Class XRInteractorLineVisual | XR Interaction Toolkit | 0.0.6-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class XRInteractorLineVisual

    Interactor helper object aligns a LineRenderer with the Interactor.

    Inheritance
    Object
    XRInteractorLineVisual
    Namespace: UnityEngine.XR.Interaction.Toolkit
    Syntax
    public class XRInteractorLineVisual : MonoBehaviour, IXRCustomReticleProvider

    Properties

    followTightness

    Gets or sets the speed that the rendered segments will follow the target segments.

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

    invalidColorGradient

    Gets or sets 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
    Type Description
    Gradient

    lineLength

    Gets or sets the width of the line (in centimeters).

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

    lineWidth

    Gets or sets the width of the line (in centimeters).

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

    overrideInteractorLineLength

    Gets or sets the width of the line (in centimeters).

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

    reticle

    Gets or sets the reticle that will appear at the end of the line when it is valid.

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

    smoothMovement

    Gets or sets if enabled, the rendered segments will be delayed from and smoothly follow the target segments.

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

    snapThresholdDistance

    Gets or sets the threshold distance to snap line points when smoothMovement is enabled.

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

    stopLineAtFirstRaycastHit

    Sets whether we cut the line off at the first raycast hit..

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

    validColorGradient

    Gets or sets 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
    Type Description
    Gradient

    Methods

    AttachCustomReticle(GameObject)

    Declaration
    public bool AttachCustomReticle(GameObject reticle)
    Parameters
    Type Name Description
    GameObject reticle
    Returns
    Type Description
    Boolean
    Implements
    IXRCustomReticleProvider.AttachCustomReticle(GameObject)

    RemoveCustomReticle()

    Declaration
    public bool RemoveCustomReticle()
    Returns
    Type Description
    Boolean
    Implements
    IXRCustomReticleProvider.RemoveCustomReticle()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023