Class ARPlane
Represents a plane (that is, a flat surface) detected by an AR device.
Inheritance
Inherited Members
Namespace: UnityEngine.XR.ARFoundation
Assembly: solution.dll
Syntax
[DefaultExecutionOrder(-2147483646)]
[DisallowMultipleComponent]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.arfoundation@4.2/api/UnityEngine.XR.ARFoundation.ARPlane.html")]
public sealed class ARPlane : ARTrackable<BoundedPlane, ARPlane>
Remarks
Generated by the ARPlaneManager when an AR device detects a plane in the environment.
Properties
Name | Description |
---|---|
alignment | The alignment of this plane. |
boundary | The plane's boundary points, in plane space, that is, relative to this ARPlane's local position and rotation. |
center | The 3D center point, in Unity world space. |
centerInPlaneSpace | The 2D center point, in plane space |
classification | The classification of this plane. |
extents | The physical extents (half dimensions) of the plane in meters. |
infinitePlane | Get the infinite plane associated with this ARPlane. |
nativePtr | Get a native pointer associated with this plane. |
normal | Gets the normal to this plane in world space. |
size | The physical size (dimensions) of the plane in meters. |
subsumedBy | The ARPlane which has subsumed this plane, or |
vertexChangedThreshold | The largest value by which a plane's vertex could change before the mesh is regenerated. Units are in meters. |
Events
Name | Description |
---|---|
boundaryChanged | Invoked when any vertex in the plane's boundary changes by more than vertexChangedThreshold. |