lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey
added in API level 21

ViewAnimationUtils

public final class ViewAnimationUtils
extends Object

java.lang.Object
   ↳ android.view.ViewAnimationUtils


Defines common utilities for working with View's animations.

Summary

Public methods

static Animator createCircularReveal(View view, int centerX, int centerY, float startRadius, float endRadius)

Returns an Animator which can animate a clipping circle.

Inherited methods

Public methods

createCircularReveal

added in API level 21
public static Animator createCircularReveal (View view, 
                int centerX, 
                int centerY, 
                float startRadius, 
                float endRadius)

Returns an Animator which can animate a clipping circle.

Any shadow cast by the View will respect the circular clip from this animator.

Only a single non-rectangular clip can be applied on a View at any time. Views clipped by a circular reveal animation take priority over View Outline clipping.

Note that the animation returned here is a one-shot animation. It cannot be re-used, and once started it cannot be paused or resumed. It is also an asynchronous animation that automatically runs off of the UI thread. As a result Animator.AnimatorListener.onAnimationEnd(Animator) will occur after the animation has ended, but it may be delayed depending on thread responsiveness.

Note that if any start delay is set on the reveal animator, the start radius will not be applied to the reveal circle until the start delay has passed. If it's desired to set a start radius on the reveal circle during the start delay, one workaround could be adding an animator with the same start and end radius. For example:


 public static Animator createRevealWithDelay(View view, int centerX, int centerY, float startRadius, float endRadius) {
     Animator delayAnimator = ViewAnimationUtils.createCircularReveal(view, centerX, centerY, startRadius, startRadius);
     delayAnimator.setDuration(delayTimeMS);
     Animator revealAnimator = ViewAnimationUtils.createCircularReveal(view, centerX, centerY, startRadius, endRadius);
     AnimatorSet set = new AnimatorSet();
     set.playSequentially(delayAnimator, revealAnimator);
     return set;
 }
 

Parameters
view View: The View will be clipped to the animating circle.

centerX int: The x coordinate of the center of the animating circle, relative to view.

centerY int: The y coordinate of the center of the animating circle, relative to view.

startRadius float: The starting radius of the animating circle.

endRadius float: The ending radius of the animating circle.

Returns
Animator