PitchLimits

public class PitchLimits internal constructor(private val packedValue: Long)

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)

Properties

minimumPitch

public val minimumPitch: Float

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

maximumPitch

public val maximumPitch: Float

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

Functions

component1

public inline operator fun component1(): Float

component2

public inline operator fun component2(): Float

copy

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

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

toString

override fun toString(): String

Members

Companion

public companion object

Properties

FullRange

public val FullRange: PitchLimits = PitchLimits(-90f, 90f)

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