Murl::Graph::IClipSequencer Interface Referenceabstract

The IClipSequencer graph node interface. More...

#include "murl_graph_i_clip_sequencer.h"

Inheritance diagram for Murl::Graph::IClipSequencer:

Public Member Functions

virtual INodeGetNodeInterface ()=0
 Get the mutable Graph::INode interface. More...
 
virtual const INodeGetNodeInterface () const =0
 Get the constant Graph::INode interface. More...
 
virtual IClipNodeTargetGetStartClipNodeTarget ()=0
 Get the mutable Graph::IClipNodeTarget container storing the start clip. More...
 
virtual const IClipNodeTargetGetStartClipNodeTarget () const =0
 Get the constant Graph::IClipNodeTarget container storing the start clip. More...
 
virtual IClipGetCurrentClip ()=0
 Get the currently active clip. More...
 
virtual const IClipGetCurrentClip () const =0
 Get the currently active clip. More...
 
virtual Bool Reset ()=0
 Reset the sequencer to its initial state. More...
 

Detailed Description

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.

Member Function Documentation

◆ GetNodeInterface() [1/2]

virtual INode* Murl::Graph::IClipSequencer::GetNodeInterface ( )
pure virtual

Get the mutable Graph::INode interface.

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

Returns
The mutable Graph::INode interface, or null if not available

◆ GetNodeInterface() [2/2]

virtual const INode* Murl::Graph::IClipSequencer::GetNodeInterface ( ) const
pure virtual

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.

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

◆ GetStartClipNodeTarget() [1/2]

virtual IClipNodeTarget* Murl::Graph::IClipSequencer::GetStartClipNodeTarget ( )
pure virtual

Get the mutable Graph::IClipNodeTarget container storing the start clip.

This method returns a mutable pointer to the node's Graph::IClipNodeTarget container, which allows to set or query the sequencer's start clip.

Returns
The mutable Graph::IClipNodeTarget container.

◆ GetStartClipNodeTarget() [2/2]

virtual const IClipNodeTarget* Murl::Graph::IClipSequencer::GetStartClipNodeTarget ( ) const
pure virtual

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.

Returns
The constant Graph::IClipNodeTarget container.

◆ GetCurrentClip() [1/2]

virtual IClip* Murl::Graph::IClipSequencer::GetCurrentClip ( )
pure virtual

Get the currently active clip.

Returns
A pointer to a mutable clip, or null if none is active.

◆ GetCurrentClip() [2/2]

virtual const IClip* Murl::Graph::IClipSequencer::GetCurrentClip ( ) const
pure virtual

Get the currently active clip.

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

◆ Reset()

virtual Bool Murl::Graph::IClipSequencer::Reset ( )
pure virtual

Reset the sequencer to its initial state.

Returns
true if successful.

The documentation for this interface was generated from the following file:
  • murl_graph_i_clip_sequencer.h


Copyright © 2011-2018 Spraylight GmbH.