VISR  0.12.0
Versatile Interactive Scene Renderer
visr::rcl::PositionDecoder Class Reference

#include <position_decoder.hpp>

Inheritance diagram for visr::rcl::PositionDecoder:
visr::AtomicComponent visr::Component

Public Member Functions

 PositionDecoder (SignalFlowContext const &context, char const *name, CompositeComponent *parent, panning::XYZ const &offsetKinect, float qw=1.0f, float qx=0.0f, float qy=0.0f, float qz=0.0f)
 
 PositionDecoder (PositionDecoder const &)=delete
 
 ~PositionDecoder ()
 
void process () override
 
- Public Member Functions inherited from visr::AtomicComponent
 AtomicComponent (SignalFlowContext const &context, char const *name, CompositeComponent *parent=nullptr)
 
 AtomicComponent (AtomicComponent const &)=delete
 
 AtomicComponent (AtomicComponent &&)=delete
 
virtual ~AtomicComponent () override
 
- Public Member Functions inherited from visr::Component
 Component (SignalFlowContext const &context, char const *componentName, CompositeComponent *parent)
 
 Component (SignalFlowContext const &context, std::string const &componentName, CompositeComponent *parent)
 
 Component (Component const &)=delete
 
 Component (Component &&)=delete
 
Componentoperator= (Component const &)=delete
 
Componentoperator= (Component &&)=delete
 
virtual ~Component ()
 
std::string const & name () const
 
std::string fullName () const
 
void status (StatusMessage::Kind status, char const *message)
 
template<typename ... MessageArgs>
void status (StatusMessage::Kind status, MessageArgs ... args)
 
bool isComposite () const
 
AudioPortBaseaudioPort (char const *portName)
 
AudioPortBase const & audioPort (char const *portName) const
 
AudioPortBaseaudioPort (std::string const &portName)
 
AudioPortBase const & audioPort (std::string const &portName) const
 
ParameterPortBaseparameterPort (char const *portName)
 
ParameterPortBase const & parameterPort (char const *portName) const
 
ParameterPortBaseparameterPort (std::string const &portName)
 
ParameterPortBase const & parameterPort (std::string const &portName) const
 
SamplingFrequencyType samplingFrequency () const
 
std::size_t period () const
 
bool isTopLevel () const
 
impl::ComponentImplementationimplementation ()
 
impl::ComponentImplementation const & implementation () const
 

Additional Inherited Members

- Static Public Member Functions inherited from visr::Component
static const std::string & nameSeparator ()
 
- Protected Member Functions inherited from visr::Component
 Component (impl::ComponentImplementation *impl)
 

Detailed Description

Component to decode listener position data from messages (typically received from a network). This component has neither audio inputs or outputs.

Constructor & Destructor Documentation

◆ PositionDecoder() [1/2]

visr::rcl::PositionDecoder::PositionDecoder ( SignalFlowContext const &  context,
char const *  name,
CompositeComponent parent,
panning::XYZ const &  offsetKinect,
float  qw = 1.0f,
float  qx = 0.0f,
float  qy = 0.0f,
float  qz = 0.0f 
)
explicit

Constructor.

Parameters
contextConfiguration object containing basic execution parameters.
nameThe name of the component. Must be unique within the containing composite component (if there is one).
parentPointer to a containing component if there is one. Specify nullptr in case of a top-level component.
offsetKinectOffset position of the acquisition device (specific geometry assumptions for the Kinect
qwW component of the quaternion describing the coordinate system rotation into the renderer's system
qxX component of the quaternion describing the coordinate system rotation into the renderer's system
qyY component of the quaternion describing the coordinate system rotation into the renderer's system
qzZ component of the quaternion describing the coordinate system rotation into the renderer's system
Todo:
Provide a general implementation for transforming the coordinate system.

◆ PositionDecoder() [2/2]

visr::rcl::PositionDecoder::PositionDecoder ( PositionDecoder const &  )
delete

Disabled (deleted) copy constructor

◆ ~PositionDecoder()

visr::rcl::PositionDecoder::~PositionDecoder ( )

Destructor.

Member Function Documentation

◆ process()

void visr::rcl::PositionDecoder::process ( )
overridevirtual

The process function. Decodes all messages arriving through the "messageInput" parameter input port and sends them through the parameter output "positionOutput".

Implements visr::AtomicComponent.


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