Unigine.ObjectMeshClutter Class

num_cells_x = max(Math::ftoi(Math::ceil(clutter_size_x / step)), 1);
num_cells_y = max(Math::ftoi(Math::ceil(clutter_size_y / step)), 1);

cell_size_x = clutter_size_x / Math::itof(num_cells_x);
cell_size_y = clutter_size_y / Math::itof(num_cells_y);

cell_density = cell_size_x * cell_size_y * density;

ObjectMeshClutter Class

Properties

int CutoutInverse#

int CutoutIntersectionMask#

int MaskInverse#

string MaskMeshName#

int MaskMaxValue#

int MaskMinValue#

int MaskFlipY#

int MaskFlipX#

string MaskImageName#

float Angle#

float Threshold#

float Density#

float Step#

float SizeX#

float SizeY#

int Seed#

int SpawnCount#

float FadeDistance#

float VisibleDistance#

bool Intersection#

bool Orientation#

bool Collision#

int TerrainMask#

string MeshPath#

bool IsMeshLoadedVRAM#

bool IsMeshLoadedRAM#

bool IsMeshNull#

ObjectMeshStatic.PROCEDURAL_MODE MeshProceduralMode#

int IntersectionMask#

bool IsMeshProceduralDynamic#

bool IsMeshProceduralActive#

bool IsMeshProceduralDone#

Members

---

ObjectMeshClutter ( string path ) #

ObjectMeshClutter constructor. Creates a clutter using the path to the source mesh provided.

Arguments

• string path - Path to the source mesh file.

ObjectMeshClutter ( ) #

Default ObjectMeshClutter constructor. Creates an empty clutter.

int SetMaskImage ( Image image, bool invalidate = 1 ) #

Sets an image (in R8 format) as a mask, that defines placement of meshes.

Arguments

• Image image - Image instance.
• bool invalidate - Invalidate flag. Set true to invalidate all mesh clutter cells; otherwise, set false. All invalidated cells will be regenerated.

Return value

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

int GetMaskImage ( Image image ) #

Writes the image that is currently used as a mask for placement of meshes to 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.

void SetMaskImageName ( string image_name, bool invalidate = 1 ) #

Sets the path to a mask image (in R8 format) that defines the placement of meshes.

Arguments

• string image_name - Path to the mask image.
• bool invalidate - Invalidate flag. Set true to invalidate all mesh clutter cells; otherwise, set false. All invalidated cells will be regenerated.

int SetMaskMesh ( Mesh mesh, bool invalidate = true ) #

Sets a mesh to be used as a mask on-the-fly. Limitations:

• Before the method is called, another mesh must be set via setMaskMeshName() first.
• If the world is reloaded, the mesh set via setMaskMeshName() will be loaded.
• If the memory limit is exceeded, the new mesh might be replaced with the mesh set via setMaskMeshName().

Arguments

• Mesh mesh
• bool invalidate - Invalidate flag. Set true to invalidate all mesh clutter cells; otherwise, set false. All invalidated cells will be regenerated.

Return value

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

int GetMaskMesh ( Mesh mesh ) #

Copies the current mask mesh (if it exists) to the specified target mesh.

Arguments

• Mesh mesh - Mesh instance to copy the current mask mesh to.

Return value

1 if mesh mask exists; otherwise - 0.

void SetMaskMeshName ( string mesh_name, bool invalidate = 1 ) #

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

Arguments

• string mesh_name - Path to the *.mesh file.
• bool invalidate - Invalidate flag. Set true to invalidate all mesh clutter cells; otherwise, set false. All invalidated cells will be regenerated.

void CreateClutterTransforms ( ) #

Creates transformations for all clutter meshes.

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.

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.

void SetMeshesRotation ( vec3 mean, vec3 spread ) #

Sets the parameters of pseudo-random rotation of meshes along X, Y and Z axes.

Arguments

• vec3 mean - Mean values of meshes rotation angles, in degrees.
• vec3 spread - Maximum spread values of meshes rotation angles, in degrees.

vec3 GetMeshesRotationMean ( ) #

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

Return value

Mean values of meshes rotation angles, in degrees.

vec3 GetMeshesRotationSpread ( ) #

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

