Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Static Public Attributes | List of all members
om::engine::acoustics::SoundSceneContext Class Reference

A class that manages the internal acoustic simulation state for a scene. More...

#include <omEngineSoundSceneContext.h>

Inheritance diagram for om::engine::acoustics::SoundSceneContext:
om::engine::base::SceneContext

Public Member Functions

 SoundSceneContext ()
 Create a new empty sound scene context. More...
 
SoundScene * getScene () const
 Return a pointer to the sound scene that contains the simulation state. More...
 
virtual void addResource (const OpaqueResource &resource)
 Add a new resource to the scene context. More...
 
virtual void removeResource (const OpaqueResource &resource)
 Remove a resource from the scene context. More...
 
virtual void clearResources ()
 Remove all resources from this scene context. More...
 
virtual const ResourceTypegetResourceType () const
 Return the resource type of this scene context's concrete type. More...
 
- Public Member Functions inherited from om::engine::base::SceneContext
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...
 

Static Public Attributes

static const ResourceType RESOURCE_TYPE
 The resource type for a sound scene context. More...
 

Detailed Description

A class that manages the internal acoustic simulation state for a scene.

Constructor & Destructor Documentation

om::engine::acoustics::SoundSceneContext::SoundSceneContext ( )

Create a new empty sound scene context.

Member Function Documentation

SoundScene* om::engine::acoustics::SoundSceneContext::getScene ( ) const
inline

Return a pointer to the sound scene that contains the simulation state.

virtual void om::engine::acoustics::SoundSceneContext::addResource ( const OpaqueResource &  resource)
virtual

Add a new resource to the scene context.

virtual void om::engine::acoustics::SoundSceneContext::removeResource ( const OpaqueResource &  resource)
virtual

Remove a resource from the scene context.

virtual void om::engine::acoustics::SoundSceneContext::clearResources ( )
virtual

Remove all resources from this scene context.

Implements om::engine::base::SceneContext.

virtual const ResourceType& om::engine::acoustics::SoundSceneContext::getResourceType ( ) const
virtual

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

Implements om::engine::base::SceneContext.

Member Data Documentation

const ResourceType om::engine::acoustics::SoundSceneContext::RESOURCE_TYPE
static

The resource type for a sound scene context.


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