csl::AmbisonicRotator Class Reference

#include <AmbisonicUtilities.h>

Inheritance diagram for csl::AmbisonicRotator:

List of all members.

Public Member Functions
	AmbisonicRotator (AmbisonicUnitGenerator &input)
	initializes with no rotation
	AmbisonicRotator (UnitGenerator &input, unsigned order)
	initializes with uniform Ambisonic order and no rotation
	AmbisonicRotator (UnitGenerator &input, unsigned vorder, unsigned horder)
	initializes with hybrid Ambisonic order and no rotation
	~AmbisonicRotator ()
void	setNthInput (float amount, Axes axis)
void	setTilt (float amount)
void	setTumble (float amount)
void	setRotate (float amount)
virtual void	nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
Protected Attributes
unsigned	mNumFrames
unsigned	mGreaterOrder
unsigned	mNumChannelsGreaterOrder
unsigned *	mChannelIndex
unsigned *	mInputChannelIndex
bool	mShouldRotate
bool	mShouldTurn
bool	mShouldTilt
Private Member Functions
void	initialize (UnitGenerator &input)
void	tiltFirstOrder ()
void	tiltSecondOrder ()
void	tiltThirdOrder ()
void	tumbleFirstOrder ()
void	tumbleSecondOrder ()
void	tumbleThirdOrder ()
void	rotateZerothOrder ()
void	rotateFirstOrderHorizontal ()
void	rotateSecondOrderHorizontal ()
void	rotateThirdOrderHorizontal ()
void	rotateFirstOrderVertical ()
void	rotateSecondOrderVertical ()
void	rotateThirdOrderVertical ()
Private Attributes
Port *	mInputPort
sample	mRotate
sample	mTumble
sample	mTilt
SampleBuffer	mSinAngle
SampleBuffer	mCosAngle
SampleBufferVector	mOutPtr
SampleBufferVector	mInPtr

---

Constructor & Destructor Documentation

AmbisonicRotator::AmbisonicRotator

(

AmbisonicUnitGenerator &

input

)

initializes with no rotation

References initialize().

AmbisonicRotator::AmbisonicRotator	(	UnitGenerator &	input,
		unsigned	order
	)

initializes with uniform Ambisonic order and no rotation

References initialize().

AmbisonicRotator::AmbisonicRotator	(	UnitGenerator &	input,
		unsigned	vorder,
		unsigned	horder
	)

initializes with hybrid Ambisonic order and no rotation

References initialize().

AmbisonicRotator::~AmbisonicRotator

(

void

)

References mChannelIndex, mCosAngle, mInPtr, mInputChannelIndex, mInputPort, csl::UnitGenerator::mNumChannels, mOutPtr, mSinAngle, csl::Port::mUGen, and csl::UnitGenerator::removeOutput().

---

Member Function Documentation

void AmbisonicRotator::setNthInput	(	float	amount,
		Axes	axis
	)

References csl::kLogError, csl::kROTATE, csl::kTILT, csl::kTUMBLE, csl::logMsg(), setRotate(), setTilt(), and setTumble().

void AmbisonicRotator::setTilt

(

float

amount

)

References csl::AmbisonicOrder::isUniform, csl::kLogWarning, csl::logMsg(), csl::AmbisonicUnitGenerator::mOrder, mShouldTilt, and mTilt.

Referenced by setNthInput().

void AmbisonicRotator::setTumble

(

float

amount

)

References csl::AmbisonicOrder::isUniform, csl::kLogWarning, csl::logMsg(), csl::AmbisonicUnitGenerator::mOrder, mShouldTurn, and mTumble.

Referenced by setNthInput().

void AmbisonicRotator::setRotate

(

float

amount

)

References mRotate, and mShouldRotate.

Referenced by main(), csl::AmbisonicPanner::rotate(), and setNthInput().

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

really compute the next buffer given an offset base channel; this is called by nextBuffer, possibly multiple times

Reimplemented from csl::UnitGenerator.

References testkiss::j, csl::kLogError, csl::kSamples, csl::logMsg(), csl::Buffer::mBuffers, csl::Buffer::mIsPopulated, csl::Buffer::mNumFrames, and csl::Buffer::mType.

void AmbisonicRotator::initialize

(

UnitGenerator &

input

)

[private]

References csl::UnitGenerator::addOutput(), csl::AmbisonicUnitGenerator::channelIndexer(), csl::AmbisonicUnitGenerator::greaterOrder(), csl::AmbisonicOrder::horizontalOrder, csl::AmbisonicOrder::isUniform, csl::kLogWarning, csl::logMsg(), mChannelIndex, mCosAngle, mGreaterOrder, mInPtr, mInputChannelIndex, mInputPort, csl::UnitGenerator::mNumChannels, mNumChannelsGreaterOrder, csl::AmbisonicUnitGenerator::mOrder, mOutPtr, mShouldRotate, mShouldTilt, mShouldTurn, mSinAngle, csl::UnitGenerator::numChannels(), csl::AmbisonicUnitGenerator::orderToChannels(), and csl::AmbisonicOrder::verticalOrder.

Referenced by AmbisonicRotator().

void AmbisonicRotator::tiltFirstOrder

(

)

[private]

References mCosAngle, mNumFrames, mOutPtr, and mSinAngle.

void AmbisonicRotator::tiltSecondOrder

(

)

[private]

References mCosAngle, mGreaterOrder, mNumFrames, mOutPtr, mSinAngle, and tiltThirdOrder().

void AmbisonicRotator::tiltThirdOrder

(

)

[private]

