Plane detection

This page supplements the AR Foundation Plane detection manual. The following sections only contain information about APIs where Google's Android XR runtime exhibits platform-specific behavior.

Tip

When developing an AR app, refer to both the AR Foundation documentation as well as the required packages for each platform you support.

Important

You must ensure to configure the appropriate Permissions to use plane detection features on Android XR.

Optional feature support

Android XR implements the following optional features of AR Foundation's XRPlaneSubsystem:

Feature	Descriptor Property	Supported
Horizontal plane detection	supportsHorizontalPlaneDetection	Yes
Vertical plane detection	supportsVerticalPlaneDetection	Yes
Arbitrary plane detection	supportsArbitraryPlaneDetection	Yes
Boundary vertices	supportsBoundaryVertices	Yes
Classification	supportsClassification	Yes

Note

Refer to AR Foundation Plane detection platform support for more information on the optional features of the Plane subsystem.

Permissions

AR Foundation's plane detection feature requires an Android system permission on the Android XR runtime. Your user must grant your app the android.permission.SCENE_UNDERSTANDING_COARSE or android.permission.SCENE_UNDERSTANDING_FINE` permission before it can track plane data.

To avoid permission-related errors at runtime, set up your scene with the AR Plane Manager component disabled, then enable it only after the required permission is granted.

The following example code demonstrates how to handle required permissions and enable the AR Plane Manager component:

const string k_Permission = "android.permission.SCENE_UNDERSTANDING_COARSE";

[SerializeField]
ARPlaneManager m_ARPlaneManager;

#if UNITY_ANDROID
void Start()
{
    if (!Permission.HasUserAuthorizedPermission(k_Permission))
    {
        var callbacks = new PermissionCallbacks();
        callbacks.PermissionDenied += OnPermissionDenied;
        callbacks.PermissionGranted += OnPermissionGranted;

        Permission.RequestUserPermission(k_Permission, callbacks);
    }
    else
    {
        // enable the AR Plane Manager component if permission is already granted
        m_ARPlaneManager.enabled = true;
    }
}

void OnPermissionDenied(string permission)
{
    // handle denied permission
}

void OnPermissionGranted(string permission)
{
    // enable the AR Plane Manager component after permission is granted
    m_ARPlaneManager.enabled = true;
}
#endif // UNITY_ANDROID

For a code sample that involves multiple permissions in a single request, refer to the Permissions page.

Plane classifications

This package maps Android XR's native plane label component to AR Foundation's PlaneClassifications.

Refer to the following table to understand the mapping between AR Foundation's classifications and Android XR's plane labels:

AR Foundation label	Android XR label
None	UNKNOWN
Table	TABLE
Couch
Floor	FLOOR
Ceiling	CEILING
WallFace	WALL
WallArt
DoorFrame
WindowFrame
InvisibleWallFace
Other