SpringAnimation

class SpringAnimation : DynamicAnimation<SpringAnimation!>

kotlin.Any
↳	androidx.dynamicanimation.animation.DynamicAnimation<androidx.dynamicanimation.animation.SpringAnimation>
	↳	androidx.dynamicanimation.animation.SpringAnimation

SpringAnimation is an animation that is driven by a SpringForce. The spring force defines the spring's stiffness, damping ratio, as well as the rest position. Once the SpringAnimation is started, on each frame the spring force will update the animation's value and velocity. The animation will continue to run until the spring force reaches equilibrium. If the spring used in the animation is undamped, the animation will never reach equilibrium. Instead, it will oscillate forever.

To create a simple SpringAnimation that uses the default SpringForce:

// Create an animation to animate view's X property, set the rest position of the
  // default spring to 0, and start the animation with a starting velocity of 5000 (pixel/s).
  final SpringAnimation anim = new SpringAnimation(view, DynamicAnimation.X, 0)
          .setStartVelocity(5000);
  anim.start();
  

Alternatively, a SpringAnimation can take a pre-configured SpringForce, and use that to drive the animation.

// Create a low stiffness, low bounce spring at position 0.
  SpringForce spring = new SpringForce(0)
          .setDampingRatio(SpringForce.DAMPING_RATIO_LOW_BOUNCY)
          .setStiffness(SpringForce.STIFFNESS_LOW);
  // Create an animation to animate view's scaleY property, and start the animation using
  // the spring above and a starting value of 0.5. Additionally, constrain the range of value for
  // the animation to be non-negative, effectively preventing any spring overshoot.
  final SpringAnimation anim = new SpringAnimation(view, DynamicAnimation.SCALE_Y)
          .setMinValue(0).setSpring(spring).setStartValue(1);
  anim.start();
  

Summary

Inherited constants

From class DynamicAnimation Float MIN_VISIBLE_CHANGE_ALPHA The minimum visible change in alpha that can be visible to users. Float MIN_VISIBLE_CHANGE_PIXELS The minimum visible change in pixels that can be visible to users. Float MIN_VISIBLE_CHANGE_ROTATION_DEGREES The minimum visible change in degrees that can be visible to users. Float MIN_VISIBLE_CHANGE_SCALE The minimum visible change in scale that can be visible to users.

Public constructors
<init>(floatValueHolder: FloatValueHolder!) This creates a SpringAnimation that animates a FloatValueHolder instance.
<init>(floatValueHolder: FloatValueHolder!, finalPosition: Float) This creates a SpringAnimation that animates a FloatValueHolder instance.
<init>(object: K, property: FloatPropertyCompat<K>!) This creates a SpringAnimation that animates the property of the given object.
<init>(object: K, property: FloatPropertyCompat<K>!, finalPosition: Float) This creates a SpringAnimation that animates the property of the given object.

Public methods
Unit	animateToFinalPosition(finalPosition: Float) Updates the final position of the spring.
Boolean	canSkipToEnd() Queries whether the spring can eventually come to the rest position.
Unit	cancel() Cancels the on-going animation.
SpringForce!	getSpring() Returns the spring that the animation uses for animations.
SpringAnimation!	setSpring(force: SpringForce!) Uses the given spring as the force that drives this animation.
Unit	skipToEnd() Skips to the end of the animation.
Unit	start()

Inherited functions

From class DynamicAnimation T addEndListener(listener: DynamicAnimation.OnAnimationEndListener!) Adds an end listener to the animation for receiving onAnimationEnd callbacks. If the listener is null or has already been added to the list of listeners for the animation, no op. T addUpdateListener(listener: DynamicAnimation.OnAnimationUpdateListener!) Adds an update listener to the animation for receiving per-frame animation update callbacks. If the listener is null or has already been added to the list of listeners for the animation, no op. Note that update listener should only be added before the start of the animation. Float getMinimumVisibleChange() Returns the minimum change in the animation property that could be visibly different to users. Boolean isRunning() Returns whether the animation is currently running. Unit removeEndListener(listener: DynamicAnimation.OnAnimationEndListener!) Removes the end listener from the animation, so as to stop receiving animation end callbacks. Unit removeUpdateListener(listener: DynamicAnimation.OnAnimationUpdateListener!) Removes the update listener from the animation, so as to stop receiving animation update callbacks. T setMaxValue(max: Float) Sets the max value of the animation. Animations will not animate beyond their max value. Whether or not animation will come to an end when max value is