adwaita/org.gtkkn.bindings.adw/TimedAnimation

TimedAnimation

class TimedAnimation(pointer: <Error class: unknown class><<Error class: unknown class>>) : Animation

A time-based class@Animation.

AdwTimedAnimation implements a simple animation interpolating the given value from property@TimedAnimation:value-from to property@TimedAnimation:value-to over property@TimedAnimation:duration milliseconds using the curve described by property@TimedAnimation:easing.

If property@TimedAnimation:reverse is set to TRUE, AdwTimedAnimation will instead animate from property@TimedAnimation:value-to to property@TimedAnimation:value-from, and the easing curve will be inverted.

The animation can repeat a certain amount of times, or endlessly, depending on the property@TimedAnimation:repeat-count value. If property@TimedAnimation:alternate is set to TRUE, it will also change the direction every other iteration.

Constructors

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

Creates a new AdwTimedAnimation on @widget to animate @target from @from to @to.

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>>

adwTimedAnimationPointer

val adwTimedAnimationPointer: <Error class: unknown class><<Error class: unknown class>>

var alternate: Boolean

Whether the animation changes direction on every iteration.

var duration: <Error class: unknown class>

Duration of the animation, in milliseconds.

var easing: Easing

Easing function used in the animation.

followEnableAnimationsSetting

open var followEnableAnimationsSetting: Boolean

Whether to skip the animation when animations are globally disabled.

var repeatCount: <Error class: unknown class>

Number of times the animation will play.

var reverse: Boolean

Whether the animation plays backwards.

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.

open val widget: <Error class: unknown class>

The animation widget.

Functions

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 getAlternate(): Boolean

Gets whether @self changes direction on every iteration.

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

Gets the duration of @self.

fun getEasing(): Easing

Gets the easing function @self uses.

getFollowEnableAnimationsSetting

open fun getFollowEnableAnimationsSetting(): Boolean

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

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

Gets the number of times @self will play.

fun getReverse(): Boolean

Gets whether @self plays backwards.

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.

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 setAlternate(alternate: Boolean)

Sets whether @self changes direction on every iteration.

fun setDuration(duration: <Error class: unknown class>)

Sets the duration of @self.

fun setEasing(easing: Easing)

Sets the easing function @self will use.

setFollowEnableAnimationsSetting

open fun setFollowEnableAnimationsSetting(setting: Boolean)

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

fun setRepeatCount(repeatCount: <Error class: unknown class>)

Sets the number of times @self will play.

fun setReverse(reverse: Boolean)

Sets whether @self plays backwards.

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.