Unigine::RenderEnvironmentPreset Class

// get the second environment preset
RenderEnvironmentPresetPtr preset = Render::getEnvironmentPreset(1);

RenderEnvironmentPreset Class

Members

---

int getNum ( ) const#

Returns the number of the preset.

Return value

Preset number. Available values: 0, 1, 2.

void setIntensity ( float intensity ) #

Sets the intensity of the given preset. The preset intensity is used to blend the given environment preset with the other ones.

Arguments

• float intensity - Intensity of the preset.

float getIntensity ( ) const#

Returns the intensity of the preset. The preset intensity is used to blend the environment preset with the other ones.

Return value

Intensity of the preset.

void setScatteringMieLUTName ( const char * name ) #

Sets the path to the Mie LUT texture (the texture for setting the color of the light round the sun) for the preset. The Mie texture is used for both sun and moon.

Arguments

• const char * name - Path to the texture.

const char * getScatteringMieLUTName ( ) const#

Returns the path to the Mie LUT texture (the texture for setting the color of the light round the sun) set for the preset. The Mie texture is used for both sun and moon.

Return value

Path to the texture.

void setScatteringLightColorLUTName ( const char * name ) #

Sets the path to the light color texture (the texture defining the color of the LightWorld for different times of the day) for the preset.

Arguments

• const char * name - Path to the texture.

const char * getScatteringLightColorLUTName ( ) const#

Returns the path to the light color texture (the texture defining the color of the LightWorld for different times of the day).

Return value

Path to the texture.

void setScatteringBaseLUTName ( const char * name ) #

Sets the path to the base LUT texture (the texture defining the base color of the sky) for the preset.

Arguments

• const char * name - Path to the texture.

const char * getScatteringBaseLUTName ( ) const#

Returns the path to the base LUT texture (the texture defining the base color of the sky) set for the preset.

Return value

Path to the texture.

void setHazeMaxDistance ( float distance ) #

Sets the distance starting at which the haze becomes completely solid, so nothing will be seen behind. For large terrains it is recommended to the this parameter equal to your camera's Far parameter. This is required for distant objects to fade into the distance instead of being cut sharply.

Arguments

• float distance - Haze maximum visibility distance.

float getHazeMaxDistance ( ) const#

Returns the distance starting at which the haze becomes completely solid, so nothing will be seen behind.

Return value

Haze maximum visibility distance.

void setHazeColor ( const Math::vec4 & color ) #

Sets the color of the haze for the preset. This function will take effect only if the HAZE_SOLID mode is set via setEnvironmentHazeMode().

Arguments

• const Math::vec4 & color - Haze color.

Math::vec4 getHazeColor ( ) const#

Returns the haze color for the preset.

Return value

Haze color.

void setHazeDensity ( float density ) #

Sets the density of the haze for the preset.

Arguments

• float density - Haze density.

float getHazeDensity ( ) const#

Returns the haze density set for the preset.

Return value

Haze density.

void setReflectionIntensity ( float intensity ) #

Sets intensity of the environment reflection for the preset. 0 value means no environment reflection for the preset.

Arguments

• float intensity - Intensity value of the environment reflection.

float getReflectionIntensity ( ) const#

Returns the intensity of the environment reflections for the preset. 0 value means no environment reflections for the preset.

Return value

The intensity value of the environment reflections.

void setSkyIntensity ( float intensity ) #

Sets intensity of the environment sky for the preset. 0.0f value means no environment sky for the preset.

Arguments

• float intensity - Intensity value of the environment sky.

float getSkyIntensity ( ) const#

Returns the intensity of the environment sky set for the preset.

Return value

Intensity value of the environment sky.

void setAmbientIntensity ( float intensity ) #

Sets the intensity of the environment ambient lighting for the preset. 0 value means no environment ambient lighting for the preset. The higher the value, the more ambient lighting affects environment.

Arguments

• float intensity - Intensity value of the environment ambient lighting. The value can be greater than 1.0f (useful for dark scenes).

float getAmbientIntensity ( ) const#

Returns the intensity of the environment ambient lighting for the preset. 0 value means no environment ambient lighting for the preset. The higher the value, the more ambient lighting affects environment.

Return value

The intensity value of environment ambient lighting. The value can be greater than 1.0f.

void setTexture ( const Ptr<Texture> & texture ) #

Sets the cubemap defining the environment color for the preset. This texture is used for imitating landscape reflections and lighting in accordance with the ground mask.

Arguments

• const Ptr<Texture> & texture - Cubemap defining the environment color.

Ptr<Texture> getTexture ( ) const#

Returns the cubemap defining the environment color set for the preset. This texture is used for imitating landscape reflections and lighting in accordance with the ground mask.

Return value

Cubemap defining the environment color.

void setTextureName ( const char * name ) #

Sets the path to the cubemap defining the environment color for the preset. This texture is used for imitating landscape reflections and lighting in accordance with the ground mask.

Arguments

• const char * name - Path to the cubemap defining the environment color.

const char * getTextureName ( ) const#

