Murl::Graph::IIslandStateCopy Interface Referenceabstract

The IIslandStateCopy graph node interface. More...

#include "murl_graph_i_island_state_copy.h"

Inheritance diagram for Murl::Graph::IIslandStateCopy:

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 Bool SetSourceSlot (SInt32 slot)=0
 Set the source slot to copy the state assignment from. More...
 
virtual SInt32 GetSourceSlot () const =0
 Get the source slot to copy the state assignment from. More...
 
- Public Member Functions inherited from Murl::Graph::IStateSlot
virtual Bool SetSlot (SInt32 slot)=0
 Set the slot index to use. More...
 
virtual SInt32 GetSlot () const =0
 Get the slot index to use. More...
 

Detailed Description

The IIslandStateCopy graph node interface.

Nodes implementing this interface provide a means to copy the current island state assignment (performed via an IIslandState node) at a given source slot to a given destination slot.

See Graph::IIslandState for additional details.

Member Function Documentation

◆ GetNodeInterface() [1/2]

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

◆ SetSourceSlot()

virtual Bool Murl::Graph::IIslandStateCopy::SetSourceSlot ( SInt32  slot)
pure virtual

Set the source slot to copy the state assignment from.

Parameters
slotThe source slot, from 0 to IEnums::NUM_ISLAND_SLOTS-1.
Returns
true if successful.

◆ GetSourceSlot()

virtual SInt32 Murl::Graph::IIslandStateCopy::GetSourceSlot ( ) const
pure virtual

Get the source slot to copy the state assignment from.

Returns
The source slot, from 0 to IEnums::NUM_ISLAND_SLOTS-1.

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


Copyright © 2011-2018 Spraylight GmbH.