Om  1.0.0
A universal framework for multimedia simulation
Classes | Public Member Functions | List of all members
om::engine::base::SceneSystem Class Reference

A class that manages the scenes that are currently being simulated by the engine. More...

#include <omEngineSceneSystem.h>

Inheritance diagram for om::engine::base::SceneSystem:
om::engine::base::EngineSystem

Public Member Functions

 SceneSystem ()
 Create a new default scene system. More...
 
virtual void update (EngineContext &engine, const Time &dt)
 Update the scene state for the engine context. More...
 
virtual void addComponent (const ResourceType &type, void *component, EngineContext &engine)
 Update the internal state of the system for a component that was added to the engine. More...
 
virtual void removeComponent (const ResourceType &type, void *component, EngineContext &engine)
 Update the internal state of the system for a component that was removed from the engine. More...
 
Size getContextFactoryCount () const
 Return the number of scene context factories there are in this scene system. More...
 
SceneContextFactorygetContextFactory (Index factoryIndex) const
 Return a pointer to the context factory in this scene system at the specified index. More...
 
Bool addContextFactory (SceneContextFactory *factory)
 Add a new context factory to this scene system. More...
 
Bool removeContextFactory (SceneContextFactory *factory)
 Remove a context factory from this scene system. More...
 
void clearContextFactories ()
 Remove all scene context factories from this scene system. More...
 
- Public Member Functions inherited from om::engine::base::EngineSystem
virtual ~EngineSystem ()
 Destroy a system and release all internal resources. More...
 
const SystemTypegetType () const
 Return an enum value indicating the semantic type of this engine system. More...
 

Additional Inherited Members

- Protected Member Functions inherited from om::engine::base::EngineSystem
 EngineSystem ()
 Create a new engine system with the UNDEFINED system type. More...
 
 EngineSystem (const SystemType &newSystemType)
 Create a new engine system with the specified system type. More...
 

Detailed Description

A class that manages the scenes that are currently being simulated by the engine.

Constructor & Destructor Documentation

om::engine::base::SceneSystem::SceneSystem ( )

Create a new default scene system.

Member Function Documentation

virtual void om::engine::base::SceneSystem::update ( EngineContext engine,
const Time dt 
)
virtual

Update the scene state for the engine context.

Reimplemented from om::engine::base::EngineSystem.

virtual void om::engine::base::SceneSystem::addComponent ( const ResourceType type,
void *  component,
EngineContext engine 
)
virtual

Update the internal state of the system for a component that was added to the engine.

Reimplemented from om::engine::base::EngineSystem.

virtual void om::engine::base::SceneSystem::removeComponent ( const ResourceType type,
void *  component,
EngineContext engine 
)
virtual

Update the internal state of the system for a component that was removed from the engine.

Reimplemented from om::engine::base::EngineSystem.

Size om::engine::base::SceneSystem::getContextFactoryCount ( ) const
inline

Return the number of scene context factories there are in this scene system.

SceneContextFactory* om::engine::base::SceneSystem::getContextFactory ( Index  factoryIndex) const
inline

Return a pointer to the context factory in this scene system at the specified index.

Bool om::engine::base::SceneSystem::addContextFactory ( SceneContextFactory factory)

Add a new context factory to this scene system.

The method returns whether or not the factory was able to be added.

Bool om::engine::base::SceneSystem::removeContextFactory ( SceneContextFactory factory)

Remove a context factory from this scene system.

The method returns whether or not the factory was able to be removed.

void om::engine::base::SceneSystem::clearContextFactories ( )

Remove all scene context factories from this scene system.


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