Unigine::ObjectMeshStatic Class

ObjectMeshStatic Class

Enums

LIGHTMAP_QUALITY#

Lightmap baking quality preset to be used.

Name	Description
LIGHTMAP_QUALITY_GLOBAL = 0	Global quality preset set in the Bake Lighting settings.
LIGHTMAP_QUALITY_DRAFT = 1	Draft quality preset for lightmaps.
LIGHTMAP_QUALITY_LOW = 2	Low quality preset for lightmaps.
LIGHTMAP_QUALITY_MEDIUM = 3	Medium quality preset for lightmaps.
LIGHTMAP_QUALITY_HIGH = 4	High quality preset for lightmaps.
LIGHTMAP_QUALITY_ULTRA = 5	Ultra quality preset for lightmaps.

LIGHTMAP_MODE#

Lightmap mode defining the source of lightmap texture to be used.

Name	Description
LIGHTMAP_MODE_UNIQUE = 0	Bake a unique lightmap texture for the surface.
LIGHTMAP_MODE_CUSTOM = 1	Use a custom lightmap texture for the surface.
LIGHTMAP_MODE_SURFACE = 2	Reuse an already baked lightmap texture from another surface. Can be used for LODs.

SURFACE_CUSTOM_TEXTURE_MODE#

Mode defining the source of surface custom texture to be used.

Name	Description
SURFACE_CUSTOM_TEXTURE_MODE_UNIQUE = 0	Use a unique custom texture for the surface.
SURFACE_CUSTOM_TEXTURE_MODE_SURFACE = 1	Use the custom texture from another surface. This option is intended for use with LODs having the same UV maps.

PROCEDURAL_MODE#

Name	Description
PROCEDURAL_MODE_DISABLE = 0
PROCEDURAL_MODE_DYNAMIC = 1
PROCEDURAL_MODE_FILE = 2
PROCEDURAL_MODE_BLOB = 3

Members

---

static ObjectMeshStaticPtr create ( const char * path ) #

ObjectMeshStatic constructor. Creates a Static Mesh object with mesh loaded from the specified file.

Arguments

• const char * path - Path to the source .mesh-file.

static ObjectMeshStaticPtr create ( ) #

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 ( const char * 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

• const char * path - Path to the source .mesh-file.

const char * getMeshPath ( ) const#

Returns the path to the current source mesh file.

Return value

Path to the source .mesh-file.

void setLightmapEnabled ( bool enabled, int surface ) #

Sets a value indicating if lightmapping is to be enabled for the surface with the specified number.

Arguments

• bool enabled - true to enable lightmapping for the surface with the specified number, or false - to disable.
• int surface - Mesh surface number.

bool isLightmapEnabled ( int surface ) const#

Returns a value indicating if lightmapping is enabled for the surface with the specified number.

Arguments

• int surface - Mesh surface number.

Return value

true if lightmapping is enabled for the surface with the specified number;otherwise, false.

void setLightmapMode ( ObjectMeshStatic::LIGHTMAP_MODE mode, int surface ) #

Sets a new lightmap mode for the surface with the specified number.

Arguments

• ObjectMeshStatic::LIGHTMAP_MODE 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.

ObjectMeshStatic::LIGHTMAP_MODE getLightmapMode ( int surface ) const#

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 ) const#

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.

bool isLightmapCompression ( int surface ) const#

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

true if the lightmap texture baked for the surface with the specified number is to be compressed; otherwise, false.

