Creflectance

Defines the reflectance/transmittance/IOR of a bsdf or coating.

Inherits from

CmaterialPointer.

Method

setActiveIorMode

Sets if the active IOR mode is CUSTOM (complex = 0) or measured (complex = 1, uses a complex IOR file).

Return value

0 = Error setting active IOR mode.

1 = Success.

getActiveIorMode

Gets if the active IOR mode is CUSTOM (complex = 0) or measured (complex = 1, uses a complex IOR file).

Return value

C++

0 = Error getting the active IOR mode.

1 = Success.

Python

Active IOR mode.

setComplexIor

Sets the complex IOR file used when the active IOR mode is 1 (complex mode).

Return value

0 = Error setting complex IOR.

1 = Success.

getComplexIor

Gets the complex IOR file used when the active IOR mode is 1 (complex mode).

setColor

Sets the reflectance color parameters.

Parameters

Return value

0 = Error setting reflectance color.

1 = Success.

Examples

Cmaxwell::CmaterialLayer layer = material.addLayer();
Cmaxwell::Cbsdf bsdf = layer.addBSDF();
layer.setName( "layer" );
Cmaxwell::CmultiValue::Cmap mvMap;
Cmaxwell::Creflectance reflectance = bsdf.getReflectance();

// Set the reflectance color as RGB
Crgb color;
color.assign( 1.0, 1.0, 1.0 );
mvMap.type = Cmaxwell::CmultiValue::Cmap::TYPE_RGB;
mvMap.rgb.assign( color );
reflectance.setColor( "color", mvMap );
reflectance.setActiveColor( "color", mvMap ); // Set RGB as active
 
// Set the reflectance as a texture
mvMap.pFileName = path;
mvMap.uvwChannel = 0;
mvMap.uIsTiled = ...;
reflectance.setColor( "color", mvMap );
reflectance.setActiveColor( "color", mvMap ); // Set texture as active

getColor

Gets the reflectance color parameters.

Parameters

Return value

C++

0 = Error getting the color.

1 = Success.

Python

Cmap containing the color requested.

setActiveColor

Sets the reflectance active color parameters.

Parameters

Return value

0 = Error setting reflectance color.

1 = Success.

Examples

Cmaxwell::CmaterialLayer layer = material.addLayer();
Cmaxwell::Cbsdf bsdf = layer.addBSDF();
layer.setName( "layer" );
Cmaxwell::CmultiValue::Cmap mvMap;
Cmaxwell::Creflectance reflectance = bsdf.getReflectance();

// Set the reflectance color as RGB
Crgb color;
color.assign( 1.0, 1.0, 1.0 );
mvMap.type = Cmaxwell::CmultiValue::Cmap::TYPE_RGB;
mvMap.rgb.assign( color );
reflectance.setColor( "color", mvMap );
reflectance.setActiveColor( "color", mvMap ); // Set RGB as active
 
// Set the reflectance as a texture
mvMap.pFileName = path;
mvMap.uvwChannel = 0;
mvMap.uIsTiled = ...;
reflectance.setColor( "color", mvMap );
reflectance.setActiveColor( "color", mvMap ); // Set texture as active

getActiveColor

Gets the reflectance active color parameters.

Parameters

Return value

C++

0 = Error getting the active color.

1 = Success.

Python

Cmap containing the active color requested.

setAbsorptionDistance

Sets the absorption distance.

Parameters

Return value

0 = Error setting reflectance absorption distance.

1 = Success.

getAbsorptionDistance

Gets the absorption distance of the reflectance.

Parameters

Return value

C++

Absorption distance type ("nanometers", "microns", "millimeters", "centimeters", "decimeters" or "meters").

Python

Tuple containing type ("nanometers", "microns", "millimeters", "centimeters", "decimeters" or "meters") and distance.

setScatteringParameters

Sets the scattering parameters.

Return value

0 = Error setting scattering parameters.

1 = Success.

getScatteringParameters

Gets the scattering parameters.

Return value

C++

0 = Error getting the scattering parameters.

1 = Success.

Python

Tuple containing the scattering parameters (scatteringCoefficient, assymetryFactor, useThickness).

setScatteringThickness

Sets the thickness used for the single side subsurface scattering.

Return value

0 = Error setting the scattering thickness.

1 = Success.

getScatteringThickness

Gets the thickness used for the single side scattering scattering.

Return value

C++

0 = Error getting the thickness.

1 = Success.

Python

Cmap containing the thickness.

setActiveScatteringThickness

Sets the active thickness used for the single side subsurface scattering.

Return value

0 = Error setting the active scattering thickness.

1 = Success.

getActiveScatteringThickness

Gets the active thickness used for the single side subsurface scattering.

Return value

C++

0 = Error getting the active thickness.

1 = Success.

Python

Cmap containing the active thickness.

setScatteringThicknessRange

Sets the scattering thickness range.

Return value

0 = Error setting scattering thickness range.

1 = Success.

getScatteringThicknessRange

Gets the scattering thickness range.

Return value

C++

0 = Error getting the scattering thickness range.

1 = Success.

Python

Tuple containing the scattering thickness range (min,max).

setIOR

Sets the IOR parameters.

Return value

0 = Error setting IOR parameters.

1 = Success.

getIOR

Gets the IOR parameters.

Return value

C++

0 = Error getting the IOR parameters.

1 = Success.

Python

Tuple containing the IOR parameters (nd,abbe).

setConductor

k > 0 means it's a conductor.

Return value

0 = Error setting conductor.

1 = Success.

getConductor

Gets the conductor parameter.

Return value

C++

0 = Error getting the conductor parameter.

1 = Success.

Python

Conductor k value.

enableForceFresnel

Sets the flag to force the fresnel on/off, using only the chromaticism of the reflectance 90 and ignoring its luminescence.

Return value

0 = Error setting force fresnel state.

1 = Success.

getForceFresnel

Gets force fresnel flag.

Return value

C++

0 = Error getting the force fresnel flag.

1 = Success.

Python

Force fresnel flag.

setFresnelCustom

Enables/Disables the custom fresnel values (old R2 controls).

Return value

0 = Error setting custom fresnel values.

1 = Success.

getFresnelCustom

Gets the custom fresnel values.

Return value

C++

0 = Error getting the custom fresnel values.

1 = Success.

Python

Tuple containing the custom fresnel values (angleStrenght, roughnessStrenght, isEnabled).