The DummyNoAnimationInstance is a special animation instance which can be used with animation players as an alternative way to stop animation. More...
#include <jmAnimationCommon.h>
Inherits AnimationInstance.
Public Member Functions | |
| int | Update (int msTimePoint, int _flags) override |
| Update the animation state for the given msTimePoint. More... | |
| void | UpdateAnimatedSprites (bool _resetAnimatedProperties) override |
| Update the animated sprites. More... | |
 Public Member Functions inherited from AnimationInstance | |
| AnimationKind | GetKind () |
| Returns the kind of this animation. More... | |
| Animation * | GetAnimation () |
| Returns the animation object of this animation instance. More... | |
| AnimationBaseParameters & | GetBaseParameters () |
| Returns the base animation parameters of this animation instance. More... | |
| void | SetCompleteLoops (bool _completeLoops) |
| Set a parameter which indicates that the animation should finish its current loop before ending. More... | |
| bool | GetCompleteLoops () |
| Returns the completeLoops parameter of this animation instance. More... | |
| void | SetSpeedFactor (float _fSpeed) |
| Set the speed factor of animation playback. The value 1.0 is the default speed; higher values means faster animation and lower values means slower animation. More... | |
| float | GetSpeedFactor () |
| Returns the speed factor of this animation instance. More... | |
| void | SetStartPlayTimeOffset (int _startPlayTimeOffset) |
| Set the animation starting time point offset in milliseconds. More... | |
| int | GetStartPlayTimeOffset () |
| Returns the animation starting time point offset of this animation instance. More... | |
Detailed Description
The DummyNoAnimationInstance is a special animation instance which can be used with animation players as an alternative way to stop animation.
Member Function Documentation
◆ Update()
|
inlineoverridevirtual |
Update the animation state for the given msTimePoint.
This function is usually called by animation players.
Implements AnimationInstance.
◆ UpdateAnimatedSprites()
|
inlineoverridevirtual |
Update the animated sprites.
This function must be called manually when an animation player updates animation and returns PlayingAnimationFlags::ANIMATED_PROPERTIES_CHANGED flag. The parameter *_resetSpriteAnimatedProperties* must be set in the following way:
- If one animation instance is used to animate a sprite the parameter is true.
- If more animation instances (via more players) is used to animating the same sprite, the parameter is true for the first processed instance and false for the others.
Implements AnimationInstance.
The documentation for this class was generated from the following file:
- C:/Development/JugiMapProject/JugiMapFRM/framework_c++/jugimap/jmAnimationCommon.h
