Référence de la classe Plan

Classe représentant un Plan infini. Plus de détails...

#include <Plan.h>

Graphe d'héritage de Plan:

Graphe de collaboration de Plan:

Liste de tous les membres

Fonctions membres publiques
	Plan (Vecteur const &origine=Vecteur(3), Vecteur const &normale=Vecteur(0, 0, 1), Couleur const &color=Couleur(1, 1, 1, 1), double const &alpha=0.8)
	Construit un Plan.
virtual	~Plan ()
	Destructeur, implanté pour le polymorphisme.
virtual Vecteur	pointPlusProche (ObjetMobile const &objet) const
	Sert à trouver le point du Plan le plus proche de l'ObjetMobile passé en argument.
virtual std::string	type () const
	Sert à obtenir le type Plan sous forme de chaîne de caractères.
virtual QFormLayout *	proprietesLayout () const
	Sert à créer un Layout contenant les propriétés du Plan en vue de l'interface graphique.
virtual void	enregistrer (std::ofstream &out) const
	Sert à envoyer l'état du Plan dans le flux passé en argument, dans un style XML.
Fonctions membres protégées
virtual void	affiche (std::ostream &out) const
	Affiche le Plan courant dans le flux passé en argument.
Attributs protégés
Couleur	m_couleur
	Couleur du Plan.

---

Description détaillée

Classe représentant un Plan infini.

Note:

Hérite de Obstacle

---

Documentation des constructeurs et destructeur

Plan::Plan	(	Vecteur const &	origine = Vecteur(3),
		Vecteur const &	normale = Vecteur(0,0,1),
		Couleur const &	color = Couleur(1,1,1,1),
		double const &	alpha = 0.8
	)

Construit un Plan.

Paramètres:

origine	Origine du Plan, par défault le Vecteur nul de dimension 3
normale	Normale au Plan, par défault le Vecteur unitaire sur l'axe z {0,0,1}
color	Couleur du Plan, par défault Couleur(1,1,1,1) (Blanc)
alpha	Coefficient de rebonds du Plan, par défault 0.8

Plan::~Plan

(

)

[virtual]

Destructeur, implanté pour le polymorphisme.

---

Documentation des fonctions membres

Vecteur Plan::pointPlusProche

(

ObjetMobile const &

objet

)

const [virtual]

Sert à trouver le point du Plan le plus proche de l'ObjetMobile passé en argument.

Paramètres:

objet

ObjetMobile dont on doit déterminer le point le plus proche

Renvoie:

Retourne le Vecteur des coordonnées du point du Plan le plus proche de l'ObjetMobile

Implémente Obstacle.

Réimplémentée dans PlanFini.

string Plan::type

(

)

const [virtual]

Sert à obtenir le type Plan sous forme de chaîne de caractères.

Renvoie:

Retourne std::string("Plan")

Note:

Utilisée pour la liste des Elements dans l'interface graphique

Implémente Element.

Réimplémentée dans Plan3D, PlanFini, et PlanFini3D.

QFormLayout * Plan::proprietesLayout

(

)

const [virtual]

Sert à créer un Layout contenant les propriétés du Plan en vue de l'interface graphique.

Renvoie:

Retourne un pointeur sur un QFormLayout dont les champs contiennent les propriétés du Plan

Implémente Element.

Réimplémentée dans PlanFini.

virtual void Plan::enregistrer

(

std::ofstream &

out

)

const [virtual]

Sert à envoyer l'état du Plan dans le flux passé en argument, dans un style XML.

Paramètres:

out	Flux de sortie

Implémente Element.

Réimplémentée dans Plan3D, PlanFini, et PlanFini3D.

virtual void Plan::affiche

(

std::ostream &

out

)

const [protected, virtual]

Affiche le Plan courant dans le flux passé en argument.

Paramètres:

out	Flux de sortie

Implémente Dessinable.

Réimplémentée dans PlanFini.

---

Documentation des données membres

Couleur Plan::m_couleur [protected]

Couleur du Plan.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• include/Plan.h
• src/Plan.cpp