csl::AmbisonicPanner Class Reference

#include <AmbisonicPanner.h>

Inheritance diagram for csl::AmbisonicPanner:

List of all members.

Public Member Functions
	AmbisonicPanner (unsigned order=1, SpeakerLayout *layout=SpeakerLayout::defaultSpeakerLayout())
	AmbisonicPanner (unsigned hOrder, unsigned vOrder, SpeakerLayout *layout=SpeakerLayout::defaultSpeakerLayout())
	~AmbisonicPanner ()
virtual void	addSource (SpatialSource &s)
	Implement Panner's addSource, inserting an Encoder to each source.
virtual void	removeSource (SpatialSource &s)
	Remove a sound source.
void	rotate (float amount)
virtual void	nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
	fill the buffer with the next buffer_length of values
void	dump ()
	pretty-print the receiver
Protected Member Functions
virtual void *	cache ()
	Returns an instance of it's cache data per sound source.
Protected Attributes
AmbisonicMixer *	mMixer
	Print info about this instance.
AmbisonicDecoder *	mDecoder
AmbisonicRotator *	mRotator

---

Detailed Description

Ambisonic Panner Wraps around the different ambisonic classes, providing a single interface for encoding, manipulating and decoding (i.e. panning) multiple UnitGenerators.

---

Constructor & Destructor Documentation

AmbisonicPanner::AmbisonicPanner	(	unsigned	order = 1,
		SpeakerLayout *	layout = SpeakerLayout::defaultSpeakerLayout()
	)

References csl::kIgnore, mDecoder, mMixer, mRotator, and csl::UnitGenerator::setCopyPolicy().

AmbisonicPanner::AmbisonicPanner	(	unsigned	hOrder,
		unsigned	vOrder,
		SpeakerLayout *	layout = SpeakerLayout::defaultSpeakerLayout()
	)

References csl::kIgnore, mDecoder, mMixer, mRotator, and csl::UnitGenerator::setCopyPolicy().

AmbisonicPanner::~AmbisonicPanner

(

)

References mDecoder, mMixer, and mRotator.

---

Member Function Documentation

void AmbisonicPanner::addSource

(

SpatialSource &

s

)

[virtual]

Implement Panner's addSource, inserting an Encoder to each source.

Reimplemented from csl::SpatialPanner.

References csl::AmbisonicMixer::addInput(), and mMixer.

void AmbisonicPanner::removeSource

(

SpatialSource &

s

)

[virtual]

Remove a sound source.

Reimplemented from csl::SpatialPanner.

void AmbisonicPanner::rotate

(

float

amount

)

References mRotator, and csl::AmbisonicRotator::setRotate().

void AmbisonicPanner::nextBuffer	(	Buffer &	outputBuffer,
		unsigned	outBufNum
	)			throw (CException) [virtual]

fill the buffer with the next buffer_length of values

Reimplemented from csl::UnitGenerator.

References csl::logMsg().

void csl::AmbisonicPanner::dump

(

void

)

[inline, virtual]

pretty-print the receiver

Reimplemented from csl::UnitGenerator.

void * AmbisonicPanner::cache

(

)

[protected, virtual]

Returns an instance of it's cache data per sound source.

Implements csl::SpatialPanner.

---

Member Data Documentation

AmbisonicMixer* csl::AmbisonicPanner::mMixer [protected]

Print info about this instance.

Referenced by addSource(), AmbisonicPanner(), and ~AmbisonicPanner().

AmbisonicDecoder* csl::AmbisonicPanner::mDecoder [protected]

Referenced by AmbisonicPanner(), and ~AmbisonicPanner().

AmbisonicRotator* csl::AmbisonicPanner::mRotator [protected]

Referenced by AmbisonicPanner(), rotate(), and ~AmbisonicPanner().

---

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

• CSL/Spatializers/Ambisonic/AmbisonicPanner.h
• CSL/Spatializers/Ambisonic/AmbisonicPanner.cpp