A class that receives the output of sound propagation in an acoustic context. More...

#include <omAcousticResult.h>

Public Member Functions
	AcousticResult ()
	Create a new empty acoustic result. More...

	~AcousticResult ()
	Destroy this acoustic result and release all internal resources. More...

Size	getPairCount () const
	Return the number of acoustic pairs there are in this result. More...

AcousticPairResult *	getPair (Index pairIndex)
	Return a pointer to the result for the acoustic pair at the specified index. More...

const AcousticPairResult *	getPair (Index pairIndex) const
	Return a pointer to the result for the acoustic pair at the specified index. More...

AcousticPairResult *	addPair (SoundListener listener, SoundSource source)
	Create and return a pointer to a new acoustic pair result for the specified listener and source. More...

void	clearPairs ()
	Remove all acoustic pairs from this result but don't deallocate their storage. More...

AcousticStatistics &	getStatistics ()
	Return a reference to an object that recieves statistics about the simulation context. More...

const AcousticStatistics &	getStatistics () const
	Return a reference to an object that recieves statistics about the simulation context. More...

void	reset ()
	Reset this acoustic result to its default state and deallocate internal storage. More...

Detailed Description

A class that receives the output of sound propagation in an acoustic context.

Constructor & Destructor Documentation

om::sound::acoustics::contexts::AcousticResult::AcousticResult ( )

Create a new empty acoustic result.

om::sound::acoustics::contexts::AcousticResult::~AcousticResult ( )

Destroy this acoustic result and release all internal resources.

Size om::sound::acoustics::contexts::AcousticResult::getPairCount ( ) const

inline

Return the number of acoustic pairs there are in this result.

AcousticPairResult* om::sound::acoustics::contexts::AcousticResult::getPair ( Index pairIndex )

inline

Return a pointer to the result for the acoustic pair at the specified index.

const AcousticPairResult* om::sound::acoustics::contexts::AcousticResult::getPair ( Index pairIndex ) const

inline

Return a pointer to the result for the acoustic pair at the specified index.

AcousticPairResult* om::sound::acoustics::contexts::AcousticResult::addPair	(	SoundListener *	listener,
		SoundSource *	source
	)

Create and return a pointer to a new acoustic pair result for the specified listener and source.

void om::sound::acoustics::contexts::AcousticResult::clearPairs ( )

inline

Remove all acoustic pairs from this result but don't deallocate their storage.

AcousticStatistics& om::sound::acoustics::contexts::AcousticResult::getStatistics ( )

inline

Return a reference to an object that recieves statistics about the simulation context.

const AcousticStatistics& om::sound::acoustics::contexts::AcousticResult::getStatistics ( ) const

inline

Return a reference to an object that recieves statistics about the simulation context.

void om::sound::acoustics::contexts::AcousticResult::reset ( )

Reset this acoustic result to its default state and deallocate internal storage.

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