ModuleInterface Class Reference

#include <ModuleInterface.h>

Inherited by ControllerManagerInterface, InteractionInterface, JointInteraction, NavigationInterface, NetworkInterface, Physics, PhysicsSoundManager, SceneGraphInterface, and Simulation2D.

List of all members.


Public Types
enum	CONFIGURATION_ORDER { CONFIGURE_BEFORE_CORECOMPONENTS, CONFIGURE_AFTER_CORECOMPONENTS }
Public Member Functions
virtual	~ModuleInterface ()
virtual bool	loadConfig (std::string configFile)=0
virtual void	cleanup ()
virtual void	update (float dt)
virtual std::string	getName ()=0
virtual CONFIGURATION_ORDER	getConfigurationOrder ()
virtual Event *	createSyncEvent ()

Detailed Description

Basic interface for modules. Provides methods for initialisation and cleanup.

Member Enumeration Documentation

enum ModuleInterface::CONFIGURATION_ORDER

Enumerator:

CONFIGURE_BEFORE_CORECOMPONENTS
CONFIGURE_AFTER_CORECOMPONENTS

Constructor & Destructor Documentation

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

Member Function Documentation

virtual void ModuleInterface::cleanup ( ) [inline, virtual]

Instruct the module to free all memory allocated internally.

Reimplemented in ControllerManager, Simulation2D, Physics, Interaction, JointInteraction, Navigation, Network, OpenSGSceneGraphInterface, SceneGraphInterface, InteractionInterface, NetworkInterface, and PhysicsSoundManager.

virtual Event* ModuleInterface::createSyncEvent ( ) [inline, virtual]

Todo:: write doku

Reimplemented in Simulation2D, Physics, and SceneGraphInterface.

virtual CONFIGURATION_ORDER ModuleInterface::getConfigurationOrder ( ) [inline, virtual]

Define wether the module should be configured before or after the core components are configured. By default the module is configured before the core components are configured.

virtual std::string ModuleInterface::getName ( ) [pure virtual]

Return the unique name of the module.

Implemented in ControllerManager, Simulation2D, Physics, Interaction, JointInteraction, Navigation, Network, OpenSGSceneGraphInterface, SceneGraphInterface, InteractionInterface, NetworkInterface, and PhysicsSoundManager.