omega::EngineModule Class Reference

Base class for engine modules Engine modules are classes that can be attached to the engine and receive update, event and command calls. More...

#include <ModuleServices.h>

Public Types
enum	Priority {   PriorityLowest = 0, PriorityLow = 1, PriorityNormal = 2, PriorityHigh = 3,   PriorityHighest = 4 }
enum	OpenGLProfile { CoreProfile, CompatibilityProfile, UnspecifiedProfile }

Public Member Functions
	EngineModule (const String &name)
	EngineModule ()
virtual	~EngineModule ()
void	requestOpenGLProfile (OpenGLProfile profile)
	This method can be used within an engine module ctor or initialization to test for module compatibility. More...
void	enableSharedData ()
void	disableSharedData ()
virtual void	initialize ()
virtual void	dispose ()
virtual void	update (const UpdateContext &context)
virtual void	handleEvent (const Event &evt)
virtual bool	handleCommand (const String &cmd)
virtual void	commitSharedData (SharedOStream &out)
virtual void	updateSharedData (SharedIStream &in)
virtual void	initializeRenderer (Renderer *)
void	doInitialize (Engine *server)
void	doDispose ()
virtual bool	isInitialized ()
Engine *	getEngine ()
Priority	getPriority ()
void	setPriority (Priority value)
const String &	getName ()
Public Member Functions inherited from omicron::ReferenceType
	ReferenceType ()
virtual	~ReferenceType ()
void	ref ()
void	unref ()
long	refCount ()

Friends
class	ModuleServices

Additional Inherited Members
Static Public Member Functions inherited from omicron::ReferenceType
static void	printObjCounts ()
Static Protected Attributes inherited from omicron::ReferenceType
static List< ReferenceType * >	mysObjList

Detailed Description

Base class for engine modules Engine modules are classes that can be attached to the engine and receive update, event and command calls.

Inheritance diagram for omega::EngineModule:

Member Enumeration Documentation

enum omega::EngineModule::OpenGLProfile

Enumerator
CoreProfile
CompatibilityProfile
UnspecifiedProfile

enum omega::EngineModule::Priority

Enumerator
PriorityLowest
PriorityLow
PriorityNormal
PriorityHigh
PriorityHighest

Constructor & Destructor Documentation

omega::EngineModule::EngineModule ( const String &  name )

inline

omega::EngineModule::EngineModule ( )

inline

virtual omega::EngineModule::~EngineModule ( )

virtual

Member Function Documentation

virtual void omega::EngineModule::commitSharedData ( SharedOStream &  out )

inlinevirtual

Reimplemented from omega::SharedObject.

Reimplemented in omega::EventSharingModule, and omega::ImageBroadcastModule.

void omega::EngineModule::disableSharedData

(

)

virtual void omega::EngineModule::dispose ( )

inlinevirtual

Reimplemented in omega::MissionControlClient, omegaToolkit::UiModule, omega::EventSharingModule, and omegaToolkit::ui::MenuManager.

void omega::EngineModule::doDispose

(

)

void omega::EngineModule::doInitialize

(

Engine *

server

)

void omega::EngineModule::enableSharedData

(

)

Engine* omega::EngineModule::getEngine ( )

inline

const String& omega::EngineModule::getName ( )

inline

Priority omega::EngineModule::getPriority ( )

inline

virtual bool omega::EngineModule::handleCommand ( const String &  cmd )

inlinevirtual

Reimplemented in omega::Actor, omega::Console, and omega::CameraController.

virtual void omega::EngineModule::handleEvent ( const Event &  evt )

inlinevirtual

Implements omicron::IEventListener.

Reimplemented in omega::Actor, omega::Console, omega::CameraController, omega::KeyboardMouseCameraController, omega::GamepadCameraController, omega::WandCameraController, omega::TrackedObject, and omega::MouseCameraController.

virtual void omega::EngineModule::initialize ( )

inlinevirtual

Reimplemented in omega::MissionControlClient, omegaToolkit::SceneEditorModule, omegaToolkit::UiModule, omega::Console, omegaToolkit::ui::MenuManager, and omegaToolkit::CameraStereoSwitcher.

virtual void omega::EngineModule::initializeRenderer ( Renderer *  )

inlinevirtual

Reimplemented in omegaToolkit::UiModule, and omega::Console.

virtual bool omega::EngineModule::isInitialized ( )

inlinevirtual

void omega::EngineModule::requestOpenGLProfile

(

OpenGLProfile

profile

)

This method can be used within an engine module ctor or initialization to test for module compatibility.

After initialization, the module will test requested profile against what the display system is running.

void omega::EngineModule::setPriority ( Priority  value )

inline

virtual void omega::EngineModule::update ( const UpdateContext &  context )

inlinevirtual

Reimplemented in omega::MissionControlClient, omega::Actor, omegaToolkit::WandManipulator, omegaToolkit::UiModule, omegaToolkit::SceneEditorModule, omegaToolkit::ui::MenuManager, omega::CameraController, omega::KeyboardMouseCameraController, omega::GamepadCameraController, omega::TrackedObject, omega::WandCameraController, omega::MouseCameraController, omegaToolkit::ControllerManipulator, and omegaToolkit::MouseManipulator.

virtual void omega::EngineModule::updateSharedData ( SharedIStream &  in )

inlinevirtual

Reimplemented from omega::SharedObject.

Reimplemented in omega::EventSharingModule, and omega::ImageBroadcastModule.

Friends And Related Function Documentation

friend class ModuleServices

friend

---

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

• C:/dev/omegalib/release/include/omega/ModuleServices.h