Interactor helper object aligns a LineRenderer with the Interactor.
Inheritance
XRInteractorLineVisual
[AddComponentMenu("XR/Helpers/XR Interactor Line Visual")]
[DisallowMultipleComponent]
[RequireComponent(typeof(LineRenderer))]
[DefaultExecutionOrder(100)]
public class XRInteractorLineVisual : MonoBehaviour, IXRCustomReticleProvider
Properties
Controls the speed that the rendered segments will follow the target segments when Smooth Movement is enabled.
Declaration
public float followTightness { get; set; }
Property Value
Controls the color of the line as a gradient from start to end to indicate an invalid state.
Declaration
public Gradient invalidColorGradient { get; set; }
Property Value
Controls the length of the line when overriding.
Declaration
public float lineLength { get; set; }
Property Value
Controls the width of the line.
Declaration
public float lineWidth { get; set; }
Property Value
A boolean value that controls which source is used to determine the length of the line.
Set to true to use the Line Length set by this behavior.
Set to false have the length of the line determined by the interactor.
Declaration
public bool overrideInteractorLineLength { get; set; }
Property Value
Stores the reticle that will appear at the end of the line when it is valid.
Declaration
public GameObject reticle { get; set; }
Property Value
Controls whether the rendered segments will be delayed from and smoothly follow the target segments.
Declaration
public bool smoothMovement { get; set; }
Property Value
Controls the threshold distance between line points at two consecutive frames to snap rendered segments to target segments when Smooth Movement is enabled.
Declaration
public float snapThresholdDistance { get; set; }
Property Value
Controls whether the line will always be cut short by this behavior at the first raycast hit, even when invalid.
Declaration
public bool stopLineAtFirstRaycastHit { get; set; }
Property Value
Controls the color of the line as a gradient from start to end to indicate a valid state.
Declaration
public Gradient validColorGradient { get; set; }
Property Value
Controls the relative width of the line from start to end.
Declaration
public AnimationCurve widthCurve { get; set; }
Property Value
Methods
Declaration
public bool AttachCustomReticle(GameObject reticleInstance)
Parameters
Returns
Implements
Declaration
Declaration
protected void OnDisable()
Declaration
protected void OnEnable()
Declaration
protected void OnValidate()
Declaration
public bool RemoveCustomReticle()
Returns
Implements
Declaration
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.