Rect class for defining rectangles. More...

#include <geometry/Rect.h>

Inheritance diagram for Rect< T, D >:

Public Types
typedef RectBase< T, D, Rect< T, D > >	Base

typedef Base::PointType	PointType

typedef Base::SizeType	SizeType

typedef Base::BoxType	BoxType

Public Member Functions
	Rect ()
	The default constructor. More...

	Rect (const PointType &p1, const PointType &p2, bool makeValid=true)
	A constructor to initialize from 2 points. More...

void	reflect (Reflector &reflector)
	the method to serialize this object More...

SizeType	size () const
	return the size of the multidimensional rect More...

const Rect< T, D > &	operator+= (const PointType &displacement)
	Moves the rect (the minCorner and the maxCorner) by the specified displacement. More...

Rect< T, D >	operator+ (const PointType &displacement) const
	Returns a rect that is moved by the specified displacement. More...

Implicit conversion operators
	operator BoxType () const
	converts to boost::geometry::box More...

Comparison Operators
bool	operator== (const RectBase< T, D, OtherDerived > &other) const

bool	operator!= (const RectBase< T, D, OtherDerived > &other) const

Intersection tests
bool	contains (const OtherGeometry &otherGeometry) const
	this method checks if a given geometry is enclosed by this box More...

bool	intersects (const OtherGeometry &otherGeometry) const
	this method checks for intersections with other geometry More...

bool	disjoint (const OtherGeometry &otherGeometry) const
	this method checks for non-intersections with other geometry More...

Geometric Operators
Rect< T, D >	operator\| (const Rect< T, D > &other) const
	Returns the bounding rectangle of this rectangle and the given rectangle. More...

const Rect< T, D > &	operator\|= (const Rect< T, D > &other)
	Unites this rectangle with the given rectangle. More...

const Rect< T, D > &	operator\|= (const PointType &p)
	Unites this rectangle with the given point. More...

Rect< T, D >	operator& (const Rect< T, D > &other) const
	Returns the intersection of this rectangle and the given rectangle. More...

const Rect< T, D > &	operator&= (const Rect< T, D > &other)
	Intersects the rectangle with the given rectangle. More...

Static Public Member Functions
static Rect< T, D >	convertFrom (const RectBase< U, D, OtherDerived > &other)
	Converts from a Rect of a different type. More...

Public Attributes
PointType	minCorner

PointType	maxCorner

Invalid and null Rects
bool	isValid () const
	Returns true if this is a valid Rect where the maxCorner's components are not smaller than the minCorner, i.e. More...

Rect< T, D >	normalized () const
	Returns the normalized Rect, where the maxCorner and minCorner components are swapped if necessary to produce a valid Rect, where all maxCorner's components are larger than the minCorner. More...

