Dragengine.StateMachineSystem.SMConditionParameterTableFloat Class Reference
State machine condition evaluating a floating point parameter table entry. More...
Inheritance diagram for Dragengine.StateMachineSystem.SMConditionParameterTableFloat:
Classes | |
| enum | Operator |
| Compare operator. More... | |
Public Member Functions | |
| bool | evaluateCondition (SMContext context, Dictionary parameters) |
| Evaluate condition. More... | |
| float | getCompareValue () |
| Default compare against value. More... | |
| float | getDefaultValue () |
| Default value if entry to compare is not null. More... | |
| ParameterTableEntry | getEntry () |
| Parameter table entry to compare. More... | |
| ParameterTableEntry | getEntryCompareValue () |
| Parameter table entry to compare against. More... | |
| Operator | getOperator () |
| Compare operator from eOperators. More... | |
| String | getParameterNameCompareValue () |
| Use named parameter as source of compare value if not null. More... | |
| float | getThreshold () |
| Threshold value. More... | |
| SMConditionParameterTableFloat | negated () |
| Create condition testing the exact opposite. More... | |
| SMConditionParameterTableFloat | new (ParameterTableEntry entry, float defaultValue, Operator operator, float compareValue) |
| Create condition. More... | |
| SMConditionParameterTableFloat | new (ParameterTableEntry entry, float defaultValue, Operator operator, float compareValue, String parameterNameCompareValue) |
| Create condition. More... | |
| SMConditionParameterTableFloat | new (ParameterTableEntry entry, float defaultValue, Operator operator, ParameterTableEntry entryCompareValue, float compareValue, String parameterNameCompareValue) |
| Create condition. More... | |
| void | setCompareValue (float compareValue) |
| Set default compare against value. More... | |
| void | setDefaultValue (float defaultValue) |
| Set default value if entry to compare is not null. More... | |
| void | setEntry (ParameterTableEntry entry) |
| Set parameter table entry to compare. More... | |
| void | setEntryCompareValue (ParameterTableEntry entry) |
| Set parameter table entry to compare against. More... | |
| void | setOperator (Operator operator) |
| Set compare operator from eOperators. More... | |
| void | setParameterNameCompareValue (String name) |
| Use named parameter as source of compare value if not null. More... | |
| void | setThreshold (float threshold) |
| Set threshold value. More... | |
Detailed Description
State machine condition evaluating a floating point parameter table entry.
Compares the value of a parameter table entry against a static value or another parameter table entry. A threshold is used for the compare operations defaulting to 0.0001.
Member Function Documentation
◆ evaluateCondition()
| bool Dragengine.StateMachineSystem.SMConditionParameterTableFloat.evaluateCondition | ( | SMContext | context, |
| Dictionary | parameters | ||
| ) |
Evaluate condition.
- Parameters
-
parameters Dictionary with parameters of type String key and String value. Do not change the content of the dictionary as it is shared.
Implements Dragengine.StateMachineSystem.SMCondition.
◆ getCompareValue()
| float Dragengine.StateMachineSystem.SMConditionParameterTableFloat.getCompareValue | ( | ) |
Default compare against value.
◆ getDefaultValue()
| float Dragengine.StateMachineSystem.SMConditionParameterTableFloat.getDefaultValue | ( | ) |
Default value if entry to compare is not null.
◆ getEntry()
| ParameterTableEntry Dragengine.StateMachineSystem.SMConditionParameterTableFloat.getEntry | ( | ) |
Parameter table entry to compare.
◆ getEntryCompareValue()
| ParameterTableEntry Dragengine.StateMachineSystem.SMConditionParameterTableFloat.getEntryCompareValue | ( | ) |
Parameter table entry to compare against.
◆ getOperator()
| Operator Dragengine.StateMachineSystem.SMConditionParameterTableFloat.getOperator | ( | ) |
Compare operator from eOperators.
◆ getParameterNameCompareValue()
| String Dragengine.StateMachineSystem.SMConditionParameterTableFloat.getParameterNameCompareValue | ( | ) |
Use named parameter as source of compare value if not null.
◆ getThreshold()
| float Dragengine.StateMachineSystem.SMConditionParameterTableFloat.getThreshold | ( | ) |
Threshold value.
◆ negated()
| SMConditionParameterTableFloat Dragengine.StateMachineSystem.SMConditionParameterTableFloat.negated | ( | ) |
Create condition testing the exact opposite.
◆ new() [1/3]
| SMConditionParameterTableFloat Dragengine.StateMachineSystem.SMConditionParameterTableFloat.new | ( | ParameterTableEntry | entry, |
| float | defaultValue, | ||
| Operator | operator, | ||
| float | compareValue | ||
| ) |
Create condition.
◆ new() [2/3]
| SMConditionParameterTableFloat Dragengine.StateMachineSystem.SMConditionParameterTableFloat.new | ( | ParameterTableEntry | entry, |
| float | defaultValue, | ||
| Operator | operator, | ||
| float | compareValue, | ||
| String | parameterNameCompareValue | ||
| ) |
Create condition.
◆ new() [3/3]
| SMConditionParameterTableFloat Dragengine.StateMachineSystem.SMConditionParameterTableFloat.new | ( | ParameterTableEntry | entry, |
| float | defaultValue, | ||
| Operator | operator, | ||
| ParameterTableEntry | entryCompareValue, | ||
| float | compareValue, | ||
| String | parameterNameCompareValue | ||
| ) |
Create condition.
◆ setCompareValue()
| void Dragengine.StateMachineSystem.SMConditionParameterTableFloat.setCompareValue | ( | float | compareValue | ) |
Set default compare against value.
◆ setDefaultValue()
| void Dragengine.StateMachineSystem.SMConditionParameterTableFloat.setDefaultValue | ( | float | defaultValue | ) |
Set default value if entry to compare is not null.
◆ setEntry()
| void Dragengine.StateMachineSystem.SMConditionParameterTableFloat.setEntry | ( | ParameterTableEntry | entry | ) |
Set parameter table entry to compare.
◆ setEntryCompareValue()
| void Dragengine.StateMachineSystem.SMConditionParameterTableFloat.setEntryCompareValue | ( | ParameterTableEntry | entry | ) |
Set parameter table entry to compare against.
◆ setOperator()
| void Dragengine.StateMachineSystem.SMConditionParameterTableFloat.setOperator | ( | Operator | operator | ) |
Set compare operator from eOperators.
◆ setParameterNameCompareValue()
| void Dragengine.StateMachineSystem.SMConditionParameterTableFloat.setParameterNameCompareValue | ( | String | name | ) |
Use named parameter as source of compare value if not null.
◆ setThreshold()
| void Dragengine.StateMachineSystem.SMConditionParameterTableFloat.setThreshold | ( | float | threshold | ) |
Set threshold value.
The documentation for this class was generated from the following file:
