Struct libadwaita::SpringAnimation

pub struct SpringAnimation { /* private fields */ }

A spring-based Animation.

SpringAnimation implements an animation driven by a physical model of a spring described by SpringParams, with a resting position in value-to, stretched to value-from.

Since the animation is physically simulated, spring animations don’t have a fixed duration. The animation will stop when the simulated spring comes to a rest - when the amplitude of the oscillations becomes smaller than epsilon, or immediately when it reaches value-to if clamp is set to TRUE. The estimated duration can be obtained with estimated-duration.

Due to the nature of spring-driven motion the animation can overshoot value-to before coming to a rest. Whether the animation will overshoot or not depends on the damping ratio of the spring. See SpringParams for more information about specific damping ratio values.

If clamp is TRUE, the animation will abruptly end as soon as it reaches the final value, preventing overshooting.

Animations can have an initial velocity value, set via initial-velocity, which adjusts the curve without changing the duration. This makes spring animations useful for deceleration at the end of gestures.

If the initial and final values are equal, and the initial velocity is not 0, the animation value will bounce and return to its resting position.

Properties

clamp

Whether the animation should be clamped.

If set to TRUE, the animation will abruptly end as soon as it reaches the final value, preventing overshooting.

It won’t prevent overshooting value-from if a relative negative initial-velocity is set.

Readable | Writeable

epsilon

Precision of the spring.

The level of precision used to determine when the animation has come to a rest, that is, when the amplitude of the oscillations becomes smaller than this value.

If the epsilon value is too small, the animation will take a long time to stop after the animated value has stopped visibly changing.

If the epsilon value is too large, the animation will end prematurely.

The default value is 0.001.

Readable | Writeable

estimated-duration

Estimated duration of the animation, in milliseconds.

Can be DURATION_INFINITE if the spring damping is set to 0.

Readable

initial-velocity

The initial velocity to start the animation with.

Initial velocity affects only the animation curve, but not its duration.

Readable | Writeable

spring-params

Physical parameters describing the spring.

Readable | Writeable | Construct

value-from

The value to animate from.

The animation will start at this value and end at value-to.

Readable | Writeable | Construct

value-to

The value to animate to.

The animation will start at value-from and end at this value.

Readable | Writeable | Construct

velocity

Current velocity of the animation.

Readable

Animation

follow-enable-animations-setting

Whether to skip the animation when animations are globally disabled.

The default behavior is to skip the animation. Set to FALSE to disable this behavior.

This can be useful for cases where animation is essential, like spinners, or in demo applications. Most other animations should keep it enabled.

See gtk-enable-animations.

Readable | Writeable

state

The animation state.

The state indicates whether the animation is currently playing, paused, finished or hasn’t been started yet.

Readable

target

The target to animate.

Readable | Writeable | Construct

value

The current value of the animation.

Readable

widget

The animation widget.

It provides the frame clock for the animation. It’s not strictly necessary for this widget to be same as the one being animated.

The widget must be mapped in order for the animation to work. If it’s not mapped, or if it gets unmapped during an ongoing animation, the animation will be automatically skipped.

Readable | Writeable | Construct Only

Implements

AnimationExt, [trait@glib::ObjectExt]

Implementations

impl SpringAnimation

pub fn new( widget: &impl IsA<Widget>, from: f64, to: f64, spring_params: SpringParams, target: impl IsA<AnimationTarget> ) -> SpringAnimation

Creates a new SpringAnimation on @widget.

The animation will animate @target from @from to @to with the dynamics of a spring described by @spring_params.

widget

a widget to create animation on

from

a value to animate from

to

a value to animate to

spring_params

physical parameters of the spring

target

a target value to animate

Returns

the newly created animation

pub fn builder() -> SpringAnimationBuilder

Creates a new builder-pattern struct instance to construct SpringAnimation objects.

This method returns an instance of SpringAnimationBuilder which can be used to create SpringAnimation objects.

pub fn calculate_value(&self, time: u32) -> f64

Available on crate feature v1_3 only.

Calculates the value @self will have at @time.

The time starts at 0 and ends at estimated_duration.

See also calculate_velocity().

time

elapsed time, in milliseconds

Returns

the value at @time

pub fn calculate_velocity(&self, time: u32) -> f64

Available on crate feature v1_3 only.

Calculates the velocity @self will have at @time.

The time starts at 0 and ends at estimated_duration.

See also calculate_value().

time

elapsed time, in milliseconds

Returns

the velocity at @time

pub fn is_clamp(&self) -> bool

Gets whether @self should be clamped.

Returns

whether @self is clamped

pub fn epsilon(&self) -> f64

Gets the precision of the spring.

Returns

the epsilon value

pub fn estimated_duration(&self) -> u32

Gets the estimated duration of @self, in milliseconds.

Can be DURATION_INFINITE if the spring damping is set to 0.

Returns

the estimated duration

pub fn initial_velocity(&self) -> f64

Gets the initial velocity of @self.

Returns

the initial velocity

pub fn spring_params(&self) -> SpringParams

Gets the physical parameters of the spring of @self.

Returns

the spring parameters

pub fn value_from(&self) -> f64

Gets the value @self will animate from.

Returns

the value to animate from

pub fn value_to(&self) -> f64

Gets the value @self will animate to.

Returns

the value to animate to

pub fn velocity(&self) -> f64

Gets the current velocity of @self.

Returns

the current velocity

pub fn set_clamp(&self, clamp: bool)

Sets whether @self should be clamped.

If set to TRUE, the animation will abruptly end as soon as it reaches the final value, preventing overshooting.

It won’t prevent overshooting value-from if a relative negative initial-velocity is set.

clamp

the new value

pub fn set_epsilon(&self, epsilon: f64)

Sets the precision of the spring.

The level of precision used to determine when the animation has come to a rest, that is, when the amplitude of the oscillations becomes smaller than this value.

If the epsilon value is too small, the animation will take a long time to stop after the animated value has stopped visibly changing.

If the epsilon value is too large, the animation will end prematurely.

The default value is 0.001.

epsilon

the new value

pub fn set_initial_velocity(&self, velocity: f64)

Sets the initial velocity of @self.

Initial velocity affects only the animation curve, but not its duration.

velocity

the initial velocity

pub fn set_spring_params(&self, spring_params: &SpringParams)

Sets the physical parameters of the spring of @self.

spring_params

the new spring parameters

pub fn set_value_from(&self, value: f64)

Sets the value @self will animate from.

The animation will start at this value and end at value-to.

value

the value to animate from

pub fn set_value_to(&self, value: f64)

Sets the value @self will animate to.

The animation will start at value-from and end at this value.

value

the value to animate to

pub fn connect_clamp_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_epsilon_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_estimated_duration_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_initial_velocity_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_spring_params_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_value_from_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_value_to_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_velocity_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for SpringAnimation

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpringAnimation

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

Formats the value using the given formatter.

impl Default for SpringAnimation

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SpringAnimation

type ParamSpec = ParamSpecObject

type SetValue = SpringAnimation

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, SpringAnimation>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SpringAnimation

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SpringAnimation

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for SpringAnimation

type Parent = Animation

impl<OT: ObjectType> PartialEq<OT> for SpringAnimation

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for SpringAnimation

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for SpringAnimation

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SpringAnimation

impl IsA<Animation> for SpringAnimation