LibBoard::Rect Struct Reference

Struct representing a rectangle on the plane. More...

#include <Rect.h>

Public Member Functions
	Rect (double left=0.0, double top=0.0, double width=0.0, double height=0.0)
	Rect (Point topLeft, double width=0.0, double height=0.0)
	Rect (Point topLeft, Point bottomRight)
Point	topLeft () const
	topLeft Top-left point of the rectangle
Point	topRight () const
	topRight Top-right point of the rectangle
Point	bottomLeft () const
	bottomLeft Bottom-left point of the rectangle
Point	bottomRight () const
	bottomRight Bottom-right point of the rectangle
Point	center () const
	center The center of the rectangle
Point	centerLeft () const
	centerLeft The center of the left border of the rectangle
Point	centerRight () const
	centerRight The center of the right border of the rectangle
Point	centerTop () const
	centerTop The center of the top border of the rectangle
Point	centerBottom () const
	centerBottom The center of the bottom border of the rectangle
double	bottom () const
	The y coordinate of the bottom of the rectangle.
double	right () const
	The x coordinate of the right side of the rectangle.
double	diameter () const
	diameter
void	clear ()
	Set to a rectangle with zero width and height at position (0,0)
Rect &	growToContain (const Point &p)
	Grow the rectangle so that it contains the point p.
Rect &	growToContain (const std::vector< Point > &points)
	Grow the rectangle so that it contains a set of points.
bool	contains (Point p) const
	Check whether or not a point is contained in the rectangle (including its border)
bool	strictlyContains (Point p) const
	Check whether or not a point is strictly contained in the rectangle.
bool	intersects (const Rect &other) const
	Check whether the rectangle intersects another rectangle.
bool	strictlyIntersects (const Rect &other) const
	Check whether the rectangle strictly intersects another rectangle.
Rect &	grow (double margin)
	Grow the rectangle by a given distance (margin) in each direction.
Rect	growed (double margin)
	Return the rectangle growed by a given distance (margin) in each direction.
bool	isNull () const
	Check if a rectangle is null (i.e., zero sized)

Public Attributes
double	left
double	top
double	width
double	height

Detailed Description

Struct representing a rectangle on the plane.

The Rectangle structure.

Examples

examples/Huffman.cpp, examples/arrows.cpp, examples/ellipse.cpp, examples/tilings.cpp, and examples/traversal.cpp.

Constructor & Destructor Documentation

Rect() [1/3]

LibBoard::Rect::Rect ( double  left = 0.0, double  top = 0.0, double  width = 0.0, double  height = 0.0  )

inline

Rect constructor

Parameters

left	x coordinate of the left border of the rectangle
top	y coordinate of the top border of the rectangle
width	width of the rectangle
height	height of the rectangle

Rect() [2/3]

LibBoard::Rect::Rect ( Point  topLeft, double  width = 0.0, double  height = 0.0  )

inline

Rect constructor.

Parameters

topLeft	The top-left point of the rectangle
width	Width of the rectangle
height	Height of the rectangle

Rect() [3/3]

LibBoard::Rect::Rect ( Point  topLeft, Point  bottomRight  )

inline

Rect constructor.

Parameters

topLeft	The top-left point of the rectangle.
bottomRight	The bottom-right point of the rectangle.

Member Function Documentation

bottom()

double LibBoard::Rect::bottom ( ) const

inline

The y coordinate of the bottom of the rectangle.

Returns

The y coordinate of the bottom of the rectangle

References height, and top.

Referenced by LibBoard::ShapeList::append(), LibBoard::boardFontText(), LibBoard::hachures(), and LibBoard::Board::saveEPS().

bottomLeft()

Point LibBoard::Rect::bottomLeft ( ) const

inline

bottomLeft Bottom-left point of the rectangle

Returns

The point at the bottom-left corner of the rectangle

Examples

examples/sandbox.cpp, and examples/tilings.cpp.

References height, left, and top.

Referenced by intersects(), main(), and strictlyIntersects().

bottomRight()

Point LibBoard::Rect::bottomRight ( ) const

inline

bottomRight Bottom-right point of the rectangle

Returns

The point at the bottom-right corner of the rectangle

Examples

examples/arrows.cpp, and examples/tilings.cpp.

References height, left, top, and width.

Referenced by intersects(), main(), and strictlyIntersects().

center()

Point LibBoard::Rect::center ( ) const

inline

center The center of the rectangle

Returns

The point at the center of the rectangle

References height, left, top, and width.

Referenced by LibBoard::ShapeList::append(), LibBoard::Path::center(), LibBoard::Shape::center(), LibBoard::circled(), LibBoard::TransformEPS::setBoundingBox(), LibBoard::TransformFIG::setBoundingBox(), and LibBoard::TransformSVG::setBoundingBox().