Return value

Maximum spread values of meshes rotation angles, in degrees.

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.

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.

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.

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.

void Invalidate ( ) #

Invalidates all mesh clutter cells. All invalidated cells will be regenerated.

void Invalidate ( WorldBoundBox bounds ) #

Invalidates all mesh clutter cells within the area specified by the given bounding box. All invalidated cells will be regenerated.

Arguments

• WorldBoundBox bounds - Bounding box, defining the area, where mesh clutter cells will be regenerated.

static int type ( ) #

Returns the node type.

Return value

Node type identifier.

void ClearClutterExcludes ( ) #

Restores all cells removed by the calls to the setClutterExclude() method. Restored cells will be regenerated.

void SetClutterExclude ( WorldBoundBox bounds, int exclude ) #

Removes all cells within the area specified by the given bounding box. Generation of these cells will be skipped. This method can be used to replace some parts of the clutter with modified meshes (e.g., broken trees within the area around the shell crater in the forest).

Arguments

• WorldBoundBox bounds - Bounding box, defining the area, where mesh clutter cells will not be generated.
• int exclude - Exclude flag. Set 1 to remove all mesh clutter cells within the area; otherwise, set 0 to restore the removed ones. Restored cells will be regenerated.

bool GetClutterTransforms ( WorldBoundBox bounds, mat4[] OUT_transforms, bool precise = 1, bool force = 1 ) #

Collects transformations for all clutter meshes in the generated cells within the area specified by the given bounding box and puts them to the specified buffer.

Arguments

• WorldBoundBox bounds - Bounding box, defining the area, for which the transformations of clutter meshes are to be collected.
• mat4[] OUT_transforms - Buffer to store transformations of clutter meshes.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.
• bool precise - Precision flag:
  • 1 - transformations will be collected for clutter meshes within the specified bounding box
  • 0 - transformations will be collected for clutter meshes within the cells intersected by the specified bounding box
• bool force - Force flag.
  • 1 - regenerate all cells within the area, that were not generated, before collecting transformations for the meshes inside them.
  • 0 - transformations will be collected only for the meshes inside the clutter cells, that were generated.

Return value

true, if there are transformations of clutter meshes; or false, if there are no transformations of clutter meshes found.

bool GetClutterTransforms ( mat4[] OUT_transforms ) #

Collects transformations for all clutter meshes within the generated cells and puts them to the specified buffer.

Arguments

• mat4[] OUT_transforms - Buffer to store transformations of clutter meshes.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

Return value

true, if there are transformations of clutter meshes; or false, if there are no transformations of clutter meshes found.

bool GetClutterWorldTransforms ( WorldBoundBox bounds, mat4[] OUT_transforms, bool precise = 1, bool force = 1 ) #

Collects transformations (in world coordinates) for all clutter meshes in the generated cells within the area specified by the given bounding box and puts them to the specified buffer.

Arguments

• WorldBoundBox bounds - Bounding box, defining the area, for which the transformations of clutter meshes are to be collected.
• mat4[] OUT_transforms - Buffer to store transformations of clutter meshes, in world coordinates.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.
• bool precise - Precision flag:
  • 1 - transformations will be collected for clutter meshes within the specified bounding box
  • 0 - transformations will be collected for clutter meshes within the cells intersected by the specified bounding box
• bool force - Force flag.
  • 1 - regenerate all cells within the area, that were not generated, before collecting transformations for the meshes inside them.
  • 0 - transformations will be collected only for the meshes inside the clutter cells, that were generated.

Return value

true, if there are transformations of clutter meshes; or false, if there are no transformations of clutter meshes found.

bool GetClutterWorldTransforms ( mat4[] OUT_transforms ) #

Collects transformations (in world coordinates) for all clutter meshes within the generated cells and puts them to the specified buffer.

Arguments

• mat4[] OUT_transforms - Buffer to store transformations of clutter meshes, in world coordinates.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

Return value

true, if there are transformations of clutter meshes; or false, if there are no transformations of clutter meshes found.

int GetClutterLocalTransforms ( BoundBox bounds, mat4[] OUT_transforms, int precise = 1, int force = 1 ) #

