Scene

public final lateinit @NonNull ActivitySpace activitySpace

The ActivitySpace is a special entity that represents the space in which the application is launched. It is the default parent of all entities in the scene.

The ActivitySpace is created automatically when the androidx.xr.runtime.Session is created.

public final lateinit @NonNull MainPanelEntity mainPanelEntity

A spatialized MainPanelEntity associated with the "main window" for the Activity. When in Home Space Mode, this is the application's "main window".

If called multiple times, this will return the same MainPanelEntity.

public final lateinit @NonNull PerceptionSpace perceptionSpace

The PerceptionSpace represents the origin of the space in which ARCore for Jetpack XR provides tracking info. The transformations provided by the PerceptionSpace are only valid for the call frame, as the transformation can be changed by the system at any time.

public final lateinit @NonNull Set<@NonNull SpatialCapability> spatialCapabilities

The current Set of SpatialCapability constants available in the Session. The set may change within a session. The returned object will not update if the capabilities change; this method should be called again to get the latest set of capabilities, or clients can subscribe to changes with addSpatialCapabilitiesChangedListener.

public final lateinit @NonNull SpatialEnvironment spatialEnvironment

The SpatialEnvironment for this scene.

This object provides APIs to manage the XR background and passthrough settings. Use it to set a custom skybox, define the 3D geometry of the environment, and control the opacity of the camera passthrough feed.

public final void addSpatialCapabilitiesChangedListener(
    @NonNull Consumer<@NonNull Set<@NonNull SpatialCapability>> listener
)

Adds the given Consumer as a listener to be invoked when this androidx.xr.runtime.Session's spatial capabilities change.

public final void addSpatialCapabilitiesChangedListener(
    @NonNull Executor callbackExecutor,
    @NonNull Consumer<@NonNull Set<@NonNull SpatialCapability>> listener
)

Adds the given Consumer as a listener to be invoked when this androidx.xr.runtime.Session's spatial capabilities change.

public final void addSpatialVisibilityChangedListener(
    @NonNull Consumer<@NonNull SpatialVisibility> listener
)

Adds a listener to be invoked on the main thread executor when the spatial visibility of the rendered content of the entire scene (all entities, including children of AnchorEntitys and ActivitySpace) changes within the user's field of view. In Home Space Mode, the listener continues to monitor the spatial visibility of the application's main panel.

This API only checks if the bounding box of all rendered content (even if partially transparent) is within the user's field of view. Content not rendered due to full transparency (alpha=0) or being hidden is not considered. If the entities in the scene or any of their ancestors are hidden using Entity.setEnabled (enabled=false) or if the entities are turned fully transparent using Entity.setAlpha (alpha=0.0), then the SpatialVisibility checks will return SpatialVisibility.OUTSIDE_FIELD_OF_VIEW.

public final void addSpatialVisibilityChangedListener(
    @NonNull Executor callbackExecutor,
    @NonNull Consumer<@NonNull SpatialVisibility> listener
)

Adds a listener to be invoked when the spatial visibility of the rendered content of the entire scene (all entities, including children of AnchorEntitys and ActivitySpace) changes within the user's field of view. In Home Space Mode, the listener continues to monitor the spatial visibility of the application's main panel.

This API only checks if the bounding box of all rendered content (even if partially transparent) is within the user's field of view. Content not rendered due to full transparency (alpha=0) or being hidden is not considered. If the entities in the scene or any of their ancestors are hidden using Entity.setEnabled (enabled=false) or if the entities are turned fully transparent using Entity.setAlpha (alpha=0.0), then the SpatialVisibility checks will return SpatialVisibility.OUTSIDE_FIELD_OF_VIEW.

The listener is invoked on the provided Executor.

public final void clearSpatialModeChangedListener()

Releases the listener previously set by setSpatialModeChangedListener and reinstates the default behavior of automatically updating the keyEntity's pose and scale on the main thread executor.

The listener is automatically released at the end of the Scene's lifecycle even if this method is not explicitly called.

public final @NonNull ActivitySpace getActivitySpace()

The ActivitySpace is a special entity that represents the space in which the application is launched. It is the default parent of all entities in the scene.

The ActivitySpace is created automatically when the androidx.xr.runtime.Session is created.

public final @NonNull List<@NonNull T> <T extends Entity> getEntitiesOfType(@NonNull Class<@NonNull T> type)

Returns all entities of the given type or its subtypes.

public final Entity getKeyEntity()

The primary Entity that serves as the spatial reference for the scene's content.

This entity is used to maintain visual continuity during spatial mode transitions. When entering Full Space Mode or re-centering the scene, the system provides a recommended pose and scale. SceneCore's default mode change handler applies those to the entity designated as keyEntity to help preserve the user's spatial context across these mode transitions.

