WindowInsetsAnimationCompat
class WindowInsetsAnimationCompat
Class representing an animation of a set of windows that cause insets.
Summary
Nested types |
|---|
|
Class representing the range of an |
abstract class WindowInsetsAnimationCompat.CallbackInterface that allows the application to listen to animation events for windows that cause insets. |
Public constructors |
|---|
WindowInsetsAnimationCompat(Creates a new |
Public functions |
|
|---|---|
@FloatRange(from = 0.0, to = 1.0) Float |
getAlpha()Retrieves the translucency of the windows that are animating. |
Long |
|
@FloatRange(from = 0.0, to = 1.0) Float |
Returns the raw fractional progress of this animation between start state of the animation and the end state of the animation. |
Float |
Returns the interpolated fractional progress of this animation between start state of the animation and the end state of the animation. |
Interpolator? |
Retrieves the interpolator used for this animation, or |
Int |
|
Unit |
setAlpha(alpha: @FloatRange(from = 0.0, to = 1.0) Float)Sets the translucency of the windows that are animating. |
Unit |
setFraction(fraction: @FloatRange(from = 0.0, to = 1.0) Float)Set fraction of the progress if |
Public constructors
WindowInsetsAnimationCompat
WindowInsetsAnimationCompat(
typeMask: Int,
interpolator: Interpolator?,
durationMillis: Long
)
Creates a new WindowInsetsAnimationCompat object.
This should only be used for testing, as usually the system creates this object for the application to listen to with WindowInsetsAnimationCompat.Callback.
| Parameters | |
|---|---|
typeMask: Int |
The bitmask of |
interpolator: Interpolator? |
The interpolator of the animation. |
durationMillis: Long |
The duration of the animation in |
Public functions
getAlpha
fun getAlpha(): @FloatRange(from = 0.0, to = 1.0) Float
Retrieves the translucency of the windows that are animating.
| Returns | |
|---|---|
@FloatRange(from = 0.0, to = 1.0) Float |
Alpha of windows that cause insets of type |
getDurationMillis
fun getDurationMillis(): Long
| Returns | |
|---|---|
Long |
duration of animation in |
getFraction
fun getFraction(): @FloatRange(from = 0.0, to = 1.0) Float
Returns the raw fractional progress of this animation between start state of the animation and the end state of the animation. Note that this progress is the global progress of the animation, whereas onProgress will only dispatch the insets that may be inset with inset by parents of views in the hierarchy. Progress per insets animation is global for the entire animation. One animation animates all things together (in, out, ...). If they don't animate together, we'd have multiple animations.
Note: In case the application is controlling the animation, the valued returned here will be the same as the application passed into setInsetsAndAlpha.
| Returns | |
|---|---|
@FloatRange(from = 0.0, to = 1.0) Float |
The current progress of this animation. |
getInterpolatedFraction
fun getInterpolatedFraction(): Float
Returns the interpolated fractional progress of this animation between start state of the animation and the end state of the animation. Note that this progress is the global progress of the animation, whereas onProgress will only dispatch the insets that may be inset with inset by parents of views in the hierarchy. Progress per insets animation is global for the entire animation. One animation animates all things together (in, out, ...). If they don't animate together, we'd have multiple animations.
Note: In case the application is controlling the animation, the valued returned here will be the same as the application passed into setInsetsAndAlpha, interpolated with the interpolator passed into controlWindowInsetsAnimation.
Note: For system-initiated animations, this will always return a valid value between 0 and 1.
| Returns | |
|---|---|
Float |
The current interpolated progress of this animation. |
| See also | |
|---|---|
getFraction |
for raw fraction. |
getInterpolator
fun getInterpolator(): Interpolator?
Retrieves the interpolator used for this animation, or null if this animation doesn't follow an interpolation curved. For system-initiated animations, this will never return null.
| Returns | |
|---|---|
Interpolator? |
The interpolator used for this animation. |
setAlpha
fun setAlpha(alpha: @FloatRange(from = 0.0, to = 1.0) Float): Unit
Sets the translucency of the windows that are animating.
Note: This should only be used for testing, as the system fills in the alpha for the application or the alpha that was passed into setInsetsAndAlpha is being used.
| Parameters | |
|---|---|
alpha: @FloatRange(from = 0.0, to = 1.0) Float |
Alpha of windows that cause insets of type |
| See also | |
|---|---|
getAlpha |
setFraction
fun setFraction(fraction: @FloatRange(from = 0.0, to = 1.0) Float): Unit
Set fraction of the progress if Type animation is controlled by the app.
Note: This should only be used for testing, as the system fills in the fraction for the application or the fraction that was passed into setInsetsAndAlpha is being used.
| Parameters | |
|---|---|
fraction: @FloatRange(from = 0.0, to = 1.0) Float |
fractional progress between 0 and 1 where 0 represents hidden and zero progress and 1 represent fully shown final state. |
| See also | |
|---|---|
getFraction |