vrdEnvironmentMaterial

class vrdEnvironmentMaterial

(Inherits vrdMaterial)

This is the base class for environment materials vrdSphereEnvironmentMaterial, vrdSkylightMaterial, vrdSubstanceEnvironmentMaterial.

class GeometryType
Custom
Dome
Sphere
Cube

Functions

vrdEnvironmentMaterial.getColorCorrection()

Gets access to all properties of vrdEnvironmentColorCorrection.

Returns:An vrdEnvironmentColorCorrection object, to read and write access of all properties.
Return type:vrdEnvironmentColorCorrection
vrdEnvironmentMaterial.getEnvironment()

Gets environment image.

Returns:The current used environment image.
Return type:vrdImage
vrdEnvironmentMaterial.getExposure()

Get the current value for exposure.

Returns:The current value for exposure.
Return type:float
vrdEnvironmentMaterial.getFilteredEnvMapSamples()

Gets the number of filtered environment map samples.

See vrdEnvironmentMaterial.setFilteredEnvMapSamples(samples) for a description.

Returns:The number filtered environment map samples.
Return type:integer
vrdEnvironmentMaterial.getGeometryFile()

Gets the geometry file which is used for custom geometry type.

This value is identical for all objects. It is not stored and only valid for the current session.

Returns:Globally used geometry file.
Return type:string
vrdEnvironmentMaterial.getGeometryType()

Gets geometry type.

Returns:The current used geometry type.
Return type:vrdEnvironmentMaterial.GeometryType
vrdEnvironmentMaterial.getIlluminateVolumes()
Returns:True if the environment is illuminating all volumes in the scene.
Return type:bool
vrdEnvironmentMaterial.getLuminanceMapping()

Gets the value for luminance mapping.

Returns:The current used luminance mapping.
Return type:float
vrdEnvironmentMaterial.getRaytracing()

Gets access to all raytracing settings of this environment.

Returns:A vrdEnvironmentRaytracingSettings object, to read and write access of all properties.
Return type:vrdEnvironmentRaytracingSettings
vrdEnvironmentMaterial.getShadowsAndIllumination()

Gets access to all properties of vrdEnvironmentShadowsAndIllumination.

Returns:An vrdEnvironmentShadowsAndIllumination object, to read and write access of all properties.
Return type:vrdEnvironmentShadowsAndIllumination
vrdEnvironmentMaterial.getTransformation()

Gets access to all properties of vrdEnvironmentTransformation.

Returns:An vrdEnvironmentTransformation object, to read and write access of all properties.
Return type:vrdEnvironmentTransformation
vrdEnvironmentMaterial.isFlipped()

Gets flipped state. See vrdEnvironmentMaterial.setFlipped(s).

Returns:Current flipped state.
Return type:bool
vrdEnvironmentMaterial.isShadowPlaneVisible()

Gets visibility state of shadow plane.

Returns:Current visibility state of shadow plane.
Return type:bool
vrdEnvironmentMaterial.isVisible()

Gets primary visibility state of the environment.

Returns:Current visibility state.
Return type:bool
vrdEnvironmentMaterial.setExposure(exposure)

Sets the exposure value.

Parameters:exposure (float) – The new used value for exposure.
vrdEnvironmentMaterial.setFilteredEnvMapSamples(samples)

Sets the number of filtered environment map samples.

This value defines the quality for the precomputed glossy IBL. It is also used for the precomputed ray-tracing mode, but not for full global illumination. The entries are internally specifying a sample amount per pixel and correspond to the following values:

Low - 256 samples
Medium - 512 samples
High - 1024 samples
Ultra High - 2048 samples

The higher the value the better the visual quality. The lower the value the faster is the computation.

Parameters:samples (integer) – The samples
vrdEnvironmentMaterial.setFlipped(s)

Flips the normals of the environment sphere.

This changes whether the environment geometry can be viewed from the inside or outside.

Parameters:s (bool) – New flipped state.
vrdEnvironmentMaterial.setGeometryFile(filename)

Load a globally used geometry for custom geometry type from disk.

Parameters:filename (string) – path of the loaded file.
vrdEnvironmentMaterial.setGeometryType(value)

Sets geometry type. It defines the shape of the environment hull. These options are available:

Custom - Uses a custom geometry
Dome - Uses a dome geometry with a flat bottom.
Sphere - Uses a sphere geometry
Cube - Uses a cube geometry
Parameters:value (vrdEnvironmentMaterial.GeometryType) – The new geometry type.
vrdEnvironmentMaterial.setIlluminateVolumes(value)

If enabled the environment will illuminate all volumes in the scene.

Parameters:value (bool) – New state.
vrdEnvironmentMaterial.setLuminanceMapping(luminanceMapping)

Sets the luminance value a RGB value of (1,1,1) in the HDR image is mapped to. The default value is 100 cd/m^2 but a realistic value for many HDRs is 10000 cd/m^2. This option is only available when photometric parameters are turned on.

Parameters:luminanceMapping (float) – The new value for luminance mapping.
vrdEnvironmentMaterial.setShadowPlaneVisible(s)

Sets the shadow plane of the corresponding Environment node to be visible or hidden.

Parameters:s (bool) – New visibility state of shadow plane.
vrdEnvironmentMaterial.setVisible(s)

Sets the primary visibility of the environment.

An environment material set to not be visible can still illuminate scene objects, if it is enabled to be used as light source, and can still be used for specular reflections in Raytracing.

Parameters:s (bool) – New visibility state.
vrdEnvironmentMaterial.toSphericalQImage(width, height, toneMapped=True)

Creates a spherical image from the current environment image.

Parameters:
  • width (integer) – Horizontal resolution
  • height (integer) – Vertical resolution
  • toneMapped (bool) – If ture, the returned image is tone mapped
Returns:

An image with the given resolution
Return type:

QImage