Scene

Scene(sceneRoot: ViewGroup)

Constructs a Scene with no information about how values will change when this scene is applied. This constructor might be used when a Scene is created with the intention of being dynamically configured, through setting setEnterAction and possibly setExitAction.

Scene(sceneRoot: ViewGroup, layout: View)

Constructs a Scene which, when entered, will remove any children from the sceneRoot container and add the layout object as a new child of that container.

fun enter(): Unit

Enters this scene, which entails changing all values that are specified by this scene. These may be values associated with a layout view group or layout resource file which will now be added to the scene root, or it may be values changed by an setEnterAction enter action}, or a combination of the these. No transition will be run when the scene is entered. To get transition behavior in scene changes, use one of the methods in androidx.transition.TransitionManager instead.

fun exit(): Unit

Exits this scene, if it is the current scene on the scene's scene root. The current scene is set when entering a scene. Exiting a scene runs the exit action if there is one.

java-static fun getCurrentScene(sceneRoot: ViewGroup): Scene?

Gets the current Scene set on the given ViewGroup. A scene is set on a ViewGroup only if that ViewGroup is the scene root.

java-static fun getSceneForLayout(
    sceneRoot: ViewGroup,
    layoutId: @LayoutRes Int,
    context: Context
): Scene

Returns a Scene described by the resource file associated with the given layoutId parameter. If such a Scene has already been created for the given sceneRoot, that same Scene will be returned. This caching of layoutId-based scenes enables sharing of common scenes between those created in code and those referenced by TransitionManager XML resource files.

fun getSceneRoot(): ViewGroup

Gets the root of the scene, which is the root of the view hierarchy affected by changes due to this scene, and which will be animated when this scene is entered.

fun setEnterAction(action: Runnable?): Unit

Scenes that are not defined with layout resources or hierarchies, or which need to perform additional steps after those hierarchies are changed to, should set an enter action, and possibly an exit action as well. An enter action will cause Scene to call back into application code to do anything else the application needs after transitions have captured pre-change values and after any other scene changes have been applied, such as the layout (if any) being added to the view hierarchy. After this method is called, Transitions will be played.

fun setExitAction(action: Runnable?): Unit

Scenes that are not defined with layout resources or hierarchies, or which need to perform additional steps after those hierarchies are changed to, should set an enter action, and possibly an exit action as well. An exit action will cause Scene to call back into application code to do anything the application needs to do after applicable transitions have captured pre-change values, but before any other scene changes have been applied, such as the new layout (if any) being added to the view hierarchy. After this method is called, the next scene will be entered, including a call to setEnterAction if an enter action is set.