|
Crazy Eddies GUI System 0.7.6
|
Defines an 'affector' class. More...
Collaboration diagram for CEGUI::Affector:Public Types | |
| enum | ApplicationMethod { AM_Absolute, AM_Relative, AM_RelativeMultiply } |
| enumerates the possible methods of application More... | |
Public Member Functions | |
| Affector (Animation *parent) | |
| ~Affector (void) | |
| destructor, this destroys all key frames defined inside this affector | |
| void | setApplicationMethod (ApplicationMethod method) |
| Sets the application method. | |
| ApplicationMethod | getApplicationMethod () const |
| Retrieves current application method. | |
| void | setTargetProperty (const String &target) |
| Sets the property that will be affected. | |
| const String & | getTargetProperty () const |
| Gets the property that will be affected. | |
| void | setInterpolator (Interpolator *interpolator) |
| Sets interpolator of this Affector. | |
| void | setInterpolator (const String &name) |
| Sets interpolator of this Affector. | |
| Interpolator * | getInterpolator () const |
| Retrieves currently used interpolator of this Affector. | |
| KeyFrame * | createKeyFrame (float position) |
| Creates a KeyFrame at given position. | |
| KeyFrame * | createKeyFrame (float position, const String &value, KeyFrame::Progression progression=KeyFrame::P_Linear, const String &sourceProperty="") |
| Creates a KeyFrame at given position. | |
| void | destroyKeyFrame (KeyFrame *keyframe) |
| Destroys given keyframe. | |
| KeyFrame * | getKeyFrameAtPosition (float position) const |
| Retrieves a KeyFrame at given position. | |
| KeyFrame * | getKeyFrameAtIdx (size_t index) const |
| Retrieves a KeyFrame with given index. | |
| size_t | getNumKeyFrames () const |
| Returns number of key frames defined in this affector. | |
| void | moveKeyFrameToPosition (KeyFrame *keyframe, float newPosition) |
| Moves given key frame to given new position. | |
| void | moveKeyFrameToPosition (float oldPosition, float newPosition) |
| Moves key frame at given old position to given new position. | |
| void | savePropertyValues (AnimationInstance *instance) |
| Internal method, causes all properties that are used by this affector and it's keyframes to be saved. | |
| void | apply (AnimationInstance *instance) |
| Applies this Affector's definition with parameters from given Animation Instance. | |
Defines an 'affector' class.
Affector is part of Animation definition. It is set to affect one Property using one Interpolator.
enumerates the possible methods of application
| CEGUI::Affector::Affector | ( | Animation * | parent | ) |
internal constructor, please construct Affectors via Animation::createAffector only
| void CEGUI::Affector::apply | ( | AnimationInstance * | instance | ) |
Applies this Affector's definition with parameters from given Animation Instance.
| KeyFrame* CEGUI::Affector::createKeyFrame | ( | float | position, |
| const String & | value, | ||
| KeyFrame::Progression | progression = KeyFrame::P_Linear, |
||
| const String & | sourceProperty = "" |
||
| ) |
| ApplicationMethod CEGUI::Affector::getApplicationMethod | ( | ) | const |
Retrieves current application method.
| void CEGUI::Affector::savePropertyValues | ( | AnimationInstance * | instance | ) |
Internal method, causes all properties that are used by this affector and it's keyframes to be saved.
| void CEGUI::Affector::setApplicationMethod | ( | ApplicationMethod | method | ) |
Sets the application method.
| void CEGUI::Affector::setInterpolator | ( | const String & | name | ) |
Sets interpolator of this Affector.
| void CEGUI::Affector::setInterpolator | ( | Interpolator * | interpolator | ) |
Sets interpolator of this Affector.
1.7.4