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

A class that simulates virtual acoustics for an engine context. More...

#include <omEngineAcousticSystem.h>

Inheritance diagram for om::engine::acoustics::AcousticSystem:
om::engine::base::EngineSystem om::engine::base::SceneContextFactory

Public Member Functions

 AcousticSystem ()
 Create a new acoustic system with the default state. More...
 
virtual void update (EngineContext &engine, const Time &dt)
 Update the state of the entities in the specified engine context for the given timestep. 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...
 
AcousticContext * getContext () const
 Return a pointer to the acoustics simulation context that is being used by this acoustic system. More...
 
Bool setContext (AcousticContext *newContext)
 Set a pointer to the acoustics simulation context that should be used by this acoustic system. More...
 
virtual Shared< SceneContextnewSceneContext ()
 Create a new sound scene context. More...
 
- Public Member Functions inherited from om::engine::base::EngineSystem
virtual ~EngineSystem ()
 Destroy a system and release all internal resources. 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...
 
const SystemTypegetType () const
 Return an enum value indicating the semantic type of this engine system. More...
 
- Public Member Functions inherited from om::engine::base::SceneContextFactory
virtual ~SceneContextFactory ()
 Destroy a scene context and release internal resources. 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 simulates virtual acoustics for an engine context.

Constructor & Destructor Documentation

om::engine::acoustics::AcousticSystem::AcousticSystem ( )

Create a new acoustic system with the default state.

Member Function Documentation

virtual void om::engine::acoustics::AcousticSystem::update ( EngineContext engine,
const Time dt 
)
virtual

Update the state of the entities in the specified engine context for the given timestep.

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

virtual void om::engine::acoustics::AcousticSystem::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.

virtual void om::engine::acoustics::AcousticSystem::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.

AcousticContext* om::engine::acoustics::AcousticSystem::getContext ( ) const
inline

Return a pointer to the acoustics simulation context that is being used by this acoustic system.

Bool om::engine::acoustics::AcousticSystem::setContext ( AcousticContext *  newContext)

Set a pointer to the acoustics simulation context that should be used by this acoustic system.

The method returns whether or not the acoustic context can be used to do the simulation.

virtual Shared<SceneContext> om::engine::acoustics::AcousticSystem::newSceneContext ( )
virtual

Create a new sound scene context.

Implements om::engine::base::SceneContextFactory.


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