Murl::Graph::ILightStateCopy Interface Referenceabstract

The ILightStateCopy graph node interface. More...

#include "murl_graph_i_light_state_copy.h"

Inheritance diagram for Murl::Graph::ILightStateCopy:

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 SetSourceUnit (UInt32 unit)=0
 Set the source unit to copy the state assignment from. More...
 
virtual UInt32 GetSourceUnit () const =0
 Get the source unit to copy the state assignment from. 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 ILightStateCopy graph node interface.

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

See Graph::ILightState for additional details.

Member Function Documentation

◆ GetNodeInterface() [1/2]

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

◆ SetSourceUnit()

virtual Bool Murl::Graph::ILightStateCopy::SetSourceUnit ( UInt32  unit)
pure virtual

Set the source unit to copy the state assignment from.

Parameters
unitThe source unit, from 0 to IEnums::NUM_LIGHT_UNITS-1.
Returns
true if successful.

◆ GetSourceUnit()

virtual UInt32 Murl::Graph::ILightStateCopy::GetSourceUnit ( ) const
pure virtual

Get the source unit to copy the state assignment from.

Returns
The source unit, from 0 to IEnums::NUM_LIGHT_UNITS-1.

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


Copyright © 2011-2018 Spraylight GmbH.