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

ObjectMeshClutter Class

MeshClutter is used to scatter identical meshes (with the same material applied to their surfaces), as well as randomly scale and orient them. Scattered meshes are baked into one object, which allows for less cluttered spatial tree, reduces the number of texture fetches and speeds up rendering.
Meshes are rendered within a specified distance from the camera. Further than this distance, nodes fade out and then disappear completely.

The following samples demonstrate the ObjectMeshClutter class usage:

See Also

ObjectMeshClutter Class

This class inherits from Object

Members


ObjectMeshClutter (string name)

Constructor. Creates a new mesh clutter to scatter instances of the specified mesh.

Arguments

  • string name - Mesh name.

int createMesh (string name, int dynamic = 0)

Creates the clutter mesh with the specified parameters.

Arguments

  • string name - Mesh name.
  • int dynamic - Dynamic flag:
    • 0 - If the mesh vertices are changed in run-time, meshes loaded from the same file will be also changed.
    • 1 - If the mesh vertices are changed in run-time, meshes loaded from the same file won't be changed

Return value

1 if the mesh is created successfully; otherwise - 0.

int findSurfaceTarget (string name, int surface)

Searches for a surface target with a given name.

Arguments

  • string name - Target name.
  • int surface - Surface number.

Return value

Target number if it exists; otherwise, -1.

void flushMesh ()

Flushes the clutter mesh geometry into the video memory.

float getAngle ()

Returns the current angle cosine that defines the slope steepness appropriate for positioning meshes.

Return value

Slope angle cosine.

int getCollision ()

Returns a value indicating if collisions with the object should be taken into account.
Notice
If the return value is 0 the new geometry will never be generated by collision detection request.

Return value

1 if collisions are taken into account; 0 if collisions are allowed only with already generated geometry.

float getDensity ()

Returns the current density factor that defines the number of meshes per square unit.

Return value

Density factor.

float getFadeDistance ()

Returns the current distance up to which meshes scattered by the mesh clutter are fading out (that is, fewer meshes will be rendered instead of all). The distance is measured starting from the visible distance.
Notice
In order for a fade distance to be applied, visibility distance should not be infinite.

Return value

Distance of nodes fading in units.

int getIntersection ()

Returns a value indicating whether meshes are scattered upon the ground (along its relief): either the terrain or a mesh set as a parent node.

Return value

1 if intersection is enabled; otherwise, 0.

int getMaskFlipX ()

Returns a flag indicating if a mask is flipped by X axis.

Return value

Positive value if the mask is flipped; otherwise, 0.

int getMaskFlipY ()

Returns a flag indicating if a mask is flipped by Y axis.

Return value

Positive value if the mask is flipped; otherwise, 0.

string getMaskImageName ()

Returns the name of a mask texture (in R8 format) that defines the placement of meshes.

Return value

Name (path) of the mask texture.

int getMaskImage (Image image)

Writes the image that is currently used as a mask for the placement of meshes into the given buffer.

Arguments

  • Image image - Image buffer to store a mask into.

Return value

1 if the mask image is successfully written into the buffer; otherwise, 0.

int getMaskInverse ()

Returns a flag indicating if clutter meshes are rendered inside or outside the mask mesh contour.

Return value

0 if clutter meshes are rendered inside the mask mesh contour; 1 if outside.

int getMaskMaxValue ()

Returns the maximum value of the mask application range.

Return value

Maximum mask value.

string getMaskMeshName ()

Returns the current mesh to used as a mask for the mesh clutter. This mesh should be plane.

Return value

Path to the *.mesh file.

int getMaskMinValue ()

Returns the minimum value of the mask application range.

Return value

Minimum mask value.

float getMaxScaleMean ()

Returns the scale mean value for meshes in the areas with high density (according to the mask).

Return value

Scale mean value.

float getMaxScaleSpread ()

Returns the scale spread value that controls the range of mesh scales in the areas with high density (according to the mask).

Return value

Scale spread value.

string getMeshName ()

Returns the name of the mesh scattered by mesh clutter.

Return value

Mesh name.

int getMesh (Mesh mesh)

Copies the current mesh into the source mesh.

Arguments

  • Mesh mesh - Source mesh.

Return value

1 if the mesh is copied successfully.

float getMinScaleMean ()

Returns the scale mean value for meshes in the areas with low density (according to the mask).

