The IIslandState graph node interface. More...

#include "murl_graph_i_island_state.h"

Inheritance diagram for Murl::Graph::IIslandState:

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 IIslandNodeTargetGetIslandNodeTarget ()=0
 Get the mutable Graph::IIslandNodeTarget container. More...
 
virtual const IIslandNodeTargetGetIslandNodeTarget () const =0
 Get the constant Graph::IIslandNodeTarget container. 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 IIslandState graph node interface.

Island state nodes are used to activate and/or quickly switch between physics simulation islands (Graph::IIsland) during scene graph traversal. As soon as a specific island is activated at a given slot via an island state node, it stays active during traversal until a different island state node using the same slot is encountered.

Use the base interface's IStateSlot::SetSlot() method to set the actual slot index the referenced islandf should be attached to.

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

Member Function Documentation

◆ GetNodeInterface() [1/2]

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

◆ GetIslandNodeTarget() [1/2]

virtual IIslandNodeTarget* Murl::Graph::IIslandState::GetIslandNodeTarget ( )
pure virtual

Get the mutable Graph::IIslandNodeTarget container.

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

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

◆ GetIslandNodeTarget() [2/2]

virtual const IIslandNodeTarget* Murl::Graph::IIslandState::GetIslandNodeTarget ( ) const
pure virtual

Get the constant Graph::IIslandNodeTarget container.

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

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

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


Copyright © 2011-2018 Spraylight GmbH.