Inheritance diagram for DzExpression:
Properties | |
Boolean | active |
Methods | |
DzError | addInput (DzExpressionInput input) |
DzExpressionInput | findInput (String label) |
DzExpressionInput | findInput (DzNumericProperty prop) |
String | getExpression () |
DzExpressionInput | getInput (Number which) |
String | getInverseExpression () |
Number | getNumInputs () |
void | removeAllInputs () |
DzError | removeInput (DzExpressionInput input) |
DzError | removeInput (Number which) |
void | setExpression (String script, String inverseScript="") |
Constructors | |
DzExpression () | |
Signals | |
void | propertyDeleted (DzProperty prop) |
Signature: "propertyDeleted(DzProperty*)" |
This numeric controller implements an expression that is evaluated at runtime which can use the current value of the property and zero or more inputs from other properties to calculate the final value of the property using a DAZ Script.
DzExpression::DzExpression | ( | ) |
Default constructor.
DzError DzExpression::addInput | ( | DzExpressionInput | input | ) |
Adds the input to this expression.
input | The new input to add to the expression. |
DzExpressionInput DzExpression::findInput | ( | String | label | ) |
which The index of the input to return.
DzExpressionInput DzExpression::findInput | ( | DzNumericProperty | prop | ) |
which The index of the input to return.
String DzExpression::getExpression | ( | ) |
DzExpressionInput DzExpression::getInput | ( | Number | which | ) |
which The index of the input to return.
String DzExpression::getInverseExpression | ( | ) |
Number DzExpression::getNumInputs | ( | ) |
void DzExpression::propertyDeleted | ( | DzProperty | prop | ) | [signal] |
Signature: "propertyDeleted(DzProperty*)"
Emitted when a source property or current property is deleted.
void DzExpression::removeAllInputs | ( | ) |
Clears the list of inputs for the expression.
DzError DzExpression::removeInput | ( | DzExpressionInput | input | ) |
Removes the given input from the expression.
input | The input to remove from the expression. |
Removes the input at the given index from the expression.
which | The index of the input to remove from the expression. |
Sets the DAZ Script that is evaluated to apply this expression. An inverse script should be provided if the expression is invertible. Providing an inverse expression ensures that keys on the controlled property are correctly set when the user modifies the controlled property from the interface. If the expression completely ignores the currently keyed value of the property it is controlling, an inverse function is not necessary, otherwise, if an inverse function is not provided, modifying the controlled property from the interface will have unpredictable results.
script | The text of the DAZ Script to evaluate for this expression. | |
inverseScript | The text of the DAZ Script to evaluate when applying this expression in inverse. If empty, the expression will do nothing when applied in inverse. |
This property determines whether or not the controller is applied.