Struct ClipBackgroundRegion
Description of the on-screen area where a clip is drawn
Namespace: UnityEditor.Timeline
Syntax
public struct ClipBackgroundRegionConstructors
ClipBackgroundRegion(Rect, Double, Double)
Constructor
Declaration
public ClipBackgroundRegion(Rect _position, double _startTime, double _endTime)Parameters
| Type | Name | Description |
|---|---|---|
| Rect | _position | |
| Double | _startTime | |
| Double | _endTime |
Properties
endTime
The end time of the region, relative to the clip.
Declaration
public double endTime { get; }Property Value
| Type | Description |
|---|---|
| Double |
position
The rectangle where the background of the clip is drawn.
Declaration
public Rect position { get; }Property Value
| Type | Description |
|---|---|
| Rect |
Remarks
The rectangle is clipped to the screen. The rectangle does not include clip borders.
startTime
The start time of the region, relative to the clip.
Declaration
public double startTime { get; }Property Value
| Type | Description |
|---|---|
| Double |
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 |
Equals(ClipBackgroundRegion)
Compares this object with another ClipBackgroundRegion.
Declaration
public bool Equals(ClipBackgroundRegion other)Parameters
| Type | Name | Description |
|---|---|---|
| ClipBackgroundRegion | other | The object to compare with. |
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if |
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(ClipBackgroundRegion, ClipBackgroundRegion)
Compares two ClipBackgroundRegion objects.
Declaration
public static bool operator ==(ClipBackgroundRegion region1, ClipBackgroundRegion region2)Parameters
| Type | Name | Description |
|---|---|---|
| ClipBackgroundRegion | region1 | The first object. |
| ClipBackgroundRegion | region2 | The second object. |
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if they are equal. |
Inequality(ClipBackgroundRegion, ClipBackgroundRegion)
Compares two ClipBackgroundRegion objects.
Declaration
public static bool operator !=(ClipBackgroundRegion region1, ClipBackgroundRegion region2)Parameters
| Type | Name | Description |
|---|---|---|
| ClipBackgroundRegion | region1 | The first object. |
| ClipBackgroundRegion | region2 | The second object. |
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if they are not equal. |