MaterialContainerTransform

public static final int FADE_MODE_CROSS = 2

Indicates that this transition should cross fade the outgoing and incoming content.

public static final int FADE_MODE_IN = 0

Indicates that this transition should only fade in the incoming content, without changing the opacity of the outgoing content.

public static final int FADE_MODE_OUT = 1

Indicates that this transition should only fade out the outgoing content, without changing the opacity of the incoming content.

public static final int FADE_MODE_THROUGH = 3

Indicates that this transition should sequentially fade out the outgoing content and fade in the incoming content.

public static final int FIT_MODE_AUTO = 0

Indicates that this transition should automatically choose whether to use FIT_MODE_WIDTH or FIT_MODE_HEIGHT.

public static final int FIT_MODE_HEIGHT = 2

Indicates that this transition should fit the incoming content to the height of the outgoing content during the scale animation.

public static final int FIT_MODE_WIDTH = 1

Indicates that this transition should fit the incoming content to the width of the outgoing content during the scale animation.

public static final int TRANSITION_DIRECTION_AUTO = 0

Indicates that this transition should use automatic detection to determine whether it is an Enter or a Return. If the end container has a larger area than the start container then it is considered an Enter transition, otherwise it is a Return transition.

public static final int TRANSITION_DIRECTION_ENTER = 1

Indicates that this is an Enter transition, i.e., when elements are entering the scene.

public static final int TRANSITION_DIRECTION_RETURN = 2

Indicates that this is a Return transition, i.e., when elements are exiting the scene.

public int getContainerColor()

Get the color to be drawn beneath both the start view and end view.

public int getDrawingViewId()

Get the id of the View whose overlay this transitions will be added to.

public int getEndContainerColor()

Get the color to be drawn beneath the end view.

public float getEndElevation()

Get the elevation that will be used to render a shadow around the container at the end of the transition.

Default is -1, which means the elevation of the end view will be used.

public ShapeAppearanceModel getEndShapeAppearanceModel()

Get the ShapeAppearanceModel which will be used to determine the shape into which the container will be transformed.

public View getEndView()

Get the View which will be used as the end shared element container.

public int getEndViewId()

Get the id of the View which will be used as the end shared element container.

Setting an end View id can be used to manually configure MaterialContainerTransform when transitioning between two Views in a single layout when the Transition system will not automatically capture shared element start or end Views for you.

If the end view cannot be found during the initialization of the MaterialContainerTransform, then an IllegalArgumentException will be thrown.

public int getFadeMode()

The fade mode to be used to swap the content of the start View with that of the end View.

public MaterialContainerTransform.ProgressThresholds getFadeProgressThresholds()

Get the ProgressThresholds which define the sub-range (any range inside the full progress range of 0.0 - 1.0) between which the fade animation, determined by getFadeMode will complete.

public int getFitMode()

The fit mode to be used when scaling the incoming content of the end View.

public MaterialContainerTransform.ProgressThresholds getScaleMaskProgressThresholds()

Get the ProgressThresholds which define the sub-range (any range inside the full progress range of 0.0 and 1.0) between which the container will morph between the start and end View's dimensions.

public MaterialContainerTransform.ProgressThresholds getScaleProgressThresholds()

Get the ProgressThresholds which define the sub-range (any range inside the full progress range of 0.0 - 1.0) between which the outgoing and incoming content will scale to the full dimensions of the end container.

public int getScrimColor()

Get the color to be drawn under the morphing container but within the bounds of the getDrawingViewId.

public MaterialContainerTransform.ProgressThresholds getShapeMaskProgressThresholds()

Get the ProgressThresholds which define the sub-range (any range inside the full progress range of 0.0 and 1.0) between which the container will morph between the starting ShapeAppearanceModel and ending ShapeAppearanceModel.

public int getStartContainerColor()

Get the color to be drawn beneath the start view.

public float getStartElevation()

Get the elevation that will be used to render a shadow around the container at the start of the transition.

Default is -1, which means the elevation of the start view will be used.

public ShapeAppearanceModel getStartShapeAppearanceModel()

Get the ShapeAppearanceModel which will be used to determine the shape from which the container will be transformed.

