Class ARPlaneMeshVisualizer

Generates a mesh for an ARPlane.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

ARPlaneMeshVisualizer

Inherited Members

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()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren(bool)

Component.GetComponentInChildren()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren(bool)

Component.GetComponentsInChildren(bool, List)

Component.GetComponentsInChildren()

Component.GetComponentsInChildren(List)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent(bool)

Component.GetComponentInParent()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent(bool)

Component.GetComponentsInParent(bool, List)

Component.GetComponentsInParent()

Component.GetComponents(Type)

Component.GetComponents(Type, List)

Component.GetComponents(List)

Component.GetComponents()

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)

Object.InstantiateAsync(T, Transform)

Object.InstantiateAsync(T, Vector3, Quaternion)

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

Object.InstantiateAsync(T, int)

Object.InstantiateAsync(T, int, Transform)

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

Object.InstantiateAsync(T, int, ReadOnlySpan, ReadOnlySpan)

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

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

Object.InstantiateAsync(T, int, Transform, ReadOnlySpan, ReadOnlySpan)

Object.InstantiateAsync(T, int, Transform, ReadOnlySpan, ReadOnlySpan, CancellationToken)

Object.InstantiateAsync(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync(T, int, ReadOnlySpan, ReadOnlySpan, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate(T, InstantiateParameters)

Object.Instantiate(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate(T)

Object.Instantiate(T, Vector3, Quaternion)

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

Object.Instantiate(T, Transform)

Object.Instantiate(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()

Object.FindObjectsByType(FindObjectsSortMode)

Object.FindObjectsOfType(bool)

Object.FindObjectsByType(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType()

Object.FindObjectOfType(bool)

Object.FindFirstObjectByType()

Object.FindAnyObjectByType()

Object.FindFirstObjectByType(FindObjectsInactive)

Object.FindAnyObjectByType(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

[RequireComponent(typeof(ARPlane))]
public sealed class ARPlaneMeshVisualizer : MonoBehaviour

Remarks

If this component's GameObject has a MeshFilter and/or a MeshCollider, this component will generate a mesh from the BoundedPlane associated with the ARPlane.

It will also update a LineRenderer with the boundary points, if present.

MeshRenderer and LineRenderer components will only be enabled if:

• This component is enabled.
• The plane's trackingState is greater than or equal to trackingStateVisibilityThreshold.
• The ARSession's state is greater than Ready.
• hideSubsumed is false OR subsumedBy is not null.

Related information: Custom plane visualizers

Properties

hideSubsumed

Indicates whether subsumed planes should be rendered. (See subsumedBy.)

Declaration

public bool hideSubsumed { get; set; }

Property Value

Type	Description
bool

Remarks

MeshRenderer and LineRenderer components will only be enabled if:

• This component is enabled.
• The plane's trackingState is greater than or equal to trackingStateVisibilityThreshold.
• The ARSession's state is greater than Ready.
• hideSubsumed is false OR subsumedBy is not null.

mesh

Get the Mesh that this visualizer creates and manages.

Declaration

public Mesh mesh { get; }

Property Value

Type	Description
Mesh

trackingStateVisibilityThreshold

The threshold TrackingState that affects the visibility of the MeshRenderer and LineRenderer components.

Declaration

public TrackingState trackingStateVisibilityThreshold { get; set; }

Property Value

Type	Description
TrackingState

Remarks

MeshRenderer and LineRenderer components will only be enabled if:

• This component is enabled.
• The plane's trackingState is greater than or equal to trackingStateVisibilityThreshold.
• The ARSession's state is greater than Ready.
• hideSubsumed is false OR subsumedBy is not null.