The IParameters graph node interface. More...

#include "murl_graph_i_parameters.h"

Inheritance diagram for Murl::Graph::IParameters:

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 IParametersNodeTargetGetSubParametersNodeTarget ()=0
 Get the mutable container holding the optional child parameters. More...
 
virtual const IParametersNodeTargetGetSubParametersNodeTarget () const =0
 Get the constant container holding the optional child parameters. More...
 
virtual UInt32 GetNumberOfDetailLevels () const =0
 Get the parameters' number of detail levels. More...
 
virtual UInt32 GetNumberOfStages (UInt32 detailLevel) const =0
 Get the parameters' number of stages for a given detail level. More...
 
virtual Video::IConstantsGetVideoConstantsObject (UInt32 detailLevel, UInt32 stage) const =0
 Get the parameters' internal video renderer object for a given pass. 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 IParameters graph node interface.

Parameters nodes hold different individual parameters that may be used by a Graph::IProgram to parameterize its output. There exist a number of predefined values for e.g. lighting component color values (see Graph::IFixedParameters); in addition, custom parameters can be added to control the behavior of user-defined GPU shader programs (see Graph::IGenericParameters).

Use the Graph::IStateSlot base interface to set or get the parameters slot index these parameters are temporarily attached to if any children are present.

See Output-States, Slots und Units for an overview of state handling during scene graph traversal.
See Graph::IParametersState for activating parameters for rendering. See Graph::IProgram for defining GPU programs that act on these parameters.

Member Function Documentation

◆ GetNodeInterface() [1/2]

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

◆ GetSubParametersNodeTarget() [1/2]

virtual IParametersNodeTarget* Murl::Graph::IParameters::GetSubParametersNodeTarget ( )
pure virtual

Get the mutable container holding the optional child parameters.

This method returns a mutable pointer to the node's Graph::IParametersNodeTarget sub container, which is used to store multiple sub-parameters.

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

◆ GetSubParametersNodeTarget() [2/2]

virtual const IParametersNodeTarget* Murl::Graph::IParameters::GetSubParametersNodeTarget ( ) const
pure virtual

Get the constant container holding the optional child parameters.

This method returns a constant pointer to the node's Graph::IParametersNodeTarget sub container, which is used to store multiple sub-parameters.

Returns
The constant Graph::IParametersNodeTarget container, or null if not available.

◆ GetNumberOfDetailLevels()

virtual UInt32 Murl::Graph::IParameters::GetNumberOfDetailLevels ( ) const
pure virtual

Get the parameters' number of detail levels.

Returns
The number of detail levels.

◆ GetNumberOfStages()

virtual UInt32 Murl::Graph::IParameters::GetNumberOfStages ( UInt32  detailLevel) const
pure virtual

Get the parameters' number of stages for a given detail level.

Parameters
detailLevelThe detail level to query.
Returns
The number of stages.

◆ GetVideoConstantsObject()

virtual Video::IConstants* Murl::Graph::IParameters::GetVideoConstantsObject ( UInt32  detailLevel,
UInt32  stage 
) const
pure virtual

Get the parameters' internal video renderer object for a given pass.

Parameters
detailLevelThe detail level to query.
stageThe stage to query.
Returns
A pointer to the mutable video renderer object.

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


Copyright © 2011-2018 Spraylight GmbH.