Struct MotionSample 

pub struct MotionSample {
    pub progress: Progress,
    pub local_time: Progress,
    pub iteration: u128,
    pub direction: PassDirection,
    pub phase: MotionPhase,
    pub is_active: bool,
}

The state of a Motion at one moment, returned by Motion::sample.

Use progress to draw the frame and is_active to decide whether to request another one. Whether the whole run has finished is a separate question, answered by is_complete.

Fields

progress: Progress

Eased presentation progress. It may overshoot zero through one.

local_time: Progress

Normalized time within the current pass, before easing. For a settling spring this is the elapsed time divided by the estimated settling time.

iteration: u128

Zero-based index of the current iteration. A spring reports zero. A completed finite run reports its last iteration.

direction: PassDirection

The direction of the pass this sample is in. It is the resolved direction, not the configured Direction. A spring reports PassDirection::Forward.

phase: MotionPhase

The lifecycle state of the run.

is_active: bool

Whether another sample can produce a different value. This is true in MotionPhase::Delayed and MotionPhase::Playing, and false in MotionPhase::Completed and MotionPhase::Inactive.

Implementations

impl MotionSample

pub const fn is_complete(self) -> bool

Returns whether the whole finite run has completed.

A completed run may rest at either end of its presentation, so check is_at_end separately if you need the endpoint.

pub const fn is_at_end(self) -> bool

Returns whether the eased presentation is exactly at one.

Trait Implementations

impl Clone for MotionSample

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MotionSample

impl Debug for MotionSample

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for MotionSample

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for MotionSample