# CircularRevealCompat

[View Source](https://github.com/material-components/material-components-android/blob/1.14.0/lib/java/com/google/android/material/circularreveal/CircularRevealCompat.java)

*** ** * ** ***


```
public final class CircularRevealCompat
```

<br />

*** ** * ** ***

Defines compat implementations of circular reveal animations.

| See also |
|---|---|
| `https://developer.android.com/reference/[JVM root]/ViewAnimationUtils` |   |

## Summary

| ### Public methods |
|---|---|
| `static Animator` | `https://developer.android.com/reference/com/google/android/material/circularreveal/CircularRevealCompat#createCircularReveal(com.google.android.material.circularreveal.CircularRevealWidget,float,float,float)( https://developer.android.com/reference/com/google/android/material/circularreveal/CircularRevealWidget view, float centerX, float centerY, float endRadius )` Returns an Animator to animate a clipping circle. |
| `static Animator` | `https://developer.android.com/reference/com/google/android/material/circularreveal/CircularRevealCompat#createCircularReveal(com.google.android.material.circularreveal.CircularRevealWidget,float,float,float,float)( https://developer.android.com/reference/com/google/android/material/circularreveal/CircularRevealWidget view, float centerX, float centerY, float startRadius, float endRadius )` Returns an Animator to animate a clipping circle. |
| `static AnimatorListener` | `https://developer.android.com/reference/com/google/android/material/circularreveal/CircularRevealCompat#createCircularRevealListener(com.google.android.material.circularreveal.CircularRevealWidget)(https://developer.android.com/reference/com/google/android/material/circularreveal/CircularRevealWidget view)` Creates an AnimatorListener to be applied to either the Animator returned from createCircularReveal or preferably to the overall AnimatorSet. |

## Public methods

### createCircularReveal

```
public static Animator createCircularReveal(
    CircularRevealWidget view,
    float centerX,
    float centerY,
    float endRadius
)
```

Returns an Animator to animate a clipping circle. The startRadius will be the current `https://developer.android.com/reference/com/google/android/material/circularreveal/CircularRevealWidget#getRevealInfo()`'s `https://developer.android.com/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo#radius()` at the start of the animation.

This is meant to be used as a drop-in replacement for createCircularReveal. In pre-L APIs, a backwards compatible version of the Animator will be returned.

You must also call `https://developer.android.com/reference/com/google/android/material/circularreveal/CircularRevealCompat#createCircularRevealListener(com.google.android.material.circularreveal.CircularRevealWidget)` and add the returned AnimatorListener to this Animator or preferably to the overall AnimatorSet.

### createCircularReveal

```
public static Animator createCircularReveal(
    CircularRevealWidget view,
    float centerX,
    float centerY,
    float startRadius,
    float endRadius
)
```

Returns an Animator to animate a clipping circle.

This is meant to be used as a drop-in replacement for createCircularReveal. In pre-L APIs, a backwards compatible version of the Animator will be returned.

You must also call `https://developer.android.com/reference/com/google/android/material/circularreveal/CircularRevealCompat#createCircularRevealListener(com.google.android.material.circularreveal.CircularRevealWidget)` and add the returned AnimatorListener to this Animator or preferably to the overall AnimatorSet.

### createCircularRevealListener

```
public static AnimatorListener createCircularRevealListener(CircularRevealWidget view)
```

Creates an AnimatorListener to be applied to either the Animator returned from createCircularReveal or preferably to the overall AnimatorSet.