Struct AnimationPhase 

pub struct AnimationPhase(pub f32);

An animation coordinate that can go past zero and one.

A phase is not limited to 0.0..=1.0. A multi-stage animation can assign each stage its own range, such as 1.0..=2.0, and interpolate values across it. A bool target produces a phase that settles at 0.0 or 1.0.

Examples

use gpui::AnimationPhase;

let phase = AnimationPhase(1.5);
assert_eq!(phase.interpolate(10.0, 20.0), 25.0);
assert_eq!(phase.interpolate_clamped(10.0, 20.0), 20.0);
assert_eq!(phase.interpolate_between(1.0..=2.0, 10.0, 20.0), 15.0);
assert_eq!(phase.interpolate_between_clamped(2.0..=3.0, 10.0, 20.0), 10.0);

Tuple Fields

0: f32

The phase coordinate, which is not bounded.

Implementations

impl AnimationPhase

pub fn clamp(self, range: RangeInclusive<f32>) -> Self

Limits this phase to range.

The bounds may be given in either order.

pub fn interpolate<T: Interpolate>(self, from: T, to: T) -> T

Interpolates from from at phase 0.0 to to at phase 1.0.

Phases outside 0.0..=1.0 extrapolate past the endpoints. Use interpolate_clamped to hold the endpoints instead.

pub fn interpolate_clamped<T: Interpolate>(self, from: T, to: T) -> T

Interpolates from from to to like interpolate, clamping at the endpoints.

A phase below 0.0 gives from, and a phase above 1.0 gives to.

pub fn interpolate_between<T: Interpolate>( self, range: RangeInclusive<f32>, from: T, to: T, ) -> T

Interpolates across range, where its start maps to from and its end maps to to.

Phases outside the range extrapolate. If the range is empty (start == end), the result is from below start and to at or above it.

pub fn interpolate_between_clamped<T: Interpolate>( self, range: RangeInclusive<f32>, from: T, to: T, ) -> T

Interpolates across range like interpolate_between, clamping at the endpoints.

Phases outside the range give from or to. An empty range behaves as it does in interpolate_between.

Trait Implementations

impl Clone for AnimationPhase

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 AnimationPhase

impl Debug for AnimationPhase

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

Formats the value using the given formatter.

impl Default for AnimationPhase

fn default() -> Self

Returns the “default value” for a type.

impl From<bool> for AnimationPhase

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for AnimationPhase

fn from(value: f32) -> Self

Converts to this type from the input type.

impl PartialEq for AnimationPhase

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AnimationPhase

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl SpringTarget for AnimationPhase

type Output = AnimationPhase

The value that the spring animator receives.

fn target(&self) -> f32

Returns this target as a coordinate for the spring.

fn resolve(&self, value: f32) -> Self::Output

Converts a spring coordinate into the output the animator receives.

impl StructuralPartialEq for AnimationPhase