#include <object.hpp>
◆ ChannelIndex
Type used for the audio channels associated with an object.
◆ Coordinate
Data types. Data type used by default for all data members such as positions or angles.
◆ Priority
Priority. Low values denote high priority (0 is highest priority)
◆ Object() [1/2]
visr::objectmodel::Object::Object |
( |
| ) |
|
|
delete |
◆ Object() [2/2]
visr::objectmodel::Object::Object |
( |
ObjectId |
id | ) |
|
|
explicit |
◆ ~Object()
visr::objectmodel::Object::~Object |
( |
| ) |
|
|
pure virtualdefault |
◆ channelIndex()
Return the audio channel index for a particular channel.
- Parameters
-
index | the array index within the array of channel indices. |
- Exceptions
-
std::invalid_argument | If index exceeds the number of available audio channels |
◆ clone()
virtual std::unique_ptr<Object> visr::objectmodel::Object::clone |
( |
| ) |
const |
|
pure virtual |
◆ eqCoefficients()
◆ groupId()
GroupId visr::objectmodel::Object::groupId |
( |
| ) |
const |
|
inline |
◆ id()
ObjectId visr::objectmodel::Object::id |
( |
| ) |
const |
|
inline |
◆ level()
LevelType visr::objectmodel::Object::level |
( |
| ) |
const |
◆ numberOfChannels()
std::size_t visr::objectmodel::Object::numberOfChannels |
( |
| ) |
const |
Support for channels assigned to an audio objects. The base class interface supports arbitrary channel numbers and layouts, but derived classes might offer only restricted channel layouts. Return the number of audio channels of this object.
◆ priority()
◆ resetNumberOfChannels()
void visr::objectmodel::Object::resetNumberOfChannels |
( |
std::size_t |
numChannels | ) |
|
Change the number of channels for the audio object. This resets all entries to invalid channel indices (i.e., cInvalidChannelIndex values).
◆ setChannelIndex()
void visr::objectmodel::Object::setChannelIndex |
( |
std::size_t |
index, |
|
|
ChannelIndex |
channelIndex |
|
) |
| |
Set the audio channel index for a particular
- Exceptions
-
std::invalid_argument | if index exceeds the number of channels for this object. |
◆ setEqCoefficients()
◆ setGroupId()
void visr::objectmodel::Object::setGroupId |
( |
ObjectId |
newId | ) |
|
◆ setLevel()
void visr::objectmodel::Object::setLevel |
( |
LevelType |
newLevel | ) |
|
◆ setPriority()
void visr::objectmodel::Object::setPriority |
( |
Priority |
newPriority | ) |
|
◆ type()
virtual ObjectTypeId visr::objectmodel::Object::type |
( |
| ) |
const |
|
pure virtual |
◆ cDefaultGroupId
const GroupId visr::objectmodel::Object::cDefaultGroupId = 0 |
|
static |
◆ cInvalidChannelIndex
Special value to denote an invalid or unassigned audio channel index.
- Todo:
- Decide whether this type must be visible on the outside.
◆ cInvalidObjectId
const ObjectId visr::objectmodel::Object::cInvalidObjectId = UINT_MAX |
|
static |
- Note
- The solution using numeric_limits::max() would be preferable, but cannot be used since MSVC does not support const_expr yet.
Provide definition for the static const class members in order to allow their address to be taken. The value is taken from their declaration within the class.
The documentation for this class was generated from the following files:
- C:/Local/dev/gitlab-runner/builds/a913a013/0/s3a/VISR/src/libobjectmodel/object.hpp
- C:/Local/dev/gitlab-runner/builds/a913a013/0/s3a/VISR/src/libobjectmodel/object.cpp