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
Syntax
[AddComponentMenu("XR/Visual/XR Interactor Reticle Visual", 11)]
[DisallowMultipleComponent]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.0/api/UnityEngine.XR.Interaction.Toolkit.XRInteractorReticleVisual.html")]
public class XRInteractorReticleVisual : MonoBehaviourRemarks
When attached to an XRRayInteractor, the TryGetCurrentRaycast(out Nullable<RaycastHit>, out Int32, out Nullable<RaycastResult>, out Int32, out Boolean) method will be used instead of the internal ray cast function of this behavior.
Properties
alignPrefabWithSurfaceNormal
Whether Unity aligns the prefab to the ray casted surface normal.
Declaration
public bool alignPrefabWithSurfaceNormal { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
drawWhileSelecting
Whether Unity draws the reticlePrefab while selecting an Interactable.
Declaration
public bool drawWhileSelecting { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
endpointSmoothingTime
Smoothing time for endpoint.
Declaration
public float endpointSmoothingTime { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
maxRaycastDistance
The max distance to Raycast from this Interactor.
Declaration
public float maxRaycastDistance { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
prefabScalingFactor
Amount to scale prefab (before applying distance scaling).
Declaration
public float prefabScalingFactor { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
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 |
|---|---|
| Boolean |
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 |
|---|---|
| Boolean |
Methods
Awake()
See MonoBehaviour.
Declaration
protected void Awake()OnDestroy()
See MonoBehaviour.
Declaration
protected void OnDestroy()Update()
See MonoBehaviour.
Declaration
protected void Update()