Documentation
Urho3D::ValueAnimationInfo Class Reference
Base class for a value animation instance, which includes animation runtime information and updates the target object's value automatically. More...
#include <ValueAnimationInfo.h>
Inheritance diagram for Urho3D::ValueAnimationInfo:
Collaboration diagram for Urho3D::ValueAnimationInfo:
Public Member Functions | |
| ValueAnimationInfo (ValueAnimation *animation, WrapMode wrapMode, float speed) | |
| Construct without target object. | |
| ValueAnimationInfo (Object *target, ValueAnimation *animation, WrapMode wrapMode, float speed) | |
| Construct with target object. | |
| ValueAnimationInfo (const ValueAnimationInfo &other) | |
| Copy construct. | |
| ~ValueAnimationInfo () | |
| Destruct. | |
| bool | Update (float timeStep) |
| Advance time position and apply. Return true when the animation is finished. No-op when the target object is not defined. | |
| bool | SetTime (float time) |
| Set time position and apply. Return true when the animation is finished. No-op when the target object is not defined. | |
| void | SetWrapMode (WrapMode wrapMode) |
| Set wrap mode. | |
| void | SetSpeed (float speed) |
| Set speed. | |
| Object * | GetTarget () const |
| Return target object. | |
| ValueAnimation * | GetAnimation () const |
| Return animation. | |
| WrapMode | GetWrapMode () const |
| Return wrap mode. | |
| float | GetTime () const |
| Return time position. | |
| float | GetSpeed () const |
| Return speed. | |
 Public Member Functions inherited from Urho3D::RefCounted | |
| RefCounted () | |
| Construct. Allocate the reference count structure and set an initial self weak reference. | |
| virtual | ~RefCounted () |
| Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist. | |
| void | AddRef () |
| Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. | |
| void | ReleaseRef () |
| Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. | |
| int | Refs () const |
| Return reference count. | |
| int | WeakRefs () const |
| Return weak reference count. | |
| RefCount * | RefCountPtr () |
| Return pointer to the reference count structure. | |
Protected Member Functions | |
| virtual void | ApplyValue (const Variant &newValue) |
| Apply new animation value to the target object. Called by Update(). | |
| float | CalculateScaledTime (float currentTime, bool &finished) const |
| Calculate scaled time. | |
| void | GetEventFrames (float beginTime, float endTime, PODVector< const VAnimEventFrame * > &eventFrames) |
| Return event frames. | |
Protected Attributes | |
| WeakPtr< Object > | target_ |
| Target object. | |
| SharedPtr< ValueAnimation > | animation_ |
| Attribute animation. | |
| WrapMode | wrapMode_ |
| Wrap mode. | |
| float | speed_ |
| Animation speed. | |
| float | currentTime_ |
| Current time. | |
| float | lastScaledTime_ |
| Last scaled time. | |
Detailed Description
Base class for a value animation instance, which includes animation runtime information and updates the target object's value automatically.
The documentation for this class was generated from the following files:
- /home/travis/build/urho3d/Urho3D/Source/Urho3D/Scene/ValueAnimationInfo.h
- /home/travis/build/urho3d/Urho3D/Source/Urho3D/Scene/ValueAnimationInfo.cpp