 | |
IAnimation Interface | |
Namespace: Ab4d.SharpEngine.Animation
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 2.0.8956+4c7684e186ca1be74e7a284fbe739d9a1b843d3c
SyntaxC#
public interface IAnimation
The IAnimation type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Direction | |
| Duration | Duration of one animation loop in milliseconds. If duration has not been explicitly set using the SetDuration method, the duration is determined by length of the animation tracks (elements). If duration has been explicitly set, all tracks are temporally scaled to the specified length, so the estimated duration should also equal to the specified one. The duration estimate becomes available (valid) only after animation is started and tracks are finalized. |
| EasingFunction | |
| IsAutomaticallyUpdating | |
| IsRunning | True when the animation is running (has been started). |
| Loop | When false (by default) the animation is played only once. When true the animation is repeated. By default the animation is repeated indefinitely. To limit the number of iterations set the LoopCount property. |
| LoopCount | Gets or sets number of times the animation iterations. Zero (by default) means to loop indefinitely (if Loop is true). |
| LoopIteration | Loop iteration counter |
| Name | Gets an optional name of the animation that can be set when the animation is created. |
| Progress | Gets the progress of the animation withing one loop. The returns value is in range from 0 (start of the animation) to 1 (end of the animated loop). |
| Time | Gets the time of the current animation loop. |
| TotalDuration | Total duration of the animation including the loops that are defined by Loop and LoopCount. In case when the animation loops indefinitely (Loop = true; LoopCount = 0), then float.PositiveInfinity is returned. |
| TotalProgress | Gets the total progress of the animation including the loops that are defined by Loop and LoopCount. The returns value is in range from 0 (start of the animation) to 1 (end of the animated loop). |
| TotalTime | Gets the total time of the animation. |
Methods| Name | Description | |
|---|---|---|
 | DumpInfo | |
| GetAnimatedPropertyName | |
| GetDelay | |
| GetDuration | |
| GetEndDelay | |
| GetInfoText | |
| Initialize | |
| Rewind | |
| Seek | |
| SetDelay | |
| SetDuration | |
| SetEasingFunctionToAllKeyframes | Set the specified easing function to all key-frames that have been defined in the animation. |
| SetEndDelay | |
| Start | |
| Stop | |
| Update | |
| Update(Single) |
Events| Name | Description | |
|---|---|---|
 | Completed | |
| LoopIterationChanged | |
| Updated |
See Also