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

An interface for classes that operate on a specific Scene. More...

#include <omEngineSceneContext.h>

Inheritance diagram for om::engine::base::SceneContext:
om::engine::acoustics::SoundSceneContext om::engine::graphics::GraphicsSceneContext om::engine::physics::PhysicsSceneContext

Public Member Functions

virtual ~SceneContext ()
 Destroy a scene context and release internal resources. More...
 
virtual void addResource (const OpaqueResource &resource)=0
 Add a new resource to the scene context. More...
 
virtual void removeResource (const OpaqueResource &resource)=0
 Remove a resource from the scene context. More...
 
virtual void clearResources ()=0
 Remove all resources from this scene context. More...
 
virtual const ResourceTypegetResourceType () const =0
 Return the resource type of this scene context's concrete type. More...
 

Detailed Description

An interface for classes that operate on a specific Scene.

Each Scene can be associated with multiple scene contexts, where each context operates on the scene's contents and provides some service (e.g. graphics rendering, physics/sound simulation, AI pathfinding, etc.).

Constructor & Destructor Documentation

virtual om::engine::base::SceneContext::~SceneContext ( )
virtual

Destroy a scene context and release internal resources.

Member Function Documentation

virtual void om::engine::base::SceneContext::addResource ( const OpaqueResource resource)
pure virtual

Add a new resource to the scene context.

virtual void om::engine::base::SceneContext::removeResource ( const OpaqueResource resource)
pure virtual

Remove a resource from the scene context.

virtual void om::engine::base::SceneContext::clearResources ( )
pure virtual
virtual const ResourceType& om::engine::base::SceneContext::getResourceType ( ) const
pure virtual

Return the resource type of this scene context's concrete type.

Implemented in om::engine::acoustics::SoundSceneContext, om::engine::graphics::GraphicsSceneContext, and om::engine::physics::PhysicsSceneContext.


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