Tizen(Headed) Native API  6.5
Public Member Functions
Dali::Rect< T > Struct Template Reference
Math

Template class to create and operate on rectangles. More...

Public Member Functions

 Rect ()
 Constructor.
 Rect (T x, T y, T width, T height)
 Constructor.
 Rect (const Rect< T > &rhs)
 Copy constructor.
Rect< T > & operator= (const Rect< T > &rhs)
 Assignment operator.
void Set (T newX, T newY, T newWidth, T newHeight)
 Assignment from individual values.
bool IsEmpty () const
 Determines whether or not this Rectangle is empty.
bool IsValid () const
 Determines whether or not this Rectangle is valid.
T Left () const
 Gets the left of the rectangle.
T Right () const
 Gets the right of the rectangle.
T Top () const
 Gets the top of the rectangle.
T Bottom () const
 Gets the bottom of the rectangle.
T Area () const
 Gets the area of the rectangle.
bool Intersects (const Rect< T > &other) const
 Determines whether or not this rectangle and the specified rectangle intersect.
bool Intersect (const Rect< T > &rect)
 Intersects this rectangle and the specified rectangle. The result of the intersection is stored in this rectangle.
void Merge (const Rect< T > &rect)
 Merges this rectangle and the specified rectangle. The result of the merge is stored in this rectangle.
void Inset (T dx, T dy)
 Inset the rectangle by (dx,dy). If dx is positive, then the sides are moved inwards. If dx is negative, then the sides are moved outwards. The result of the inset is stored in this rectangle.
bool Contains (const Rect< T > &other) const
 Determines whether or not this Rectangle contains the specified rectangle.
template<>
bool IsEmpty () const

Detailed Description

template<typename T = float>
struct Dali::Rect< T >

Template class to create and operate on rectangles.

Since:
2.4, DALi version 1.0.0

Constructor & Destructor Documentation

template<typename T = float>
Dali::Rect< T >::Rect ( )

Constructor.

Since:
2.4, DALi version 1.0.0
template<typename T = float>
Dali::Rect< T >::Rect ( T  x,
T  y,
T  width,
T  height 
)

Constructor.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]xX coordinate (or left)
[in]yY coordinate (or right)
[in]widthWidth (or bottom)
[in]heightHeight (or top)
template<typename T = float>
Dali::Rect< T >::Rect ( const Rect< T > &  rhs)

Copy constructor.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]rhsThe original object

Member Function Documentation

template<typename T = float>
T Dali::Rect< T >::Area ( ) const

Gets the area of the rectangle.

Since:
2.4, DALi version 1.0.0
Returns:
The area of the rectangle
template<typename T = float>
T Dali::Rect< T >::Bottom ( ) const

Gets the bottom of the rectangle.

Since:
2.4, DALi version 1.0.0
Returns:
The bottom of the rectangle
template<typename T = float>
bool Dali::Rect< T >::Contains ( const Rect< T > &  other) const

Determines whether or not this Rectangle contains the specified rectangle.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]otherThe other rectangle to test against this rectangle
Returns:
True if the specified rectangle is contained
template<typename T = float>
void Dali::Rect< T >::Inset ( T  dx,
T  dy 
)

Inset the rectangle by (dx,dy). If dx is positive, then the sides are moved inwards. If dx is negative, then the sides are moved outwards. The result of the inset is stored in this rectangle.

Since:
6.0, DALi version 1.5.18
template<typename T = float>
bool Dali::Rect< T >::Intersect ( const Rect< T > &  rect)

Intersects this rectangle and the specified rectangle. The result of the intersection is stored in this rectangle.

Since:
6.0, DALi version 1.5.18
Parameters:
[in]rectThe other rectangle to intersect with
Returns:
True if the rectangles intersect
template<typename T = float>
bool Dali::Rect< T >::Intersects ( const Rect< T > &  other) const

Determines whether or not this rectangle and the specified rectangle intersect.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]otherThe other rectangle to test against this rectangle
Returns:
True if the rectangles intersect
template<typename T = float>
bool Dali::Rect< T >::IsEmpty ( ) const

Determines whether or not this Rectangle is empty.

Since:
2.4, DALi version 1.0.0
Returns:
True if width or height are zero
template<>
bool Dali::Rect< float >::IsEmpty ( ) const
Since:
2.4, DALi version 1.0.0
Returns:
True if the rectangle has zero size
template<typename T = float>
bool Dali::Rect< T >::IsValid ( ) const

Determines whether or not this Rectangle is valid.

Since:
6.0, DALi version 1.5.18
Returns:
True if width and height are not negative
template<typename T = float>
T Dali::Rect< T >::Left ( ) const

Gets the left of the rectangle.

Since:
2.4, DALi version 1.0.0
Returns:
The left edge of the rectangle
template<typename T = float>
void Dali::Rect< T >::Merge ( const Rect< T > &  rect)

Merges this rectangle and the specified rectangle. The result of the merge is stored in this rectangle.

Since:
6.0, DALi version 1.5.18
Parameters:
[in]rectThe other rectangle to merge with
template<typename T = float>
Rect<T>& Dali::Rect< T >::operator= ( const Rect< T > &  rhs)

Assignment operator.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]rhsThe original object
Returns:
Reference to this
template<typename T = float>
T Dali::Rect< T >::Right ( ) const

Gets the right of the rectangle.

Since:
2.4, DALi version 1.0.0
Returns:
The right edge of the rectangle
template<typename T = float>
void Dali::Rect< T >::Set ( T  newX,
T  newY,
T  newWidth,
T  newHeight 
)

Assignment from individual values.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]newXX coordinate
[in]newYY coordinate
[in]newWidthWidth
[in]newHeightHeight
template<typename T = float>
T Dali::Rect< T >::Top ( ) const

Gets the top of the rectangle.

Since:
2.4, DALi version 1.0.0
Returns:
The top of the rectangle