Skip to main content

Clamping

Struct Clamping 

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

Android’s scroll feel — Flutter’s ClampingScrollPhysics: a drag never leaves the range (the excess is rejected outright, for the surface to show as a stretch or a glow instead), and a release runs Android’s own SplineOverScroller deceleration to a hard stop.

See the module docs for why nothing here clamps that curve itself.

Implementations§

Source§

impl Clamping

Source

pub fn new() -> Clamping

A standalone clamping physics (no chained parent).

Source

pub fn chain(self, parent: impl ScrollPhysics + 'static) -> Clamping

Chain parent behind this physics, the module-wide composition convention (ScrollPhysics’ Chaining).

Trait Implementations§

Source§

impl Debug for Clamping

Source§

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

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

impl Default for Clamping

Source§

fn default() -> Clamping

Returns the “default value” for a type. Read more
Source§

impl ScrollPhysics for Clamping

Source§

fn apply_boundary_conditions(&self, metrics: &ScrollMetrics, value: f64) -> f64

The whole of any past-extent excess is rejected, so the position itself never leaves [min, max]. The caller still learns how far the proposal went — that rejected distance is what a stretch or glow effect reads (this module’s parent’s design ruling).

Source§

fn create_ballistic_simulation( &self, metrics: &ScrollMetrics, velocity: f64, ) -> Option<Box<dyn Simulation>>

Android’s fling curve for a release with room to travel, and — as a safety arm this physics’ own boundary rule makes unreachable — a spring back to the nearest extent for a position that starts out of range.

Source§

fn parent(&self) -> Option<&dyn ScrollPhysics>

The chained parent physics, if this one was built via chain(...). None for a physics built standalone (the chain’s root).
Source§

fn apply_physics_to_user_offset( &self, metrics: &ScrollMetrics, offset: f64, ) -> f64

Map a raw user drag delta (finger px, signed in the content’s own direction) to the delta actually applied to the position. Must not alter the in-bounds portion of a drag — only a physics with an out-of-bounds opinion (e.g. added resistance) touches this. Read more
Source§

fn should_accept_user_offset(&self, metrics: &ScrollMetrics) -> bool

Whether a user drag is allowed to move the position at all. Read more
Source§

fn carried_momentum(&self, existing_velocity: f64) -> f64

Momentum (px/s) to add onto a new fling’s initial velocity when motion is already live (a re-fling mid-animation carries some of the old velocity forward rather than starting cold). Read more
Source§

fn min_fling_velocity(&self) -> f64

The minimum release speed that starts a fling. Read more
Source§

fn max_fling_velocity(&self) -> f64

The fastest fling speed this physics honors. Read more
Source§

fn tolerance_for(&self, metrics: &ScrollMetrics) -> Tolerance

The velocity/distance tolerance a ballistic simulation settles within. Read more
Source§

fn spring(&self) -> SpringDescription

The spring a bounce-back/snap simulation is built from. Read more

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> 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> ErasedDestructor for T
where T: 'static,

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> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

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

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
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> 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