Struct ClipDrawOptions | Timeline | 1.2.18
docs.unity3d.com
    Show / Hide Table of Contents

    Struct ClipDrawOptions

    The user-defined options for drawing a clip.

    Namespace: UnityEditor.Timeline
    Syntax
    public struct ClipDrawOptions

    Properties

    errorText

    Text that indicates if the clip should display an error.

    Declaration
    public string errorText { get; set; }
    Property Value
    Type Description
    String
    Remarks

    If the error text is not empty or null, then the clip displays a warning. The error text is used as the tooltip.

    highlightColor

    The color drawn under the clip. By default, the color is the same as the track color.

    Declaration
    public Color highlightColor { get; set; }
    Property Value
    Type Description
    Color

    icons

    Icons to display on the clip.

    Declaration
    public IEnumerable<Texture2D> icons { get; set; }
    Property Value
    Type Description
    IEnumerable<Texture2D>

    tooltip

    The tooltip to show for the clip.

    Declaration
    public string tooltip { get; set; }
    Property Value
    Type Description
    String

    Methods

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj
    Returns
    Type Description
    Boolean
    Overrides
    ValueType.Equals(Object)

    Equals(ClipDrawOptions)

    Declaration
    public bool Equals(ClipDrawOptions other)
    Parameters
    Type Name Description
    ClipDrawOptions other
    Returns
    Type Description
    Boolean

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32
    Overrides
    ValueType.GetHashCode()

    Operators

    Equality(ClipDrawOptions, ClipDrawOptions)

    Declaration
    public static bool operator ==(ClipDrawOptions options1, ClipDrawOptions options2)
    Parameters
    Type Name Description
    ClipDrawOptions options1
    ClipDrawOptions options2
    Returns
    Type Description
    Boolean

    Inequality(ClipDrawOptions, ClipDrawOptions)

    Declaration
    public static bool operator !=(ClipDrawOptions options1, ClipDrawOptions options2)
    Parameters
    Type Name Description
    ClipDrawOptions options1
    ClipDrawOptions options2
    Returns
    Type Description
    Boolean
    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