centerBottom()

Point LibBoard::Rect::centerBottom ( ) const

inline

centerBottom The center of the bottom border of the rectangle

Returns

The point at the center of the bottom border of the rectangle

References height, left, top, and width.

centerLeft()

Point LibBoard::Rect::centerLeft ( ) const

inline

centerLeft The center of the left border of the rectangle

Returns

The point at the center of the left border of the rectangle

References height, left, and top.

centerRight()

Point LibBoard::Rect::centerRight ( ) const

inline

centerRight The center of the right border of the rectangle

Returns

The point at the center of the right border of the rectangle

References height, left, top, and width.

centerTop()

Point LibBoard::Rect::centerTop ( ) const

inline

centerTop The center of the top border of the rectangle

Returns

The point at the center of the top border of the rectangle

References left, top, and width.

clear()

void LibBoard::Rect::clear ( )

inline

Set to a rectangle with zero width and height at position (0,0)

References height, left, top, and width.

Referenced by LibBoard::Tools::getEPSBoundingBox().

contains()

bool LibBoard::Rect::contains

(

Point

p

)

const

Check whether or not a point is contained in the rectangle (including its border)

Parameters

p

A point

Returns

true if the point is in the rectangle, otherwise false

References height, left, top, width, LibBoard::Point::x, and LibBoard::Point::y.

Referenced by intersects().

diameter()

double LibBoard::Rect::diameter ( ) const

inline

diameter

Returns

The distance between two opposite corners

References height, and width.

Referenced by LibBoard::circled().

grow()

Rect & LibBoard::Rect::grow

(

double

margin

)

Grow the rectangle by a given distance (margin) in each direction.

Parameters

margin

The margin to be added

Returns

A reference to the rectangle itself

References height, left, top, and width.

Referenced by LibBoard::Ellipse::boundingBox(), LibBoard::framed(), growed(), and main().

growed()

Rect LibBoard::Rect::growed

(

double

margin

)

Return the rectangle growed by a given distance (margin) in each direction.

Parameters

margin

The margin to be added

Returns

A new rectangle, result of the growth

Examples

examples/Huffman.cpp.

References grow().

Referenced by merge().

growToContain() [1/2]

Rect & LibBoard::Rect::growToContain

(

const Point &

p

)

Grow the rectangle so that it contains the point p.

Parameters

p

A point

Returns

A reference to the rectangle itself

References height, left, top, width, LibBoard::Point::x, and LibBoard::Point::y.

Referenced by LibBoard::Path::boundingBox(), growToContain(), and LibBoard::Tools::pathBoundingBox().

growToContain() [2/2]

Rect & LibBoard::Rect::growToContain

(

const std::vector< Point > &

points

)

Grow the rectangle so that it contains a set of points.

Parameters

points

A set of points

Returns

A reference to the rectangle itself

References growToContain(), and point().

intersects()

bool LibBoard::Rect::intersects

(

const Rect &

other

)

const

Check whether the rectangle intersects another rectangle.

Parameters

other

Another rectangle

Returns

true if the rectangles intersect, otherwise false

References bottomLeft(), bottomRight(), contains(), topLeft(), and topRight().

isNull()

bool LibBoard::Rect::isNull ( ) const

inline

Check if a rectangle is null (i.e., zero sized)

Returns

true if the rectangle is null, otherwise false

References height, and width.

Referenced by LibBoard::operator||().

right()

double LibBoard::Rect::right ( ) const

inline

The x coordinate of the right side of the rectangle.

Returns

The x coordinate of the right side of the rectangle

References left, and width.

Referenced by LibBoard::ShapeList::append(), and LibBoard::Board::saveEPS().

strictlyContains()

bool LibBoard::Rect::strictlyContains

(

Point

p

)

const

Check whether or not a point is strictly contained in the rectangle.

Parameters

p

A point

Returns

true if the point is inside the rectangle, otherwise false

References height, left, top, width, LibBoard::Point::x, and LibBoard::Point::y.

Referenced by strictlyIntersects().

strictlyIntersects()

bool LibBoard::Rect::strictlyIntersects

(

const Rect &

other

)

const

Check whether the rectangle strictly intersects another rectangle.

Parameters

other

Another rectangle

Returns

true if the rectangles strictly intersect, otherwise false

References bottomLeft(), bottomRight(), strictlyContains(), topLeft(), and topRight().

topLeft()

Point LibBoard::Rect::topLeft ( ) const

inline

topLeft Top-left point of the rectangle

Returns

The point at the top-left corner of the rectangle

Examples

