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.
The following samples demonstrate the ObjectGuiMesh class usage:
ObjectGuiMesh Class
Members
ObjectGuiMesh (string mesh_name, string name = 0, int dynamic = 0)
Arguments
- string mesh_name
- string name
- int dynamic
Gui getGui ()
Returns a Gui instance associated with the object. This function is used when assigning a widget to the GUI mesh.Notice
When you create an instance of the ObjectGuiMesh class, it is automatically associated with a Gui instance.
Return value
GUI associated with the object.int getScreenWidth ()
Returns the screen width of the mesh GUI object.Return value
Width in pixels.int createMesh (string name, int dynamic = 0)
Creates the GUI mesh with the specified parameters.Arguments
- string name - Path to the *.mesh file.
- int dynamic - 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.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 loadMesh (string name)
Loads a new mesh instead of the current mesh from the .mesh file. This function doesn't change the mesh name.Arguments
- string name - The path to the .mesh file.
Return value
1 if the mesh is loaded successfully; otherwise, 0.int setMesh (Mesh mesh)
Copies the source mesh into the current mesh.Arguments
- Mesh mesh - The source mesh to be copied.
Return value
1 if the mesh is copied successfully; otherwise, 0.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.
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.
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.
void flushMesh ()
Flushes the mesh geometry into the video memory.string getMeshName ()
Returns the name of the mesh.Return value
Name of the mesh.void setMeshName (string name)
Sets the new name for the mesh.Arguments
- string name - Name to be set for the mesh.
int saveMesh (string name)
Saves the mesh into the .mesh format.Arguments
- string name - The path to the file.
Return value
1 if the mesh is saved successfully; otherwise, 0.float getControlDistance ()
Returns the distance, at which the GUI becomes controllable.Return value
Distance in units.int getScreenHeight ()
Returns the screen height of the mesh GUI object.Return value
Height in pixels.int getMesh (Mesh mesh)
Copies the current mesh into the source mesh.Arguments
- Mesh mesh - Source mesh.
Return value
1 if the mesh is copied successfully.Last update: 2017-07-03
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)