Struct Animated 

pub struct Animated<T, Time = Instant> { /* private fields */ }

A value that animates toward a target, and keeps the state it needs to change course.

Animated stores the logical target, the motion, and when the current run started. When the target changes mid-run, the new run starts from the value on screen at that moment, so the motion doesn’t jump. Transition and style transitions are built on it.

Time is the clock type. The default is std::time::Instant. Any Time that subtracts to a Duration works, and a Duration makes the examples deterministic.

Examples

use std::time::Duration;

use gpui::{Animated, Motion, millis, secs};

let motion = Motion::new(secs(1));
let mut value = Animated::<f32, Duration>::new(0.0, motion.clone());

assert!(value.set(10.0, &motion, Duration::ZERO));
assert_eq!(value.sample(millis(500)).value, 5.0);

// Setting the same target again changes nothing.
assert!(!value.set(10.0, &motion, millis(500)));

Implementations

impl<T, Time> Animated<T, Time>

where T: Lerp + Clone + PartialEq, Time: Copy + Sub<Time, Output = Duration>,

pub fn new(value: T, motion: impl Into<AnyMotion>) -> Self

Creates a value at rest at value. motion describes how later changes animate.

pub fn value(&self) -> &T

Returns the logical target: the value most recently given to set.

This is not the value on screen during a run. Use sample for that.

pub fn set(&mut self, value: T, motion: impl Into<AnyMotion>, now: Time) -> bool

Sets a new target and starts a run from the current presentation.

The run begins at now, using motion, and starts from the value on screen at that moment. Returns true if the target changed. Setting the current target again returns false and leaves the run alone.

Reverse-first playback flips motion progress into anchor-to-target progress. A custom easing curve that starts away from zero can still cause an initial jump.

pub fn jump_to(&mut self, value: T)

Sets the target and the value on screen to value, with no animation.

This stops any run in progress.

pub fn reset(&mut self)

Restores the value this animation was created with, with no animation.

This stops any run in progress.

pub fn sample(&mut self, now: Time) -> AnimatedSample<T>

Returns the value presented at now, and whether the animation can still change.

Call this once per frame. After a run finishes, the sample returns its final value with is_active set to false, and that value becomes the anchor for the next change. Before a run starts, sampling returns the last settled value.

Trait Implementations

impl<T: Clone, Time: Clone> Clone for Animated<T, Time>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.