VISR  0.11.1
Versatile Interactive Scene Renderer
visr::objectmodel Namespace Reference

Namespaces

 python
 
 test
 

Classes

class  ChannelObject
 
class  ChannelObjectParser
 
class  DiffuseSource
 
class  DiffuseSourceParser
 
class  HoaSource
 
class  HoaSourceParser
 
struct  InstantiateObjectFactory
 
class  Object
 
class  ObjectFactory
 
class  ObjectParser
 
class  ObjectVector
 
class  ObjectVectorParser
 
class  PlaneWave
 
class  PlaneWaveParser
 
class  PointSource
 
class  PointSourceExtent
 
class  PointSourceExtentParser
 
class  PointSourceParser
 
class  PointSourceWithDiffuseness
 
class  PointSourceWithDiffusenessParser
 
class  PointSourceWithReverb
 
class  PointSourceWithReverbParser
 

Typedefs

using ObjectId = unsigned int
 
using GroupId = unsigned int
 
using LevelType = float
 
using ObjectTypeIntegerRepresentation = std::uint8_t
 

Enumerations

enum  ObjectTypeId : ObjectTypeIntegerRepresentation {
  ObjectTypeId::PointSource = 0, ObjectTypeId::PlaneWave = 1, ObjectTypeId::DiffuseSource = 2, ObjectTypeId::PointSourceWithDiffuseness = 3,
  ObjectTypeId::ExtendedSource = 4, ObjectTypeId::PointSourceWithReverb = 5, ObjectTypeId::PointSourceExtent = 6, ObjectTypeId::HoaSource = 7,
  ObjectTypeId::ChannelObject = 8
}
 

Functions

const std::string & objectTypeToString (ObjectTypeId type)
 
ObjectTypeId stringToObjectType (std::string const &typeString)
 

Variables

InstantiateObjectFactory const cInstantiationHelper
 

Detailed Description

The documentation for the namespace objectmodel. Detailed description follows here.

Typedef Documentation

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::ObjectId = typedef unsigned int

Enumeration Type Documentation

A numeric id to uniquely describe object types.

Enumerator
PointSource 

Simple point-like source (monopole)

PlaneWave 

Straight plane-wave source type

DiffuseSource 

Totally diffuse source type

PointSourceWithDiffuseness 

Point-source-like audio object with an addditional "diffuseness" attribute controlling the fraction of the source that is reproduced diffusely.

ExtendedSource 

Source type with controllable extent, i.e. width and height.

PointSourceWithReverb 

Point source with reverberation

PointSourceExtent 

Point source with explicit spatial extent.

HoaSource 

Higher Order Ambbisonics object, sound field representation based on spherical harmonics

ChannelObject 

Source type representing a single or multiple channels routed to a set of loudspeaker channels.

Function Documentation

std::string const & visr::objectmodel::objectTypeToString ( ObjectTypeId  type)

Convert an object type id into its string representation

Parameters
type
Exceptions
std::logic_errorHappens 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)
Parameters
typeString
Returns
The object id of the type correspoonding to the string representation
Exceptions
std::invalid_argumentIf typeStr does not correspond to an existing object type.

Variable Documentation

InstantiateObjectFactory const visr::objectmodel::cInstantiationHelper

Object which is used to initialise the object factory.