Collects transformations (in local coordinates) for all clutter meshes within the generated cells and puts them to the specified buffer.

Arguments

• BoundBox bounds - Bounding box, defining the area, for which the transformations of clutter meshes are to be collected.
• mat4[] OUT_transforms - Buffer to store transformations of clutter meshes, in local coordinates.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.
• int precise - Precision flag:
  • 1 - transformations will be collected for clutter meshes within the specified bounding box
  • 0 - transformations will be collected for clutter meshes within the cells intersected by the specified bounding box
• int force - Force flag.
  • 1 - regenerate all cells within the area, that were not generated, before collecting transformations for the meshes inside them.
  • 0 - transformations will be collected only for the meshes inside the clutter cells, that were generated.

Return value

true, if there are transformations of clutter meshes; or false, if there are no transformations of clutter meshes found.

Mesh GetMeshCurrentRAM ( ) #

Returns the current source mesh used for the object and loaded to memory (RAM).

Return value

A current source mesh used for the object.

MeshRender GetMeshCurrentVRAM ( ) #

Returns the current render mesh used for the object and loaded to video memory (VRAM).

Return value

A current render mesh used for the object.

Mesh GetMeshForceRAM ( ) #

Returns the source mesh used for the object and loads it to memory (RAM) immediately.

Return value

A source mesh used for the object.

MeshRender GetMeshForceVRAM ( ) #

Returns the render mesh used for the object and loads it to video memory (VRAM) immediately. At that, the static mesh will also be loaded to memory (RAM).

Return value

A render mesh used for the object.

Mesh GetMeshAsyncRAM ( ) #

Returns the source mesh used for the object and loads it to memory (RAM) asynchronously.

Return value

A source mesh used for the object.

MeshRender GetMeshAsyncVRAM ( ) #

Returns the render mesh used for the object and loads it to video memory (VRAM) asynchronously. At that, the static mesh will also be loaded to memory (RAM).

Return value

A render mesh used for the object.

Mesh GetMeshDynamicRAM ( ) #

Returns the procedural source mesh associated with the object and ensures it is loaded into system memory (RAM). This method is only available when the mesh is in PROCEDURAL_MODE_DYNAMIC. A procedural mesh is a mesh created via code and uses a specific streaming mode. In PROCEDURAL_MODE_DYNAMIC, the object stays in memory after creation and is only unloaded manually using deleteDynamicMesh() or when the procedural mode is changed.

Return value

A procedural source mesh used for the object.

MeshRender GetMeshDynamicVRAM ( ) #

Returns the procedural render mesh associated with the object and ensures it is loaded into video memory (VRAM). This method is only available when the mesh is in PROCEDURAL_MODE_DYNAMIC. A procedural mesh is a mesh created via code and uses a specific streaming mode. In PROCEDURAL_MODE_DYNAMIC, the object stays in memory after creation and is only unloaded manually using deleteDynamicMesh() or when the procedural mode is changed.

Return value

A procedural render mesh used for the object.

bool LoadAsyncVRAM ( ) #

Asynchronously loads the mesh to video memory (VRAM) if the async streaming mode for meshes is enabled. Otherwise, the forced loading is performed. This method is recommended for implementing your own prefetch system (i.e. asynchronous pre-loading of meshes to video memory before they are used).

Return value

true if the mesh is loaded successfully, otherwise false. If the mesh is already loaded to VRAM, true will be returned.

bool LoadAsyncRAM ( ) #

Asynchronously loads the mesh to memory (RAM) if the async streaming mode for meshes is enabled. Otherwise, the forced loading is performed. This method is recommended for implementing your own prefetch system (i.e. asynchronous pre-loading of meshes to memory before they are used).

Return value

true if the mesh is loaded successfully, otherwise false. If the mesh is already loaded to RAM, true will be returned.

bool LoadForceVRAM ( ) #

Performs force-loading of the mesh to video memory (VRAM) immediately.

Return value

true if the mesh is loaded successfully, otherwise false. If the mesh is already loaded to VRAM, true will be returned.

bool LoadForceRAM ( ) #

Performs force-loading of the mesh to memory (RAM) immediately.

Return value

