vrdIlluminationBakeSettings¶
-
class
vrdIlluminationBakeSettings¶
(Inherits vrdData)
Settings for texture baking with vrBakeService.bakeToTexture(geometryNodes, illuminationSettings, textureSettings, replaceTextureBake).
Summary¶
- Functions:
- getAmbientOcclusionMaximumDistance() → float
- getAmbientOcclusionMinimumDistance() → float
- getAmbientOcclusionWeight() → vrBakeTypes.AmbientOcclusionWeight
- getColorBleeding() → bool
- getDirectIlluminationMode() → vrBakeTypes.DirectIlluminationMode
- getIndirectIllumination() → bool
- getIndirections() → integer
- getLightsLayer() → integer
- getMaterialOverride() → bool
- getMaterialOverrideColor() → QColor
- setAmbientOcclusionMaximumDistance(value)
- setAmbientOcclusionMinimumDistance(value)
- setAmbientOcclusionWeight(value)
- setColorBleeding(value)
- setDirectIlluminationMode(value)
- setIndirectIllumination(value)
- setIndirections(value)
- setLightsLayer(value)
- setMaterialOverride(value)
- setMaterialOverrideColor(value)
- vrdIlluminationBakeSettings()
Functions¶
-
vrdIlluminationBakeSettings.getAmbientOcclusionMaximumDistance()¶ Returns: The ambient occlusion maximum distance. Return type: float
-
vrdIlluminationBakeSettings.getAmbientOcclusionMinimumDistance()¶ Returns: The ambient occlusion minimum distance. Return type: float
-
vrdIlluminationBakeSettings.getAmbientOcclusionWeight()¶ Returns: The ambient occlusion weight mode. Return type: vrBakeTypes.AmbientOcclusionWeight
-
vrdIlluminationBakeSettings.getColorBleeding()¶ Returns: True if color bleeding should be used, False otherwise. Return type: bool
-
vrdIlluminationBakeSettings.getDirectIlluminationMode()¶ Returns: The direct illumination mode. Return type: vrBakeTypes.DirectIlluminationMode
-
vrdIlluminationBakeSettings.getIndirectIllumination()¶ Returns: True if indirect illumination should be evaluated, False otherwise. Return type: bool
-
vrdIlluminationBakeSettings.getIndirections()¶ Returns: The number of indirections. Return type: integer
-
vrdIlluminationBakeSettings.getLightsLayer()¶ Returns: The layer index used for baking. See vrdIlluminationBakeSettings.setLightsLayer(value). Return type: integer
-
vrdIlluminationBakeSettings.getMaterialOverride()¶ Returns: True if a material override should be used, False otherwise. Return type: bool
-
vrdIlluminationBakeSettings.getMaterialOverrideColor()¶ Returns: The override material color. Return type: QColor
-
vrdIlluminationBakeSettings.setAmbientOcclusionMaximumDistance(value)¶ Sets the ambient occlusion maximum distance.
Sets the maximum distance of objects to be taken into account for the ambient occlusion calculation.
Parameters: value (float) – Distance in mm.
-
vrdIlluminationBakeSettings.setAmbientOcclusionMinimumDistance(value)¶ Sets the ambient occlusion minimum distance.
Sets the minimum distance of objects to be taken into account for the ambient occlusion calculation.
Parameters: value (float) – Distance in mm.
-
vrdIlluminationBakeSettings.setAmbientOcclusionWeight(value)¶ Sets the ambient occlusion weight mode.
Sets how the ambient occlusion samples in the hemisphere above the calculation point are weighted.
Parameters: value (vrBakeTypes.AmbientOcclusionWeight) – The ambient occlusion weight mode.
-
vrdIlluminationBakeSettings.setColorBleeding(value)¶ Sets if color bleeding should be used.
This affects the indirect illumination. If disabled the indirect illumination result is grayscale.
Parameters: value (bool) – True for using color bleeding, False otherwise.
-
vrdIlluminationBakeSettings.setDirectIlluminationMode(value)¶ Sets the direct illumination mode.
This mode defines the kind of data which will be baked.
Parameters: value (vrBakeTypes.DirectIlluminationMode) – The direct illumination mode.
-
vrdIlluminationBakeSettings.setIndirectIllumination(value)¶ Sets if indirect illumination should be evaluated.
Parameters: value (bool) – True for evaluating indirect illumination, False otherwise.
-
vrdIlluminationBakeSettings.setIndirections(value)¶ Sets the number of indirections.
Defines the number of calculated light bounces.
Parameters: value (integer) – Number of indirections.
-
vrdIlluminationBakeSettings.setLightsLayer(value)¶ Only available for texture baking. Sets if only lights from a specific layer should be baked. By default, all active lights are baked.
See vrdBaseLightNode.setBakeLayer(layer) to set the layer for light sources, and vrdIncandescence.setBakeLayer(layer) to set the layer for emissive materials (geometry lights).
Parameters: value (integer) – Layer index. -1 (default) means light layer setting is ignored, i.e. all lights are baked regardless of their layer setting.
Value >= 0 means only lights with matching layer number are evaluated during baking.
For baking base and separate lightmap, use layer 0 (base) and 1 (separate illumination).
-
vrdIlluminationBakeSettings.setMaterialOverride(value)¶ Sets if a global material override should be used.
If enabled, all geometries will have a global diffuse material override during the bake calculation.
Parameters: value (bool) – True for using a material override, False otherwise.
-
vrdIlluminationBakeSettings.setMaterialOverrideColor(value)¶ Sets the color of the override material.
Parameters: value (QColor) – The color value.
-
vrdIlluminationBakeSettings.vrdIlluminationBakeSettings()¶ Default constructor.