adwaita/org.gtkkn.bindings.adw/SpringAnimation

SpringAnimation

class SpringAnimation(pointer: <Error class: unknown class><<Error class: unknown class>>) : 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.

Constructors

SpringAnimation

constructor(widget: <Error class: unknown class>, from: Double, to: Double, springParams: SpringParams, target: AnimationTarget)

Creates a new AdwSpringAnimation on @widget.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

object Companion

Properties

adwAnimationPointer

val adwAnimationPointer: <Error class: unknown class><<Error class: unknown class>>

adwSpringAnimationPointer

val adwSpringAnimationPointer: <Error class: unknown class><<Error class: unknown class>>

var clamp: Boolean

Whether the animation should be clamped.

var epsilon: Double

Precision of the spring.

estimatedDuration

val estimatedDuration: <Error class: unknown class>

Estimated duration of the animation, in milliseconds.

followEnableAnimationsSetting

open var followEnableAnimationsSetting: Boolean

Whether to skip the animation when animations are globally disabled.

initialVelocity

var initialVelocity: Double

The initial velocity to start the animation with.

var springParams: SpringParams

Physical parameters describing the spring.

open val state: AnimationState

The animation state.

open var target: AnimationTarget

The target to animate.

open val value: Double

The current value of the animation.

var valueFrom: Double

The value to animate from.

var valueTo: Double

The value to animate to.

val velocity: Double

Current velocity of the animation.

open val widget: <Error class: unknown class>

The animation widget.

Functions

fun calculateValue(time: <Error class: unknown class>): Double

Calculates the value @self will have at @time.

calculateVelocity

fun calculateVelocity(time: <Error class: unknown class>): Double

Calculates the velocity @self will have at @time.

fun connectDone(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

This signal is emitted when the animation has been completed, either on its own or via calling method@Animation.skip.

fun getClamp(): Boolean

Gets whether @self should be clamped.

fun getEpsilon(): Double

Gets the precision of the spring.

getEstimatedDuration

fun getEstimatedDuration(): <Error class: unknown class>

Gets the estimated duration of @self, in milliseconds.

getFollowEnableAnimationsSetting

open fun getFollowEnableAnimationsSetting(): Boolean

Gets whether @self should be skipped when animations are globally disabled.

getInitialVelocity

fun getInitialVelocity(): Double

Gets the initial velocity of @self.

getSpringParams

fun getSpringParams(): SpringParams

Gets the physical parameters of the spring of @self.

open fun getState(): AnimationState

Gets the current value of @self.

open fun getTarget(): AnimationTarget

Gets the target @self animates.

open fun getValue(): Double

Gets the current value of @self.

fun getValueFrom(): Double

Gets the value @self will animate from.

fun getValueTo(): Double

Gets the value @self will animate to.

fun getVelocity(): Double

Gets the current velocity of @self.

open fun getWidget(): <Error class: unknown class>

Gets the widget @self was created for.

open fun pause()

Pauses a playing animation for @self.

open fun play()

Starts the animation for @self.

open fun reset()

Resets the animation for @self.

open fun resume()

Resumes a paused animation for @self.

fun setClamp(clamp: Boolean)

Sets whether @self should be clamped.

fun setEpsilon(epsilon: Double)

Sets the precision of the spring.

setFollowEnableAnimationsSetting

open fun setFollowEnableAnimationsSetting(setting: Boolean)

Sets whether to skip @self when animations are globally disabled.

setInitialVelocity

fun setInitialVelocity(velocity: Double)

Sets the initial velocity of @self.

setSpringParams

fun setSpringParams(springParams: SpringParams)

Sets the physical parameters of the spring of @self.

open fun setTarget(target: AnimationTarget)

Sets the target @self animates to @target.

fun setValueFrom(value: Double)

Sets the value @self will animate from.

fun setValueTo(value: Double)

Sets the value @self will animate to.

open fun skip()

Skips the animation for @self.