Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

spark::Spark Class Reference

application framework for apps that use oxygen and kerosin classes. More...

#include <spark.h>

Collaboration diagram for spark::Spark:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Spark (const std::string &relPathPrefix)
virtual ~Spark ()
bool Init (int argc, char **argv)
 inits the Spark lib, returns true on success, has to be called once before any other spark methods
virtual bool InitApp (int argc, char **argv)
 called once after Spark finished it's init
zeitgeist::ZeitgeistGetZeitgeist ()
 returns the zeitgeist instance
boost::shared_ptr< zeitgeist::CoreGetCore ()
 returns the zeitgeist core instance
boost::shared_ptr< zeitgeist::LogServerGetLog ()
 returns the LogServer
boost::shared_ptr< zeitgeist::ScriptServerGetScriptServer ()
 returns the ScriptServer
boost::shared_ptr< oxygen::SceneServerGetSceneServer ()
 returns the SceneServer
boost::shared_ptr< oxygen::SceneGetActiveScene ()
 returns the current active Scene
boost::shared_ptr< oxygen::SimulationServerGetSimulationServer ()
 returns the SimulationServer
boost::shared_ptr< kerosin::InputControlGetInputControl ()
 returns the input control node
boost::shared_ptr< kerosin::RenderControlGetRenderControl ()
 returns the render control node

Protected Attributes

boost::shared_ptr< zeitgeist::LogServermLogServer
boost::shared_ptr< zeitgeist::ScriptServermScriptServer
boost::shared_ptr< oxygen::SceneServermSceneServer
boost::shared_ptr< oxygen::SimulationServermSimulationServer
zeitgeist::Zeitgeist mZeitgeist
oxygen::Oxygen mOxygen
kerosin::Kerosin mKerosin

Detailed Description

application framework for apps that use oxygen and kerosin classes.

It provides a default setup of and easy access to all relevant classes. Applications that want to use spark should subclass it and override the given callbacks.

Definition at line 37 of file spark.h.


Constructor & Destructor Documentation

spark::Spark::Spark const std::string &  relPathPrefix  ) 
 

Spark::~Spark  )  [virtual]
 

Definition at line 41 of file spark.cpp.

References mLogServer, mSceneServer, mScriptServer, and mSimulationServer.


Member Function Documentation

shared_ptr< Scene > Spark::GetActiveScene  ) 
 

returns the current active Scene

Definition at line 156 of file spark.cpp.

References mLogServer, and mSceneServer.

shared_ptr< Core > Spark::GetCore  ) 
 

returns the zeitgeist core instance

Definition at line 108 of file spark.cpp.

References zeitgeist::Zeitgeist::GetCore(), and mZeitgeist.

Here is the call graph for this function:

shared_ptr< InputControl > Spark::GetInputControl  ) 
 

returns the input control node

Definition at line 128 of file spark.cpp.

References mSimulationServer.

shared_ptr< zeitgeist::LogServer > Spark::GetLog  ) 
 

returns the LogServer

Definition at line 113 of file spark.cpp.

References zeitgeist::Zeitgeist::GetCore(), and mZeitgeist.

Here is the call graph for this function:

shared_ptr< RenderControl > Spark::GetRenderControl  ) 
 

returns the render control node

Definition at line 139 of file spark.cpp.

References mSimulationServer.

shared_ptr< SceneServer > Spark::GetSceneServer  ) 
 

returns the SceneServer

Definition at line 118 of file spark.cpp.

References mSceneServer.

shared_ptr< ScriptServer > Spark::GetScriptServer  ) 
 

returns the ScriptServer

Definition at line 151 of file spark.cpp.

References mScriptServer.

shared_ptr< SimulationServer > Spark::GetSimulationServer  ) 
 

returns the SimulationServer

Definition at line 123 of file spark.cpp.

References mSimulationServer.

Zeitgeist & Spark::GetZeitgeist  ) 
 

returns the zeitgeist instance

Definition at line 103 of file spark.cpp.

References mZeitgeist.

bool Spark::Init int  argc,
char **  argv
 

inits the Spark lib, returns true on success, has to be called once before any other spark methods

Definition at line 51 of file spark.cpp.

References zeitgeist::Zeitgeist::GetCore(), InitApp(), mLogServer, mSceneServer, mScriptServer, mSimulationServer, and mZeitgeist.

Here is the call graph for this function:

bool Spark::InitApp int  argc,
char **  argv
[virtual]
 

called once after Spark finished it's init

Definition at line 98 of file spark.cpp.

Referenced by Init().


Member Data Documentation

kerosin::Kerosin spark::Spark::mKerosin [protected]
 

Definition at line 91 of file spark.h.

boost::shared_ptr<zeitgeist::LogServer> spark::Spark::mLogServer [protected]
 

Definition at line 84 of file spark.h.

Referenced by GetActiveScene(), Init(), and ~Spark().

oxygen::Oxygen spark::Spark::mOxygen [protected]
 

Definition at line 90 of file spark.h.

boost::shared_ptr<oxygen::SceneServer> spark::Spark::mSceneServer [protected]
 

Definition at line 86 of file spark.h.

Referenced by GetActiveScene(), GetSceneServer(), Init(), and ~Spark().

boost::shared_ptr<zeitgeist::ScriptServer> spark::Spark::mScriptServer [protected]
 

Definition at line 85 of file spark.h.

Referenced by GetScriptServer(), Init(), and ~Spark().

boost::shared_ptr<oxygen::SimulationServer> spark::Spark::mSimulationServer [protected]
 

Definition at line 87 of file spark.h.

Referenced by GetInputControl(), GetRenderControl(), GetSimulationServer(), Init(), and ~Spark().

zeitgeist::Zeitgeist spark::Spark::mZeitgeist [protected]
 

Definition at line 89 of file spark.h.

Referenced by GetCore(), GetLog(), GetZeitgeist(), and Init().


The documentation for this class was generated from the following files:
Generated on Thu Apr 6 15:49:41 2006 for rcssserver3d by  doxygen 1.4.4