Class

ARReferenceObject

A 3D object to be recognized in the real-world environment during a world-tracking AR session.

Overview

Object detection in ARKit lets you trigger AR content when the session recognizes a known 3D object. For example, your app could detect sculptures in an art museum and provide a virtual curator, or detect tabletop gaming figures and create visual effects for the game.

To provide a known 3D object for detection, you scan a real-world object using ARKit:

  1. Run an AR session using ARObjectScanningConfiguration to enable collection of high-fidelity spatial mapping data.

  2. In that session, point the device camera at the real-world object from various angles, allowing ARKit to build up an internal map of the object and its surroundings. For an example of guiding user interactions to produce good scan data, see Scanning and Detecting 3D Objects.

  3. Determine the portion of the session's world coordinate space representing the object to be recognized, and call createReferenceObjectWithTransform:center:extent:completionHandler: to get that portion as an ARReferenceObject ready for use in object detection.

  4. To save the reference object for use later or elsewhere, use the exportObjectToURL:previewImage:error: method to create an .arobject file.

To detect objects in an AR session, pass a collection of reference objects to your session configuration's detectionObjects property. You need not scan and detect objects in the same app: For example, you might create one app for scanning museum collections that outputs .arobject files, then bundle those files into another app meant for museum visitors.

To bundle reference objects into an app, use your Xcode project's asset catalog:

  1. In your asset catalog, use the Add (+) button to create an AR Resource Group.

  2. Drag .arobject into the resource group to create AR Reference Object entries in the asset catalog.

  3. Optionally, use the Xcode inspector panel to provide a descriptive name for the object, which appears as the name property at runtime and can be useful for debugging.

Topics

Loading Reference Objects

initWithArchiveURL:error:

Loads a reference object from the specified file URL.

referenceObjectsInGroupNamed:bundle:

Loads all reference objects in the specified AR Resource Group in your Xcode project's asset catalog.

Examining a Reference Object

name

A descriptive name for the reference object.

center

The center point of the reference object's space-mapping data.

extent

The size of the reference object's space-mapping data.

scale

A scale factor for the local coordinate space the reference object defines.

Saving Recorded Objects

exportObjectToURL:previewImage:error:

Writes a binary representation of the object to the specified file URL.

ARReferenceObjectArchiveExtension

The standard filename extension for exported ARReferenceObject instances.

Creating Derivative Reference Objects

referenceObjectByApplyingTransform:

Returns a new reference object created by applying the specified transform to this reference object's geometric data.

referenceObjectByMergingObject:error:

Returns a new reference object that combines spatial information from both this reference object and another.

Debugging a Reference Object

rawFeaturePoints

A coarse representation of the space-mapping data contained in the reference object.

Relationships

Inherits From

Conforms To

See Also

Object Detection

Scanning and Detecting 3D Objects

Record spatial features of real-world objects, then use the results to find those objects in the user’s environment and trigger AR content.

ARObjectAnchor

Information about the position and orientation of a real-world 3D object detected in a world-tracking AR session.

Beta
ARObjectScanningConfiguration

A configuration that uses the back-facing camera to collect high-fidelity spatial data for use in scanning 3D objects for later detection.

Beta

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software