Starting with Spatial API v2, setting keyEntity allows SceneCore to share the entity's pose with the system as a spatial continuity hint. The system uses this hint to maintain visual consistency when the current activity transitions to the Home Space or when a new activity is launched.

Unmovable Entities, such as AnchorEntity or ActivitySpace, cannot be set as the Scene.keyEntity and will throw IllegalArgumentException if set.

By default, this is set to mainPanelEntity. This field can be null if the key entity was cleared by setting this value to null. When null, the default listener takes no action during spatial mode changes.

When a new non-null Entity is assigned as keyEntity, the spatialModeChangedListener is immediately invoked with the last known recommended pose and scale values if the following conditions are met:

1. The previous value of keyEntity was null.

2. There are cached pose and scale values, provided by the system earlier.

public final @NonNull MainPanelEntity getMainPanelEntity()

A spatialized MainPanelEntity associated with the "main window" for the Activity. When in Home Space Mode, this is the application's "main window".

If called multiple times, this will return the same MainPanelEntity.

public final @NonNull PanelClippingConfig getPanelClippingConfig()

The current clipping configuration of all panels in the Scene.

Setting this property updates the clipping behavior.

public final @NonNull PerceptionSpace getPerceptionSpace()

The PerceptionSpace represents the origin of the space in which ARCore for Jetpack XR provides tracking info. The transformations provided by the PerceptionSpace are only valid for the call frame, as the transformation can be changed by the system at any time.

public final @NonNull Set<@NonNull SpatialCapability> getSpatialCapabilities()

The current Set of SpatialCapability constants available in the Session. The set may change within a session. The returned object will not update if the capabilities change; this method should be called again to get the latest set of capabilities, or clients can subscribe to changes with addSpatialCapabilitiesChangedListener.

public final @NonNull SpatialEnvironment getSpatialEnvironment()

The SpatialEnvironment for this scene.

This object provides APIs to manage the XR background and passthrough settings. Use it to set a custom skybox, define the 3D geometry of the environment, and control the opacity of the camera passthrough feed.

public final void removeSpatialCapabilitiesChangedListener(
    @NonNull Consumer<@NonNull Set<@NonNull SpatialCapability>> listener
)

Releases the given Consumer from receiving updates when the androidx.xr.runtime.Session's SpatialCapability change.

The listeners are automatically released at the end of the Scene's lifecycle even if this method is not explicitly called.

public final void removeSpatialVisibilityChangedListener(
    @NonNull Consumer<@NonNull SpatialVisibility> listener
)

Releases the listener previously added by addSpatialVisibilityChangedListener.

The listener is automatically released at the end of the Scene's lifecycle even if this method is not explicitly called.

public final void requestFullSpaceMode()

If the Activity has focus, causes the Activity to be placed in Full Space Mode. Otherwise, this call does nothing.

public final void requestHomeSpaceMode()

If the Activity has focus, causes the Activity to be placed in Home Space Mode. Otherwise, this call does nothing.

public final void setKeyEntity(Entity value)

The primary Entity that serves as the spatial reference for the scene's content.

This entity is used to maintain visual continuity during spatial mode transitions. When entering Full Space Mode or re-centering the scene, the system provides a recommended pose and scale. SceneCore's default mode change handler applies those to the entity designated as keyEntity to help preserve the user's spatial context across these mode transitions.

Starting with Spatial API v2, setting keyEntity allows SceneCore to share the entity's pose with the system as a spatial continuity hint. The system uses this hint to maintain visual consistency when the current activity transitions to the Home Space or when a new activity is launched.

Unmovable Entities, such as AnchorEntity or ActivitySpace, cannot be set as the Scene.keyEntity and will throw IllegalArgumentException if set.

By default, this is set to mainPanelEntity. This field can be null if the key entity was cleared by setting this value to null. When null, the default listener takes no action during spatial mode changes.

When a new non-null Entity is assigned as keyEntity, the spatialModeChangedListener is immediately invoked with the last known recommended pose and scale values if the following conditions are met:

1. The previous value of keyEntity was null.

2. There are cached pose and scale values, provided by the system earlier.

public final void setPanelClippingConfig(@NonNull PanelClippingConfig value)

The current clipping configuration of all panels in the Scene.

Setting this property updates the clipping behavior.

public final void setSpatialModeChangedListener(
    @NonNull Consumer<@NonNull SpatialModeChangeEvent> listener
)

Sets the listener to be invoked on the main thread executor when the spatial mode for the scene has changed.

Because the listener will typically update the keyEntity's pose and/or scale, there can only be one listener set at a time. If a new listener is set, the previous listener will be released.

public final void setSpatialModeChangedListener(
    @NonNull Executor callbackExecutor,
    @NonNull Consumer<@NonNull SpatialModeChangeEvent> listener
)

Sets the listener to be invoked when the spatial mode for the scene has changed.

The listener is invoked on the provided Executor.

There can only be one listener set at a time. If a new listener is set, the previous listener will be released.