bool	isNull () const
	Returns true, if all extends (i.e. More...

static Rect< T, D >	invalid ()
	Returns an invalid rect with negative extends. More...

static Rect< T, D >	null ()
	Returns a null-Rect which extends are null (minCorner and maxCorner) are set to 0. More...

static Rect< T, D >	zero ()
	Same as null(). More...

Detailed Description

template<typename T, int D>
class mira::Rect< T, D >

Rect class for defining rectangles.

Member Typedef Documentation

◆ Base

typedef RectBase<T,D, Rect<T,D> > Base

◆ PointType

typedef Base::PointType PointType

◆ SizeType

typedef Base::SizeType SizeType

◆ BoxType

typedef Base::BoxType BoxType

Constructor & Destructor Documentation

◆ Rect() [1/2]

Rect ( )

inline

The default constructor.

◆ Rect() [2/2]

Rect	(	const PointType &	p1,
		const PointType &	p2,
		bool	makeValid = `true`
	)

inline

A constructor to initialize from 2 points.

Member Function Documentation

◆ reflect()

void reflect ( Reflector & reflector )

inlineinherited

the method to serialize this object

◆ operator BoxType()

operator BoxType ( ) const

inlineinherited

converts to boost::geometry::box

◆ size()

SizeType size ( ) const

inlineinherited

return the size of the multidimensional rect

◆ operator==()

bool operator== ( const RectBase< T, D, OtherDerived > & other ) const

inlineinherited

◆ operator!=()

bool operator!= ( const RectBase< T, D, OtherDerived > & other ) const

inlineinherited

◆ contains()

bool contains ( const OtherGeometry & otherGeometry ) const

inlineinherited

this method checks if a given geometry is enclosed by this box

◆ intersects()

bool intersects ( const OtherGeometry & otherGeometry ) const

inlineinherited

this method checks for intersections with other geometry

◆ disjoint()

bool disjoint ( const OtherGeometry & otherGeometry ) const

inlineinherited

this method checks for non-intersections with other geometry

◆ isValid()

bool isValid ( ) const

inlineinherited

Returns true if this is a valid Rect where the maxCorner's components are not smaller than the minCorner, i.e.

the width and height is not negative. Note: a null-Rect is valid.

◆ invalid()

static Rect< T, D > invalid ( )

inlinestaticinherited

Returns an invalid rect with negative extends.

Provided for backward compatibility (the default constructor does exactly this).

◆ normalized()

Rect< T, D > normalized ( ) const

inlineinherited

Returns the normalized Rect, where the maxCorner and minCorner components are swapped if necessary to produce a valid Rect, where all maxCorner's components are larger than the minCorner.

◆ isNull()

bool isNull ( ) const

inlineinherited

Returns true, if all extends (i.e.

width, height, etc) of this Rect are null.

◆ null()

static Rect< T, D > null ( )

inlinestaticinherited

Returns a null-Rect which extends are null (minCorner and maxCorner) are set to 0.

◆ zero()

static Rect< T, D > zero ( )

inlinestaticinherited

Same as null().

Provided for compatibility to Ogre.

◆ operator|()

Rect< T, D > operator| ( const Rect< T, D > & other ) const

inlineinherited

Returns the bounding rectangle of this rectangle and the given rectangle.

Moreover:
  a | invalid = a
  invalid | b = b
  invalid | invalid = invalid

◆ operator|=() [1/2]

const Rect< T, D > & operator|= ( const Rect< T, D > & other )

inlineinherited

Unites this rectangle with the given rectangle.

Moreover:
  a |= invalid, leaves a unchanged
  invalid |= b, previous null becomes b

◆ operator|=() [2/2]

const Rect< T, D > & operator|= ( const PointType & p )

inlineinherited

Unites this rectangle with the given point.

Using this operator bounding boxes around single points can be created:

Rect2i r;
r |= point1;
r |= point2;
r |= point3;
...

Moreover:

invalid |= point

creates an empty rect as bounding box at the position of the single point

Note: This will put the rectangle border at the outermost points. However, contains() returns false for points on the border! Thus, to make all points added to actually be contained in the rect, an extra margin must be added to min/maxCorner.

◆ operator&()

Rect< T, D > operator& ( const Rect< T, D > & other ) const

inlineinherited

Returns the intersection of this rectangle and the given rectangle.

Returns an invalid rectangle if there is no intersection.

Moreover:
  a & invalid = invalid
  invalid & b = invalid
  invalid & invalid = invalid
  a & b = invalid, only if a and b do not intersect at all.

◆ operator&=()

const Rect< T, D > & operator&= ( const Rect< T, D > & other )

inlineinherited

Intersects the rectangle with the given rectangle.

Returns an invalid rectangle if there is no intersection.

◆ convertFrom()

static Rect< T, D > convertFrom ( const RectBase< U, D, OtherDerived > & other )

inlinestaticinherited

Converts from a Rect of a different type.

◆ operator+=()

const Rect< T, D > & operator+= ( const PointType & displacement )

inlineinherited

Moves the rect (the minCorner and the maxCorner) by the specified displacement.

◆ operator+()

Rect< T, D > operator+ ( const PointType & displacement ) const

inlineinherited

Returns a rect that is moved by the specified displacement.

Member Data Documentation

◆ minCorner

PointType minCorner

inherited

◆ maxCorner

PointType maxCorner

inherited

The documentation for this class was generated from the following file:

base/include/geometry/Rect.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Invalid and null Rects

Detailed Description

template<typename T, int D> class mira::Rect< T, D >

Member Typedef Documentation

◆ Base

◆ PointType

◆ SizeType

◆ BoxType

Constructor & Destructor Documentation

◆ Rect() [1/2]

◆ Rect() [2/2]

Member Function Documentation

◆ reflect()

◆ operator BoxType()

◆ size()

◆ operator==()

◆ operator!=()

◆ contains()

◆ intersects()

◆ disjoint()

◆ isValid()

◆ invalid()

◆ normalized()

◆ isNull()

◆ null()

◆ zero()

◆ operator|()

◆ operator|=() [1/2]

◆ operator|=() [2/2]

◆ operator&()

◆ operator&=()

◆ convertFrom()

◆ operator+=()

◆ operator+()

Member Data Documentation

◆ minCorner

◆ maxCorner

template<typename T, int D>
class mira::Rect< T, D >