Murl::Graph::ITimelineState Interface Referenceabstract

The ITimelineState graph node interface. More...

#include "murl_graph_i_timeline_state.h"

Inheritance diagram for Murl::Graph::ITimelineState:

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 ITimelineNodeTargetGetTimelineNodeTarget ()=0
 Get the mutable Graph::ITimelineNodeTarget container. More...
 
virtual const ITimelineNodeTargetGetTimelineNodeTarget () const =0
 Get the constant Graph::ITimelineNodeTarget container. More...
 
- Public Member Functions inherited from Murl::Graph::IStateUnit
virtual Bool SetUnit (UInt32 unit)=0
 Set the unit index to use. More...
 
virtual UInt32 GetUnit () const =0
 Get the unit index to use. More...
 

Detailed Description

The ITimelineState graph node interface.

Timeline state nodes are used to activate and/or quickly switch between timelines during scene graph traversal. As soon as a specific timeline is activated via a timeline state node, it stays active during traversal until a different timeline state node is encountered.

See Output-States, Slots und Units for an overview of state handling during scene graph traversal.
See Graph::ITimeline for defining a specific timeline.

Member Function Documentation

◆ GetNodeInterface() [1/2]

virtual INode* Murl::Graph::ITimelineState::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::ITimelineState::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

◆ GetTimelineNodeTarget() [1/2]

virtual ITimelineNodeTarget* Murl::Graph::ITimelineState::GetTimelineNodeTarget ( )
pure virtual

Get the mutable Graph::ITimelineNodeTarget container.

This method returns a mutable pointer to the node's Graph::ITimelineNodeTarget container, which allows to set or query the timeline this state node refers to.

Returns
The mutable Graph::ITimelineNodeTarget container, or null if not available.

◆ GetTimelineNodeTarget() [2/2]

virtual const ITimelineNodeTarget* Murl::Graph::ITimelineState::GetTimelineNodeTarget ( ) const
pure virtual

Get the constant Graph::ITimelineNodeTarget container.

This method returns a constant pointer to the node's Graph::ITimelineNodeTarget container, which allows to query the timeline this state node refers to.

Returns
The mutable Graph::ITimelineNodeTarget container, or null if not available.

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


Copyright © 2011-2018 Spraylight GmbH.