AnimatedFloat

Kotlin |Java

abstract class AnimatedFloat : BaseAnimatedValue<Float, AnimationVector1D>

kotlin.Any
↳	androidx.animation.BaseAnimatedValue<kotlin.Float, androidx.animation.AnimationVector1D>
	↳	androidx.animation.AnimatedFloat

Known Direct Subclasses

AnimatedFloatModel

Model class for AnimatedFloat.

This class inherits most of the functionality from BaseAnimatedValue. In addition, it tracks velocity and supports the definition of bounds. Once bounds are defined using setBounds, the animation will consider itself finished when it reaches the upper or lower bound, even when the velocity is non-zero.

Summary

Public constructors
`<init>(clock: AnimationClockObservable, visibilityThreshold: Float = Spring.DefaultDisplacementThreshold)` This class inherits most of the functionality from BaseAnimatedValue.

Public methods
Unit	`setBounds(min: Float = Float.NEGATIVE_INFINITY, max: Float = Float.POSITIVE_INFINITY)` Sets up the bounds that the animation should be constrained to.
open Unit	`snapTo(targetValue: Float)` Sets the current value to the target value immediately, without any animation.

Protected methods
open Unit	`checkFinished(playtime: Long)`

Inherited functions

From class BaseAnimatedValue

Unit

animateTo(targetValue: T, anim: AnimationSpec<T> = defaultSpringSpec, onEnd: (AnimationEndReason, T) -> Unit = null)

Sets the target value, which effectively starts an animation to change the value from value to the target value. If there is already an animation in flight, this method will interrupt the ongoing animation, invoke onEnd that is associated with that animation, and start a new animation from the current value to the new target value.

Unit

stop()

Stops any on-going animation. No op if no animation is running. Note that this method does not skip the animation value to its target value. Rather the animation will be stopped in its track.

Extension functions

From androidx.animation

Unit	`AnimatedFloat.fling(startVelocity: Float, decay: FloatDecayAnimationSpec = ExponentialDecay(), onEnd: OnAnimationEnd? = null)` Starts a fling animation with the specified starting velocity.
Unit	`AnimatedFloat.fling(startVelocity: Float, decay: FloatDecayAnimationSpec = ExponentialDecay(), adjustTarget: (Float) -> TargetAnimation?, onEnd: OnAnimationEnd? = null)` Starts a fling animation with the specified starting velocity.

From androidx.ui.foundation.animation

Unit	`AnimatedFloat.fling(startVelocity: Float, config: FlingConfig, onAnimationEnd: OnAnimationEnd? = null)` Starts a fling animation with the specified starting velocity and fling configuration.

Properties
Float	`max` Upper bound of the animation value.
Float	`min` Lower bound of the animation value.
Float	`velocity`

Inherited properties

From class BaseAnimatedValue

Boolean

isRunning

Indicates whether the animation is running.

T

targetValue

The target of the current animation. This target will not be the same as the value of the animation, until the animation finishes un-interrupted.

T

value

Current value of the animation.

Public constructors

<init>

AnimatedFloat(
    clock: AnimationClockObservable, 
    visibilityThreshold: Float = Spring.DefaultDisplacementThreshold)

Parameters
clock: AnimationClockObservable	An animation clock observable controlling the progression of the animated value
visibilityThreshold: Float = Spring.DefaultDisplacementThreshold	Threshold at which the animation may round off to its target value.

Public methods

setBounds

fun setBounds(
    min: Float = Float.NEGATIVE_INFINITY, 
    max: Float = Float.POSITIVE_INFINITY
): Unit

Sets up the bounds that the animation should be constrained to. When the animation reaches the bounds it will stop right away, even when there is remaining velocity. Setting a range will immediately clamp the current value to the new range. Therefore it is not recommended to change bounds in a way that immediately changes current value during an animation, as it would result in a discontinuous animation.

Parameters
min: Float = Float.NEGATIVE_INFINITY	Lower bound of the animation value. Defaults to Float.NEGATIVE_INFINITY
max: Float = Float.POSITIVE_INFINITY	Upper bound of the animation value. Defaults to Float.POSITIVE_INFINITY

snapTo

open fun snapTo(targetValue: Float): Unit

Sets the current value to the target value immediately, without any animation.

Parameters
targetValue: Float	The new target value to set value to.

Protected methods

checkFinished

protected open fun checkFinished(playtime: Long): Unit

Properties

max

var max: Float

Upper bound of the animation value. When animations reach this upper bound, it will automatically stop with AnimationEndReason being AnimationEndReason.BoundReached. This bound is Float.POSITIVE_INFINITY by default. It can be adjusted via setBounds.

min

var min: Float

Lower bound of the animation value. When animations reach this lower bound, it will automatically stop with AnimationEndReason being AnimationEndReason.BoundReached. This bound is Float.NEGATIVE_INFINITY by default. It can be adjusted via setBounds.

velocity

val velocity: Float