om::sound::acoustics::base::AcousticUsage Class Reference

A class that specifies how the output of an acoustic simluation will be used. More...

#include <omAcousticUsage.h>

Public Types
enum	Enum {   UNDEFINED = 0, FAST, INTERACTIVE, OFFLINE,   DEFAULT = INTERACTIVE }

Public Member Functions
	AcousticUsage ()
	Create a new acoustic usage with the default usage. More...
	AcousticUsage (Enum newUsage)
	Create a new acoustic usage with the specified acoustic usage enum value. More...
	operator Enum () const
	Convert this acoustic usage to an enum value. More...
String	toString () const
	Return a string representation of the acoustic usage. More...
	operator String () const
	Convert this acoustic usage into a string representation. More...

Detailed Description

A class that specifies how the output of an acoustic simluation will be used.

Member Enumeration Documentation

enum om::sound::acoustics::base::AcousticUsage::Enum

Enumerator
UNDEFINED	An unfefined acoustic usage.
FAST	A usage that specifies that the acoustic simulation is for a time-critical application. In this case, the acoustic simulation should use the fastest mode available to compute the sound. This mode may come with a loss of quality compared to the less-efficient modes.
INTERACTIVE	A usage that specifies that the acoustic simulation is for an interactive application. In this case, the acoustic simulation can change the quality to maintain interactive performance. The output of the simulation is a sequence of acoustic frames that may be dependent on each other (e.g. using temporal coherence/caching).
OFFLINE	A usage that indicates that the acoustic simulation is for an offline application (not interactive). In this case, the simulation produces acoustic frames that are independent of each other (no temporal caching). The simulation aims for high-quality results rather than fast updates.
DEFAULT	The default acoustic usage.

Constructor & Destructor Documentation

om::sound::acoustics::base::AcousticUsage::AcousticUsage ( )

inline

Create a new acoustic usage with the default usage.

om::sound::acoustics::base::AcousticUsage::AcousticUsage ( Enum  newUsage )

inline

Create a new acoustic usage with the specified acoustic usage enum value.

Member Function Documentation

om::sound::acoustics::base::AcousticUsage::operator Enum ( ) const

inline

Convert this acoustic usage to an enum value.

String om::sound::acoustics::base::AcousticUsage::toString

(

)

const

Return a string representation of the acoustic usage.

om::sound::acoustics::base::AcousticUsage::operator String ( ) const

inline

Convert this acoustic usage into a string representation.

---

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

• omAcousticUsage.h