docs.unity3d.com
    Show / Hide Table of Contents

    Struct TrackDrawOptions

    The user-defined options for drawing a track."

    Namespace: UnityEditor.Timeline
    Syntax
    public struct TrackDrawOptions

    Properties

    errorText

    Text that indicates if the track 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 track displays a warning. The error text is used as the tooltip.

    icon

    The icon displayed on the track header.

    Declaration
    public Texture2D icon { get; set; }
    Property Value
    Type Description
    Texture2D
    Remarks

    If this value is null, then the default icon for the track is used.

    minimumHeight

    The minimum height of the track.

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

    trackColor

    The highlight color of the track.

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

    Methods

    Equals(Object)

    Indicates whether this instance and a specified object are equal.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj

    The object to compare with the current instance.

    Returns
    Type Description
    Boolean

    Returns true if obj and this instance are the same type and represent the same value.

    Equals(TrackDrawOptions)

    Compares this object with another TrackDrawOptions.

    Declaration
    public bool Equals(TrackDrawOptions other)
    Parameters
    Type Name Description
    TrackDrawOptions other

    The object to compare with.

    Returns
    Type Description
    Boolean

    Returns true if this and other are equal.

    GetHashCode()

    Returns the hash code for this instance.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    A 32-bit signed integer that is the hash code for this instance.

    Operators

    Equality(TrackDrawOptions, TrackDrawOptions)

    Compares two TrackDrawOptions objects.

    Declaration
    public static bool operator ==(TrackDrawOptions options1, TrackDrawOptions options2)
    Parameters
    Type Name Description
    TrackDrawOptions options1

    The first object.

    TrackDrawOptions options2

    The second object.

    Returns
    Type Description
    Boolean

    Returns true if they are equal.

    Inequality(TrackDrawOptions, TrackDrawOptions)

    Compares two TrackDrawOptions objects.

    Declaration
    public static bool operator !=(TrackDrawOptions options1, TrackDrawOptions options2)
    Parameters
    Type Name Description
    TrackDrawOptions options1

    The first object.

    TrackDrawOptions options2

    The second object.

    Returns
    Type Description
    Boolean

    Returns true if they are not equal.

    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