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

Unigine::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.

To use this class, include the UnigineWorld.h file.

Unigine::WorldClutter Class

Members


static int type ()

WorldClutter type.

Return value

WorldClutter type identifier.

static Ptr< WorldClutter > create (const NodePtr & node)

WorldClutter constructor.

Arguments

  • const NodePtr & node - Node smart pointer.

static Ptr< WorldClutter > create ()

WorldClutter constructor.

virtual Ptr< Node > getNode () const =0

Returns a node pointer.

Return value

Node pointer.

virtual int addReference (const char * name) =0

Adds a new reference node to the world clutter.

Arguments

  • const char * name - Name of the reference node.

Return value

The number of added reference node.

virtual void removeReference (int num) =0

Removes the specified reference node from the world clutter.

Arguments

  • int num - The number of the reference node.

virtual int getNumReferences () const =0

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

Return value

The number of reference nodes.

virtual void setReferenceName (int num, const char * name) =0

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

Arguments

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

virtual const char * getReferenceName (int num) const =0

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.

virtual void setReferenceProbability (int num, float probability) =0

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].

virtual float getReferenceProbability (int num) const =0

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

Arguments

  • int num - The number of the reference node.

Return value

Probability factor.

virtual void setOrientation (int orientation) =0

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).

Arguments

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

virtual int getOrientation () const =0

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.

virtual void setIntersection (int intersection) =0

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.

Arguments

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

virtual int getIntersection () const =0

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.

virtual void setVisibleDistance (float distance) =0

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

Arguments

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

virtual float getVisibleDistance () const =0

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.

virtual void setFadeDistance (float distance) =0

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.
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.

virtual float getFadeDistance () const =0

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.
Notice
In order for a fade distance to be applied, visibility distance should not be infinite.

Return value

Distance in units.

virtual void setSpawnRate (int spawn) =0

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.

Arguments

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

virtual int getSpawnRate () const =0

Returns the number of cells updated each frame. High number of updated cells may lead to a performance spike.

Return value

Number of cells to be updated.

virtual void setSeed (int seed) =0

Sets the seed for pseudo-random positioning of reference nodes.

Arguments

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

virtual int getSeed () const =0

Returns the seed used for pseudo-random positioning of reference nodes.

Return value

Number used to initialize a pseudo-random sequence.

virtual void setSizeX (float size) =0

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

Arguments

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

virtual float getSizeX () const =0

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

Return value

X-coordinate width in units.

virtual void setSizeY (float size) =0

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

Arguments

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

virtual float getSizeY () const =0

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

Return value

Y-coordinate length in units.

virtual void setStep (float step) =0

Sets the step for cells used to render node references.

Arguments

  • float step - Step for clutter cells in units.

virtual float getStep () const =0

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

Return value

Step for clutter cells in units.

virtual void setDensity (float density) =0

Sets the density factor that defines the amount of reference nodes per square unit.

Arguments

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

virtual float getDensity () const =0

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

Return value

Density factor.

virtual void setThreshold (float threshold) const =0

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

Arguments

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

virtual float getThreshold () =0

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

Return value

Density threshold.

virtual void setAngle (float angle) =0

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

Arguments

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

virtual float getAngle () const =0

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

Return value

Slope angle cosine.

virtual void setMinScale (float mean, float spread) =0

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.

Arguments

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

virtual float getMinScaleMean () const =0

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

Return value

Scale mean value.

virtual float getMinScaleSpread () const =0

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.

virtual void setMaxScale (float mean, float spread) =0

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 enables 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.

virtual float getMaxScaleMean () const =0

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

Return value

Scale mean value.

virtual float getMaxScaleSpread () const =0

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.

virtual void setOffset (float mean, float spread) =0

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

Arguments

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

virtual float getOffsetMean () const =0

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.

virtual float getOffsetSpread () const =0

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.

virtual void setRotation (const vec3 & mean, const vec3 & spread) =0

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

Arguments

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

virtual vec3 getRotationMean () const =0

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

Return value

Mean values of rotation angles in degrees.

virtual vec3 getRotationSpread () const =0

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

Return value

Spread values of rotation angles in degrees.

virtual int setMaskImage (const ImagePtr & image) =0

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

Arguments

  • const ImagePtr & image - Pointer to the image.

Return value

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

virtual int getMaskImage (const ImagePtr & image) const =0

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

Arguments

  • const ImagePtr & image - Image buffer to store a mask into.

Return value

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

virtual void setMaskImageName (const char * name) =0

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

Arguments

  • const char * name - Name (path) of the mask texture.

virtual const char * getMaskImageName () const =0

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.

virtual void setMaskFlipX (int flip) =0

Flip the mask by X axis.

Arguments

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

virtual int getMaskFlipX () const =0

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

Return value

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

virtual void setMaskFlipY (int flip) =0

Flip the mask by Y axis.

Arguments

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

virtual int getMaskFlipY () const =0

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

Return value

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

virtual void setMaskMinValue (int value) =0

Sets the minimum mask value for the WorldClutter object.

Arguments

  • int value - Minimum mask value.

virtual int getMaskMinValue () const =0

Returns the minimum mask value for the WorldClutter object.

Return value

Minimum mask value.

virtual void setMaskMaxValue (int value) =0

Sets the maximum mask value for the WorldClutter object.

Arguments

  • int value - Maximum mask value.

virtual int getMaskMaxValue () const =0

Returns the maximum mask value for the WorldClutter object.

Return value

Maximum mask value.

virtual void setMaskMeshName (const char * name) =0

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

Arguments

  • const char * name - Path to the *.mesh file.

virtual const char * getMaskMeshName () const =0

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.

virtual void setMaskInverse (int inverse) =0

Specifies if reference nodes should be rendered inside or outside the mask mesh contour.

Arguments

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

virtual int getMaskInverse () const =0

Returns a flag indicating if reference nodes are rendered inside or outside the mask mesh contour.

Return value

0 if reference nodes are rendered inside the mesh contour; 1 if outside.
Last update: 2017-07-03