Rive Android/app.rive.runtime.kotlin.core/LinearAnimationInstance

LinearAnimationInstance

class LinearAnimationInstance(unsafeCppPointer: Long, lock: ReentrantLock, var mix: Float = 1.0f) : PlayableInstance, NativeObject

The LinearAnimationInstance is a helper to wrap common operations to play an animation.

Use this to keep track of an animation's current state and progress. You may also apply changes that the animation makes to components in an Artboard.

Parameters

unsafeCppPointer

Pointer to the C++ counterpart.

Constructors

LinearAnimationInstance

constructor(unsafeCppPointer: Long, lock: ReentrantLock, mix: Float = 1.0f)

Properties

cppPointer

var cppPointer: Long

Getter/Setter for the underlying C++ pointer value.

dependencies

val dependencies: MutableList<RefCount>

direction

var direction: Direction

Configure the animation to play forwards or backwards.

duration

val duration: Int

The duration of an animation in frames. This does not take workStart and workEnd into account.

effectiveDuration

val effectiveDuration: Int

The duration of this animation in frames, taking workStart and workEnd into account.

effectiveDurationInSeconds

val effectiveDurationInSeconds: Float

The duration of an animation in seconds, taking workStart and workEnd into account.

endTime

val endTime: Float

The offset in seconds to the end of the animation.

fps

val fps: Int

Return the frames per second (FPS) configured for this animation.

hasCppObject

val hasCppObject: Boolean

Whether this objects underlying pointer is still valid.

loop

var loop: Loop

Configure the Loop mode for this animation. Can be either Loop.LOOP, Loop.ONESHOT, Loop.PINGPONG or Loop.AUTO.

mix

var mix: Float

name

open override val name: String

The name given to this animation.

refCount

open val refCount: Int

refs

override var refs: AtomicInteger

startTime

val startTime: Float

The offset in seconds to the beginning of the animation. Animations will start playing from here.

time

val time: Float

The elapsed time that this instance has played to.

workEnd

val workEnd: Int

The offset in frames to the end of an animations work area. Animations will execute their loop behavior once this is reached.

workStart

val workStart: Int

The offset in frames to the beginning of an animations work area. Animations will start playing from here.

Functions

acquire

@Synchronized

open override fun acquire(): Int

Increments the references for this counter. Cannot be used for initialization - use refs.incrementAndGet instead.

advance

fun ~~advance~~(elapsedTime: Float): Loop?

Advance the animation.

advanceAndGetResult

fun advanceAndGetResult(elapsedTime: Float): AdvanceResult

Advance the animation and return the result.

apply

fun apply()

Applies the animation instance's current set of transformations to an Artboard.

fun apply(elapsed: Float): Boolean

Applies and advances the animation instance in a single step.

cppDelete

open external override fun cppDelete(pointer: Long)

release

@Synchronized

open override fun release(): Int

Decrements the reference counter.

time

fun time(time: Float)

Seeks the animation to time.