Timeline Mixer Documentation
Loading...
Searching...
No Matches
TimelineMixer.AnimationTrackProcessor Class Reference

Processes animation tracks and connects them to the correct mixer on the playable graph. Use the TrackProcessor attribute to set the track type the processor will be in charge of. This track processor is VERY specialized, and should not be used as a basic example. Be careful when modifying this Track Processor. More...

Inheritance diagram for TimelineMixer.AnimationTrackProcessor:
[legend]

Public Member Functions

AnimatorControllerPlayable CreateAnimatorControllerPlayable (Animator animator, PlayableGraph graph, ref PlayableConnectionInfo info)
 Clones the RuntimeAnimatorController created by the AnimatorController, splices it into TimelineMixers graph, and removes the Animator Component reference to prevent conflicts. Even though the Animator holds no reference you can still use Animator methods on it as normal to set parameters, this doesn't change.
PlayableNode GetExternalSystemMixerNode (Animator animator)
 Allows you to get the node for the AnimationMixer that the AnimatorControllers are connected to. This mixer is intended for external systems, if you want to integrate your animation playables, use this to retrieve the mixer.
override void DisconnectTrack (PlayableNode timelineNode, int trackIndex, ref PlayableConnectionInfo info)
 Use this to cleanly disconnect tracks from their mixers and destroy any intermediary Playables. If you have added a lot of mixers or other playables between the timeline and output override this and destroy them here. Used when rebinding a timeline track at runtime, or removing a timeline.
Public Member Functions inherited from TimelineMixer.TrackProcessor
virtual void ProcessTrack (PlayableGraph graph, TrackAsset track, ScriptPlayable< TimelinePlayable > playable, int trackIndex, Object boundComponent, ref PlayableConnectionInfo info)
 Connect the current track index to any required mixer and playable output.

Additional Inherited Members

Protected Member Functions inherited from TimelineMixer.TrackProcessor
void ConnectPlayable (PlayableNode mixerNode, PlayableNode timelineNode, int trackIndex, ref PlayableConnectionInfo info)
 Connects the Timeline Playable to a mixer or passthrough and stores information about connections in the PlayableConnectionInfo.

Detailed Description

Processes animation tracks and connects them to the correct mixer on the playable graph. Use the TrackProcessor attribute to set the track type the processor will be in charge of. This track processor is VERY specialized, and should not be used as a basic example. Be careful when modifying this Track Processor.

Member Function Documentation

◆ CreateAnimatorControllerPlayable()

AnimatorControllerPlayable TimelineMixer.AnimationTrackProcessor.CreateAnimatorControllerPlayable ( Animator animator,
PlayableGraph graph,
ref PlayableConnectionInfo info )
inline

Clones the RuntimeAnimatorController created by the AnimatorController, splices it into TimelineMixers graph, and removes the Animator Component reference to prevent conflicts. Even though the Animator holds no reference you can still use Animator methods on it as normal to set parameters, this doesn't change.

Parameters
animatorThe Animator component we will use to clone the animator controller
graphThe graph that will house the new
Returns

◆ DisconnectTrack()

override void TimelineMixer.AnimationTrackProcessor.DisconnectTrack ( PlayableNode timelineNode,
int trackIndex,
ref PlayableConnectionInfo info )
inlinevirtual

Use this to cleanly disconnect tracks from their mixers and destroy any intermediary Playables. If you have added a lot of mixers or other playables between the timeline and output override this and destroy them here. Used when rebinding a timeline track at runtime, or removing a timeline.

Specialized track processors may need to override this method if they involve multiple Playables between the timeline and the mixer. For example:

  • The audio track processor uses an extra AudioMixerPlayable to work around a bug in the Playables API that affects audio mixing.

The default track processor does not offer blending, so the "mixer" and output are destroyed when disconnected from the timeline.

Parameters
trackIndexThe index of the timeline track to disconnect.

Reimplemented from TimelineMixer.TrackProcessor.

◆ GetExternalSystemMixerNode()

PlayableNode TimelineMixer.AnimationTrackProcessor.GetExternalSystemMixerNode ( Animator animator)
inline

Allows you to get the node for the AnimationMixer that the AnimatorControllers are connected to. This mixer is intended for external systems, if you want to integrate your animation playables, use this to retrieve the mixer.

Parameters
animator
Returns