Référence de la classe castor::Rectangle

#include <Rectangle.hpp>

Graphe d'héritage de castor::Rectangle:

Graphe de collaboration de castor::Rectangle:

Fonctions membres publiques
CU_API	Rectangle (Position const &origin=Position(), Size const &size=Size())
	Constructeur.
CU_API	Rectangle (int32_t left, int32_t top, int32_t right, int32_t bottom)
	Constructeur.
CU_API Intersection	intersects (Position const &point) const
	Teste si le point donné est sur ou dans ce rectangle.
CU_API Intersection	intersects (Rectangle const &rect) const
	Teste si le rectangle donné intersecte ce rectangle.
CU_API void	set (int32_t left, int32_t top, int32_t right, int32_t bottom)
	Définit le rectangle.
CU_API void	size (Size &result) const
	Récupère les dimensions du rectangle.
int	left () const
	Récupère la coordonnée gauche.
int &	left ()
	Récupère la coordonnée gauche.
int	right () const
	Récupère la coordonnée droite.
int &	right ()
	Récupère la coordonnée droite.
int	top () const
	Récupère la coordonnée haute.
int &	top ()
	Récupère la coordonnée haute.
int	bottom () const
	Récupère la coordonnée basse.
int &	bottom ()
	Récupère la coordonnée basse.
int	getWidth () const
	Récupère la largeur.
int	getHeight () const
	Récupère la hauteur.

Documentation des constructeurs et destructeur

Rectangle() [1/2]

CU_API castor::Rectangle::Rectangle	(	Position const &	origin = Position(),
		Size const &	size = Size() )

Constructeur.

Paramètres

[in]	origin	Position
[in]	size	Dimensions

Rectangle() [2/2]

CU_API castor::Rectangle::Rectangle	(	int32_t	left,
		int32_t	top,
		int32_t	right,
		int32_t	bottom )

Constructeur.

Paramètres

[in]	left,top	Point haut gauche
[in]	right,bottom	Point bas droit

Documentation des fonctions membres

bottom() [1/2]

int & castor::Rectangle::bottom ( )

inline

Récupère la coordonnée basse.

Renvoie

La coordonnée basse du rectangle

Références castor::RectangleData::Mbr::bottom, castor::DataHolderT< RectangleData >::getData(), et castor::RectangleData::rect.

Voici le graphe d'appel pour cette fonction :

bottom() [2/2]

int castor::Rectangle::bottom ( ) const

inline

Récupère la coordonnée basse.

Renvoie

La coordonnée basse du rectangle

Références castor::RectangleData::Mbr::bottom, castor::DataHolderT< RectangleData >::getData(), et castor::RectangleData::rect.

Voici le graphe d'appel pour cette fonction :

getHeight()

int castor::Rectangle::getHeight ( ) const

inline

Récupère la hauteur.

Renvoie

La hauteur du rectangle

Références castor::RectangleData::Mbr::bottom, castor::DataHolderT< RectangleData >::getData(), castor::RectangleData::rect, et castor::RectangleData::Mbr::top.

Voici le graphe d'appel pour cette fonction :

getWidth()

int castor::Rectangle::getWidth ( ) const

inline

Récupère la largeur.

Renvoie

La largeur du rectangle

Références castor::DataHolderT< RectangleData >::getData(), castor::RectangleData::Mbr::left, castor::RectangleData::rect, et castor::RectangleData::Mbr::right.

Voici le graphe d'appel pour cette fonction :

intersects() [1/2]

CU_API Intersection castor::Rectangle::intersects

(

Position const &

point

)

const

Teste si le point donné est sur ou dans ce rectangle.

Paramètres

[in]

point

Le point à tester

Renvoie

Intersection::eIn si sur ou dedans, Intersection::eOut sinon

intersects() [2/2]

CU_API Intersection castor::Rectangle::intersects

(

Rectangle const &

rect

)

const

Teste si le rectangle donné intersecte ce rectangle.

Paramètres

[in]

rect

Le rectangle à tester

Renvoie

Le type d'intersection entre les 2 rectangles

left() [1/2]

int & castor::Rectangle::left ( )

inline

Récupère la coordonnée gauche.

Renvoie

La coordonnée gauche du rectangle

Références castor::DataHolderT< RectangleData >::getData(), castor::RectangleData::Mbr::left, et castor::RectangleData::rect.

Voici le graphe d'appel pour cette fonction :

left() [2/2]

int castor::Rectangle::left ( ) const

inline

Récupère la coordonnée gauche.

Renvoie

La coordonnée gauche du rectangle

Références castor::DataHolderT< RectangleData >::getData(), castor::RectangleData::Mbr::left, et castor::RectangleData::rect.

Voici le graphe d'appel pour cette fonction :

right() [1/2]

int & castor::Rectangle::right ( )

inline

Récupère la coordonnée droite.

Renvoie

La coordonnée droite du rectangle

Références castor::DataHolderT< RectangleData >::getData(), castor::RectangleData::rect, et castor::RectangleData::Mbr::right.

Voici le graphe d'appel pour cette fonction :

right() [2/2]

int castor::Rectangle::right ( ) const

inline

Récupère la coordonnée droite.

Renvoie

La coordonnée droite du rectangle

Références castor::DataHolderT< RectangleData >::getData(), castor::RectangleData::rect, et castor::RectangleData::Mbr::right.

Voici le graphe d'appel pour cette fonction :

set()

CU_API void castor::Rectangle::set	(	int32_t	left,
		int32_t	top,
		int32_t	right,
		int32_t	bottom )

Définit le rectangle.

Paramètres

[in]	left,top	Point haut gauche
[in]	right,bottom	Point bas droit

size()

CU_API void castor::Rectangle::size

(

Size &

result

)

const

Récupère les dimensions du rectangle.

Paramètres

[out]

result

Les dimensions du rectangle

top() [1/2]

int & castor::Rectangle::top ( )

inline

Récupère la coordonnée haute.

Renvoie

La coordonnée haute du rectangle

Références castor::DataHolderT< RectangleData >::getData(), castor::RectangleData::rect, et castor::RectangleData::Mbr::top.

Voici le graphe d'appel pour cette fonction :

top() [2/2]

int castor::Rectangle::top ( ) const

inline

Récupère la coordonnée haute.

Renvoie

La coordonnée haute du rectangle

Références castor::DataHolderT< RectangleData >::getData(), castor::RectangleData::rect, et castor::RectangleData::Mbr::top.

Voici le graphe d'appel pour cette fonction :

---

La documentation de cette classe a été générée à partir du fichier suivant :

• CastorUtils/Graphics/Rectangle.hpp