Unigine::ObjectGuiMesh Class

ObjectGuiMesh Class

Members

---

static ObjectGuiMeshPtr create ( const char * mesh_path, const char * name = 0 ) #

An ObjectGuiMesh constructor. The Gui Mesh will be created on the basis of the mesh loaded from the specified path.

Arguments

• const char * mesh_path - Path to the source .mesh-file used for the object
• const char * name

static ObjectGuiMeshPtr create ( ) #

Constructor. Creates a new Gui Mesh object.

void setControlDistance ( float distance ) #

Sets a distance at which the GUI becomes controllable.

Arguments

• float distance - A new distance in units.

float getControlDistance ( ) const#

Returns the distance at which the GUI becomes controllable.

Return value

The distance in units.

Ptr<Gui> getGui ( ) const#

Returns a Gui instance associated with the object.

Return value

Gui smart pointer.

void setMeshPath ( const char * path ) #

Sets a new path to the source mesh for the Gui Mesh object. If the mesh is in the procedural mode, it will be reset.

Arguments

• const char * path - New path to the source .mesh-file to be set.

const char * getMeshPath ( ) const#

Returns the path to the source .mesh-file currently used for the Gui Mesh object.

Return value

Path to the source .mesh-file.

void setMouse ( const Math::Vec3 & p0, const Math::Vec3 & p1, int mouse_buttons, bool mouse_show ) #

Sets mouse cursor position in the virtual control mode.

Arguments

• const Math::Vec3 & p0 - Start point. A line segment between the start and the end points must intersect ObjectGui. The point of intersection determines x and y coordinates on the ObjectGui.
• const Math::Vec3 & p1 - End point. A line segment between the start and the end points must intersect ObjectGui. The point of intersection determines x and y coordinates on the ObjectGui.
• int mouse_buttons - Mouse button status. Set 1 to indicate that the button is clicked; otherwise, 0.
• bool mouse_show - Mouse cursor status. Set 1 to show mouse cursor; otherwise, 0.

void setMouseMode ( int mode ) #

Sets mouse mode. This method can be used to set a virtual control mode for the mouse.

Arguments

• int mode - Mouse mode. One of the MOUSE_* variables.

int getMouseMode ( ) const#

Returns the current mouse mode.

Return value

Mouse mode. One of the MOUSE_* variables.

void setMouseShow ( bool show ) #

Sets a value indicating if the mouse cursor should be rendered in the mesh GUI object.

Arguments

• bool show - true to render the mouse cursor; otherwise, false.

bool isMouseShow ( ) const#

Returns a value indicating if the mouse cursor is rendered in the mesh GUI object.

Return value

true if the cursor is rendered; otherwise, false.

void setBackground ( bool background ) #

Sets a value indicating if the GUI background (black screen) should be rendered.

Arguments

• bool background - true to render GUI background, false to keep it transparent.

bool isBackground ( ) const#

Returns a value indicating if GUI background (black screen) is rendered.

Return value

true if background is rendered; otherwise, false.

int getScreenHeight ( ) const#

Returns the screen height of the mesh GUI object.

Return value

Height in pixels.

void setScreenSize ( int width, int height ) #

Sets screen dimensions of the mesh GUI object.

Arguments

• int width - New width in pixels. If a negative value is provided, 0 will be used instead.
• int height - New height in pixels. If a negative value is provided, 0 will be used instead.

int getScreenWidth ( ) const#

Returns the screen width of the mesh GUI object.

Return value

Width in pixels.

static int type ( ) #

Returns the type identifier of ObjectMeshStatic.

Return value

ObjectMeshStatic type identifier.

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

Ptr<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. The forced loading to VRAM is performed in the main thread.

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.

ObjectMeshStatic::PROCEDURAL_MODE getMeshProceduralMode ( ) const#

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.

Return value

Current procedural mode of the mesh.

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#

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 ( Ptr<Mesh> & result ) const#

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

• Ptr<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 isMeshProceduralDone ( ) const#

Returns a value indicating if all asynchronous operations on the procedural mesh have completed.

Return value

true if no asynchronous geometry operation is active, otherwise false.

bool isMeshProceduralActive ( ) const#

Returns a value indicating if an asynchronous operation on the procedural mesh is currently in progress.

Return value

true if an asynchronous geometry operation is active, otherwise false.

bool isMeshProceduralDynamic ( ) const#

Returns a value indicating if the current procedural mode is PROCEDURAL_MODE_DYNAMIC.

Return value

true if PROCEDURAL_MODE_DYNAMIC is active, otherwise false.

bool applyCopyMeshProceduralForce ( const Ptr<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.

Arguments

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

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

• const Ptr<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 ( const Ptr<Mesh> & mesh_ram, const Ptr<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

• const Ptr<Mesh> & mesh_ram - Source mesh containing vertex data.
• const Ptr<MeshRender> & mesh_vram - Source mesh containing render data.

Return value

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

bool applyCopyMeshProceduralAsync ( const Ptr<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.

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

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

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

• const Ptr<Mesh> & mesh - Source mesh to copy vertex data from.
• int mesh_render_flags - Optional usage flags for MeshRender.

bool applyMoveMeshProceduralAsync ( const Ptr<Mesh> & mesh_ram, const Ptr<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

• const Ptr<Mesh> & mesh_ram - Source mesh containing vertex data.
• const Ptr<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 ( CallbackBase1<Ptr<Mesh>> * 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

• CallbackBase1<Ptr<Mesh>> * callback_generate - Callback function responsible for creating and filling the source mesh. Executed in the main thread.

  The function must be wrapped using MakeCallback() and have the following signature:

  void callback_generate(Ptr<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 ( CallbackBase1<Ptr<Mesh>> * callback_generate, CallbackBase * 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

• CallbackBase1<Ptr<Mesh>> * callback_generate - Callback function responsible for creating and filling the source mesh. Executed in the main thread.

  The function must be wrapped using MakeCallback() and have the following signature:

  void callback_generate(Ptr<Mesh> mesh)

• CallbackBase * callback_done - Optional callback executed after geometry has been fully applied.

  The function must be wrapped using MakeCallback() and have the following signature:

  void callback_done()

• int mesh_render_flags - Optional usage flags for MeshRender.

Return value

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

bool runGenerateMeshProceduralForce ( CallbackBase1<Ptr<Mesh>> * 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

• CallbackBase1<Ptr<Mesh>> * callback_generate - Callback function responsible for creating and filling the source mesh. Executed in the main thread.

  The function must be wrapped using MakeCallback() and have the following signature:

  void callback_generate(Ptr<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 ( CallbackBase1<Ptr<Mesh>> * callback_generate, CallbackBase * 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

• CallbackBase1<Ptr<Mesh>> * callback_generate - Callback function responsible for creating and filling the source mesh. Executed in the main thread.

  The function must be wrapped using MakeCallback() and have the following signature:

  void callback_generate(Ptr<Mesh> mesh)

• CallbackBase * callback_done - Optional callback executed after geometry has been fully applied.

  The function must be wrapped using MakeCallback() and have the following signature:

  void callback_done()

• int mesh_render_flags - Optional usage flags for MeshRender.

Return value

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