Unigine.DecalMesh Class

This class describes how to create and modify mesh decals.

DecalMesh Class

Members

static DecalMesh(Mesh mesh, float radius, string name)

Arguments

• Mesh mesh - Pointer to Mesh.
• float radius - The height of the decal projection box along the Z axis, in units.
• string name - Material name.

static DecalMesh(string mesh_name, float radius, string name)

Arguments

• string mesh_name - Mesh name.
  Notice

  The mesh should contain a single surface. In case if the mesh contains several surfaces, only the one with the 0 index will be used. Thus, the area of the decal will differ from the initial mesh.
• float radius - The height of the decal projection box along the Z axis, in units.
• string name - Material name

DecalMesh cast(Node node)

Arguments

• Node node - Node instance.

Return value

DecalMesh cast(Decal base)

Arguments

• Decal base - Decal instance.

Return value

int setMesh(Mesh mesh, int unique = 1)

// create an empty decal mesh
DecalMesh decalMesh = new DecalMesh("",8.0f,"decal_base_0");
// create a mesh
Mesh mesh = new Mesh("decal.mesh");
// copy the mesh into the decal mesh
decalMesh.setMesh(mesh);

Arguments

• Mesh mesh - Mesh to be set.
  Notice

  The mesh should contain a single surface. In case if the mesh contains several surfaces, only the one with the 0 index will be used. Thus, the area of the decal will differ from the initial mesh.
• int unique - Unique flag used when you create several objects out of a single Mesh instance:
  • 0 - An instance of source mesh geometry is created. If the source geometry is changed at runtime, its instances will be changed as well.
  • 1 - A copy of source mesh geometry is created and changes made to the source geometry do not affect the mesh.

Return value

int getMesh(Mesh mesh)

// a decal mesh from which geometry will be obtained
DecalMesh decalMesh = new DecalMesh("decal.mesh",8.0f,"decal_base_0");
// create a new mesh
Mesh mesh = new Mesh();
// copy geometry to the created mesh
if (decalMesh.getMesh(mesh) == 1) {
	// do something with the obtained mesh
}
else {
	Log.error("Failed to copy a mesh\n");
}

Arguments

• Mesh mesh - Current mesh.

Return value

void setMeshName(string name, int force_load = 0)

Arguments

• string name - A new name to be set for the mesh.
• int force_load - Force flag.
  • If 1 is specified, the mesh with the new name will be loaded immediately with the unique flag set to 0.
  • If 0 is specified, only the mesh name will be updated.

string getMeshName()

Return value

void setRadius(float radius)

Arguments

• float radius - The height of the decal projection box along the Z axis, in units.

float getRadius()

Return value

void loadMesh(string name, int unique = 0)

Arguments

• string name - The name of the mesh file.
  Notice

  The mesh should contain a single surface. In case if the mesh contains several surfaces, only the one with the 0 index will be used. Thus, the area of the decal will differ from the initial mesh.
• int unique - Unique flag used when you create several objects out of a single .mesh file:
  • 0 - An instance of source mesh geometry is created. If the source geometry is changed at runtime, its instances will be changed as well.
  • 1 - A copy of source mesh geometry is created and changes made to the source geometry do not affect the mesh.

int saveMesh(string name)

Arguments

• string name - Mesh file name.

Return value

int type()

Return value