Animation

Object Hierarchy:

Description:

[ CCode ( type_id = "bis_animation_get_type ()" ) ]
[ Version ( since = "1.0" ) ]
public abstract class Animation : Object

A base class for animations.

`BisAnimation` 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: [class@TimedAnimation] and [class@SpringAnimation].

`BisAnimation` will automatically skip the animation if [property@Animation:widget] is unmapped, or if [ property@Gtk.Settings:gtk-enable-animations] is `FALSE`.

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

`BisAnimation` 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:

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

static void my_object_animate (MyObject *self) { BisAnimationTarget *target = bis_callback_animation_target_new (( BisAnimationTargetFunc) animation_cb, self, NULL); g_autoptr (BisAnimation) animation = bis_timed_animation_new (widget, 0, 1, 250, target);

bis_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 `BisAnimation` object can be reused.

All known sub-classes:

SpringAnimation

TimedAnimation

Namespace: Bis

Package: libbismuth-1

Content:

Properties:

public AnimationState state { get; }
The animation state.
public AnimationTarget target { get; set construct; }
The target to animate.
public double value { get; }
The current value of the animation.
public Widget widget { get; construct; }
The animation widget.

Creation methods:

protected Animation ()

Methods:

public AnimationState get_state ()
Gets the current value of this.
public unowned AnimationTarget get_target ()
Gets the target this animates.
public double get_value ()
Gets the current value of this.
public unowned Widget get_widget ()
Gets the widget this was created for.
public void pause ()
Pauses a playing animation for this.
public void play ()
Starts the animation for this.
public void reset ()
Resets the animation for this.
public void resume ()
Resumes a paused animation for this.
public void set_target (AnimationTarget target)
Sets the target this animates to target.
public void skip ()
Skips the animation for this.

Signals:

public signal void done ()
This signal is emitted when the animation has been completed, either on its own or via calling [method@Animation.

Inherited Members:

All known members inherited from class GLib.Object