Hibernation Class Reference

Gestion des objets de type caisson d'Hibernation. More...

#include <Hibernation.h>

List of all members.

Public Member Functions
	Hibernation (String Name, String MeshFile, SceneNode *ParentNode, SceneManager *SceneMgr)
	Constructeur.
virtual	~Hibernation ()
	Destruction.
bool	frameStarted (const FrameEvent &evt)
	Gère les animations de la capsule d'hibernation.
void	addFrameListener (short User)
	Gère le lancement du FrameListener.
long	getTypeID (void) const
	Surchage de la fonction d'identification de la classe UserDefinedObject.
void	addToScene ()
	Ajoute la caisson à la scene courante.
void	removeFromScene ()
	Retire la capsule de la scene courante.
void	setPosition (Vector3 Position)
	Positionne le caisson.
Vector3	getPosition (String RelativeTo="PARENT")
	Renvoie la position du Caisson. RelativeTo peut valoir "PARENT" ou "SHIP".
void	setOrientation (int Orientation)
	Oriente le caisson.
void	setOrientation (Quaternion Orientation)
	Oriente le caisson.
void	setBroken (bool broken)
	Gere les pannes du caisson.
void	setFocusOn ()
	On active le focus au moment ou la souris passe sur l'objet.
void	setFocusOff ()
	Quand on perd le focus, on détruit le GUI d'interface Hibernation.
void	createInterface ()
	Crée un objet d'Interface Hibernation (GUI).
void	removeInterface ()
	Détruit un objet d'Interface Hibernation (GUI).
void	hideInterface ()
	L'interface est masquée mais pas détruite.
void	requestExitInterface (Real seconds)
	Mémorise une demande de fin de la GUI.
bool	isExitInterfaceRequiered ()
	Renvoie TRUE si une demande de sortie de GUI est en cours.
bool	isInterfaceDisabled ()
	Renvoie TRUE si le GUI est inactif (cad non affiché).
bool	isBroken ()
	Renvois TRUE si le caisson est endommagé.
bool	isOpened ()
	Renvoie TRUE si le caisson est ouvert.
bool	isClosed ()
	Renvoie TRUE si le caisson est fermé.
bool	closeDoor ()
	Ferme le couvercle de la capsule.
bool	openDoor ()
	Ouvre le couvercle de la capsule.
void	startSequence ()
	Lance la séquence d'hibernation.
void	endSequence ()
	Lance la séquence de fin d'hibernation.
void	loadObject ()
	Charge les parametres initiaux du caisson.
void	climb ()
	Monte ou descent du caisson (pour le joueur).
void	climbIn ()
	Le joueur monte dans le caisson.
void	climbOut ()
	Le joueur descend du caisson.
void	setDuration (int duration)
	Mémorise la durée de l'hibernation à effectuer.
void	setMaterialScreen ()
	Met à jour l'image réduite de l'interface de commande du Caisson.
String	getStatus ()
	Renvoie le status du caisson d'hibernation sous forme de chaine XML.
String	getName ()
	Renvoie le nom du caisson.
Protected Types
enum	tStatus { OPENED, CLOSED, OPENING, CLOSING }
enum	tPhase { IDLE, STARTING, OPERATING, ENDING }
Protected Attributes
Root *	mRoot
SceneManager *	mSceneMgr
String	mHibernationName
SceneNode *	mHibernationNode
SceneNode *	mParentNode
Entity *	mEntity
int	mScreenEntity
bool	mBroken
bool	mLocked
bool	mHasFocus
tPhase	mPhase
Real	mFineClock
int	mGrossClock
int	mLastGrossClock
int	mCptFrame
int	mTemperature
int	mInitialDuration
long	mInitialDate
long	mFinalDate
Body *	mSubject
String	mSubjectName
bool	mExitGui
Real	mExitGuiDelay
tStatus	mStatus
AnimationState *	mAnimState
Real	mAnimationSpeed
short	mListenerNeeded
Real	mEndFog
int	mOpenSoundChannel
int	mStartSoundChannel
int	mEndSoundChannel
int	mOperatingSoundChannel
int	mHelloSoundChannel
int	mOperatingSoundFrequency
int	mOperatingSoundVolume
SceneNode *	mParticulesNode
ParticleSystem *	mSmoke
ParticleSystem *	mSparks
ParticleSystem *	mGivre
String	mMeshFile
String	mInterfaceFile
String	mOpenSoundFile
String	mStartSoundFile
String	mEndSoundFile
String	mHelloSoundFile
String	mOperatingSoundFile
Hibernation_Interface *	mHibernation_GUI
Friends
class	Hibernation_Interface

---

Detailed Description

Gestion des objets de type caisson d'Hibernation.

---

Member Enumeration Documentation

enum Hibernation::tPhase [protected]

Enumerator: IDLE  STARTING  OPERATING  ENDING

enum Hibernation::tStatus [protected]

Enumerator: OPENED  CLOSED  OPENING  CLOSING

---

Constructor & Destructor Documentation

Hibernation::Hibernation (  String  Name, String  MeshFile, SceneNode *  ParentNode, SceneManager *  SceneMgr )

Constructeur.

Hibernation::~Hibernation (   )  [virtual]

Destruction.

---

Member Function Documentation

void Hibernation::addFrameListener (  short  User  )

Gère le lancement du FrameListener.

void Hibernation::addToScene (   )

Ajoute la caisson à la scene courante.

void Hibernation::climb (   )

Monte ou descent du caisson (pour le joueur).

void Hibernation::climbIn (   )

Le joueur monte dans le caisson.

