DecalMesh Class

WarningUnigineScript is deprecated and will be removed in future releases. Please consider using C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt is not guaranteed, as the current level of support assumes only fixing critical issues.

Inherits:

Decal

This class describes how to create and modify mesh decals.

Creating a Mesh Decal#

The following code illustrates how to create a mesh decal, set its parameters and add the node to UnigineEditor.

Source code (UnigineScript)

#include <core/unigine.h>

int init() {
	
	DecalMesh decal_mesh;
	
	// create a mesh
	Mesh mesh = new Mesh();
	mesh.addBoxSurface("box_0", vec3(1.0f));

	// create a mesh decal using created mesh and setting its radius to 10, material to "decal_base"
	decal_mesh = new DecalMesh(mesh, 10.0f, "decal_base");

	// set the name and position of the decal
	decal_mesh.setName("Mesh Decal");
    decal_mesh.setWorldPosition(vec3(0.0f, 0.0f, 5.0f));

	return 1;
}

Methods:

Name	Description View: Sort by:
getMeshName	Returns a name of the mesh used as a base for the decal.
setRadius	Sets the new height of the decal projection box along the Z axis.
getRadius	Returns the current height of the decal projection box along the Z axis.
setMesh	Copies a given source mesh into the current decal mesh.
getMesh	Copies the current decal mesh into the received mesh.
setMeshName	Sets a new name for the mesh and forces loading of the mesh with the new name for the current decal mesh.
loadMesh	Loads a mesh for the current mesh from the file.
saveMesh	Saves the decal mesh into a file.
type	Returns a DecalMesh type identifier.
setMeshName

DecalMesh Class

Members

int setMesh ( Mesh mesh, int unique = 1 ) #

Copies a given source mesh into the current decal mesh.

Source code (UnigineScript)

// create an empty decal mesh
DecalMesh decalMesh = new DecalMesh(NULL,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

1 if the mesh is copied successfully; otherwise, 0.

int getMesh ( Mesh mesh ) #

Copies the current decal mesh into the received mesh. For example, you can obtain geometry of the decal mesh and then change it:

Source code (UnigineScript)

// 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)) {
	// do something with the obtained mesh
}
else {
	log.error("Failed to copy a mesh\n");
}

Arguments

Mesh mesh - Current mesh.

Return value

1 if the mesh is copied successfully; otherwise, 0.

void setMeshName ( string path, int force_load = 0 ) #

Sets a new name for the mesh and forces loading of the mesh with the new name for the current decal mesh.

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

Arguments

string path - 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 ( ) #

Returns a name of the mesh used as a base for the decal.

Return value

Name of the mesh.

void setRadius ( float radius ) #

Sets the new height of the decal projection box along the Z axis.

Arguments

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

float getRadius ( ) #

Returns the current height of the decal projection box along the Z axis.

Return value

The height of the decal projection box along the Z axis, in units.

void loadMesh ( string path, int unique = 0 ) #

Loads a mesh for the current mesh from the file. This function doesn't change the mesh name.

Arguments

string path - 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 path ) #

Saves the decal mesh into a file.

Arguments

string path - Mesh file name.

Return value

1 if the mesh is saved successfully; otherwise, 0.

static int type ( ) #

Returns a DecalMesh type identifier.

Return value

Type identifier.

void setMeshName ( string name ) #

Arguments

string name

Last update: 2020-04-10

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

DecalMesh Class

See Also#

Creating a Mesh Decal#

Methods:

DecalMesh Class

Members

int setMesh ( Mesh mesh, int unique = 1 ) #

Arguments

Return value

int getMesh ( Mesh mesh ) #

Arguments

Return value

void setMeshName ( string path, int force_load = 0 ) #

Arguments

string getMeshName ( ) #

Return value

void setRadius ( float radius ) #

Arguments

float getRadius ( ) #

Return value

void loadMesh ( string path, int unique = 0 ) #

Arguments

int saveMesh ( string path ) #

Arguments

Return value

static int type ( ) #

Return value

void setMeshName ( string name ) #

Arguments