Struct TrackDrawOptions

The user-defined options for drawing a track."

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEditor.Timeline

Assembly: Unity.Timeline.Editor.dll

Syntax

public struct TrackDrawOptions

Properties

errorText

Text that indicates if the track should display an error.

Declaration

public string errorText { readonly 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 { readonly 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 { readonly get; set; }

Property Value

Type	Description
float

trackColor

The highlight color of the track.

Declaration

public Color trackColor { readonly 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
bool	Returns true if obj and this instance are the same type and represent the same value.

Overrides

ValueType.Equals(object)

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
bool	Returns true if this and other are equal.

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

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

Overrides

ValueType.GetHashCode()

Operators

operator ==(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
bool	Returns true if they are equal.

operator !=(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
bool	Returns true if they are not equal.