Struct AnimatedValue 

pub struct AnimatedValue { /* private fields */ }

An animated value that automatically registers with the scheduler

When the target changes, the value smoothly animates to it using spring physics. The animation is automatically registered with the scheduler and ticked each frame.

Example

// Create an animated value (auto-registers with scheduler)
let opacity = AnimatedValue::new(ctx.animation_handle(), 1.0, SpringConfig::stiff());

// Change target - automatically animates
opacity.set_target(0.5);

// Get current animated value (interpolated)
let current = opacity.get();

Implementations

impl AnimatedValue

pub fn new( handle: SchedulerHandle, initial: f32, config: SpringConfig, ) -> AnimatedValue

Create a new animated value with the given initial value

pub fn with_default(handle: SchedulerHandle, initial: f32) -> AnimatedValue

Create with default spring config (stiff)

pub fn set_target(&mut self, target: f32)

Set the target value - starts animation if different from current

pub fn get(&self) -> f32

Get the current animated value

pub fn set_immediate(&mut self, value: f32)

Set value immediately without animation

pub fn is_animating(&self) -> bool

Check if currently animating

Returns true only while the spring is actively moving toward its target. Once the spring has settled (reached target with near-zero velocity), this returns false.

pub fn snap_to_target(&mut self)

Snap immediately to the target value, stopping any active animation

This removes the spring entirely and sets the current value to the target. Useful for immediately completing an animation.

pub fn target(&self) -> f32

Get the current target value

Trait Implementations

impl Clone for AnimatedValue

fn clone(&self) -> AnimatedValue

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for AnimatedValue

fn drop(&mut self)

Executes the destructor for this type.