Class SubDirectorClip

A clip representing a nested timeline using another playable director

Inheritance
Object
DOTSClip
SubDirectorClip
Inherited Members
Namespace: Unity.Timeline.ECS
Syntax
[Serializable]
public class SubDirectorClip : DOTSClip, ITimelineClipAsset, IPropertyPreview, IDeclareNestedPlayableDirector

Fields

DefaultClipDuration

The default duration of the timeline. This is set in the editor based on the length of the timeline assigned

Declaration
public double DefaultClipDuration
Field Value
Type Description
Double

subDirector

The sub timeline as a playable director

Declaration
public ExposedReference<PlayableDirector> subDirector
Field Value
Type Description
ExposedReference<PlayableDirector>

Take

Optional reference to a 'take' in the nested timeline

Declaration
public EditTrack Take
Field Value
Type Description
EditTrack

Properties

clipCaps

Declaration
public ClipCaps clipCaps { get; }
Property Value
Type Description
ClipCaps

duration

This is the default duration of the clip used by the UI

Declaration
public override double duration { get; }
Property Value
Type Description
Double

Methods

CreateClipEntity(ConversionContext)

Creates an entity from this clip, using the context object provided. Override this method to change the default clip create method, or return Entity.Null where a conversion is not required

Declaration
public override Entity CreateClipEntity(ConversionContext context)
Parameters
Type Name Description
ConversionContext context
Returns
Type Description
Entity
Overrides
Remarks

Converts the sub director timeline

CreatePlayable(PlayableGraph, GameObject)

Overrides the playable creation

Declaration
public override Playable CreatePlayable(PlayableGraph graph, GameObject go)
Parameters
Type Name Description
PlayableGraph graph
GameObject go
Returns
Type Description
Playable
Overrides
Remarks

Needed to make the sub director in the window contain the correct time

DeclareReferencedPrefabs(ConversionContext, List<GameObject>)

Propagate prefab calls to the Sub-Timeline

Declaration
public override void DeclareReferencedPrefabs(ConversionContext context, List<GameObject> referencedPrefabs)
Parameters
Type Name Description
ConversionContext context
List<GameObject> referencedPrefabs
Overrides

GatherProperties(PlayableDirector, IPropertyCollector)

Propagate any gather calls on to the Sub-Timeline

Declaration
public void GatherProperties(PlayableDirector director, IPropertyCollector driver)
Parameters
Type Name Description
PlayableDirector director
IPropertyCollector driver

GetNestedDirectors(IExposedPropertyTable, List<PlayableDirector>)

Gather nested playable directors

Declaration
public void GetNestedDirectors(IExposedPropertyTable propertyTable, List<PlayableDirector> nestedDirectors)
Parameters
Type Name Description
IExposedPropertyTable propertyTable
List<PlayableDirector> nestedDirectors
Implements