csl::Speaker Class Reference

Represents a speaker as a position relative to the center of a space. More...

#include <SpeakerLayout.h>

List of all members.

Public Member Functions
	Speaker (float azimuth, float elevation, float radius=1.0)
	Speaker (float x, float y, float z, float xNorm, float yNorm, float zNorm, float gain=1.0)
	~Speaker ()
CPoint	position ()
float	azimuth ()
float	elevation ()
float	radius ()
void	setRadius (float radius)
	Specify the distance from the center of the coordinate space to the speaker.
CPoint	normal ()
float	speakerGain ()
void	dump ()
	Print speaker information.
Protected Attributes
CPoint	mPosition
CPoint	mNormal
float	mGain

---

Detailed Description

Represents a speaker as a position relative to the center of a space.

---

Constructor & Destructor Documentation

Speaker::Speaker	(	float	azimuth,
		float	elevation,
		float	radius = 1.0
	)

Speaker constructor. The speaker class should only be used by the speaker layout. Clients should modify speakers using the Speaker layout and not deal with speakers directly. The speaker positions have to be specified in (spherical) radians.

References kPolar, mGain, mNormal, mPosition, and csl::CPoint::set().

Speaker::Speaker	(	float	x,
		float	y,
		float	z,
		float	xNorm,
		float	yNorm,
		float	zNorm,
		float	gain = 1.0
	)

References mGain, mNormal, mPosition, and csl::CPoint::set().

csl::Speaker::~Speaker

(

)

[inline]

---

Member Function Documentation

CPoint csl::Speaker::position

(

)

[inline]

References mPosition.

Referenced by csl::SpeakerSetLayout::findSpeakerTriplets(), and csl::SpeakerSetLayout::invertTripleMatrix().

float csl::Speaker::azimuth

(

)

[inline]

References mPosition, and csl::CPoint::theta().

Referenced by dump(), csl::SpeakerSetLayout::findSpeakerPairs(), and csl::AmbisonicDecoder::makeTransposedReEncodingMatrix().

float csl::Speaker::elevation

(

)

[inline]

References csl::CPoint::ele(), and mPosition.

Referenced by dump(), csl::SpeakerSetLayout::findSpeakerPairs(), and csl::AmbisonicDecoder::makeTransposedReEncodingMatrix().

float csl::Speaker::radius

(

)

[inline]

References mPosition, and csl::CPoint::r().

Referenced by dump(), and setRadius().

void Speaker::setRadius

(

float

radius

)

Specify the distance from the center of the coordinate space to the speaker.

References mPosition, csl::CPoint::normalize(), and radius().

CPoint csl::Speaker::normal

(

)

[inline]

References mNormal.

float csl::Speaker::speakerGain

(

)

[inline]

References mGain.

void Speaker::dump

(

void

)

Print speaker information.

References azimuth(), CSL_PI, elevation(), and radius().

Referenced by csl::SpeakerSetLayout::findSpeakerPairs().

---

Member Data Documentation

CPoint csl::Speaker::mPosition [protected]

Referenced by azimuth(), elevation(), position(), radius(), setRadius(), and Speaker().

CPoint csl::Speaker::mNormal [protected]

Referenced by normal(), and Speaker().

float csl::Speaker::mGain [protected]

Referenced by Speaker(), and speakerGain().

---

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

• CSL/Spatializers/SpeakerLayout.h
• CSL/Spatializers/SpeakerLayout.cpp