Instance Property

classificationStatus

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

Declaration

@property(nonatomic, assign, readonly) ARPlaneClassificationStatus classificationStatus;

Discussion

On supported devices, ARKit automatically attempts to characterize each detected plane, describing it as a real-world surface such as as a wall, floor, or table. You can then use this information to enhance the realism of your AR experience; for example, by placing certain virtual content only on floors.

When this property's value is ARPlaneClassificationStatusKnown, the classification property represents ARKit's characterization of the real-world surface corresponding to the plane anchor.

Plane classification can take longer than plane detection, and ARKit reports classifications only for planes where it has a high confidence in the result, so you can use other values of this property to keep track of ARKit's classification process:

Plane classification is available only on iPhone XS, iPhone XS Max, and iPhone XR. Before using classification results, check the classificationSupported class property to make sure you're on a supported device.

See Also

Classifying a Plane

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.

ARPlaneClassificationStatus

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