Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

volume_fog_base

A volume_fog_base material is used to to create fog, haze or mist that hides objects behind it. It is applied to Volume box and Volume spheres.

Warning
This article is deprecated and will be updated in the further UNIGINE updates.

Fog material with Volume box

Fog material with Volume box

States

In the States tab you can set rendering passes and available options. Enabling some of the states activates additional textures and parameters in the Textures and Parameters tabs respectively.

For this material the states contain only Options field.

All the options can be either enabled or disabled by ticking the respective boxes.

All the states can be set to default ones - click a Set to parent button near the state (if the state is different from the default one, its field will be highlighted with green).

The states available for this kind of materials are listed below.

Options

GUI name XML name Description
Falloff height Specifies if the fog fades out to the top of its volume.

Parameters

In the Parameters tab you can set or modify base and additional parameters.

Parameters of different types are set in different ways:

  • expression - vector values can be set either in the field near the parameter or in the dialog window opened when double clicking this field
  • slider - the value can be set either by smoothly moving the slider of the scroll box or manually in the box near the parameter (if required, the value bigger than maximum one for the slider can be set)
  • color - the color can be chosen in the dialog window, activated after double clicking the color field

All the parameters can be set to default ones - click a Set to parent button near the parameter (if the parameter is different from the default one, its field will be highlighted with green).

The parameters available for this kind of materials are listed below.

Shading Parameters

Shading parameters are modified in the Shading field of the Parameters tab.

GUI name XML name Type Description
Diffuse diffuse_color color

A color picker specifying the diffuse color.

Density Parameters

Falloff parameter is present only if a Falloff option is enabled in theStates tab. Density parameters are modified in the Density field of the Parameters tab.

GUI name XML name Type Description
Power volume_power slider Specifies if the fog density falls of to the edges of the volume box. If a Falloff option is enabled, it also affects the density.
  • By the minimum value of 1, fog is distributed evenly within the volume box.
  • If a higher value is set, the fog density is decreased at the edges of the object and increased in the center.
Low Power value High Power value
Power = 1
Power = 4
Low Power value High Power value
Power = 1
Power = 3
Multiplier volume_density slider A coefficient to scale a density of the fog. This value affects visibility of objects inside the fog:
  • By low values, only distant objects are hidden by the fog.
  • By high values, even close objects are not visible in the fog.
Low Multiplier value High Multiplier value
Density = 0.2
Density = 0.4
Last update: 2017-12-21