VectorizedDurationBasedAnimationSpec

Kotlin |Java

interface VectorizedDurationBasedAnimationSpec<V : AnimationVector> : VectorizedAnimationSpec<V>

androidx.compose.animation.core.VectorizedDurationBasedAnimationSpec

Known Direct Subclasses VectorizedKeyframesSpec, VectorizedSnapSpec, VectorizedTweenSpec VectorizedKeyframesSpec VectorizedKeyframesSpec class manages the animation based on the values defined at different timestamps in the duration of the animation (i. VectorizedSnapSpec VectorizedSnapSpec immediately snaps the animating value to the end value. VectorizedTweenSpec VectorizedTweenSpec animates a AnimationVector value by interpolating the start and end value, in the given durationMillis using the given easing curve.

Base class for VectorizedAnimationSpecs that are based on a fixed durationMillis.

Summary

Public methods
open Long	getDurationMillis(start: V, end: V, startVelocity: V) Calculates the duration of an animation.

Inherited functions

From class VectorizedAnimationSpec V getEndVelocity(start: V, end: V, startVelocity: V) Calculates the end velocity of the animation with the provided start/end values, and start velocity. For duration-based animations, end velocity will be the velocity of the animation at the duration time. This is also the default assumption. However, for physics-based animations, end velocity is an AnimationVector of 0s. V getValue(playTime: Long, start: V, end: V, startVelocity: V) Calculates the value of the animation at given the playtime, with the provided start/end values, and start velocity. V getVelocity(playTime: Long, start: V, end: V, startVelocity: V) Calculates the velocity of the animation at given the playtime, with the provided start/end values, and start velocity.

Properties
abstract Int	delayMillis delay defines the amount of time that animation can be delayed.
abstract Int	durationMillis duration is the amount of time while animation is not yet finished.

Public methods

getDurationMillis

open fun getDurationMillis(
    start: V, 
    end: V, 
    startVelocity: V
): Long

Calculates the duration of an animation. For duration-based animations, this will return the pre-defined duration. For physics-based animations, the duration will be estimated based on the physics configuration (such as spring stiffness, damping ratio, visibility threshold) as well as the start, end values, and startVelocity.

Parameters
start: V	start value of the animation
end: V	end value of the animation
startVelocity: V	start velocity of the animation

Properties

delayMillis

abstract val delayMillis: Int

delay defines the amount of time that animation can be delayed.

durationMillis

abstract val durationMillis: Int

duration is the amount of time while animation is not yet finished.