Package org.gnome.adw

Class SpringAnimation

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.adw.Animation

org.gnome.adw.SpringAnimation

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class SpringAnimation
extends Animation

A spring-based Animation.

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

Due to the nature of spring-driven motion the animation can overshoot SpringAnimation: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 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 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpringAnimation.Builder<B extends SpringAnimation.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	SpringAnimation.SpringAnimationClass

Nested classes/interfaces inherited from class org.gnome.adw.Animation

Animation.Animation$Impl, Animation.AnimationClass, Animation.DoneCallback

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
SpringAnimation()	Creates a new SpringAnimation.
SpringAnimation(MemorySegment address)	Create a SpringAnimation proxy instance for the provided memory address.
SpringAnimation(Widget widget, double from, double to, SpringParams springParams, AnimationTarget target)	Creates a new AdwSpringAnimation on widget.

Method Summary

Modifier and Type	Method	Description
protected SpringAnimation	asParent()	Returns this instance as if it were its parent type.
static SpringAnimation.Builder<? extends SpringAnimation.Builder>	builder()	A SpringAnimation.Builder object constructs a SpringAnimation with the specified properties.
double	calculateValue(int time)	Calculates the value this SpringAnimation will have at time.
double	calculateVelocity(int time)	Calculates the velocity this SpringAnimation will have at time.
boolean	getClamp()	Gets whether this SpringAnimation should be clamped.
double	getEpsilon()	Gets the precision of the spring.
int	getEstimatedDuration()	Gets the estimated duration of self, in milliseconds.
double	getInitialVelocity()	Gets the initial velocity of self.
SpringParams	getSpringParams()	Gets the physical parameters of the spring of self.
static @Nullable Type	getType()	Get the GType of the SpringAnimation class
double	getValueFrom()	Gets the value this SpringAnimation will animate from.
double	getValueTo()	Gets the value this SpringAnimation will animate to.
double	getVelocity()	Gets the current velocity of self.
void	setClamp(boolean clamp)	Sets whether this SpringAnimation should be clamped.
void	setEpsilon(double epsilon)	Sets the precision of the spring.
void	setInitialVelocity(double velocity)	Sets the initial velocity of self.
void	setSpringParams(SpringParams springParams)	Sets the physical parameters of the spring of self.
void	setValueFrom(double value)	Sets the value this SpringAnimation will animate from.
void	setValueTo(double value)	Sets the value this SpringAnimation will animate to.

Methods inherited from class org.gnome.adw.Animation

emitDone, getFollowEnableAnimationsSetting, getMemoryLayout, getState, getTarget, getValue, getWidget, onDone, pause, play, reset, resume, setFollowEnableAnimationsSetting, setTarget, skip

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SpringAnimation

public SpringAnimation(MemorySegment address)

Create a SpringAnimation proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

SpringAnimation

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

Creates a new AdwSpringAnimation on widget.

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

Parameters:

widget - a widget to create animation on

from - a value to animate from

to - a value to animate to

springParams - physical parameters of the spring

target - a target value to animate

SpringAnimation

public SpringAnimation()

Creates a new SpringAnimation.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the SpringAnimation class

Returns:

the GType

asParent

protected SpringAnimation asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class Animation

calculateValue

public double calculateValue(int time)

Calculates the value this SpringAnimation will have at time.

The time starts at 0 and ends at SpringAnimation:estimated_duration.

See also calculateVelocity(int).

Parameters:

time - elapsed time, in milliseconds

Returns:

the value at time

Since:

1.3

calculateVelocity

public double calculateVelocity(int time)

Calculates the velocity this SpringAnimation will have at time.

The time starts at 0 and ends at SpringAnimation:estimated_duration.

See also calculateValue(int).

Parameters:

time - elapsed time, in milliseconds

Returns:

the velocity at time

Since:

1.3

getClamp

public boolean getClamp()

Gets whether this SpringAnimation should be clamped.

Returns:

whether this SpringAnimation is clamped

getEpsilon

public double getEpsilon()

Gets the precision of the spring.

Returns:

the epsilon value

getEstimatedDuration

public int getEstimatedDuration()

Gets the estimated duration of self, in milliseconds.

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

Returns:

the estimated duration

getInitialVelocity

public double getInitialVelocity()

Gets the initial velocity of self.

Returns:

the initial velocity

getSpringParams

public SpringParams getSpringParams()

Gets the physical parameters of the spring of self.

Returns:

the spring parameters

getValueFrom

public double getValueFrom()

Gets the value this SpringAnimation will animate from.

Returns:

the value to animate from

getValueTo

public double getValueTo()

Gets the value this SpringAnimation will animate to.

Returns:

the value to animate to

getVelocity

public double getVelocity()

Gets the current velocity of self.

Returns:

the current velocity

setClamp

public void setClamp(boolean clamp)

Sets whether this SpringAnimation 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 SpringAnimation:value-from if a relative negative SpringAnimation:initial-velocity is set.

Parameters:

clamp - the new value

setEpsilon

public void setEpsilon(double epsilon)

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.

Parameters:

epsilon - the new value

setInitialVelocity

public void setInitialVelocity(double velocity)

Sets the initial velocity of self.

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

Parameters:

velocity - the initial velocity

setSpringParams

public void setSpringParams(SpringParams springParams)

Sets the physical parameters of the spring of self.

Parameters:

springParams - the new spring parameters

setValueFrom

public void setValueFrom(double value)

Sets the value this SpringAnimation will animate from.

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

Parameters:

value - the value to animate from

setValueTo

public void setValueTo(double value)

Sets the value this SpringAnimation will animate to.

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

Parameters:

value - the value to animate to

builder

public static SpringAnimation.Builder<? extends SpringAnimation.Builder> builder()

A SpringAnimation.Builder object constructs a SpringAnimation with the specified properties. Use the various set...() methods to set properties, and finish construction with SpringAnimation.Builder.build().

Returns:

the builder object