Unigine.ObjectMeshStatic Class

ObjectMeshStatic Class

Enums

LIGHTMAP_QUALITY#

LIGHTMAP_MODE#

SURFACE_CUSTOM_TEXTURE_MODE#

Properties

string MeshName#

Members

ObjectMeshStatic ( Mesh mesh ) #

Arguments

• Mesh mesh - A mesh smart pointer.

ObjectMeshStatic ( string path, bool unique = 0 ) #

Arguments

• string path - Path to the mesh file.
• 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 true (1), so a copy of the mesh geometry will be created and changes won't be applied.

void SetCIndex ( int num, int index, int surface ) #

Arguments

• int num - Vertex number in the range from 0 to the total number of coordinate indices for the given surface.
  Notice

  To get the total number of coordinate indices for the given surface, use the getNumCIndices() method.
• int index - Coordinate index to be set in the range from 0 to the total number of coordinate vertices for the given surface.
  Notice

  To get the total number of coordinate vertices for the given surface, use the getNumVertex() method.
• int surface - Mesh surface number.

int GetCIndex ( int num, int surface ) #

Arguments

• int num - Vertex number in the range from 0 to the total number of coordinate indices for the given surface.
  Notice

  To get the total number of coordinate indices for the given surface, use the getNumCIndices() method.
• int surface - Mesh surface number.

Return value

void SetColor ( int num, vec4 color, int surface ) #

Arguments

• int num - Triangle vertex number in the range from 0 to the total number of vertex color entries of the given surface.
  Notice

  To get the total number of vertex color entries for the surface, call the getNumColors() method.
• vec4 color - Vertex color to be set.
• int surface - Mesh surface number.

vec4 GetColor ( int num, int surface ) #

Arguments

• int num - Triangle vertex number in the range from 0 to the total number of vertex color entries of the given surface.
  Notice

  To get the total number of vertex color entries for the surface, call the getNumColors() method.
• int surface - Mesh surface number.

Return value

bool GetMesh ( Mesh mesh ) #

// a static mesh from which geometry will be obtained
ObjectMeshStatic staticMesh = new ObjectMeshStatic("box.mesh");
// create a new mesh
Mesh mesh = new Mesh();
// copy geometry to the created mesh
if (staticMesh.getMesh(mesh) == 1) {
	// do something with the obtained mesh
}
else {
	Log.Error("Failed to copy a mesh\n");
}

Arguments

• Mesh mesh - Destination mesh.

Return value

bool SetMesh ( Mesh mesh, bool unique = true ) #

// create ObjectMeshStatic instances 
ObjectMeshStatic staticMesh = new ObjectMeshStatic("box.mesh");
ObjectMeshStatic staticMesh_2 = new ObjectMeshStatic("capsule.mesh");

// create a Mesh instance
Mesh firstMesh = new Mesh();

// get the mesh of the ObjectMeshStatic and copy it to the Mesh class instance
staticMesh.getMesh(firstMesh);

// put the firstMesh mesh to the staticMesh_2 instance
staticMesh_2.setMesh(firstMesh);

Arguments

• Mesh mesh - Source mesh to be copied.
• bool unique - Unique flag used when you create several objects out of a single Mesh instance :
  • false (0) - An instance of source mesh geometry is created. If the source geometry is changed at runtime, its instances will be changed as well.
  • true (1) - A copy of source mesh geometry is created and changes made to the source geometry do not affect the mesh.

Return value

void SetMeshNameForce ( string path ) #

Arguments

• string path - Path to the mesh file.

int GetMeshSurface ( Mesh mesh, int surface, int target = -1 ) #

Arguments

• Mesh mesh - Destination mesh to copy the surface into.
• int surface - Number of the mesh surface to be copied.
• int target - Number of the surface target to be copied. The default value is -1 (all targets).

Return value

vec3 GetNormal ( int num, int surface, int target = 0 ) #

Arguments

• int num - Triangle vertex number in the range from 0 to the total number of vertex tangent entries of the given surface target.
  Notice

  Vertex normals are calculated using vertex tangents. To get the total number of vertex tangent entries for the surface target, call the getNumTangents() method.
