Unigine.TerrainGlobalDetail Class
Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to- Engineering / Sim
SDK edition to use it.
You should upgrade to
This class is used to manage details of the global terrain object.
TerrainGlobalDetail Class
Properties
float DisplacementOffset#
The displacement offset. this parameter controls the direction of displacement (inward or outward).
set
Sets the displacement offset. This parameter controls the direction of displacement (inward or outward).
set value -
Displacement offset value within the [-1.0f; 1.0f] range.
- positive value - outward displacement.
- 0 - points corresponding to height texture values less than 0.5 are displaced inwards, others are displaced outwards.
- negative value - inward displacement.
float Displacement#
The scale of displacement mapping according to the height texture.
set
Sets the scale of displacement mapping according to the height texture.
set value -
Displacement scale value within the [0.0f; 1.0f] range. Higher values produce a greater displacement effect.
float NormalScale#
The intensity scale of the detail normal texture.
set
Sets the intensity scale of the detail normal texture.
set value -
Normal texture intensity scale value within the [0.0f; 1.0f] range.
float RoughnessScale#
The intensity scale of the detail roughness texture.
set
Sets the intensity scale of the detail roughness texture.
set value -
Roughness texture intensity scale value within the [0.0f; 1.0f] range.
float AlbedoScale#
The intensity scale of the detail albedo texture.
set
Sets the intensity scale of the detail albedo texture.
set value -
Albedo texture intensity scale value within the [0.0f; 1.0f] range.
float Roughness#
The roughness value multiplier for the detail.
set
Sets the roughness value multiplier for the detail.
set value -
Roughness value multiplier within the [0.0f; 1.0f] range.
vec4 AlbedoColor#
The current albedo color multiplier for the detail.
set
Sets the albedo color multiplier for the detail.
set value -
Albedo color multiplier.
string HeightTextureName#
The path to the height texture of the detail.
set
Sets the path to the height texture of the detail.
set value -
Path to the height texture.
string NormalTextureName#
The path to the normal texture of the detail.
set
Sets the path to the normal texture of the detail.
set value -
Path to the normal texture.
string RoughnessTextureName#
The path to the roughness texture of the detail.
set
Sets the path to the roughness texture of the detail.
set value -
Path to the roughness texture.
string AlbedoTextureName#
The path to the albedo texture of the detail.
set
Sets the path to the albedo texture of the detail.
set value -
Path to the albedo texture.
float MaskContrast#
The contrast of the detail mask.
set
Sets the contrast of the detail mask.
set value -
Detail mask contrast value within the [0.0f; 1.0f] range.
float MaskWidth#
The width of blending of detail's height texture. Higher values provide wider areas. Blending is performed according to the detail's mask.
set
Sets the width of blending of detail's height texture. Higher values provide wider areas. Blending is performed according to the detail's mask.
set value -
Blending width value within the [0.0f; 1.0f] range.
float MaskThreshold#
The threshold that controls smoothness of blending of detail's height texture. Higher values provide smoother results. Blending is performed according to the detail's mask.
set
Sets the threshold that controls smoothness of blending of detail's height texture. Higher values provide smoother results. Blending is performed according to the detail's mask.
set value -
Blending threshold value within the [0.0f; 1.0f] range.
float BlendTriplanar#
The threshold value that controls smoothness of blending between the different projections of triplanar texture mapping.
Notice
This parameter is used only when triplanar texture mapping is enabled for the detail.
set
Sets the threshold value that controls smoothness of blending between the different projections of triplanar texture mapping.
Notice
This parameter is used only when triplanar texture mapping is enabled for the detail.
set value -
Triplanar blending value within the [0.0f; 1.0f] range. Lower values produce sharper transitions between projections, while higher values make it smoother.
bool IsTriplanar#
A value indicating if triplanar texture mapping is enabled for the detail.
set
Enables or disables triplanar texture mapping for the detail.
set value -
1 to enable triplanar texture mapping for the detail; 0 to use planar UV mapping instead.
bool IsDetail#
The value indicating if the detail uses the mask of the parent detail.
set
Sets the value indicating if the detail uses the mask of the parent detail.
set value -
1 to use the mask of the parent detail or the one generated on its basis; 0 to use own mask.
bool IsOverlap#
A value indicating if overlap mode is enabled for the detail.
set
Enables or disables overlap mode for the detail.
set value -
1 to enable overlap mode for the detail; 0 to use overlay mode instead.
float MaxFadeDistance#
The maximum fade-out distance of the detail. over this distance the detail smoothly becomes invisible due to alpha fading. it is counted starting from the maximum visibility distance.
set
Sets the maximum fade-out distance of the detail. Over this distance the detail smoothly becomes invisible due to alpha fading. It is counted starting from the maximum visibility distance.
set value -
Maximum fade-out distance, in units. If a negative value is provided, 0 will be used instead. The default value is 0.
float MinFadeDistance#
The minimum fade-in distance of the detail. over this distance the detail smoothly becomes visible due to alpha fading. it is counted starting from the minimum visibility distance.
set
Sets the minimum fade-in distance of the detail. Over this distance the detail smoothly becomes visible due to alpha fading. It is counted starting from the minimum visibility distance.
set value -
Minimum fade-in distance, in units. If a negative value is provided, 0 will be used instead. The default value is 0.
float MaxVisibleDistance#
The maximum visibility distance of the detail. it is the distance, starting from which the detail begins to fade out until it becomes completely invisible.
set
Sets the maximum visibility distance of the detail. It is the distance, starting from which the detail begins to fade out until it becomes completely invisible.
Notice
This parameter can be used to improve performance and reduce the tiling effect when looking at the terrain from a large distance.
set value -
Maximum visibility distance, in units. If a negative value is provided, 0 will be used instead. The default value is inf.
float MinVisibleDistance#
The minimum visibility distance of the detail. it is the distance, starting from which the detail begins to fade in until it becomes completely visible.
set
Sets the minimum visibility distance of the detail. It is the distance, starting from which the detail begins to fade in until it becomes completely visible.
Notice
This parameter can be used to improve performance and reduce the tiling effect when looking at the terrain from a large distance.
set value -
Minimum visibility distance, in units. If a negative value is provided, 0 will be used instead. The default value is -inf.
float MaxFadeHeight#
The fade out height range for the detail mask. over this height range above the maximum height value the detail mask will fade out until it is completely invisible. This parameter is used to modulate the detail mask by height.
set
Sets the fade out height range for the detail mask. Over this height range above the maximum height value the detail mask will fade out until it is completely invisible. This parameter is used to modulate the detail mask by height.
set value -
Fade out height range value for the mask, in units. The default value is 0. Higher values provide smoother fade out.
float MinFadeHeight#
The fade in height range for the detail mask. over this height range below the minimum height value the detail mask will fade in until it is completely visible. This parameter is used to modulate the detail mask by height.
set
Sets the fade in height range for the detail mask. Over this height range below the minimum height value the detail mask will fade in until it is completely visible. This parameter is used to modulate the detail mask by height.
set value -
Fade in height range value for the mask, in units. The default value is 0. Higher values provide smoother fade in.
float MaxVisibleHeight#
Sets the maximum height value for the detail mask, starting from which the detail begins to fade out until it becomes completely invisible. This parameter is used to modulate the detail mask by height.
set
Sets the maximum height value for the detail mask, starting from which the detail begins to fade out until it becomes completely invisible. This parameter is used to modulate the detail mask by height.
set value -
Maximum height value for the mask, in units. The default value is inf.
float MinVisibleHeight#
The minimum height value for the detail mask, starting from which the detail begins to fade in until it becomes completely visible. This parameter is used to modulate the detail mask by height.
set
Sets the minimum height value for the detail mask, starting from which the detail begins to fade in until it becomes completely visible. This parameter is used to modulate the detail mask by height.
set value -
Minimum height value for the mask, in units. The default value is -inf.
vec4 Transform#
The current transformation parameters of the detail.
set
Sets the transformation parameters of the detail.
set value -
Vec4 transformation vector with the following components:
- X - Tile size X - texture tile size along the X axis, in units.
- Y - Tile size Y - texture tile size along the Y axis, in units.
- Z - Offset X - texture offset along the X axis.
- W - Offset Y - texture offset along the Y axis.
vec4 MaskColor#
The color of the detail mask.
set
Sets the color of the detail mask.
set value -
Detail mask color.
int MaskNumber#
The index of the mask used by the detail.
set
Sets the index of the mask used by the detail.
set value -
Mask number.
bool IsEnabled#
A value indicating if the detail is enabled.
set
Enables or disables the detail.
set value -
1 to enable the detail; 0 to disable it.
string Name#
The name of the detail.
set
Sets the name of the detail.
set value -
Detail name.
Members
Last update:
2020-04-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)