Murl Engine Lua Addon API  Version 1.0 beta
Murl.Graph.IFixedParameters

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.


Table members

Inherited


Murl.Graph.IColored

Enumerations


FixedParametersFlags

Murl.Graph.IFixedParameters.FIXED_PARAMETERS_FLAG_AMBIENT_COLOR_MODIFIED
Murl.Graph.IFixedParameters.FIXED_PARAMETERS_FLAG_DIFFUSE_COLOR_MODIFIED
Murl.Graph.IFixedParameters.FIXED_PARAMETERS_FLAG_SPECULAR_COLOR_MODIFIED
Murl.Graph.IFixedParameters.FIXED_PARAMETERS_FLAG_EMISSIVE_COLOR_MODIFIED
Murl.Graph.IFixedParameters.FIXED_PARAMETERS_FLAG_SHININESS_MODIFIED
Murl.Graph.IFixedParameters.FIXED_PARAMETERS_FLAG_COLOR_MODIFIED
Murl.Graph.IFixedParameters.FIXED_PARAMETERS_FLAG_MODIFIED


Functions



Methods


GetNodeInterface()

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.

Murl.Graph.INode GetNodeInterface()

Returns
Murl.Graph.INode The constant Graph::INode interface, or null if not available

GetParametersInterface()

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.

Murl.Graph.IParameters GetParametersInterface()

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

GetParentFixedParametersNodeTarget()

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.

Murl.Graph.IGenericNodeTarget.GraphIFixedParameters GetParentFixedParametersNodeTarget()

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

GetFixedParametersFlags()

Get current flags.

Integer GetFixedParametersFlags()

Returns
Integer A bit mask made up from individual FixedParametersFlags values.

SetShininess(shininess)

Set the material shininess (specular exponent).

SetShininess(Number shininess)

Parameters
shininessThe shininess value in the range from 0.0 to 128.0

GetShininess()

Get the material shininess (specular exponent).

Number GetShininess()

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

GetModulatedColor(component)

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

Murl.Color GetModulatedColor(Murl.IEnums.LightingComponent component)

Parameters
componentThe lighting component.
Returns
Murl.Color The modulated color.

GetModulatedShininess()

Get the shininess modulated with an optional parent.

Number GetModulatedShininess()

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