interface IARPlaneAnchor (Niantic.ARDK.AR.Anchors.IARPlaneAnchor)

Overview

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

interface IARPlaneAnchor: Niantic.ARDK.AR.Anchors.IARAnchor {
    // properties

    PlaneAlignment Alignment;
    Vector3 Center;
    PlaneClassification Classification;
    PlaneClassificationStatus ClassificationStatus;
    Vector3 Extent;
    IARPlaneGeometry Geometry;
};

Inherited Members

public:
    // properties

    AnchorType AnchorType;
    Guid Identifier;
    Matrix4x4 Transform;

Detailed Documentation

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

Note

When a session is run with plane estimation enabled, the Session will search and automatically add anchors representing detected surfaces.

Properties

PlaneAlignment Alignment

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

Vector3 Center

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

PlaneClassification Classification

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

Note

This is only available on iPhone Xs, Xr, Xs Max, with iOS 12+.

PlaneClassificationStatus ClassificationStatus

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

Vector3 Extent

The estimated width and length of the detected plane.

The y-component of this vector will always be zero.

IARPlaneGeometry Geometry

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

Note

May be null.