FollowThresholds

@ExperimentalFollowingSubspaceApi
class FollowThresholds


Defines a movement threshold range for FollowMode within which follow motion is not triggered.

When the following entity is within these thresholds relative to the target pose, it remains stationary. Once the target moves beyond a threshold along any dimension, follow motion begins.

Setting these values low (but above zero) helps filter out micro-movements while the user is relatively stationary. Setting the values high allows the content to remain anchored until the user makes a significant movement, such as relocating to another area.

Summary

Public companion properties

FollowThresholds

Public constructors

FollowThresholds(
    translationMeters: Float,
    pitchDegrees: Float,
    yawDegrees: Float,
    rollDegrees: Float
)

Public functions

open operator Boolean
equals(other: Any?)
open Int
open String

Public properties

Float

The pitch rotation threshold, in degrees, required to trigger follow motion.

Float

The roll rotation threshold, in degrees, required to trigger follow motion.

Float

The translation threshold, in meters, required to trigger follow motion.

Float

The yaw rotation threshold, in degrees, required to trigger follow motion.

Public companion properties

Zero

Added in 1.0.0-beta02
val Zero: FollowThresholds

Public constructors

FollowThresholds

Added in 1.0.0-beta02
FollowThresholds(
    translationMeters: Float = 0.0f,
    pitchDegrees: Float = 0.0f,
    yawDegrees: Float = 0.0f,
    rollDegrees: Float = 0.0f
)
Parameters
translationMeters: Float = 0.0f

The translation threshold, in meters, required to trigger follow motion.

pitchDegrees: Float = 0.0f

The pitch rotation threshold, in degrees, required to trigger follow motion.

yawDegrees: Float = 0.0f

The yaw rotation threshold, in degrees, required to trigger follow motion.

rollDegrees: Float = 0.0f

The roll rotation threshold, in degrees, required to trigger follow motion.

Public functions

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

pitchDegrees

Added in 1.0.0-beta02
val pitchDegrees: Float

The pitch rotation threshold, in degrees, required to trigger follow motion.

rollDegrees

Added in 1.0.0-beta02
val rollDegrees: Float

The roll rotation threshold, in degrees, required to trigger follow motion.

translationMeters

Added in 1.0.0-beta02
val translationMeters: Float

The translation threshold, in meters, required to trigger follow motion.

yawDegrees

Added in 1.0.0-beta02
val yawDegrees: Float

The yaw rotation threshold, in degrees, required to trigger follow motion.