Murl::Graph::ISurfaceState Interface Reference

The ISurfaceState graph node interface. More...

#include "murl_graph_i_surface_state.h"

Inheritance diagram for Murl::Graph::ISurfaceState:

Public Member Functions
virtual INode *	GetNodeInterface ()=0
	Get the mutable Graph::INode interface. More...
virtual const INode *	GetNodeInterface () const =0
	Get the constant Graph::INode interface. More...
virtual ISurfaceNodeTarget *	GetSurfaceNodeTarget ()=0
	Get the mutable Graph::ISurfaceNodeTarget container. More...
virtual const ISurfaceNodeTarget *	GetSurfaceNodeTarget () const =0
	Get the constant Graph::ISurfaceNodeTarget 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 ISurfaceState graph node interface.

Surface state nodes are used to activate and/or quickly switch between physical collision surfaces (Graph::ISurface) during scene graph traversal. As soon as a specific surface is activated at a given slot via a surface state node, it stays active during traversal until a different surface state node using the same slot is encountered.

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

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

Member Function Documentation

GetNodeInterface() [1/2]

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

GetSurfaceNodeTarget() [1/2]

virtual ISurfaceNodeTarget* Murl::Graph::ISurfaceState::GetSurfaceNodeTarget ( )

pure virtual

Get the mutable Graph::ISurfaceNodeTarget container.

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

Returns

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

GetSurfaceNodeTarget() [2/2]

virtual const ISurfaceNodeTarget* Murl::Graph::ISurfaceState::GetSurfaceNodeTarget ( ) const

pure virtual

Get the constant Graph::ISurfaceNodeTarget container.

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

Returns

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

---

The documentation for this interface was generated from the following file:

• murl_graph_i_surface_state.h