Class XRInteractorReticleVisual

Interactor helper object that draws a targeting reticlePrefab over a ray casted point in front of the Interactor.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
XRInteractorReticleVisual
Inherited Members
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.XR.Interaction.Toolkit.Interactors.Visuals
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
[AddComponentMenu("XR/Visual/XR Interactor Reticle Visual", 11)]
[DisallowMultipleComponent]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.0/api/UnityEngine.XR.Interaction.Toolkit.Interactors.Visuals.XRInteractorReticleVisual.html")]
public class XRInteractorReticleVisual : MonoBehaviour
Remarks

When attached to an XRRayInteractor, the TryGetCurrentRaycast(out RaycastHit?, out int, out RaycastResult?, out int, out bool) method will be used instead of the internal ray cast function of this behavior.

Properties

alignPrefabWithSurfaceNormal

Whether Unity aligns y-axis of the prefab to the ray casted surface normal. On non-horizontal surfaces this will use the xrOrigin.up to align the z-axis of the prefab. On horizontal surfaces this will use the interactor forward vector to align the z-axis of the prefab.

Declaration
public bool alignPrefabWithSurfaceNormal { get; set; }
Property Value
Type Description
bool
Remarks

If xrOrigin is null it will default to Vector3.up to align the z-axis of the prefab.

drawOnNoHit

Whether Unity draws the reticlePrefab when there is no hit. If true, Unity will draw the reticlePrefab at the last point of a XRRayInteractor.

Declaration
public bool drawOnNoHit { get; set; }
Property Value
Type Description
bool

drawWhileSelecting

Whether Unity draws the reticlePrefab while selecting an Interactable.

Declaration
public bool drawWhileSelecting { get; set; }
Property Value
Type Description
bool

endpointSmoothingTime

Smoothing time for endpoint.

Declaration
public float endpointSmoothingTime { get; set; }
Property Value
Type Description
float

maxRaycastDistance

The max distance to Raycast from this Interactor.

Declaration
public float maxRaycastDistance { get; set; }
Property Value
Type Description
float

prefabScalingFactor

Amount to scale prefab (before applying distance scaling).

Declaration
public float prefabScalingFactor { get; set; }
Property Value
Type Description
float

raycastMask

Layer mask for ray cast.

Declaration
public LayerMask raycastMask { get; set; }
Property Value
Type Description
LayerMask

reticleActive

Whether the reticle is currently active.

Declaration
public bool reticleActive { get; set; }
Property Value
Type Description
bool

reticlePrefab

Prefab which Unity draws over Raycast destination.

Declaration
public GameObject reticlePrefab { get; set; }
Property Value
Type Description
GameObject

undoDistanceScaling

Whether Unity undoes the apparent scale of the prefab by distance.

Declaration
public bool undoDistanceScaling { get; set; }
Property Value
Type Description
bool

Methods

Awake()

See MonoBehaviour.

Declaration
protected void Awake()

OnDestroy()

See MonoBehaviour.

Declaration
protected void OnDestroy()

OnDisable()

See MonoBehaviour.

Declaration
protected void OnDisable()

Update()

See MonoBehaviour.

Declaration
protected void Update()