RepeatableSpec

Artifact: androidx.compose.animation:animation-core

View Source

Added in 1.0.0

Common/All

• Cmn

  class RepeatableSpec<T : Any?> : FiniteAnimationSpec

---

RepeatableSpec takes another DurationBasedAnimationSpec and plays it iterations times. For creating infinitely repeating animation spec, consider using InfiniteRepeatableSpec.

Note: When repeating in the RepeatMode.Reverse mode, it's highly recommended to have an odd number of iterations. Otherwise, the animation may jump to the end value when it finishes the last iteration.

initialStartOffset can be used to either delay the start of the animation or to fast forward the animation to a given play time. This start offset will not be repeated, whereas the delay in the animation (if any) will be repeated. By default, the amount of offset is 0.

See also
repeatable
InfiniteRepeatableSpec
infiniteRepeatable

Summary

Public constructors
<T : Any?> RepeatableSpec(     iterations: Int,     animation: DurationBasedAnimationSpec<T>,     repeatMode: RepeatMode,     initialStartOffset: StartOffset )	Cmn

Public functions
open operator Boolean	equals(other: Any?)	Cmn
open Int	hashCode()	Cmn
open VectorizedFiniteAnimationSpec<V>	<V : AnimationVector> vectorize(converter: TwoWayConverter<T, V>) Creates a VectorizedAnimationSpec with the given TwoWayConverter.	Cmn

Public properties
DurationBasedAnimationSpec<T>	animation the AnimationSpec to be repeated	Cmn
StartOffset	initialStartOffset offsets the start of the animation	Cmn
Int	iterations the count of iterations.	Cmn
RepeatMode	repeatMode whether animation should repeat by starting from the beginning (i.e. RepeatMode.Restart) or from the end (i.e. RepeatMode.Reverse)	Cmn

Public constructors

RepeatableSpec

Cmn

<T : Any?> RepeatableSpec(
    iterations: Int,
    animation: DurationBasedAnimationSpec<T>,
    repeatMode: RepeatMode = RepeatMode.Restart,
    initialStartOffset: StartOffset = StartOffset(0)
)

Parameters
iterations: Int	the count of iterations. Should be at least 1.
animation: DurationBasedAnimationSpec<T>	the AnimationSpec to be repeated
repeatMode: RepeatMode = RepeatMode.Restart	whether animation should repeat by starting from the beginning (i.e. RepeatMode.Restart) or from the end (i.e. RepeatMode.Reverse)
initialStartOffset: StartOffset = StartOffset(0)	offsets the start of the animation

Public functions

equals

Cmn

open operator fun equals(other: Any?): Boolean

hashCode

Cmn

open fun hashCode(): Int

vectorize

Cmn

open fun <V : AnimationVector> vectorize(converter: TwoWayConverter<T, V>): VectorizedFiniteAnimationSpec<V>

Creates a VectorizedAnimationSpec with the given TwoWayConverter.

The underlying animation system operates on AnimationVectors. T will be converted to AnimationVector to animate. VectorizedAnimationSpec describes how the converted AnimationVector should be animated. E.g. The animation could simply interpolate between the start and end values (i.e.TweenSpec), or apply spring physics to produce the motion (i.e. SpringSpec), etc)

Parameters
converter: TwoWayConverter<T, V>	converts the type T from and to AnimationVector type

Public properties

animation

Cmn

Added in 1.0.0

val animation: DurationBasedAnimationSpec<T>

the AnimationSpec to be repeated

initialStartOffset

Cmn

Added in 1.1.0

val initialStartOffset: StartOffset

offsets the start of the animation

iterations

Cmn

Added in 1.0.0

val iterations: Int

the count of iterations. Should be at least 1.

repeatMode

Cmn

Added in 1.0.0

val repeatMode: RepeatMode

whether animation should repeat by starting from the beginning (i.e. RepeatMode.Restart) or from the end (i.e. RepeatMode.Reverse)