om::sound::acoustics::contexts::AcousticContextObject Class Reference

The base class for objects that use a acoustics context to do simulation. More...

#include <omAcousticContextObject.h>

Inheritance diagram for om::sound::acoustics::contexts::AcousticContextObject:

Public Member Functions
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...

Protected Member Functions
	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
AcousticContext *	context
	A pointer to the acoustics context this object is using. More...

Detailed Description

The base class for objects that use a acoustics context to do simulation.

Constructor & Destructor Documentation

virtual om::sound::acoustics::contexts::AcousticContextObject::~AcousticContextObject ( )

virtual

Destory this acoustics context object.

om::sound::acoustics::contexts::AcousticContextObject::AcousticContextObject ( )

inlineprotected

Create a new acoustics context object that doesn't have an associated acoustics context.

om::sound::acoustics::contexts::AcousticContextObject::AcousticContextObject ( AcousticContext *  newContext )

inlineprotected

Create a new acoustics context object that uses the specified context for simulation.

Member Function Documentation

AcousticContext* om::sound::acoustics::contexts::AcousticContextObject::getContext ( ) const

inline

Return a pointer to the acoustics context this context object is using to do simulation.

virtual Bool om::sound::acoustics::contexts::AcousticContextObject::setContext ( AcousticContext *  newContext )

virtual

Set a pointer to the acoustics context this context object should use to do simulation.

The context object subclass should override this method to perform any initialization and configuration for the new context.

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

Bool om::sound::acoustics::contexts::AcousticContextObject::clearContext ( )

inline

Clear the previous context from this object.

Member Data Documentation

AcousticContext* om::sound::acoustics::contexts::AcousticContextObject::context

protected

A pointer to the acoustics context this object is using.

---

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

• omAcousticContextObject.h