Murl Engine Lua Addon API  Version 1.0 beta
Murl.Graph.IWaveUniformTimeController

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.


Table members

Methods


GetTimeControllerInterface()

Get the constant ITimeController interface.

Murl.Graph.ITimeController GetTimeControllerInterface()

Returns
Murl.Graph.ITimeController The constant ITimeController interface.

GetUniformTimeControllerInterface()

Get the constant IUniformTimeController interface.

Murl.Graph.IUniformTimeController GetUniformTimeControllerInterface()

Returns
Murl.Graph.IUniformTimeController The constant IUniformTimeController interface.

AddGenerator(components, waveform, offset, amplitude, phase, frequency, dutyCycle)

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

Boolean AddGenerator(Integer components, Murl.IEnums.Waveform waveform, Number offset, Number amplitude, Number phase, Number frequency, Number dutyCycle)

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
Boolean true if successful.

GetNumberOfGenerators()

Get the total number of waveform generators defined.

Integer GetNumberOfGenerators()

Returns
Integer The number of generators.

GetAffectedGeneratorComponents(generatorIndex)

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

Integer GetAffectedGeneratorComponents(Integer generatorIndex)

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

GetGeneratorWaveform(generatorIndex)

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

Murl.IEnums.Waveform GetGeneratorWaveform(Integer generatorIndex)

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

GetGeneratorOffset(generatorIndex)

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

Number GetGeneratorOffset(Integer generatorIndex)

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

GetGeneratorAmplitude(generatorIndex)

Get the amplitude of a generator at a given index.

Number GetGeneratorAmplitude(Integer generatorIndex)

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

GetGeneratorPhase(generatorIndex)

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

Number GetGeneratorPhase(Integer generatorIndex)

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

GetGeneratorFrequency(generatorIndex)

Get the frequency of a generator at a given index.

Number GetGeneratorFrequency(Integer generatorIndex)

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

GetGeneratorDutyCycle(generatorIndex)

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

Number GetGeneratorDutyCycle(Integer generatorIndex)

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