Struct Animation

pub struct Animation(/* private fields */);

Represents an animation in its closure.

See the VARS.animate method for more details.

Implementations

impl Animation

pub fn start_time(&self) -> DInstant

The instant this animation (re)started.

pub fn now(&self) -> DInstant

The instant the current animation update started.

Use this value instead of INSTANT.now, animations update sequentially, but should behave as if they are updating exactly in parallel, using this timestamp ensures that.

pub fn time_scale(&self) -> Factor

Global time scale for animations.

pub fn sleep(&self, duration: Duration)

Set the duration to the next animation update. The animation will sleep until duration elapses.

The animation awakes in the next VARS.frame_duration after the duration elapses. The minimum possible duration is the frame duration, shorter durations behave the same as if not set.

pub fn animations_enabled(&self) -> bool

Returns a value that indicates if animations are enabled in the operating system.

If false all animations must be skipped to the end, users with photo-sensitive epilepsy disable animations system wide.

pub fn force_enable(&self)

Set animations_enabled to true.

This should only be used for animations that are component of an app feature, cosmetic animations must not force enable.

pub fn elapsed_dur(&self) -> Duration

Compute the time elapsed from start_time to now.

pub fn elapsed(&self, duration: Duration) -> EasingTime

Compute the elapsed EasingTime, in the span of the total duration, if animations_enabled.

If animations are disabled, returns EasingTime::end, the returned time is scaled.

pub fn elapsed_stop(&self, duration: Duration) -> EasingTime

Compute the elapsed EasingTime, if the time is_end requests animation stop.

pub fn elapsed_restart(&self, duration: Duration) -> EasingTime

Compute the elapsed EasingTime, if the time is_end restarts the animation.

pub fn elapsed_restart_stop( &self, duration: Duration, max_restarts: usize, ) -> EasingTime

Compute the elapsed EasingTime, if the time is_end restarts the animation, repeats until has restarted max_restarts inclusive, then stops the animation.

pub fn stop(&self)

Drop the animation after applying the current update.

pub fn stop_requested(&self) -> bool

If the animation will be dropped after applying the update.

pub fn restart(&self)

Set the animation start time to now.

pub fn restart_count(&self) -> usize

Number of times the animation restarted.

pub fn set_start_time(&self, instant: DInstant)

Change the start time to an arbitrary value.

Note that this does not affect the restart count.

pub fn set_elapsed(&self, elapsed: EasingTime, duration: Duration)

Change the start to an instant that computes the elapsed for the duration at the moment this method is called.

Note that this does not affect the restart count.

Trait Implementations

impl Clone for Animation

fn clone(&self) -> Animation

Returns a copy of the value.

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

Performs copy-assignment from source.