HitResult

Stay organized with collections Save and categorize content based on your preferences.
public class HitResult

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

Public Methods

Anchor
createAnchor()
Creates a new anchor at the hit location.
boolean
equals(Object obj)
Indicates whether some other object is a HitResult referencing the same logical hit result as this one.
float
getDistance()
Returns the distance from the camera to the hit location, in meters.
Pose
getHitPose()
Returns the pose of the intersection between a ray and detected real-world geometry.
Trackable
getTrackable()
Returns the Trackable that was hit.
int
hashCode()
Returns a hash code value for the object.

Inherited Methods

Public Methods

createAnchor

public Anchor createAnchor()

Creates a new anchor at the hit location. See getHitPose() for details.

Anchors incur ongoing processing overhead within ARCore. To release unneeded anchors use Anchor.detach().

This method is a convenience alias for hitResult.getTrackable().createAnchor(hitResult.getHitPose())

Details
Throws
NotTrackingException if the trackable's tracking state was not TrackingState.TRACKING
SessionPausedException if the session had been paused.
ResourceExhaustedException if too many anchors exist.
DeadlineExceededException if the hit result originates from an old Frame.
See Also

equals

public boolean equals(
  Object obj
)

Indicates whether some other object is a HitResult referencing the same logical hit result as this one.

Details
Parameters
obj the reference object with which to compare.
Returns true if this object is the same as the obj argument; false otherwise.
See Also

getDistance

public float getDistance()

Returns the distance from the camera to the hit location, in meters.

getHitPose

public Pose getHitPose()

Returns the pose of the intersection between a ray and detected real-world geometry. The position is the location in space where the ray intersected the geometry. The orientation is a best effort to face the user's device, and its exact definition differs depending on the Trackable that was hit.

Plane: X+ is perpendicular to the cast ray and parallel to the plane, Y+ points along the plane normal (up, for Plane.Type.HORIZONTAL_UPWARD_FACING planes), and Z+ is parallel to the plane, pointing roughly toward the user's device.

Point: Attempt to estimate the normal of the surface centered around the hit test. Surface normal estimation is most likely to succeed on textured surfaces and with camera motion. If Point.getOrientationMode() returns Point.OrientationMode.ESTIMATED_SURFACE_NORMAL, then X+ is perpendicular to the cast ray and parallel to the physical surface centered around the hit test, Y+ points along the estimated surface normal, and Z+ points roughly toward the user's device. If Point.getOrientationMode() returns Point.OrientationMode.INITIALIZED_TO_IDENTITY, then X+ is perpendicular to the cast ray and points right from the perspective of the user's device, Y+ points up, and Z+ points roughly toward the user's device.

If you wish to retain the location of this pose beyond the duration of a single frame, create an Anchor using createAnchor() to save the pose in a physically consistent way.

Details
See Also

getTrackable

public Trackable getTrackable()

Returns the Trackable that was hit.

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

Details
Returns a hash code value for this object.
See Also