TimeAnimator

Kotlin |Java

open class TimeAnimator : ValueAnimator

kotlin.Any
↳	androidx.core.animation.Animator
	↳	androidx.core.animation.ValueAnimator
		↳	androidx.core.animation.TimeAnimator

This class provides a simple callback mechanism to listeners that is synchronized with all other animators in the system. There is no duration, interpolation, or object value-setting with this Animator. Instead, it is simply started, after which it proceeds to send out events on every animation frame to its TimeListener (if set), with information about this animator, the total elapsed time, and the elapsed time since the previous animation frame.

Summary

Nested classes
abstract	TimeListener Implementors of this interface can set themselves as update listeners to a TimeAnimator instance to receive callbacks on every animation frame to receive the total time since the animator started and the delta time since the last frame.

Inherited constants
From class Animator Long DURATION_INFINITE The value used to indicate infinite duration (e.g. when Animators repeat infinitely).
From class ValueAnimator Int INFINITE This value used used with the setRepeatCount(int) property to repeat the animation indefinitely. Int RESTART When the animation reaches the end and repeatCount is INFINITE or a positive value, the animation restarts from the beginning. Int REVERSE When the animation reaches the end and repeatCount is INFINITE or a positive value, the animation reverses direction on every iteration.

Public constructors
<init>() This class provides a simple callback mechanism to listeners that is synchronized with all other animators in the system.

Public methods
open Unit	setCurrentPlayTime(playTime: Long)
open Unit	setTimeListener(@Nullable listener: TimeAnimator.TimeListener?) Sets a listener that is sent update events throughout the life of an animation.
open Unit	start()

Inherited functions
From class Animator Unit addListener(@NonNull listener: Animator.AnimatorListener) Adds a listener to the set of listeners that are sent events through the life of an animation, such as start, repeat, and end. Unit addPauseListener(@NonNull listener: Animator.AnimatorPauseListener) Adds a pause listener to this animator. Unit addUpdateListener(@NonNull listener: Animator.AnimatorUpdateListener) Adds a listener to the set of listeners that are sent update events through the life of an animation. This method is called on all listeners for every frame of the animation, after the values for the animation have been calculated. Boolean isPaused() Returns whether this animator is currently in a paused state. Unit removeAllListeners() Removes all listeners and pauseListeners from this object. Unit removeAllUpdateListeners() Removes all listeners from the set listening to frame updates for this animation. Unit removeListener(@NonNull listener: Animator.AnimatorListener) Removes a listener from the set listening to this animation. Unit removePauseListener(@NonNull listener: Animator.AnimatorPauseListener) Removes a pause listener from the set listening to this animation. Unit removeUpdateListener(@NonNull listener: Animator.AnimatorUpdateListener) Removes a listener from the set listening to frame updates for this animation. Unit setTarget(@Nullable target: Any?) Sets the target object whose property will be animated by this animation. Not all subclasses operate on target objects (for example, ValueAnimator, but this method is on the superclass for the convenience of dealing generically with those subclasses that do handle targets. Note: The target is stored as a weak reference internally to avoid leaking resources by having animators directly reference old targets. Therefore, you should ensure that animator targets always have a hard reference elsewhere. Unit setupEndValues() This method tells the object to use appropriate information to extract ending values for the animation. For example, a AnimatorSet object will pass this call to its child objects to tell them to set up the values. A ObjectAnimator object will use the information it has about its target object and PropertyValuesHolder objects to get the start values for its properties. A ValueAnimator object will ignore the request since it does not have enough information (such as a target object) to gather these values. Unit setupStartValues() This method tells the object to use appropriate information to extract starting values for the animation. For example, a AnimatorSet object will pass this call to its child objects to tell them to set up the values. A ObjectAnimator object will use the information it has about its target object and PropertyValuesHolder objects to get the start values for its properties. A ValueAnimator object will ignore the request since it does not have enough information (such as a target object) to gather these values.
From class ValueAnimator Boolean areAnimatorsEnabled() Returns whether animators are currently enabled, system-wide. By default, all animators are enabled. This can change if either the user sets a Developer Option to set the animator duration scale to 0 or by Battery Savery mode being enabled (which disables all animations). Developers should not typically need to call this method, but should an app wish to show a different experience when animators are disabled, this return value can be used as a decider of which experience to offer. Unit cancel() ValueAnimator clone() Unit end() Float getAnimatedFraction() Returns the current animation fraction, which is the elapsed/interpolated fraction used in the most recent frame update on the animation. Any getAnimatedValue() The most recent value calculated by this ValueAnimator when there is just one property being animated. This value is only sensible while the animation is running. The main purpose for this read-only property is to retrieve the value from the ValueAnimator during a call to androidx.core.animation.Animator.AnimatorUpdateListener#onAnimationUpdate(Animator), which is called during each animation frame, immediately after the value is calculated. Any? getAnimatedValue(@NonNull propertyName: String) The most recent value calculated by this ValueAnimator for propertyName. The main purpose for this read-only property is to retrieve the value from the ValueAnimator during a call to androidx.core.animation.Animator.AnimatorUpdateListener#onAnimationUpdate(Animator), which is called during each animation frame, immediately after the value is calculated. Long getCurrentPlayTime() Gets the current position of the animation in time, which is equal to the current time minus the time that the animation started. An animation that is not yet started will return a value of zero, unless the animation has has its play time set via setCurrentPlayTime(long) or setCurrentFraction(float), in which case it will return the time that was set. Long getDuration() Gets the length of the animation. The default duration is 300 milliseconds. Long getFrameDelay() The amount of time, in milliseconds, between each frame of the animation. This is a requested time that the animation will attempt to honor, but the actual delay between frames may be different, depending on system load and capabilities. This is a static function because the same delay will be applied to all animations, since they are all run off of a single timing loop. The frame delay may be ignored when the animation system uses an external timing source, such as the display refresh rate (vsync), to govern animations. Note that this method should be called from the same thread that start() is called in order to check the frame delay for that animation. A runtime exception will be thrown if the calling thread does not have a Looper. Interpolator? getInterpolator() Returns the timing interpolator that this ValueAnimator uses. String getNameForTrace() Returns the name of this animator for debugging purposes. Int getRepeatCount() Defines how many times the animation should repeat. The default value is 0. Int getRepeatMode() Defines what this animation should do when it reaches the end. Long getStartDelay() The amount of time, in milliseconds, to delay starting the animation after start() is called. Long getTotalDuration() Array<PropertyValuesHolder!> getValues() Returns the values that this ValueAnimator animates between. These values are stored in PropertyValuesHolder objects, even if the ValueAnimator was created with a simple list of value objects instead. Boolean isRunning() Boolean isStarted() ValueAnimator