TrackedDimensions
@ExperimentalFollowingSubspaceApi
class TrackedDimensions
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 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, TrackedDimensions.All, or TrackedDimensions.RotationOnly.
Summary
Public companion properties |
|
|---|---|
TrackedDimensions |
TrackedDimensions.All is provided as a convenient way to specify all 6 dimensions of a pose. |
TrackedDimensions |
TrackedDimensions.RotationOnly is provided as a convenient way to specify tracking only rotation dimensions (pitch, yaw, roll). |
Public constructors |
|---|
Public functions |
|
|---|---|
TrackedDimensions |
copy(Returns a copy of this object with the given values updated. |
open operator Boolean |
|
open Int |
hashCode() |
open String |
toString() |
Public properties |
|
|---|---|
Boolean |
Whether to track pitch rotation. |
Boolean |
Whether to track roll rotation. |
Boolean |
Whether to track translation along the X axis. |
Boolean |
Whether to track translation along the Y axis. |
Boolean |
Whether to track yaw rotation. |
Boolean |
Whether to track translation along the Z axis. |
Public companion properties
All
val All: TrackedDimensions
TrackedDimensions.All is provided as a convenient way to specify all 6 dimensions of a pose.
RotationOnly
val RotationOnly: TrackedDimensions
TrackedDimensions.RotationOnly is provided as a convenient way to specify tracking only rotation dimensions (pitch, yaw, roll).
Public constructors
TrackedDimensions
TrackedDimensions(
isXTracked: Boolean = false,
isYTracked: Boolean = false,
isZTracked: Boolean = false,
isPitchTracked: Boolean = false,
isYawTracked: Boolean = false,
isRollTracked: Boolean = false
)
| Parameters | |
|---|---|
isXTracked: Boolean = false |
Whether to track translation along the X axis. |
isYTracked: Boolean = false |
Whether to track translation along the Y axis. |
isZTracked: Boolean = false |
Whether to track translation along the Z axis. |
isPitchTracked: Boolean = false |
Whether to track pitch rotation. |
isYawTracked: Boolean = false |
Whether to track yaw rotation. |
isRollTracked: Boolean = false |
Whether to track roll rotation. |
Public functions
copy
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: Boolean = this.isXTracked |
Whether to track translation along the X axis. |
isYTracked: Boolean = this.isYTracked |
Whether to track translation along the Y axis. |
isZTracked: Boolean = this.isZTracked |
Whether to track translation along the Z axis. |
isPitchTracked: Boolean = this.isPitchTracked |
Whether to track rotation around the X axis. |
isYawTracked: Boolean = this.isYawTracked |
Whether to track rotation around the Y axis. |
isRollTracked: Boolean = this.isRollTracked |
Whether to track rotation around the Z axis. |
Public properties
isXTracked
val isXTracked: Boolean
Whether to track translation along the X axis.
isYTracked
val isYTracked: Boolean
Whether to track translation along the Y axis.
isZTracked
val isZTracked: Boolean
Whether to track translation along the Z axis.