ObjectMeshStatic Class
| Inherits from: | Object |
This class is used for handling static meshes.
A static mesh represents a non-deformable collection of vertices, edges, and triangles defining the object's geometry. By default, its geometry is fixed at runtime and can only be transformed as a whole (moved, rotated, scaled). However, ObjectMeshStatic supports optional procedural modes, which allows modifying or generating mesh data in runtime via code.
Procedural Mesh Workflow#
Static meshes support streaming, allowing geometry to be loaded from disk on demand to reduce memory usage. However, when procedural mode is enabled, streaming behavior changes depending on the selected mode, some modes keep all data in memory, while others allow disk-based access. These differences directly affect performance and memory consumption during runtime.
When using static meshes for procedural geometry, the typical workflow is:
-
Create or Load a Mesh
Begin by creating a mesh using the Mesh API or loading an existing one from disk. You can fully define geometry in code (vertices, indices, surfaces, etc.), or reuse prepared assets as input data.
-
Bind the Mesh to the Object
Assign the mesh to a static mesh using one of the available application methods (see below). At this stage, the mesh is not yet editable unless procedural mode is enabled.
-
Enable Procedural Mode
Call setMeshProceduralMode to enable runtime modification. Geometry cannot be modified unless one of the procedural modes is selected.
NoticeEach procedural mode has specific behavior regarding how geometry is stored and accesed (in RAM, VRAM, or file). See the PROCEDURAL_MODE descriptions for details on how each mode handles memory, streaming, and performance. -
Apply or Generate Geometry
There are two main approaches to updating procedural mesh data:
-
Use Simplified Generation API
For common procedural workflows, the runGenerateMeshProceduralAsync() and runGenerateMeshProceduralForce() methods allow you to schedule mesh generation via callbacks. The engine handles threading and timing internally. In your callback, you define how the geometry is built (e.g. populate Mesh and MeshRender), and the engine will apply it automatically.
-
Use Direct Application Methods
You can also apply mesh data directly using a set of methods that differ by update strategy. All of them serve the same purpose: replace the current mesh with new data. The differences are encoded in the method names:
- copy: Mesh data is copied into the object's internal memory.
- move: Mesh data is transferred into the object using move semantics, without memory copying. This avoids the cost of copying operations and allows for faster updates.
- force: The operation is executed immediately in the main thread. Useful for real-time updates when delay is unacceptable. In PROCEDURAL_MODE_DYNAMIC, forced move behaves identically to its asynchronous variant.
- async: This avoids blocking the main thread and is especially useful in PROCEDURAL_MODE_FILE or PROCEDURAL_MODE_BLOB modes, where disk I/O or memory streaming can be offloaded.
NoticeIf a method name contains one of these terms, it reflects how the mesh data is transferred and when the operation is performed.Choose the method that matches your needs, e.g. use applyCopyMeshProceduralForce() for an immediate copy, or applyMoveMeshProceduralAsync() to transfer data without blocking the main thread.
-
Use Simplified Generation API
-
Finalize for Collision and Intersection Support
If the mesh is intended to participate in collision and intersection checks, you must explicitly call createCollisionData() after geometry modification is complete. That ensures that required internal data structures (such as edges and spatial tree) are generated and up-to-date.
See Also#
ObjectMeshStatic Class
Members
static ObjectMeshStatic ( string path ) #
ObjectMeshStatic constructor. Creates a Static Mesh object with mesh loaded from the specified file.Arguments
- string path - Path to the source .mesh-file.
static ObjectMeshStatic ( ) #
ObjectMeshStatic constructor. Creates an empty Static Mesh object.static int type ( ) #
Returns the type of the object.Return value
Object Mesh Static type identifier.void setMeshPath ( string path ) #
Sets the new path to the source mesh. Does not update mesh immediately using the new path. If the mesh is in the procedural mode, it will be reset.Arguments
- string path - Path to the source .mesh-file.
string getMeshPath ( ) #
Returns the path to the current source mesh file.Return value
Path to the source .mesh-file.void setLightmapEnabled ( int enabled, int surface ) #
Sets a value indicating if lightmapping is to be enabled for the surface with the specified number.Arguments
- int enabled - 1 to enable lightmapping for the surface with the specified number, or 0 - to disable.
- int surface - Mesh surface number.
int isLightmapEnabled ( int surface ) #
Returns a value indicating if lightmapping is enabled for the surface with the specified number.Arguments
- int surface - Mesh surface number.
Return value
1 if lightmapping is enabled for the surface with the specified number;otherwise, 0.void setLightmapMode ( int mode, int surface ) #
Sets a new lightmap mode for the surface with the specified number.Arguments
- int mode - New lightmap mode to be set for the surface with the specified number. One of the LIGHTMAP_MODE values.
- int surface - Mesh surface number.
int getLightmapMode ( int surface ) #
Returns the current lightmap mode for the surface with the specified number.Arguments
- int surface - Mesh surface number.
Return value
Current lightmap mode for the surface with the specified number. One of the LIGHTMAP_MODE values.void setLightmapSourceSurface ( int source_surface, int surface ) #
Sets a new source mesh surface number for the surface with the specified number. A lightmap texture generated for the source mesh surface shall be used for the specified surface (available only when the lightmap mode for the surface is set to LIGHTMAP_MODE_SURFACE mode. This can be used as optimization for LODs.Arguments
- int source_surface - Source mesh surface number.
- int surface - Mesh surface number.
int getLightmapSourceSurface ( int surface ) #
Returns the current source mesh surface number for the surface with the specified number. A lightmap texture generated for the source mesh surface is used for the specified surface (available only when the lightmap mode for the surface is set to LIGHTMAP_MODE_SURFACE mode. This can be used as optimization for LODs.Arguments
- int surface - Mesh surface number.
Return value
Source mesh surface number.int isLightmapCompression ( int surface ) #
Returns a value indicating if the lightmap texture baked for the surface with the specified number is to be compressed. Compressed lightmaps are lightweight, but please note that some compression artifacts may appear.Arguments
- int surface - Mesh surface number.
Return value
1 if the lightmap texture baked for the surface with the specified number is to be compressed; otherwise, 0.void setLightmapCompression ( int enabled, int surface ) #
Sets a value indicating if the lightmap texture baked for the surface with the specified number is to be compressed. Compressed lightmaps are lightweight, but please note that some compression artifacts may appear.Arguments
- int enabled - 1 to enable compression for the lightmap texture baked for the surface with the specified number, or 0 - to disable.
- int surface - Mesh surface number.
void setLightmapQuality ( int quality, int surface ) #
Sets a new lightmap baking quality preset for the surface with the specified number.Arguments
- int quality - New lightmap baking quality preset to be used for the surface with the specified number. One of the LIGHTMAP_QUALITY values.
- int surface - Mesh surface number.
int getLightmapQuality ( int surface ) #
Returns the current lightmap baking quality preset for the surface with the specified number.Arguments
- int surface - Mesh surface number.
Return value
Current lightmap baking quality preset for the surface with the specified number. One of the LIGHTMAP_QUALITY values.void setLightmapTextureFilePath ( string path, int surface ) #
Sets a new path to the baked lightmap texture file to be used for the surface with the specified number. You can use this method to specify a lightmap texture generated in a third-party software.Arguments
- string path - Path to the baked lightmap texture file to be used for the surface with the specified number.
- int surface - Mesh surface number.
String getLightmapTextureFilePath ( int surface ) #
Returns the path to the baked lightmap texture file currently used for the surface with the specified number.Arguments
- int surface - Mesh surface number.
Return value
Path to the baked lightmap texture file currently used for the surface with the specified number.void setSurfaceCustomTextureEnabled ( int enabled, int surface ) #
Sets a value indicating if a custom texture is to be used for the surface with the specified number.Arguments
- int enabled - 1 to enable using the custom texture for the surface with the specified number, or 0 - to disable.
- int surface - Mesh surface number.
int isSurfaceCustomTextureEnabled ( int surface ) #
Returns a value indicating if a custom texture is to be used for the surface with the specified number.Arguments
- int surface - Mesh surface number.
Return value
1 if a custom texture is to be used for the surface with the specified number; otherwise, 0.void setSurfaceCustomTextureMode ( int mode, int surface ) #
Sets a new mode for the custom texture of the surface with the specified number. This mode defines the source of the custom texture for the surface: either use a unique custom texture, or use a custom texture that is assigned to another surface of the mesh.Arguments
- int mode - Custom texture mode to be set for the surface with the specified number. One of the SURFACE_CUSTOM_TEXTURE_MODE_ values.
- int surface - Mesh surface number.
int getSurfaceCustomTextureMode ( int surface ) #
Returns the current mode for the custom texture of the surface with the specified number. This mode defines the source of the custom texture for the surface: either use a unique custom texture, or use a custom texture that is assigned to another surface of the mesh.Arguments
- int surface - Mesh surface number.
Return value
Current custom texture mode for the surface with the specified number. One of the SURFACE_CUSTOM_TEXTURE_MODE_ values.void setSurfaceCustomTextureSourceSurface ( int source_surface, int surface ) #
Sets a new source mesh surface number for the surface with the specified number. A custom texture generated for the source mesh surface shall be used for the specified surface (available only when the custom texture mode for the surface is set to SURFACE_CUSTOM_TEXTURE_MODE_SURFACE. This can be used as optimization for LODs.Arguments
- int source_surface - Source mesh surface number.
- int surface - Mesh surface number.
int getSurfaceCustomTextureSourceSurface ( int surface ) #
Returns the current source mesh surface number for the surface with the specified number. A custom texture generated for the source mesh surface is used for the specified surface (available only when the custom texture mode for the surface is set to SURFACE_CUSTOM_TEXTURE_MODE_SURFACE. This can be used as optimization for LODs.Arguments
- int surface - Mesh surface number.
Return value
Source mesh surface number.void setSurfaceCustomTexturePath ( string path, int surface ) #
Sets a new path to the custom texture to be used for the surface with the specified number. You can use this method to specify a texture generated in a third-party software.Arguments
- string path - Path to the custom texture to be assigned to the surface with the specified number.
- int surface - Mesh surface number.
string getSurfaceCustomTexturePath ( int surface ) #
Returns the path to the custom texture currently assigned to the surface with the specified index.Arguments
- int surface - Mesh surface number.
Return value
Path to the custom texture currently assigned to the surface with the specified number.void setSurfaceCustomTexture ( Texture texture, int surface ) #
Sets a new texture to be used as a custom texture for the surface with the specified number. You can use this method to set any texture.Arguments
- Texture texture - Texture to be set.
- int surface - Mesh surface number.
Texture getSurfaceCustomTexture ( int surface ) #
Returns the texture currently used as a custom texture for the surface with the specified number.Arguments
- int surface - Mesh surface number.
Return value
Texture used as a custom texture for the specified surface.ConstMesh 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 source mesh used for the object and loaded to video memory (VRAM).Return value
A current render mesh used for the object.ConstMesh 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.ConstMesh 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 the dynamic (PROCEDURAL_MODE_DYNAMIC) mode. A procedural mesh is a mesh created via code and uses a specific streaming mode. In dynamic mode, the object constantly remains in memory after creation and is only unloaded manually using deleteDynamicMesh() or when the procedural mode is changed.Please note that procedural mesh modification directly affects streaming and memory usage (RAM, VRAM, and disk) depending on the selected procedural mode. For details, see the Procedural Mesh Workflow section.
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 the dynamic (PROCEDURAL_MODE_DYNAMIC) mode. A procedural mesh is a mesh created via code and uses a specific streaming mode. In dynamic mode, the object constantly remains in memory after creation and is only unloaded manually using deleteDynamicMesh() or when the procedural mode is changed.Please note that procedural mesh modification directly affects streaming and memory usage (RAM, VRAM, and disk) depending on the selected procedural mode. For details, see the Procedural Mesh Workflow section.
Return value
A procedural render mesh used for the object.int 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
1 if the mesh is loaded successfully, otherwise 0. If the mesh is already loaded to VRAM, 1 will be returned.int 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
1 if the mesh is loaded successfully, otherwise 0. If the mesh is already loaded to RAM, 1 will be returned.int loadForceVRAM ( ) #
Performs force-loading of the mesh to video memory (VRAM) immediately.Return value
1 if the mesh is loaded successfully, otherwise 0. If the mesh is already loaded to VRAM, 1 will be returned.int loadForceRAM ( ) #
Performs force-loading of the mesh to memory (RAM) immediately.Return value
1 if the mesh is loaded successfully, otherwise 0. If the mesh is already loaded to RAM, 1 will be returned.void setMeshProceduralMode ( int 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.Please note that procedural mesh modification directly affects streaming and memory usage (RAM, VRAM, and disk) depending on the selected procedural mode. For details, see the Procedural Mesh Workflow section.
Arguments
- int 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.
int getMeshProceduralMode ( ) #
Returns a value indicating which procedural mode assigned to the mesh. The value corresponds to one of the available PROCEDURAL_MODE types, determining how procedural data is stored, updated, and unloaded.Please note that procedural mesh modification directly affects streaming and memory usage (RAM, VRAM, and disk) depending on the selected procedural mode. For details, see the Procedural Mesh Workflow section.
Return value
Current procedural mode of the mesh.int isMeshNull ( ) #
Returns a value indicating if the source mesh used for the object is null (does not exist, unassigned, not loaded, etc.).Return value
1 if the source mesh used for the object is null; otherwise, 0.int isMeshLoadedRAM ( ) #
Returns a value indicating if the source mesh used for the object is loaded to memory (RAM).Return value
1 if the source mesh used for the object is loaded to RAM; otherwise, 0.int isMeshLoadedVRAM ( ) #
Returns a value indicating if the source mesh used for the object is loaded to video memory (VRAM).Return value
1 if the source mesh used for the object is loaded to VRAM; otherwise, 0.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.int 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.int applyCopyMeshProceduralForce ( ConstMesh 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. Works only when procedural mode is enabled.
Please note that procedural mesh modification directly affects streaming and memory usage (RAM, VRAM, and disk) depending on the selected procedural mode. For details, see the Procedural Mesh Workflow section.
Arguments
- ConstMesh 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.int 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). Works only when procedural mode is enabled.
In PROCEDURAL_MODE_DYNAMIC, this method behaves identically to its asynchronous variant.
Please note that procedural mesh modification directly affects streaming and memory usage (RAM, VRAM, and disk) depending on the selected procedural mode. For details, see the Procedural Mesh Workflow section.
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.int applyCopyMeshProceduralAsync ( ConstMesh 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. Works only when procedural mode is enabled.
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.
Please note that procedural mesh modification directly affects streaming and memory usage (RAM, VRAM, and disk) depending on the selected procedural mode. For details, see the Procedural Mesh Workflow section.
Arguments
- ConstMesh 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.int 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). Works only when procedural mode is enabled.
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.
Please note that procedural mesh modification directly affects streaming and memory usage (RAM, VRAM, and disk) depending on the selected procedural mode. For details, see the Procedural Mesh Workflow section.
Arguments
- Mesh mesh - Source mesh to copy vertex data from.
- int mesh_render_flags - Optional usage flags for MeshRender.
int deleteDynamicMesh ( ) #
Releases all memory used by the procedural mesh, including both VRAM and RAM. Works only when procedural mode is set to PROCEDURAL_MODE_DYNAMIC.
Please note that procedural mesh modification directly affects streaming and memory usage (RAM, VRAM, and disk) depending on the selected procedural mode. For details, see the Procedural Mesh Workflow section.
Return value
true if the memory was released successfully, otherwise false.int 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. Works only when procedural mode is enabled.
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.
Please note that procedural mesh modification directly affects streaming and memory usage (RAM, VRAM, and disk) depending on the selected procedural mode. For details, see the Procedural Mesh Workflow section.
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 falseint 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. Works only when procedural mode is enabled.
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.
Please note that procedural mesh modification directly affects streaming and memory usage (RAM, VRAM, and disk) depending on the selected procedural mode. For details, see the Procedural Mesh Workflow section.
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 falseint 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. Works only when procedural mode is enabled.
Please note that procedural mesh modification directly affects streaming and memory usage (RAM, VRAM, and disk) depending on the selected procedural mode. For details, see the Procedural Mesh Workflow section.
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 falseint 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. Works only when procedural mode is enabled.
Please note that procedural mesh modification directly affects streaming and memory usage (RAM, VRAM, and disk) depending on the selected procedural mode. For details, see the Procedural Mesh Workflow section.
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 falseThe information on this page is valid for UNIGINE 2.20 SDK.