Public Member Functions | Private Attributes | List of all members
karto::Rectangle2< T > Class Template Reference

#include <Karto.h>

Public Member Functions

const Vector2< T > GetCenter () const
 
GetHeight () const
 
const Vector2< T > & GetPosition () const
 
const Size2< T > & GetSize () const
 
GetWidth () const
 
GetX () const
 
GetY () const
 
kt_bool operator!= (const Rectangle2 &rOther) const
 
Rectangle2operator= (const Rectangle2 &rOther)
 
kt_bool operator== (const Rectangle2 &rOther) const
 
 Rectangle2 ()
 
 Rectangle2 (T x, T y, T width, T height)
 
 Rectangle2 (const Vector2< T > &rPosition, const Size2< T > &rSize)
 
 Rectangle2 (const Rectangle2 &rOther)
 
void SetHeight (T height)
 
void SetPosition (const T &rX, const T &rY)
 
void SetPosition (const Vector2< T > &rPosition)
 
void SetSize (const Size2< T > &rSize)
 
void SetWidth (T width)
 
void SetX (T x)
 
void SetY (T y)
 

Private Attributes

Vector2< T > m_Position
 
Size2< T > m_Size
 

Detailed Description

template<typename T>
class karto::Rectangle2< T >

Stores x, y, width and height that represents the location and size of a rectangle (x, y) is at bottom left in mapper!

Definition at line 1744 of file Karto.h.

Constructor & Destructor Documentation

template<typename T>
karto::Rectangle2< T >::Rectangle2 ( )
inline

Default constructor

Definition at line 1750 of file Karto.h.

template<typename T>
karto::Rectangle2< T >::Rectangle2 ( x,
y,
width,
height 
)
inline

Constructor initializing rectangle parameters

Parameters
xx-coordinate of left edge of rectangle
yy-coordinate of bottom edge of rectangle
widthwidth of rectangle
heightheight of rectangle

Definition at line 1761 of file Karto.h.

template<typename T>
karto::Rectangle2< T >::Rectangle2 ( const Vector2< T > &  rPosition,
const Size2< T > &  rSize 
)
inline

Constructor initializing rectangle parameters

Parameters
rPosition(x,y)-coordinate of rectangle
rSizeSize of the rectangle

Definition at line 1772 of file Karto.h.

template<typename T>
karto::Rectangle2< T >::Rectangle2 ( const Rectangle2< T > &  rOther)
inline

Copy constructor

Definition at line 1781 of file Karto.h.

Member Function Documentation

template<typename T>
const Vector2<T> karto::Rectangle2< T >::GetCenter ( ) const
inline

Gets the center of this rectangle

Returns
the center of this rectangle

Definition at line 1910 of file Karto.h.

template<typename T>
T karto::Rectangle2< T >::GetHeight ( ) const
inline

Gets the height of this rectangle

Returns
the height of this rectangle

Definition at line 1846 of file Karto.h.

template<typename T>
const Vector2<T>& karto::Rectangle2< T >::GetPosition ( ) const
inline

Gets the position of this rectangle

Returns
the position of this rectangle

Definition at line 1864 of file Karto.h.

template<typename T>
const Size2<T>& karto::Rectangle2< T >::GetSize ( ) const
inline

Gets the size of this rectangle

Returns
the size of this rectangle

Definition at line 1892 of file Karto.h.

template<typename T>
T karto::Rectangle2< T >::GetWidth ( ) const
inline

Gets the width of this rectangle

Returns
the width of this rectangle

Definition at line 1828 of file Karto.h.

template<typename T>
T karto::Rectangle2< T >::GetX ( ) const
inline

Gets the x-coordinate of the left edge of this rectangle

Returns
the x-coordinate of the left edge of this rectangle

Definition at line 1792 of file Karto.h.

template<typename T>
T karto::Rectangle2< T >::GetY ( ) const
inline

Gets the y-coordinate of the bottom edge of this rectangle

Returns
the y-coordinate of the bottom edge of this rectangle

Definition at line 1810 of file Karto.h.

template<typename T>
kt_bool karto::Rectangle2< T >::operator!= ( const Rectangle2< T > &  rOther) const
inline

Inequality operator

Definition at line 1938 of file Karto.h.

template<typename T>
Rectangle2& karto::Rectangle2< T >::operator= ( const Rectangle2< T > &  rOther)
inline

Assignment operator

Definition at line 1919 of file Karto.h.

template<typename T>
kt_bool karto::Rectangle2< T >::operator== ( const Rectangle2< T > &  rOther) const
inline

Equality operator

Definition at line 1930 of file Karto.h.

template<typename T>
void karto::Rectangle2< T >::SetHeight ( height)
inline

Sets the height of this rectangle

Parameters
heightthe height of this rectangle

Definition at line 1855 of file Karto.h.

template<typename T>
void karto::Rectangle2< T >::SetPosition ( const T &  rX,
const T &  rY 
)
inline

Sets the position of this rectangle

Parameters
rXx
rYy

Definition at line 1874 of file Karto.h.

template<typename T>
void karto::Rectangle2< T >::SetPosition ( const Vector2< T > &  rPosition)
inline

Sets the position of this rectangle

Parameters
rPositionposition

Definition at line 1883 of file Karto.h.

template<typename T>
void karto::Rectangle2< T >::SetSize ( const Size2< T > &  rSize)
inline

Sets the size of this rectangle

Parameters
rSizesize

Definition at line 1901 of file Karto.h.

template<typename T>
void karto::Rectangle2< T >::SetWidth ( width)
inline

Sets the width of this rectangle

Parameters
widththe width of this rectangle

Definition at line 1837 of file Karto.h.

template<typename T>
void karto::Rectangle2< T >::SetX ( x)
inline

Sets the x-coordinate of the left edge of this rectangle

Parameters
xthe x-coordinate of the left edge of this rectangle

Definition at line 1801 of file Karto.h.

template<typename T>
void karto::Rectangle2< T >::SetY ( y)
inline

Sets the y-coordinate of the bottom edge of this rectangle

Parameters
ythe y-coordinate of the bottom edge of this rectangle

Definition at line 1819 of file Karto.h.

Member Data Documentation

template<typename T>
Vector2<T> karto::Rectangle2< T >::m_Position
private

Definition at line 1944 of file Karto.h.

template<typename T>
Size2<T> karto::Rectangle2< T >::m_Size
private

Definition at line 1945 of file Karto.h.


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


open_karto
Author(s):
autogenerated on Mon Jun 10 2019 14:02:19