om::sound::acoustics::objects::SoundShape Class Reference

A class that represents a sound shape in a virtual acoustic context. More...

#include <omSoundShape.h>

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

Public Member Functions
	SoundShape ()
	Create a default sound object positioned at the origin with no shapes. More...
Size	getGroupCount () const
	Return the number of groups that this object has. More...
MeshGroup *	getGroup (Index groupIndex) const
	Return a pointer to the group for this shape at the specified index. More...
Bool	addGroup (MeshGroup *newGroup)
	Add a new group to this shape. More...
Bool	setGroup (Index groupIndex, MeshGroup *newGroup)
	Set the shape for this object at the specified index. More...
Bool	removeGroup (Index groupIndex)
	Remove the group from this shape at the specified index. More...
Bool	removeGroup (const MeshGroup *group)
	Remove the specified group from this object. More...
void	clearGroups ()
	Remove all groups from this object. More...
virtual Bool	setContext (AcousticContext *newContext)
	Set a pointer to the acoustics context this context object should use to do simulation. More...
SoundShapeID	getID () const
	Return the ID of this sound object within its current acoustic context. More...
Bool	addObjectShapes (SoundObjectID objectID)
	Add internal context objects to the object with the specified ID. More...
Bool	removeObjectShapes (SoundObjectID objectID)
	Remove internal context objects from the object 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...
Bool	clearContext ()
	Clear the previous context from this object. More...

Static Public Attributes
static const ResourceType	RESOURCE_TYPE
	The resource type for a sound 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

A class that represents a sound shape in a virtual acoustic context.

Constructor & Destructor Documentation

om::sound::acoustics::objects::SoundShape::SoundShape

(

)

Create a default sound object positioned at the origin with no shapes.

Member Function Documentation

Size om::sound::acoustics::objects::SoundShape::getGroupCount ( ) const

inline

Return the number of groups that this object has.

MeshGroup* om::sound::acoustics::objects::SoundShape::getGroup ( Index  groupIndex ) const

inline

Return a pointer to the group for this shape at the specified index.

Bool om::sound::acoustics::objects::SoundShape::addGroup

(

MeshGroup *

newGroup

)

Add a new group to this shape.

The method returns whether or not the operation was successful. The method fails if the new group pointer is NULL.

Bool om::sound::acoustics::objects::SoundShape::setGroup ( Index  groupIndex, MeshGroup *  newGroup  )

inline

Set the shape for this object at the specified index.

The method returns whether or not the operation was successful. The method fails if the new shape pointer is NULL.

Bool om::sound::acoustics::objects::SoundShape::removeGroup

(

Index

groupIndex

)

Remove the group from this shape at the specified index.

The method returns whether or not the operation was successful. The method fails if the specified index is out of bounds.

Bool om::sound::acoustics::objects::SoundShape::removeGroup

(

const MeshGroup *

group

)

Remove the specified group from this object.

Returns

whether or not the group was successfully found and removed.

void om::sound::acoustics::objects::SoundShape::clearGroups

(

)

Remove all groups from this object.

virtual Bool om::sound::acoustics::objects::SoundShape::setContext ( AcousticContext *  newContext )

virtual

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

Reimplemented from om::sound::acoustics::contexts::AcousticContextObject.

SoundShapeID om::sound::acoustics::objects::SoundShape::getID ( ) const

inline

Return the ID of this sound object within its current acoustic context.

Bool om::sound::acoustics::objects::SoundShape::addObjectShapes

(

SoundObjectID

objectID

)

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

Bool om::sound::acoustics::objects::SoundShape::removeObjectShapes

(

SoundObjectID

objectID

)

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

Member Data Documentation

const ResourceType om::sound::acoustics::objects::SoundShape::RESOURCE_TYPE

static

The resource type for a sound object.

---

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

• omSoundShape.h