LuciadCPillar C# 2024.0.05
|
An animation that can be added to AnimationManager
.
More...
Public Member Functions | |
System.TimeSpan | GetDuration () |
Returns the duration of this animation in milliseconds. More... | |
bool | IsLooping () |
Returns whether this animation is a looping animation. More... | |
void | OnStart () |
This method is called when the animation is started. More... | |
void | OnStop () |
This method is called when the animation is stopped. More... | |
bool | OnUpdate (double fraction) |
This method is called to update the animation. More... | |
An animation that can be added to AnimationManager
.
An animation is modeled as a function that takes a value between 0 and 1 as input.
AnimationManager
generates this value using a duration that is assigned
to the animation and the elapsed time at the moment the animation is updated
.
System.TimeSpan Luciad.Animations.IAnimation.GetDuration | ( | ) |
Returns the duration of this animation in milliseconds.
This information is used by AnimationManager
. In practice, this means that the IAnimation.OnUpdate
method is called with a value of 1.0
after this duration has elapsed.
bool Luciad.Animations.IAnimation.IsLooping | ( | ) |
Returns whether this animation is a looping animation.
This information is used by AnimationManager
. If false, the animation is automatically stopped and removed once the duration has elapsed. Otherwise, the animation will continue as long as IAnimation.OnUpdate
returns true. In case of a looping animation, the fraction that is passed to the IAnimation.OnUpdate
restarts at 0 once the animation has completed and progresses again towards 1.
void Luciad.Animations.IAnimation.OnStart | ( | ) |
This method is called when the animation is started.
No onUpdate call will be performed before this method is called. This method is not supposed to call IAnimation.OnUpdate
itself.
void Luciad.Animations.IAnimation.OnStop | ( | ) |
This method is called when the animation is stopped.
No IAnimation.OnUpdate
call will be performed after this method is called. This method is not supposed to call IAnimation.OnUpdate
itself.
Note that this method may be called before the animation has finished. This can for example happen when an animation is canceled.
bool Luciad.Animations.IAnimation.OnUpdate | ( | double | fraction | ) |
This method is called to update the animation.
This method will typically perform an action, e.g. update the camera location.
fraction | The position where you are located in the animation. This position varies from 0 to 1 (0 and 1 are included). |
OnStop
method. System.ArgumentException | when the fraction value is invalid. |