The IFixedParameters graph node interface. More...
#include "murl_graph_i_fixed_parameters.h"
Public Member Functions | |
| virtual INode * | GetNodeInterface ()=0 |
| Get the mutable Graph::INode interface. More... | |
| virtual const INode * | GetNodeInterface () const =0 |
| Get the constant Graph::INode interface. More... | |
| virtual IParameters * | GetParametersInterface ()=0 |
| Get the mutable Graph::IParameters interface. More... | |
| virtual const IParameters * | GetParametersInterface () const =0 |
| Get the constant Graph::IParameters interface. More... | |
| virtual IFixedParametersNodeTarget * | GetParentFixedParametersNodeTarget ()=0 |
| Get the mutable Graph::IFixedParameters container storing the object's parent. More... | |
| virtual const IFixedParametersNodeTarget * | GetParentFixedParametersNodeTarget () 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 Color & | GetModulatedColor (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 Color & | GetColor (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]
|
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]
|
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]
|
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]
|
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]
|
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]
|
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()
|
pure virtual |
Get current flags.
- Returns
- A bit mask made up from individual FixedParametersFlags values.
◆ SetShininess()
|
pure virtual |
Set the material shininess (specular exponent).
- Parameters
-
shininess The shininess value in the range from 0.0 to 128.0
◆ GetShininess()
|
pure virtual |
Get the material shininess (specular exponent).
- Returns
- The shininess value in the range from 0.0 to 128.0
◆ GetModulatedColor()
|
pure virtual |
Get the color value set for a given lighting component, modulated with an optional parent.
- Parameters
-
component The lighting component.
- Returns
- The modulated color.
◆ GetModulatedShininess()
|
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