Class TimelineClipExtensions

Inheritance

Object

TimelineClipExtensions

Namespace: Unity.Timeline.Hybrid

Syntax

public static class TimelineClipExtensions

Methods

CreateClipWeightCurve(TimelineClip)

Gets a single animation curve that represents the weighting curve of the entire clip

Declaration

public static AnimationCurve CreateClipWeightCurve(this TimelineClip clip)

Parameters

Type	Name	Description
TimelineClip	clip

Returns

Type	Description
AnimationCurve	null if the TimelineClip does not have any blend or ease weights

GetActiveRange(TimelineClip)

Returns the start and end range for a TimelineClip as an ActiveRange

Declaration

public static ActiveRange GetActiveRange(this TimelineClip clip)

Parameters

Type	Name	Description
TimelineClip	clip

Returns

Type	Description
ActiveRange

GetEffectiveRange(TimelineClip)

Returns the extrapolated range of the timeline clip, clamped to the length of the timeline

Declaration

public static double2 GetEffectiveRange(this TimelineClip clip)

Parameters

Type	Name	Description
TimelineClip	clip

Returns

Type	Description
Unity.Mathematics.double2

GetMixCurveHash(TimelineClip)

Declaration

public static Hash128 GetMixCurveHash(this TimelineClip clip)

Parameters

Type	Name	Description
TimelineClip	clip

Returns

Type	Description
Hash128

GetSubTimelineRange(TimelineClip)

Returns the active range of the subtimeline of this clip

Declaration

public static ActiveRange GetSubTimelineRange(this TimelineClip clip)

Parameters

Type	Name	Description
TimelineClip	clip

Returns

Type	Description
ActiveRange

GetTimeTransform(TimelineClip)

Gets the parent to local time transform for a TimelineClip

Declaration

public static TimeTransform GetTimeTransform(this TimelineClip clip)

Parameters

Type	Name	Description
TimelineClip	clip

Returns

Type	Description
TimeTransform

InRangeInclLoops(ActiveRange, ActiveRange, ActiveRange)

Checks if a timeline clip is within range, including loops of the timeline asset.

Declaration

public static bool InRangeInclLoops(ActiveRange clipRange, ActiveRange activeRange, ActiveRange timelineRange)

Parameters

Type	Name	Description
ActiveRange	clipRange	The range of the TimelineClip including Loops
ActiveRange	activeRange	The active range to check. If this is larger than the timelines range, it is checked for loops
ActiveRange	timelineRange

Returns

Type	Description
Boolean

InRangeInclLoops(TimelineClip, ActiveRange)

Checks if a timeline clip is within range, including loops of the timeline asset.

Declaration

public static bool InRangeInclLoops(this TimelineClip clip, ActiveRange activeRange)

Parameters

Type	Name	Description
TimelineClip	clip	The TimelineClip including Loops
ActiveRange	activeRange	The active range to check. If this is larger than the timelines range, it is checked for loops

Returns

Type	Description
Boolean