A class that stores information about the 3D placement and semantic type of a channel's speaker.
More...
#include <omSoundChannelInfo.h>
|
| | ChannelInfo () |
| | Create a new channel information object with undefined type and position (0,0,0). More...
|
| |
| | ChannelInfo (const ChannelType &newType) |
| | Create a new channel information object with the specified type that is not positional. More...
|
| |
| | ChannelInfo (const ChannelType &newType, const Vector2f &newPosition) |
| | Create a new channel information object with the specified type and 2D speaker position. More...
|
| |
| | ChannelInfo (const ChannelType &newType, const Vector3f &newPosition) |
| | Create a new channel information object with the specified type and 3D speaker position. More...
|
| |
| Bool | operator== (const ChannelInfo &other) const |
| | Return whether or not this channel info object is equal to another. More...
|
| |
| Bool | operator!= (const ChannelInfo &other) const |
| | Return whether or not this channel info object is not equal to another. More...
|
| |
| const ChannelType & | getType () const |
| | Return an object representing the semantic type of this channel's speaker. More...
|
| |
| void | setType (const ChannelType &newType) |
| | Set the semantic type of this channel's speaker. More...
|
| |
| const Vector3f & | getPosition () const |
| | Return a reference to the 3D position of the channel's speaker relative to the listener. More...
|
| |
| void | setPosition (const Vector2f &newPosition) |
| | Set the 2D XZ plane position of the channel's speaker relative to the listener. More...
|
| |
| void | setPosition (const Vector3f &newPosition) |
| | Set the 3D position of the channel's speaker relative to the listener. More...
|
| |
| Bool | isPositional () const |
| | Return whether or not this channel has a position that is non-zero. More...
|
| |
A class that stores information about the 3D placement and semantic type of a channel's speaker.
| om::sound::base::ChannelInfo::ChannelInfo |
( |
| ) |
|
|
inline |
Create a new channel information object with undefined type and position (0,0,0).
| om::sound::base::ChannelInfo::ChannelInfo |
( |
const ChannelType & |
newType | ) |
|
|
inline |
Create a new channel information object with the specified type that is not positional.
| om::sound::base::ChannelInfo::ChannelInfo |
( |
const ChannelType & |
newType, |
|
|
const Vector2f & |
newPosition |
|
) |
| |
|
inline |
Create a new channel information object with the specified type and 2D speaker position.
| om::sound::base::ChannelInfo::ChannelInfo |
( |
const ChannelType & |
newType, |
|
|
const Vector3f & |
newPosition |
|
) |
| |
|
inline |
Create a new channel information object with the specified type and 3D speaker position.
| Bool om::sound::base::ChannelInfo::operator== |
( |
const ChannelInfo & |
other | ) |
const |
|
inline |
Return whether or not this channel info object is equal to another.
| Bool om::sound::base::ChannelInfo::operator!= |
( |
const ChannelInfo & |
other | ) |
const |
|
inline |
Return whether or not this channel info object is not equal to another.
| const ChannelType& om::sound::base::ChannelInfo::getType |
( |
| ) |
const |
|
inline |
Return an object representing the semantic type of this channel's speaker.
| void om::sound::base::ChannelInfo::setType |
( |
const ChannelType & |
newType | ) |
|
|
inline |
Set the semantic type of this channel's speaker.
| const Vector3f& om::sound::base::ChannelInfo::getPosition |
( |
| ) |
const |
|
inline |
Return a reference to the 3D position of the channel's speaker relative to the listener.
The position is specified in the right-handed coordinate system where -z is forward, +x is right, and +y is up. The distance to the speaker may optionally be encoded as the magnitude of the position vector.
| void om::sound::base::ChannelInfo::setPosition |
( |
const Vector2f & |
newPosition | ) |
|
|
inline |
Set the 2D XZ plane position of the channel's speaker relative to the listener.
The position is specified in the right-handed coordinate system where -z is forward, +x is right, and +y is up. This method is designed for dealing with 2D arrays of speakers in the horizontal plane. The value 0 is inserted for the Y component of the 3D position vector. The distance to the speaker may optionally be encoded as the magnitude of the position vector.
| void om::sound::base::ChannelInfo::setPosition |
( |
const Vector3f & |
newPosition | ) |
|
|
inline |
Set the 3D position of the channel's speaker relative to the listener.
The position is specified in the right-handed coordinate system where -z is forward, +x is right, and +y is up. This method is designed for dealing with 3D arrays of speakers. The distance to the speaker may optionally be encoded as the magnitude of the position vector.
| Bool om::sound::base::ChannelInfo::isPositional |
( |
| ) |
const |
|
inline |
Return whether or not this channel has a position that is non-zero.
The documentation for this class was generated from the following file:
1.8.11
