Skip to main content

MotionSpec

Struct MotionSpec 

Source
pub struct MotionSpec {
    pub duration_ms: u64,
    pub delay_ms: u64,
    pub curve: CubicBezier,
    /* private fields */
}
Expand description

A curve with a duration and a delay: everything one animation needs, taken from the token document rather than written beside the element.

A specification can carry a spring instead of a curve. Its duration is then the spring’s settle time, so everything that already knows how to run a specification — Transition, Presence, Stagger and GPUI’s with_animation — runs a spring without knowing it is one.

Fields§

§duration_ms: u64§delay_ms: u64§curve: CubicBezier

Implementations§

Source§

impl MotionSpec

Source

pub const fn new(duration_ms: u64, curve: CubicBezier) -> Self

Source

pub fn sprung(spring: Spring) -> Self

A specification that arrives on a spring rather than along a curve.

The duration is the spring’s settle time, which is where the weight comes from: a spring is still moving after a curve of the same nominal length has stopped.

Source

pub const fn with_delay(self, delay_ms: u64) -> Self

Source

pub fn is_sprung(self) -> bool

Source

pub fn spring(self) -> Option<Spring>

The spring behind a sprung specification, for callers that need more of it than an eased fraction — velocity across a retarget, for one.

Source

pub fn total(self) -> Duration

Source

pub fn progress(self, raw: f32) -> f32

Source

pub fn time_at(self, value: f32) -> Duration

The earliest point in the run at which the specification has reached value: the inverse of MotionSpec::progress, on the same clock.

Sampled at a millisecond rather than solved, because a cubic bezier has no closed-form inverse and a spring is not even monotonic — an underdamped one passes its target and comes back, so “the earliest time it was there” is the only well-defined answer. A millisecond is the granularity a specification is written in anyway.

A value never reached returns the whole run.

Source

pub fn after(self, previous: MotionSpec) -> Self

The specification moved to start when previous has finished.

Its own delay is kept and counted from there, so “80ms after the panel has opened” is content.with_delay(80).after(panel) and the caller never adds two numbers together. Sequence is the same composition for more than two, and can report the total.

Source

pub fn animation(self) -> Animation

Adapts the specification to GPUI’s animation driver.

GPUI requires an eased delta inside 0..1, so an overshooting curve or an underdamped spring is clamped here. Overshoot survives in Transition and Presence, which sample MotionSpec::progress directly.

Source

pub fn repeating(self) -> Animation

Trait Implementations§

Source§

impl Clone for MotionSpec

Source§

fn clone(&self) -> MotionSpec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for MotionSpec

Source§

impl Debug for MotionSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for MotionSpec

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MotionSpec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more