Murl Engine Lua Addon API  Version 1.0 beta
Murl.Graph.IClipSequencer

The IClipSequencer graph node interface.

A clip sequencer is similar to a state machine, in that it manages a set of individual Graph::IClip child nodes (states) and transitions between them (Graph::IClipTransition). Both types of nodes must be defined as direct children of the sequencer. In addition, a start clip must be defined, which is active when the sequencer is initialized (see GetStartClipNodeTarget()).

Unlike a "traditional" state machine, a clip sequencer allows more than one "state" (i.e. clip) to be active at the same time, in order to smoothly blend between them to create smooth animations. For this reason, the Graph::IClipTransition interface provides methods to set in and out transition durations and offsets.

See Graph::IClip and Graph::IClipTransition for details.


Table members

Methods


GetNodeInterface()

Get the constant Graph::INode interface. This method returns a constant pointer to the node's Graph::INode interface, to be able to query common node properties such as active state, visibility or ID.

Murl.Graph.INode GetNodeInterface()

Returns
Murl.Graph.INode The constant Graph::INode interface, or null if not available

GetStartClipNodeTarget()

Get the constant Graph::IClipNodeTarget container storing the start clip. This method returns a constant pointer to the node's Graph::IClipNodeTarget container, which allows to query the sequencer's start clip.

Murl.Graph.IGenericNodeTarget.GraphIClip GetStartClipNodeTarget()

Returns
Murl.Graph.IGenericNodeTarget.GraphIClip The constant Graph::IClipNodeTarget container.

GetCurrentClip()

Get the currently active clip

Murl.Graph.IClip GetCurrentClip()

Returns
Murl.Graph.IClip A pointer to a constant clip, or null if none is active.

Reset()

Reset the sequencer to its initial state.

Boolean Reset()

Returns
Boolean true if successful.