peak::ipl::Rect2D Class Reference

Rectangle type. More...

#include <peak_ipl/types/peak_ipl_rect.hpp>

Public Member Functions
constexpr	Rect2D (size_t x, size_t y, size_t width, size_t height)
constexpr	Rect2D (const Point2D &point, const Size2D &size)
PEAK_IPL_NO_DISCARD constexpr Point2D	topLeft () const
PEAK_IPL_NO_DISCARD constexpr Size2D	size () const
PEAK_IPL_NO_DISCARD constexpr size_t	left () const
PEAK_IPL_NO_DISCARD constexpr size_t	right () const
PEAK_IPL_NO_DISCARD constexpr size_t	top () const
PEAK_IPL_NO_DISCARD constexpr size_t	bottom () const
void	setSize (const Size2D &size)
void	setWidth (size_t width)
void	setHeight (size_t height)
void	setX (size_t x)
void	setY (size_t y)

Detailed Description

Rectangle type.

Constructor & Destructor Documentation

Rect2D() [1/2]

constexpr peak::ipl::Rect2D::Rect2D ( size_t  x, size_t  y, size_t  width, size_t  height  )

inline

Rect2D() [2/2]

constexpr peak::ipl::Rect2D::Rect2D ( const Point2D &  point, const Size2D &  size  )

inline

Member Function Documentation

bottom()

PEAK_IPL_NO_DISCARD constexpr size_t peak::ipl::Rect2D::bottom ( ) const

inline

Returns the bottom position of the rectangle

left()

PEAK_IPL_NO_DISCARD constexpr size_t peak::ipl::Rect2D::left ( ) const

inline

Returns the left position of the rectangle

right()

PEAK_IPL_NO_DISCARD constexpr size_t peak::ipl::Rect2D::right ( ) const

inline

Returns the right position of the rectangle

setHeight()

void peak::ipl::Rect2D::setHeight ( size_t  height )

inline

Sets the rectangle height

setSize()

void peak::ipl::Rect2D::setSize ( const Size2D &  size )

inline

Sets a new size for the rectangle

setWidth()

void peak::ipl::Rect2D::setWidth ( size_t  width )

inline

Sets the rectangle width

setX()

void peak::ipl::Rect2D::setX ( size_t  x )

inline

Sets the left position of the rectangle

setY()

void peak::ipl::Rect2D::setY ( size_t  y )

inline

Sets the top position of the rectangle

size()

PEAK_IPL_NO_DISCARD constexpr Size2D peak::ipl::Rect2D::size ( ) const

inline

Returns the size of the rectancle

top()

PEAK_IPL_NO_DISCARD constexpr size_t peak::ipl::Rect2D::top ( ) const

inline

Returns the top position of the rectangle

topLeft()

PEAK_IPL_NO_DISCARD constexpr Point2D peak::ipl::Rect2D::topLeft ( ) const

inline

Returns the position of the top-left corner of the rectangle

---

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

• peak_ipl/types/peak_ipl_rect.hpp