# Plane.State

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

*** ** * ** ***


```
class Plane.State : Trackable.State
```

<br />

*** ** * ** ***

The representation of the current state of a `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane`. A `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane` is represented as a finite polygon with an arbitrary amount of `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State#vertices()` around a `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State#centerPose()`.

## Summary

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State#toString()()` Returns a string representation of `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State` for debugging. |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State#centerPose()` the `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` of the center of the detected plane's bounding box in the world coordinate space. |
| `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/FloatSize2d` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State#extents()` the dimensions of the bounding box of the detected plane |
| `https://developer.android.com/reference/kotlin/androidx/xr/arcore/PlaneLabel` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State#label()` the `https://developer.android.com/reference/kotlin/androidx/xr/arcore/PlaneLabel` associated with the plane |
| `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State#owner()` self-reference to the object that owns this state |
| `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane?` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State#subsumedBy()` if this plane has been subsumed, returns the plane this plane was merged into. |
| `open https://developer.android.com/reference/kotlin/androidx/xr/arcore/TrackingState` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State#trackingState()` whether this plane is being tracked or not |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Vector2>` | `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State#vertices()` the 2D vertices of a convex polygon approximating the detected plane |

## Public functions

### equals

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

### hashCode

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

### toString

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

Returns a string representation of `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State` for debugging.

Note: Not intended for production use.

## Public properties

### centerPose

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

```
val centerPose: Pose
```

the `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` of the center of the detected plane's bounding box in the world coordinate space. The +Y axis relative to the `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane.State#centerPose()` is equivalent to the normal of the `https://developer.android.com/reference/kotlin/androidx/xr/arcore/Plane`

### extents

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

```
val extents: FloatSize2d
```

the dimensions of the bounding box of the detected plane

### label

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

```
val label: PlaneLabel
```

the `https://developer.android.com/reference/kotlin/androidx/xr/arcore/PlaneLabel` associated with the plane

### owner

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

```
val owner: Plane
```

self-reference to the object that owns this state

### subsumedBy

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

```
val subsumedBy: Plane?
```

if this plane has been subsumed, returns the plane this plane was merged into. If the subsuming plane is also subsumed by another plane, this plane will continue to be subsumed by the former

### trackingState

```
open val trackingState: TrackingState
```

whether this plane is being tracked or not

### vertices

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

```
val vertices: List<Vector2>
```

the 2D vertices of a convex polygon approximating the detected plane