• int surface - Mesh surface number.
• int target - Surface target number. The default value is 0.

Return value

int GetNumCIndices ( int surface ) #

Arguments

• int surface - Mesh surface number.

Return value

int GetNumColors ( int surface ) #

Arguments

• int surface - Surface number.

Return value

int GetNumSurfaceTargets ( int surface ) #

Arguments

• int surface - Mesh surface number.

Return value

int GetNumTangents ( int surface ) #

Arguments

• int surface - Mesh surface number.

Return value

void SetNumTexCoords0 ( int num, int surface ) #

Arguments

• int num - Number of the first UV map texture coordinates to be set.
• int surface - Mesh surface number.

int GetNumTexCoords0 ( int surface ) #

Arguments

• int surface - Mesh surface number.

Return value

void SetNumTexCoords1 ( int num, int surface ) #

Arguments

• int num - Number of the second UV map texture coordinates to be set.
• int surface - Mesh surface number.

int GetNumTexCoords1 ( int surface ) #

Arguments

• int surface - Mesh surface number.

Return value

int GetNumTIndices ( int surface ) #

Arguments

• int surface - Mesh surface number.

Return value

int GetNumVertex ( int surface ) #

Arguments

• int surface - Mesh surface number.

Return value

string GetSurfaceTargetName ( int surface, int target ) #

Arguments

• int surface - Mesh surface number.
• int target - Number of the surface target.

Return value

void SetSurfaceTransform ( mat4 transform, int surface, int target = -1 ) #

Arguments

• mat4 transform - Transformation matrix.
• int surface - Mesh surface number.
• int target - Number of the surface target. The default value is -1 (all targets).

void SetTangent ( int num, quat tangent, int surface, int target = 0 ) #

Arguments

• int num - Triangle vertex number in the range from 0 to the total number of vertex tangent entries of the given surface.
  Notice

  To get the total number of vertex tangent entries for the surface, call the getNumTangents() method.
• quat tangent - Tangent to be set.
• int surface - Mesh surface number.
• int target - Surface target number. The default value is 0.

quat GetTangent ( int num, int surface, int target = 0 ) #

Arguments

• int num - Triangle vertex number in the range from 0 to the total number of vertex tangent entries of the given surface.
  Notice

  To get the total number of vertex tangent entries for the surface, call the getNumTangents() method.
• int surface - Mesh surface number.
• int target - Surface target number. The default value is 0.

Return value

void SetTexCoord0 ( int num, vec2 texcoord, int surface ) #

Arguments

• int num - Triangle vertex number in the range from 0 to the total number of first UV map texture coordinate entries of the given surface.
  Notice

  To get the total number of first UV map texture coordinate entries for the surface, call the getNumTexCoords0() method.
• vec2 texcoord - First UV map texture coordinates to be set.
• int surface - Mesh surface number.

vec2 GetTexCoord0 ( int num, int surface ) #

Arguments

• int num - Triangle vertex number in the range from 0 to the total number of first UV map texture coordinate entries of the given surface.
  Notice

  To get the total number of first UV map texture coordinate entries for the surface, call the getNumTexCoords0() method.
• int surface - Mesh surface number.

Return value

void SetTexCoord1 ( int num, vec2 texcoord, int surface ) #

Arguments

• int num - Triangle vertex number in the range from 0 to the total number of second UV map texture coordinate entries of the given surface.
  Notice

  To get the total number of second UV map texture coordinate entries for the surface, call the getNumTexCoords1() method.
• vec2 texcoord - Second UV map texture coordinates to be set.
• int surface - Mesh surface number.

vec2 GetTexCoord1 ( int num, int surface ) #

Arguments

• int num - Triangle vertex number in the range from 0 to the total number of second UV map texture coordinate entries of the given surface.
  Notice

  To get the total number of second UV map texture coordinate entries for the surface, call the getNumTexCoords1() method.
• int surface - Mesh surface number.

Return value

void SetTIndex ( int num, int index, int surface ) #

Arguments

