ObjectGuiMesh Class

ObjectGuiMesh Class

Members

---

static ObjectGuiMesh(variable v, string name = 0, int unique = 0)

An ObjectGuiMesh constructor. The ObjectGuiMesh will be created on the basis of the specified mesh.

Arguments

• variable v - A 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 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.

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

Distance in units.

Gui getGui()

Returns a Gui instance associated with the object. This function is used when assigning a widget to the GUI mesh.

Return value

GUI associated with the object.

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.

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.

void setMeshName(string name)

Sets the new name for the mesh.

Arguments

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

string getMeshName()

Returns the name of the mesh.

Return value

Name of the mesh.

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

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

Width in pixels.

int createMesh(string name, int unique = 0)

Creates the GUI mesh with the specified parameters.

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