 | |
AnimationT Class | |
Inheritance HierarchySystemObject
Ab4d.SharpEngine.AnimationAnimationT
Ab4d.SharpEngine.AnimationCameraAnimation
Ab4d.SharpEngine.AnimationTargetsAnimationT
Ab4d.SharpEngine.AnimationAnimationT
Ab4d.SharpEngine.AnimationCameraAnimation
Ab4d.SharpEngine.AnimationTargetsAnimationT
Namespace: Ab4d.SharpEngine.Animation
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 2.0.8956+4c7684e186ca1be74e7a284fbe739d9a1b843d3c
SyntaxThe AnimationT type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AnimationT | Initializes a new instance of the AnimationT class |
Properties| Name | Description | |
|---|---|---|
 | Direction | |
| Duration | Duration of one animation loop in milliseconds. If duration has not been explicitly set using the SetDuration(Single) or SetDuration(FuncT, Int32, Int32, Single) methods, 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 | When true (by default) then the animation is automatically subscribed to SceneUpdating event on Scene or SceneView object. When false, then user must manually call Update or Update(Single) methods. This property must be set before the animation is started. |
| IsInitialized | True after animation is initialized using the Initialize method. |
| IsRunning | True when the animation is running (has been started). |
| IsUsingExistingStandardTransform | When true than an existing transformation on SceneNode will be animated (by default). When false, then each start of animation will add a new StandardTransformation object to the SceneNode's Transform. |
| 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 within 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 including the loops that are defined by Loop and LoopCount. |
Methods| Name | Description | |
|---|---|---|
| AddKeyframesInfoText | |
| AddTargetsInfoText | |
| CheckIsRunning | |
 | ConstructAnimationTrackTProperty, TInfoProperty | Helper for constructing final animation track from list of keyframe info entries and animation parameters. |
 | DumpInfo | |
| GetAnimatedPropertyName | |
| GetDelay | |
| GetDuration | |
| GetEndDelay | |
| GetInfoText | |
| GetTargetName | |
| Initialize | Initialize the animation's internal structures and compute keyframe tracks. After this call, the animation's properties such as Duration and TotalDuration become valid. The animation itself (e.g., its parameters) cannot be altered anymore. |
| OnCompleted | |
| OnInitialize | |
| OnLoopIterationChanged | |
| OnRewind | |
| OnStart | |
| OnStop | |
| OnUpdate | |
| OnUpdated | |
| RegisterAnimation | Registers this animation on Scene or SceneView object so that Update method is automatically called. This method is called from Start method. |
| Rewind | |
| Seek | |
| SetDelay(FuncT, Int32, Int32, Single) | Sets the delay function that sets different delay for each target element. The function is called with the following parameters: targetElement, index of the target element, target elements count. |
| SetDelay(Single) | Sets the delay before the animation starts. |
| SetDelay(TimeSpan) | Sets the delay before the animation starts. |
| SetDuration(FuncT, Int32, Int32, Single) | Sets the duration function that sets different duration for each target element. The function is called with the following parameters: targetElement, index of the target element, target elements count. |
| SetDuration(Single) | Sets the duration of the whole animation. |
| SetDuration(TimeSpan) | Sets the duration of the whole animation. |
| SetEasingFunctionToAllKeyframes | |
| SetEasingFunctionToKeyframeInfosTKeyframeInfo | |
| SetEndDelay(FuncT, Int32, Int32, Single) | Sets the end delay function that sets different end delay for each target element. The function is called with the following parameters: targetElement, index of the target element, target elements count. |
| SetEndDelay(Single) | Sets the end delay before the animation starts. |
| SetEndDelay(TimeSpan) | Sets the end delay before the animation starts. |
| Start | |
| Stop | |
| TemporallyScaleAnimationTracks | Helper for temporal rescaling of per-target group of animation tracks. |
| UnRegisterAnimation | Removes this animation from Scene or SceneView object and prevents calling Update method automatically. This method is called from Stop method. |
| Update | |
| Update(Single) |
Events| Name | Description | |
|---|---|---|
 | Completed | |
| LoopIterationChanged | |
| Updated |
Fields| Name | Description | |
|---|---|---|
 | animationTracks | Animation tracks. Populated by actual subclasses of this class. |
 | DefaultDuration | |
| settingsChanged | Internal boolean indicating that animation's settings have changed and that animation needs to be re-initialized. If not done explicitly via Initialize method, animation is re-initialized implicitly on next Start, Rewind, or Seek(Single) method call. |
See Also