Class ARPlaneMeshVisualizer
Generates a mesh for an ARPlane.
Inherited Members
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Object.GetHashCode()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
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 notnull
.
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 notnull
.
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 notnull
.