Adw.SpringAnimation – libadwaita-1 – Vala Binding Reference

Description:

[ CCode ( type_id = "adw_spring_animation_get_type ()" ) ]
[ Version ( since = "1.0" ) ]
public class SpringAnimation : Animation

A spring-based [class@Animation].

`AdwSpringAnimation` implements an animation driven by a physical model of a spring described by [struct@SpringParams], with a resting position in [property@SpringAnimation:value-to], stretched to [property@SpringAnimation: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 [property@SpringAnimation:epsilon], or immediately when it reaches [property@SpringAnimation:value-to] if [property@SpringAnimation:clamp] is set to `TRUE`. The estimated duration can be obtained with [property@SpringAnimation:estimated-duration].

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

If [property@SpringAnimation: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 [property@SpringAnimation: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.

Namespace: Adw

Content:

Properties:

public bool clamp { get; set; }

Whether the animation should be clamped.

public double epsilon { get; set; }

Precision of the spring.

public uint estimated_duration { get; }

Estimated duration of the animation, in milliseconds.

public double initial_velocity { get; set; }

The initial velocity to start the animation with.

public SpringParams spring_params { get; set construct; }

Physical parameters describing the spring.

public double value_from { get; set construct; }

The value to animate from.

public double value_to { get; set construct; }

The value to animate to.

public double velocity { get; }

Current velocity of the animation.

Creation methods:

public SpringAnimation (Widget widget, double from, double to, owned SpringParams spring_params, owned AnimationTarget target)

Creates a new `AdwSpringAnimation` on widget.

Methods:

public bool get_clamp ()

Gets whether this should be clamped.

public double get_epsilon ()

Gets the precision used to determine the duration of this.

public uint get_estimated_duration ()

Gets the estimated duration of this.

public double get_initial_velocity ()

Gets the initial velocity of this.

public unowned SpringParams get_spring_params ()

Gets the physical parameters of the spring of this.

public double get_value_from ()

Gets the value this will animate from.

public double get_value_to ()

Gets the value this will animate to.

public double get_velocity ()

Gets the current velocity of this.

public void set_clamp (bool clamp)

Sets whether this should be clamped.

public void set_epsilon (double epsilon)

Sets the precision used to determine the duration of this.

public void set_initial_velocity (double velocity)

Sets the initial velocity of this.

public void set_spring_params (SpringParams spring_params)

Sets the physical parameters of the spring of this.

public void set_value_from (double value)

Sets the value this will animate from.

public void set_value_to (double value)

Sets the value this will animate to.

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref