orxonox::GSRoot Class Reference

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/orxonox/gamestates/GSRoot.h>

Inheritance diagram for orxonox::GSRoot:

Public Member Functions
	GSRoot (const GameStateInfo &info)
	~GSRoot ()
virtual void	activate () override
virtual void	deactivate () override
float	getTimeFactor ()
void	pause ()
void	setPause (bool pause)
void	setTimeFactor (float factor)
	Changes the speed of Orxonox. More...
virtual void	update (const Clock &time) override
Public Member Functions inherited from orxonox::GameState
	GameState (const GameStateInfo &info)
	Constructor only initialises variables and sets the name permanently. More...
virtual	~GameState ()
	Destructor only checks that we don't delete an active state. More...
State	getActivity () const
const GameStateInfo &	getInfo () const
const std::string &	getName () const
Public Member Functions inherited from orxonox::TimeFactorListener
	TimeFactorListener ()
virtual	~TimeFactorListener ()=default
Public Member Functions inherited from orxonox::Listable
	Listable ()
	Constructor: Allocates space in the element list. More...
	Listable (Context *context)
	Constructor: Allocates space in the element list and assigns the context. More...
virtual	~Listable ()
	Destructor: Removes the object from the object-lists. More...
Context *	getContext () const
void	setContext (Context *context)
	Changes the context. More...
void	unregisterObject ()
	Removes this object from the object-lists. More...
Public Member Functions inherited from orxonox::Identifiable
	Identifiable ()
	Constructor: Sets the default values. More...
virtual	~Identifiable ()
ORX_FORCEINLINE void *	getDerivedPointer (unsigned int classID)
	Returns a valid pointer of any derived type that is registered in the class hierarchy. More...
template<class T >
ORX_FORCEINLINE T *	getDerivedPointer (unsigned int classID)
	Version of getDerivedPointer with template. More...
template<class T >
ORX_FORCEINLINE const T *	getDerivedPointer (unsigned int classID) const
	Const version of getDerivedPointer with template. More...
Identifier *	getIdentifier () const
	Returns the Identifier of the object. More...
bool	isA (const Identifier *identifier)
	Returns true if the object's class is of the given type or a derivative. More...
template<class B >
bool	isA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is of the given type or a derivative. More...
bool	isA (const Identifiable *object)
	Returns true if the object's class is of the given type or a derivative. More...
bool	isChildOf (const Identifier *identifier)
	Returns true if the object's class is a child of the given type. More...
template<class B >
bool	isChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a child of the given type. More...
bool	isChildOf (const Identifiable *object)
	Returns true if the object's class is a child of the given type. More...
bool	isDirectChildOf (const Identifier *identifier)
	Returns true if the object's class is a direct child of the given type. More...
template<class B >
bool	isDirectChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct child of the given type. More...
bool	isDirectChildOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...
bool	isDirectParentOf (const Identifier *identifier)
	Returns true if the object's class is a direct parent of the given type. More...
template<class B >
bool	isDirectParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct parent of the given type. More...
bool	isDirectParentOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...
bool	isExactlyA (const Identifier *identifier)
	Returns true if the object's class is exactly of the given type. More...
template<class B >
bool	isExactlyA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is exactly of the given type. More...
bool	isExactlyA (const Identifiable *object)
	Returns true if the object's class is exactly of the given type. More...
bool	isParentOf (const Identifier *identifier)
	Returns true if the object's class is a parent of the given type. More...
template<class B >
bool	isParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a parent of the given type. More...
bool	isParentOf (const Identifiable *object)
	Returns true if the object's class is a parent of the given type. More...

Static Public Member Functions
static void	delayedStartMainMenu (void)
static void	printObjects ()
Static Public Member Functions inherited from orxonox::TimeFactorListener
static float	getTimeFactor ()
static void	setTimeFactor (float factor)

Protected Member Functions
virtual void	changedTimeFactor (float factor_new, float factor_old) override

Private Attributes
bool	bPaused_
float	timeFactorPauseBackup_

Static Private Attributes
static bool	startMainMenu_s = false

Constructor & Destructor Documentation

orxonox::GSRoot::GSRoot

(

const GameStateInfo &

info

)

orxonox::GSRoot::~GSRoot

(

)

Member Function Documentation

void orxonox::GSRoot::activate ( )

overridevirtual

Reimplemented from orxonox::GameState.

void orxonox::GSRoot::changedTimeFactor ( float  factor_new, float  factor_old  )

overrideprotectedvirtual

Reimplemented from orxonox::TimeFactorListener.

void orxonox::GSRoot::deactivate ( )

overridevirtual

Reimplemented from orxonox::GameState.

void orxonox::GSRoot::delayedStartMainMenu ( void  )

static

float orxonox::GSRoot::getTimeFactor

(

)

void orxonox::GSRoot::pause

(

)

void orxonox::GSRoot::printObjects ( )

static

void orxonox::GSRoot::setPause

(

bool

pause

)

void orxonox::GSRoot::setTimeFactor

(

float

factor

)

Changes the speed of Orxonox.

Remarks

This function is a hack when placed here! Timefactor should be related to the scene (level or so), not the game

void orxonox::GSRoot::update ( const Clock &  time )

overridevirtual

Reimplemented from orxonox::GameState.

Member Data Documentation

bool orxonox::GSRoot::bPaused_

private

bool orxonox::GSRoot::startMainMenu_s = false

staticprivate

float orxonox::GSRoot::timeFactorPauseBackup_

private

---

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

• orxonox/gamestates/GSRoot.h
• orxonox/gamestates/GSRoot.cc