Irrlicht 3D Engine
irr::core::rect< T > Class Template Reference

Rectangle template. More...

#include <rect.h>

Public Member Functions

 rect ()
 Default constructor creating empty rectangle at (0,0) More...
 
 rect (T x, T y, T x2, T y2)
 Constructor with two corners. More...
 
 rect (const position2d< T > &upperLeft, const position2d< T > &lowerRight)
 Constructor with two corners. More...
 
template<class U >
 rect (const position2d< T > &pos, const dimension2d< U > &size)
 Constructor with upper left corner and dimension. More...
 
template<class U >
 rect (const dimension2d< U > &size)
 Constructor with upper left at 0,0 and lower right using dimension. More...
 
void addInternalPoint (const position2d< T > &p)
 Adds a point to the rectangle. More...
 
void addInternalPoint (T x, T y)
 Adds a point to the bounding rectangle. More...
 
void clipAgainst (const rect< T > &other)
 Clips this rectangle with another one. More...
 
bool constrainTo (const rect< T > &other)
 Moves this rectangle to fit inside another one. More...
 
getArea () const
 Returns size of rectangle. More...
 
position2d< T > getCenter () const
 Get the center of the rectangle. More...
 
getHeight () const
 Get height of rectangle. More...
 
dimension2d< T > getSize () const
 Get the dimensions of the rectangle. More...
 
getWidth () const
 Get width of rectangle. More...
 
bool isPointInside (const position2d< T > &pos) const
 Returns if a 2d point is within this rectangle. More...
 
bool isRectCollided (const rect< T > &other) const
 Check if the rectangle collides with another rectangle. More...
 
bool isValid () const
 Returns if the rect is valid to draw. More...
 
bool operator!= (const rect< T > &other) const
 inequality operator More...
 
rect< T > operator+ (const position2d< T > &pos) const
 move right by given numbers More...
 
rect< T > & operator+= (const position2d< T > &pos)
 move right by given numbers More...
 
rect< T > operator- (const position2d< T > &pos) const
 move left by given numbers More...
 
rect< T > & operator-= (const position2d< T > &pos)
 move left by given numbers More...
 
bool operator< (const rect< T > &other) const
 compares size of rectangles More...
 
bool operator== (const rect< T > &other) const
 equality operator More...
 
void repair ()
 If the lower right corner of the rect is smaller then the upper left, the points are swapped. More...
 

Public Attributes

position2d< T > LowerRightCorner
 Lower right corner. More...
 
position2d< T > UpperLeftCorner
 Upper left corner. More...
 

Detailed Description

template<class T>
class irr::core::rect< T >

Rectangle template.

Mostly used by 2D GUI elements and for 2D drawing methods. It has 2 positions instead of position and dimension and a fast method for collision detection with other rectangles and points.

Coordinates are (0,0) for top-left corner, and increasing to the right and to the bottom.

Definition at line 26 of file rect.h.

Constructor & Destructor Documentation

◆ rect() [1/5]

template<class T>
irr::core::rect< T >::rect ( )
inline

Default constructor creating empty rectangle at (0,0)

Definition at line 31 of file rect.h.

◆ rect() [2/5]

template<class T>
irr::core::rect< T >::rect ( x,
y,
x2,
y2 
)
inline

Constructor with two corners.

Definition at line 34 of file rect.h.

◆ rect() [3/5]

template<class T>
irr::core::rect< T >::rect ( const position2d< T > &  upperLeft,
const position2d< T > &  lowerRight 
)
inline

Constructor with two corners.

Definition at line 38 of file rect.h.

◆ rect() [4/5]

template<class T>
template<class U >
irr::core::rect< T >::rect ( const position2d< T > &  pos,
const dimension2d< U > &  size 
)
inline

Constructor with upper left corner and dimension.

Definition at line 43 of file rect.h.

◆ rect() [5/5]

template<class T>
template<class U >
irr::core::rect< T >::rect ( const dimension2d< U > &  size)
inlineexplicit

Constructor with upper left at 0,0 and lower right using dimension.

Definition at line 48 of file rect.h.

Member Function Documentation

◆ addInternalPoint() [1/2]

template<class T>
void irr::core::rect< T >::addInternalPoint ( const position2d< T > &  p)
inline

Adds a point to the rectangle.

Causes the rectangle to grow bigger if point is outside of the box

Parameters
pPoint to add to the box.

Definition at line 246 of file rect.h.

