vrdSkylightMaterial

class vrdSkylightMaterial

(Inherits vrdEnvironmentMaterial)

This class is used to handle all skylight material properties.

Functions

vrdSkylightMaterial.getDate()

Gets the date used to compute the sun position.

Returns:Currently used date
Return type:QDate
vrdSkylightMaterial.getEnvironmentWithSun()

Gets skylight environment image including a rasterized sun. Please note, for vrdSkylightMaterial, vrdEnvironmentMaterial.getEnvironment() returns an image of the sky without sun.

Returns:The current skylight environment image with sun.
Return type:vrdImage
vrdSkylightMaterial.getLocation()

Gets access to all properties of the embedded vrdSkylightLocation object.

Returns:The vrdSkylightLocation object
Return type:vrdSkylightLocation
vrdSkylightMaterial.getResolution()

Gets the resolution of the procedural environment texture.

Returns:Current resolution
Return type:integer
vrdSkylightMaterial.getShowCompass()

Gets the current compass state.

Returns:Is the compass visible
Return type:bool
vrdSkylightMaterial.getSkyAndSun()

Gets access to all properties of the embedded vrdSkylightSkyAndSun object.

Returns:The vrdSkylightLocation object
Return type:vrdSkylightSkyAndSun
vrdSkylightMaterial.getTime()

Gets the local time used to compute the sun position.

Returns:Local time
Return type:QTime
vrdSkylightMaterial.setDate(value)

Sets the date used to compute the sun position. The sun position is computed from Local Time, Date, and Location.

Parameters:value (QDate) – New date
vrdSkylightMaterial.setResolution(value)

Sets the resolution of the procedural environment texture. A higher quality yields higher generation time for the environment, but might be necessary in precomputed illumination mode with animated sun. Default value is 128.

Parameters:value (integer) – New resolution in pixels for one side of the 6-sided environment cube map
vrdSkylightMaterial.setShowCompass(value)

Displays a compass in the render window for the currently selected skylight material. The compass is positioned at the environment’s center and oriented according to the environment rotation.

Parameters:value (bool) – Is the compass visible
vrdSkylightMaterial.setTime(value)

Sets the local time used to compute the sun position. The sun position is computed from Local Time, Date, and Location. Time zone is controlled by vrdSkylightLocation.

Parameters:value (QTime) – New local time