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_shaft_base

A volume_shaft_base material is used to create beams of light falling into a dark room through windows or any other openings. In case colored glass is used for windows, beams also will be colored.

This material is applied only to Volume boxes.

Volume shaft material

Volume shaft material

States

The volume_shaft_base material has the following states.

States

Material Editor, States tab.

Height

This state determines if the intensity of light shafts reduces depending on height. By default this state is disabled. This state enables the Falloff parameter.

Camera position based

This state determines if light shafts are to be rendered relative to current camera position. By default this state is disabled. This state enables the Radius parameter.

Parameters

Parameters

Material Editor, Parameters tab.

Base Parameters

  • Diffuse - Determines the diffuse color multiplier for light shafts.

Density Parameters

  • Power - Determines the sharpness of volumetric bounds. By the minimum value of 1 the volumetric bounds are smoooth. The higher the value the sharper are the bounds.

  • Multiplier - Determines the density scale of the environment.

  • Falloff - Determines the reduction of intensity of light rays depending on height.
    Notice
    This parameter is available only when the Height state is enabled.

  • Radius - Determines the visibility distance of the rays, measured from the camera position, in meters.
    Notice
    This parameter is available only when the Camera position based state is enabled.

Other Parameters

  • Rays jitter - Determines smoothness of light rays. The higher the value, the smoother the rays.

  • Step jitter This parameter can be used to remove banding effect and make the rays look smoother. The higher the value, the smoother the rays.

  • Bias This parameter shifts shadow in the light direction to remove banding effect in case of insufficient shadow resolution.

  • Samples - Number of depth samples used. The more samples, the higher is the quality.
    Notice
    To increase performance, use low Sample values.

  • View intensity - Determines the intensity of rays when view direction is the same as the direction of the light rays (looking away from the light source). The higher the value, the more pronounced the rays look.

  • View exponent - Determines the rate of change of the intensity of rays when view direction is the same as the direction of the light rays (looking away from the light source). The higher the value, the smoother is the change of intensity.

Last update: 2017-10-20