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

Classe de conteneur sphérique. Plus de détails...

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

Graphe de collaboration de Castor::SphereBox:

Liste de tous les membres

Fonctions membres publiques
	SphereBox ()
	Constructeur par défaut.
	SphereBox (SphereBox const &p_sphere)
	Constructeur par copie.
	SphereBox (SphereBox &&p_sphere)
	Constructeur par déplacement.
	SphereBox (Point3r const &p_center, real p_radius)
	Constructeur spécifié.
	SphereBox (CubeBox const &p_box)
	Constructeur à partir d'une CubeBox.
SphereBox &	operator= (SphereBox const &p_sphere)
	Opérateur d'affectation par copie.
SphereBox &	operator= (SphereBox &&p_sphere)
	Opérateur d'affectation par déplacement.
void	Load (Point3r const &p_center, real p_radius)
	Réinitialise la sphere box.
void	Load (CubeBox const &p_box)
	Réinitialise à partir d'une CubeBox.
virtual bool	IsWithin (Point3r const &p_v)
	Teste si un point est contenu dans le container (mais pas à la limite).
virtual bool	IsOnLimits (Point3r const &p_v)
	Teste si un point est sur la limite du container, et pas dedans.
real	GetRadius () const
	Récupère le rayon.

---

Description détaillée

Classe de conteneur sphérique.

Auteur:

Sylvain DOREMUS

Date:

14/02/2010

---

Documentation des constructeurs et destructeur

Castor::SphereBox::SphereBox

(

)

[inline]

Constructeur par défaut.

Castor::SphereBox::SphereBox

(

SphereBox const &

p_sphere

)

[inline]

Constructeur par copie.

Paramètres:

[in]

p_sphere

La sphere box à copier

Castor::SphereBox::SphereBox

(

SphereBox &&

p_sphere

)

[inline]

Constructeur par déplacement.

Paramètres:

[in]

p_sphere

La sphere box à déplacer

Castor::SphereBox::SphereBox	(	Point3r const &	p_center,
		real	p_radius
	)			[inline]

Constructeur spécifié.

Paramètres:

[in]	p_center	Le centre de la sphère
[in]	p_radius	Le rayon de la sphère

Castor::SphereBox::SphereBox

(

CubeBox const &

p_box

)

[inline]

Constructeur à partir d'une CubeBox.

Paramètres:

[in]

p_box

La CubeBox

---

Documentation des fonctions membres

real Castor::SphereBox::GetRadius

(

)

const [inline]

Récupère le rayon.

Renvoie:

Le rayon

virtual bool Castor::SphereBox::IsOnLimits

(

Point3r const &

p_v

)

[inline, 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

Voici le graphe d'appel pour cette fonction :

virtual bool Castor::SphereBox::IsWithin

(

Point3r const &

p_v

)

[inline, 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

Voici le graphe d'appel pour cette fonction :

void Castor::SphereBox::Load

(

CubeBox const &

p_box

)

[inline]

Réinitialise à partir d'une CubeBox.

Paramètres:

[in]

p_box

La CubeBox

Voici le graphe d'appel pour cette fonction :

void Castor::SphereBox::Load	(	Point3r const &	p_center,
		real	p_radius
	)			[inline]

Réinitialise la sphere box.

Paramètres:

[in]	p_center	Le centre
[in]	p_radius	Le rayon

Voici le graphe d'appel pour cette fonction :

SphereBox& Castor::SphereBox::operator=

(

SphereBox const &

p_sphere

)

[inline]

Opérateur d'affectation par copie.

Paramètres:

[in]

p_sphere

La sphere box à copier

Renvoie:

Une référence sur cette SphereBox

Voici le graphe d'appel pour cette fonction :

SphereBox& Castor::SphereBox::operator=

(

SphereBox &&

p_sphere

)

[inline]

Opérateur d'affectation par déplacement.

Paramètres:

[in]

p_sphere

La sphere box à déplacer

Renvoie:

Une référence sur cette SphereBox

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/Container.hpp