[AddComponentMenu("XR/Visual/XR Interactor Line Visual", 11)]
[DisallowMultipleComponent]
[RequireComponent(typeof(LineRenderer))]
[DefaultExecutionOrder(100)]
[HelpURL("https://docs.unity.cn/Packages/com.unity.xr.interaction.toolkit@3.0/api/UnityEngine.XR.Interaction.Toolkit.XRInteractorLineVisual.html")]
public class XRInteractorLineVisual : MonoBehaviour, IXRCustomReticleProvider

Properties

Name	Description
autoAdjustLineLength	Determines whether the length of the line will retract over time when no valid hits or selection occur.
blockedColorGradient	Controls the color of the line as a gradient from start to end to indicate a state where the interactor has a valid target but selection is blocked.
blockedReticle	Stores the reticle that appears at the end of the line when the interactor has a valid target but selection is blocked.
followTightness	Controls the speed that the rendered segments follow the target segments when Smooth Movement is enabled.
invalidColorGradient	Controls the color of the line as a gradient from start to end to indicate an invalid state.
lineBendRatio	This ratio determines where the bend point is on a bent line. Line bending occurs due to hitting a snap volume or because the target end point is out of line with the ray. A value of 1 means the line will not bend.
lineLength	Controls the length of the line when overriding.
lineLengthChangeSpeed	Scalar used to control the speed of changes in length of the line when overriding it's length.
lineOriginOffset	Offset from line origin along the line direction before line rendering begins. Only works if the line provider is using straight lines. This value applies even when not overriding the line origin with a different Transform.
lineOriginTransform	The starting position and direction of the line when overriding.
lineRetractionDelay	Time in seconds elapsed after last valid hit or selection for line to begin retracting to the minimum override length.
lineWidth	Controls the width of the line.
minLineLength	Controls the minimum length of the line when overriding. When no valid hits occur, the ray visual shrinks down to this size.
overrideInteractorLineLength	A boolean value that controls which source Unity uses to determine the length of the line. Set to true to use the Line Length set by this behavior. Set to false to have the length of the line determined by the Interactor.
overrideInteractorLineOrigin	A boolean value that controls whether to use a different Transform as the starting position and direction of the line. Set to true to use the line origin specified by lineOriginTransform. Set to false to use the the line origin specified by the interactor.
reticle	Stores the reticle that appears at the end of the line when it is valid.
setLineColorGradient	Determines whether or not this component will control the color of the Line Renderer. Disable to manually control the color externally from this component.
smoothMovement	Controls whether the rendered segments will be delayed from and smoothly follow the target segments.
snapEndpointIfAvailable	Controls whether the visualized line will snap endpoint if the ray hits a XRInteractableSnapVolume.
snapThresholdDistance	Controls the threshold distance between line points at two consecutive frames to snap rendered segments to target segments when Smooth Movement is enabled.
stopLineAtFirstRaycastHit	Controls whether this behavior always cuts the line short at the first ray cast hit, even when invalid.
stopLineAtSelection	Controls whether the line will stop at the attach point of the closest interactable selected by the interactor, if there is one.
treatSelectionAsValidState	Forces the use of valid state visuals while the interactor is selecting an interactable, whether or not the Interactor has any valid targets.
useDistanceToHitAsMaxLineLength	Determines whether the max line length will be the the distance to the hit point or the fixed line length.
validColorGradient	Controls the color of the line as a gradient from start to end to indicate a valid state.
widthCurve	Controls the relative width of the line from start to end.

Methods

Name	Description
AttachCustomReticle(GameObject)	Attaches a custom reticle.
Awake()	See MonoBehaviour.
LateUpdate()	See MonoBehaviour.
OnDestroy()	See MonoBehaviour.
OnDisable()	See MonoBehaviour.
OnEnable()	See MonoBehaviour.
OnValidate()	See MonoBehaviour.
RemoveCustomReticle()	Removes a custom reticle.
Reset()	See MonoBehaviour.