OldApplicationBase Class Reference

#include <OldApplicationBase.h>

Collaboration diagram for OldApplicationBase:


Public Member Functions
	OldApplicationBase (int argc, char **argv)
virtual	~OldApplicationBase ()
virtual bool	init (int argc, char **argv)
virtual void	step (float dt)
virtual void	display (float dt)
virtual void	cleanup ()
virtual void	finalize ()
virtual void	setupStageModifiers ()
virtual void	cbConfigureModule (ModuleInterface *module)
virtual void	cbConfigureCoreComponent (CoreComponents component)
virtual void	run (int argc, char **argv)
virtual void	setupCamera ()
Static Public Member Functions
static void	configureModule (ModuleInterface *module)
Protected Member Functions
virtual void	updateNavigation (float dt)
virtual gmtl::Matrix44f &	getCameraMatrix (gmtl::Matrix44f &dst)
virtual void	internalCleanup ()
Static Protected Member Functions
static void	configureCoreComponent (CoreComponents component)
Protected Attributes
ControllerManagerInterface *	contInt
NavigationInterface *	navInt
NetworkInterface *	netInt
InteractionInterface *	interactionInt
User *	localUser
CameraTransformation *	activeCamera
FILE *	logFile
float	physicalToWorldScale
Static Protected Attributes
static OldApplicationBase *	currentInstance = NULL
Friends
class	SystemCore

Constructor & Destructor Documentation

OldApplicationBase::OldApplicationBase	(	int	argc,
		char **	argv
	)

The constructor expects in argv[0] a config file which is passed to the Configuration. This is a good place for performing any platform specific initialisation. You cannot rely on very much functionality being available at this stage. It is recommended to do as much as possible of your initialisation work in init()

virtual OldApplicationBase::~OldApplicationBase ( ) [inline, virtual]

Member Function Documentation

void OldApplicationBase::cbConfigureCoreComponent ( CoreComponents component ) [virtual]

void OldApplicationBase::cbConfigureModule ( ModuleInterface * module ) [virtual]

Todo:: add documentation

void OldApplicationBase::cleanup ( ) [virtual]

Thats the proper place to delete stuff allocated by the application. Modules instanced during setupModules() don't need to be delete, this will be done automatically.

void OldApplicationBase::configureCoreComponent ( CoreComponents component ) [static, protected]

void OldApplicationBase::configureModule ( ModuleInterface * module ) [static]

Create instances of the modules you need here. The modules register themself at the SystemCore automatically. However in order to make the OldApplicationBase class aware of them its necessary to assign them to the Interface members for now. This method will be invoked by run().

Todo:: documentation is deprecated -> must be fixed

Parameters:

Module

module to initialize

void OldApplicationBase::display ( float dt ) [virtual]

Will be invoked during step(). Some parts of the transformation pipes might have been already executed.

Parameters:

elapsed

time since last invokation

void OldApplicationBase::finalize ( ) [virtual]

All modules and variables which have to be deleted after the WorldDatabase and UserDatabase are cleaned up can be deleted here.

gmtl::Matrix44f & OldApplicationBase::getCameraMatrix ( gmtl::Matrix44f & dst ) [protected, virtual]

bool OldApplicationBase::init	(	int	argc,
		char **	argv
	)			`[virtual]`

Typically loading the WorldDatabase and similar things are performed here this method should be overriden by your own method.

Parameters:

	argc	command line argument counter
	argv	command line argument vector

Returns:: returning false leads to program termination

void OldApplicationBase::internalCleanup ( ) [protected, virtual]

void OldApplicationBase::run	(	int	argc,
		char **	argv
	)			`[virtual]`

Here the methods responsible for initialisation are invoked in an appropriate order. Additionally it should make sure step() is called periodically. The former is already provided by the implementation of OldApplicationBase. For instance a glut based derived class could register step() via glutDisplayFunc() and invoke glutMainLoop() to make step() called periodically

Parameters:

	argc	command line argument counter
	argv	command line argument vector

void OldApplicationBase::setupCamera ( ) [virtual]

This method must be implemented in a derived class. It should write the matrix of activeCamera to the 3d engine

void OldApplicationBase::setupStageModifiers ( ) [virtual]

Override this method to tell the TransformationManager which modifiers to use. By default the modifiers are loaded from "default.xml" in the TransformationManager config directory. This method is invoked only once during startup by run().

Deprecated:

void OldApplicationBase::step ( float dt ) [virtual]

This method is invoked periodically. It updates the TransformationManager and polls the controller. Additionally display() is invoked. This method is not intended to be overriden. Use display() instead. The run() method is responsible for calling step() from time to time.

Parameters:

dt

elapsed time since last invokation

void OldApplicationBase::updateNavigation ( float dt ) [protected, virtual]