Returns the path to the cubemap defining the environment color set for the preset. This texture is used for imitating landscape reflections and lighting in accordance with the ground mask.

Return value

Path to the cubemap defining the environment color.

void setTextureColor ( const Math::vec4 & color ) #

Sets the environment color multiplier for the preset. The alpha channel defines visibility of the environment cubemap above scattering. The color multiplier is required when you need to display a sky with a photo texture and dynamic gradients at the same time.

Arguments

• const Math::vec4 & color - The environment color multiplier.

Math::vec4 getTextureColor ( ) const#

Returns the environment color multiplier set for the preset. The alpha channel defines visibility of the environment cubemap above scattering. The color multiplier is required when you need to display a sky with a photo texture and dynamic gradients at the same time.

Return value

The environment color multiplier.

void setTextureRotation ( const Math::vec3 & rotation ) #

Sets rotation of the environment texture along three axes.

Arguments

• const Math::vec3 & rotation - Rotation of the texture along X, Y, Z axes, in degrees.

Math::vec3 getTextureRotation ( ) const#

Returns rotation of the environment texture along three axes, in degrees.

Return value

Rotation of the texture along X, Y, Z axes, in degrees.

void setTextureBlur ( float blur ) #

Sets the blur intensity for the environment texture. This value can be used to make blurred panorama at the background.

Arguments

• float blur - Blur intensity.

float getTextureBlur ( ) const#

Returns the blur intensity for the environment texture.

Return value

Blur intensity.

float getMoonTextureIntensity ( ) const#

Returns the intensity multiplier of the Moon texture. It allows increasing/reducing brightness of the Moon.

Return value

Intensity of the Moon texture.

void setMoonTextureIntensity ( float intensity ) #

Sets the intensity multiplier of the Moon texture. It allows increasing/reducing brightness of the Moon.

Arguments

• float intensity - Intensity of the Moon texture.

void setSunTextureColor ( const Math::vec4 & color ) #

Sets the color multiplier for the current Sun texture. By default, it is (1,1,1,1).

Arguments

• const Math::vec4 & color - Color multiplier.

float getMoonAngularSize ( ) const#

Returns the current angular size of the Moon in degrees as seen from the Earth. By default, the size of the Moon is 0.5 degrees.

Return value

Angular size of the Moon.

float getSunTextureIntensity ( ) const#

Returns the intensity multiplier of the Sun texture. It allows increasing/reducing brightness of the Sun.

Return value

Intensity of the sun texture.

Math::vec4 getMoonTextureColor ( ) const#

Returns the color multiplier of the Moon texture.

Return value

Color multiplier.

void setSunTextureName ( const char * name ) #

Sets the Sun texture with the given name.

Arguments

• const char * name - Name of the Sun texture.

void setMoonTextureColor ( const Math::vec4 & color ) #

Sets the color multiplier for the current Moon texture. By default, it is (1,1,1,1).

Arguments

• const Math::vec4 & color - Color multiplier.

void setSunTextureIntensity ( float intensity ) #

Sets the intensity multiplier of the Sun texture. It allows increasing/reducing brightness of the Sun.

Arguments

• float intensity - Intensity of the Sun texture.

void setMoonAngularSize ( float size ) #

Sets the angular size of the Moon in degrees. The value is set for an observer on the Earth. By default, the size of the Moon is 0.5 degrees as seen from the Earth..

Arguments

• float size - Angular size of the Moon.

Math::vec4 getSunTextureColor ( ) const#

Returns the color multiplier of the Sun texture. By default, it is (1,1,1,1).

Return value

Color multiplier.

void setMoonTextureName ( const char * name ) #

Sets a name of the Moon texture.

Arguments

• const char * name - Name of the Moon texture.

void setSunAngularSize ( float size ) #

Sets the angular size of the Sun in degrees. The value is set for an observer on the Earth. By default, the size of the Sun is 0.5 degrees as seen from the Earth.

Arguments

• float size - Angular size of the Sun.

float getSunAngularSize ( ) const#

Returns the angular size of the Sun in degrees as seen from the Earth. By default, the size of the Sun is 0.5 degrees.

Return value

Angular size of the Sun.

const char * getSunTextureName ( ) const#

Returns the name of the Sun texture.

Return value

Name of the Sun texture.

const char * getMoonTextureName ( ) const#

Returns the name of the Moon texture.

Return value

Name of the Moon texure.

void setHazePhysicalStartHeight ( float height ) #

Sets a new reference height value for the two parameters (Half Visibility Distance and Half Faloff Height).

Arguments

• float height - New reference height value to be set, in units.

float getHazePhysicalStartHeight ( ) const#

Returns the current reference height value for the two parameters (Half Visibility Distance and Half Faloff Height).

Return value

Current reference height value, in units.

void setHazePhysicalHalfVisibilityDistance ( float distance ) #

Sets the distance to the boundary at which the visibility comprises 50%. There is no zero-visibility in the real world, so the half-visibility boundary is used to adjust haze distance.

Arguments

• float distance - New distance value to be set, in units.

