sceneview/io.github.sceneview.animation/AnimatableModel

AnimatableModel

An AnimatableModel is an object whose properties can be animated by an ModelAnimation. The object animation transformation can be done at the desired frame callback place. ModelAnimation updates the value (like in a standard context) or to apply them inside a global/common frame callback.

An AnimatableModel can, for example, update the data of each animated property managed by an com.google.android.filament.gltfio.Animator.

Inheritors

RenderableInstance

Functions

animate

open fun animate(repeat: Boolean): ObjectAnimator

Constructs and returns an ObjectAnimator for all ModelAnimation of this object.

open fun animate(animationIndexes: Array<Int>): ObjectAnimator

Constructs and returns an ObjectAnimator for targeted ModelAnimation with a a given index of this object.

open fun animate(animations: Array<ModelAnimation>): ObjectAnimator

Constructs and returns an ObjectAnimator for a targeted ModelAnimation of this object.

open fun animate(animationNames: Array<String>): ObjectAnimator

Constructs and returns an ObjectAnimator for targeted ModelAnimation with a given name of this object.

applyAnimationChange

abstract fun applyAnimationChange(animation: ModelAnimation): Boolean

Occurs when a ModelAnimation has received any property changed.

getAnimation

abstract fun getAnimation(animationIndex: Int): ModelAnimation

Get the associated ModelAnimation at the given index or throw an IndexOutOfBoundsException.

open fun getAnimation(name: String): ModelAnimation

Get the associated ModelAnimation by name or null if none exist with the given name.

getAnimationCount

abstract fun getAnimationCount(): Int

Returns the number of ModelAnimation definitions in the model.

getAnimationIndex

open fun getAnimationIndex(name: String): Int

Get the Zero-based index for the animation name of interest or -1 if not found.

getAnimationName

open fun getAnimationName(animationIndex: Int): String

Get the name of the ModelAnimation at the Zero-based index This name corresponds to the one defined and exported in the renderable asset.

getAnimationNames

open fun getAnimationNames(): List<String>

Get the names of the ModelAnimation This names correspond to the ones defined and exported in the renderable asset.

getAnimationOrThrow

open fun getAnimationOrThrow(name: String): ModelAnimation

Get the associated ModelAnimation by name or throw an Exception if none exist with the given name.

hasAnimations

open fun hasAnimations(): Boolean

Return true if getAnimationCount>0

onModelAnimationChanged

open fun onModelAnimationChanged(animation: ModelAnimation)

Called form the ModelAnimation when it dirty state changed.

setAnimationsFramePosition

open fun setAnimationsFramePosition(framePosition: Int)

Sets the current position of (seeks) all the animations to the specified frame number according to the getFrameRate This method will apply rotation, translation, and scale to the Renderable that have been targeted.

setAnimationsTimePosition

open fun setAnimationsTimePosition(timePosition: Float)

Sets the current position of (seeks) the animation to the specified time position in seconds.