Package org.gnome.adw

Class Animation

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.adw.Animation

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

Animation.Animation$Impl, SpringAnimation, TimedAnimation

@Generated("io.github.jwharm.JavaGI")
public abstract class Animation
extends GObject

A base class for animations.

AdwAnimation represents an animation on a widget. It has a target that provides a value to animate, and a state indicating whether the animation hasn't been started yet, is playing, paused or finished.

Currently there are two concrete animation types: TimedAnimation and SpringAnimation.

AdwAnimation will automatically skip the animation if Animation:widget is unmapped, or if Gtk.Settings:gtk-enable-animations is FALSE.

The Animation::done signal can be used to perform an action after the animation ends, for example hiding a widget after animating its Gtk.Widget:opacity to 0.

AdwAnimation will be kept alive while the animation is playing. As such, it's safe to create an animation, start it and immediately unref it: A fire-and-forget animation:

static void
 animation_cb (double    value,
               MyObject *self)
 {
   // Do something with @value
 }

 static void
 my_object_animate (MyObject *self)
 {
   AdwAnimationTarget *target =
     adw_callback_animation_target_new ((AdwAnimationTargetFunc) animation_cb,
                                        self, NULL);
   g_autoptr (AdwAnimation) animation =
     adw_timed_animation_new (widget, 0, 1, 250, target);

   adw_animation_play (animation);
 }
 

If there's a chance the previous animation for the same target hasn't yet finished, the previous animation should be stopped first, or the existing AdwAnimation object can be reused.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Animation.Animation$Impl	The Animation$Impl type represents a native instance of the abstract Animation class.
static class	Animation.AnimationClass
static class	Animation.Builder<B extends Animation.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	Animation.DoneCallback	Functional interface declaration of the DoneCallback callback.

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
Animation()	Creates a new Animation.
Animation(MemorySegment address)	Create a Animation proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected Animation	asParent()	Returns this instance as if it were its parent type.
void	emitDone()	Emits the "done" signal.
boolean	getFollowEnableAnimationsSetting()	Gets whether this Animation should be skipped when animations are globally disabled.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
AnimationState	getState()	Gets the current value of self.
AnimationTarget	getTarget()	Gets the target this Animation animates.
static @Nullable Type	getType()	Get the GType of the Animation class
double	getValue()	Gets the current value of self.
Widget	getWidget()	Gets the widget this Animation was created for.
SignalConnection<Animation.DoneCallback>	onDone(Animation.DoneCallback handler)	This signal is emitted when the animation has been completed, either on its own or via calling skip().
void	pause()	Pauses a playing animation for self.
void	play()	Starts the animation for self.
void	reset()	Resets the animation for self.
void	resume()	Resumes a paused animation for self.
void	setFollowEnableAnimationsSetting(boolean setting)	Sets whether to skip this Animation when animations are globally disabled.
void	setTarget(AnimationTarget target)	Sets the target this Animation animates to target.
void	skip()	Skips the animation for self.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, builder, 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

Animation

public Animation(MemorySegment address)

Create a Animation proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Animation

public Animation()

Creates a new Animation.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Animation class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Animation 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 GObject

getFollowEnableAnimationsSetting

public boolean getFollowEnableAnimationsSetting()

Gets whether this Animation should be skipped when animations are globally disabled.

Returns:

whether to follow the global setting

Since:

1.3

getState

public AnimationState getState()

Gets the current value of self.

The state indicates whether this Animation is currently playing, paused, finished or hasn't been started yet.

Returns:

the animation value

getTarget

public AnimationTarget getTarget()

Gets the target this Animation animates.

Returns:

the animation target

getValue

public double getValue()

Gets the current value of self.

Returns:

the current value

getWidget

public Widget getWidget()

Gets the widget this Animation was created for.

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.

Returns:

the animation widget

pause

public void pause()

Pauses a playing animation for self.

Does nothing if the current state of this Animation isn't ADW_ANIMATION_PLAYING.

Sets Animation:state to ADW_ANIMATION_PAUSED.

play

public void play()

Starts the animation for self.

If the animation is playing, paused or has been completed, restarts it from the beginning. This allows to easily play an animation regardless of whether it's already playing or not.

Sets Animation:state to ADW_ANIMATION_PLAYING.

The animation will be automatically skipped if Animation:widget is unmapped, or if Gtk.Settings:gtk-enable-animations is FALSE.

As such, it's not guaranteed that the animation will actually run. For example, when using GLib.idleAdd(int, org.gnome.glib.SourceFunc) and starting an animation immediately afterwards, it's entirely possible that the idle callback will run after the animation has already finished, and not while it's playing.

reset

public void reset()

Resets the animation for self.

Sets Animation:state to ADW_ANIMATION_IDLE.

resume

public void resume()

Resumes a paused animation for self.

This function must only be used if the animation has been paused with pause().

Sets Animation:state to ADW_ANIMATION_PLAYING.

setFollowEnableAnimationsSetting

public void setFollowEnableAnimationsSetting(boolean setting)

Sets whether to skip this 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.Settings:gtk-enable-animations.

Parameters:

setting - whether to follow the global setting

Since:

1.3

setTarget

public void setTarget(AnimationTarget target)

Sets the target this Animation animates to target.

Parameters:

target - an animation target

skip

public void skip()

Skips the animation for self.

If the animation hasn't been started yet, is playing, or is paused, instantly skips the animation to the end and causes Animation::done to be emitted.

Sets Animation:state to ADW_ANIMATION_FINISHED.

onDone

public SignalConnection<Animation.DoneCallback> onDone(Animation.DoneCallback handler)

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

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Animation.DoneCallback.run()

emitDone

public void emitDone()

Emits the "done" signal. See onDone(org.gnome.adw.Animation.DoneCallback).