Class FrameCycleAnimation

Namespace

SharpConsoleUI.Animation

Assembly

SharpConsoleUI.dll

A looping animation that advances a frame index on a fixed interval and never self-completes. Used by spinner controls and helpers. Ticked on the UI thread via AnimationManager; invokes the callback only when the index changes.

public sealed class FrameCycleAnimation : IAnimation

Inheritance

object

FrameCycleAnimation

Implements

IAnimation

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>, Func<TTgt, TSrc>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>)

Constructors

FrameCycleAnimation(int, TimeSpan, Action<int>)

Creates a looping frame-cycle animation.

public FrameCycleAnimation(int frameCount, TimeSpan interval, Action<int> onFrame)

Parameters

frameCount int

Number of frames to cycle through.

interval TimeSpan

Time between frame advances.

onFrame Action<int>

Invoked with the new frame index whenever it changes.

Properties

CurrentFrame

The current frame index (0-based).

public int CurrentFrame { get; }

Property Value

int

IsComplete

Whether the animation has finished or been cancelled.

public bool IsComplete { get; }

Property Value

bool

Methods

Cancel()

Cancels the animation, marking it as complete.

public void Cancel()

Update(TimeSpan)

Advances the animation by the given delta time.

public void Update(TimeSpan deltaTime)

Parameters

deltaTime TimeSpan