mosaic-animation/org.unitedsoftware.mosaic.animation/FloatDecayAnimationSpec

FloatDecayAnimationSpec

This animation interface is intended to be stateless, just like Animation. But unlike Animation, DecayAnimation does not have an end value defined. The end value is a result of the animation rather than an input.

Inheritors

FloatExponentialDecaySpec

Properties

absVelocityThreshold

abstract val absVelocityThreshold: Float

This is the absolute value of a velocity threshold, below which the animation is considered finished.

Functions

generateDecayAnimationSpec

fun <T> FloatDecayAnimationSpec.generateDecayAnimationSpec(): DecayAnimationSpec<T>

Creates a DecayAnimationSpec from a org.unitedsoftware.mosaic.animation.FloatDecayAnimationSpec by applying the given org.unitedsoftware.mosaic.animation.FloatDecayAnimationSpec on every dimension of the AnimationVector that T converts to.

getDurationNanos

abstract fun getDurationNanos(initialValue: Float, initialVelocity: Float): Long

Returns the duration of the decay animation, in nanoseconds.

getTargetValue

abstract fun getTargetValue(initialValue: Float, initialVelocity: Float): Float

Returns the target value of the animation based on the starting condition of the animation ( i.e. start value and start velocity).

getValueFromNanos

abstract fun getValueFromNanos(playTimeNanos: Long, initialValue: Float, initialVelocity: Float): Float

Returns the value of the animation at the given time.

getVelocityFromNanos

abstract fun getVelocityFromNanos(playTimeNanos: Long, initialValue: Float, initialVelocity: Float): Float

Returns the velocity of the animation at the given time.