Animator Class. More...
#include <deAnimator.h>
Public Member Functions | |
Constructors and Destructors | |
| deAnimator (deAnimatorManager *manager) | |
| Creates a new animator with the given resource manager. | |
| ~deAnimator () | |
| Cleans up the animator. | |
Management | |
| void | Apply () |
| Applies the state of the animator to the bound component. | |
| deComponent * | GetComponent () const |
| Retrieves the set component or NULL if none is set. | |
| void | SetComponent (deComponent *component) |
| Sets the bound component or NULL to unset it. | |
| float | GetSourceFactor () const |
| Retrieves the source blend factor. | |
| void | SetSourceFactor (float factor) |
| Sets the source blend factor. | |
| float | GetDestinationFactor () const |
| Retrieves the destination blend factor. | |
| void | SetDestinationFactor (float factor) |
| Sets the destination blend factor. | |
| deAnimation * | GetAnimation () const |
| Retrieves the set animation or NULL if none is set. | |
| void | SetAnimation (deAnimation *animation) |
| Sets the animation or NULL to unset it. | |
Controller Management | |
| int | GetControllerCount () const |
| Retrieves the count of controllers. | |
| deAnimatorController * | GetControllerAt (int index) const |
| Retrieves the controller at the given index. | |
| int | IndexOfController (deAnimatorController *controller) const |
| Retrieves the index of the given controller or -1 if not found. | |
| bool | HasController (deAnimatorController *controller) const |
| Determines if the given controller exists. | |
| void | AddController (deAnimatorController *controller) |
| Adds a controller. | |
| void | RemoveController (deAnimatorController *controller) |
| Removes the given controller. | |
| void | RemoveAllControllers () |
| Removes all controllers. | |
| void | NotifyControllerChangedAt (int index) |
| Notifies that the controller at the given index changed. | |
Link Management | |
| int | GetLinkCount () const |
| Retrieves the count of links. | |
| deAnimatorLink * | GetLinkAt (int index) const |
| Retrieves the link at the given index. | |
| int | IndexOfLink (deAnimatorLink *link) const |
| Retrieves the index of the given link or -1 if not found. | |
| bool | HasLink (deAnimatorLink *link) const |
| Determines if the given link exists. | |
| void | AddLink (deAnimatorLink *link) |
| Adds a link. | |
| void | RemoveLink (deAnimatorLink *link) |
| Removes the given link. | |
| void | RemoveAllLinks () |
| Removes all links. | |
| void | NotifyLinkChangedAt (int index) |
| Notifies that the link at the given index changed. | |
Rule Management | |
| int | GetRuleCount () const |
| Retrieves the count of rules. | |
| deAnimatorRule * | GetRuleAt (int index) const |
| Retrieves the rule at the given index. | |
| int | IndexOfRule (deAnimatorRule *rule) const |
| Retrieves the index of the given rule or -1 if not found. | |
| bool | HasRule (deAnimatorRule *rule) const |
| Determines if the given rule exists. | |
| void | AddRule (deAnimatorRule *rule) |
| Adds a rule. | |
| void | RemoveRule (deAnimatorRule *rule) |
| Removes the given rule. | |
| void | RemoveAllRules () |
| Removes all rules. | |
| void | NotifyRuleChangedAt (int index) |
| Notifies that the rule at the given index changed. | |
System Peers | |
| deBaseAnimatorAnimator * | GetAnimatorAnimator () const |
| Retrieves the animator system peer object. | |
| void | SetAnimatorAnimator (deBaseAnimatorAnimator *aniAnimator) |
| Sets the animator system peer object. | |
Detailed Description
Animator Class.
Animators are objects capable of producing an animation state for a component. Every animator composes of a set of rules and controllers which indicate how the final animation state is produced from a set animation. Some rules can also produce animations without the help of the animation but external informations like for example where another object is located or a reference state captured before. Controllers provide the values required by rules and one controller can be attached to more than one rule. Every animator is coupled to a component. More than one animator can act on one component one after the other if complex animations are required that can not be done using one single animator. Animators can not be used at the same time as a collider component if the rig of the component is driven by physics. Animators can though be used if the rig is kinematic. The animator object has peers into the animator module. This way the creation of animations can be accelerated if possible.
- Version:
- 1.0
- Date:
- 2008
Constructor & Destructor Documentation
| deAnimator::deAnimator | ( | deAnimatorManager * | manager ) |
Creates a new animator with the given resource manager.
| deAnimator::~deAnimator | ( | ) |
Cleans up the animator.
Member Function Documentation
| void deAnimator::AddController | ( | deAnimatorController * | controller ) |
Adds a controller.
| void deAnimator::AddLink | ( | deAnimatorLink * | link ) |
Adds a link.
| void deAnimator::AddRule | ( | deAnimatorRule * | rule ) |
Adds a rule.
| void deAnimator::Apply | ( | ) |
Applies the state of the animator to the bound component.
| deAnimation* deAnimator::GetAnimation | ( | ) | const [inline] |
Retrieves the set animation or NULL if none is set.
| deBaseAnimatorAnimator* deAnimator::GetAnimatorAnimator | ( | ) | const [inline] |
Retrieves the animator system peer object.
| deComponent* deAnimator::GetComponent | ( | ) | const [inline] |
Retrieves the set component or NULL if none is set.
| deAnimatorController* deAnimator::GetControllerAt | ( | int | index ) | const |
Retrieves the controller at the given index.
| int deAnimator::GetControllerCount | ( | ) | const [inline] |
Retrieves the count of controllers.
| float deAnimator::GetDestinationFactor | ( | ) | const [inline] |
Retrieves the destination blend factor.
| deAnimatorLink* deAnimator::GetLinkAt | ( | int | index ) | const |
Retrieves the link at the given index.
| int deAnimator::GetLinkCount | ( | ) | const [inline] |
Retrieves the count of links.
| deAnimatorRule* deAnimator::GetRuleAt | ( | int | index ) | const |
Retrieves the rule at the given index.
| int deAnimator::GetRuleCount | ( | ) | const [inline] |
Retrieves the count of rules.
| float deAnimator::GetSourceFactor | ( | ) | const [inline] |
Retrieves the source blend factor.
| bool deAnimator::HasController | ( | deAnimatorController * | controller ) | const |
Determines if the given controller exists.
| bool deAnimator::HasLink | ( | deAnimatorLink * | link ) | const |
Determines if the given link exists.
| bool deAnimator::HasRule | ( | deAnimatorRule * | rule ) | const |
Determines if the given rule exists.
| int deAnimator::IndexOfController | ( | deAnimatorController * | controller ) | const |
Retrieves the index of the given controller or -1 if not found.
| int deAnimator::IndexOfLink | ( | deAnimatorLink * | link ) | const |
Retrieves the index of the given link or -1 if not found.
| int deAnimator::IndexOfRule | ( | deAnimatorRule * | rule ) | const |
Retrieves the index of the given rule or -1 if not found.
| void deAnimator::NotifyControllerChangedAt | ( | int | index ) |
Notifies that the controller at the given index changed.
| void deAnimator::NotifyLinkChangedAt | ( | int | index ) |
Notifies that the link at the given index changed.
| void deAnimator::NotifyRuleChangedAt | ( | int | index ) |
Notifies that the rule at the given index changed.
| void deAnimator::RemoveAllControllers | ( | ) |
Removes all controllers.
| void deAnimator::RemoveAllLinks | ( | ) |
Removes all links.
| void deAnimator::RemoveAllRules | ( | ) |
Removes all rules.
| void deAnimator::RemoveController | ( | deAnimatorController * | controller ) |
Removes the given controller.
| void deAnimator::RemoveLink | ( | deAnimatorLink * | link ) |
Removes the given link.
| void deAnimator::RemoveRule | ( | deAnimatorRule * | rule ) |
Removes the given rule.
| void deAnimator::SetAnimation | ( | deAnimation * | animation ) |
Sets the animation or NULL to unset it.
| void deAnimator::SetAnimatorAnimator | ( | deBaseAnimatorAnimator * | aniAnimator ) |
Sets the animator system peer object.
| void deAnimator::SetComponent | ( | deComponent * | component ) |
Sets the bound component or NULL to unset it.
| void deAnimator::SetDestinationFactor | ( | float | factor ) |
Sets the destination blend factor.
| void deAnimator::SetSourceFactor | ( | float | factor ) |
Sets the source blend factor.
The documentation for this class was generated from the following file:
