Skip to main content

Spring

Struct Spring 

Source
pub struct Spring { /* private fields */ }
Expand description

A physical spring policy for spring.

A spring is the counterpart to Transition for values that can be retargeted while they are still moving. A duration-based transition restarts its easing from the value sampled at that instant, which is continuous in position but not in velocity. A spring carries velocity across the retarget, so a value reversed mid-flight decelerates and turns around instead of snapping to a new curve’s initial speed.

Implementations§

Source§

impl Spring

Source

pub const fn new(response: Duration) -> Self

Builds a spring that reaches its target in about response without overshooting it.

response is not a duration in the sense Transition::new means one. A spring has no end to schedule: this is the period one full oscillation would take without damping, which is the scale the motion is felt at rather than the moment it stops. The remaining fraction of a percent keeps settling past it, until it is within the tolerance Self::with_epsilon sets.

A zero response adopts the target on the spot, as a zero duration does for a transition. Say that with Self::with_travel where it is what you mean; a zero here is the degenerate case, defined so an infinitely stiff spring resolves rather than dividing by its own period.

Source

pub const fn with_damping(self, ratio: f32) -> Self

Sets the damping ratio, which is 1.0 — no overshoot — by default.

Below 1.0 the spring passes its target and comes back; above 1.0 it approaches slowly. Overshoot suits a value with room to pass its target and nothing to collide with. A height, an opacity, or anything bounded by the geometry around it should stay at the default.

This is $\zeta$, not GPUI’s SpringConfig::damping, which is the coefficient $c = 2 \zeta \omega_0$.

§Panics

Panics when ratio is negative or non-finite. Use Self::try_with_damping when the value is not a trusted constant.

Source

pub const fn try_with_damping(self, ratio: f32) -> Result<Self, SpringError>

Checked form of Self::with_damping.

Source

pub const fn with_travel(self, travel: bool) -> Self

Sets whether the spring travels to its target or adopts it on the spot.

A value the pointer is already moving — a panel being dragged by its resize handle — must not lag behind the pointer, so the spring stops travelling for as long as the drag lasts. Retained state stays pinned to the target meanwhile, so travel resumes from the value the drag released rather than from wherever the spring was when it began.

This says at the call that the motion is suspended, and it says it without disturbing the response, damping or tolerance the spring is configured with — which a policy swapped out for the length of the drag would have to restate or discard.

Source

pub const fn with_epsilon(self, epsilon: f32) -> Self

Sets the settling tolerance, expressed in the target’s own units.

The default suits targets that move within a normalized 0..1 range. A spring over pixels settles perceptibly sooner with a coarser tolerance, which also ends the animation frames that the remaining sub-pixel motion would otherwise request.

§Panics

Panics when epsilon is zero, negative, or non-finite. Use Self::try_with_epsilon when the value is not a trusted constant.

Source

pub const fn try_with_epsilon(self, epsilon: f32) -> Result<Self, SpringError>

Checked form of Self::with_epsilon.

Source

pub const fn epsilon(self) -> f32

Returns the settling tolerance in the target’s own units.

Trait Implementations§

Source§

impl Clone for Spring

Source§

fn clone(&self) -> Self

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 Spring

Source§

impl Debug for Spring

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Forget for Spring

§

impl Freeze for Spring

§

impl Move for Spring

§

impl RefUnwindSafe for Spring

§

impl Send for Spring

§

impl Sync for Spring

§

impl Unpin for Spring

§

impl UnsafeUnpin for Spring

§

impl UnwindSafe for Spring

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> TextSelectionScopeExt for T

Source§

fn text_selection_scope(self, scope: TextSelectionScopeId) -> impl IntoElement
where Self: IntoElement,

Marks this element subtree as belonging to a text-selection scope.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

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