The ILightState graph node interface. More...

#include "murl_graph_i_light_state.h"

Inheritance diagram for Murl::Graph::ILightState:

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

Light state nodes are used to activate lights for rendering during scene graph traversal. As soon as a specific light is activated via a light state node, it stays active during traversal until a different light state node is encountered.

See Output-States, Slots und Units for an overview of state handling during scene graph traversal.
See Graph::ILight for defining individual light sources and their group assignment.
See Graph::ILightTransform for setting a light's position and orientation.

Member Function Documentation

◆ GetNodeInterface() [1/2]

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

◆ GetLightNodeTarget() [1/2]

virtual ILightNodeTarget* Murl::Graph::ILightState::GetLightNodeTarget ( )
pure virtual

Get the mutable Graph::ILightNodeTarget container.

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

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

◆ GetLightNodeTarget() [2/2]

virtual const ILightNodeTarget* Murl::Graph::ILightState::GetLightNodeTarget ( ) const
pure virtual

Get the constant Graph::ILightNodeTarget container.

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

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

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


Copyright © 2011-2018 Spraylight GmbH.