![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
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.
Get the constant ITimeController interface.
Murl.Graph.ITimeController GetTimeControllerInterface()
Get the constant IUniformTimeController interface.
Murl.Graph.IUniformTimeController GetUniformTimeControllerInterface()
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)
components | A bit mask of affected components, with bit numbers in the range from 0 to IEnums::GetUniformTypeNumberOfComponents()-1 with the referenced parameter's data type. |
waveform | The waveform to generate. |
offset | The value offset to add to the generated output (bias). |
amplitude | The output amplitude. |
phase | The phase shift in seconds. |
frequency | The waveform frequency in Hertz. |
dutyCycle | The duty cycle, used for rectangle and triangle waves. |
Get the total number of waveform generators defined.
Integer GetNumberOfGenerators()
Get the affected variable components of a generator at a given index.
Integer GetAffectedGeneratorComponents(Integer generatorIndex)
generatorIndex | The index of the generator, from 0 to GetNumberOfGenerators()-1. |
Get the waveform function of a generator at a given index.
Murl.IEnums.Waveform GetGeneratorWaveform(Integer generatorIndex)
generatorIndex | The index of the generator, from 0 to GetNumberOfGenerators()-1. |
Get the value offset (bias) of a generator at a given index.
Number GetGeneratorOffset(Integer generatorIndex)
generatorIndex | The index of the generator, from 0 to GetNumberOfGenerators()-1. |
Get the amplitude of a generator at a given index.
Number GetGeneratorAmplitude(Integer generatorIndex)
generatorIndex | The index of the generator, from 0 to GetNumberOfGenerators()-1. |
Get the phase shift of a generator at a given index.
Number GetGeneratorPhase(Integer generatorIndex)
generatorIndex | The index of the generator, from 0 to GetNumberOfGenerators()-1. |
Get the frequency of a generator at a given index.
Number GetGeneratorFrequency(Integer generatorIndex)
generatorIndex | The index of the generator, from 0 to GetNumberOfGenerators()-1. |
Get the duty cycle of a generator at a given index.
Number GetGeneratorDutyCycle(Integer generatorIndex)
generatorIndex | The index of the generator, from 0 to GetNumberOfGenerators()-1. |