Unigine::DecalMesh Class

This class describes how to create and modify mesh decals.

DecalMesh Class

Members

---

static DecalMeshPtr create(const Ptr<Mesh> & mesh, float radius, const char * name)

Constructor. Creates a new mesh decal with the given properties.

Arguments

• const Ptr<Mesh> & mesh - Pointer to Mesh.
• float radius - The height of the decal projection box along the Z axis, in units.
• const char * name - Material name.

static DecalMeshPtr create(const char * mesh_name, float radius, const char * name)

Constructor. Creates a new mesh decal with the given properties.

Arguments

• const char * mesh_name - Mesh name.
• float radius - The height of the decal projection box along the Z axis, in units.
• const char * name - Material name

Ptr<DecalMesh> cast(const Ptr<Node> & node)

Casts a mesh decal out of the Node instance.

Arguments

• const Ptr<Node> & node - Node smart pointer.

Return value

Pointer to the DecalMesh.

Ptr<DecalMesh> cast(const Ptr<Decal> & base)

Casts a DecalMesh out of the Decal instance.

Arguments

• const Ptr<Decal> & base - Decal smart pointer.

Return value

Pointer to the DecalMesh.

int setMesh(const Ptr<Mesh> & mesh, int unique = 1)

Copies a given source mesh into the current decal mesh.

Arguments

• const Ptr<Mesh> & mesh - The mesh smart pointer.
• 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.

Return value

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

int getMesh(const Ptr<Mesh> & mesh)

Copies the current decal mesh into the received mesh.

Arguments

• const Ptr<Mesh> & mesh - The mesh smart pointer.

Return value

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

void setMeshName(const char * name, 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.

Arguments

• const char * 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.

const char * getMeshName()

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

Return value

The mesh name.

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(const char * name, int unique = 0)

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

Arguments

• const char * name - The name of the mesh file.
• 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.

int saveMesh(const char * name)

Saves the decal mesh into a file.

Arguments

• const char * name - A name of the mesh file.

Return value

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

int type()

Returns a DecalMesh type identifier.

Return value

Type identifier.