Class ARPlane

Represents a plane (that is, a flat surface) detected by an AR device.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

ARTrackable

ARTrackable<BoundedPlane, ARPlane>

ARPlane

Implements

ITrackable

Inherited Members

ARTrackable<BoundedPlane, ARPlane>.destroyOnRemoval

ARTrackable<BoundedPlane, ARPlane>.trackableId

ARTrackable<BoundedPlane, ARPlane>.pose

ARTrackable<BoundedPlane, ARPlane>.trackingState

ARTrackable<BoundedPlane, ARPlane>.nativePtr

ARTrackable<BoundedPlane, ARPlane>.pending

ARTrackable.trackableId

ARTrackable.pose

ARTrackable.trackingState

ARTrackable.nativePtr

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.ARFoundation

Assembly: Unity.XR.ARFoundation.dll

Syntax

[DefaultExecutionOrder(-2147483646)]
[DisallowMultipleComponent]
public sealed class ARPlane : ARTrackable<BoundedPlane, ARPlane>, ITrackable

Remarks

Generated by the ARPlaneManager when an AR device detects a plane in the environment.

Related information: AR Plane component

Properties

alignment

The alignment of this plane.

Declaration

public PlaneAlignment alignment { get; }

Property Value

Type	Description
PlaneAlignment

boundary

The plane's boundary points, in plane space, that is, relative to this ARPlane's local position and rotation.

Declaration

public NativeArray<Vector2> boundary { get; }

Property Value

Type	Description
NativeArray<Vector2>

center

The 3D center point, in Unity world space.

Declaration

public Vector3 center { get; }

Property Value

Type	Description
Vector3

centerInPlaneSpace

The 2D center point, in plane space

Declaration

public Vector2 centerInPlaneSpace { get; }

Property Value

Type	Description
Vector2

classification

The classification of this plane.

Declaration

[Obsolete("classification has been deprecated in AR Foundation 6.0. Use classifications instead.")]
public PlaneClassification classification { get; }

Property Value

Type	Description
PlaneClassification

classifications

The classifications of this plane.

Declaration

public PlaneClassifications classifications { get; }

Property Value

Type	Description
PlaneClassifications

extents

The physical extents (half dimensions) of the plane in meters.

Declaration

public Vector2 extents { get; }

Property Value

Type	Description
Vector2

infinitePlane

Get the infinite plane associated with this ARPlane.

Declaration

public Plane infinitePlane { get; }

Property Value

Type	Description
Plane

normal

Gets the normal to this plane in world space.

Declaration

public Vector3 normal { get; }

Property Value

Type	Description
Vector3

size

The physical size (dimensions) of the plane in meters.

Declaration

public Vector2 size { get; }

Property Value

Type	Description
Vector2

subsumedBy

The ARPlane which has subsumed this plane, or null if this plane has not been subsumed.

Declaration

public ARPlane subsumedBy { get; }

Property Value

Type	Description
ARPlane

vertexChangedThreshold

The largest value by which a plane's vertex could change before the mesh is regenerated. Units are in meters.

Declaration

public float vertexChangedThreshold { get; set; }

Property Value

Type	Description
float

Events

boundaryChanged

Invoked when any vertex in the plane's boundary changes by more than vertexChangedThreshold.

Declaration

public event Action<ARPlaneBoundaryChangedEventArgs> boundaryChanged

Event Type

Type	Description
Action<ARPlaneBoundaryChangedEventArgs>

Implements

ITrackable