PitchLimits

@ExperimentalRotateToLookAtUserApi
value class PitchLimits


Represents the limits for pitch angles in degrees.

To construct a PitchLimits, call the factory function that accepts minimum and maximum pitch angles:

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

Summary

Public companion properties

PitchLimits

A PitchLimits that allows the full range of pitch angles from -90.0 to 90.0 degrees.

Public functions

inline operator Float
inline operator Float
PitchLimits
copy(
    minimumPitch: @FloatRange(from = -90.0, to = 90.0) Float,
    maximumPitch: @FloatRange(from = -90.0, to = 90.0) Float
)

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

open String

Public properties

Float

The maximum allowed pitch angle in degrees.

Float

The minimum allowed pitch angle in degrees.

Public companion properties

FullRange

val FullRange: PitchLimits

A 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
inline operator fun component1(): Float

component2

Added in 1.0.0-beta02
inline operator fun component2(): Float

copy

Added in 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.