Class

ARHitTestResult

Information about a real-world surface found by examining a point in the device camera view of an AR session.

Declaration

class ARHitTestResult : NSObject

Overview

If you display an AR experience using SceneKit or SpriteKit, you can use one of the following methods to search the camera image for real-world content at a point specified in view coordinates:

Otherwise, you can search the camera image for real-world content using the ARFrame hitTest(_:types:) method. Because a frame is independent of a view, for this method you pass a point specified in normalized image coordinates (where (0,0) is the top left corner of the image and (1,1) is the lower right).

All these methods return an array of ARHitTestResult objects describing the content found. The number and order of results in the array depends on the search types you specify and the order you specify them in. For example, consider the code below:

let results = view.hitTest(point, [.existingPlaneUsingGeometry, .estimatedHorizontalPlane])

This hitTest(_:types:) call searches first for plane anchors already present in the session (according to the session configuration's planeDetection settings); returning any such results (in order of distance from the camera) as the first elements in the array. This call also (due to the estimatedHorizontalPlane request) attempts to determine whether the hit test ray intersects any horizontal surface not already found by plane detection, and returns that result (if any) as the last element in the array.

Topics

Identifying Results

var type: ARHitTestResult.ResultType

The kind of detected feature the search result represents.

struct ARHitTestResult.ResultType

Possible types for specifying a hit-test search, or for the result of a hit-test search.

var anchor: ARAnchor?

The anchor representing the detected surface, if any.

Examining Result Geometry

var distance: CGFloat

The distance, in meters, from the camera to the detected surface.

var worldTransform: simd_float4x4

The position and orientation of the hit test result relative to the world coordinate system.

var localTransform: simd_float4x4

The position and orientation of the hit test result relative to the nearest anchor or feature point.

Relationships

Inherits From

Conforms To

See Also

Hit Testing and Real-World Positions

class ARAnchor

A real-world position and orientation that can be used for placing objects in an AR scene.

protocol ARAnchorCopying

Support for custom ARAnchor subclasses.

protocol ARTrackable

A real-world object in a scene for which ARKit tracks changes to position and orientation.