FloatSpringSpec

FloatSpringSpec animation uses a spring animation to animate a Float value. Its configuration can be tuned via adjusting the spring parameters, namely damping ratio and stiffness.

Summary

Public constructors
FloatSpringSpec(
    dampingRatio: Float,
    stiffness: Float,
    visibilityThreshold: Float
)
Cmn

Public functions
open Long
getDurationNanos(
    initialValue: Float,
    targetValue: Float,
    initialVelocity: Float
)

Calculates the duration of an animation.
Cmn
open Float
getEndVelocity(
    initialValue: Float,
    targetValue: Float,
    initialVelocity: Float
)

Calculates the end velocity of the animation with the provided start/end values, and start velocity.
Cmn
open Float
getValueFromNanos(
    playTimeNanos: Long,
    initialValue: Float,
    targetValue: Float,
    initialVelocity: Float
)

Calculates the value of the animation at given the playtime, with the provided start/end values, and start velocity.
Cmn
open Float
getVelocityFromNanos(
    playTimeNanos: Long,
    initialValue: Float,
    targetValue: Float,
    initialVelocity: Float
)

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

Public properties
Float

damping ratio of the spring.
Cmn
Float

Stiffness of the spring.
Cmn

Inherited functions
From androidx.compose.animation.core.FloatAnimationSpec
open VectorizedFloatAnimationSpec<V>

Create an VectorizedAnimationSpec that animates AnimationVector from a FloatAnimationSpec.
Cmn

Public constructors

FloatSpringSpec

Cmn
Added in 1.0.0
FloatSpringSpec(
    dampingRatio: Float = Spring.DampingRatioNoBouncy,
    stiffness: Float = Spring.StiffnessMedium,
    visibilityThreshold: Float = Spring.DefaultDisplacementThreshold
)
Parameters
dampingRatio: Float = Spring.DampingRatioNoBouncy

damping ratio of the spring. Defaults to Spring.DampingRatioNoBouncy
stiffness: Float = Spring.StiffnessMedium

Stiffness of the spring. Defaults to Spring.StiffnessMedium
visibilityThreshold: Float = Spring.DefaultDisplacementThreshold

The value threshold such that the animation is no longer significant. e.g. 1px for translation animations. Defaults to Spring.DefaultDisplacementThreshold

Public functions

getDurationNanos

Cmn 
open 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.

Note: this may be a computation that is expensive - especially with spring based animations

Parameters
initialValue: Float

start value of the animation
targetValue: Float

end value of the animation
initialVelocity: Float

start velocity of the animation

getEndVelocity

Cmn 
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.

Parameters
initialValue: Float

start value of the animation
targetValue: Float

end value of the animation
initialVelocity: Float

start velocity of the animation

getValueFromNanos

Cmn 
open 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.

Parameters
playTimeNanos: Long

time since the start of the animation
initialValue: Float

start value of the animation
targetValue: Float

end value of the animation
initialVelocity: Float

start velocity of the animation

getVelocityFromNanos

Cmn 
open 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.

Parameters
playTimeNanos: Long

time since the start of the animation
initialValue: Float

start value of the animation
targetValue: Float

end value of the animation
initialVelocity: Float

start velocity of the animation

Public properties

dampingRatio

Cmn
Added in 1.0.0
val dampingRatio: Float

damping ratio of the spring. Defaults to Spring.DampingRatioNoBouncy

stiffness

Cmn
Added in 1.0.0
val stiffness: Float

Stiffness of the spring. Defaults to Spring.StiffnessMedium