om::sound::acoustics::base::SoundMaterial Class Reference

A class that specifies information about a material in an acoustic simulation. More...

#include <omSoundMaterial.h>

Public Member Functions
	SoundMaterial ()
	Create a sound material with the default initial state. More...
Size	getAttributeCount () const
	Return the number of attributes that this material has. More...
SoundMaterialAttribute &	getAttribute (Index attributeIndex)
	Return a reference to the attribute at the specified index in this material. More...
const SoundMaterialAttribute &	getAttribute (Index attributeIndex) const
	Return a const reference to the attribute at the specified index in this material. More...
void	addAttribute (const SoundMaterialAttribute &newAttribute)
	Add a new attribute to this sound material. More...
void	clearAttributes ()
	Remove all attributes from this material. More...
const UTF8String &	getName () const
	Return the name of this sound material. More...
void	setName (const UTF8String &newName)
	Set the name of this sound material. More...
const UTF8String &	getDescription () const
	Return a text description of this sound material. More...
void	setDescription (const UTF8String &newDescription)
	Set the text description of this sound material. More...
const Vector4f &	getColor () const
	Return an RGBA color that should be used when displaying this material. More...
void	setColor (const Vector4f &newColor)
	Set an RGBA color that should be used when displaying this material. More...

Static Public Attributes
static const ResourceType	RESOURCE_TYPE
	The resource type for a sound material. More...

Detailed Description

A class that specifies information about a material in an acoustic simulation.

Constructor & Destructor Documentation

om::sound::acoustics::base::SoundMaterial::SoundMaterial

(

)

Create a sound material with the default initial state.

Member Function Documentation

Size om::sound::acoustics::base::SoundMaterial::getAttributeCount ( ) const

inline

Return the number of attributes that this material has.

SoundMaterialAttribute& om::sound::acoustics::base::SoundMaterial::getAttribute ( Index  attributeIndex )

inline

Return a reference to the attribute at the specified index in this material.

const SoundMaterialAttribute& om::sound::acoustics::base::SoundMaterial::getAttribute ( Index  attributeIndex ) const

inline

Return a const reference to the attribute at the specified index in this material.

void om::sound::acoustics::base::SoundMaterial::addAttribute

(

const SoundMaterialAttribute &

newAttribute

)

Add a new attribute to this sound material.

void om::sound::acoustics::base::SoundMaterial::clearAttributes

(

)

Remove all attributes from this material.

const UTF8String& om::sound::acoustics::base::SoundMaterial::getName ( ) const

inline

Return the name of this sound material.

void om::sound::acoustics::base::SoundMaterial::setName ( const UTF8String &  newName )

inline

Set the name of this sound material.

const UTF8String& om::sound::acoustics::base::SoundMaterial::getDescription ( ) const

inline

Return a text description of this sound material.

void om::sound::acoustics::base::SoundMaterial::setDescription ( const UTF8String &  newDescription )

inline

Set the text description of this sound material.

const Vector4f& om::sound::acoustics::base::SoundMaterial::getColor ( ) const

inline

Return an RGBA color that should be used when displaying this material.

void om::sound::acoustics::base::SoundMaterial::setColor ( const Vector4f &  newColor )

inline

Set an RGBA color that should be used when displaying this material.

Member Data Documentation

const ResourceType om::sound::acoustics::base::SoundMaterial::RESOURCE_TYPE

static

The resource type for a sound material.

---

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

• omSoundMaterial.h