om::sound::acoustics::base::AcousticFlags Class Reference

A class that encapsulates the different boolean flags that an acoustic simulation can have. More...

#include <omAcousticFlags.h>

Public Types
enum	Flag {   DIRECT = (1 << 0), REFLECTION = (1 << 1), TRANSMISSION = (1 << 2), DIFFRACTION = (1 << 3),   HRTF = (1 << 4), DIRECTIVITY = (1 << 5), MEDIA = (1 << 6), DOPPLER = (1 << 7),   DEFAULT = DIRECT | REFLECTION | TRANSMISSION | DIFFRACTION | HRTF | DIRECTIVITY | MEDIA | DOPPLER, UNDEFINED = 0 }
	An enum that specifies the different acoustic simulation flags. More...

Public Member Functions
	AcousticFlags ()
	Create a new acoustic flags object with no flags set. More...
	AcousticFlags (Flag flag)
	Create a new acoustic flags object with the specified flag value initially set. More...
	AcousticFlags (UInt32 newFlags)
	Create a new acoustic flags object with the specified initial combined flags value. More...
	operator UInt32 () const
	Convert this acoustic flags object to an integer value. More...
Bool	isSet (Flag flag) const
	Return whether or not the specified flag value is set for this flags object. More...
void	set (Flag flag, Bool newIsSet)
	Set whether or not the specified flag value is set for this flags object. More...

Detailed Description

A class that encapsulates the different boolean flags that an acoustic simulation can have.

These flags provide boolean information about an acoustic simulation. Flags are indicated by setting a single bit of a 32-bit unsigned integer to 1.

Enum values for the different flags are defined as members of the class. Typically, the user would bitwise-OR the flag enum values together to produce a final set of set flags.

Member Enumeration Documentation

enum om::sound::acoustics::base::AcousticFlags::Flag

An enum that specifies the different acoustic simulation flags.

Enumerator
DIRECT	A flag indicating whether or not direct sound modeling is enabled for the acoustic simulation.
REFLECTION	A flag indicating whether or not reflected sound modeling is enabled for the acoustic simulation.
TRANSMISSION	A flag indicating whether or not transmission modeling is enabled for the acoustic simulation.
DIFFRACTION	A flag indicating whether or not diffraction modeling is enabled for the acoustic simulation.
HRTF	A flag indicating whether or not HRTF spatial sound is enabled for the acoustic simulation.
DIRECTIVITY	A flag indicating whether or not source directivity is enabled for the acoustic simulation.
MEDIA	A flag indicating whether or not sound medium modeling is enabled for the acoustic simulation.
DOPPLER	A flag indicating whether or not doppler effect modeling is enabled for the acoustic simulation.
DEFAULT	The default flags to use for an acoustic simulation.
UNDEFINED	The flag value when all flags are not set.

Constructor & Destructor Documentation

om::sound::acoustics::base::AcousticFlags::AcousticFlags ( )

inline

Create a new acoustic flags object with no flags set.

om::sound::acoustics::base::AcousticFlags::AcousticFlags ( Flag  flag )

inline

Create a new acoustic flags object with the specified flag value initially set.

om::sound::acoustics::base::AcousticFlags::AcousticFlags ( UInt32  newFlags )

inline

Create a new acoustic flags object with the specified initial combined flags value.

Member Function Documentation

om::sound::acoustics::base::AcousticFlags::operator UInt32 ( ) const

inline

Convert this acoustic flags object to an integer value.

This operator is provided so that the AcousticFlags object can be used as an integer value for bitwise logical operations.

Bool om::sound::acoustics::base::AcousticFlags::isSet ( Flag  flag ) const

inline

Return whether or not the specified flag value is set for this flags object.

void om::sound::acoustics::base::AcousticFlags::set ( Flag  flag, Bool  newIsSet  )

inline

Set whether or not the specified flag value is set for this flags object.

---

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

• omAcousticFlags.h