Rectangle Struct Reference

A Rectangle is a position with a size. More...

#include <Dimensions.hh>

Inheritance diagram for Rectangle:

Collaboration diagram for Rectangle:

Public Member Functions
	Rectangle ()
	Constructs an empty rectangle.
	Rectangle (const Point_2D &position, const Size_2D &size)
	Constructs a rectangle from a position and a size.
	Rectangle (const Size_2D &size)
	Constructs a rectangle from a size at position 0,0.
	Rectangle (const int x, const int y, const unsigned int width=0, const unsigned int height=0)
	Constructs a rectangle from an x,y position and width,height size.
	Rectangle (const Rectangle &rectangle)
	Constructs a rectangle as a copy of another rectangle.
Rectangle &	operator= (const Rectangle &rectangle)
	Assign the position and size of another rectangle to this rectangle.
Point_2D	position () const
	Get the rectangle position.
Rectangle &	position (const Point_2D &point)
	Set the position of the rectangle.
Rectangle &	position (const int x, const int y)
	Set the x,y position of the rectangle.
Size_2D	size () const
	Get the rectangle size.
Rectangle &	size (const Size_2D &size)
	Set the size of the rectangle.
Rectangle &	size (const unsigned int width, const unsigned int height)
	Set the width,height of the rectangle.
Rectangle &	operator&= (const Rectangle &rectangle)
	Take the intersection with another rectangle.
Public Member Functions inherited from Point_2D
	Point_2D ()
	Constructs a point at position 0,0.
	Point_2D (const int &x, const int &y)
	Constructs a point at position x,y.
	Point_2D (const Point_2D &point)
	Constructs a point from another point.
Point_2D &	operator= (const Point_2D &point)
	Assign the position of another point to this point.
int	x () const
	Get the horizontal (x-axis) position.
Point_2D &	x (const int &x_position)
	Set the horizontal (x-axis) position.
int	y () const
	Get the vertical (y-axis) position.
Point_2D &	y (const int &y_position)
	Set the vertical (y-axis) position.
Public Member Functions inherited from Size_2D
	Size_2D ()
	Constructs an empty 2D size.
	Size_2D (const unsigned int &width, const unsigned int &height)
	Constructs a specific size.
	Size_2D (const unsigned int &side)
	Constructs a size of equal width and height.
	Size_2D (const Size_2D &size)
	Constructs a size from another size.
Size_2D &	operator= (const Size_2D &size)
	Assign the size of another size to this size.
unsigned int	width () const
	Get the width of the size.
Size_2D &	width (const unsigned int &width)
	Set the width of the size.
unsigned int	height () const
	Get the height of the size.
Size_2D &	height (const unsigned int &height)
	Set the height of the size.
unsigned long	area () const
	Get the area of this size.

Additional Inherited Members
Public Attributes inherited from Point_2D
int	X
	The horizontal (x-axis) position of the point.
int	Y
	The vertical (y-axis) position of the point.
Public Attributes inherited from Size_2D
unsigned int	Width
	The width of the 2D size.
unsigned int	Height
	The height of the 2D size.

Detailed Description

A Rectangle is a position with a size.

Author

Bradford Castalia, UA/PIRL

Version

1.7

See also

Point_2D

Size_2D

Constructor & Destructor Documentation

Rectangle() [1/5]

Rectangle

(

)

Constructs an empty rectangle.

The position is 0,0 and the size is 0,0.

Rectangle() [2/5]

Rectangle	(	const Point_2D &	position,
		const Size_2D &	size )

Constructs a rectangle from a position and a size.

Parameters

position	A Point_2D.
size	A Size_2D.

Rectangle() [3/5]

Rectangle

(

const Size_2D &

size

)

Constructs a rectangle from a size at position 0,0.

Parameters

size	A Size_2D.

Rectangle() [4/5]

Rectangle	(	const int	x,
		const int	y,
		const unsigned int	width = 0,
		const unsigned int	height = 0 )

Constructs a rectangle from an x,y position and width,height size.

Parameters

x	The horizontal (x-axis) position.
y	The vertical (y-axis) position.
width	The width of the rectangle size.
height	The height of the recangle size.

Rectangle() [5/5]

Rectangle

(

const Rectangle &

rectangle

)

Constructs a rectangle as a copy of another rectangle.

Parameters

rectangle

A Rectangle to be copied.

Member Function Documentation

operator=()

Rectangle & operator=

(

const Rectangle &

rectangle

)

Assign the position and size of another rectangle to this rectangle.

Parameters

rectangle

A Rectangle whose position and size are be assigned to this rectangle.

Returns

This Rectangle.

position() [1/3]

Point_2D position ( ) const

inline

Get the rectangle position.

Returns

A Point_2D with the rectangle position. N.B.: Changing this point will not change the position of the rectangle.

position() [2/3]

Rectangle & position ( const Point_2D & point )

inline

Set the position of the rectangle.

Parameters

point

A Point_2D for the position of the rectangle.

Returns

This Rectangle.

position() [3/3]

Rectangle & position ( const int x, const int y )

inline

Set the x,y position of the rectangle.

Parameters

x	The horizontal (x-axis) position.
y	The vertical (y-axis) position.

Returns

This Rectangle.

size() [1/3]

Size_2D size ( ) const

inline

Get the rectangle size.

Returns

A Size_2D with the rectangle size. N.B.: Changing this size will not change the size of the rectangle.

size() [2/3]

Rectangle & size ( const Size_2D & size )

inline

Set the size of the rectangle.

Parameters

size	A Size_2D for the size of the rectangle.

Returns

This Rectangle.

size() [3/3]

Rectangle & size ( const unsigned int width, const unsigned int height )

inline

Set the width,height of the rectangle.

Parameters

width	The width of the rectangle size.
height	The height of the recangle size.

Returns

This Rectangle.

operator&=()

Rectangle & operator&=

(

const Rectangle &

rectangle

)

Take the intersection with another rectangle.

Parameters

rectangle

The Rectangle to intersect with this Rectangle.

Returns

This Rectangle with its position and size set to the intersection with the other rectangle. If the rectangles do not intersect this will result in a rectangle with no area (width and height both zero) but the position will be unchanged.

---

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

• Dimensions.hh
• Dimensions.cc