Murl::Graph::IFixedParameters Interface Referenceabstract

The IFixedParameters graph node interface. More...

#include "murl_graph_i_fixed_parameters.h"

Inheritance diagram for Murl::Graph::IFixedParameters:

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 IParametersGetParametersInterface ()=0
 Get the mutable Graph::IParameters interface. More...
 
virtual const IParametersGetParametersInterface () const =0
 Get the constant Graph::IParameters interface. More...
 
virtual IFixedParametersNodeTargetGetParentFixedParametersNodeTarget ()=0
 Get the mutable Graph::IFixedParameters container storing the object's parent. More...
 
virtual const IFixedParametersNodeTargetGetParentFixedParametersNodeTarget () const =0
 Get the constant Graph::IFixedParameters container storing the object's parent. More...
 
virtual UInt32 GetFixedParametersFlags () const =0
 Get current flags. More...
 
virtual void SetShininess (Real shininess)=0
 Set the material shininess (specular exponent). More...
 
virtual Real GetShininess () const =0
 Get the material shininess (specular exponent). More...
 
virtual const ColorGetModulatedColor (IEnums::LightingComponent component) const =0
 Get the color value set for a given lighting component, modulated with an optional parent. More...
 
virtual Real GetModulatedShininess () const =0
 Get the shininess modulated with an optional parent. More...
 
- Public Member Functions inherited from Murl::Graph::IColored
virtual Bool SetColor (IEnums::LightingComponent component, const Color &color)=0
 Set the color value of a given lighting component. More...
 
virtual const ColorGetColor (IEnums::LightingComponent component) const =0
 Get the color value set for a given lighting component. More...
 

Detailed Description

The IFixedParameters graph node interface.

The IFixedParameters interface provides an easy way to define commonly used fixed parameters such as material color or material shininess, to control the appearance of renderable objects in conjunction with a given material.

Use the Graph::IColored base interface to set or get the predefined lighting component color values, such as ambient, diffuse, specular or emissive material properties.

See the Graph::IParameters base interface for additional information.

Member Function Documentation

◆ GetNodeInterface() [1/2]

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

◆ GetParametersInterface() [1/2]

virtual IParameters* Murl::Graph::IFixedParameters::GetParametersInterface ( )
pure virtual

Get the mutable Graph::IParameters interface.

This method returns a mutable pointer to the node's Graph::IParameters interface, to be able to query or modify common parameter properties.

Returns
The mutable Graph::IParameters interface, or null if not available

◆ GetParametersInterface() [2/2]

virtual const IParameters* Murl::Graph::IFixedParameters::GetParametersInterface ( ) const
pure virtual

Get the constant Graph::IParameters interface.

This method returns a constant pointer to the node's Graph::IParameters interface, to be able to query common parameter properties.

Returns
The constant Graph::IParameters interface, or null if not available

◆ GetParentFixedParametersNodeTarget() [1/2]

virtual IFixedParametersNodeTarget* Murl::Graph::IFixedParameters::GetParentFixedParametersNodeTarget ( )
pure virtual

Get the mutable Graph::IFixedParameters container storing the object's parent.

This method returns a mutable pointer to the node's Graph::IFixedParameters container that stores an optional reference to another fixed parameters object, to set or query the object's parent.

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

◆ GetParentFixedParametersNodeTarget() [2/2]

virtual const IFixedParametersNodeTarget* Murl::Graph::IFixedParameters::GetParentFixedParametersNodeTarget ( ) const
pure virtual

Get the constant Graph::IFixedParameters container storing the object's parent.

This method returns a constant pointer to the node's Graph::IFixedParameters container that stores an optional reference to another fixed parameters object, to query the object's parent.

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

◆ GetFixedParametersFlags()

virtual UInt32 Murl::Graph::IFixedParameters::GetFixedParametersFlags ( ) const
pure virtual

Get current flags.

Returns
A bit mask made up from individual FixedParametersFlags values.

◆ SetShininess()

virtual void Murl::Graph::IFixedParameters::SetShininess ( Real  shininess)
pure virtual

Set the material shininess (specular exponent).

Parameters
shininessThe shininess value in the range from 0.0 to 128.0

◆ GetShininess()

virtual Real Murl::Graph::IFixedParameters::GetShininess ( ) const
pure virtual

Get the material shininess (specular exponent).

Returns
The shininess value in the range from 0.0 to 128.0

◆ GetModulatedColor()

virtual const Color& Murl::Graph::IFixedParameters::GetModulatedColor ( IEnums::LightingComponent  component) const
pure virtual

Get the color value set for a given lighting component, modulated with an optional parent.

Parameters
componentThe lighting component.
Returns
The modulated color.

◆ GetModulatedShininess()

virtual Real Murl::Graph::IFixedParameters::GetModulatedShininess ( ) const
pure virtual

Get the shininess modulated with an optional parent.

Returns
The modulated shininess value in the range from 0.0 to 128.0

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


Copyright © 2011-2018 Spraylight GmbH.