vrdEnvironmentRaytracingSettings

class vrdEnvironmentRaytracingSettings

(Inherits vrdSceneObject)

This class is used for all environment raytracing properties.

class Shadowing
FullSphere

FullSphere: Generates shadows based on the full environment sphere.

UpperHemisphere

UpperHemisphere: Generates shadows based on the upper hemisphere of the environment.

Functions

vrdEnvironmentRaytracingSettings.getAnisotropy()

Returns the anisotropy value of the texture.

Returns:The anisotropy value.
Return type:float
vrdEnvironmentRaytracingSettings.getEmitCaustics()

Gets enable state of the HDR to emit photon caustics.

Returns:Current enable state of the HDR to emit photon caustics
Return type:bool
vrdEnvironmentRaytracingSettings.getFilterSampledCaustics()

Gets state of sample caustics.

Returns:Current state of sample caustics
Return type:bool
vrdEnvironmentRaytracingSettings.getImportanceMapQuality()

Gets the quality level for the environment importance map used for IBL sampling.

Returns:Quality level from 1 to 8
Return type:integer
vrdEnvironmentRaytracingSettings.getInteractiveIblSamplingQuality()

Gets the override IBL sampling quality used during interactive rendering.

Returns:Quality level from 0 to 4
Return type:integer
vrdEnvironmentRaytracingSettings.getIsLightsource()

Gets the state of diffuse or glossy illumination calculation.

Returns:Current state of diffuse or glossy illumination calculation
Return type:bool
vrdEnvironmentRaytracingSettings.getIsVisibleInReflections()

Gets the visibility of the environment in reflections.

Returns:Current visibility of the environment in reflections
Return type:bool
vrdEnvironmentRaytracingSettings.getMaterialId()

Gets the ID of the material.

Returns:CurrentID of the material
Return type:integer
vrdEnvironmentRaytracingSettings.getOverrideIblSampling()
Returns:Whether IBL sampling quality override is enabled
Return type:bool
vrdEnvironmentRaytracingSettings.getShadowingMode()

Gets the shadowing mode.

Returns:Current used shadowing mode
Return type:vrdEnvironmentRaytracingSettings.Shadowing
vrdEnvironmentRaytracingSettings.getStillFrameIblSamplingQuality()

Gets the override IBL sampling quality used during still-frame rendering.

Returns:Quality level from 0 to 4
Return type:integer
vrdEnvironmentRaytracingSettings.getUseAccurateReflections()

Gets state of the real environment geometry usage.

Returns:Current state of the real environment geometry usage
Return type:bool
vrdEnvironmentRaytracingSettings.setAnisotropy(anisotropy)

Sets the anisotropy value of the texture.

Parameters:anisotropy (float) – The anisotropy value.
vrdEnvironmentRaytracingSettings.setEmitCaustics(value)

Enables the HDR to emit photon caustics. Only supported in Full Global Illumination mode with caustics (Photon Tracing mode ‘Caustics + Indirect’).

Parameters:value (bool) – New enable state of the HDR to emit photon caustics
vrdEnvironmentRaytracingSettings.setFilterSampledCaustics(value)

If enabled the maximum energy from caustic ray paths is limited to avoid excessive noise. If disabled caustics caused by the environment are accurately sampled.

Parameters:value (bool) – New state of sample caustics
vrdEnvironmentRaytracingSettings.setImportanceMapQuality(value)

Sets the quality level for the environment importance map used for IBL sampling. The quality level is a scaling factor for the resolution of the importance map. Higher value require more memory.

Parameters:value (integer) – New quality level from 1 to 8. Default 1
vrdEnvironmentRaytracingSettings.setInteractiveIblSamplingQuality(value)

Sets the override IBL sampling quality used during interactive rendering.

Parameters:value (integer) – New quality level from 0 to 4. Default 1
vrdEnvironmentRaytracingSettings.setIsLightsource(value)

Does not calculate diffuse or glossy illumination, when disabled. Only one visible environment should have this enabled otherwise, VRED won’t know which environment to use as a light source.

Parameters:value (bool) – State of diffuse or glossy illumination calculation
vrdEnvironmentRaytracingSettings.setIsVisibleInReflections(value)

Toggles the visibility of the environment in reflections.

Parameters:value (bool) – New visibility of the environment in reflections
vrdEnvironmentRaytracingSettings.setMaterialId(value)

Sets the ID of the material for Renderpasses rendering.

Parameters:value (integer) – New ID of the material
vrdEnvironmentRaytracingSettings.setOverrideIblSampling(value)

Enables overriding the global IBL sampling quality for sampling the environment map during interactive or still frame rendering.

Parameters:value (bool) – True to enable override
vrdEnvironmentRaytracingSettings.setShadowingMode(mode)

Sets the shadowing mode to use for environment shadows in the Illumination Mode “Precomputed + Shadows”, shadows on the Shadow Material and shadow lightsources generated for the environment.

Parameters:mode (vrdEnvironmentRaytracingSettings.Shadowing) – New shadowing mode
vrdEnvironmentRaytracingSettings.setStillFrameIblSamplingQuality(value)

Sets the override IBL sampling quality used during still-frame rendering.

Parameters:value (integer) – New quality level from 0 to 4. Default 1
vrdEnvironmentRaytracingSettings.setUseAccurateReflections(value)

Uses the real environment geometry, when enabled, for more accurate diffuse and glossy illumination in Precomputed+IBL and Full Global Illumination Mode (at the cost of a 20 to 25 percent performance hit compared to the default finite sphere environment). It is disabled by default, so all diffuse and glossy reflection calculations are based on the virtual sphere of the environment.

Parameters:value (bool) – New state of the real environment geometry usage