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
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1

mesh_stem_base

A mesh_stem_base material is used to create stems for vegetation (for example, tree trunks and branches). Can be applied to static meshes and dynamic meshes.

mesh_stem_base

Stems

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.

The states are divided into 2 groups: Passes and Options.

Possible values for a Light omni, Light proj and Light world passes:

GUI name XML name Description
Skip none Material is not rendered.
Phong rim phong-rim Material is rendered with a Phong rim shading (by default) or simple Phong shading*

Possible values for all the other passes:

GUI name XML name Description
Skip none Material is not rendered during the pass.
Default default Material is rendered during the pass.

Possible values for a Detail option:

GUI name XML name Description
Skip disabled A material is not rendered.
Overlay first overlay_0

Material is rendered in the Overlay mode: detail textures are blended with the base ones according to the first UV coordinates.

The formula is: A + (B - 0.5) * k,
where A and B are base and detail textures correspondingly;
k is an alpha blending coefficient that allows smooth interpolation between alpha values of base and detail textures.

For example, if Alpha test option for material is disabled, k = base Alpha * detail Alpha.

Overlay second overlay_1 Material is rendered in the Overlay mode: detail textures are blended with the base ones according to the second UV coordinates.

All the other 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.

Passes

Passes specify during which rendering pass the material should be rendered. They are modified in the Passes field of the States tab.

GUI name XML name Description
Deferred deferred Deferred rendering pass. Specifies if the material should be rendered during the deferred pass. For the transparent surfaces see also a Post deferred option.
Auxiliary auxiliary Auxiliary rendering pass. Specifies if the material should be rendered into the auxiliary buffer to create a custom post-process.
Ambient ambient Ambient rendering pass. Specifies, how the material should be rendered during the Ambient light pass for the opaque objects. The actual opacity or transparency of the material depends solely on the set blending options.
Light omni light_omni Omni-directional lights rendering pass. Specifies, if the material should be rendered illuminated by the Omni light sources during the light and shadows rendering passes.
Light proj light_proj Projected lights rendering pass. Specifies, if the material should be rendered illuminated by the Projected light sources during the light and shadows rendering passes.
Light world light_world World lights rendering pass. Specifies, if the material should be rendered illuminated by the World light sources during the light and shadows rendering passes.

Options

The following options are set in the Options field of the States tab.

GUI name XML name Description
Detail detail Specifies if additional detail textures with the specified UV channel will be provided for the material. Such textures allow to render unique details (such as dirt or worn spots).
Animation animation Enables animation for stems. The available values are:
Shadow shafts volumetric Specifies if volumetric shadows from world lights will be rendered from surfaces with the applied material.
Without Shadow shafts With Shadow shafts
Disabled Shadow shafts
Enabled Shadow shafts

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 Textures

Base textures are loaded and modified in the Base field of the Textures tab. Normal and specular textures are present only if Phong Shading option in the States tab is enabled.

GUI name XML name Description Channels
Diffuse diffuse Diffuse map. A texture to define a surface's main color. RGBA:
  • RGB values store a color of the texture
  • An alpha (A) value contains either transparency values or a detail mask
Notice
An alpha (A) value will store transparency values if an Alpha test option is enabled. Otherwise it will store a detail mask.
Normal normal Normal map. A texture to store information about a surface's normals deviation. RG:
  • RG values contain two components of a normal
  • The third component's value is calculated from the given components in run-time
Specular specular Specular map. A texture to define a surface's shininess and highlight color. RGBA:
  • RGB values store reflection color and intensity (black color means no reflection)
  • An alpha (A) value specifies the specular power: 0 means specular highlights are very bright and intense, 256 - specular highlights are dull

Detail Textures

Detail textures are present if Detail option on the States tab is enabled and can be loaded and modified in the Detail field of the Textures tab.

GUI name XML name Description Channels
Diffuse diffuse_detail Diffuse map. A texture to define a surface's main color. RGBA:
  • RGB values store a color of the texture
  • An alpha (A) value contains either transparency values or a detail mask
Notice
An alpha (A) value will store transparency values if an Alpha test option is enabled. Otherwise it will store a detail mask.
Normal normal_detail Normal map. A texture to store information about a surface's normals deviation. RG:
  • RG values contain two components of a normal
  • The third component's value is calculated from the given components in run-time
Specular specular_detail Specular map. A texture to define a surface's shininess and highlight color. RGBA:
  • RGB values store reflection color and intensity (black color means no reflection)
  • An alpha (A) value specifies the specular power: 0 means specular highlights are very bright and intense, 256 - specular highlights are dull

Additional Textures

Additional textures are modified in the Additional field of the Textures tab.

GUI name XML name Description Channels
Ambient ambient

Ambient map. A texture to modulate the global environment illumination (when an object is lighter at the top from sky above, darker at the bottom from the ground below etc).

The texture takes effect only if the scene environment texture is loaded.

RGBA:

  • RGB values store a glowing color
  • An alpha (A) value stores a glow mask: black is for non-glowing areas, white - for glowing ones

Second UV map channel.