Return value

Scale mean value.

float getMinScaleSpread ()

Returns the scale spread value that controls the range of mesh scales in the areas with low density (according to the mask).

Return value

Scale spread value.

int getNumSurfaceTargets (int surface)

Returns the total number of surface targets.

Arguments

  • int surface - Surface number.

Return value

Total number of surface targets.

float getOffsetMean ()

Returns the current mean value of the vertical offset that determines the placement of meshes above or below the surface.

Return value

Mean value of the offset in units.

float getOffsetSpread ()

Returns the current spread value of the vertical offset that determines the placement of meshes above or below the surface.

Return value

Spread value of the offset in units.

int getOrientation ()

Returns a value indicating whether meshes are oriented along the normals of the ground (either the terrain or a mesh set as a parent node).

Return value

1 if orientation is enabled; otherwise, 0.

vec3 getRotationMean ()

Returns the mean value of meshes rotation along X, Y and Z axes.

Return value

Mean values of rotation angles in degrees.

vec3 getRotationSpread ()

Returns the spread value of meshes rotation along X, Y and Z axes.

Return value

Spread values of rotation angles in degrees.

int getSeed ()

Returns the seed used for pseudo-random positioning of meshes.

Return value

Number used to initialize a pseudo-random sequence.

float getShadowRadius ()

Returns the current distance to draw additional meshes outside the view frustum. This option allows you to eliminate popping of shadows at the edges of the screen when the camera is turning.

Return value

Distance in units.

float getSizeX ()

Returns the current width of the mesh clutter along the X-coordinate.

Return value

X-coordinate width in units.

float getSizeY ()

Returns the current length of the mesh clutter along the Y-coordinate.

Return value

Y-coordinate length in units.

int getSpawnCount ()

Returns the number of cells to be generated.

Return value

Number of cells to be generated if the scene generation is not completed; otherwise, 0.

float getStep ()

Returns the step for cells used to render meshes scattered by the mesh clutter.

Return value

Step for clutter cells in units.

string getSurfaceTargetName (int surface, int target)

Returns the name of a given surface target.

Arguments

  • int surface - Surface number.
  • int target - Target number.

Return value

Target name.

float getThreshold ()

Returns the current density threshold (for a mask) starting from which meshes are rendered if placed dense enough.

Return value

Density threshold.

float getVisibleDistance ()

Returns the current distance up to which meshes scattered by the mesh clutter are rendered.

Return value

Distance of visibility for meshes in units.

int loadMesh (string name)

Loads a new mesh instead of the current mesh from the .mesh file. This function doesn't change the mesh name.

Arguments

  • string name - The path to the .mesh file.

Return value

1 if the mesh is loaded successfully; otherwise, 0.

int saveMesh (string name)

Saves the mesh into the .mesh format.

Arguments

  • string name - The path to the file.

Return value

1 if the mesh is saved successfully; otherwise, 0.

void setAngle (float angle)

Sets the angle cosine that defines the slope steepness appropriate for positioning meshes.

Arguments

  • float angle - Slope angle cosine. The provided value will be clipped in range [0;1].

void setCollision (int collision)

Sets a value indicating if collisions with the object should be taken into account.
Notice
If the collision parameter is set to 0, the new geometry will never be generated by collision detection request.

Arguments

  • int collision - 1 to take collisions into account and make the object important for physics; 0 to allow collisions only with already generated geometry.

void setDensity (float density)

Sets the density factor that defines the number of meshes per square unit.

Arguments

  • float density - Density factor. If a negative value is provided, 0 will be used instead.

void setFadeDistance (float distance)

Sets the distance up to which meshes scattered by the mesh clutter will be fading out (that is, fewer meshes will be rendered instead of all). The distance is measured starting from the visible distance.
Notice
In order for a fade distance to be applied, visibility distance should not be infinite.

Arguments

  • float distance - Distance of fading for meshes in units. If a negative value is provided, 0 will be used instead.

void setIntersection (int intersection)

Sets a value indicating whether meshes should be scattered upon the ground (along its relief): either the terrain or a mesh set as a parent node.

Arguments

  • int intersection - Positive number to enable intersection; 0 to disable.

void setMaskFlipX (int flip)

Flip the mask by X axis.

Arguments

  • int flip - Positive value to flip the mask; otherwise, 0.

void setMaskFlipY (int flip)

Flip the mask by Y axis.

Arguments

  • int flip - Positive value to flip the mask; otherwise, 0.

void setMaskImageName (string name)

Sets the name of a mask texture (in R8 format) that defines the placement of meshes.

Arguments

  • string name - Name (path) of the mask texture.

int setMaskImage (Image image)

Sets an image (in R8 format) that defines the placement of meshes.

Arguments

  • Image image - Pointer to the image.

Return value

1 if the mask image is successfully set; otherwise, 0.

void setMaskInverse (int inverse)

Specifies if clutter meshes should be rendered inside or outside the mask mesh contour.

Arguments

  • int inverse - 0 to render clutter meshes inside the mask mesh contour; 1 to render them outside.

void setMaskMaxValue (int value)

Sets the maximum value of the mask application range.

Arguments

  • int value - Maximum mask value, [0;255].

void setMaskMeshName (string name)

Sets a mesh to be used as a mask for the mesh clutter. This mesh should be plane.

Arguments

  • string name - Path to the *.mesh file.

void setMaskMinValue (int value)

Sets the minimum value of the mask application range.

Arguments

  • int value - Minimum mask value, [0;255].

void setMaxScale (float mean, float spread)

Sets the scale for meshes in the areas with high density (according to the mask). With the minimum scale it is possible to automatically render, for example, big trees in the center of the forest. A spread value allows you to control the range of scales relative to the mean value.

Arguments

  • float mean - Scale mean value.
  • float spread - Maximum spread value to randomly upscale or downscale objects.

void setMeshName (string name)

Sets a name for the mesh scattered by the mesh clutter.

Arguments

  • string name - Name to be set for the mesh.

int setMesh (Mesh mesh)

Copies the source mesh into the current mesh.

Arguments

  • Mesh mesh - The source mesh to be copied.

Return value

1 if the mesh is copied successfully; otherwise, 0.

void setMinScale (float mean, float spread)

Sets the scale for meshes in the areas with low density (according to the mask). With the minimum scale it is possible to automatically render, for example, small trees at the forest border. A spread value allows you to control the range of scales relative to the mean value.

Arguments

  • float mean - Scale mean value.
  • float spread - Maximum spread value to randomly upscale or downscale objects.

void setOffset (float mean, float spread)

Sets the vertical offset that determines the placement of meshes above or below the surface.

Arguments

  • float mean - Mean value of the offset in units.
  • float spread - Spread value of the offset in units.

void setOrientation (int orientation)

Sets a value indicating whether meshes should be oriented along the normals of the ground (either the terrain or a mesh set as a parent node).

Arguments

  • int orientation - Positive number to enable orientation; 0 to disable.

void setRotation (vec3 mean, vec3 spread)

Sets the rotation of meshes along X, Y and Z axes.

Arguments

  • vec3 mean - Mean values of rotation angles in degrees.
  • vec3 spread - Spread values of rotation angles in degrees.

void setSeed (int seed)

Sets the seed for pseudo-random positioning of meshes.

Arguments

  • int seed - Number used to initialize a pseudo-random sequence. If a negative value is provided, 0 will be used instead.

void setShadowRadius (float radius)

Sets the distance to draw additional meshes outside the view frustum. This option allows you to eliminate popping of shadows at the edges of the screen when the camera is turning.

Arguments

  • float radius - Distance in units. If a negative value is provided, 0 will be used instead.

void setSizeX (float size)

Sets the width of the mesh clutter along the X-coordinate.

Arguments

  • float size - X-coordinate width in units. If a negative value is provided, 0 will be used instead.

void setSizeY (float size)

Sets the length of the mesh clutter along the Y-coordinate.

Arguments

  • float size - Y-coordinate length in units. If a negative value is provided, 0 will be used instead.

void setStep (float step)

Sets the step for cells used to render mesh clutter.

Arguments

  • float step - Step for clutter cells in units.

void setThreshold (float threshold)

Sets the density threshold (for a mask) starting from which meshes are rendered if placed dense enough.

Arguments

  • float threshold - Density threshold. The provided value will be clipped in range [0;1].

void setVisibleDistance (float distance)

Sets the distance up to which meshes scattered by the mesh clutter will be rendered.

Arguments

  • float distance - Distance of visibility for meshes in units. If a negative value is provided, 0 will be used instead.
Last update: 2017-07-03