![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
The IVariable graph node interface.
Variable nodes provide a generic bridge between user logic code and certain scene graph nodes as well as a means for simple arithmetic operations within the scene graph. Variable nodes serve as input for e.g. controllers that implement the Graph::IVariableController interface, or Graph::IClipTransition nodes.
Depending on the actual operation given (IEnums::ALU_OPERATION_*), certain constraints apply to the given input and output data types (inType and outType: IEnums::VARIABLE_TYPE_*) as well as number of constant and variable inputs and outputs (numIn and numOut):
Get the constant Graph::INode interface. This method returns a constant pointer to the node's Graph::INode interface, to be able to query common node properties such as active state, visibility or ID.
Murl.Graph.INode GetNodeInterface()
Set the data type for all constant input operands.
Boolean SetInputType(Murl.IEnums.VariableType type)
type | The data type. |
Get the data type for all constant input operands.
Murl.IEnums.VariableType GetInputType()
Set the output data type.
Boolean SetOutputType(Murl.IEnums.VariableType type)
type | The data type. |
Get the output data type.
Murl.IEnums.VariableType GetOutputType()
Set the arithmetic/logic operation to perform.
Boolean SetOperation(Murl.IEnums.AluOperation operation)
operation | The operation. |
Get the arithmetic/logic operation performed.
Murl.IEnums.AluOperation GetOperation()
Enable/disable auto-resetting.
Boolean SetAutoResetEnabled(Boolean enabled)
enabled | If true, auto-resetting is enabled. |
Check if auto-resetting is enabled.
Boolean IsAutoResetEnabled()
Get the constant Graph::IVariableNodeTarget container referencing the input variables. This method returns a constant pointer to the node's Graph::IVariableNodeTarget container, which allows to query references to the input variables.
Murl.Graph.IGenericNodeTarget.GraphIVariable GetVariableInputOperandNodeTarget()
Get the constant Graph::IVariableNodeTarget container referencing the output variables. This method returns a constant pointer to the node's Graph::IVariableNodeTarget container, which allows to query references to the output variables.
Murl.Graph.IGenericNodeTarget.GraphIVariable GetVariableOutputOperandNodeTarget()
Set a constant floating-point input value at a given index. See class description.
Boolean SetConstantInputOperand(Integer index, Number value)
index | The input operand index. |
value | The value to apply. |
Set a constant string input value at a given index. See class description.
Boolean SetConstantInputOperand(Integer index, String value)
index | The input operand index. |
value | The value to apply. |
Set a constant boolean input value at a given index. See class description.
Boolean SetConstantInputOperand(Integer index, Boolean value)
index | The input operand index. |
value | The value to apply. |
Get a constant floating-point input value at a given index. See class description.
Boolean, Number GetConstantInputOperand(Integer index, Number value)
index | The input operand index. |
value | The return value to retrieve. |
Get a constant boolean input value at a given index. See class description.
Boolean, Boolean GetConstantInputOperand(Integer index, Boolean value)
index | The input operand index. |
value | The return value to retrieve. |
Set a constant floating-point output value at a given index. See class description.
Boolean SetConstantOutputOperand(Integer index, Number value)
index | The output operand index. |
value | The value to apply. |
Set a constant string output value at a given index. See class description.
Boolean SetConstantOutputOperand(Integer index, String value)
index | The output operand index. |
value | The value to apply. |
Set a constant boolean output value at a given index. See class description.
Boolean SetConstantOutputOperand(Integer index, Boolean value)
index | The output operand index. |
value | The value to apply. |
Get a constant floating-point output value at a given index. See class description.
Boolean, Number GetConstantOutputOperand(Integer index, Number value)
index | The output operand index. |
value | The return value to retrieve. |
Get a constant boolean output value at a given index. See class description.
Boolean, Boolean GetConstantOutputOperand(Integer index, Boolean value)
index | The output operand index. |
value | The return value to retrieve. |
Try to get the result as a floating-point value.
Boolean, Number GetValue(Number value)
value | A reference to a floating-point variable to receive the result. |
Try to get the result as a boolean value.
Boolean, Boolean GetValue(Boolean value)
value | A reference to a boolean variable to receive the result. |