Stargen_XMLparser Class Reference

Gestion des fichiers de description de planetes au format StarGenII. More...

#include <Stargen_XMLparser.h>

Inheritance diagram for Stargen_XMLparser:

List of all members.

Public Member Functions
	Stargen_XMLparser (String XMLfile)
	Constructeur (on execute le Constructeur de la surclasse).
virtual	~Stargen_XMLparser ()
	Destructeur (on execute le destructeur de la surclasse).
void	gotoTopOfFile ()
	On réinitialise les pointeurs parcourant le fichier DotScene.
bool	gotoPlanet (int index)
	On se positionne sur une planete du systeme solaire.
bool	gotoStar ()
	On se positionne sur le node STAR de la scene.
String	getPlanetAttribute (String childnode, String attribute)
	Renvoie l'attribut demandé du node child.
bool	gotoRoomDoor ()
	On se positionne sur le node DOOR de la ROOM courante.
bool	gotoRoomDoorPanel ()
	On se positionne sur le node PANEL de la DOOR courante.
bool	getNextSubObject ()
	On se positionne sur le tag "node" suivant, appartenant à la Room en cours, et contenant un element "entity".
String	getUserdata (String PropertyName)
	On analyse les <userdata> du Node courant, et on renvoie la DATA correspondant à la property demandée.
bool	getBooleanUserdata (String PropertyName)
	On analyse les <userdata> du Node courant, et on renvoie la DATA correspondant à la property demandée.
bool	hasMoreNodes ()
	Cette fonction indique si, d'une façon ou d'une autre, on a atteint la fin des <node> de <nodes>.
Protected Member Functions
String	getUserdata (void *node, String PropertyName)
	On analyse les <userdata> du Node demandé, et on renvoie la DATA correspondant à la property demandée.
Protected Attributes
int	mRoomIndex
	position courante dans les listes d'éléments XML
int	mDoorIndex
	position courante dans les listes d'éléments XML
int	mObjectIndex
	position courante dans les listes d'éléments XML
int	mLightIndex
	position courante dans les listes d'éléments XML
bool	mNoMoreNodes
	indicateur de fin de fichier XML
void *	mRoomElement
	Handle sur la ROOM de la scene.
void *	mDoorElement
	Handle sur la DOOR de la scene.

---

Detailed Description

Gestion des fichiers de description de planetes au format StarGenII.

---

Constructor & Destructor Documentation

Stargen_XMLparser::Stargen_XMLparser (  String  XMLfile  )

Constructeur (on execute le Constructeur de la surclasse).

Stargen_XMLparser::~Stargen_XMLparser (   )  [virtual]

Destructeur (on execute le destructeur de la surclasse).

---

Member Function Documentation

bool Stargen_XMLparser::getBooleanUserdata (  String  PropertyName  )

On analyse les <userdata> du Node courant, et on renvoie la DATA correspondant à la property demandée. Parameters: PropertyName  Attribut NAME du tag <property> dont on veut recuperer la DATA Returns: La valeur de l'attribut DATA correspondant. Les attributs TYPE et NAME de "property" doivent être en majuscules

bool Stargen_XMLparser::getNextSubObject (   )

On se positionne sur le tag "node" suivant, appartenant à la Room en cours, et contenant un element "entity". On renvoie FALSE si on trouve pas d'objet.

String Stargen_XMLparser::getPlanetAttribute (  String  childnode, String  attribute )

Renvoie l'attribut demandé du node child. Parameters: childnode  Le nom du node fils du node courant. attribute  Le nom de l'attribut demandé. Returns: la valeur de l'attribut (String)

String Stargen_XMLparser::getUserdata (  void *  node, String  PropertyName )  [protected]

On analyse les <userdata> du Node demandé, et on renvoie la DATA correspondant à la property demandée. Parameters: node  Node parent dont on veut lire une <userdata> PropertyName  Nom du tag <property> dont on veut recuperer la DATA Returns: La valeur de l'attribut DATA correspondant. Tous les attributs de Property (type, name et data) doivent être en majuscules.

String Stargen_XMLparser::getUserdata (  String  PropertyName  )

On analyse les <userdata> du Node courant, et on renvoie la DATA correspondant à la property demandée. Parameters: PropertyName  Attribut NAME du tag <property> dont on veut recuperer la DATA Returns: La valeur de l'attribut DATA correspondant. Les attributs TYPE et NAME de "property" doivent être en majuscules

bool Stargen_XMLparser::gotoPlanet (  int  index  )

On se positionne sur une planete du systeme solaire. Parameters: index  Position du node correspondant à la planete dans le fichier XML [1..N]. Returns: La fonction renvoie FALSE, si le node n'est pas trouvé. On renvoie FALSE si on trouve pas le node planet

bool Stargen_XMLparser::gotoRoomDoor (   )

On se positionne sur le node DOOR de la ROOM courante. Dans la nouvelle structure des DotScene decrivant un Level, la porte est un node Child de la pièce. Returns: La fonction renvoie FALSE, si le node n'est pas trouvé. On renvoie FALSE si on trouve pas la porte.

bool Stargen_XMLparser::gotoRoomDoorPanel (   )

On se positionne sur le node PANEL de la DOOR courante. Dans la nouvelle structure des DotScene decrivant un Level, le panel est le (seul) node Child de la porte. Returns: La fonction renvoie FALSE, si le node n'est pas trouvé. On renvoie FALSE si on trouve pas le panel.

bool Stargen_XMLparser::gotoStar (   )

On se positionne sur le node STAR de la scene. On renvoie FALSE si on trouve pas le node Star

void Stargen_XMLparser::gotoTopOfFile (   )

On réinitialise les pointeurs parcourant le fichier DotScene.

bool Stargen_XMLparser::hasMoreNodes (   )

Cette fonction indique si, d'une façon ou d'une autre, on a atteint la fin des <node> de <nodes>. Returns: FALSE si la fin des node a été atteinte.

---

Member Data Documentation

void* Stargen_XMLparser::mDoorElement [protected]

Handle sur la DOOR de la scene.

int Stargen_XMLparser::mDoorIndex [protected]

position courante dans les listes d'éléments XML

int Stargen_XMLparser::mLightIndex [protected]

position courante dans les listes d'éléments XML

bool Stargen_XMLparser::mNoMoreNodes [protected]

indicateur de fin de fichier XML

int Stargen_XMLparser::mObjectIndex [protected]

position courante dans les listes d'éléments XML

void* Stargen_XMLparser::mRoomElement [protected]

Handle sur la ROOM de la scene.

int Stargen_XMLparser::mRoomIndex [protected]

position courante dans les listes d'éléments XML

---

The documentation for this class was generated from the following files:

• E:/sphinx/LFE/Stargen_XMLparser.h
• E:/sphinx/LFE/Stargen_XMLparser.cpp

---