Murl::Graph::IListenerState Interface Referenceabstract

The IListenerState graph node interface. More...

#include "murl_graph_i_listener_state.h"

Inheritance diagram for Murl::Graph::IListenerState:

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

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

See Output-States, Slots und Units for an overview of state handling during scene graph traversal.
See Graph::IListener for defining a specific listener for rendering.
See Graph::IListenerTransform for setting a listener's position and orientation.

Member Function Documentation

◆ GetNodeInterface() [1/2]

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

◆ GetListenerNodeTarget() [1/2]

virtual IListenerNodeTarget* Murl::Graph::IListenerState::GetListenerNodeTarget ( )
pure virtual

Get the mutable Graph::IListenerNodeTarget container.

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

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

◆ GetListenerNodeTarget() [2/2]

virtual const IListenerNodeTarget* Murl::Graph::IListenerState::GetListenerNodeTarget ( ) const
pure virtual

Get the constant Graph::IListenerNodeTarget container.

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

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

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


Copyright © 2011-2018 Spraylight GmbH.