vrdSkylightSkyAndSun

class vrdSkylightSkyAndSun

(Inherits vrdSceneObject)

This class is used for all skylight properties of vrdSkylightMaterial.

class SkyModel
Artistic
Realistic

Functions

vrdSkylightSkyAndSun.getGroundColor()

Gets the color for the single-colored ground in the lower hemisphere if Use Mirrored Sky as Ground is not active.

Returns:The current color for the ground.
Return type:QVector3D
vrdSkylightSkyAndSun.getSkyModel()

Queries the used sky model.

Returns:The current sky model.
Return type:vrdSkylightSkyAndSun.SkyModel
vrdSkylightSkyAndSun.getSkyTurbidity()

Gets the amount of haze in the atmosphere.

Returns:Current used value for the amount of haze in the atmosphere.
Return type:float
vrdSkylightSkyAndSun.getSunScale()

Gets the size of the sun.

Returns:Current used value for the size of the sun.
Return type:float
vrdSkylightSkyAndSun.getSunVisibleInSpecularReflections()

Queries whether the sun of this skylight material is visible in all specular reflections in the scene.

Returns:whether the sun of this skylight material is visible in all specular reflections in the scene.
Return type:bool
vrdSkylightSkyAndSun.getUseMirroredSkyAsGround()

Queries if the upper hemisphere is mirrored.

Returns:Current state.
Return type:bool
vrdSkylightSkyAndSun.setGroundColor(value)

Sets the color for the single-colored ground in the lower hemisphere if Use Mirrored Sky as Ground is not active.

Parameters:value (QVector3D) – The new color for the ground.
vrdSkylightSkyAndSun.setSkyModel(value)

Choose between two different sky models: Realistic and Artistic. The artistic sky model produces more reddish and colorful skies, especially for sunrise/sunsets.

Parameters:value (vrdSkylightSkyAndSun.SkyModel) – The new sky model.
vrdSkylightSkyAndSun.setSkyTurbidity(value)

Controls the amount of haze in the atmosphere. Low values correspond to a clear sky. The default value of 3.0 is a clear sky in a temperate climate. The maximum value of 10.0 yields a hazy sky.

Parameters:value (float) – New value for the amount of haze in the atmosphere.
vrdSkylightSkyAndSun.setSunScale(value)

Controls the size of the sun. The default value 1.0 corresponds to the actual size of the sun, seen from the earth. The sun is drawn as a filled circle within the sky environment. Increase the sun scale to get softer shadows with raytracing.

Parameters:value (float) – New value for the size of the sun.
vrdSkylightSkyAndSun.setSunVisibleInSpecularReflections(value)

Defines whether the sun of this skylight material is visible in all specular reflections in the scene, for example, on clear coat.

Parameters:value (bool) – State whether the sun of this skylight material is visible in all specular reflections in the scene.
vrdSkylightSkyAndSun.setUseMirroredSkyAsGround(value)

Uses the mirrored upper hemisphere (sky without sun) as the lower hemisphere (ground). If disabled, a uniform colored ground is used, see vrdSkylightSkyAndSun.setGroundColor(value).

Parameters:value (bool) – New state.