VISR  0.11.8
Versatile Interactive Scene Renderer
visr::objectmodel::PlaneWave Class Reference

#include <plane_wave.hpp>

Inheritance diagram for visr::objectmodel::PlaneWave:
visr::objectmodel::Object

Public Types

using Direction = Coordinate
 
- Public Types inherited from visr::objectmodel::Object
using Coordinate = float
 
using Priority = unsigned char
 
using ChannelIndex = unsigned int
 

Public Member Functions

 PlaneWave ()=delete
 
 PlaneWave (ObjectId id)
 
 PlaneWave (PlaneWave const &rhs)=default
 
virtual ~PlaneWave ()
 
ObjectTypeId type () const
 
std::unique_ptr< Objectclone () const
 
Direction incidenceAzimuth () const
 
Direction incidenceElevation () const
 
void setIncidenceAzimuth (Direction newAzimuth)
 
void setIncidenceElevation (Direction newElevation)
 
Coordinate referenceDistance () const
 
void setReferenceDistance (Coordinate newDistance)
 
- Public Member Functions inherited from visr::objectmodel::Object
 Object ()=delete
 
 Object (ObjectId id)
 
virtual ~Object ()=0
 
ObjectId id () const
 
GroupId groupId () const
 
void setGroupId (ObjectId newId)
 
LevelType level () const
 
void setLevel (LevelType newLevel)
 
Priority priority () const
 
void setPriority (Priority newPriority)
 
rbbl::ParametricIirCoefficientList< Coordinate > const & eqCoefficients () const
 
void setEqCoefficients (rbbl::ParametricIirCoefficientList< Coordinate > const &newCoeffs)
 
std::size_t numberOfChannels () const
 
ChannelIndex channelIndex (std::size_t index) const
 
void resetNumberOfChannels (std::size_t numChannels)
 
void setChannelIndex (std::size_t index, ChannelIndex channelIndex)
 

Additional Inherited Members

- Static Public Attributes inherited from visr::objectmodel::Object
static const ObjectId cInvalidObjectId = UINT_MAX
 
static const GroupId cDefaultGroupId = 0
 
static const ChannelIndex cInvalidChannelIndex = UINT_MAX
 

Member Typedef Documentation

Constructor & Destructor Documentation

visr::objectmodel::PlaneWave::PlaneWave ( )
delete

Default constructor, creates a source with invalid object id and default group id.

visr::objectmodel::PlaneWave::PlaneWave ( ObjectId  id)
explicit
visr::objectmodel::PlaneWave::PlaneWave ( PlaneWave const &  rhs)
default

Copy constructor, explicitly instantiated

visr::objectmodel::PlaneWave::~PlaneWave ( )
virtualdefault

Member Function Documentation

std::unique_ptr< Object > visr::objectmodel::PlaneWave::clone ( ) const
virtual

Clone function simulating a virtual copy constructor.

Note
This method relies on the proper working of the copy constructor.

Implements visr::objectmodel::Object.

Direction visr::objectmodel::PlaneWave::incidenceAzimuth ( ) const
inline
Direction visr::objectmodel::PlaneWave::incidenceElevation ( ) const
inline
Coordinate visr::objectmodel::PlaneWave::referenceDistance ( ) const
inline
void visr::objectmodel::PlaneWave::setIncidenceAzimuth ( Direction  newAzimuth)
void visr::objectmodel::PlaneWave::setIncidenceElevation ( Direction  newElevation)
void visr::objectmodel::PlaneWave::setReferenceDistance ( Coordinate  newDistance)
ObjectTypeId visr::objectmodel::PlaneWave::type ( ) const
virtual

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