TestAnimationClock

Kotlin |Java

interface TestAnimationClock : AnimationClockObservable

androidx.compose.ui.test.TestAnimationClock

Interface for animation clocks that can report their idleness and can switch between ticking automatically (e.g., if it's driven by the main loop of the host) and ticking manually.

An idle clock is one that is currently not driving any animations. Typically, that means a clock where no observers are registered. The idleness can be retrieved by isIdle.

Use pauseClock to switch from automatic ticking to manual ticking, resumeClock to switch from manual to automatic with; and manually tick the clock with advanceClock.

Summary

Public methods
abstract Unit	`advanceClock(milliseconds: Long)` Advances the clock by the given number of milliseconds.
abstract Unit	`pauseClock()` Pauses the automatic ticking of the clock.
abstract Unit	`resumeClock()` Resumes the automatic ticking of the clock.

Inherited functions

From class AnimationClockObservable

Unit

subscribe(observer: AnimationClockObserver)

Subscribes an observer to the animation clock source.

Observers may only be added to a clock once. Calls to add the same observer more than once will be ignored, and a single call to unsubscribe will unregister from further callbacks.

Unit

unsubscribe(observer: AnimationClockObserver)

Unsubscribes an observer from the animation clock.

Observers may only be added to a clock once. If subscribe has been called multiple times with the same observer, a single call to this method will unregister the observer completely.

Inherited extension functions

From androidx.compose.animation

DisposableAnimationClock

AnimationClockObservable.asDisposableClock()

Return a new AnimationClockObservable wrapping this one that will auto-unsubscribe all AnimationClockObservers when this call leaves the composition, preventing clock subscriptions from persisting beyond the composition lifecycle.

Properties
abstract Boolean	`isIdle` Whether the clock is idle or not.
abstract Boolean	`isPaused` Whether the clock is paused or not.

Public methods

advanceClock

abstract fun advanceClock(milliseconds: Long): Unit

Advances the clock by the given number of milliseconds. It is safe to call this method both when the clock is paused and resumed.

pauseClock

abstract fun pauseClock(): Unit

Pauses the automatic ticking of the clock. The clock shall only tick in response to advanceClock, and shall continue ticking automatically when resumeClock is called. It's safe to call this method when the clock is already paused.

resumeClock

abstract fun resumeClock(): Unit

Resumes the automatic ticking of the clock. It's safe to call this method when the clock is already resumed.

Properties

isIdle

abstract val isIdle: Boolean

Whether the clock is idle or not. An idle clock is one that is not driving animations, which happens (1) when no observers are observing this clock, or (2) when the clock is paused.

isPaused

abstract val isPaused: Boolean

Whether the clock is paused or not.