Unigine.LightPlanarProbe Class
| Inherits from: | Light |
This class is used to create and manage planar reflection probes.
LightPlanarProbe Class
Enums
REFLECTION_RESOLUTION#
Properties
vec3 ProjectionSize#
The current size of the Light Planar Probe.
set
Sets the size for the planar probe. Defines the box-shaped influence volume around the probe, in units, in which reflective surfaces (having the appropriate roughness values) shall use the results captured by the probe.
set value -
The size along X, Y and Z axes. The default value is (2.0f, 2.0f, 0.1f).
vec3 AttenuationDistance#
The current distance from the probe, at which the probe doesn't project anything in the reflection.
set
Sets the attenuation distance that specifies how far the projection can reach any surfaces from the Probe position. It also specifies the attenuation area around the Probe at which the projection starts to fade out at the specified rate.
set value -
Attenuation distance. The default value is (0.1f, 0.1f, 0.1f).
int RoughnessSamples#
The maximum number of blurring samples.
set
Sets the number of samples used to adjust quality of the blurring effect for the reflection on rough surfaces.
set value -
Number of roughness samples. The default value is 0.
LightPlanarProbe.REFLECTION_RESOLUTION ReflectionResolution#
The current resolution of the reflection texture in pixels.
set
Sets the resolution of the reflection texture for the projection.
set value -
Reflection resolution. The default value is REFLECTION_RESOLUTION_MODE_HEIGHT.
bool TwoSided#
A value indicating if the reflection is two-sided.
set
Set a value indication if two-sided reflection is enabled.
set value -
true to enable two-sided reflection; false - to disable it. The default value is false.
float DistanceScale#
The current distance scale for the reflection.
set
Sets the distance multiplier for the reflection visibility distance. Distance Scale is applied to the distance measured from the reflection camera to the node (surface) bound.
set value -
Distance scale multiplier for the reflection. The default value is 0.5f.
float ReflectionDistance#
The current rendering distance of the reflected projection.
set
Sets the render distance for the reflection that specifies how far the reflection is rendered from the camera.
set value -
Reflection render distance in units. The default value is 100.0f.
int ReflectionViewportMask#
The reflection mask that controls rendering of the Planar Reflection Probe reflections into the reflection camera viewport.
set
Sets the viewing mask that specifies materials for which reflections are to be rendered in the viewport.
set value -
Reflection viewport mask (integer, each bit of which is used to represent a mask).
int VisibilitySkipFlags#
The mask that specifies what objects to ingore for the reflection projection (sky).
float ZNear#
The current distance to the near clipping plane defining a frustum to be used for grabbing reflections.
set
Sets the distance to the near clipping plane for image grabbing.
set value -
Distance to the near clipping plane. The default value is 0.01f.
float ZFar#
The current distance to the far clipping plane defining a frustum to be used for grabbing reflections.
set
Sets the distance to the far clipping plane defining a frustum to be used for grabbing reflections.
set value -
Distance to the far clipping plane. The default value is 100.0f.
float ReflectionVisibilityRoughnessMin#
The current lower surface roughness limit, starting from which the reflection starts to fade out gradually.
set
Sets the bound of the roughness range of the at which the reflection of the planar probe starts to attenuate.
set value -
Minimal visibility roughness bound. The default value is 0.0f.
float ReflectionVisibilityRoughnessMax#
The current upper surface roughness limit, starting from which the reflection completely disappears.
set
Sets the higher bound of the roughness range at which the reflection of the planar probe disappears completely.
set value -
Maximal visibility roughness. The default value is 0.25f.
bool VisibilitySky#
A value indicating if rendering of the sky is enabled or disabled for the reflection.
set
Sets a value indicating if sky is rendered in the reflection.
set value -
true to enable sky rendering in reflection; false.
float Parallax#
A value indicating the current degree of reflection distortion.
set
Sets degree of reflection distortion. Distortion depends on an angle between the probe plane and the surface onto which the probe projects reflection. Increasing the value amplifies visual distortion as a result of increasing this angle.
set value -
Degree of reflection distortion within the range of [0;1].
float NoiseIntensity#
The current intensity of noise effect for the projection.
set
Sets the intensity of jitter for roughness samples that creates a noise effect on the reflection.
set value -
Intensity of reflection noisiness. The default value is 0.5f.
float ReflectionOffset#
The current Z axis offset relative to the probe position.
set
Sets reflection Z axis offset relative to the probe coordinate system.
set value -
Reflection offset along Z axis in units. The default value is 0.01f.
Members
LightPlanarProbe ( ) #
Constructor. Creates a new planar probe.static int type ( ) #
Returns the object node type.Last update:
2021-04-29
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)