# PitchLimits

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/layout/PitchLimits.kt+class:androidx.xr.compose.subspace.layout.PitchLimits) Added in [1.0.0-beta02](https://developer.android.com/jetpack/androidx/releases/xr-compose#1.0.0-beta02)


```
@ExperimentalRotateToLookAtUserApi
value class PitchLimits
```

<br />

*** ** * ** ***

Represents the limits for pitch angles in degrees.

To construct a `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/PitchLimits`, call the factory function that accepts minimum and maximum pitch angles:

```kotlin
val limits = PitchLimits(minimumPitch = -15f, maximumPitch = 15f)
```

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/PitchLimits` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/PitchLimits#FullRange()` A `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/PitchLimits` that allows the full range of pitch angles from -90.0 to 90.0 degrees. |

| ### Public functions |
|---|---|
| `inline operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/PitchLimits#component1()()` |
| `inline operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/PitchLimits#component2()()` |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/PitchLimits` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/PitchLimits#copy(kotlin.Float,kotlin.Float)( minimumPitch: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = -90.0, to = 90.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, maximumPitch: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = -90.0, to = 90.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html )` Returns a copy of this PitchLimits instance optionally overriding the minimumPitch or maximumPitch parameter. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/PitchLimits#toString()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/PitchLimits#maximumPitch()` The maximum allowed pitch angle in degrees. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/PitchLimits#minimumPitch()` The minimum allowed pitch angle in degrees. |

## Public companion properties

### FullRange

```
val FullRange: PitchLimits
```

A `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/PitchLimits` that allows the full range of pitch angles from -90.0 to 90.0 degrees.

## Public functions

### component1

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

```
inline operator fun component1(): Float
```

### component2

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

```
inline operator fun component2(): Float
```

### copy

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

```
fun copy(
    minimumPitch: @FloatRange(from = -90.0, to = 90.0) Float = this.minimumPitch,
    maximumPitch: @FloatRange(from = -90.0, to = 90.0) Float = this.maximumPitch
): PitchLimits
```

Returns a copy of this PitchLimits instance optionally overriding the minimumPitch or maximumPitch parameter.

### toString

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

## Public properties

### maximumPitch

```
val maximumPitch: Float
```

The maximum allowed pitch angle in degrees. Must be in the range -90.0, 90.0.

### minimumPitch

```
val minimumPitch: Float
```

The minimum allowed pitch angle in degrees. Must be in the range -90.0, 90.0.