ADRule Class Referenceabstract
Inheritance diagram for ADRule:
Public Member Functions | |
| void | addBone (String bone) |
| void | addTargetLink (ADRuleTargetLink targetLink) |
| AnimatorRule | buildRule (Animator animator) |
| void | debug (Console console) |
| void | forEachTarget (Block ablock) |
| Visit targets with a block. More... | |
| float | getBlendFactor () |
| int | getBlendMode () |
| String | getBoneAt (int index) |
| bool | getEnabled () |
| String | getName () |
| ADRuleTargetLink | getTargetLinkAt (int index) |
| int | getTargetLinkCount () |
| ADRule | new () |
| void | setBlendFactor (float factor) |
| void | setBlendMode (int mode) |
| void | setEnabled (bool enabled) |
| void | setName (String name) |
Protected Member Functions | |
| String | debugCommon (String type) |
Detailed Description
Definition of an animator rule. Once defined a rule can be added to an animator using the stored definition. This is the base rule class with the properties shared amongst all rule types.
- Version
- 1.0
- Date
- 2015
Member Function Documentation
◆ addBone()
| void addBone | ( | String | bone | ) |
Adds a bone.
◆ addTargetLink()
| void addTargetLink | ( | ADRuleTargetLink | targetLink | ) |
Adds a target link.
◆ buildRule()
| AnimatorRule buildRule | ( | Animator | animator | ) |
Build engine animator rule using the stored definition.
◆ debug()
| void debug | ( | Console | console | ) |
◆ debugCommon()
|
protected |
◆ forEachTarget()
| void forEachTarget | ( | Block | ablock | ) |
Visit targets with a block.
◆ getBlendFactor()
| float getBlendFactor | ( | ) |
Retrieves the blend factor.
◆ getBlendMode()
| int getBlendMode | ( | ) |
Retrieves the blend mode.
◆ getBoneAt()
| String getBoneAt | ( | int | index | ) |
Retrieves the bone at the given index.
◆ getEnabled()
| bool getEnabled | ( | ) |
Determines if the rule is enabled.
◆ getName()
| String getName | ( | ) |
Retrieves the name of the rule.
◆ getTargetLinkAt()
| ADRuleTargetLink getTargetLinkAt | ( | int | index | ) |
Retrieves the target link at the given index.
◆ getTargetLinkCount()
| int getTargetLinkCount | ( | ) |
Retrieves the number of target links.
◆ new()
| ADRule new | ( | ) |
Creates a new animation rule definition.
◆ setBlendFactor()
| void setBlendFactor | ( | float | factor | ) |
Sets the blend factor.
◆ setBlendMode()
| void setBlendMode | ( | int | mode | ) |
Sets the blend mode.
◆ setEnabled()
| void setEnabled | ( | bool | enabled | ) |
Sets if the rule is enabled.
◆ setName()
| void setName | ( | String | name | ) |
Sets the name of the rule.
The documentation for this class was generated from the following file:
