Murl::Graph::IWaveUniformTimeController Interface Referenceabstract

The IWaveUniformTimeController interface. More...

#include "murl_graph_i_wave_uniform_time_controller.h"

Inheritance diagram for Murl::Graph::IWaveUniformTimeController:

Public Member Functions

virtual IControllerGetControllerInterface ()=0
 Get the mutable IController interface.
 
virtual const IControllerGetControllerInterface () const =0
 Get the constant IController interface.
 
virtual ITimeControllerGetTimeControllerInterface ()=0
 Get the mutable ITimeController interface.
 
virtual const ITimeControllerGetTimeControllerInterface () const =0
 Get the constant ITimeController interface.
 
virtual IUniformTimeControllerGetUniformTimeControllerInterface ()=0
 Get the mutable IUniformTimeController interface.
 
virtual const IUniformTimeControllerGetUniformTimeControllerInterface () const =0
 Get the constant IUniformTimeController interface.
 
virtual Bool AddGenerator (UInt32 components, IEnums::Waveform waveform, Real offset, Real amplitude, Real phase, Real frequency, Real dutyCycle)=0
 Add a waveform generator. More...
 
virtual UInt32 GetNumberOfGenerators () const =0
 Get the total number of waveform generators defined. More...
 
virtual UInt32 GetAffectedGeneratorComponents (UInt32 generatorIndex) const =0
 Get the affected variable components of a generator at a given index. More...
 
virtual IEnums::Waveform GetGeneratorWaveform (UInt32 generatorIndex) const =0
 Get the waveform function of a generator at a given index. More...
 
virtual Real GetGeneratorOffset (UInt32 generatorIndex) const =0
 Get the value offset (bias) of a generator at a given index. More...
 
virtual Real GetGeneratorAmplitude (UInt32 generatorIndex) const =0
 Get the amplitude of a generator at a given index. More...
 
virtual Real GetGeneratorPhase (UInt32 generatorIndex) const =0
 Get the phase shift of a generator at a given index. More...
 
virtual Real GetGeneratorFrequency (UInt32 generatorIndex) const =0
 Get the frequency of a generator at a given index. More...
 
virtual Real GetGeneratorDutyCycle (UInt32 generatorIndex) const =0
 Get the duty cycle of a generator at a given index. More...
 

Detailed Description

The IWaveUniformTimeController interface.

A wave uniform controller can be attached to any node implementing the Graph::IGenericParameter interface. It is used to control the value of that parameter by applying one or more predefined waveform functions such as sine or rectangle wave or noise.

Member Function Documentation

◆ AddGenerator()

virtual Bool Murl::Graph::IWaveUniformTimeController::AddGenerator ( UInt32  components,
IEnums::Waveform  waveform,
Real  offset,
Real  amplitude,
Real  phase,
Real  frequency,
Real  dutyCycle 
)
pure virtual

Add a waveform generator.

This method adds a waveform item affecting a given set of components of the controlled Graph::IGenericParameter.

Parameters
componentsA bit mask of affected components, with bit numbers in the range from 0 to IEnums::GetUniformTypeNumberOfComponents()-1 with the referenced parameter's data type.
waveformThe waveform to generate.
offsetThe value offset to add to the generated output (bias).
amplitudeThe output amplitude.
phaseThe phase shift in seconds.
frequencyThe waveform frequency in Hertz.
dutyCycleThe duty cycle, used for rectangle and triangle waves.
Returns
true if successful.

◆ GetNumberOfGenerators()

virtual UInt32 Murl::Graph::IWaveUniformTimeController::GetNumberOfGenerators ( ) const
pure virtual

Get the total number of waveform generators defined.

Returns
The number of generators.

◆ GetAffectedGeneratorComponents()

virtual UInt32 Murl::Graph::IWaveUniformTimeController::GetAffectedGeneratorComponents ( UInt32  generatorIndex) const
pure virtual

Get the affected variable components of a generator at a given index.

Parameters
generatorIndexThe index of the generator, from 0 to GetNumberOfGenerators()-1.
Returns
A bit mask of affected variable components.

◆ GetGeneratorWaveform()

virtual IEnums::Waveform Murl::Graph::IWaveUniformTimeController::GetGeneratorWaveform ( UInt32  generatorIndex) const
pure virtual

Get the waveform function of a generator at a given index.

Parameters
generatorIndexThe index of the generator, from 0 to GetNumberOfGenerators()-1.
Returns
The waveform.

◆ GetGeneratorOffset()

virtual Real Murl::Graph::IWaveUniformTimeController::GetGeneratorOffset ( UInt32  generatorIndex) const
pure virtual

Get the value offset (bias) of a generator at a given index.

Parameters
generatorIndexThe index of the generator, from 0 to GetNumberOfGenerators()-1.
Returns
The offset.

◆ GetGeneratorAmplitude()

virtual Real Murl::Graph::IWaveUniformTimeController::GetGeneratorAmplitude ( UInt32  generatorIndex) const
pure virtual

Get the amplitude of a generator at a given index.

Parameters
generatorIndexThe index of the generator, from 0 to GetNumberOfGenerators()-1.
Returns
The amplitude.

◆ GetGeneratorPhase()

virtual Real Murl::Graph::IWaveUniformTimeController::GetGeneratorPhase ( UInt32  generatorIndex) const
pure virtual

Get the phase shift of a generator at a given index.

Parameters
generatorIndexThe index of the generator, from 0 to GetNumberOfGenerators()-1.
Returns
The phase shift.

◆ GetGeneratorFrequency()

virtual Real Murl::Graph::IWaveUniformTimeController::GetGeneratorFrequency ( UInt32  generatorIndex) const
pure virtual

Get the frequency of a generator at a given index.

Parameters
generatorIndexThe index of the generator, from 0 to GetNumberOfGenerators()-1.
Returns
The frequency.

◆ GetGeneratorDutyCycle()

virtual Real Murl::Graph::IWaveUniformTimeController::GetGeneratorDutyCycle ( UInt32  generatorIndex) const
pure virtual

Get the duty cycle of a generator at a given index.

Parameters
generatorIndexThe index of the generator, from 0 to GetNumberOfGenerators()-1.
Returns
The duty cycle.

The documentation for this interface was generated from the following file:
  • murl_graph_i_wave_uniform_time_controller.h


Copyright © 2011-2018 Spraylight GmbH.