TrackedDimensions

@ExperimentalFollowingSubspaceApi
class TrackedDimensions


A set of boolean flags which determine the dimensions of movement that are tracked.

This is intended to be used with a FollowBehavior. 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 translationX and translationZ. Possible values are: isTranslationXTracked, isTranslationYTracked, isTranslationZTracked, isRotationXTracked, isRotationYTracked, isRotationZTracked or TrackedDimensions.All.

FollowingSubspace has been deprecated. Use androidx.xr.compose.spatial.Subspace with androidx.xr.compose.subspace.animation.follow.TrackedDimensions instead.

Summary

Public companion properties

TrackedDimensions

This property is deprecated. FollowingSubspace has been deprecated.

Public constructors

TrackedDimensions(
    isTranslationXTracked: Boolean,
    isTranslationYTracked: Boolean,
    isTranslationZTracked: Boolean,
    isRotationXTracked: Boolean,
    isRotationYTracked: Boolean,
    isRotationZTracked: Boolean
)

This function is deprecated. FollowingSubspace has been deprecated.

Public functions

TrackedDimensions
copy(
    isTranslationXTracked: Boolean,
    isTranslationYTracked: Boolean,
    isTranslationZTracked: Boolean,
    isRotationXTracked: Boolean,
    isRotationYTracked: Boolean,
    isRotationZTracked: Boolean
)

This function is deprecated. FollowingSubspace has been deprecated.

open operator Boolean
equals(other: Any?)

This function is deprecated. FollowingSubspace has been deprecated.

open Int

This function is deprecated. FollowingSubspace has been deprecated.

open String

This function is deprecated. FollowingSubspace has been deprecated.

Public properties

Boolean

This property is deprecated. FollowingSubspace has been deprecated.

Boolean

This property is deprecated. FollowingSubspace has been deprecated.

Boolean

This property is deprecated. FollowingSubspace has been deprecated.

Boolean

This property is deprecated. FollowingSubspace has been deprecated.

Boolean

This property is deprecated. FollowingSubspace has been deprecated.

Boolean

This property is deprecated. FollowingSubspace has been deprecated.

Public companion properties

All

Added in 1.0.0-beta02
Deprecated in 1.0.0-beta02
val All: TrackedDimensions

TrackedDimensions.ALL is provided as a convenient way to specify all 6 dimensions of a pose.

FollowingSubspace has been deprecated. Use androidx.xr.compose.subspace.animation.follow.TrackedDimensions.Companion.All instead.

Public constructors

TrackedDimensions

Added in 1.0.0-beta02
Deprecated in 1.0.0-beta02
TrackedDimensions(
    isTranslationXTracked: Boolean = false,
    isTranslationYTracked: Boolean = false,
    isTranslationZTracked: Boolean = false,
    isRotationXTracked: Boolean = false,
    isRotationYTracked: Boolean = false,
    isRotationZTracked: Boolean = false
)

Public functions

copy

Added in 1.0.0-beta02
Deprecated in 1.0.0-beta02
fun copy(
    isTranslationXTracked: Boolean = this.isTranslationXTracked,
    isTranslationYTracked: Boolean = this.isTranslationYTracked,
    isTranslationZTracked: Boolean = this.isTranslationZTracked,
    isRotationXTracked: Boolean = this.isRotationXTracked,
    isRotationYTracked: Boolean = this.isRotationYTracked,
    isRotationZTracked: Boolean = this.isRotationZTracked
): TrackedDimensions

returns a copy of this object with the given values updated.

Parameters
isTranslationXTracked: Boolean = this.isTranslationXTracked

Whether to track translation along the X axis.

isTranslationYTracked: Boolean = this.isTranslationYTracked

Whether to track translation along the Y axis.

isTranslationZTracked: Boolean = this.isTranslationZTracked

Whether to track translation along the Z axis.

isRotationXTracked: Boolean = this.isRotationXTracked

Whether to track rotation around the X axis.

isRotationYTracked: Boolean = this.isRotationYTracked

Whether to track rotation around the Y axis.

isRotationZTracked: Boolean = this.isRotationZTracked

Whether to track rotation around the Z axis.

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

isRotationXTracked

Added in 1.0.0-beta02
Deprecated in 1.0.0-beta02
val isRotationXTracked: Boolean

isRotationYTracked

Added in 1.0.0-beta02
Deprecated in 1.0.0-beta02
val isRotationYTracked: Boolean

isRotationZTracked

Added in 1.0.0-beta02
Deprecated in 1.0.0-beta02
val isRotationZTracked: Boolean

isTranslationXTracked

Added in 1.0.0-beta02
Deprecated in 1.0.0-beta02
val isTranslationXTracked: Boolean

isTranslationYTracked

Added in 1.0.0-beta02
Deprecated in 1.0.0-beta02
val isTranslationYTracked: Boolean

isTranslationZTracked

Added in 1.0.0-beta02
Deprecated in 1.0.0-beta02
val isTranslationZTracked: Boolean