References mCosAngle, mNumFrames, mOutPtr, and mSinAngle.

Referenced by tiltSecondOrder().

void AmbisonicRotator::tumbleFirstOrder

(

)

[private]

References mCosAngle, mNumFrames, mOutPtr, and mSinAngle.

void AmbisonicRotator::tumbleSecondOrder

(

)

[private]

References mCosAngle, mGreaterOrder, mNumFrames, mOutPtr, mSinAngle, and tumbleThirdOrder().

void AmbisonicRotator::tumbleThirdOrder

(

)

[private]

References mCosAngle, mNumFrames, mOutPtr, and mSinAngle.

Referenced by tumbleSecondOrder().

void csl::AmbisonicRotator::rotateZerothOrder

(

)

[private]

void AmbisonicRotator::rotateFirstOrderHorizontal

(

)

[private]

References csl::AmbisonicOrder::horizontalOrder, mCosAngle, mNumFrames, csl::AmbisonicUnitGenerator::mOrder, mOutPtr, mSinAngle, and rotateSecondOrderHorizontal().

void AmbisonicRotator::rotateSecondOrderHorizontal

(

)

[private]

References csl::AmbisonicOrder::horizontalOrder, mCosAngle, mNumFrames, csl::AmbisonicUnitGenerator::mOrder, mOutPtr, mSinAngle, and rotateThirdOrderHorizontal().

Referenced by rotateFirstOrderHorizontal().

void AmbisonicRotator::rotateThirdOrderHorizontal

(

)

[private]

References mCosAngle, mNumFrames, mOutPtr, and mSinAngle.

Referenced by rotateSecondOrderHorizontal().

void csl::AmbisonicRotator::rotateFirstOrderVertical

(

)

[private]

void AmbisonicRotator::rotateSecondOrderVertical

(

)

[private]

References mCosAngle, mNumFrames, csl::AmbisonicUnitGenerator::mOrder, mOutPtr, mSinAngle, rotateThirdOrderVertical(), and csl::AmbisonicOrder::verticalOrder.

void AmbisonicRotator::rotateThirdOrderVertical

(

)

[private]

References mCosAngle, mNumFrames, mOutPtr, and mSinAngle.

Referenced by rotateSecondOrderVertical().

---

Member Data Documentation

unsigned csl::AmbisonicRotator::mNumFrames [protected]

Referenced by rotateFirstOrderHorizontal(), rotateSecondOrderHorizontal(), rotateSecondOrderVertical(), rotateThirdOrderHorizontal(), rotateThirdOrderVertical(), tiltFirstOrder(), tiltSecondOrder(), tiltThirdOrder(), tumbleFirstOrder(), tumbleSecondOrder(), and tumbleThirdOrder().

unsigned csl::AmbisonicRotator::mGreaterOrder [protected]

Referenced by initialize(), tiltSecondOrder(), and tumbleSecondOrder().

unsigned csl::AmbisonicRotator::mNumChannelsGreaterOrder [protected]

Referenced by initialize().

unsigned* csl::AmbisonicRotator::mChannelIndex [protected]

Referenced by initialize(), and ~AmbisonicRotator().

unsigned* csl::AmbisonicRotator::mInputChannelIndex [protected]

Referenced by initialize(), and ~AmbisonicRotator().

bool csl::AmbisonicRotator::mShouldRotate [protected]

Referenced by initialize(), and setRotate().

bool csl::AmbisonicRotator::mShouldTurn [protected]

Referenced by initialize(), and setTumble().

bool csl::AmbisonicRotator::mShouldTilt [protected]

Referenced by initialize(), and setTilt().

Port* csl::AmbisonicRotator::mInputPort [private]

Referenced by initialize(), and ~AmbisonicRotator().

sample csl::AmbisonicRotator::mRotate [private]

Referenced by setRotate().

sample csl::AmbisonicRotator::mTumble [private]

Referenced by setTumble().

sample csl::AmbisonicRotator::mTilt [private]

Referenced by setTilt().

SampleBuffer csl::AmbisonicRotator::mSinAngle [private]

Referenced by initialize(), rotateFirstOrderHorizontal(), rotateSecondOrderHorizontal(), rotateSecondOrderVertical(), rotateThirdOrderHorizontal(), rotateThirdOrderVertical(), tiltFirstOrder(), tiltSecondOrder(), tiltThirdOrder(), tumbleFirstOrder(), tumbleSecondOrder(), tumbleThirdOrder(), and ~AmbisonicRotator().

SampleBuffer csl::AmbisonicRotator::mCosAngle [private]

Referenced by initialize(), rotateFirstOrderHorizontal(), rotateSecondOrderHorizontal(), rotateSecondOrderVertical(), rotateThirdOrderHorizontal(), rotateThirdOrderVertical(), tiltFirstOrder(), tiltSecondOrder(), tiltThirdOrder(), tumbleFirstOrder(), tumbleSecondOrder(), tumbleThirdOrder(), and ~AmbisonicRotator().

SampleBufferVector csl::AmbisonicRotator::mOutPtr [private]

Referenced by initialize(), rotateFirstOrderHorizontal(), rotateSecondOrderHorizontal(), rotateSecondOrderVertical(), rotateThirdOrderHorizontal(), rotateThirdOrderVertical(), tiltFirstOrder(), tiltSecondOrder(), tiltThirdOrder(), tumbleFirstOrder(), tumbleSecondOrder(), tumbleThirdOrder(), and ~AmbisonicRotator().

SampleBufferVector csl::AmbisonicRotator::mInPtr [private]

Referenced by initialize(), and ~AmbisonicRotator().

---

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

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