androidx.xr.arcore

Interfaces

Trackable

An object that ARCore for Jetpack XR can track and that an Anchor can be attached to.
Trackable.State

The subset of data that is common to the state of all Trackable instances.

Classes

Anchor

An anchor describes a fixed location and orientation in the real world.
Anchor.State

The representation of the current state of an Anchor.
AnchorCreateIllegalState

Result of an unsuccessful Anchor.create call.
AnchorCreateNotAuthorized

Result of an unsuccessful Anchor.create call.
AnchorCreateResourcesExhausted

Result of an unsuccessful Anchor.create or Anchor.load call.
AnchorCreateResult

Result of a Anchor.create or Anchor.load call.
AnchorCreateSuccess

Result of a successful Anchor.create or Anchor.load call.
AnchorCreateTrackingUnavailable

Result of an unsuccessful Anchor.create call.
AnchorCreateUnsupportedLocation

Result of an unsuccessful Anchor.create call.
AnchorLoadInvalidUuid

Result of an unsuccessful Anchor.load call.
Hand

Contains the tracking information of one of the user's hands.
Hand.State

The representation of the current state of Hand.
HitResult

Defines an intersection between a ray and estimated real-world geometry.
PerceptionState

Represents the state of ARCore for Jetpack XR at an specific point in time.
Plane

Describes the system's current best knowledge of a real-world planar surface.
Plane.Label

A semantic description of a Plane.
Plane.State

The representation of the current state of a Plane.
Plane.Type

A simple summary of the normal vector of a Plane.

Enums

Hand.HandSide

The handedness of the user's hand.

Top-level functions summary

List<HitResult>
hitTest(session: Session, ray: Ray)

Performs a hit-test using the given ray.

Top-level functions

hitTest

fun hitTest(session: Session, ray: Ray): List<HitResult>

Performs a hit-test using the given ray.

A hit-test is a method of calculating the intersection of a ray with objects tracked by the session. Conducting a hit-test results in a list of hit objects, in other words, a hit-test does not stop at the first object hit.

Returns
List<HitResult>

A list of HitResult objects, sorted by distance from the origin of the ray. The nearest hit is at the beginning of the list.
Throws
kotlin.IllegalStateException

if Session.config is set to Config.PlaneTrackingMode.DISABLED.