Unigine::ObjectGuiMesh Class

ObjectGuiMesh Class

Members

static ObjectGuiMeshPtr create ( const Ptr<Mesh> & mesh, const char * path = 0 ) #

Arguments

• const Ptr<Mesh> & mesh - Source Mesh to be used.
• const char * path - A name of a new GUI mesh.

ObjectGuiMesh ( const char * mesh_name, const char * path = 0, bool unique = false ) #

Arguments

• const char * mesh_name - Path to the .mesh file.
• const char * 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.

void setControlDistance ( float distance ) #

Arguments

• float distance - A new distance in units.

float getControlDistance ( ) const#

Return value

Ptr<Gui> getGui ( ) const#

Return value

int setMesh ( const Ptr<Mesh> & mesh ) #

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

// create a Mesh instance
MeshPtr firstMesh = Mesh::create();

// 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

• const Ptr<Mesh> & mesh - Pointer to the source mesh that must be copied.

Return value

int getMesh ( const Ptr<Mesh> & mesh ) const#

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

Arguments

• const Ptr<Mesh> & mesh - Pointer to the source mesh.

Return value

void setMeshName ( const char * name ) #

Arguments

• const char * name - Name to be set for the mesh.

const char * getMeshName ( ) const#

Return value

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

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_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 setMouseMode ( int mode ) #

Arguments

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

int getMouseMode ( ) const#

Return value

void setMouseShow ( bool show ) #

Arguments

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

bool isMouseShow ( ) const#

Return value

void setBackground ( bool background ) #

Arguments

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

bool isBackground ( ) const#

Return value

int getScreenHeight ( ) const#

Return value

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

Return value

int createMesh ( const char * path, bool unique = 0 ) #

Arguments

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

Arguments

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

Return value

int saveMesh ( const char * path ) #

Arguments

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

Return value

static int type ( ) #

Return value