# Scene

Artifact: [androidx.xr.scenecore:scenecore](https://developer.android.com/jetpack/androidx/releases/xr-scenecore) [View Source](https://cs.android.com/search?q=file:androidx/xr/scenecore/Scene.kt+class:androidx.xr.scenecore.Scene) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

*** ** * ** ***


```
class Scene
```

<br />

*** ** * ** ***

Scene is the primary interface to SceneCore functionality for the application. Each spatialized `https://developer.android.com/reference/android/app/Activity.html` must create and hold an instance of a Scene.

Once created, the application can use the Scene object to create spatialized entities, such as Widget panels and geometric models, set the background environment, and anchor content to the real world.

## Summary

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#addSpatialCapabilitiesChangedListener(java.util.function.Consumer)( listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialCapability>> )` Adds the given `https://developer.android.com/reference/java/util/function/Consumer.html` as a listener to be invoked when this `https://developer.android.com/reference/kotlin/androidx/xr/runtime/Session`'s spatial capabilities change. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#addSpatialCapabilitiesChangedListener(java.util.concurrent.Executor,java.util.function.Consumer)( callbackExecutor: https://developer.android.com/reference/java/util/concurrent/Executor.html, listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialCapability>> )` Adds the given `https://developer.android.com/reference/java/util/function/Consumer.html` as a listener to be invoked when this `https://developer.android.com/reference/kotlin/androidx/xr/runtime/Session`'s spatial capabilities change. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#addSpatialVisibilityChangedListener(java.util.function.Consumer)( listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialVisibility> )` 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 `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/AnchorSpace`s and `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ActivitySpace`) changes within the user's field of view. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#addSpatialVisibilityChangedListener(java.util.concurrent.Executor,java.util.function.Consumer)( callbackExecutor: https://developer.android.com/reference/java/util/concurrent/Executor.html, listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialVisibility> )` Adds a listener to be invoked when the spatial visibility of the rendered content of the entire scene (all entities, including children of `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/AnchorSpace`s and `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ActivitySpace`) changes within the user's field of view. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#clearSpaceChangedListener()()` Releases the listener previously set by `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#setSpaceChangedListener(java.util.concurrent.Executor,java.util.function.Consumer)` and reinstates the default behavior of automatically updating the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#keyEntity()`'s pose and scale on the main thread executor. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<T>` | `<T : https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity> https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#getEntitiesOfType(java.lang.Class)(type: https://developer.android.com/reference/java/lang/Class.html<T>)` Returns all entities of the given type or its subtypes. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#removeSpatialCapabilitiesChangedListener(java.util.function.Consumer)( listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialCapability>> )` Releases the given `https://developer.android.com/reference/java/util/function/Consumer.html` from receiving updates when the `https://developer.android.com/reference/kotlin/androidx/xr/runtime/Session`'s `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialCapability` change. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#removeSpatialVisibilityChangedListener(java.util.function.Consumer)( listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialVisibility> )` Releases the listener previously added by `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#addSpatialVisibilityChangedListener(java.util.concurrent.Executor,java.util.function.Consumer)`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#requestFullSpace()()` If the `https://developer.android.com/reference/android/app/Activity.html` has focus, causes the Activity to be placed in Full Space. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#requestHomeSpace()()` If the `https://developer.android.com/reference/android/app/Activity.html` has focus, causes the Activity to be placed in Home Space. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#setSpaceChangedListener(java.util.function.Consumer)(listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpaceChangeEvent>)` Sets the listener to be invoked on the main thread executor when the space for the Scene has changed, such as from Home Space to Full Space. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#setSpaceChangedListener(java.util.concurrent.Executor,java.util.function.Consumer)( callbackExecutor: https://developer.android.com/reference/java/util/concurrent/Executor.html, listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpaceChangeEvent> )` Sets the listener to be invoked when the space has changed, such as from Home Space to Full Space. |

| ### Public properties |
|---|---|
| `lateinit https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ActivitySpace` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#activitySpace()` The `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ActivitySpace` is a special entity that represents the space in which the application is launched. |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity?` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#keyEntity()` The primary `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity` that serves as the spatial reference for the scene's content. |
| `lateinit https://developer.android.com/reference/kotlin/androidx/xr/scenecore/MainPanelEntity` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#mainPanelEntity()` A spatialized `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/MainPanelEntity` associated with the "main window" for the Activity. |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelClippingConfig` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#panelClippingConfig()` The current clipping configuration of all panels in the Scene. |
| `lateinit https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PerceptionSpace` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#perceptionSpace()` The `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PerceptionSpace` represents the origin of the space in which ARCore for Jetpack XR provides tracking info. |
| `lateinit https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialCapability>` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#spatialCapabilities()` The current `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html` of `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialCapability` constants available in the Session. |
| `lateinit https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialEnvironment` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#spatialEnvironment()` The `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialEnvironment` for this scene. |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PixelDensity` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#virtualPixelDensity()` Provides access to the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PixelDensity` standards for this scene. |

## Public functions

### addSpatialCapabilitiesChangedListener

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun addSpatialCapabilitiesChangedListener(
    listener: Consumer<Set<SpatialCapability>>
): Unit
```

Adds the given `https://developer.android.com/reference/java/util/function/Consumer.html` as a listener to be invoked when this `https://developer.android.com/reference/kotlin/androidx/xr/runtime/Session`'s spatial capabilities change.

| Parameters |
|---|---|
| `listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialCapability>>` | The Consumer to be invoked asynchronously, on the main thread. The set includes every currently-available `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialCapability`. |

### addSpatialCapabilitiesChangedListener

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun addSpatialCapabilitiesChangedListener(
    callbackExecutor: Executor,
    listener: Consumer<Set<SpatialCapability>>
): Unit
```

Adds the given `https://developer.android.com/reference/java/util/function/Consumer.html` as a listener to be invoked when this `https://developer.android.com/reference/kotlin/androidx/xr/runtime/Session`'s spatial capabilities change.

| Parameters |
|---|---|
| `callbackExecutor: https://developer.android.com/reference/java/util/concurrent/Executor.html` | The `https://developer.android.com/reference/java/util/concurrent/Executor.html` to run the listener on. |
| `listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialCapability>>` | The Consumer to be invoked asynchronously on the given callbackExecutor. The set includes every currently-available `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialCapability`. |

### addSpatialVisibilityChangedListener

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun addSpatialVisibilityChangedListener(
    listener: Consumer<SpatialVisibility>
): Unit
```

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 `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/AnchorSpace`s and `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/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 `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#setEnabled(kotlin.Boolean)` (enabled=false) or if the entities are turned fully transparent using `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#setAlpha(kotlin.Float)` (alpha=0.0), then the SpatialVisibility checks will return `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialVisibility#OUTSIDE_FIELD_OF_VIEW()`.

| Parameters |
|---|---|
| `listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialVisibility>` | The `https://developer.android.com/reference/java/util/function/Consumer.html` to be invoked asynchronously on the main thread whenever the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialVisibility` of the renderable content changes. |

### addSpatialVisibilityChangedListener

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun addSpatialVisibilityChangedListener(
    callbackExecutor: Executor,
    listener: Consumer<SpatialVisibility>
): Unit
```

Adds a listener to be invoked when the spatial visibility of the rendered content of the entire scene (all entities, including children of `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/AnchorSpace`s and `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/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 `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#setEnabled(kotlin.Boolean)` (enabled=false) or if the entities are turned fully transparent using `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#setAlpha(kotlin.Float)` (alpha=0.0), then the SpatialVisibility checks will return `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialVisibility#OUTSIDE_FIELD_OF_VIEW()`.

The listener is invoked on the provided `https://developer.android.com/reference/java/util/concurrent/Executor.html`.

| Parameters |
|---|---|
| `callbackExecutor: https://developer.android.com/reference/java/util/concurrent/Executor.html` | The `https://developer.android.com/reference/java/util/concurrent/Executor.html` to run the listener on. |
| `listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialVisibility>` | The `https://developer.android.com/reference/java/util/function/Consumer.html` to be invoked asynchronously on the given callbackExecutor whenever the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialVisibility` of the renderable content changes. |

### clearSpaceChangedListener

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun clearSpaceChangedListener(): Unit
```

Releases the listener previously set by `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#setSpaceChangedListener(java.util.concurrent.Executor,java.util.function.Consumer)` and reinstates the default behavior of automatically updating the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#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.

### getEntitiesOfType

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

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

Returns all entities of the given type or its subtypes.

| Parameters |
|---|---|
| `type: https://developer.android.com/reference/java/lang/Class.html<T>` | the type of `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity` to return. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<T>` | a list of all entities of the given type. |

### removeSpatialCapabilitiesChangedListener

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun removeSpatialCapabilitiesChangedListener(
    listener: Consumer<Set<SpatialCapability>>
): Unit
```

Releases the given `https://developer.android.com/reference/java/util/function/Consumer.html` from receiving updates when the `https://developer.android.com/reference/kotlin/androidx/xr/runtime/Session`'s `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialCapability` change.

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

| Parameters |
|---|---|
| `listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialCapability>>` | The Consumer to be removed. It will no longer receive change events. |

### removeSpatialVisibilityChangedListener

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun removeSpatialVisibilityChangedListener(
    listener: Consumer<SpatialVisibility>
): Unit
```

Releases the listener previously added by `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#addSpatialVisibilityChangedListener(java.util.concurrent.Executor,java.util.function.Consumer)`.

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

### requestFullSpace

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun requestFullSpace(): Unit
```

If the `https://developer.android.com/reference/android/app/Activity.html` has focus, causes the Activity to be placed in Full Space. Otherwise, this call does nothing.

### requestHomeSpace

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun requestHomeSpace(): Unit
```

If the `https://developer.android.com/reference/android/app/Activity.html` has focus, causes the Activity to be placed in Home Space. Otherwise, this call does nothing.

### setSpaceChangedListener

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun setSpaceChangedListener(listener: Consumer<SpaceChangeEvent>): Unit
```

Sets the listener to be invoked on the main thread executor when the space for the Scene has changed, such as from Home Space to Full Space.

Because the listener will typically update the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#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.

| Parameters |
|---|---|
| `listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpaceChangeEvent>` | The `https://developer.android.com/reference/java/util/function/Consumer.html` to be invoked asynchronously on the main thread whenever the spatial mode has changed. |

### setSpaceChangedListener

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun setSpaceChangedListener(
    callbackExecutor: Executor,
    listener: Consumer<SpaceChangeEvent>
): Unit
```

Sets the listener to be invoked when the space has changed, such as from Home Space to Full Space.

The listener is invoked on the provided `https://developer.android.com/reference/java/util/concurrent/Executor.html`.

Because the listener will typically update the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#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.

| Parameters |
|---|---|
| `callbackExecutor: https://developer.android.com/reference/java/util/concurrent/Executor.html` | The `https://developer.android.com/reference/java/util/concurrent/Executor.html` on which to run the listener. |
| `listener: https://developer.android.com/reference/java/util/function/Consumer.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpaceChangeEvent>` | The `https://developer.android.com/reference/java/util/function/Consumer.html` to be invoked asynchronously on the given callbackExecutor whenever the space has changed. |

## Public properties

### activitySpace

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
lateinit val activitySpace: ActivitySpace
```

The `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/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 `https://developer.android.com/reference/kotlin/androidx/xr/runtime/Session` is created.

### keyEntity

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
var keyEntity: Entity?
```

The primary `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/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 `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#keyEntity()` to help preserve the user's spatial context across these mode transitions.

Starting with Spatial API v2, setting `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#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.

Spaces, such as `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/AnchorSpace` or `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ActivitySpace`, cannot be set as the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#keyEntity()` and will throw `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` if set.

By default, this is set to `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#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 `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity` is assigned as `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#keyEntity()`, the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#spaceChangedListener()` is immediately invoked with the last known recommended pose and scale values if the following conditions are met:

1. The previous value of `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#keyEntity()` was `null`.

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

### mainPanelEntity

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
lateinit val mainPanelEntity: MainPanelEntity
```

A spatialized `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/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.

### panelClippingConfig

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
var panelClippingConfig: PanelClippingConfig
```

The current clipping configuration of all panels in the Scene.

Setting this property updates the clipping behavior.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelClippingConfig` |   |

### perceptionSpace

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
lateinit val perceptionSpace: PerceptionSpace
```

The `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/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.

### spatialCapabilities

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
lateinit val spatialCapabilities: Set<SpatialCapability>
```

The current `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html` of `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/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 `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene#addSpatialCapabilitiesChangedListener(java.util.function.Consumer)`.

### spatialEnvironment

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
lateinit val spatialEnvironment: SpatialEnvironment
```

The `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/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.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpatialEnvironment` |   |

### virtualPixelDensity

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
val virtualPixelDensity: PixelDensity
```

Provides access to the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PixelDensity` standards for this scene.

This specific density represents the default number of **virtual pixels** that correspond to one physical meter in `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ActivitySpace`.

Since the spatial coordinate system is emulated, these pixels represent content units (texture resolution) used to define entities such as `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelEntity`, rather than physical display pixels.

It is a static hardware constant and ignores user-level display preference overrides (system density changes).