om::sound::acoustics::objects::SoundSceneObject Class Reference

An interface for classes that can be part of a sound scene. More...

#include <omSoundSceneObject.h>

Inheritance diagram for om::sound::acoustics::objects::SoundSceneObject:

Public Member Functions
virtual Bool	addSceneObjects (SoundSceneID sceneID)
	Add internal context objects to the scene with the specified ID. More...
virtual Bool	removeSceneObjects (SoundSceneID sceneID)
	Remove internal context objects from the scene with the specified ID. More...
Public Member Functions inherited from om::sound::acoustics::contexts::AcousticContextObject
virtual	~AcousticContextObject ()
	Destory this acoustics context object. More...
AcousticContext *	getContext () const
	Return a pointer to the acoustics context this context object is using to do simulation. More...
virtual Bool	setContext (AcousticContext *newContext)
	Set a pointer to the acoustics context this context object should use to do simulation. More...
Bool	clearContext ()
	Clear the previous context from this object. More...

Additional Inherited Members
Protected Member Functions inherited from om::sound::acoustics::contexts::AcousticContextObject
	AcousticContextObject ()
	Create a new acoustics context object that doesn't have an associated acoustics context. More...
	AcousticContextObject (AcousticContext *newContext)
	Create a new acoustics context object that uses the specified context for simulation. More...
Protected Attributes inherited from om::sound::acoustics::contexts::AcousticContextObject
AcousticContext *	context
	A pointer to the acoustics context this object is using. More...

Detailed Description

An interface for classes that can be part of a sound scene.

Member Function Documentation

virtual Bool om::sound::acoustics::objects::SoundSceneObject::addSceneObjects ( SoundSceneID  sceneID )

inlinevirtual

Add internal context objects to the scene with the specified ID.

This method should register any internal simulation objects as part of the given scene in the current simulation context. The method returns whether or not the objects where successfully registered.

Reimplemented in om::sound::acoustics::objects::SoundObject, om::sound::acoustics::objects::SoundListener, and om::sound::acoustics::objects::SoundSource.

virtual Bool om::sound::acoustics::objects::SoundSceneObject::removeSceneObjects ( SoundSceneID  sceneID )

inlinevirtual

Remove internal context objects from the scene with the specified ID.

This method should un-register any internal simulation objects from the given scene in the current simulation context. The method returns whether or not the objects where successfully unregistered.

Reimplemented in om::sound::acoustics::objects::SoundObject, om::sound::acoustics::objects::SoundListener, and om::sound::acoustics::objects::SoundSource.

---

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

• omSoundSceneObject.h