Unigine.ObjectGuiMesh Class

ObjectGuiMesh Class

Properties

int ScreenHeight#

int ScreenWidth#

float ControlDistance#

int MouseMode#

bool MouseShow#

bool Background#

string MeshName#

Gui Gui#

Members

ObjectGuiMesh ( Mesh mesh, string path = 0 ) #

Arguments

• Mesh mesh - Source Mesh to be used.
• string path - A name of a new GUI mesh.

ObjectGuiMesh ( string mesh_name, string path = 0, bool unique = false ) #

Arguments

• string mesh_name - Path to the .mesh file.
• string path - Name of the new GUI mesh.
• bool unique - When you create several objects out of a single .mesh file, the instance of the mesh geometry is created. If you then change the source geometry, its instances will be changed as well. To avoid this, set the unique flag to 1, so a copy of the mesh geometry will be created and changes won't be applied.
  Notice

  This argument is available only if the first argument is string.

int SetMesh ( Mesh mesh ) #

// create ObjectGuiMesh instances 
ObjectGuiMesh guiMesh = new ObjectGuiMesh("gui.mesh");
ObjectGuiMesh guiMesh_2 = new ObjectGuiMesh("gui_2.mesh");

// create a Mesh instance
Mesh firstMesh = new Mesh();

// get the mesh of the ObjectGuiMesh and copy it to the Mesh class instance
guiMesh.getMesh(firstMesh);

// put the firstMesh mesh to the guiMesh_2 instance
guiMesh_2.setMesh(firstMesh);

Arguments

• Mesh mesh - The source mesh to be copied.

Return value

int GetMesh ( Mesh mesh ) #

// a gui mesh from which geometry will be obtained
ObjectGuiMesh guiMesh = new ObjectGuiMesh("gui.mesh");
// create a new mesh
Mesh mesh = new Mesh();
// copy geometry to the created mesh
if (guiMesh.getMesh(mesh) == 1) {
	// do something with the obtained mesh
}
else {
	Log.Error("Failed to copy a mesh\n");
}

Arguments

• Mesh mesh - Source mesh.

Return value

void SetMouse ( vec3 p0, vec3 p1, int mouse_button, int mouse_show ) #

Arguments

• 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.
• 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_button - Mouse button status. Set 1 to indicate that the button is clicked; otherwise, 0.
• int mouse_show - Mouse cursor status. Set 1 to show mouse cursor; otherwise, 0.

void SetScreenSize ( int width, int height ) #

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 CreateMesh ( string path, bool unique = 0 ) #

Arguments

• string path - Path to the *.mesh file.
• bool unique - Dynamic flag:
  • false - If the mesh vertices are changed in run-time, meshes loaded from the same file will be also changed.
  • true - If the mesh vertices are changed in run-time, meshes loaded from the same file won't be changed

Return value

void FlushMesh ( ) #

int LoadMesh ( string path ) #

Arguments

• string path - Path to the .mesh file.

Return value

int SaveMesh ( string path ) #

Arguments

• string path - Path to the .mesh file.

Return value

static int type ( ) #

Return value