Unigine.ObjectGuiMesh Class
| Inherits: | Object |
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.
ObjectGuiMesh Class
Members
static ObjectGuiMesh(Mesh mesh, string name = 0)
ObjectGuiMesh constructor. Creates a new GUI mesh from a given file.Arguments
- Mesh mesh - A mesh smart pointer.
- string name - A name of a new GUI mesh.
static ObjectGuiMesh(string mesh_name, string name = 0, int unique = 0)
An ObjectGuiMesh constructor. The ObjectGuiMesh will be created on the basis of the specified mesh.Arguments
- string mesh_name - Path to the mesh file.
- string name - Name of the new GUI mesh.
- int 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.
NoticeThis argument is available only if the first argument is string.
ObjectGuiMesh cast(Object base)
Casts an ObjectGuiMesh out of the Object instance.Arguments
- Object base - Object instance.
Return value
ObjectGuiMesh instance.ObjectGuiMesh cast(Node node)
Casts an ObjectGuiMesh out of the Node instance.Arguments
- Node node - Node instance.
Return value
ObjectGuiMesh instance.void setControlDistance(float distance)
Sets a distance at which the GUI becomes controllable.Arguments
- float distance - New distance in units. If a negative value is provided, 0 will be used instead.
float getControlDistance()
Returns the distance at which the GUI becomes controllable.Return value
The distance in units.Gui getGui()
Returns a Gui instance associated with the object.Return value
Gui smart pointer.int setMesh(Mesh mesh)
Copies the source mesh into the current mesh.Source code (C#)
// 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
1 if the mesh is copied successfully; otherwise, 0.int getMesh(Mesh mesh)
Copies the current mesh into the source mesh passed as an argument. For example, you can obtain geometry of the gui mesh and then change it:Source code (C#)
// 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
1 if the mesh is copied successfully; otherwise, 0.void setMeshName(string name)
Sets a new mesh name.Arguments
- string name - Name to be set for the mesh.
string getMeshName()
Returns the mesh name.Return value
Mesh name.void setMouse(Vec3 p0, Vec3 p1, int mouse_button, int mouse_show)
Sets mouse cursor position in the virtual control mode.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 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()
Returns the current mouse mode.Return value
Mouse mode. One of the MOUSE_* variables.void setMouseShow(int show)
Sets a value indicating if the mouse cursor should be rendered in the mesh GUI object.Arguments
- int show - Positive number to render the mouse cursor; otherwise, 0.
int getMouseShow()
Returns a value indicating if the mouse cursor is rendered in the mesh GUI object.Return value
1 if the cursor is rendered; otherwise, 0.int getScreenHeight()
Returns the screen height of the mesh GUI object.Return value
The 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()
Returns the screen width of the mesh GUI object.Return value
The width in pixels.int createMesh(string name, int unique = 0)
Creates a mesh.Arguments
- string name - Path to the *.mesh file.
- int unique - Dynamic flag:
- 0 - If the mesh vertices are changed in run-time, meshes loaded from the same file will be also changed.
- 1 - If the mesh vertices are changed in run-time, meshes loaded from the same file won't be changed
Return value
1 if the mesh is created successfully; otherwise, 0.void flushMesh()
Flushes the mesh geometry into the video memory.int loadMesh(string name)
Loads a mesh file.Arguments
- string name - The path to the .mesh file.
Return value
1 if the mesh is loaded successfully; otherwise, 0.int saveMesh(string name)
Saves the mesh into a file.Arguments
- string name - The path to the file.
Return value
1 if the mesh is saved successfully; otherwise, 0.static int type()
Returns the type of ObjectMeshStatic.Return value
ObjectMeshStatic type identifier.int
Description
Virtual mouse control mode.int
Description
Standard mouse control mode.Last update: 2018-08-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)