Référence de la classe PlanFini

Classe représentant une portion de Plan. Plus de détails...

#include <PlanFini.h>

Graphe d'héritage de PlanFini:

Graphe de collaboration de PlanFini:

Liste de tous les membres

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

---

Description détaillée

Classe représentant une portion de Plan.

Note:

Hérite de Plan

---

Documentation des constructeurs et destructeur

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

Construit un PlanFini.

Paramètres:

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

PlanFini::~PlanFini

(

)

[virtual]

Destructeur, implanté pour le polymorphisme.

---

Documentation des fonctions membres

Vecteur PlanFini::pointPlusProche

(

ObjetMobile const &

objet

)

const [virtual]

Sert à trouver le point du PlanFini 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 PlanFini le plus proche de l'ObjetMobile

Réimplémentée à partir de Plan.

Vecteur const & PlanFini::longueur

(

)

const

Accesseur pour PlanFini::m_longueur.

Renvoie:

Retourne une référence constante sur PlanFini::m_longueur

Vecteur const & PlanFini::largeur

(

)

const

Accesseur pour PlanFini::m_largeur.

Renvoie:

Retourne une référence constante sur PlanFini::m_largeur

string PlanFini::type

(

)

const [virtual]

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

Renvoie:

Retourne std::string("PlanFini")

Note:

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

Réimplémentée à partir de Plan.

Réimplémentée dans PlanFini3D.

QFormLayout * PlanFini::proprietesLayout

(

)

const [virtual]

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

Renvoie:

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

Réimplémentée à partir de Plan.

virtual void PlanFini::enregistrer

(

std::ofstream &

out

)

const [virtual]

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

Paramètres:

out	Flux de sortie

Réimplémentée à partir de Plan.

Réimplémentée dans PlanFini3D.

virtual void PlanFini::affiche

(

std::ostream &

out

)

const [protected, virtual]

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

Paramètres:

out	Flux de sortie

Réimplémentée à partir de Plan.

---

Documentation des données membres

Vecteur const PlanFini::m_longueur [private]

Longueur du Plan.

Vecteur const PlanFini::m_largeur [private]

Largeur du Plan.

---

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

• include/PlanFini.h
• src/PlanFini.cpp