Animator Controller Class. More...
#include <deAnimatorController.h>
Public Member Functions | |
Constructors and Destructors | |
| deAnimatorController () | |
| Creates a new animator controller with range 0 to 1 and the value 0. | |
| ~deAnimatorController () | |
| Cleans up the animator. | |
Management | |
| float | GetMinimumValue () const |
| Retrieves the minimum value. | |
| float | GetMaximumValue () const |
| Retrieves the maximum value. | |
| void | SetValueRange (float minValue, float maxValue) |
| Sets the value range. | |
| float | GetCurrentValue () const |
| Retrieves the current value. | |
| void | SetCurrentValue (float value) |
| Sets the current value. | |
| void | IncrementCurrentValue (float incrementBy) |
| Increments the current value. | |
| bool | GetFrozen () const |
| Determines if the controller is frozen. | |
| void | SetFrozen (bool frozen) |
| Sets if the controller is frozen. | |
| bool | GetClamp () const |
| Determines if values passed the range are clamped or wrapped around. | |
| void | SetClamp (bool clamp) |
| Sets if values passed the range are clamped or wrapped around. | |
| const decVector & | GetVector () const |
| Retrieves the controller vector. | |
| void | SetVector (const decVector &vector) |
| Sets the controller vector. | |
Animator Controller Class.
Animator controllers provide the user with control over how the individual rules of an animator produce an animation. Controllers are written in a way that you can use them without having to do scaling or transformation on your own. You can provide a minimum and maximum value matching your setup. The controller takes care of transforming the current value into the proper 0 to 1 range required for rules to work with. The current value is set by the user and is clamped to the range specified before. The real value is in the range 0 to 1 and is used by the rules. The real value can only be read. Furthermore a controller can be frozen. If a controller is frozen no values can be changed. This is useful to prevent a controller from changing without having to change all code path to account for the frozen state. In addition a controller can also contain a matrix instead of a ranged value. This can be useful for certain specialized rules which need a position or even orientations to do their work.
| deAnimatorController::deAnimatorController | ( | ) |
Creates a new animator controller with range 0 to 1 and the value 0.
| deAnimatorController::~deAnimatorController | ( | ) |
Cleans up the animator.
| bool deAnimatorController::GetClamp | ( | ) | const [inline] |
Determines if values passed the range are clamped or wrapped around.
| float deAnimatorController::GetCurrentValue | ( | ) | const [inline] |
Retrieves the current value.
| bool deAnimatorController::GetFrozen | ( | ) | const [inline] |
Determines if the controller is frozen.
| float deAnimatorController::GetMaximumValue | ( | ) | const [inline] |
Retrieves the maximum value.
| float deAnimatorController::GetMinimumValue | ( | ) | const [inline] |
Retrieves the minimum value.
| const decVector& deAnimatorController::GetVector | ( | ) | const [inline] |
Retrieves the controller vector.
| void deAnimatorController::IncrementCurrentValue | ( | float | incrementBy ) |
Increments the current value.
| void deAnimatorController::SetClamp | ( | bool | clamp ) |
Sets if values passed the range are clamped or wrapped around.
| void deAnimatorController::SetCurrentValue | ( | float | value ) |
Sets the current value.
| void deAnimatorController::SetFrozen | ( | bool | frozen ) |
Sets if the controller is frozen.
| void deAnimatorController::SetValueRange | ( | float | minValue, |
| float | maxValue | ||
| ) |
Sets the value range.
| void deAnimatorController::SetVector | ( | const decVector & | vector ) |
Sets the controller vector.
1.7.2