The omegalib Engine is the core runtime component of omegalib. More...

#include <Engine.h>

Public Types
typedef List< Ref< Camera > >	CameraCollection

Public Member Functions
	Engine (ApplicationBase *app)

virtual	~Engine ()

ServiceManager *	getServiceManager ()

SystemManager *	getSystemManager ()

ApplicationBase *	getApplication ()

DisplaySystem *	getDisplaySystem ()

int	getCanvasWidth ()

int	getCanvasHeight ()

SceneNode *	getScene ()

virtual void	initialize ()

virtual void	dispose ()

void	reset ()
	Resets the omegalib engine to its initial state. More...

void	setEventDispatchEnabled (bool value)
	Set to true by default. More...

bool	isEventDispatchEnabled ()

virtual void	handleEvent (const Event &evt)

virtual void	update (const UpdateContext &context)

bool	handleCommand (const String &cmd)


void	addRenderer (Renderer *client)
	Renderer management. More...

Renderer *	getRendererByContextId (int id)

RendererList &	getRendererList ()

void	removeRenderPass (const String &renderPassName)


Camera *	getDefaultCamera ()
	Camera management. More...

void	setDefaultCamera (Camera *camera)

Camera *	createCamera (uint flags=Camera::DefaultFlags)

Camera *	createCamera (const String &name, uint flags=Camera::DefaultFlags)

void	destroyCamera (Camera *cam)

Camera *	getCamera (const String &name)

Camera *	getCameraById (int id)

CameraCollection	getCameras ()

CameraCollection	getCameras () const


void	setDefaultFont (const FontInfo &font)
	Font management. More...

const FontInfo &	getDefaultFont ()


const SceneQueryResultList &	querySceneRay (const Ray &ray, uint flags=0)
	Scene query. More...


bool	getDrawPointers ()
	Pointer management. More...

void	setDrawPointers (bool value)

Pointer *	getPointer (int id)


Console *	getConsole ()
	Console management. More...


void	initializeSound ()
	Sound management. More...

SoundManager *	getSoundManager ()

SoundEnvironment *	getSoundEnvironment ()

bool	isSoundEnabled ()
	This is only used to indicate if sound was enabled via configuration If this is true, we assume the master node is connected/connecting to the sound server. More...


void	addQuickCommand (const String &cmd, const String &call, int args, const String &description)
	Quick commands. More...

void	removeQuickCommand (const String &cmd)

Public Member Functions inherited from omicron::ReferenceType
	ReferenceType ()

virtual	~ReferenceType ()

void	ref ()

void	unref ()

long	refCount ()

Static Public Member Functions
static Engine *	instance ()

Static Public Member Functions inherited from omicron::ReferenceType
static void	printObjCounts ()

Static Public Attributes
static const int	MaxActivePointers = 128

Friends
class	Renderer

Additional Inherited Members
Static Protected Attributes inherited from omicron::ReferenceType
static List< ReferenceType * >	mysObjList

Detailed Description

The omegalib Engine is the core runtime component of omegalib.

It runs on each node of a cluster system and handles the abstract scene graph, cameras, distribution of events and frame updates.

Inheritance diagram for omega::Engine:

Member Typedef Documentation

typedef List< Ref<Camera> > omega::Engine::CameraCollection

Constructor & Destructor Documentation

omega::Engine::Engine ( ApplicationBase * app )

virtual omega::Engine::~Engine ( )

virtual

Member Function Documentation

void omega::Engine::addQuickCommand	(	const String &	cmd,
		const String &	call,
		int	args,
		const String &	description
	)

Quick commands.

void omega::Engine::addRenderer ( Renderer * client )

Renderer management.

Camera* omega::Engine::createCamera ( uint flags = Camera::DefaultFlags )

Camera* omega::Engine::createCamera	(	const String &	name,
		uint	flags = `Camera::DefaultFlags`
	)

void omega::Engine::destroyCamera ( Camera * cam )

virtual void omega::Engine::dispose ( )

virtual

ApplicationBase* omega::Engine::getApplication ( )

inline

Camera* omega::Engine::getCamera ( const String & name )

Camera* omega::Engine::getCameraById ( int id )

CameraCollection omega::Engine::getCameras ( )

CameraCollection omega::Engine::getCameras ( ) const

int omega::Engine::getCanvasHeight ( )

int omega::Engine::getCanvasWidth ( )

Console * omega::Engine::getConsole ( )

inline

Console management.

Camera * omega::Engine::getDefaultCamera ( )

inline

Camera management.

const FontInfo & omega::Engine::getDefaultFont ( )

inline

DisplaySystem* omega::Engine::getDisplaySystem ( )

inline

bool omega::Engine::getDrawPointers ( )

inline

Pointer management.

Pointer* omega::Engine::getPointer ( int id )

Renderer* omega::Engine::getRendererByContextId ( int id )

RendererList & omega::Engine::getRendererList ( )

inline

SceneNode* omega::Engine::getScene ( )

ServiceManager * omega::Engine::getServiceManager ( )

inline

SoundEnvironment * omega::Engine::getSoundEnvironment ( )

inline

SoundManager * omega::Engine::getSoundManager ( )

inline

SystemManager* omega::Engine::getSystemManager ( )

inline

bool omega::Engine::handleCommand ( const String & cmd )

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

virtual

Implements omicron::IEventListener.

virtual void omega::Engine::initialize ( )

virtual

void omega::Engine::initializeSound ( )

Sound management.

static Engine* omega::Engine::instance ( )

inlinestatic

bool omega::Engine::isEventDispatchEnabled ( )

inline

bool omega::Engine::isSoundEnabled ( )

inline

This is only used to indicate if sound was enabled via configuration If this is true, we assume the master node is connected/connecting to the sound server.

Used to enable the sound volume Python menu.

const SceneQueryResultList& omega::Engine::querySceneRay	(	const Ray &	ray,
		uint	flags = `0`
	)

Scene query.

void omega::Engine::removeQuickCommand ( const String & cmd )

void omega::Engine::removeRenderPass ( const String & renderPassName )

void omega::Engine::reset ( )

Resets the omegalib engine to its initial state.

Useful for runtime application switching.

void omega::Engine::setDefaultCamera ( Camera * camera )

inline

void omega::Engine::setDefaultFont ( const FontInfo & font )

inline

Font management.

void omega::Engine::setDrawPointers ( bool value )

inline

void omega::Engine::setEventDispatchEnabled ( bool value )

Set to true by default.

When set to false, the engine will ignore all input events.

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

virtual

Friends And Related Function Documentation

friend class Renderer

friend

Member Data Documentation

const int omega::Engine::MaxActivePointers = 128

static

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

C:/dev/omegalib/release/include/omega/Engine.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation