Scene

fun addSpatialCapabilitiesChangedListener(
    listener: Consumer<SpatialCapabilities>
): Unit

Adds the given Consumer as a listener to be invoked when this Session's current SpatialCapabilities change.

fun addSpatialCapabilitiesChangedListener(
    callbackExecutor: Executor,
    listener: Consumer<SpatialCapabilities>
): Unit

Adds the given Consumer as a listener to be invoked when this Session's current SpatialCapabilities change.

fun clearSpatialVisibilityChangedListener(): Unit

Releases the listener previously added by setSpatialVisibilityChangedListener.

fun configureBundleForFullSpaceModeLaunch(bundle: Bundle): Bundle

Configures a Bundle to request that a new Activity be launched directly into Full Space Mode.

The configured bundle can be used to launch an Activity directly into Full Space Mode through Activity.startActivity. If there's a bundle used for customizing how the Activity should be started by android.app.ActivityOptions.toBundle or androidx.core.app.ActivityOptionsCompat.toBundle, it's suggested to use the bundle to call this method.

The flag will be ignored when no android.content.Intent.FLAG_ACTIVITY_NEW_TASK is set in the bundle, or it is not started from a focused Activity context.

This flag is also ignored when the androidx.xr.runtime.manifest.PROPERTY_XR_ACTIVITY_START_MODE property is set to a value other than androidx.xr.runtime.manifest.XR_ACTIVITY_START_MODE_UNDEFINED in the AndroidManifest.xml file for the activity being launched.

fun configureBundleForFullSpaceModeLaunchWithEnvironmentInherited(
    bundle: Bundle
): Bundle

Configures a Bundle to request that a new Activity be launched directly into Full Space Mode while inheriting the environment from the launching activity.

The configured bundle can be used to launch an Activity directly into Full Space Mode while inherit the existing environment through Activity.startActivity. If there's a bundle used for customizing how the Activity should be started by android.app.ActivityOptions.toBundle or androidx.core.app.ActivityOptionsCompat.toBundle, it's suggested to use the bundle to call this method.

When launched, the Activity will be in Full Space Mode and will inherit the environment from the launching activity. If the inherited environment needs to be animated, the launching activity has to continue updating the environment even after the activity is put into the stopped state.

The flag will be ignored when no android.content.Intent.FLAG_ACTIVITY_NEW_TASK is set in the intent, or it is not started from a focused Activity context.

The flag will also be ignored when there is no environment to inherit or when the activity has its own environment set already.

This flag is also ignored when the androidx.xr.runtime.manifest.PROPERTY_XR_ACTIVITY_START_MODE property is set to a value other than androidx.xr.runtime.manifest.XR_ACTIVITY_START_MODE_UNDEFINED in the AndroidManifest.xml file for the activity being launched.

For security reasons, Z-testing for the new activity is disabled, and the activity is always drawn on top of the inherited environment. Because Z-testing is disabled, the activity should not spatialize itself.

fun <T : Entity> getEntitiesOfType(type: Class<T>): List<T>

Returns all entities of the given type or its subtypes.

fun removeSpatialCapabilitiesChangedListener(
    listener: Consumer<SpatialCapabilities>
): Unit

Releases the given Consumer from receiving updates when the Session's SpatialCapabilities change.

fun requestFullSpaceMode(): Unit

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

fun requestHomeSpaceMode(): Unit

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

fun setSpatialVisibilityChangedListener(listener: Consumer<Int>): Unit

Sets the 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.SPATIAL_VISIBILITY_OUTSIDE_FIELD_OF_VIEW.

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

fun setSpatialVisibilityChangedListener(
    callbackExecutor: Executor,
    listener: Consumer<Int>
): Unit

Sets the 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.SPATIAL_VISIBILITY_OUTSIDE_FIELD_OF_VIEW.

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.

lateinit val 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.

var panelClippingConfig: PanelClippingConfig

The current clipping configuration of all panels in the Scene.

Setting this property updates the clipping behavior.

lateinit val 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.

val spatialCapabilities: SpatialCapabilities

Returns the current SpatialCapabilities of the Session. The set of capabilities can 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.

lateinit val 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.

lateinit val spatialUser: SpatialUser

The SpatialUser represents the user within the XR scene, providing access to tracking information for the user's head and eyes.

Use it to get the following:

• Head Pose: Access SpatialUser.head to get the position and orientation of the user's head in the scene.

• Camera Views: Access SpatialUser.cameraViews to get the pose and field of view for each of the user's camera views.

Note: Accessing properties on SpatialUser requires head tracking to be enabled in the session androidx.xr.runtime.Session.config.