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

Classe représentant un rectangle. Plus de détails...

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

Graphe de collaboration de Castor::Rectangle:

Liste de tous les membres

Fonctions membres publiques
	Rectangle (Point2i const &p_ptOrigin=Point2i(0, 0), Point2i const &p_ptSize=Point2i(0, 0))
	Constructeur.
	Rectangle (int p_iLeft, int p_iTop, int p_iWidth, int p_iHeight)
	Constructeur.
eINTERSECTION	Intersects (Point2i const &p_ptPoint) const
	Teste si le point donné est sur ou dans ce rectangle.
eINTERSECTION	Intersects (Rectangle const &p_rcRect) const
	Teste si le rectangle donné intersecte ce rectangle.
void	Set (int p_iLeft, int p_iTop, int p_iWidth, int p_iHeight)
	Définit le rectangle.
void	Size (Point2i &p_ptResult) const
	Récupère les dimensions du rectangle.
int	Left () const
	Récupère la coordonnée gauche.
int	Right () const
	Récupère la coordonnée droite.
int	Top () const
	Récupère la coordonnée haute.
int	Bottom () const
	Récupère la coordonnée basse.
int	Width () const
	Récupère la largeur.
int	Height () const
	Récupère la hauteur.

---

Description détaillée

Classe représentant un rectangle.

Auteur:

Sylvain DOREMUS

Version:

0.6.1.0

Date:

03/01/2011

Remarques:

Dérive de Point, gère les intersections entre rectangles et les accesseurs spécifiques

---

Documentation des constructeurs et destructeur

Castor::Rectangle::Rectangle	(	Point2i const &	p_ptOrigin = Point2i(0, 0),
		Point2i const &	p_ptSize = Point2i(0, 0)
	)

Constructeur.

Paramètres:

[in]	p_ptOrigin	Position
[in]	p_ptSize	Dimensions

Castor::Rectangle::Rectangle	(	int	p_iLeft,
		int	p_iTop,
		int	p_iWidth,
		int	p_iHeight
	)

Constructeur.

Paramètres:

[in]	p_iLeft,p_iTop	Position
[in]	p_iWidth,p_iHeight	Dimensions

---

Documentation des fonctions membres

int Castor::Rectangle::Bottom

(

)

const [inline]

Récupère la coordonnée basse.

Renvoie:

La coordonnée basse du rectangle

Voici le graphe d'appel pour cette fonction :

int Castor::Rectangle::Height

(

)

const [inline]

Récupère la hauteur.

Renvoie:

La hauteur du rectangle

Voici le graphe d'appel pour cette fonction :

eINTERSECTION Castor::Rectangle::Intersects

(

Rectangle const &

p_rcRect

)

const

Teste si le rectangle donné intersecte ce rectangle.

Paramètres:

[in]

p_rcRect

Le rectangle à tester

Renvoie:

Le type d'intersection entre les 2 rectangles

eINTERSECTION Castor::Rectangle::Intersects

(

Point2i const &

p_ptPoint

)

const

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

Paramètres:

[in]

p_ptPoint

Le point à tester

Renvoie:

eINTERSECTION_IN si sur ou dedans, eINTERSECTION_OUT sinon

int Castor::Rectangle::Left

(

)

const [inline]

Récupère la coordonnée gauche.

Renvoie:

La coordonnée gauche du rectangle

Voici le graphe d'appel pour cette fonction :

int Castor::Rectangle::Right

(

)

const [inline]

Récupère la coordonnée droite.

Renvoie:

La coordonnée droite du rectangle

Voici le graphe d'appel pour cette fonction :

void Castor::Rectangle::Set	(	int	p_iLeft,
		int	p_iTop,
		int	p_iWidth,
		int	p_iHeight
	)

Définit le rectangle.

Paramètres:

[in]	p_iLeft,p_iTop	Position
[in]	p_iWidth,p_iHeight	Dimensions

void Castor::Rectangle::Size

(

Point2i &

p_ptResult

)

const

Récupère les dimensions du rectangle.

Paramètres:

[out]

p_ptResult

Les dimensions du rectangle

int Castor::Rectangle::Top

(

)

const [inline]

Récupère la coordonnée haute.

Renvoie:

La coordonnée haute du rectangle

Voici le graphe d'appel pour cette fonction :

int Castor::Rectangle::Width

(

)

const [inline]

Récupère la largeur.

Renvoie:

La largeur du rectangle

Voici le graphe d'appel pour cette fonction :

---

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

• include/CastorUtils/Rectangle.hpp