mosaic-animation/com.jakewharton.mosaic.animation/FloatTweenSpec

FloatTweenSpec

class FloatTweenSpec(val duration: Int = DefaultDurationMillis, val delay: Int = 0, easing: Easing = FastOutSlowInEasing) : FloatAnimationSpec

FloatTweenSpec animates a Float value from any start value to any end value using a provided easing function. The animation will finish within the duration time. Unless a delay is specified, the animation will start right away.

Parameters

duration

the amount of time (in milliseconds) the animation will take to finish. Defaults to DefaultDurationMillis

delay

the amount of time the animation will wait before it starts running. Defaults to 0.

easing

the easing function that will be used to interoplate between the start and end value of the animation. Defaults to FastOutSlowInEasing.

Constructors

FloatTweenSpec

constructor(duration: Int = DefaultDurationMillis, delay: Int = 0, easing: Easing = FastOutSlowInEasing)

Properties

delay

val delay: Int = 0

duration

val duration: Int

Functions

getDurationNanos

open override fun getDurationNanos(initialValue: Float, targetValue: Float, initialVelocity: Float): 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 initialValue, targetValue values, and initialVelocity.

getEndVelocity

open fun getEndVelocity(initialValue: Float, targetValue: Float, initialVelocity: Float): Float

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 spring animations, the transient trailing velocity will be snapped to zero.

getValueFromNanos

open override fun getValueFromNanos(playTimeNanos: Long, initialValue: Float, targetValue: Float, initialVelocity: Float): Float

Calculates the value of the animation at given the playtime, with the provided start/end values, and start velocity.

getVelocityFromNanos

open override fun getVelocityFromNanos(playTimeNanos: Long, initialValue: Float, targetValue: Float, initialVelocity: Float): Float

Calculates the velocity of the animation at given the playtime, with the provided start/end values, and start velocity.

vectorize

open override fun <V : AnimationVector> vectorize(converter: TwoWayConverter<Float, V>): VectorizedFloatAnimationSpec<V>

Create an com.jakewharton.mosaic.animation.VectorizedAnimationSpec that animates AnimationVector from a FloatAnimationSpec. Every dimension of the AnimationVector will be animated using the given FloatAnimationSpec.