true if the mesh is loaded successfully, otherwise false. If the mesh is already loaded to RAM, true will be returned.

void SetMeshProceduralMode ( ObjectMeshStatic.PROCEDURAL_MODE mode, int mesh_render_flags = 0 ) #

Sets the procedural mode for the mesh. The specified mode defines how procedural data is stored, updated, and unloaded.

Arguments

• ObjectMeshStatic.PROCEDURAL_MODE mode - One of the PROCEDURAL_MODE to apply to the mesh.
• int mesh_render_flags - Optional usage flags that control how vertex and index data are stored for the mesh render.

Mesh CreateCopyMeshRAM ( ) #

Creates and returns a copy of the source mesh used by the object, loading it directly from disk if it is not present in cache. This method does not stream the copied mesh into memory cache, resulting in lower RAM usage.

Return value

A copy of the source mesh, or nullptr if source mesh is not presented in RAM or its file path is invalid.

bool GetCopyMeshRAM ( Mesh result ) #

Retrieves a copy of the source mesh used by the object and writes it to the provided mesh object. If the mesh is not present in cache, it is loaded directly from disk. This method does not stream the copied mesh into memory cache, resulting in lower RAM usage.

Arguments

• Mesh result - Object that will receive a copy of the source mesh.

Return value

true if the mesh was copied successfully, false if source mesh is not present in RAM or its file path is invalid.

bool ApplyCopyMeshProceduralForce ( Mesh mesh, int mesh_render_flags = 0 ) #

Copies all vertex data from the given mesh into the object's procedural mesh forcibly, executing the operation immediately.

Arguments

• Mesh mesh - Source mesh to copy vertex data from.
• int mesh_render_flags - Optional usage flags for MeshRender.

Return value

true if the mesh was copied successfully, otherwise false.

bool ApplyMoveMeshProceduralForce ( Mesh mesh, int mesh_render_flags = 0 ) #

Moves all vertex data from the given mesh into the object's procedural mesh forcibly, executing the operation immediately without memory allocation and data copying (move semantics).

In PROCEDURAL_MODE_DYNAMIC, this method behaves identically to its asynchronous variant.

Arguments

• Mesh mesh - Source mesh to move vertex data from.
• int mesh_render_flags - Optional usage flags for MeshRender.

Return value

true if the mesh was moved (transferred without copying) successfully, otherwise false.

bool ApplyMoveMeshProceduralForce ( Mesh mesh_ram, MeshRender mesh_vram ) #

Moves all vertex and render data from the given mesh_ram and mesh_vram into the object's procedural mesh forcibly, executing the operation immediately using move semantics, without data copying or VRAM allocation.

Arguments

• Mesh mesh_ram - Source mesh containing vertex data.
• MeshRender mesh_vram - Source mesh containing render data.

Return value

true if the data was moved (transferred without copying) successfully, otherwise false.

bool ApplyCopyMeshProceduralAsync ( Mesh mesh, int mesh_render_flags = 0 ) #

Copies all vertex data from the given mesh into the object's procedural mesh asynchronously. The operation is not forced and is executed in the background with no noticeable delay.

In PROCEDURAL_MODE_FILE and PROCEDURAL_MODE_BLOB, this method performs faster compared to the forced variant, as file writes and memory operations are offloaded to background threads.

Arguments

• Mesh mesh - Source mesh to copy vertex data from.
• int mesh_render_flags - Optional usage flags for MeshRender.

Return value

true if the mesh was copied successfully, otherwise false.

bool ApplyMoveMeshProceduralAsync ( Mesh mesh, int mesh_render_flags = 0 ) #

Moves all vertex data from the given mesh into the object's procedural mesh asynchronously. The operation is not forced and is executed in the background with no noticeable delay, without memory allocation and data copying (move semantics).

In PROCEDURAL_MODE_FILE and PROCEDURAL_MODE_BLOB, this method performs faster compared to the forced variant, as file writes and memory operations are offloaded to background threads.

Arguments

• Mesh mesh - Source mesh to copy vertex data from.
• int mesh_render_flags - Optional usage flags for MeshRender.

bool ApplyMoveMeshProceduralAsync ( Mesh mesh_ram, MeshRender mesh_vram ) #