void Hibernation::climbOut (   )

Le joueur descend du caisson.

bool Hibernation::closeDoor (   )

Ferme le couvercle de la capsule.

void Hibernation::createInterface (   )

Crée un objet d'Interface Hibernation (GUI).

void Hibernation::endSequence (   )

Lance la séquence de fin d'hibernation.

bool Hibernation::frameStarted (  const FrameEvent &  evt  )

Gère les animations de la capsule d'hibernation.

String Hibernation::getName (   )

Renvoie le nom du caisson.

Vector3 Hibernation::getPosition (  String  RelativeTo = "PARENT"  )

Renvoie la position du Caisson. RelativeTo peut valoir "PARENT" ou "SHIP".

String Hibernation::getStatus (   )

Renvoie le status du caisson d'hibernation sous forme de chaine XML.

long Hibernation::getTypeID (  void   )  const

Surchage de la fonction d'identification de la classe UserDefinedObject.

void Hibernation::hideInterface (   )

L'interface est masquée mais pas détruite.

bool Hibernation::isBroken (   )

Renvois TRUE si le caisson est endommagé.

bool Hibernation::isClosed (   )

Renvoie TRUE si le caisson est fermé.

bool Hibernation::isExitInterfaceRequiered (   )

Renvoie TRUE si une demande de sortie de GUI est en cours. Renvoie FALSE si aucune demande de sortie n'est en cours.

bool Hibernation::isInterfaceDisabled (   )

Renvoie TRUE si le GUI est inactif (cad non affiché).

bool Hibernation::isOpened (   )

Renvoie TRUE si le caisson est ouvert.

void Hibernation::loadObject (   )

Charge les parametres initiaux du caisson.

bool Hibernation::openDoor (   )

Ouvre le couvercle de la capsule.

void Hibernation::removeFromScene (   )

Retire la capsule de la scene courante.

void Hibernation::removeInterface (   )

Détruit un objet d'Interface Hibernation (GUI).

void Hibernation::requestExitInterface (  Real  seconds  )

Mémorise une demande de fin de la GUI.

void Hibernation::setBroken (  bool  broken  )

Gere les pannes du caisson.

void Hibernation::setDuration (  int  duration  )

Mémorise la durée de l'hibernation à effectuer.

void Hibernation::setFocusOff (   )

Quand on perd le focus, on détruit le GUI d'interface Hibernation. On efface l'interface

void Hibernation::setFocusOn (   )

On active le focus au moment ou la souris passe sur l'objet. S'il n'a pas deja le focus: on émet un son. Et on affiche un message

void Hibernation::setMaterialScreen (   )

Met à jour l'image réduite de l'interface de commande du Caisson.

void Hibernation::setOrientation (  Quaternion  Orientation  )

Oriente le caisson.

void Hibernation::setOrientation (  int  Orientation  )

Oriente le caisson.

void Hibernation::setPosition (  Vector3  Position  )

Positionne le caisson.

void Hibernation::startSequence (   )

Lance la séquence d'hibernation.

---

Friends And Related Function Documentation

friend class Hibernation_Interface [friend]

---

Member Data Documentation

Real Hibernation::mAnimationSpeed [protected]

AnimationState* Hibernation::mAnimState [protected]

bool Hibernation::mBroken [protected]

int Hibernation::mCptFrame [protected]

Real Hibernation::mEndFog [protected]

int Hibernation::mEndSoundChannel [protected]

String Hibernation::mEndSoundFile [protected]

Entity* Hibernation::mEntity [protected]

bool Hibernation::mExitGui [protected]

Real Hibernation::mExitGuiDelay [protected]

long Hibernation::mFinalDate [protected]

Real Hibernation::mFineClock [protected]

ParticleSystem* Hibernation::mGivre [protected]

int Hibernation::mGrossClock [protected]

bool Hibernation::mHasFocus [protected]

int Hibernation::mHelloSoundChannel [protected]

String Hibernation::mHelloSoundFile [protected]

Hibernation_Interface* Hibernation::mHibernation_GUI [protected]

String Hibernation::mHibernationName [protected]

SceneNode* Hibernation::mHibernationNode [protected]

long Hibernation::mInitialDate [protected]

int Hibernation::mInitialDuration [protected]

String Hibernation::mInterfaceFile [protected]

int Hibernation::mLastGrossClock [protected]

short Hibernation::mListenerNeeded [protected]

bool Hibernation::mLocked [protected]

String Hibernation::mMeshFile [protected]

int Hibernation::mOpenSoundChannel [protected]

String Hibernation::mOpenSoundFile [protected]

int Hibernation::mOperatingSoundChannel [protected]

String Hibernation::mOperatingSoundFile [protected]

int Hibernation::mOperatingSoundFrequency [protected]

int Hibernation::mOperatingSoundVolume [protected]

SceneNode* Hibernation::mParentNode [protected]

SceneNode* Hibernation::mParticulesNode [protected]

tPhase Hibernation::mPhase [protected]

Root* Hibernation::mRoot [protected]

SceneManager* Hibernation::mSceneMgr [protected]

int Hibernation::mScreenEntity [protected]

ParticleSystem* Hibernation::mSmoke [protected]

ParticleSystem* Hibernation::mSparks [protected]

int Hibernation::mStartSoundChannel [protected]

String Hibernation::mStartSoundFile [protected]

tStatus Hibernation::mStatus [protected]

Body* Hibernation::mSubject [protected]

String Hibernation::mSubjectName [protected]

int Hibernation::mTemperature [protected]

---

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

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

---