vrdClearcoat

class vrdClearcoat

(Inherits vrdSceneObject)

This class is used for clearcoat properties.

class Type

Off

Off: No clearcoat is used.

Fast

Fast: Schlick approximation for the fresnel term of the clearcoat is used.

Accurate

Accurate: Cook-Torrance approximation for the fresnel term of the clearcoat is used.

UseRefractionIndex

UseRefractionIndex: Uses the refraction index instead of the reflectivity for the clearcoat calculation.

Summary

Functions:

• getColor() → QVector3D
• getColorSpectrum() → vrSpectrum
• getDensity() → float
• getOrangePeelFrequency() → float
• getOrangePeelIntensity() → float
• getReflectivity() → float
• getRefractionIndex() → float
• getRoughness() → float
• getThickness() → float
• getType() → vrdClearcoat.Type
• getUseOrangePeel() → bool
• setColor(value)
• setColorSpectrum(value)
• setDensity(value)
• setOrangePeelFrequency(value)
• setOrangePeelIntensity(value)
• setReflectivity(value)
• setRefractionIndex(value)
• setRoughness(value)
• setThickness(value)
• setType(value)
• setUseOrangePeel(value)
• supportsOrangePeel() → bool
• supportsRefractionIndex() → bool
• supportsThickness() → bool

Functions

vrdClearcoat.getColor()

Gets the color of the clearcoat.

Returns:Current used value of clearcoat color. Return type:QVector3D

vrdClearcoat.getColorSpectrum()

Gets the spectrum of the clearcoat color.

Returns:The current used spectrum for clearcoat color. Return type:vrSpectrum

vrdClearcoat.getDensity()

Gets the density.

Returns:Current used value for the density Return type:float

vrdClearcoat.getOrangePeelFrequency()

Gets the bump structure’s noise frequency.

Returns:The current used value for the bump structure’s noise frequency. Return type:float

vrdClearcoat.getOrangePeelIntensity()

Gets the bump structure’s intensity.

Returns:The current used bump structure’s intensity Return type:float

vrdClearcoat.getReflectivity()

Gets value of clearcoat reflective intensity.

Returns:Current value of clearcoat reflective intensity. Return type:float

vrdClearcoat.getRefractionIndex()

Gets value of clearcoat refraction index.

Returns:Current value of clearcoat refraction index. Return type:float

vrdClearcoat.getRoughness()

Gets value of clearcoat roughness.

Returns:Current value of clearcoat roughness. Return type:float

vrdClearcoat.getThickness()

Gets the thickness of the clearcoat layer.

Returns:Current used value for the thickness Return type:float

vrdClearcoat.getType()

Get the value of clearcoat type.

Returns:Current value of clearcoat type. Return type:vrdClearcoat.Type

vrdClearcoat.getUseOrangePeel()

Query the state of activation of a noisy bump structure in the shader.

Returns:Current state of activation of a noisy bump structure in the shader. Return type:bool

vrdClearcoat.setColor(value)

Sets the color of the clearcoat.

Parameters:value (QVector3D) – New value of clearcoat color.

vrdClearcoat.setColorSpectrum(value)

Sets the spectrum of the clearcoat color.

Parameters:value (vrSpectrum) – New spectrum for clearcoat color

vrdClearcoat.setDensity(value)

Sets the density A value of 0 will use the clearcoat color as reflection color. A value larger than 0 will use the clearcoat color to tint the refraction of the clearcoat depending on the thickness and density settings.

Parameters:value (float) – New value for the density

vrdClearcoat.setOrangePeelFrequency(value)

Sets the bump structure’s noise frequency. The higher the value, the closer together the orange peel bump.

Parameters:value (float) – The new value for the bump structure’s noise frequency.

vrdClearcoat.setOrangePeelIntensity(value)

Sets the bump structure’s intensity. The higher the value, the more visible the orange peel and less smooth the clearcoat surface.

Parameters:value (float) – The new bump structure’s intensity

vrdClearcoat.setReflectivity(value)

Sets the clearcoat reflective intensity. It defines the amount of light reflected at normal incidence. The higher the value, the more reflective the surface.

Parameters:value (float) – New value for clearcoat reflective intensity.

vrdClearcoat.setRefractionIndex(value)

Sets the clearcoat index of refraction.

Parameters:value (float) – New value for clearcoat refraction index.

vrdClearcoat.setRoughness(value)

Controls the sharpness of the clearcoat reflections. The higher the value, the rougher the microscopic structure of the surface and more diffuse the reflections. The lower the value, the glossier the material. A value of 0 creates mirror reflections.

Parameters:value (float) – New value for clearcoat roughness.

vrdClearcoat.setThickness(value)

Sets the thickness of the clearcoat layer. A value of 0 will use the clearcoat color as reflection color. A value larger than 0 will use the clearcoat color to tint the refraction of the clearcoat depending on the thickness and density settings.

Parameters:value (float) – New value for the thickness

vrdClearcoat.setType(value)

Defines the computation method for the clearcoat. Depending on the material the following options can be available:

Off: No clearcoat is used.

Fast: Schlick approximation for the fresnel term of the clearcoat is used.

Accurate: Cook-Torrance approximation for the fresnel term of the clearcoat is used.

UseRefractionIndex: Uses the refraction index instead of the reflectivity for the clearcoat calculation.

Parameters:value (vrdClearcoat.Type) – New value of clearcoat type.

vrdClearcoat.setUseOrangePeel(value)

Activates a noisy bump structure in the shader.

Parameters:value (bool) – New state of activation of a noisy bump structure in the shader.

vrdClearcoat.supportsOrangePeel()

Returns:True if orange peel properties can be changed for this clearcoat, False otherwise Return type:bool

vrdClearcoat.supportsRefractionIndex()

Returns:True if type vrdClearcoat::Type::UseRefractionIndex and refraction index property are supported for this clearcoat, False otherwise Return type:bool

vrdClearcoat.supportsThickness()

Returns:True if thickness and density properties can be changed for this clearcoat, False otherwise Return type:bool