Object model library¶
Purpose¶
API reference¶
-
namespace visr
objectmodel
¶ The documentation for the namespace objectmodel. Detailed description follows here.
Typedefs
-
using
visr::objectmodel::ObjectId = typedef unsigned int
-
using
visr::objectmodel::GroupId = typedef unsigned int
-
using
visr::objectmodel::LevelType = typedef float
Type use for level (gain, volume) settings, linear scale
-
using
visr::objectmodel::ObjectTypeIntegerRepresentation = typedef std::uint8_t
Enums
-
enum visr::objectmodel
ObjectTypeId
¶ A numeric id to uniquely describe object types.
Values:
-
visr::objectmodel
PointSource
= 0¶ Simple point-like source (monopole)
-
visr::objectmodel
PlaneWave
= 1¶ Straight plane-wave source type
-
visr::objectmodel
DiffuseSource
= 2¶ Totally diffuse source type
-
visr::objectmodel
PointSourceWithDiffuseness
= 3¶ Point-source-like audio object with an addditional “diffuseness” attribute controlling the fraction of the source that is reproduced diffusely.
-
visr::objectmodel
ExtendedSource
= 4¶ Source type with controllable extent, i.e. width and height.
-
visr::objectmodel
PointSourceWithReverb
= 5¶ Point source with reverberation
-
visr::objectmodel
PointSourceExtent
= 6¶ Point source with explicit spatial extent.
-
visr::objectmodel
HoaSource
= 7¶ Higher Order Ambbisonics object, sound field representation based on spherical harmonics
-
visr::objectmodel
ChannelObject
= 8¶ Source type representing a single or multiple channels routed to a set of loudspeaker channels.
-
visr::objectmodel
Functions
-
std::string const &visr::objectmodel
objectTypeToString
(ObjectTypeId type)¶ Convert an object type id into its string representation
- Parameters
type
:
- Exceptions
std::logic_error
: Happens only in case of an internal inconsistency, i.e., if the type is not found in the lookup table.
-
ObjectTypeId visr::objectmodel
stringToObjectType
(std::string const &typeString)¶ - Return
- The object id of the type correspoonding to the string representation
- Parameters
typeString
:
- Exceptions
std::invalid_argument
: If typeStr does not correspond to an existing object type.
Variables
-
InstantiateObjectFactory const visr::objectmodel
cInstantiationHelper
¶ Object which is used to initialise the object factory.
-
struct visr::objectmodel
InstantiateObjectFactory
¶ A helper class with whole purpose is to register the different object types in the factory.
-
class visr::objectmodel
Object
¶ - #include <object.hpp>
Subclassed by visr::objectmodel::ChannelObject, visr::objectmodel::DiffuseSource, visr::objectmodel::HoaSource, visr::objectmodel::PlaneWave, visr::objectmodel::PointSource
-
class visr::objectmodel
ObjectParser
¶ - #include <object_parser.hpp>
Subclassed by visr::objectmodel::ChannelObjectParser, visr::objectmodel::DiffuseSourceParser, visr::objectmodel::HoaSourceParser, visr::objectmodel::PlaneWaveParser, visr::objectmodel::PointSourceParser
-
class visr::objectmodel
ObjectVector
¶ - #include <object_vector.hpp>
A class representing a set of audio objects of potentially different types.
Subclassed by visr::pml::ObjectVector
-
class visr::objectmodel
PointSource
: public visr::objectmodel::Object - #include <point_source.hpp>
Subclassed by visr::objectmodel::PointSourceWithDiffuseness, visr::objectmodel::PointSourceWithReverb
-
class visr::objectmodel
PointSourceParser
: public visr::objectmodel::ObjectParser¶ - #include <point_source_parser.hpp>
Subclassed by visr::objectmodel::PointSourceWithDiffusenessParser, visr::objectmodel::PointSourceWithReverbParser
-
class visr::objectmodel
PointSourceWithDiffuseness
: public visr::objectmodel::PointSource - #include <point_source_with_diffuseness.hpp>
Subclassed by visr::objectmodel::PointSourceExtent
-
class visr::objectmodel
PointSourceWithDiffusenessParser
: public visr::objectmodel::PointSourceParser¶ - #include <point_source_with_diffuseness_parser.hpp>
Subclassed by visr::objectmodel::PointSourceExtentParser
-
class visr::objectmodel
PointSourceWithReverb
: public visr::objectmodel::PointSource - #include <point_source_with_reverb.hpp>
Audio object representing a monopole point source with corresponding object-based reverberation. Derived from PointSource.
-
namespace visr::objectmodel
python
¶ Functions
-
void visr::objectmodel::python
exportChannelObject
(pybind11::module &m)¶
-
void visr::objectmodel::python
exportDiffuseSource
(pybind11::module &m)¶
-
void visr::objectmodel::python
exportHoaSource
(pybind11::module &m)¶
-
void visr::objectmodel::python
exportObject
(pybind11::module &m)¶
-
void visr::objectmodel::python
exportObjectType
(pybind11::module &m)¶
-
void visr::objectmodel::python
exportObjectVector
(py::module &m)¶
-
void visr::objectmodel::python
exportObjectVector
(pybind11::module &m)¶
-
void visr::objectmodel::python
exportPointSource
(pybind11::module &m)¶
-
void visr::objectmodel::python
exportPointSourceExtent
(pybind11::module &m)¶
-
void visr::objectmodel::python
exportPointSourceWithDiffuseness
(pybind11::module &m)¶
-
void visr::objectmodel::python
exportPointSourceWithReverb
(pybind11::module &m)¶
-
void visr::objectmodel::python
exportPlaneWave
(pybind11::module &m)¶
-
void visr::objectmodel::python
-
namespace visr::objectmodel
test
¶ Functions
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(ParsePointSource)¶
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(ParsePlaneWave)¶
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(UpdateSceneSameIdSameType)¶
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(UpdateSceneSameIdDifferentType)¶
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(ParseMultiChannelObject)¶
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(ParseObjectEq)¶
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(ReencodeObjectEq)¶
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(ParseChannelObject)¶
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(WriteChannelObject)¶
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(InstantiatePointSources)¶
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(ObjectVectorAssign)¶
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(ParsePointSourceWithReverb)¶
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(SerialisePointSourceWithReverb)¶
-
visr::objectmodel::test
BOOST_AUTO_TEST_CASE
(InstantiateRenderer)¶
-
visr::objectmodel::test
-
using