Notice
The above textures with the _d (diffuse map), _n (normal map) and _s (specular map) postfixes in the name respectively, located in a folder named uncompressed, will be automatically compressed by the engine.

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.

Transform Parameters

Texture transformation parameters are modified in the Transform field of the Parameters tab. Detail materials transformation parameters are present only if the Detail option is enabled.

GUI name XML name Type Description
Base base_transform expression Base texture coordinates transformation. A vector of the four float components, consisting of two pairs of vector elements:
  1. Scale texture coordinates, along X and Y axes.

    For example, by the scale of 2;2 the texture will be repeated four times on the surface.

  2. An offset of the texture respectively to its initial position along X and Y axes.

    For example, by the offset of 0.5 along X axis the texture will be repositioned to the right (so the left edge of the texture will be rendered in the center).

Detail detail_transform expression Detail texture native coordinates transformation. A vector of the four float components, consisting of two pairs of vector elements:
  1. Scale texture coordinates, along X and Y axes.
  2. An offset of the texture respectively to its initial position along X and Y axes.

Notice
Besides the native texture coordinates transformation, there are more options of setting texture coordinates. They are described in the Texture coordinates transformation article.

Animation Parameters

Animation parameters are present only if an Animation state is enabled and are modified in the Animation field of the Parameters tab.

GUI name XML name Type Description
Stem noise animation_stem_noise slider A coefficient to scale a spatial noise that diversifies the direction of movement of the vegetation stems.
Notice
Should be the same as in the mesh_stem_base material.
Stem offset animation_stem_offset slider A coefficient to scale an amplitude of horizontal movement for the vegetation stems.
Notice
Should be the same as in the mesh_stem_base material.
Stem radius animation_stem_radius slider A coefficient to scale an amplitude of vertical movement for the vegetation stems.
Notice
Should be the same as in the mesh_stem_base material.
Stem scale animation_stem_scale slider A coefficient to scale the speed of vegetation stems movement.
Notice
Should be the same as in the mesh_stem_base material.

Field Animation Parameters

This parameter is present only if the Field value is set for the Animation option on the States tab.

GUI name XML name Type Description
Field field_mask slider A field mask that specifies an area of the animation field to be applied to stems. This mask must match the field mask of the animation field.

Auxiliary Parameters

Auxiliary color parameter is present only if an Auxiliary pass is set as a Default. The parameter is modified in the Auxiliary field of the Parameters tab.

GUI name XML name Type Description
Auxiliary auxiliary_color color A color picker to choose an auxiliary color for the Auxiliary rendering pass.

Detail Parameters

Detail parameters are present only if the a Detail option in the Options tab is enabled and a detail material is created.

Detail material parameters are modified in the Detail field of the Parameters tab.

GUI name XML name Type Description
Diffuse detail_diffuse slider A coefficient to modify the visibility of the detail diffuse map:
  • By the minimum of 0, the diffuse texture is not visible at all
  • By the maximum of 1, the diffuse texture is fully appeared
Normal detail_normal slider A coefficient to modify the visibility of the detail normal map.
Specular detail_specular slider A coefficient to modify the visibility of the detail specular map.

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.

Diffuse diffuse_scale slider A coefficient to scale the brightness of the diffuse map.

The higher the value, the brighter the diffuse map is.
Specular specular_color color

A color picker to choose the color of the specular map.

Specular specular_scale slider A coefficient to scale the brightness of the specular map reflections.

The default value of 1 grants the correct color. The higher the value, the brighter the specular reflections are.
Glossiness specular_power slider

A coefficient to modify size of the highlight (Phong lighting) of the specular map:

  • Low values imitate wider highlights, typically appropriate to create diffuse reflection from the mat surface
  • High values imitate pinpoint highlights, typically appropriate to create uniform reflection of light rays from the glossy surface
Phong rim width phong_rim_width slider A coefficient to modify the width of an additionally lightened rim of an object, where incident light is perpendicular to surface being lit:
  • By the minimum value of 0, there is no additional lightning of the rim by Phong shading
  • By the maximum value of 1, all the shaded area is lightened according to the scale parameter
Phong rim scale phong_rim_scale slider A coefficient to scale brightness of the additionally lightened rim at the edges of an object, where incident light is perpendicular to surface being lit:
  • By the minimum value of 0, there is no additional lightning of the rim by Phong shading
  • By the maximum value of 1, the shaded edges are the brightest
Fresnel bias fresnel_bias slider A coefficient to compensate for the Fresnel effect and set the minimum necessary reflectance level.

By the minimum value of 0, there is no compensation for the Fresnel effect.

Increasing the value leads to more prominent overall reflections.

By the maximum value of 1, reflections are at their maximum and the Fresnel power parameter does not influence the rendered image.
Fresnel power fresnel_power slider

A coefficient to scale Fresnel effect that defines the amount of reflectance depending on the viewing angle:

  • Low values provide good reflectance even at a large viewing angles
  • High values provide the reflectance only at a small viewing angles. When looking at a large viewing angle, from above, there are no reflections rendered
Last update: 2017-07-03