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:

• gui_01

See Also

ObjectGuiMesh Class

Members

ObjectGuiMesh (variable v, string name = 0, int dynamic = 0)

Arguments

• variable v - Variable of one of the following types:
  • Mesh mesh - The source mesh.
  • string name - The path to the .mesh file.
• string name - Name of the new GUI mesh.
• 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.
  Notice

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

int createMesh (string name, int dynamic = 0)

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

void flushMesh ()

float getControlDistance ()

Return value

Gui getGui ()

Return value

Examples

To get the GUI and assign a widget to it, you can use the following:

// create an instance of the ObjectGuiMesh class
ObjectGuiMesh object_gui_mesh = add_editor(new ObjectGuiMesh("samples/objects/meshes/gui_01.mesh"));
// get a GUI associated with the GUI mesh
Gui gui = object_gui_mesh.getGui();
// create a widget to be assigned
WidgetSpriteVideo sprite_video = new WidgetSpriteVideo(gui,"samples/objects/videos/sanctuary.ogv");
// add a new widget to the GUI mesh
gui.addChild(sprite_video,GUI_ALIGN_EXPAND);
						

// get the editor node named "ObjectGuiMesh_0" and cast it to ObjectGuiMesh
ObjectGuiMesh object_gui_mesh = class_cast("ObjectGuiMesh",engine.editor.getNodeByName("ObjectGuiMesh_0"));
						

string getMeshName ()

Return value

int getMesh (Mesh mesh)

Arguments

• Mesh mesh - Source mesh.

Return value

int getMouseShow ()

Return value

int getScreenHeight ()

Return value

int getScreenWidth ()

Return value

int loadMesh (string name)

Arguments

• string name - The path to the .mesh file.

Return value

int saveMesh (string name)

Arguments

• string name - The path to the file.

Return value

void setControlDistance (float distance)

Arguments

• float distance - New distance in units. If a negative value is provided, 0 will be used instead.

void setMeshName (string name)

Arguments

• string name - Name to be set for the mesh.

int setMesh (Mesh mesh)

Arguments

• Mesh mesh - The source mesh to be copied.

Return value

void setMouseShow (int show)

Arguments

• int show - Positive number to render the 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.