# PlaneTrackingMode

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

*** ** * ** ***


```
class PlaneTrackingMode
```

<br />

*** ** * ** ***

Feature that allows tracking of and provides information about scene planes.

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/runtime/PlaneTrackingMode` | `https://developer.android.com/reference/kotlin/androidx/xr/runtime/PlaneTrackingMode#DISABLED()` Planes will not be tracked. |
| `https://developer.android.com/reference/kotlin/androidx/xr/runtime/PlaneTrackingMode` | `https://developer.android.com/reference/kotlin/androidx/xr/runtime/PlaneTrackingMode#HORIZONTAL_AND_VERTICAL()` Horizontal and vertical planes will be tracked. |

| ### Public functions |
|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/runtime/PlaneTrackingMode#toString()()` Returns a string representation of `https://developer.android.com/reference/kotlin/androidx/xr/runtime/PlaneTrackingMode` for debugging. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/runtime/PlaneTrackingMode#mode()` |

## Public companion properties

### DISABLED

```
val DISABLED: PlaneTrackingMode
```

Planes will not be tracked.

### HORIZONTAL_AND_VERTICAL

```
val HORIZONTAL_AND_VERTICAL: PlaneTrackingMode
```

Horizontal and vertical planes will be tracked. Note that setting this mode will consume additional runtime resources.

Supported runtimes:

- OpenXR

- Play Services

Required permissions:

- `https://developer.android.com/reference/kotlin/androidx/xr/runtime/manifest/package-summary#SCENE_UNDERSTANDING_COARSE()` (OpenXR runtimes only)

- `https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_COARSE_LOCATION` (Play Services runtimes only)

- `https://developer.android.com/reference/android/Manifest.permission.html#CAMERA` (Play Services runtimes only)

## Public functions

### toString

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

Returns a string representation of `https://developer.android.com/reference/kotlin/androidx/xr/runtime/PlaneTrackingMode` for debugging.

Note: Not intended for production use.

## Public properties

### mode

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

```
val mode: Int
```