docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class LineProperties

    A collection of visual line properties that can be customized for different endpoint type states.

    Inheritance
    object
    LineProperties
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.XR.Interaction.Toolkit.Interactors.Visuals
    Assembly: Unity.XR.Interaction.Toolkit.dll
    Syntax
    [Serializable]
    public class LineProperties

    Properties

    adjustGradient

    Determine if the line color should change when this state property is active.

    Declaration
    public bool adjustGradient { get; set; }
    Property Value
    Type Description
    bool
    See Also
    noValidHitProperties
    uiHitProperties
    uiPressHitProperties
    hoverHitProperties
    selectHitProperties

    adjustWidth

    Determine if the line width should be customized from defaults when this state property is active.

    Declaration
    public bool adjustWidth { get; set; }
    Property Value
    Type Description
    bool
    See Also
    noValidHitProperties
    uiHitProperties
    uiPressHitProperties
    hoverHitProperties
    selectHitProperties

    customizeExpandLineDrawPercent

    Determine if the line mode expansion should be customized from defaults

    Declaration
    public bool customizeExpandLineDrawPercent { get; set; }
    Property Value
    Type Description
    bool
    See Also
    noValidHitProperties
    uiHitProperties
    uiPressHitProperties
    hoverHitProperties
    selectHitProperties

    endWidth

    Width of the line at the end.

    Declaration
    public float endWidth { get; set; }
    Property Value
    Type Description
    float
    See Also
    noValidHitProperties
    uiHitProperties
    uiPressHitProperties
    hoverHitProperties
    selectHitProperties

    endWidthScaleDistanceFactor

    If greater than 0, the curve end width will be scaled based on the the percentage of the line length to the max visual curve distance, multiplied by the scale factor.

    Declaration
    public float endWidthScaleDistanceFactor { get; set; }
    Property Value
    Type Description
    float
    See Also
    noValidHitProperties
    uiHitProperties
    uiPressHitProperties
    hoverHitProperties
    selectHitProperties

    expandModeLineDrawPercent

    Percent of the line to draw when using the expand from hit point mode when this state property is active.

    Declaration
    public float expandModeLineDrawPercent { get; set; }
    Property Value
    Type Description
    float
    See Also
    noValidHitProperties
    uiHitProperties
    uiPressHitProperties
    hoverHitProperties
    selectHitProperties

    gradient

    Color gradient to use when this state property is active.

    Declaration
    public Gradient gradient { get; set; }
    Property Value
    Type Description
    Gradient
    See Also
    noValidHitProperties
    uiHitProperties
    uiPressHitProperties
    hoverHitProperties
    selectHitProperties

    lineBendRatio

    Ratio to control the bend of the line by adjusting the mid-point. A value of 1 defaults to a straight line.

    Declaration
    public float lineBendRatio { get; set; }
    Property Value
    Type Description
    float
    See Also
    noValidHitProperties
    uiHitProperties
    uiPressHitProperties
    hoverHitProperties
    selectHitProperties

    smoothlyCurveLine

    Determine if the line should smoothly curve when this state property is active. If false, a straight line will be drawn.

    Declaration
    public bool smoothlyCurveLine { get; set; }
    Property Value
    Type Description
    bool
    See Also
    noValidHitProperties
    uiHitProperties
    uiPressHitProperties
    hoverHitProperties
    selectHitProperties

    starWidth

    Width of the line at the start.

    Declaration
    public float starWidth { get; set; }
    Property Value
    Type Description
    float
    See Also
    noValidHitProperties
    uiHitProperties
    uiPressHitProperties
    hoverHitProperties
    selectHitProperties

    See Also

    noValidHitProperties
    uiHitProperties
    uiPressHitProperties
    hoverHitProperties
    selectHitProperties
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)