GameEngine::Process Class Reference

#include <Process.h>

Inheritance diagram for GameEngine::Process:

Inheritance graph
[legend]
List of all members.

Detailed Description

Definition at line 40 of file Process.h.

Public Member Functions

virtual bool isDead () const
virtual bool isActive () const
virtual void setActive (const bool active)
virtual bool isAttached () const
virtual bool isPaused () const
virtual void togglePause ()
bool isInitialised () const
boost::shared_ptr< ProcessgetNext () const
virtual void setNext (boost::shared_ptr< Process > next)
virtual void update (const double &dt)
virtual bool init ()
virtual void destroy ()

Protected Member Functions

virtual void setAttached (const bool attach)
virtual void kill ()

Protected Attributes

bool mKill
bool mActive
bool mPaused
bool mIsAttached
bool mIsInitialised
boost::shared_ptr< ProcessmNext

Friends

class ProcessManager


Member Function Documentation

virtual bool GameEngine::Process::isDead (  )  const [inline, virtual]

Returns:
true if the process is dead, false otherwise

Definition at line 48 of file Process.h.

virtual bool GameEngine::Process::isActive (  )  const [inline, virtual]

Returns:
true if the process is active, false otherwise

Definition at line 53 of file Process.h.

virtual void GameEngine::Process::setActive ( const bool  active  )  [inline, virtual]

Parameters:
active True to set the process as active, false otherwise

Definition at line 58 of file Process.h.

bool GameEngine::Process::isAttached (  )  const [virtual]

Returns:
true if the process is attached to a process manager, false otherwise

Definition at line 38 of file Process.cpp.

virtual bool GameEngine::Process::isPaused (  )  const [inline, virtual]

Returns:
true if the process is paused, false otherwise

Definition at line 68 of file Process.h.

virtual void GameEngine::Process::togglePause (  )  [inline, virtual]

Switches the process between the paused and unpaused state

Definition at line 73 of file Process.h.

bool GameEngine::Process::isInitialised (  )  const [inline]

Definition at line 75 of file Process.h.

boost::shared_ptr<Process> GameEngine::Process::getNext (  )  const [inline]

Returns:
The process which will be executed after this process is complete

Definition at line 80 of file Process.h.

void GameEngine::Process::setNext ( boost::shared_ptr< Process next  )  [virtual]

Parameters:
next The process which will be executed after this process is complete

Definition at line 32 of file Process.cpp.

virtual void GameEngine::Process::update ( const double &  dt  )  [inline, virtual]

Update the process

Parameters:
dt Time since last frame

Reimplemented in GameEngine::GameObject, GameEngine::GraphicalComponent, GameEngine::InputManager, GameEngine::PhysicsManager, and GameEngine::SoundManager.

Definition at line 92 of file Process.h.

virtual bool GameEngine::Process::init ( void   )  [inline, virtual]

Initialise the process

Returns:
true if process was initialised succesffuly, false otherwise

Reimplemented in GameEngine::GameObject, GameEngine::GameObjectComponent, GameEngine::GraphicalComponent, GameEngine::InputManager, and GameEngine::SoundManager.

Definition at line 98 of file Process.h.

virtual void GameEngine::Process::destroy (  )  [inline, virtual]

Destroy the process

Reimplemented in GameEngine::GameObject, GameEngine::GameObjectComponent, and GameEngine::GraphicalComponent.

Definition at line 102 of file Process.h.

void GameEngine::Process::setAttached ( const bool  attach  )  [protected, virtual]

Parameters:
attach 

Definition at line 44 of file Process.cpp.

void GameEngine::Process::kill (  )  [protected, virtual]

Definition at line 26 of file Process.cpp.


Friends And Related Function Documentation

friend class ProcessManager [friend]

Definition at line 42 of file Process.h.


Member Data Documentation

bool GameEngine::Process::mKill [protected]

Definition at line 106 of file Process.h.

bool GameEngine::Process::mActive [protected]

Definition at line 107 of file Process.h.

bool GameEngine::Process::mPaused [protected]

Definition at line 108 of file Process.h.

bool GameEngine::Process::mIsAttached [protected]

Definition at line 109 of file Process.h.

bool GameEngine::Process::mIsInitialised [protected]

Definition at line 110 of file Process.h.

boost::shared_ptr<Process> GameEngine::Process::mNext [protected]

Definition at line 111 of file Process.h.


The documentation for this class was generated from the following files:
Generated on Thu Apr 19 09:49:08 2007 for GameEngine by  doxygen 1.5.2