Animation

ABSOLUTE

static val ABSOLUTE: Int

The specified dimension is an absolute number of pixels.

Value: 0

INFINITE

static val INFINITE: Int

Repeat the animation indefinitely.

Value: -1

RELATIVE_TO_PARENT

static val RELATIVE_TO_PARENT: Int

The specified dimension holds a float and should be multiplied by the height or width of the parent of the object being animated.

Value: 2

RELATIVE_TO_SELF

static val RELATIVE_TO_SELF: Int

The specified dimension holds a float and should be multiplied by the height or width of the object being animated.

Value: 1

RESTART

static val RESTART: Int

When the animation reaches the end and the repeat count is INFINTE_REPEAT or a positive value, the animation restarts from the beginning.

Value: 1

REVERSE

static val REVERSE: Int

When the animation reaches the end and the repeat count is INFINTE_REPEAT or a positive value, the animation plays backward (and then forward again).

Value: 2

START_ON_FIRST_FRAME

static val START_ON_FIRST_FRAME: Int

Can be used as the start time to indicate the start time should be the current time when getTransformation(long,android.view.animation.Transformation) is invoked for the first animation frame. This can is useful for short animations.

Value: -1

ZORDER_BOTTOM

static val ZORDER_BOTTOM: Int

Requests that the content being animated be forced under all other content for the duration of the animation.

Value: -1

ZORDER_NORMAL

static val ZORDER_NORMAL: Int

Requests that the content being animated be kept in its current Z order.

Value: 0

ZORDER_TOP

static val ZORDER_TOP: Int

Requests that the content being animated be forced on top of all other content for the duration of the animation.

Value: 1

Animation

Animation()

Creates a new animation with a duration of 0ms, the default interpolator, with fillBefore set to true and fillAfter set to false

Animation

Animation(
    context: Context!, 
    attrs: AttributeSet!)

Creates a new animation whose parameters come from the specified context and attributes set.

cancel

open fun cancel(): Unit

Cancel the animation. Cancelling an animation invokes the animation listener, if set, to notify the end of the animation. If you cancel an animation manually, you must call reset() before starting the animation again.

computeDurationHint

open fun computeDurationHint(): Long

Compute a hint at how long the entire animation may last, in milliseconds. Animations can be written to cause themselves to run for a different duration than what is computed here, but generally this should be accurate.

getBackdropColor

open fun getBackdropColor(): Int

Returns the background color to show behind the animating windows. Will only show the background if showBackdrop was set to true. See setShowBackdrop(boolean).

getBackgroundColor

open fun getBackgroundColor(): Int

Deprecated: None of window animations are running with background color.

Returns the background color behind the animation.

getDetachWallpaper

open fun getDetachWallpaper(): Boolean

Deprecated: All window animations are running with detached wallpaper.

Return value of setDetachWallpaper(boolean).

getDuration

open fun getDuration(): Long

How long this animation should last

getFillAfter

open fun getFillAfter(): Boolean

If fillAfter is true, this animation will apply its transformation after the end time of the animation.

getFillBefore

open fun getFillBefore(): Boolean

If fillBefore is true, this animation will apply its transformation before the start time of the animation. If fillBefore is false and fillEnabled is true, the transformation will not be applied until the start time of the animation.

getInterpolator

open fun getInterpolator(): Interpolator!

Gets the acceleration curve type for this animation.

getRepeatCount

open fun getRepeatCount(): Int

Defines how many times the animation should repeat. The default value is 0.

getRepeatMode

open fun getRepeatMode(): Int

Defines what this animation should do when it reaches the end.

getShowBackdrop

open fun getShowBackdrop(): Boolean

If showBackdrop is true and this animation is applied on a window, then the windows in the animation will animate with the background associated with this window behind them. If no backdrop color is explicitly set, the backdrop's color comes from the android.R.styleable#Theme_colorBackground that is applied to this window through its theme. If multiple animating windows have showBackdrop set to true during an animation, the top most window with showBackdrop set to true and a valid background color takes precedence.

getStartOffset

open fun getStartOffset(): Long

When this animation should start, relative to StartTime

getStartTime

open fun getStartTime(): Long

When this animation should start. If the animation has not startet yet, this method might return START_ON_FIRST_FRAME.

getTransformation

open fun getTransformation(
    currentTime: Long, 
    outTransformation: Transformation!
): Boolean

Gets the transformation to apply at a specified point in time. Implementations of this method should always replace the specified Transformation or document they are doing otherwise.

getTransformation

open fun getTransformation(
    currentTime: Long, 
    outTransformation: Transformation!, 
    scale: Float
): Boolean

Gets the transformation to apply at a specified point in time. Implementations of this method should always replace the specified Transformation or document they are doing otherwise.

getZAdjustment

open fun getZAdjustment(): Int

Returns the Z ordering mode to use while running the animation as previously set by setZAdjustment.

hasEnded

open fun hasEnded(): Boolean

Indicates whether this animation has ended or not.

hasStarted

open fun hasStarted(): Boolean

Indicates whether this animation has started or not.

initialize

open fun initialize(
    width: Int, 
    height: Int, 
    parentWidth: Int, 
    parentHeight: Int
): Unit

Initialize this animation with the dimensions of the object being animated as well as the objects parents. (This is to support animation sizes being specified relative to these dimensions.)

Objects that interpret Animations should call this method when the sizes of the object being animated and its parent are known, and before calling #getTransformation.

isFillEnabled

open fun isFillEnabled(): Boolean

If fillEnabled is true, this animation will apply the value of fillBefore.

isInitialized

open fun isInitialized(): Boolean

Whether or not the animation has been initialized.

reset

open fun reset(): Unit

Reset the initialization state of this animation.

restrictDuration

