om::sound::acoustics::base::SoundMaterialAttribute Class Reference

A class that specifies a single frequency-dependent attribute for a sound material. More...

#include <omSoundMaterialAttribute.h>

Public Member Functions
	SoundMaterialAttribute ()
	Create a sound material attribute with the default initial state. More...
	SoundMaterialAttribute (const SoundMaterialAttributeType &newType, const FrequencyData &newData)
	Create a sound material attribute with the specified type and data. More...
const SoundMaterialAttributeType &	getType () const
	Return the type of this sound material attribute. More...
void	setType (const SoundMaterialAttributeType &newType)
	Set the type of this sound material attribute. More...
FrequencyData &	getData ()
	Return the frequency-dependent data for this attribute. More...
const FrequencyData &	getData () const
	Return the frequency-dependent data for this attribute. More...
void	setData (const FrequencyData &newData)
	Set the frequency-dependent data for this attribute. More...
const UTF8String &	getName () const
	Return the name of this sound material attribute. More...
void	setName (const UTF8String &newName)
	Set the name of this sound material attribute. More...
const UTF8String &	getDescription () const
	Return a text description of this sound material attribute. More...
void	setDescription (const UTF8String &newDescription)
	Set the text description of this sound material attribute. More...

Detailed Description

A class that specifies a single frequency-dependent attribute for a sound material.

Constructor & Destructor Documentation

om::sound::acoustics::base::SoundMaterialAttribute::SoundMaterialAttribute

(

)

Create a sound material attribute with the default initial state.

om::sound::acoustics::base::SoundMaterialAttribute::SoundMaterialAttribute	(	const SoundMaterialAttributeType &	newType,
		const FrequencyData &	newData
	)

Create a sound material attribute with the specified type and data.

Member Function Documentation

const SoundMaterialAttributeType& om::sound::acoustics::base::SoundMaterialAttribute::getType ( ) const

inline

Return the type of this sound material attribute.

void om::sound::acoustics::base::SoundMaterialAttribute::setType ( const SoundMaterialAttributeType &  newType )

inline

Set the type of this sound material attribute.

FrequencyData& om::sound::acoustics::base::SoundMaterialAttribute::getData ( )

inline

Return the frequency-dependent data for this attribute.

const FrequencyData& om::sound::acoustics::base::SoundMaterialAttribute::getData ( ) const

inline

Return the frequency-dependent data for this attribute.

void om::sound::acoustics::base::SoundMaterialAttribute::setData

(

const FrequencyData &

newData

)

Set the frequency-dependent data for this attribute.

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

inline

Return the name of this sound material attribute.

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

inline

Set the name of this sound material attribute.

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

inline

Return a text description of this sound material attribute.

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

inline

Set the text description of this sound material attribute.

---

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

• omSoundMaterialAttribute.h