Class

ARPlaneAnchor

Information about the position and orientation of a real-world flat surface detected in a world-tracking AR session.

Overview

When you run a world-tracking AR session whose planeDetection option is enabled, the session automatically adds to its list of anchors an ARPlaneAnchor object for each flat surface ARKit detects with the back-facing camera. Each plane anchor provides information about the estimated position and shape of the surface.

Topics

Determining Plane Orientation

alignment

The general orientation of the detected plane with respect to gravity.

ARPlaneAnchorAlignment

Values describing possible general orientations of a detected plane with respect to gravity.

Using Detailed Plane Geometry

geometry

A coarse triangle mesh representing the general shape of the detected plane.

ARPlaneGeometry

A 3D mesh describing the shape of a detected plane in world-tracking AR sessions.

ARSCNPlaneGeometry

A SceneKit representation of the 2D shape of a plane, for use with plane detection results in an AR session.

Using Basic Plane Dimensions

center

The center point of the plane relative to its anchor position.

extent

The estimated width and length of the detected plane.

Classifying Planes

classificationSupported

A Boolean value that indicates whether plane classification is available on the current device.

classification

A general characterization of what kind of real-world surface the plane anchor represents.

ARPlaneClassification

Possible characterizations of real-world surfaces represented by plane anchors.

classificationStatus

The current state of ARKit's process for classifying the plane anchor.

ARPlaneClassificationStatus

Possible states of ARKit's process for classifying plane anchors.

Relationships

Inherits From

See Also

World Tracking

Building Your First AR Experience

Create an app that runs an AR session and uses plane detection to place 3D content using SceneKit.

Understanding World Tracking in ARKit

Discover supporting concepts, features, and best practices for building great AR experiences.

ARWorldTrackingConfiguration

A configuration that uses the back-facing camera, tracks a device's orientation and position, and detects real-world surfaces, and known images or objects.