void setLightmapCompression ( bool 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

• bool enabled - true to enable compression for the lightmap texture baked for the surface with the specified number, or false - to disable.
• int surface - Mesh surface number.

void setLightmapQuality ( ObjectMeshStatic::LIGHTMAP_QUALITY quality, int surface ) #

Sets a new lightmap baking quality preset for the surface with the specified number.

Arguments

• ObjectMeshStatic::LIGHTMAP_QUALITY 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.

ObjectMeshStatic::LIGHTMAP_QUALITY getLightmapQuality ( int surface ) const#

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 ( const char * 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

• const char * 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 ) const#

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 ( bool enabled, int surface ) #

Sets a value indicating if a custom texture is to be used for the surface with the specified number.

Arguments

• bool enabled - true to enable using the custom texture for the surface with the specified number, or false - to disable.
• int surface - Mesh surface number.

bool isSurfaceCustomTextureEnabled ( int surface ) const#

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

true if a custom texture is to be used for the surface with the specified number; otherwise, false.

void setSurfaceCustomTextureMode ( ObjectMeshStatic::SURFACE_CUSTOM_TEXTURE_MODE 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

• ObjectMeshStatic::SURFACE_CUSTOM_TEXTURE_MODE 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.

ObjectMeshStatic::SURFACE_CUSTOM_TEXTURE_MODE getSurfaceCustomTextureMode ( int surface ) const#

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 ) const#

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 ( const char * 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

• const char * path - Path to the custom texture to be assigned to the surface with the specified number.
• int surface - Mesh surface number.

const char * getSurfaceCustomTexturePath ( int surface ) const#

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 ( const Ptr<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

• const Ptr<Texture> & texture - Texture to be set.
• int surface - Mesh surface number.

Ptr<Texture> getSurfaceCustomTexture ( int surface ) const#

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.

Ptr<ConstMesh> getMeshCurrentRAM ( ) const#

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

Return value

A current source mesh used for the object.

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

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

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

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

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

Ptr<Mesh> getMeshDynamicRAM ( ) #

Returns the procedural source mesh used for the object and loads it to memory (RAM) using the specific streaming mode for procedural meshes. A procedural mesh is a mesh created via code, such meshes have a specific streaming mode — they are always kept in memory after creation and never unloaded until the object is destroyed via code or the mesh returns to its normal mode (streaming from a source file). Changing of the static mesh is possible only if it is in the procedural mode.

Return value

A procedural source mesh used for the object.

Ptr<MeshRender> getMeshDynamicVRAM ( ) #

Returns the procedural render mesh used for the object and loads it to video memory (VRAM) using the specific streaming mode for procedural meshes. A procedural mesh is a mesh created via code, such meshes have a specific streaming mode — they are always kept in memory after creation and never unloaded until the object is destroyed via code or the mesh returns to its normal mode (streaming from a source file). Changing of the static mesh is possible only if it is in the procedural mode.

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

Arguments

• ObjectMeshStatic::PROCEDURAL_MODE mode
• int mesh_render_flags

ObjectMeshStatic::PROCEDURAL_MODE getMeshProceduralMode ( ) const#

bool isMeshNull ( ) const#

Returns a value indicating if the source mesh used for the object is null (does not exist, unassigned, not loaded, etc.).

Return value

true if the source mesh used for the object is null; otherwise, false.

bool isMeshLoadedRAM ( ) const#

Returns a value indicating if the source mesh used for the object is loaded to memory (RAM).

Return value

true if the source mesh used for the object is loaded to RAM; otherwise, false.

bool isMeshLoadedVRAM ( ) const#

Returns a value indicating if the source mesh used for the object is loaded to video memory (VRAM).

Return value

true if the source mesh used for the object is loaded to VRAM; otherwise, false.

Ptr<Mesh> createCopyMeshRAM ( ) const#

bool getCopyMeshRAM ( Ptr<Mesh> & result ) const#

Arguments

• Ptr<Mesh> & result

bool isMeshProceduralDone ( ) const#

bool isMeshProceduralActive ( ) const#

bool isMeshProceduralDynamic ( ) const#

bool applyCopyMeshProceduralForce ( const Ptr<ConstMesh> & mesh, int mesh_render_flags = 0 ) #

Arguments

• const Ptr<ConstMesh> & mesh
• int mesh_render_flags

bool applyMoveMeshProceduralForce ( const Ptr<Mesh> & mesh, int mesh_render_flags = 0 ) #

Arguments

• const Ptr<Mesh> & mesh
• int mesh_render_flags

bool applyMoveMeshProceduralForce ( const Ptr<Mesh> & mesh_ram, const Ptr<MeshRender> & mesh_vram ) #

Arguments

• const Ptr<Mesh> & mesh_ram
• const Ptr<MeshRender> & mesh_vram

bool applyCopyMeshProceduralAsync ( const Ptr<ConstMesh> & mesh, int mesh_render_flags = 0 ) #

Arguments

• const Ptr<ConstMesh> & mesh
• int mesh_render_flags

bool applyMoveMeshProceduralAsync ( const Ptr<Mesh> & mesh, int mesh_render_flags = 0 ) #

Arguments

• const Ptr<Mesh> & mesh
• int mesh_render_flags

bool applyMoveMeshProceduralAsync ( const Ptr<Mesh> & mesh_ram, const Ptr<MeshRender> & mesh_vram ) #

Arguments

• const Ptr<Mesh> & mesh_ram
• const Ptr<MeshRender> & mesh_vram

bool deleteDynamicMesh ( ) #

bool runGenerateMeshProceduralAsync ( CallbackBase1<Ptr<Mesh>> * callback_generate, int mesh_render_flags = 0 ) #

Arguments

• CallbackBase1<Ptr<Mesh>> * callback_generate
• int mesh_render_flags

bool runGenerateMeshProceduralAsync ( CallbackBase1<Ptr<Mesh>> * callback_generate, CallbackBase * callback_done, int mesh_render_flags = 0 ) #

Arguments

• CallbackBase1<Ptr<Mesh>> * callback_generate
• CallbackBase * callback_done
• int mesh_render_flags

bool runGenerateMeshProceduralForce ( CallbackBase1<Ptr<Mesh>> * callback_generate, int mesh_render_flags = 0 ) #

Arguments

• CallbackBase1<Ptr<Mesh>> * callback_generate
• int mesh_render_flags

bool runGenerateMeshProceduralForce ( CallbackBase1<Ptr<Mesh>> * callback_generate, CallbackBase * callback_done, int mesh_render_flags = 0 ) #

Arguments

• CallbackBase1<Ptr<Mesh>> * callback_generate
• CallbackBase * callback_done
• int mesh_render_flags