float getHazePhysicalHalfVisibilityDistance ( ) const#

Returns the current distance to the boundary at which the visibility comprises 50%. There is no zero-visibility in the real world, so the half-visibility boundary is used to adjust haze distance.

Return value

Current distance to the boundary at which the visibility comprises 50%, in units.

void setHazePhysicalHalfFalloffHeight ( float height ) #

Sets the height of the haze density gradient. The higher the value, the longer the haze desity reduces as the height grows, making the transition between the clear sky and haze smoother.

Arguments

• float height - New height of the haze density gradient to be set.

float getHazePhysicalHalfFalloffHeight ( ) const#

Returns the current height of the haze density gradient. The higher the value, the longer the haze desity reduces as the height grows, making the transition between the clear sky and haze smoother.

Return value

Current height of the haze density gradient.

void setHazePhysicalAmbientLightIntensity ( float intensity ) #

Sets the new intensity of the impact of the ambient lighting on haze (how much the ambient lighting affects the haze).

Arguments

• float intensity - New value of intensity of the ambient lighting impact to be set.

float getHazePhysicalAmbientLightIntensity ( ) const#

Returns the current intensity of the impact of the ambient lighting on haze (how much the ambient lighting affects the haze).

Return value

Current value of intensity of the ambient lighting impact.

void setHazePhysicalAmbientColorSaturation ( float saturation ) #

Sets the new intensity of the ambient color's contribution to the haze (how much the sunlight affects the haze).

Arguments

• float saturation - New value of intensity of the ambient color's contribution to the haze to be set.

float getHazePhysicalAmbientColorSaturation ( ) const#

Returns the current intensity of the ambient color's contribution to the haze (how much the sunlight affects the haze).

Return value

Current value of intensity of the ambient color's contribution to the haze.

void setHazePhysicalSunLightIntensity ( float intensity ) #

Sets the new intensity of the impact of the sunlight on haze (how much the sunlight affects the haze).

Arguments

• float intensity - New value of intensity of the sunlight impact to be set.

float getHazePhysicalSunLightIntensity ( ) const#

Returns the current intensity of the impact of the sunlight on haze defining how much the sunlight affects the haze.

Return value

Current value of intensity of the sunlight impact.

void setHazePhysicalSunColorSaturation ( float saturation ) #

Sets the new intensity of the impact of the sunlight on haze (how much the sunlight affects the haze).

Arguments

• float saturation - New value of intensity of the sunlight color's contribution to the haze to be set.

float getHazePhysicalSunColorSaturation ( ) const#

Returns the current intensity of the impact of the sunlight on haze (how much the sunlight affects the haze).

Return value

Current intensity of the sunlight color's contribution to the haze.

void setHazeScatteringMieIntensity ( float intensity ) #

Sets the minimum Mie intensity value for geometry-occluded areas. This value specifies the fraction of Mie intensity visible when the surface is viewed from straight on. Setting this value to 1 disables the Fresnel effect. You can use this parameter together with Mie Frontside Intensity (see the setHazeScatteringMieFrontSideIntensity) and Mie Fresnel Power (see the setHazeScatteringMieFresnelPower) to control light occlusion from World light sources. Works for both, opaque and transparent objects.

Arguments

• float intensity - New minimum Mie intensity value for geometry-occluded areas to be set in the [0.0f, 1.0f] range.

float getHazeScatteringMieIntensity ( ) const#

Returns the current minimum Mie intensity value for geometry-occluded areas. This value specifies the fraction of Mie intensity visible when the surface is viewed from straight on. Setting this value to 1 disables the Fresnel effect. You can use this parameter together with Mie Frontside Intensity (see the setHazeScatteringMieFrontSideIntensity) and Mie Fresnel Power (see the setHazeScatteringMieFresnelPower) to control light occlusion from World light sources. Works for both, opaque and transparent objects.

Return value

Current minimum Mie intensity value for geometry-occluded areas in the [0.0f, 1.0f] range.

void setHazeScatteringMieFrontSideIntensity ( float intensity ) #

Sets the falloff of the Fresnel effect for Mie intensity. This value is used to control occlusion of light from a World light source by the geometry.

Arguments

• float intensity - Falloff of the Fresnel effect for Mie intensity.

float getHazeScatteringMieFrontSideIntensity ( ) const#

Returns the falloff of the Fresnel effect for Mie intensity. This value is used to control occlusion of light from a World light source by the geometry.

Return value

Falloff of the Fresnel effect for Mie intensity.

void setHazeScatteringMieFresnelPower ( float power ) #

Sets the power of the Fresnel effect for Mie visibility. Higher values will tighten up the areas affected, while lower ones will allow more areas to be affected by the Fresnel effect.

Arguments

• float power - New power of the Fresnel effect to be set.

float getHazeScatteringMieFresnelPower ( ) const#

Returns the current power of the Fresnel effect for Mie visibility. Higher values will tighten up the areas affected, while lower ones will allow more areas to be affected by the Fresnel effect.

Return value

Current power of the Fresnel effect.