open fun restrictDuration(durationMillis: Long): Unit

Ensure that the duration that this animation will run is not longer than durationMillis. In addition to adjusting the duration itself, this ensures that the repeat count also will not make it run longer than the given time.

scaleCurrentDuration

open fun scaleCurrentDuration(scale: Float): Unit

How much to scale the duration by.

setAnimationListener

open fun setAnimationListener(listener: Animation.AnimationListener!): Unit

Binds an animation listener to this animation. The animation listener is notified of animation events such as the end of the animation or the repetition of the animation.

setBackdropColor

open fun setBackdropColor(backdropColor: Int): Unit

Set the color to use for the backdrop shown behind the animating windows. Will only show the backdrop if showBackdrop was set to true. See setShowBackdrop(boolean).

setBackgroundColor

open fun setBackgroundColor(bg: Int): Unit

Deprecated: None of window animations are running with background color.

Set background behind animation.

setDetachWallpaper

open fun setDetachWallpaper(detachWallpaper: Boolean): Unit

Deprecated: All window animations are running with detached wallpaper.

If detachWallpaper is true, and this is a window animation of a window that has a wallpaper background, then the window will be detached from the wallpaper while it runs. That is, the animation will only be applied to the window, and the wallpaper behind it will remain static.

setDuration

open fun setDuration(durationMillis: Long): Unit

How long this animation should last. The duration cannot be negative.

setFillAfter

open fun setFillAfter(fillAfter: Boolean): Unit

If fillAfter is true, the transformation that this animation performed will persist when it is finished. Defaults to false if not set. Note that this applies to individual animations and when using an to chain animations.

setFillBefore

open fun setFillBefore(fillBefore: Boolean): Unit

If fillBefore is true, this animation will apply its transformation before the start time of the animation. Defaults to true if setFillEnabled(boolean) is not set to true. Note that this applies when using an to chain animations. The transformation is not applied before the AnimationSet itself starts.

setFillEnabled

open fun setFillEnabled(fillEnabled: Boolean): Unit

If fillEnabled is true, the animation will apply the value of fillBefore. Otherwise, fillBefore is ignored and the animation transformation is always applied until the animation ends.

setInterpolator

open fun setInterpolator(
    context: Context!, 
    resID: Int
): Unit

Sets the acceleration curve for this animation. The interpolator is loaded as a resource from the specified context.

setInterpolator

open fun setInterpolator(i: Interpolator!): Unit

Sets the acceleration curve for this animation. Defaults to a linear interpolation.

setRepeatCount

open fun setRepeatCount(repeatCount: Int): Unit

Sets how many times the animation should be repeated. If the repeat count is 0, the animation is never repeated. If the repeat count is greater than 0 or INFINITE, the repeat mode will be taken into account. The repeat count is 0 by default.

setRepeatMode

open fun setRepeatMode(repeatMode: Int): Unit

Defines what this animation should do when it reaches the end. This setting is applied only when the repeat count is either greater than 0 or INFINITE. Defaults to RESTART.

setShowBackdrop

open fun setShowBackdrop(showBackdrop: Boolean): Unit

If showBackdrop is true and this animation is applied on a window, then the windows in the animation will animate with the background associated with this window behind them. If no backdrop color is explicitly set, the backdrop's color comes from the android.R.styleable#Theme_colorBackground that is applied to this window through its theme. If multiple animating windows have showBackdrop set to true during an animation, the top most window with showBackdrop set to true and a valid background color takes precedence.

setStartOffset

open fun setStartOffset(startOffset: Long): Unit

When this animation should start relative to the start time. This is most useful when composing complex animations using an AnimationSet where some of the animations components start at different times.

setStartTime

open fun setStartTime(startTimeMillis: Long): Unit

When this animation should start. When the start time is set to START_ON_FIRST_FRAME, the animation will start the first time getTransformation(long,android.view.animation.Transformation) is invoked. The time passed to this method should be obtained by calling AnimationUtils.currentAnimationTimeMillis() instead of System.currentTimeMillis().

setZAdjustment

open fun setZAdjustment(zAdjustment: Int): Unit

Set the Z ordering mode to use while running the animation.

start

open fun start(): Unit

Convenience method to start the animation the first time getTransformation(long,android.view.animation.Transformation) is invoked.

startNow

open fun startNow(): Unit

Convenience method to start the animation at the current time in milliseconds.

willChangeBounds

open fun willChangeBounds(): Boolean

Indicates whether or not this animation will affect the bounds of the animated view. For instance, a fade animation will not affect the bounds whereas a 200% scale animation will.

willChangeTransformationMatrix

open fun willChangeTransformationMatrix(): Boolean

Indicates whether or not this animation will affect the transformation matrix. For instance, a fade animation will not affect the matrix whereas a scale animation will.

applyTransformation

protected open fun applyTransformation(
    interpolatedTime: Float, 
    t: Transformation!
): Unit

Helper for getTransformation. Subclasses should implement this to apply their transforms given an interpolation value. Implementations of this method should always replace the specified Transformation or document they are doing otherwise.

clone

protected open fun clone(): Animation

ensureInterpolator

protected open fun ensureInterpolator(): Unit

Gurantees that this animation has an interpolator. Will use a AccelerateDecelerateInterpolator is nothing else was specified.

finalize

protected open fun finalize(): Unit

getScaleFactor

protected open fun getScaleFactor(): Float

The scale factor is set by the call to getTransformation. Overrides of getTransformation(long,android.view.animation.Transformation,float) will get this value directly. Overrides of applyTransformation(float,android.view.animation.Transformation) can call this method to get the value.

resolveSize

protected open fun resolveSize(
    type: Int, 
    value: Float, 
    size: Int, 
    parentSize: Int
): Float

Convert the information in the description of a size to an actual dimension