Struct MarkerOverlayRegion

The description of the on-screen area where the marker is drawn.

Inherited Members

Namespace: UnityEditor.Timeline

Syntax

public struct MarkerOverlayRegion

Constructors

MarkerOverlayRegion(Rect, Rect, Double, Double)

Constructor

Declaration

public MarkerOverlayRegion(Rect _markerRegion, Rect _timelineRegion, double _startTime, double _endTime)

Parameters

Type	Name	Description
Rect	_markerRegion	The area where the marker is being drawn.
Rect	_timelineRegion	The area where the overlay is being drawn.
Double	_startTime	The start time of the visible region of the window.
Double	_endTime	The end time of the visible region of the window.

MarkerOverlayRegion(Rect, Rect, Double, Double, Single)

Constructor

Declaration

public MarkerOverlayRegion(Rect _markerRegion, Rect _timelineRegion, double _startTime, double _endTime, float _trackOffset)

Parameters

Type	Name	Description
Rect	_markerRegion	The area where the marker is being drawn.
Rect	_timelineRegion	The area where the overlay is being drawn.
Double	_startTime	The start time of the visible region of the window.
Double	_endTime	The end time of the visible region of the window.
Single	_trackOffset	The offset from the timelineRegion to the trackRegion

Properties

endTime

The end time of the visible region of the window.

Declaration

public double endTime { readonly get; }

Property Value

Type	Description
Double

markerRegion

The area where the marker is being drawn.

Declaration

public Rect markerRegion { readonly get; }

Property Value

Type	Description
Rect

startTime

The start time of the visible region of the window.

Declaration

public double startTime { readonly get; }

Property Value

Type	Description
Double

timelineRegion

The area where the overlay is being drawn.

This region extends from the top of the time ruler to the bottom of the window, excluding any scrollbars.

Declaration

public Rect timelineRegion { readonly get; }

Property Value

Type	Description
Rect

trackRegion

The sub-area of the timelineRegion where the tracks are drawn.

The region extends from the bottom of the time ruler, or the timeline marker region if not hidden. Use this region to clip overlays that should not be drawn over the timeline marker region or time ruler.

Declaration

public readonly Rect trackRegion { get; }

Property Value

Type	Description
Rect

Examples

       GUI.BeginClip(region.trackRegion, -region.trackRegion.min, Vector2.zero, false);
       EditorGUI.DrawRect(region.markerRegion, Color.blue);
       GUI.EndClip();

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.

Overrides

ValueType.Equals(Object)

Equals(MarkerOverlayRegion)

Compares this object with another MarkerOverlayRegion.

Declaration

public bool Equals(MarkerOverlayRegion other)

Parameters

Type	Name	Description
MarkerOverlayRegion	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.

Overrides

ValueType.GetHashCode()

Operators

Equality(MarkerOverlayRegion, MarkerOverlayRegion)

Compares two MarkerOverlayRegion objects.

Declaration

public static bool operator ==(MarkerOverlayRegion region1, MarkerOverlayRegion region2)

Parameters

Type	Name	Description
MarkerOverlayRegion	region1	The first object.
MarkerOverlayRegion	region2	The second object.

Returns

Type	Description
Boolean	Returns true if they are equal.

Inequality(MarkerOverlayRegion, MarkerOverlayRegion)

Compares two MarkerOverlayRegion objects.

Declaration

public static bool operator !=(MarkerOverlayRegion region1, MarkerOverlayRegion region2)

Parameters

Type	Name	Description
MarkerOverlayRegion	region1	The first object.
MarkerOverlayRegion	region2	The second object.

Returns

Type	Description
Boolean	Returns true if they are not equal.