androidx.xr.arcore

Kotlin |Java

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.
`ArDevice`	Contains the information of the device that locates it with respect to the real world.
`ArDevice.State`	Contains the current state of the AR Device tracking.
`AugmentedObject`	A representation of a physical object in real space.
`AugmentedObject.State`	The representation of the current state of an `AugmentedObject`.
`CreateGeospatialPoseFromPoseNotTracking`	Result of an unsuccessful `Geospatial.createGeospatialPoseFromPose` call.
`CreateGeospatialPoseFromPoseResult`	Result of a `Geospatial.createGeospatialPoseFromPose` or Geospatial.createGeospatialPoseFromDevicePose call.
`CreateGeospatialPoseFromPoseSuccess`	Result of a successful `Geospatial.createGeospatialPoseFromPose` call.
`CreatePoseFromGeospatialPoseNotTracking`	Result of an unsuccessful `Geospatial.createPoseFromGeospatialPose` call.
`CreatePoseFromGeospatialPoseResult`	Result of a call to `Geospatial.createPoseFromGeospatialPose`.
`CreatePoseFromGeospatialPoseSuccess`	Result of a successful `Geospatial.createPoseFromGeospatialPose` call.
`DepthMap`	Contains the depth map information corresponding to a specific `RenderViewpoint`
`DepthMap.State`	Contains the current state of depth tracking
`Eye`	A representation of a user's eye.
`Eye.State`	The representation of the current state of an `Eye`.
`Face`	Contains the tracking information of a detected human face.
`Face.State`	The representation of the current state of `Face`.
`FaceBlendShapeType`	Represents the type of face blend shape.
`FaceConfidenceRegion`	Represents the regions of face tracking confidence.
`Geospatial`	Provides localization ability in Earth-relative coordinates.
`Geospatial.State`	Describes the state of Geospatial.
`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`.
`RenderViewpoint`	Represents a single viewpoint used for rendering, such as a left eye, right eye, or a mono view.
`RenderViewpoint.State`	Class that contains the current state of the render viewpoint.

Enums

`Hand.HandSide`	The handedness of the user's hand.
`HandJointType`	Represents the type of hand joint.

Top-level functions summary

List<HitResult>

hitTest(session: Session, ray: Ray)

Performs a hit-test using the given ray.

Top-level functions

hitTest

Artifact: androidx.xr.arcore:arcore

View Source

Added in 1.0.0-alpha08

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`.