Class XRInteractorReticleVisual
Interactor helper object that draws a targeting reticlePrefab over a ray casted point in front of the Interactor.
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit
Assembly: solution.dll
Syntax
[AddComponentMenu("XR/Visual/XR Interactor Reticle Visual", 11)]
[DisallowMultipleComponent]
[HelpURL("https://docs.unity.cn/Packages/com.unity.xr.interaction.toolkit@3.0/api/UnityEngine.XR.Interaction.Toolkit.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
| Name | Description |
|---|---|
| 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. |
| 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. |
| drawWhileSelecting | Whether Unity draws the reticlePrefab while selecting an Interactable. |
| endpointSmoothingTime | Smoothing time for endpoint. |
| maxRaycastDistance | The max distance to Raycast from this Interactor. |
| prefabScalingFactor | Amount to scale prefab (before applying distance scaling). |
| raycastMask | Layer mask for ray cast. |
| reticleActive | Whether the reticle is currently active. |
| reticlePrefab | Prefab which Unity draws over Raycast destination. |
| undoDistanceScaling | Whether Unity undoes the apparent scale of the prefab by distance. |
Methods
| Name | Description |
|---|---|
| Awake() | See MonoBehaviour. |
| OnDestroy() | See MonoBehaviour. |
| OnDisable() | See MonoBehaviour. |
| Update() | See MonoBehaviour. |