TuiAnimationEffect class abstract

Base abstract class for all terminal user interface (TUI) animation effects.

Implementers

Constructors

TuiAnimationEffect({required Duration duration, EasingFunction easing = Easing.linear, Duration targetFrameInterval = Duration.zero})
Creates a TuiAnimationEffect with the required duration, easing, and optional targetFrameInterval.

Properties

duration Duration
Total duration of the animation lifecycle.
final
easing EasingFunction
Easing curve applied to progress over time.
final
hashCode int
The hash code for this object.
no setterinherited
isActive bool
Whether the animation is currently active (for backward compatibility).
no setter
isAnimating bool
Whether the animation is currently running/animating (status is forward or reverse).
no setter
isVisible bool
Whether the animation is visible (status is not dismissed).
no setter
onUpdate VoidCallback?
The callback to trigger widget repaints.
getter/setter pair
progress double
The eased progress of the animation, bounded strictly between 0.0 and 1.0.
getter/setter pair
rawProgress double
The raw (uneased) progress of the animation, bounded strictly between 0.0 and 1.0.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
status AnimationStatus
The current status of the animation.
getter/setter pair
targetFrameInterval Duration
The target frame interval (e.g. Duration(milliseconds: 33) for 30 FPS). If set, the effect will throttle its repaint triggers to this interval. Defaults to Duration.zero (render on every tick/vsync).
final
triggerPoint Point<int>?
The local coordinate where the animation was triggered.
getter/setter pair

Methods

forward() → void
Starts running this animation forward.
interpolateColor(Color c1, Color c2, double t) Color
Helper utility to interpolate between two discrete Color properties.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paint(Buffer buffer, Rect area, Style baseStyle) → void
Performs direct rendering modifications to the relative buffer.
reset() → void
Resets the animation to its default dormant/dismissed state.
reverse() → void
Starts running this animation in reverse.
start(Point<int> clickPoint, VoidCallback onUpdate) → void
Starts the animation forward from the beginning.
stop() → void
Stops the animation and freezes it at the current progress.
tick() bool
Advances the animation tick frame. Returns true if ticking should continue.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited