UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Content Creation
Materials
Unigine Material Library
Tutorials

WorldClutter Class

WorldClutter class allows to randomly position reference nodes according to the mask and using the specified seed. For each node a probability of appearing is set. All nodes in the world clutter are rendered visible only within a specified distance and then fade out. Just like the ObjectGrass, world clutter is rendered in cells.

There are two benefits of using WorldClutter:

  • Instances of nodes that are currently outside the view frustum are not stored in the memory, which provides much more efficient memory usage.
  • Less cluttered spatial tree, which allows, for example, faster collision detection.

WorldClutter Class

This class inherits from Node

Members


WorldClutter ()

Constructor. Creates a world clutter with default properties.

int addReference (string name)

Adds a new reference node to the world clutter.

Arguments

  • string name - Name of the reference node.

Return value

The number of added reference node.

float getAngle ()

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

Return value

Slope angle cosine.

float getDensity ()

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

Return value

Density factor.

float getFadeDistance ()

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

Return value

Distance in units.

int getIntersection ()

Returns a value indicating whether reference nodes 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 reference nodes.

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 reference nodes are rendered inside or outside the mask mesh contour. The default is 0 (inside).

Return value

0 if reference nodes are rendered inside the mesh contour; 1 if outside.

int getMaskMaxValue ()

Returns the maximum mask value for the WorldClutter object.

Return value

Maximum mask value.

string getMaskMeshName ()

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

Return value

Path to the *.mesh file.

int getMaskMinValue ()

Returns the minimum mask value for the WorldClutter object.

Return value

Minimum mask value.

float getMaxScaleMean ()

Returns the scale mean value for meshes in the areas with high density (according to the mask). The default is 1 (no scaling).

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). The default is 0 (always use the mean scale).

Return value

Scale spread value.

float getMinScaleMean ()

Returns the scale mean value for meshes in the areas with low density (according to the mask). The default is 1 (no scaling).

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). The default is 0 (always use the mean scale).

Return value

Scale spread value.

int getNumReferences ()

Returns the total number of reference nodes contained in the world clutter.

Return value

The number of reference nodes.

float getOffsetMean ()

Returns the current mean value of the vertical offset that determines the placement of reference nodes 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 reference nodes above or below the surface.

Return value

Spread value of the offset in units.

int getOrientation ()

Returns a value indicating whether reference nodes 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.

string getReferenceName (int num)

Returns the name of the reference node contained in the world clutter.

Arguments

  • int num - The number of the reference node among contained in the world clutter.

Return value

Name of the reference node.

float getReferenceProbability (int num)

Returns the probability of the occurrence of the specified node reference.

Arguments

  • int num - The number of the reference node.

Return value

Probability factor.

vec3 getRotationMean ()

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

Return value

Mean values of rotation angles in degrees.

vec3 getRotationSpread ()

Returns the spread value of reference nodes 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 reference nodes.

Return value

Number used to initialize a pseudo-random sequence.

float getSizeX ()

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

Return value

X-coordinate width in units.

float getSizeY ()

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

Return value

Y-coordinate length in units.

int getSpawnRate ()

Returns the number of cells updated each frame. High number of updated cells may lead to a performance spike. The default is 1 cell per application update. The default is 1 cell per application update.

Return value

Number of cells to be updated.

float getStep ()

Returns the step for cells used to render node references contained in the world clutter.

Return value

Step for clutter cells in units.

float getThreshold ()

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

Return value

Density threshold.

float getVisibleDistance ()

Returns the current distance up to which all the reference nodes will be rendered. The distance is measured from the camera.

Return value

Distance in units.

void removeReference (int num)

Removes the specified reference node from the world clutter.

Arguments

  • int num - The number of the reference node.

void setAngle (float angle)

Sets the angle cosine that defines the slope steepness appropriate for positioning nodes. The default is 0 (no limitation by slope angle).

Arguments

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

void setDensity (float density)

Sets the density factor that defines the amount of reference nodes per square unit. The default is 1.

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 reference nodes will be fading out (that is, fewer nodes will be rendered instead of all). The distance is measured starting from the visible distance. The default is 0.
Notice
In order for a fade distance to be applied, visibility distance should not be infinite.

Arguments

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

void setIntersection (int intersection)

Sets a value indicating whether reference nodes should be scattered upon the ground (along its relief): either the terrain or a mesh set as a parent node. The default is 0.

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 new 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 reference nodes should be rendered inside or outside the mask mesh contour. The default is 0 (inside).

Arguments

  • int inverse - 0 to render reference nodes inside the mesh contour; 1 to render them outside.

void setMaskMaxValue (int value)

Sets the maximum mask value for the WorldClutter object.

Arguments

  • int value - Maximum mask value.

void setMaskMeshName (string name)

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

Arguments

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

void setMaskMinValue (int value)

Sets the minimum mask value for the WorldClutter object.

Arguments

  • int value - Minimum mask value.

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 to control the range of scales relative to the mean value. The default is (1,0) (no scaling).

Arguments

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

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 to control the range of scales relative to the mean value. The default is (1,0) (no scaling).

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 reference nodes above or below the surface. The default is 0 for both values.

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 reference nodes should be oriented along the normals of the ground (either the terrain or a mesh set as a parent node). The default is 0.

Arguments

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

void setReferenceName (int num, string name)

Sets the name of the specified reference node contained in the world clutter.

Arguments

  • int num - The number of the reference node.
  • string name - Name to be updated.

void setReferenceProbability (int num, float probability)

Sets the probability of the occurrence of the specified node reference.

Arguments

  • int num - The number of the reference node.
  • float probability - Probability factor. The provided value is saturated in range [0;1].

void setRotation (vec3 mean, vec3 spread)

Sets the rotation of reference nodes along X, Y and Z axes. The default is vec3(0) for both values.

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 reference nodes. The default is 0.

Arguments

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

void setSizeX (float size)

Sets the width of the world clutter along the X-coordinate. The default is 1 unit.

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 world clutter along the Y-coordinate. The default is 1 unit.

Arguments

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

void setSpawnRate (int spawn)

Determines how many cells (in which the world clutter is rendered) are updated each frame. High number of updated cells may lead to a performance spike. The default is 1 cell per application update.

Arguments

  • int spawn - Number of cells to be updated. If a non-positive value is provided, 1 will be used instead.

void setStep (float step)

Sets the step for cells used to render node references. The default is 1.

Arguments

  • float step - Step for clutter cells in units.

void setThreshold (float threshold)

Sets the density threshold (for a mask) starting from which reference nodes are rendered if placed dense enough. The default is 0.5.

Arguments

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

void setVisibleDistance (float distance)

Sets the distance up to which all the reference nodes will be rendered. The distance is measured from the camera. The default is infinity.

Arguments

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