Référence de la classe Castor::ContainerBox< Dimension > (modèle)

Classe de conteneur boîte. Plus de détails...

Graphe d'héritage de Castor::ContainerBox< Dimension >:

Graphe de collaboration de Castor::ContainerBox< Dimension >:

Liste de tous les membres

Fonctions membres publiques
	ContainerBox ()
	Constructeur par défaut.
	ContainerBox (ContainerBox const &p_container)
	Constructeur par copie.
	ContainerBox (ContainerBox &&p_container)
	Constructeur par déplacement.
	ContainerBox (Point< real, Dimension > const &p_ptCenter)
	Constructeur à partir du centre.
ContainerBox &	operator= (ContainerBox const &p_container)
	Opérateur d'affectation par copie.
ContainerBox &	operator= (ContainerBox &&p_container)
	Opérateur d'affectation par déplacement.
virtual bool	IsWithin (Point< real, Dimension > const &p_v)=0
	Teste si un point est contenu dans le container (mais pas à la limite).
virtual bool	IsOnLimits (Point< real, Dimension > const &p_v)=0
	Teste si un point est sur la limite du container, et pas dedans.
Point< real, Dimension > const &	GetCenter () const
	Récupère le centre de ce conteneur.
Point< real, Dimension > &	GetCenter ()
	Récupère le centre de ce conteneur.
Types protégés
typedef Castor::Policy< real >	policy
Attributs protégés
Point< real, Dimension >	m_ptCenter
	Le centre de ce conteneur.

---

Description détaillée

template<std::size_t Dimension>
class Castor::ContainerBox< Dimension >

Classe de conteneur boîte.

Auteur:

Sylvain DOREMUS

Date:

14/02/2010

Remarques:

Un conteneur boîte est un simple objet encadrant un objet graphique (2D ou 3D)
Ce peut être un parallélépipède, une sphère ou autre.

---

Documentation des définitions de type membres

template<std::size_t Dimension>

typedef Castor::Policy< real > Castor::ContainerBox< Dimension >::policy [protected]

---

Documentation des constructeurs et destructeur

template<std::size_t Dimension>

Castor::ContainerBox< Dimension >::ContainerBox

(

)

[inline]

Constructeur par défaut.

template<std::size_t Dimension>

Castor::ContainerBox< Dimension >::ContainerBox

(

ContainerBox< Dimension > const &

p_container

)

[inline]

Constructeur par copie.

Paramètres:

[in]

p_container

Le conteneur à copier

Voici le graphe d'appel pour cette fonction :

template<std::size_t Dimension>

Castor::ContainerBox< Dimension >::ContainerBox

(

ContainerBox< Dimension > &&

p_container

)

[inline]

Constructeur par déplacement.

Paramètres:

[in]

p_container

Le conteneur à déplacer

template<std::size_t Dimension>

Castor::ContainerBox< Dimension >::ContainerBox

(

Point< real, Dimension > const &

p_ptCenter

)

[inline]

Constructeur à partir du centre.

Paramètres:

[in]

p_ptCenter

Le centre

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

template<std::size_t Dimension>

Point< real, Dimension > const& Castor::ContainerBox< Dimension >::GetCenter

(

)

const [inline]

Récupère le centre de ce conteneur.

Renvoie:

Une référence constante sur le centre

Voici le graphe d'appel pour cette fonction :

template<std::size_t Dimension>

Point< real, Dimension >& Castor::ContainerBox< Dimension >::GetCenter

(

)

[inline]

Récupère le centre de ce conteneur.

Renvoie:

Une référence non constante sur le centre

template<std::size_t Dimension>

virtual bool Castor::ContainerBox< Dimension >::IsOnLimits

(

Point< real, Dimension > const &

p_v

)

[pure virtual]

Teste si un point est sur la limite du container, et pas dedans.

Paramètres:

[in]

p_v

Le point à tester

Renvoie:

true si le point est sur la limite

template<std::size_t Dimension>

virtual bool Castor::ContainerBox< Dimension >::IsWithin

(

Point< real, Dimension > const &

p_v

)

[pure virtual]

Teste si un point est contenu dans le container (mais pas à la limite).

Paramètres:

[in]

p_v

Le point à tester

Renvoie:

true si le point est dans le container

template<std::size_t Dimension>

ContainerBox& Castor::ContainerBox< Dimension >::operator=

(

ContainerBox< Dimension > const &

p_container

)

[inline]

Opérateur d'affectation par copie.

Paramètres:

[in]

p_container

Le conteneur à copier

Renvoie:

Une référence sur ce conteneur

Voici le graphe d'appel pour cette fonction :

template<std::size_t Dimension>

ContainerBox& Castor::ContainerBox< Dimension >::operator=

(

ContainerBox< Dimension > &&

p_container

)

[inline]

Opérateur d'affectation par déplacement.

Paramètres:

[in]

p_container

Le conteneur à déplacer

Renvoie:

Une référence sur ce conteneur

---

Documentation des données membres

template<std::size_t Dimension>

Point< real, Dimension > Castor::ContainerBox< Dimension >::m_ptCenter [protected]

Le centre de ce conteneur.

---

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

• include/CastorUtils/Container.hpp