# MaterialElevationScale

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

*** ** * ** ***


```
public final class MaterialElevationScale
```

<br />

*** ** * ** ***

A android.transition.Visibility transition that scales the size of a surface up or down to emphasize elevation changes.

This can be useful as an exit transition and reenter transition in conjunction with the `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialContainerTransform`.

## Summary

| ### Public fields |
|---|---|
| `final P` | `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialElevationScale#primaryAnimatorProvider()` |
| `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider` | `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialElevationScale#secondaryAnimatorProvider()` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialElevationScale#MaterialElevationScale(boolean)(boolean growing)` |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialElevationScale#addAdditionalAnimatorProvider(com.google.android.material.transition.platform.VisibilityAnimatorProvider)( https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider additionalAnimatorProvider )` Adds an additional `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider`, which provides animators be played together with the primary and secondary `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider`. |
| `void` | `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialElevationScale#clearAdditionalAnimatorProvider()()` Clears all additional `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider` that were previously added. |
| `P` | `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialElevationScale#getPrimaryAnimatorProvider()()` Returns the primary `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider` for this transition, which can be modified but not swapped out completely. |
| `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider` | `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialElevationScale#getSecondaryAnimatorProvider()()` Returns the secondary `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider` for this transition or null, which can be modified or swapped out completely for a different `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider`. |
| `boolean` | `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialElevationScale#isGrowing()()` |
| `Animator` | `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialElevationScale#onAppear(ViewGroup,View,TransitionValues,TransitionValues)( ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues )` |
| `Animator` | `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialElevationScale#onDisappear(ViewGroup,View,TransitionValues,TransitionValues)( ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues )` |
| `boolean` | `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialElevationScale#removeAdditionalAnimatorProvider(com.google.android.material.transition.platform.VisibilityAnimatorProvider)( https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider additionalAnimatorProvider )` Removes an additional `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider` that was previously added. |
| `void` | `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialElevationScale#setSecondaryAnimatorProvider(com.google.android.material.transition.platform.VisibilityAnimatorProvider)( https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider secondaryAnimatorProvider )` Sets the secondary `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider`, which provides animators to be played together with the primary `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider`. |

## Public fields

### primaryAnimatorProvider

```
public final P primaryAnimatorProvider
```

### secondaryAnimatorProvider

```
public VisibilityAnimatorProvider secondaryAnimatorProvider
```

## Public constructors

### MaterialElevationScale

```
public MaterialElevationScale(boolean growing)
```

## Public methods

### addAdditionalAnimatorProvider

```
public void addAdditionalAnimatorProvider(
    VisibilityAnimatorProvider additionalAnimatorProvider
)
```

Adds an additional `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider`, which provides animators be played together with the primary and secondary `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider`.

| See also |
|---|---|
| `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialVisibility#getPrimaryAnimatorProvider()` |   |
| `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialVisibility#getSecondaryAnimatorProvider()` |   |

### clearAdditionalAnimatorProvider

```
public void clearAdditionalAnimatorProvider()
```

Clears all additional `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider` that were previously added.

| See also |
|---|---|
| `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialVisibility#addAdditionalAnimatorProvider(com.google.android.material.transition.platform.VisibilityAnimatorProvider)` |   |

### getPrimaryAnimatorProvider

```
public P getPrimaryAnimatorProvider()
```

Returns the primary `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider` for this transition, which can be modified but not swapped out completely.

### getSecondaryAnimatorProvider

```
public VisibilityAnimatorProvider getSecondaryAnimatorProvider()
```

Returns the secondary `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider` for this transition or null, which can be modified or swapped out completely for a different `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider`.

| See also |
|---|---|
| `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialVisibility#setSecondaryAnimatorProvider(com.google.android.material.transition.platform.VisibilityAnimatorProvider)` |   |

### isGrowing

```
public boolean isGrowing()
```

### onAppear

```
public Animator onAppear(
    ViewGroup sceneRoot,
    View view,
    TransitionValues startValues,
    TransitionValues endValues
)
```

### onDisappear

```
public Animator onDisappear(
    ViewGroup sceneRoot,
    View view,
    TransitionValues startValues,
    TransitionValues endValues
)
```

### removeAdditionalAnimatorProvider

```
public boolean removeAdditionalAnimatorProvider(
    VisibilityAnimatorProvider additionalAnimatorProvider
)
```

Removes an additional `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider` that was previously added.

| See also |
|---|---|
| `https://developer.android.com/reference/com/google/android/material/transition/platform/MaterialVisibility#addAdditionalAnimatorProvider(com.google.android.material.transition.platform.VisibilityAnimatorProvider)` |   |

### setSecondaryAnimatorProvider

```
public void setSecondaryAnimatorProvider(
    VisibilityAnimatorProvider secondaryAnimatorProvider
)
```

Sets the secondary `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider`, which provides animators to be played together with the primary `https://developer.android.com/reference/com/google/android/material/transition/platform/VisibilityAnimatorProvider`.