MIRA
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Rect< T, 3 > Class Template Reference

Specialization for 3D. More...

#include <geometry/Rect.h>

Inheritance diagram for Rect< T, 3 >:
Inheritance graph
[legend]

Public Types

typedef RectBase< T, 3, Rect< T, 3 > > Base
 
typedef Base::PointType PointType
 
typedef Base::SizeType SizeType
 
typedef Base::BoxType BoxType
 

Public Member Functions

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, 3 > & operator+= (const PointType &displacement)
 Moves the rect (the minCorner and the maxCorner) by the specified displacement. More...
 
Rect< T, 3 > operator+ (const PointType &displacement) const
 Returns a rect that is moved by the specified displacement. More...
 
Constructors
 Rect ()
 the default constructor More...
 
 Rect (T x, T y, T z, T width, T height, T depth)
 a constructor to create a 3D rect More...
 
 Rect (const PointType &pos, T width, T height, T depth)
 a constructor to create a 3D rect More...
 
 Rect (const PointType &pos, const SizeType &s)
 a constructor to create a 3D rect More...
 
 Rect (const BoxType &box)
 copy constructor from boost::BoxType More...
 
 Rect (const PointType &p1, const PointType &p2, bool makeValid=true)
 a constructor to create a 3D rect More...
 
Access to corner elements and size
T & x0 ()
 Returns the x-coordinate of the lower corner. More...
 
x0 () const
 Returns the x-coordinate of the lower corner. More...
 
T & y0 ()
 Returns the y-coordinate of the lower corner. More...
 
y0 () const
 Returns the y-coordinate of the lower corner. More...
 
T & z0 ()
 Returns the z-coordinate of the lower corner. More...
 
z0 () const
 Returns the z-coordinate of the lower corner. More...
 
T & x1 ()
 Returns the x-coordinate of the upper corner. More...
 
x1 () const
 Returns the x-coordinate of the upper corner. More...
 
T & y1 ()
 Returns the y-coordinate of the upper corner. More...
 
y1 () const
 Returns the y-coordinate of the upper corner. More...
 
T & z1 ()
 Returns the z-coordinate of the upper corner. More...
 
z1 () const
 Returns the z-coordinate of the upper corner. More...
 
width () const
 Returns the width. More...
 
height () const
 Returns the height. More...
 
depth () const
 Returns the depth. 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, 3 > operator| (const Rect< T, 3 > &other) const
 Returns the bounding rectangle of this rectangle and the given rectangle. More...
 
const Rect< T, 3 > & operator|= (const Rect< T, 3 > &other)
 Unites this rectangle with the given rectangle. More...
 
const Rect< T, 3 > & operator|= (const PointType &p)
 Unites this rectangle with the given point. More...
 
Rect< T, 3 > operator& (const Rect< T, 3 > &other) const
 Returns the intersection of this rectangle and the given rectangle. More...
 
const Rect< T, 3 > & operator&= (const Rect< T, 3 > &other)
 Intersects the rectangle with the given rectangle. More...
 

Static Public Member Functions

static Rect< T, 3 > 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, 3 > 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, 3 > invalid ()
 Returns an invalid rect with negative extends. More...
 
static Rect< T, 3 > null ()
 Returns a null-Rect which extends are null (minCorner and maxCorner) are set to 0. More...
 
static Rect< T, 3 > zero ()
 Same as null(). More...
 

Detailed Description

template<typename T>
class mira::Rect< T, 3 >

Specialization for 3D.

Member Typedef Documentation

◆ Base

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

◆ PointType

◆ SizeType

◆ BoxType

Constructor & Destructor Documentation

◆ Rect() [1/6]

Rect ( )
inline

the default constructor

◆ Rect() [2/6]

Rect ( x,
y,
z,
width,
height,
depth 
)
inline

a constructor to create a 3D rect

Parameters
xthe min corner x-coordinate
ythe min corner y-coordinate
zthe min corner z-coordinate
widththe rect width
heightthe rect height
depththe rect depth

◆ Rect() [3/6]

Rect ( const PointType pos,
width,
height,
depth 
)
inline

a constructor to create a 3D rect

Parameters
posthe min corner
widththe rect width
heightthe rect height
depththe rect depth

◆ Rect() [4/6]

Rect ( const PointType pos,
const SizeType s 
)
inline

a constructor to create a 3D rect

Parameters
posthe min corner
sthe rect size

◆ Rect() [5/6]

Rect ( const BoxType box)
inlineexplicit

copy constructor from boost::BoxType

◆ Rect() [6/6]

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

a constructor to create a 3D rect

Parameters
[in]p1the lower corner of the rect
[in]p2the upper corner of the rect

Member Function Documentation

◆ x0() [1/2]

T& x0 ( )
inline

Returns the x-coordinate of the lower corner.

◆ x0() [2/2]

T x0 ( ) const
inline

Returns the x-coordinate of the lower corner.

◆ y0() [1/2]

T& y0 ( )
inline

Returns the y-coordinate of the lower corner.

◆ y0() [2/2]

T y0 ( ) const
inline

Returns the y-coordinate of the lower corner.

◆ z0() [1/2]

T& z0 ( )
inline

Returns the z-coordinate of the lower corner.

◆ z0() [2/2]

T z0 ( ) const
inline

Returns the z-coordinate of the lower corner.

◆ x1() [1/2]

T& x1 ( )
inline

Returns the x-coordinate of the upper corner.

◆ x1() [2/2]

T x1 ( ) const
inline

Returns the x-coordinate of the upper corner.

◆ y1() [1/2]

T& y1 ( )
inline

Returns the y-coordinate of the upper corner.

◆ y1() [2/2]

T y1 ( ) const
inline

Returns the y-coordinate of the upper corner.

◆ z1() [1/2]

T& z1 ( )
inline

Returns the z-coordinate of the upper corner.

◆ z1() [2/2]

T z1 ( ) const
inline

Returns the z-coordinate of the upper corner.

◆ width()

T width ( ) const
inline

Returns the width.

◆ height()

T height ( ) const
inline

Returns the height.

◆ depth()

T depth ( ) const
inline

Returns the depth.

◆ 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, 3 > invalid ( )
inlinestaticinherited

Returns an invalid rect with negative extends.

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

◆ normalized()

Rect< T, 3 > 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, 3 > null ( )
inlinestaticinherited

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

◆ zero()

static Rect< T, 3 > zero ( )
inlinestaticinherited

Same as null().

Provided for compatibility to Ogre.

◆ operator|()

Rect< T, 3 > operator| ( const Rect< T, 3 > &  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, 3 > & operator|= ( const Rect< T, 3 > &  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, 3 > & operator|= ( const PointType p)
inlineinherited

Unites this rectangle with the given point.

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

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, 3 > operator& ( const Rect< T, 3 > &  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, 3 > & operator&= ( const Rect< T, 3 > &  other)
inlineinherited

Intersects the rectangle with the given rectangle.

Returns an invalid rectangle if there is no intersection.

◆ convertFrom()

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

Converts from a Rect of a different type.

◆ operator+=()

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

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

◆ operator+()

Rect< T, 3 > 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: