Class

ARImageAnchor

Information about the position and orientation of an image detected in a world-tracking AR session.

Declaration

class ARImageAnchor : ARAnchor

Overview

When you run a world-tracking AR session and specify ARReferenceImage objects for the session configuration's detectionImages property, ARKit searches for those images in the real-world environment. When the session recognizes an image, it automatically adds an ARImageAnchor for each detected image to its list of anchors.

To find the extent of a recognized image in the scene, use the inherited transform property together with the physicalSize of the anchor's referenceImage.

Topics

Identifying Detected Images

var referenceImage: ARReferenceImage

The detected image referenced by the image anchor.

Estimating Scale

var estimatedScaleFactor: CGFloat

A factor between the initial size and the estimated physical size.

Beta

Relationships

Inherits From

See Also

Image Tracking

Tracking and Altering Images

Create images from rectangular shapes found in the user’s environment, and augment their appearance.

Detecting Images in an AR Experience

React to known 2D images in the user’s environment, and use their positions to place AR content.

class ARReferenceImage

The description of an image you want ARKit to detect in the physical environment.

class ARImageTrackingConfiguration

A configuration you use when you just want to track known images using the device's back camera feed.

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