examples/arrows.cpp.

References left, and top.

Referenced by intersects(), main(), and strictlyIntersects().

topRight()

Point LibBoard::Rect::topRight ( ) const

inline

topRight Top-right point of the rectangle

Returns

The point at the top-right corner of the rectangle

Examples

examples/circled_framed.cpp, examples/example1.cpp, examples/ruler.cpp, examples/tilings.cpp, and examples/xkcd.cpp.

References left, top, and width.

Referenced by intersects(), main(), and strictlyIntersects().

Member Data Documentation

height

double LibBoard::Rect::height

Height of the rectangle.

Examples

examples/Huffman.cpp.

Referenced by LibBoard::ShapeList::append(), bottom(), bottomLeft(), bottomRight(), center(), centerBottom(), centerLeft(), centerRight(), clear(), contains(), diameter(), LibBoard::Board::drawBoundingBox(), LibBoard::Board::drawRectangle(), LibBoard::Board::fillRectangle(), LibBoard::Group::flushFIG(), LibBoard::Image::flushPostscript(), grow(), growToContain(), isNull(), merge(), LibBoard::operator&&(), operator<<(), LibBoard::operator||(), LibBoard::rectangle(), LibBoard::rectangle(), LibBoard::Shape::resize(), LibBoard::Board::saveEPS(), LibBoard::Board::saveFIG(), LibBoard::Board::saveSVG(), LibBoard::Shape::scaleToHeight(), LibBoard::TransformEPS::setBoundingBox(), LibBoard::TransformFIG::setBoundingBox(), LibBoard::TransformSVG::setBoundingBox(), LibBoard::Board::setClippingRectangle(), strictlyContains(), and LibBoard::tiling().

left

double LibBoard::Rect::left

Coordinate of the left side.

Referenced by LibBoard::ShapeList::append(), LibBoard::boardFontText(), bottomLeft(), bottomRight(), center(), centerBottom(), centerLeft(), centerRight(), centerTop(), clear(), contains(), LibBoard::Board::drawBoundingBox(), LibBoard::Board::drawRectangle(), LibBoard::Board::fillRectangle(), LibBoard::Group::flushFIG(), grow(), growToContain(), LibBoard::operator&&(), operator<<(), LibBoard::operator||(), LibBoard::rectangle(), LibBoard::rectangle(), right(), LibBoard::Board::saveEPS(), LibBoard::TransformEPS::setBoundingBox(), LibBoard::Board::setClippingRectangle(), strictlyContains(), LibBoard::tiling(), topLeft(), and topRight().

top

double LibBoard::Rect::top

Coordinate of the upper side.

Referenced by LibBoard::ShapeList::append(), bottom(), bottomLeft(), bottomRight(), center(), centerBottom(), centerLeft(), centerRight(), centerTop(), clear(), contains(), LibBoard::Board::drawBoundingBox(), LibBoard::Board::drawRectangle(), LibBoard::Board::fillRectangle(), LibBoard::Group::flushFIG(), grow(), growToContain(), LibBoard::hachures(), LibBoard::operator&&(), operator<<(), LibBoard::operator||(), LibBoard::rectangle(), LibBoard::rectangle(), LibBoard::Board::saveEPS(), LibBoard::TransformEPS::setBoundingBox(), LibBoard::Board::setClippingRectangle(), strictlyContains(), LibBoard::tiling(), topLeft(), and topRight().

width

double LibBoard::Rect::width

Width of the rectangle.

Examples

examples/Huffman.cpp, and examples/board_font_text.cpp.

Referenced by LibBoard::ShapeList::append(), bottomRight(), center(), centerBottom(), centerRight(), centerTop(), clear(), contains(), diameter(), LibBoard::Board::drawBoundingBox(), LibBoard::Board::drawRectangle(), LibBoard::Board::fillRectangle(), LibBoard::Group::flushFIG(), LibBoard::Image::flushPostscript(), grow(), growToContain(), isNull(), merge(), LibBoard::operator&&(), operator<<(), LibBoard::operator||(), LibBoard::rectangle(), LibBoard::rectangle(), LibBoard::Shape::resize(), right(), LibBoard::Board::saveEPS(), LibBoard::Board::saveFIG(), LibBoard::Board::saveSVG(), LibBoard::Shape::scaleToWidth(), LibBoard::TransformEPS::setBoundingBox(), LibBoard::TransformFIG::setBoundingBox(), LibBoard::TransformSVG::setBoundingBox(), LibBoard::Board::setClippingRectangle(), strictlyContains(), text(), LibBoard::tiling(), and topRight().

---

The documentation for this struct was generated from the following files:

• include/board/Rect.h
• src/Rect.cpp