Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins

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.

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
Noise noise Specifies if the fog is rendered with the noise effect and a base noise texture will be available for the material.
Falloff height Specifies if the fog fades out to the top of its volume.
Multisample multisample Specifies if a multisample shading is enabled.

Textures

In the Textures tab of the Materials Editor you can:

  • Load the textures - click a Load button near the texture and specify the path to the texture or type the path in the texture field manually
  • Open the view window to see texture's details - click a View button near the texture
  • Set the current texture to default one - click a Set to parent button near the texture (if the texture is different from the default one, its field will be highlighted with green)

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

Base

This base texture is present only if Noise option is enabled in the States tab.

GUI name XML name Description Channels
Noise noise Noise map. A texture to add a grain effect to the fog (when a volume object is rendered, it is scaled to the screen size). This texture can only be of a 3D format. R

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 to choose the color of the diffuse map.

Density Parameters

Falloff parameter is present only if a Falloff option is enabled in the States 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
Falloff height_falloff slider A coefficient to specify the way the fog fades out to the top of its volume.

By the minimum value of 0.001, the fog will be distributed almost evenly along the height.

By higher values, the fog is rendered only at the bottom.
Low Falloff value High Falloff value
Falloff = 0.1
Falloff =0.3

Noise parameters

Noise parameters are present only if Noise option is enabled in the States tab and are modified in the Noise field of the Parameters tab.

GUI name XML name Type Description
Scale noise_scale slider Amount of noise:
  • By the minimum value of 0, there is no noise at all
  • By the maximum value of 1, the fog is rendered with the maximum amount of noise
Low noise value High noise value
Noise = 0.1
Noise = 0.4
Transform noise_transform expression Z coordinate transformation for the noise texture.
Last update: 2017-07-03