Unigine::ObjectGuiMesh Class

This class allows for rendering GUI onto an arbitrary mesh. Unlike ObjectGui, it can be used to create non-flat displays positioned in the world. If the mesh contains several surfaces, the same GUI will be rendered on each of them. Note that the GUI will be rendered according to the UV mapping of surfaces.

Методы:

Имя	Описание View: Sort by:
*ObjectGuiMeshPtr create* has overloads	An ObjectGuiMesh constructor.
setControlDistance	Sets a distance at which the GUI becomes controllable.
getControlDistance	Returns the distance at which the GUI becomes controllable.
getGui	Returns a Gui instance associated with the object.
setMeshPath	Sets a new path to the source mesh for the Gui Mesh object.
getMeshPath	Returns the path to the source .
setMouseMode	Sets mouse mode.
getMouseMode	Returns the current mouse mode.
setMouseShow	Sets a value indicating if the mouse cursor should be rendered in the mesh GUI object.
isMouseShow	Returns a value indicating if the mouse cursor is rendered in the mesh GUI object.
setBackground	Sets a value indicating if the GUI background (black screen) should be rendered.
isBackground	Returns a value indicating if GUI background (black screen) is rendered.
getScreenHeight	Returns the screen height of the mesh GUI object.
getScreenWidth	Returns the screen width of the mesh GUI object.
getMeshProceduralMode
isMeshNull	Returns a value indicating if the source mesh used for the object is null (does not exist, unassigned, not loaded, etc.
isMeshLoadedRAM	Returns a value indicating if the source mesh used for the object is loaded to memory (RAM).
isMeshLoadedVRAM	Returns a value indicating if the source mesh used for the object is loaded to video memory (VRAM).
setMouse	Sets mouse cursor position in the virtual control mode.
setScreenSize	Sets screen dimensions of the mesh GUI object.
type	Returns the type identifier of ObjectMeshStatic.
getMeshCurrentRAM	Returns the current source mesh used for the object and loaded to memory (RAM).
getMeshCurrentVRAM	Returns the current render mesh used for the object and loaded to video memory (VRAM).
getMeshForceRAM	Returns the source mesh used for the object and loads it to memory (RAM) immediately.
getMeshForceVRAM	Returns the render mesh used for the object and loads it to video memory (VRAM) immediately.
getMeshAsyncRAM	Returns the source mesh used for the object and loads it to memory (RAM) asynchronously.
getMeshAsyncVRAM	Returns the render mesh used for the object and loads it to video memory (VRAM) asynchronously.
getMeshDynamicRAM	Returns the procedural source mesh used for the object and loads it to memory (RAM) using the specific streaming mode for procedural meshes.
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.
loadAsyncVRAM	Asynchronously loads the mesh to video memory (VRAM) if the async streaming mode for meshes is enabled.
loadAsyncRAM	Asynchronously loads the mesh to memory (RAM) if the async streaming mode for meshes is enabled.
loadForceVRAM	Performs force-loading of the mesh to video memory (VRAM) immediately.
loadForceRAM	Performs force-loading of the mesh to memory (RAM) immediately.
setMeshProceduralMode
createCopyMeshRAM
getCopyMeshRAM
isMeshProceduralDone
isMeshProceduralActive
isMeshProceduralDynamic
applyCopyMeshProceduralForce
applyMoveMeshProceduralForce has overloads
applyCopyMeshProceduralAsync
applyMoveMeshProceduralAsync has overloads
deleteDynamicMesh
runGenerateMeshProceduralAsync has overloads
runGenerateMeshProceduralForce has overloads

Variables:

Name	Description
MOUSE_STANDARD = 0	Standard mouse control mode.
MOUSE_VIRTUAL = 1	Virtual mouse control mode.

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.

NoticeThe mesh should contain a single surface. In case if the mesh contains several surfaces, only the one with the 0 index will be used.

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

Notice

Loading to VRAM must be performed in the main thread only.

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

Notice

Loading to VRAM must be performed in the main thread only.

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

Notice

Loading to VRAM must be performed in the main thread only.

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.

Notice

Loading to VRAM must be performed in the main thread only.

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

_{The information on this page is valid for UNIGINE 2.20 SDK.}

Last update: 20.06.2025

Помогите сделать статью лучше

Была ли эта статья полезной?

Сообщить о проблеме в этой статье

(или выберите слово/фразу и нажмите Ctrl+Enter

Header:	#include <UnigineObjects.h>
Inherits from:	Object

Unigine::ObjectGuiMesh Class

In This Article:

See Also#

Методы:

Variables:

ObjectGuiMesh Class

Members

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

Arguments

static ObjectGuiMeshPtr create ( ) #

void setControlDistance ( float distance ) #

Arguments

float getControlDistance ( ) const#

Return value

Ptr<Gui> getGui ( ) const#

Return value

void setMeshPath ( const char * path ) #

Arguments

const char * getMeshPath ( ) const#

Return value

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

Arguments

void setMouseMode ( int mode ) #

Arguments

int getMouseMode ( ) const#

Return value

void setMouseShow ( bool show ) #

Arguments

bool isMouseShow ( ) const#

Return value

void setBackground ( bool background ) #

Arguments

bool isBackground ( ) const#

Return value

int getScreenHeight ( ) const#

Return value

void setScreenSize ( int width, int height ) #

Arguments

int getScreenWidth ( ) const#

Return value

static int type ( ) #

Return value

Ptr<ConstMesh> getMeshCurrentRAM ( ) const#

Return value

Ptr<MeshRender> getMeshCurrentVRAM ( ) #

Return value

Ptr<ConstMesh> getMeshForceRAM ( ) #

Return value

Ptr<MeshRender> getMeshForceVRAM ( ) #

Return value

Ptr<ConstMesh> getMeshAsyncRAM ( ) #

Return value

Ptr<MeshRender> getMeshAsyncVRAM ( ) #

Return value

Ptr<Mesh> getMeshDynamicRAM ( ) #

Return value

Ptr<MeshRender> getMeshDynamicVRAM ( ) #

Return value

bool loadAsyncVRAM ( ) #

Return value

bool loadAsyncRAM ( ) #

Return value

bool loadForceVRAM ( ) #

Return value

bool loadForceRAM ( ) #

Return value

void setMeshProceduralMode ( ObjectMeshStatic::PROCEDURAL_MODE mode, int mesh_render_flags = 0 ) #

Arguments

ObjectMeshStatic::PROCEDURAL_MODE getMeshProceduralMode ( ) const#

bool isMeshNull ( ) const#

Return value

bool isMeshLoadedRAM ( ) const#

Return value

bool isMeshLoadedVRAM ( ) const#

Return value

Ptr<Mesh> createCopyMeshRAM ( ) const#

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

Arguments

bool isMeshProceduralDone ( ) const#

bool isMeshProceduralActive ( ) const#