Inherits from AnimationKit.Task.

This task controls animations for implementors of the AnimationKit.FrameTarget interface.

A frame task does no actual animation, instead providing a way for an implementor to animate using sprites. Frame tasks have an identifier property which is used by the implementor to determine which sprite the new frame is intended for.

See the AnimationKit.FrameTarget interface for an example implementation and usage.


Target As AnimationKit.FrameTarget, Frames As AnimationKit.FrameSet

Creates a task for Target with the provided set of frames. The frame set can be modified after the task is created, but before it is run.


DurationInSeconds As Double = 1.0

If the Looping property is true, this is the number of seconds required to complete one loop of the animation. If the Looping property is false, this is the number of seconds required to complete the animation.

AnimationKit.Coordinator.FramesPerSecond has minimal impact on the animation speed. The duration property fully determines the speed at which frames will be swapped. This means frames may be duplicated or dropped to match the intended duration.

For example, assuming the default of 60 frames per second, a frame set of 30 frames, and a duration of 1 second, each frame in the set will be displayed for two animation frames.

The implementor will only receive a change notification when the frame actually changes; duplicated frames will not trigger duplicate notifications.

Frames As AnimationKit.FrameSet = New AnimationKit.FrameSet()

The set of frames to play/loop through.

Identifier As Text = ""

The identifier is used to instruct the implementor which sprite the new frame is for.

Looping As Boolean = False

If true, the animation will never end.

See Also

AnimationKit.Frame, AnimationKit.FrameSet, AnimationKit.FrameTarget