vrdMaterialRaytracingSettings¶
-
class
vrdMaterialRaytracingSettings
¶
(Inherits vrdSceneObject
)
This class is used for all material raytracing properties.
Summary¶
- Functions:
- getIgnorePhotonMap() → bool
- getInteractiveIblSamplingQuality() → integer
- getInteractiveIlluminationMode() → vrdMaterialRaytracingSettings.IlluminationMode
- getInteractiveReflectionSamplingQuality() → integer
- getInteractiveTraceDepth() → integer
- getLineTubeRadius() → float
- getMaterialId() → integer
- getOverrideIblSampling() → bool
- getOverrideIllumination() → bool
- getOverrideReflectionSampling() → bool
- getOverrideTraceDepth() → bool
- getStillFrameIblSamplingQuality() → integer
- getStillFrameIlluminationMode() → vrdMaterialRaytracingSettings.IlluminationMode
- getStillFrameReflectionSamplingQuality() → integer
- getStillFrameTraceDepth() → integer
- getUseLocalEnvironment() → bool
- setIgnorePhotonMap(value)
- setInteractiveIblSamplingQuality(value)
- setInteractiveIlluminationMode(mode)
- setInteractiveReflectionSamplingQuality(value)
- setInteractiveTraceDepth(value)
- setLineTubeRadius(value)
- setMaterialId(value)
- setOverrideIblSampling(value)
- setOverrideIllumination(value)
- setOverrideReflectionSampling(value)
- setOverrideTraceDepth(value)
- setStillFrameIblSamplingQuality(value)
- setStillFrameIlluminationMode(mode)
- setStillFrameReflectionSamplingQuality(value)
- setStillFrameTraceDepth(value)
- setUseLocalEnvironment(value)
Functions¶
-
vrdMaterialRaytracingSettings.
getIgnorePhotonMap
()¶ Returns: True if path tracing is used on this material even when photon mapping is turned on Return type: bool
-
vrdMaterialRaytracingSettings.
getInteractiveIblSamplingQuality
()¶ Returns: Current IBL Sampling quality override for sampling the environment map for interactive rendering Return type: integer
-
vrdMaterialRaytracingSettings.
getInteractiveIlluminationMode
()¶ Returns: Current override illumination mode for interactive rendering Return type: vrdMaterialRaytracingSettings.IlluminationMode
-
vrdMaterialRaytracingSettings.
getInteractiveReflectionSamplingQuality
()¶ Returns: Current sampling quality override for reflections and refractions for interactive rendering Return type: integer
-
vrdMaterialRaytracingSettings.
getInteractiveTraceDepth
()¶ Returns: Current trace depth override during interactive rendering Return type: integer
-
vrdMaterialRaytracingSettings.
getLineTubeRadius
()¶ Gets the radius of tubes that are used to render lines in raytracing.
Returns: Current radius of tubes that are used to render lines in raytracing Return type: float
-
vrdMaterialRaytracingSettings.
getMaterialId
()¶ Gets the ID of the material for Renderpasses rendering.
Returns: Current ID of the material Return type: integer
-
vrdMaterialRaytracingSettings.
getOverrideIblSampling
()¶ Returns: If IBL Sampling quality override is enabled for this material Return type: bool
-
vrdMaterialRaytracingSettings.
getOverrideIllumination
()¶ Returns: If illumination mode override is enabled for this material Return type: bool
-
vrdMaterialRaytracingSettings.
getOverrideReflectionSampling
()¶ Returns: If sampling quality override for reflections and refractions is enabled for this material Return type: bool
-
vrdMaterialRaytracingSettings.
getOverrideTraceDepth
()¶ Returns: If trace depth override is enabled for this material Return type: bool
-
vrdMaterialRaytracingSettings.
getStillFrameIblSamplingQuality
()¶ Returns: Current IBL Sampling quality override for sampling the environment map for still frame rendering Return type: integer
-
vrdMaterialRaytracingSettings.
getStillFrameIlluminationMode
()¶ Returns: Current illumination mode override for for still frame rendering Return type: vrdMaterialRaytracingSettings.IlluminationMode
-
vrdMaterialRaytracingSettings.
getStillFrameReflectionSamplingQuality
()¶ Returns: Current sampling quality override for reflections and refractions for still frame rendering Return type: integer
-
vrdMaterialRaytracingSettings.
getStillFrameTraceDepth
()¶ Returns: Current trace depth override during still-frame rendering Return type: integer
-
vrdMaterialRaytracingSettings.
getUseLocalEnvironment
()¶ Returns: If local environment (the environment assigned to the material, see vrdBRDFCommonSettings.getEnvironment()) is used for diffuse and glossy reflections in raytracing. Return type: bool
-
vrdMaterialRaytracingSettings.
setIgnorePhotonMap
(value)¶ Uses path tracing on this material even when photon mapping is turned on.
Parameters: value (bool) – New state of path tracing usage
-
vrdMaterialRaytracingSettings.
setInteractiveIblSamplingQuality
(value)¶ Sets the IBL Sampling quality override for sampling the environment map for interactive rendering.
Parameters: value (integer) – Override quality from 0 to 4. Default 1
-
vrdMaterialRaytracingSettings.
setInteractiveIlluminationMode
(mode)¶ Sets the override illumination mode for interactive rendering.
Parameters: mode (vrdMaterialRaytracingSettings.IlluminationMode) – Override mode
-
vrdMaterialRaytracingSettings.
setInteractiveReflectionSamplingQuality
(value)¶ Sets the sampling quality override for reflections and refractions for interactive rendering.
Parameters: value (integer) – Override quality from 0 to 4. Default 1
-
vrdMaterialRaytracingSettings.
setInteractiveTraceDepth
(value)¶ Sets the trace depth override during interactive rendering.
Parameters: value (integer) – Override depth
-
vrdMaterialRaytracingSettings.
setLineTubeRadius
(value)¶ Sets the radius of tubes that are used to render lines in raytracing. It is given in object space.
Parameters: value (float) – New radius of tubes that are used to render lines in raytracing
-
vrdMaterialRaytracingSettings.
setMaterialId
(value)¶ Sets the ID of the material for Renderpasses rendering.
Parameters: value (integer) – New ID of the material
-
vrdMaterialRaytracingSettings.
setOverrideIblSampling
(value)¶ Enables IBL Sampling quality override for this material in interactive and still frame rendering.
Parameters: value (bool) – Enable override
-
vrdMaterialRaytracingSettings.
setOverrideIllumination
(value)¶ Enables illumination mode override for this material in interactive and still frame rendering.
Parameters: value (bool) – Enable override
-
vrdMaterialRaytracingSettings.
setOverrideReflectionSampling
(value)¶ Enables sampling quality override for reflections and refractions for this material for interactive and still frame rendering.
Parameters: value (bool) – Enable override
-
vrdMaterialRaytracingSettings.
setOverrideTraceDepth
(value)¶ Enables trace depth override for this material during interactive and still frame rendering.
Parameters: value (bool) – Enable override
-
vrdMaterialRaytracingSettings.
setStillFrameIblSamplingQuality
(value)¶ Sets the override IBL Sampling quality for sampling the environment map for still frame rendering.
Parameters: value (integer) – Override quality from 0 to 4. Default 1
-
vrdMaterialRaytracingSettings.
setStillFrameIlluminationMode
(mode)¶ Sets the override illumination mode for still frame rendering.
Parameters: mode (vrdMaterialRaytracingSettings.IlluminationMode) – Override mode
-
vrdMaterialRaytracingSettings.
setStillFrameReflectionSamplingQuality
(value)¶ Sets the sampling quality override for reflections and refractions for still frame rendering.
Parameters: value (integer) – Override quality from 0 to 4. Default 1
-
vrdMaterialRaytracingSettings.
setStillFrameTraceDepth
(value)¶ Sets the trace depth override during still-frame rendering.
Parameters: value (integer) – Override depth
-
vrdMaterialRaytracingSettings.
setUseLocalEnvironment
(value)¶ Uses the local environment (the environment assigned to the material, see vrdBRDFCommonSettings.getEnvironment()) for diffuse and glossy reflections in raytracing.
Parameters: value (bool) – New state of local environment usage