Skip to main content

ARDK for Android/com.nianticlabs.ardk/AnchorTrackingState

AnchorTrackingState

[androidJvm]
enum AnchorTrackingState : Enum<AnchorTrackingState>

Represents the current tracking state of a VPS anchor.

The tracking state indicates how well the system is able to track an anchor's position and orientation in the current environment. This information is crucial for determining the reliability of anchor pose data.

Overview​

Tracking states progress from not tracked to fully tracked, with limited tracking representing an intermediate state where tracking is possible but may be less reliable.

Example​

val update = vpsSession.getAnchorUpdate(anchorId)
when (update.trackingState) {
AnchorTrackingState.NOT_TRACKED ->
println("Anchor is not currently being tracked")
AnchorTrackingState.LIMITED ->
println("Anchor tracking is limited - pose may be unreliable")
AnchorTrackingState.TRACKED ->
println("Anchor is fully tracked - pose is reliable")
}

Entries​

NOT_TRACKED[androidJvm]
NOT_TRACKED
The anchor is not currently being tracked.
LIMITED[androidJvm]
LIMITED
The anchor is being tracked with limited accuracy.
TRACKED[androidJvm]
TRACKED
The anchor is being tracked with full accuracy.

Types​

NameSummary
Companion[androidJvm]
object Companion

Properties​

NameSummary
entries[androidJvm]
val entries: EnumEntries<AnchorTrackingState>
Returns a representation of an immutable list of all enum entries, in the order they're declared.
name[androidJvm]
val name: String
ordinal[androidJvm]
val ordinal: Int
value[androidJvm]
val value: Int

Functions​

NameSummary
valueOf[androidJvm]
fun valueOf(value: String): AnchorTrackingState
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
values[androidJvm]
fun values(): Array<AnchorTrackingState>
Returns an array containing the constants of this enum type, in the order they're declared.