Moves all vertex and render data from the given mesh_ram and mesh_vram into the object's procedural mesh asynchronously, without copying or allocating VRAM. The operation is not forced and is executed in the background with no noticeable delay.

In PROCEDURAL_MODE_FILE and PROCEDURAL_MODE_BLOB, this method performs faster, as file writes and memory operations are offloaded to background threads.

In PROCEDURAL_MODE_DYNAMIC, this method behaves identically to its forced variant.

Arguments

• Mesh mesh_ram - Source mesh containing vertex data.
• MeshRender mesh_vram - Source mesh containing render data.

Return value

true if the data was moved successfully, otherwise false.

bool DeleteDynamicMesh ( ) #

Releases all memory used by the procedural mesh, including both VRAM and RAM.

Return value

true if the memory was released successfully, otherwise false.

bool RunGenerateMeshProceduralAsync ( GenerateMeshProcedural callback_generate, int mesh_render_flags = 0 ) #

Starts asynchronous generation of procedural mesh data. The callback_generate function is executed in a background thread and must create and fill a mesh object with new data. The generated mesh will be transferred to the object once complete, without blocking the main thread.

Note that the callback is executed in a single dedicated thread controlled by the engine, it is not parallelized and must not spawn additional threads.

Arguments

• GenerateMeshProcedural callback_generate - Callback function responsible for creating and filling the source mesh. Executed in the main thread. The function must have the following signature:

  void GenerateMeshProcedural(Mesh mesh)

• int mesh_render_flags - Optional usage flags for MeshRender.

Return value

true if the modification was completed and applied successfully, otherwise false

bool RunGenerateMeshProceduralAsync ( GenerateMeshProcedural callback_generate, DoneMeshProcedural callback_done, int mesh_render_flags = 0 ) #

Starts asynchronous generation of procedural mesh data. The callback_generate function is executed in a background thread and must create and fill a mesh object with new data. The generated mesh will be transferred to the object once complete, without blocking the main thread. After the mesh has been applied to the object, the optional callback_done will be called.

Note that the callback is executed in a single dedicated thread controlled by the engine, it is not parallelized and must not spawn additional threads.

Arguments

• GenerateMeshProcedural callback_generate - Callback function responsible for creating and filling the source mesh. Executed in the main thread. The function must have the following signature:

  void GenerateMeshProcedural(Mesh mesh)

• DoneMeshProcedural callback_done - Optional callback executed after geometry has been fully applied. The function must have the following signature:

  void DoneMeshProcedural()

• int mesh_render_flags - Optional usage flags for MeshRender.

Return value

true if the generation was completed and applied successfully, otherwise false

bool RunGenerateMeshProceduralForce ( GenerateMeshProcedural callback_generate, int mesh_render_flags = 0 ) #

Starts immediate (forced) generation of procedural mesh data. The callback_generate function is executed in the main thread and must create and fill a mesh object with new data. The generated mesh is applied to the object as soon as generation completes.

Arguments

• GenerateMeshProcedural callback_generate - Callback function responsible for creating and filling the source mesh. Executed in the main thread. The function must have the following signature:

  void GenerateMeshProcedural(Mesh mesh)

• int mesh_render_flags - Optional usage flags for MeshRender.

Return value

true if the generation was completed and applied successfully, otherwise false

bool RunGenerateMeshProceduralForce ( GenerateMeshProcedural callback_generate, DoneMeshProcedural callback_done, int mesh_render_flags = 0 ) #

Starts immediate (forced) generation of procedural mesh data. The callback_generate function is executed in the main thread and must create and fill a Mesh object with vertex data. Once the mesh is applied to the object, the optional callback_done is called on the main thread.

Arguments

• GenerateMeshProcedural callback_generate - Callback function responsible for creating and filling the source mesh. Executed in the main thread. The function must have the following signature:

  void GenerateMeshProcedural(Mesh mesh)

• DoneMeshProcedural callback_done - Optional callback executed after geometry has been fully applied. The function must have the following signature:

  void DoneMeshProcedural()

• int mesh_render_flags - Optional usage flags for MeshRender.

Return value

true if the generation was completed and applied successfully, otherwise false