Animator Foreign State Rule Class. More...
#include <deAnimatorRuleForeignState.h>
Public Member Functions | |
Constructors and Destructors | |
| deAnimatorRuleForeignState () | |
| Creates a new animator rule. | |
| virtual | ~deAnimatorRuleForeignState () |
| Cleans up the animator rule. | |
Management | |
| const char * | GetForeignBone () const |
| Retrieves the name of the foreign bone. | |
| void | SetForeignBone (const char *boneName) |
| Sets the name of the foreign bone. | |
| float | GetScalePosition () const |
| Retrieves the position scale factor. | |
| void | SetScalePosition (float scalePosition) |
| Sets the position scale factor. | |
| float | GetScaleOrientation () const |
| Retrieves the orientation scale factor. | |
| void | SetScaleOrientation (float scaleOrientation) |
| Sets the orientation scale factor. | |
| float | GetScaleSize () const |
| Retrieves the size scale factor. | |
| void | SetScaleSize (float scaleSize) |
| Sets the size scale factor. | |
| bool | GetEnablePosition () const |
| Determines if position manipulation is enabled. | |
| void | SetEnablePosition (bool enabled) |
| Sets if position manipulation is enabled. | |
| bool | GetEnableOrientation () const |
| Determines if orientation manipulation is enabled. | |
| void | SetEnableOrientation (bool enabled) |
| Sets if orientation manipulation is enabled. | |
| bool | GetEnableSize () const |
| Determines if size manipulation is enabled. | |
| void | SetEnableSize (bool enabled) |
| Sets if size manipulation is enabled. | |
| deAnimatorControllerTarget & | GetTargetPosition () |
| Retrieves the scale position target. | |
| deAnimatorControllerTarget & | GetTargetOrientation () |
| Retrieves the scale orientation target. | |
| deAnimatorControllerTarget & | GetTargetSize () |
| Retrieves the scale size target. | |
Visiting | |
| virtual void | Visit (deAnimatorRuleVisitor *visitor) |
| Visits the rule. | |
Detailed Description
Animator Foreign State Rule Class.
The foreign state rule applies the state of another bone to the affected bones ( usually one ) after applying a scaling factor. This way bones can be animated in dependence of other bones. This is useful for character attachments where animation data does not exists for new bones added by the attachment yet the right bone state can be calculated from existing animation bones. An example would be a shoulder pad which is oriented half way between the two arm/shoulder bones in proximity of the pad bone. For each scaling factor a controller link can be provided.
- Version:
- 1.0
- Date:
- 2008
Constructor & Destructor Documentation
| deAnimatorRuleForeignState::deAnimatorRuleForeignState | ( | ) |
Creates a new animator rule.
| virtual deAnimatorRuleForeignState::~deAnimatorRuleForeignState | ( | ) | [virtual] |
Cleans up the animator rule.
Member Function Documentation
| bool deAnimatorRuleForeignState::GetEnableOrientation | ( | ) | const [inline] |
Determines if orientation manipulation is enabled.
| bool deAnimatorRuleForeignState::GetEnablePosition | ( | ) | const [inline] |
Determines if position manipulation is enabled.
| bool deAnimatorRuleForeignState::GetEnableSize | ( | ) | const [inline] |
Determines if size manipulation is enabled.
| const char* deAnimatorRuleForeignState::GetForeignBone | ( | ) | const [inline] |
Retrieves the name of the foreign bone.
| float deAnimatorRuleForeignState::GetScaleOrientation | ( | ) | const [inline] |
Retrieves the orientation scale factor.
| float deAnimatorRuleForeignState::GetScalePosition | ( | ) | const [inline] |
Retrieves the position scale factor.
| float deAnimatorRuleForeignState::GetScaleSize | ( | ) | const [inline] |
Retrieves the size scale factor.
| deAnimatorControllerTarget& deAnimatorRuleForeignState::GetTargetOrientation | ( | ) | [inline] |
Retrieves the scale orientation target.
| deAnimatorControllerTarget& deAnimatorRuleForeignState::GetTargetPosition | ( | ) | [inline] |
Retrieves the scale position target.
| deAnimatorControllerTarget& deAnimatorRuleForeignState::GetTargetSize | ( | ) | [inline] |
Retrieves the scale size target.
| void deAnimatorRuleForeignState::SetEnableOrientation | ( | bool | enabled ) |
Sets if orientation manipulation is enabled.
| void deAnimatorRuleForeignState::SetEnablePosition | ( | bool | enabled ) |
Sets if position manipulation is enabled.
| void deAnimatorRuleForeignState::SetEnableSize | ( | bool | enabled ) |
Sets if size manipulation is enabled.
| void deAnimatorRuleForeignState::SetForeignBone | ( | const char * | boneName ) |
Sets the name of the foreign bone.
| void deAnimatorRuleForeignState::SetScaleOrientation | ( | float | scaleOrientation ) |
Sets the orientation scale factor.
| void deAnimatorRuleForeignState::SetScalePosition | ( | float | scalePosition ) |
Sets the position scale factor.
| void deAnimatorRuleForeignState::SetScaleSize | ( | float | scaleSize ) |
Sets the size scale factor.
| virtual void deAnimatorRuleForeignState::Visit | ( | deAnimatorRuleVisitor * | visitor ) | [virtual] |
Visits the rule.
Reimplemented from deAnimatorRule.
The documentation for this class was generated from the following file:
