# SceneState

Artifact: [androidx.navigation3:navigation3-ui](https://developer.android.com/jetpack/androidx/releases/navigation3) [View Source](https://cs.android.com/search?q=file:androidx/navigation3/scene/SceneState.kt+class:androidx.navigation3.scene.SceneState) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigation3#1.0.0) Common/All
- Cmn

  ```
  class SceneState<T : Any>
  ```

*** ** * ** ***

Class for holding the state associated with a scene

This provides information to the androidx.navigation3.ui.NavDisplay and androidx.navigationevent.compose.NavigationBackHandler to ensure they can behave correctly.

## Summary

| ### Public functions |
|---|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneState#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneState#hashCode()()` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneState#toString()()` | Cmn |

| ### Public properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/Scene<T>` | `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneState#currentScene()` the current scene that could be displayed, and also the scene that is displayed underneath any overlay scenes. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntry<T>>` | `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneState#entries()` all of the entries that are associated with this state | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/navigation3/scene/OverlayScene<T>>` | `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneState#overlayScenes()` any overlay scenes available to the state | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/navigation3/scene/Scene<T>>` | `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneState#previousScenes()` the list of all of the previous scenes before the currentScene | Cmn |

## Public functions

### equals

Cmn

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

Cmn

```
open fun hashCode(): Int
```

### toString

Cmn

```
open fun toString(): String
```

## Public properties

### currentScene

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigation3#1.0.0)

```
val currentScene: Scene<T>
```

the current scene that could be displayed, and also the scene that is displayed underneath any overlay scenes.

### entries

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigation3#1.0.0)

```
val entries: List<NavEntry<T>>
```

all of the entries that are associated with this state

### overlayScenes

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigation3#1.0.0)

```
val overlayScenes: List<OverlayScene<T>>
```

any overlay scenes available to the state

### previousScenes

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigation3#1.0.0)

```
val previousScenes: List<Scene<T>>
```

the list of all of the previous scenes before the currentScene