# TrackedDimensions

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


```
@ExperimentalFollowingSubspaceApi
class TrackedDimensions
```

<br />

*** ** * ** ***

A set of boolean flags which determine the dimensions of movement that are tracked, and will be used to update the content.

This is intended to be used with a `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/FollowMode`. These dimensions can be used to control how one entity is follows another. For example, if a dev wants to place a marker on the floor showing a user's position in a room, they might want to track only x and z. Possible values are: isXTracked, isYTracked, isZTracked, isPitchTracked, isYawTracked, isRollTracked, `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#All()`, or `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#RotationOnly()`.

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#All()` TrackedDimensions.All is provided as a convenient way to specify all 6 dimensions of a pose. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#RotationOnly()` TrackedDimensions.RotationOnly is provided as a convenient way to specify tracking only rotation dimensions (pitch, yaw, roll). |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#TrackedDimensions(kotlin.Boolean,kotlin.Boolean,kotlin.Boolean,kotlin.Boolean,kotlin.Boolean,kotlin.Boolean)( isXTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, isYTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, isZTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, isPitchTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, isYawTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, isRollTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#copy(kotlin.Boolean,kotlin.Boolean,kotlin.Boolean,kotlin.Boolean,kotlin.Boolean,kotlin.Boolean)( isXTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, isYTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, isZTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, isPitchTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, isYawTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, isRollTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` Returns a copy of this object with the given values updated. |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#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/compose/subspace/animation/follow/TrackedDimensions#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#toString()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#isPitchTracked()` Whether to track pitch rotation. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#isRollTracked()` Whether to track roll rotation. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#isXTracked()` Whether to track translation along the X axis. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#isYTracked()` Whether to track translation along the Y axis. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#isYawTracked()` Whether to track yaw rotation. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/animation/follow/TrackedDimensions#isZTracked()` Whether to track translation along the Z axis. |

## Public companion properties

### All

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

```
val All: TrackedDimensions
```

TrackedDimensions.All is provided as a convenient way to specify all 6 dimensions of a pose.

### RotationOnly

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

```
val RotationOnly: TrackedDimensions
```

TrackedDimensions.RotationOnly is provided as a convenient way to specify tracking only rotation dimensions (pitch, yaw, roll).

## Public constructors

### TrackedDimensions

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

```
TrackedDimensions(
    isXTracked: Boolean = false,
    isYTracked: Boolean = false,
    isZTracked: Boolean = false,
    isPitchTracked: Boolean = false,
    isYawTracked: Boolean = false,
    isRollTracked: Boolean = false
)
```

| Parameters |
|---|---|
| `isXTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether to track translation along the X axis. |
| `isYTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether to track translation along the Y axis. |
| `isZTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether to track translation along the Z axis. |
| `isPitchTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether to track pitch rotation. |
| `isYawTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether to track yaw rotation. |
| `isRollTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether to track roll rotation. |

## Public functions

### copy

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

```
fun copy(
    isXTracked: Boolean = this.isXTracked,
    isYTracked: Boolean = this.isYTracked,
    isZTracked: Boolean = this.isZTracked,
    isPitchTracked: Boolean = this.isPitchTracked,
    isYawTracked: Boolean = this.isYawTracked,
    isRollTracked: Boolean = this.isRollTracked
): TrackedDimensions
```

Returns a copy of this object with the given values updated.

| Parameters |
|---|---|
| `isXTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = this.isXTracked` | Whether to track translation along the X axis. |
| `isYTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = this.isYTracked` | Whether to track translation along the Y axis. |
| `isZTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = this.isZTracked` | Whether to track translation along the Z axis. |
| `isPitchTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = this.isPitchTracked` | Whether to track rotation around the X axis. |
| `isYawTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = this.isYawTracked` | Whether to track rotation around the Y axis. |
| `isRollTracked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = this.isRollTracked` | Whether to track rotation around the Z axis. |

### equals

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

### hashCode

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

### toString

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

## Public properties

### isPitchTracked

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

```
val isPitchTracked: Boolean
```

Whether to track pitch rotation.

### isRollTracked

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

```
val isRollTracked: Boolean
```

Whether to track roll rotation.

### isXTracked

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

```
val isXTracked: Boolean
```

Whether to track translation along the X axis.

### isYTracked

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

```
val isYTracked: Boolean
```

Whether to track translation along the Y axis.

### isYawTracked

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

```
val isYawTracked: Boolean
```

Whether to track yaw rotation.

### isZTracked

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

```
val isZTracked: Boolean
```

Whether to track translation along the Z axis.