Struct ClipDrawOptions

The user-defined options for drawing a clip.

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 ClipDrawOptions

Properties

displayClipName

Controls the display of the clip name.

Declaration

public bool displayClipName { get; set; }

Property Value

Type	Description
bool

Remarks

Set to true to display the clip name. Set to false to avoid drawing the clip name.

errorText

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

hideScaleIndicator

Controls the display of the clip scale indicator.

Declaration

public bool hideScaleIndicator { readonly get; set; }

Property Value

Type	Description
bool

Remarks

Set to true to hide the clip scale indicator. This is useful if the scale indicator is interfering with your custom clip rendering, or if the scale indicator is not useful for your clip.

highlightColor

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

Declaration

public Color highlightColor { readonly 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>

The tooltip to show for the clip.

Declaration

public string tooltip { readonly get; set; }

Property Value

Type	Description
string

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(ClipDrawOptions)

Compares this object with another ClipDrawOptions.

Declaration

public bool Equals(ClipDrawOptions other)

Parameters

Type	Name	Description
ClipDrawOptions	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 ==(ClipDrawOptions, ClipDrawOptions)

Compares two ClipDrawOptions objects.

Declaration

public static bool operator ==(ClipDrawOptions options1, ClipDrawOptions options2)

Parameters

Type	Name	Description
ClipDrawOptions	options1	The first object.
ClipDrawOptions	options2	The second object.

Returns

Type	Description
bool	Returns true if they are equal.

operator !=(ClipDrawOptions, ClipDrawOptions)

Compares two ClipDrawOptions objects.

Declaration

public static bool operator !=(ClipDrawOptions options1, ClipDrawOptions options2)

Parameters

Type	Name	Description
ClipDrawOptions	options1	The first object.
ClipDrawOptions	options2	The second object.

Returns

Type	Description
bool	Returns true if they are not equal.