public View getStartView()

Get the View which will be used as the start shared element container.

public int getStartViewId()

Get the id of the View which will be used as the start shared element container.

public int getTransitionDirection()

The direction to be used by this transform.

public boolean isDrawDebugEnabled()

Whether debug drawing is enabled.

public boolean isElevationShadowEnabled()

Get whether shadows should be drawn around the container to approximate native elevation shadows on the start and end views.

public boolean isHoldAtEndEnabled()

Whether to hold the last frame at the end of the animation.

public void setAllContainerColors(int containerColor)

Set the container color, the start container color and the end container color.

This is a helper for the common case of transitioning between a start and end view when neither draws its own background but a common color is shared. This prevents the start or end view from being visible below one another.

public void setContainerColor(int containerColor)

Set a color to be drawn beneath both the start and end view.

This color is the background color of the transforming container inside of which the start and end views are drawn. Unlike the start view, start container color, end view and end container color, this color will always be drawn as fully opaque, beneath all other content in the container. By default, this color is set to transparent (0), meaning a container color will not be drawn.

If a default container transform results in the start view being visible beneath the end view, or vica versa, this is due to one or both views not having a background. The most common way to solve this issue is by sequentially fading the contents with FADE_MODE_THROUGH and setting this color to the start and end view's desired background color.

If the start and end views have different background colors, or you would like to use a fade mode other than FADE_MODE_THROUGH, handle this by using setStartContainerColor and setEndContainerColor.

public void setDrawDebugEnabled(boolean drawDebugEnabled)

Set whether or not to draw paths which follow the shape and path of animating containers.

public void setDrawingViewId(int drawingViewId)

Set the id of the View whose overlay this transition will be added to.

This can be used to limit the bounds of the animation (including the background scrim) to the bounds of the provided drawing view, and also have the animation drawn at the relative z-order of the drawing view.

By default, the drawingViewId will be android.R.id.content. Additionally, if drawingViewId is the same as the end View's id, MaterialContainerTransform will add the transition's drawable to the drawingViewId's parent instead.

If the drawing view cannot be found during the initialization of the MaterialContainerTransform, then an IllegalArgumentException will be thrown.

public void setElevationShadowEnabled(boolean elevationShadowEnabled)

Set whether shadows should be drawn around the container to approximate native elevation shadows on the start and end views.

By default, the elevation shadows are only enabled for API level 28 and above, because Paint shadows are not supported with hardware acceleration below API level 28. If enabled for below API level 28, then the shadows will be drawn using , however this may cause performance issues.

Additionally, the rendering of elevation shadows may cause performance issues if the container's shape is not a round rect or a regular rect, e.g., a rect with cut corners.

public void setEndContainerColor(int containerColor)

Set a color to be drawn beneath the end view.

This color will be drawn directly beneath the end view, will fill the entire transforming container, and the will animate its opacity to match the end view's. By default, this color is set to transparent (0), meaning no color will be drawn.

This method can be useful when the color of the start and end view differ and the end view does not handle drawing its own background. Setting this color will prevent the start view from being visible beneath the end view while transforming.

public void setEndElevation(float endElevation)

Set the elevation that will be used to render a shadow around the container at the end of the transition.

By default the elevation of the end view will be used.

public void setEndShapeAppearanceModel(
    ShapeAppearanceModel endShapeAppearanceModel
)

Set the ShapeAppearanceModel which will be used to determine the shape into which the container will be transformed.

public void setEndView(View endView)

Set the View to be used as the end shared element container.

public void setEndViewId(int endViewId)

Set the id of the View to be used as the end shared element container. The matching View will be searched for in the hierarchy when starting this transition.

Manually setting the end View id will override any View explicitly set via setEndView or any View picked up by the Transition system marked with a transitionName.

public void setFadeMode(int fadeMode)

Set the fade mode to be used to swap the content of the start View with that of the end View.

By default, the fade mode is set to FADE_MODE_IN.

public void setFadeProgressThresholds(
    MaterialContainerTransform.ProgressThresholds fadeProgressThresholds
)

