MaterialElevationScale

public final class MaterialElevationScale
extends Visibility

java.lang.Object
   ↳ android.transition.Transition
     ↳ android.transition.Visibility
       ↳ com.google.android.material.transition.platform.MaterialElevationScale


A 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 MaterialContainerTransform.

Summary

Inherited constants

Public constructors

MaterialElevationScale(boolean growing)

Public methods

void addAdditionalAnimatorProvider(VisibilityAnimatorProvider additionalAnimatorProvider)

Adds an additional VisibilityAnimatorProvider, which provides animators be played together with the primary and secondary VisibilityAnimatorProviders.

void clearAdditionalAnimatorProvider()

Clears all additional VisibilityAnimatorProviders that were previously added.

P extends VisibilityAnimatorProvider getPrimaryAnimatorProvider()

Returns the primary VisibilityAnimatorProvider for this transition, which can be modified but not swapped out completely.

VisibilityAnimatorProvider getSecondaryAnimatorProvider()

Returns the secondary VisibilityAnimatorProvider for this transition or null, which can be modified or swapped out completely for a different VisibilityAnimatorProvider.

boolean isGrowing()
Animator onAppear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)
Animator onDisappear(ViewGroup sceneRoot, View view, TransitionValues startValues, TransitionValues endValues)
boolean removeAdditionalAnimatorProvider(VisibilityAnimatorProvider additionalAnimatorProvider)

Removes an additional VisibilityAnimatorProvider that was previously added.

void setSecondaryAnimatorProvider(VisibilityAnimatorProvider secondaryAnimatorProvider)

Sets the secondary VisibilityAnimatorProvider, which provides animators to be played together with the primary VisibilityAnimatorProvider.

Inherited methods

Public constructors

MaterialElevationScale

public MaterialElevationScale (boolean growing)

Parameters
growing boolean

Public methods

addAdditionalAnimatorProvider

public void addAdditionalAnimatorProvider (VisibilityAnimatorProvider additionalAnimatorProvider)

Adds an additional VisibilityAnimatorProvider, which provides animators be played together with the primary and secondary VisibilityAnimatorProviders.

Parameters
additionalAnimatorProvider VisibilityAnimatorProvider

clearAdditionalAnimatorProvider

public void clearAdditionalAnimatorProvider ()

Clears all additional VisibilityAnimatorProviders that were previously added.

getPrimaryAnimatorProvider

public P extends VisibilityAnimatorProvider getPrimaryAnimatorProvider ()

Returns the primary VisibilityAnimatorProvider for this transition, which can be modified but not swapped out completely.

Returns
P extends VisibilityAnimatorProvider

getSecondaryAnimatorProvider

public VisibilityAnimatorProvider getSecondaryAnimatorProvider ()

Returns the secondary VisibilityAnimatorProvider for this transition or null, which can be modified or swapped out completely for a different VisibilityAnimatorProvider.

Returns
VisibilityAnimatorProvider

isGrowing

public boolean isGrowing ()

Returns
boolean

onAppear

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

Parameters
sceneRoot ViewGroup

view View

startValues TransitionValues

endValues TransitionValues

Returns
Animator

onDisappear

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

Parameters
sceneRoot ViewGroup

view View

startValues TransitionValues

endValues TransitionValues

Returns
Animator

removeAdditionalAnimatorProvider

public boolean removeAdditionalAnimatorProvider (VisibilityAnimatorProvider additionalAnimatorProvider)

Removes an additional VisibilityAnimatorProvider that was previously added.

Parameters
additionalAnimatorProvider VisibilityAnimatorProvider

Returns
boolean

setSecondaryAnimatorProvider

public void setSecondaryAnimatorProvider (VisibilityAnimatorProvider secondaryAnimatorProvider)

Sets the secondary VisibilityAnimatorProvider, which provides animators to be played together with the primary VisibilityAnimatorProvider.

Parameters
secondaryAnimatorProvider VisibilityAnimatorProvider