• int num - Vertex number in the range from 0 to the total number of triangle indices for the given surface.
• int index - Triangle index to be set in the range from 0 to the total number of triangle vertices for the given surface.
• int surface - Mesh surface number.

int GetTIndex ( int num, int surface ) #

Arguments

• int num - Vertex number in the range from 0 to the total number of triangle indices for the given surface.
• int surface - Mesh surface number.

Return value

void SetVertex ( int num, vec3 vertex, int surface, int target = 0 ) #

Arguments

• int num - Coordinate vertex number in the range from 0 to the total number of coordinate vertices for the given surface.
  Notice

  To get the total number of coordinate vertices for the given surface, use the getNumCVertex() method.
• vec3 vertex - Vertex coordinates to be set.
• int surface - Mesh surface number.
• int target - Surface target number. The default value is 0.

vec3 GetVertex ( int num, int surface, int target = 0 ) #

Arguments

• int num - Coordinate vertex number in the range from 0 to the total number of coordinate vertices for the given surface.
  Notice

  To get the total number of coordinate vertices for the given surface, use the getNumCVertex() method.
• int surface - Mesh surface number.
• int target - Surface target number. The default value is 0.

Return value

int AddEmptySurface ( string name, int num_vertex, int num_indices ) #

Arguments

• string name - The name of the new surface.
• int num_vertex - Number of the new surface vertices.
• int num_indices - Number of the new surface indices.

Return value

int AddMeshSurface ( int dest_surface, ObjectMeshStatic mesh, int surface, int target = -1 ) #

Arguments

• int dest_surface - Number of the surface to copy the mesh to.
• ObjectMeshStatic mesh - Source ObjectMeshStatic to copy a surface from.
• int surface - Mesh surface number to copy.
• int target - Mesh target number to copy. The default value is -1 (all targets).

Return value

int AddMeshSurface ( string name, Mesh mesh, int surface, int target = -1 ) #

Arguments

• string name - Name of the new surface of the current mesh.
• Mesh mesh - Mesh pointer to copy a surface from.
• int surface - Mesh surface number to copy.
• int target - Mesh target number to copy. The default value is -1 (all targets).

Return value

int AddMeshSurface ( string name, ObjectMeshStatic mesh, int surface, int target = -1 ) #

Arguments

• string name - Name of the new surface of the current mesh.
• ObjectMeshStatic mesh - Mesh pointer to copy a surface from.
• int surface - Mesh surface number to copy.
• int target - Mesh target number to copy. The default value is -1 (all targets).

Return value

int AddSurfaceTarget ( int surface, string name = 0 ) #

Arguments

• int surface - The number of the surface, to which the target will be appended.
• string name - The name of the new target.

Return value

bool CreateMesh ( string path, bool unique = 0 ) #

Arguments

• string path - Path to the mesh file.
• bool unique - Unique flag used when you create several objects out of a single .mesh file :
  • false (0) - An instance of source mesh geometry is created. If the source geometry is changed at runtime, its instances will be changed as well.
  • true (1) - A copy of source mesh geometry is created and changes made to the source geometry do not affect the mesh.

Return value

int FindSurfaceTarget ( string name, int surface ) #

Arguments

• string name - The name of the target.
• int surface - Mesh surface number.

Return value

void FlushMesh ( ) #

bool LoadMesh ( string path ) #

Arguments

• string path - Path to the .mesh file.

Return value

bool SaveMesh ( string path ) #

// setting mesh name from the desired path
UGUID guid = FileSystem.get().getGUID(path);
object_mesh_static.setMeshName(guid.getFileSystemString());

// saving the mesh to the desired path
object_mesh_static.saveMesh(path);

Arguments

• string path - Path to the file, to which the mesh is to be saved.

Return value

static int type ( ) #

Return value

void UpdateSurfaceBounds ( int surface = -1 ) #

Arguments

• int surface - Surface number (use -1 for all surfaces).

MeshStatic GetMeshStatic ( ) #

Return value

bool IsFlushed ( ) #

Return value

void SetLightmapEnabled ( bool enabled, int surface ) #