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

#include <diffusion_gain_calculator.hpp>

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

Public Types

using CoefficientType = SampleType
 

Public Member Functions

 DiffusionGainCalculator (SignalFlowContext const &context, char const *name, CompositeComponent *parent, std::size_t numberOfObjectChannels)
 
 DiffusionGainCalculator (DiffusionGainCalculator const &)=delete
 
 ~DiffusionGainCalculator ()
 
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

Audio component for extracting the diffuseness gain from an object vector.

Member Typedef Documentation

◆ CoefficientType

Type of the gain coefficients. We use the same type as the audio samples.

Constructor & Destructor Documentation

◆ DiffusionGainCalculator() [1/2]

visr::rcl::DiffusionGainCalculator::DiffusionGainCalculator ( SignalFlowContext const &  context,
char const *  name,
CompositeComponent parent,
std::size_t  numberOfObjectChannels 
)
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
numberOfObjectChannelsThe number of object channels supported by this calculator.

◆ DiffusionGainCalculator() [2/2]

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

Disabled (deleted) copy constructor

◆ ~DiffusionGainCalculator()

visr::rcl::DiffusionGainCalculator::~DiffusionGainCalculator ( )

Destructor.

Member Function Documentation

◆ process()

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

Method to initialise the component. The process function.

Implements visr::AtomicComponent.


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