Referenced by irr::core::rect< f32 >::addInternalPoint().

◆ addInternalPoint() [2/2]

template<class T>
void irr::core::rect< T >::addInternalPoint ( x,
y 
)
inline

Adds a point to the bounding rectangle.

Causes the rectangle to grow bigger if point is outside of the box

Parameters
xX-Coordinate of the point to add to this box.
yY-Coordinate of the point to add to this box.

Definition at line 256 of file rect.h.

◆ clipAgainst()

template<class T>
void irr::core::rect< T >::clipAgainst ( const rect< T > &  other)
inline

Clips this rectangle with another one.

Parameters
otherRectangle to clip with

Definition at line 131 of file rect.h.

Referenced by irr::gui::IGUIElement::recalculateAbsolutePosition().

◆ constrainTo()

template<class T>
bool irr::core::rect< T >::constrainTo ( const rect< T > &  other)
inline

Moves this rectangle to fit inside another one.

Returns
True on success, false if not possible

Definition at line 152 of file rect.h.

◆ getArea()

template<class T>
T irr::core::rect< T >::getArea ( ) const
inline

Returns size of rectangle.

Definition at line 102 of file rect.h.

Referenced by irr::core::rect< f32 >::operator<().

◆ getCenter()

template<class T>
position2d<T> irr::core::rect< T >::getCenter ( ) const
inline

Get the center of the rectangle.

Definition at line 228 of file rect.h.

◆ getHeight()

◆ getSize()

template<class T>
dimension2d<T> irr::core::rect< T >::getSize ( ) const
inline

Get the dimensions of the rectangle.

Definition at line 236 of file rect.h.

Referenced by irr::gui::IGUIElement::setRelativePosition(), and irr::gui::IGUIElement::setRelativePositionProportional().

◆ getWidth()

◆ isPointInside()

template<class T>
bool irr::core::rect< T >::isPointInside ( const position2d< T > &  pos) const
inline

Returns if a 2d point is within this rectangle.

Parameters
posPosition to test if it lies within this rectangle.
Returns
True if the position is within the rectangle, false if not.

Definition at line 110 of file rect.h.

Referenced by irr::gui::IGUIElement::isPointInside().

◆ isRectCollided()

template<class T>
bool irr::core::rect< T >::isRectCollided ( const rect< T > &  other) const
inline

Check if the rectangle collides with another rectangle.

Parameters
otherRectangle to test collision with
Returns
True if the rectangles collide.

Definition at line 121 of file rect.h.

◆ isValid()

template<class T>
bool irr::core::rect< T >::isValid ( ) const
inline

Returns if the rect is valid to draw.

It would be invalid if the UpperLeftCorner is lower or more right than the LowerRightCorner.

Definition at line 221 of file rect.h.

◆ operator!=()

template<class T>
bool irr::core::rect< T >::operator!= ( const rect< T > &  other) const
inline

inequality operator

Definition at line 89 of file rect.h.

◆ operator+()

template<class T>
rect<T> irr::core::rect< T >::operator+ ( const position2d< T > &  pos) const
inline

move right by given numbers

Definition at line 52 of file rect.h.

◆ operator+=()

template<class T>
rect<T>& irr::core::rect< T >::operator+= ( const position2d< T > &  pos)
inline

move right by given numbers

Definition at line 59 of file rect.h.

◆ operator-()

template<class T>
rect<T> irr::core::rect< T >::operator- ( const position2d< T > &  pos) const
inline

move left by given numbers

Definition at line 67 of file rect.h.

◆ operator-=()

template<class T>
rect<T>& irr::core::rect< T >::operator-= ( const position2d< T > &  pos)
inline

move left by given numbers

Definition at line 74 of file rect.h.

◆ operator<()

template<class T>
bool irr::core::rect< T >::operator< ( const rect< T > &  other) const
inline

compares size of rectangles

Definition at line 96 of file rect.h.

◆ operator==()

template<class T>
bool irr::core::rect< T >::operator== ( const rect< T > &  other) const
inline

equality operator

Definition at line 82 of file rect.h.

◆ repair()

template<class T>
void irr::core::rect< T >::repair ( )
inline

If the lower right corner of the rect is smaller then the upper left, the points are swapped.

Definition at line 201 of file rect.h.

Referenced by irr::gui::IGUIElement::recalculateAbsolutePosition().

Member Data Documentation

◆ LowerRightCorner

◆ UpperLeftCorner


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