Set the ProgressThresholds which define the sub-range (any range inside the full progress range of 0.0 - 1.0) between which the fade animation, determined by getFadeMode will complete.

See ProgressThresholds for an example of how the threshold ranges work.

public void setFitMode(int fitMode)

Set the fit mode to be used when scaling the incoming content of the end View.

By default, the fit mode is set to FIT_MODE_AUTO.

public void setHoldAtEndEnabled(boolean holdAtEndEnabled)

If true, the last frame of the animation will be held in place, and the original outgoing and incoming views will not be re-shown.

Useful for Activity return transitions to make sure the screen doesn't flash at the end.

public void setScaleMaskProgressThresholds(
    MaterialContainerTransform.ProgressThresholds scaleMaskProgressThresholds
)

Set the ProgressThresholds which define the sub-range (any range inside the full progress range of 0.0 and 1.0) between which the container will morph between the start and end View's dimensions.

See ProgressThresholds for an example of how the threshold ranges work.

public void setScaleProgressThresholds(
    MaterialContainerTransform.ProgressThresholds scaleProgressThresholds
)

Set the ProgressThresholds which define the sub-range (any range inside the full progress range of 0.0 - 1.0) between which the outgoing and incoming content will scale to the full dimensions of the end container.

See ProgressThresholds for an example of how the threshold ranges work.

public void setScrimColor(int scrimColor)

Set the color to be drawn under the morphing container but within the bounds of the getDrawingViewId.

By default this is set to black with 32% opacity. Drawing a scrim is primarily useful for transforming from a partial-screen View (eg. Card in a grid) to a full screen. The scrim will gradually fade in and cover the content being transformed over by the morphing container.

Changing the default scrim color can be useful when transitioning between two Views in a layout, where the ending View does not cover any outgoing content (eg. a FAB to a bottom toolbar). For scenarios such as these, set the scrim color to transparent.

public void setShapeMaskProgressThresholds(
    MaterialContainerTransform.ProgressThresholds shapeMaskProgressThresholds
)

Set the ProgressThresholds which define the sub-range (any range inside the full progress range of 0.0 and 1.0) between which the container will morph between the starting ShapeAppearanceModel and ending ShapeAppearanceModel.

See ProgressThresholds for an example of how the threshold ranges work.

public void setStartContainerColor(int containerColor)

Set a color to be drawn beneath the start view.

This color will be drawn directly beneath the start view, will fill the entire transforming container, and will animate its opacity to match the start view's. By default, this color is set to transparent (0), meaning no color will be drawn.

This method can be useful when the color of the start and end view differ and the start view does not handle drawing its own background. This can also be used if an expanding container is larger than the start view. Setting this color to match that of the start view's background will cause the start view to look like its background is expanding to fill the transforming container.

public void setStartElevation(float startElevation)

Set the elevation that will be used to render a shadow around the container at the start of the transition.

By default the elevation of the start view will be used.

public void setStartShapeAppearanceModel(
    ShapeAppearanceModel startShapeAppearanceModel
)

Set the ShapeAppearanceModel which will be used to determine the shape from which the container will be transformed.

Manually setting a shape appearance will override both your theme's transitionShapeAppearance attribute (if set) and the shape appearance of the start View (or end View via setEndShapeAppearanceModel if the View implements the Shapeable interface. Setting this property can be useful if your start or end View does not implement Shapeable but does have a shape (eg. a rounded rect background drawable) and you would like MaterialContainerTransform to morph from or to your View's shape.

public void setStartView(View startView)

Set the View to be used as the start shared element container.

public void setStartViewId(int startViewId)

Set the id of the View to be used as the start shared element container. The matching View will be searched for in the hierarchy when starting this transition.

Setting a start View can be helpful when transitioning from a View to another View or if transitioning from a View to a Fragment.

Manually setting the start View id will override any View explicitly set via setStartView or any View picked up by the Transition system marked with a transitionName.

If the start view cannot be found during the initialization of the MaterialContainerTransform, then an IllegalArgumentException will be thrown.

public void setTransitionDirection(int transitionDirection)

Set the transition direction to be used by this transform.

By default, the transition direction is determined by the change in size between the start and end Views.