Unigine::DecalMesh Class

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 (C++)

// AppWorldLogic.h

#include <UnigineLogic.h>
#include <UnigineObjects.h>
#include <UnigineEditor.h>
#include <UnigineDecals.h>

class AppWorldLogic : public Unigine::WorldLogic {
	
public:
	AppWorldLogic();
	virtual ~AppWorldLogic();
	
	virtual int init();
	
	virtual int update();
	virtual int postUpdate();
	virtual int updatePhysics();
	
	virtual int shutdown();
	
	virtual int save(const Unigine::StreamPtr &stream);
	virtual int restore(const Unigine::StreamPtr &stream);

private:
	Unigine::DecalMeshPtr decal_mesh;
};

Source code (C++)

// AppWorldLogic.cpp

#include "AppWorldLogic.h";

using namespace Unigine;

int AppWorldLogic::init()
{
	// create a mesh with a surface (e.g. a box primitive)
	MeshPtr mesh = Mesh::create();
	mesh->addBoxSurface("box_0", Math::vec3(1.0f));

	// create a mesh decal using created mesh and setting its radius to 10, material to "decal_base_0"
	decal_mesh = DecalMesh::create();
	decal_mesh->setMesh(mesh);
	decal_mesh->setRadius(10.0f);
	decal_mesh->setMaterialPath("decal_base_0.mat");

	// set the name and position of the decal
	decal_mesh->setName("Mesh Decal");
	decal_mesh->setWorldPosition(Math::Vec3(0.0f, 0.0f, 5.0f));

	return 1;
}

Methods:

Name	Description View: Sort by:
*create*	Constructor.
setMeshPath	Sets a new path to the source mesh for the current decal mesh.
getMeshPath	Returns the path to the source .
setMeshProceduralMode	Sets a value indicating if the base mesh used for the object is procedural.
isMeshProceduralMode	Returns a value indicating if the base mesh used for the object is procedural.
isMeshNull	Returns a value indicating if the base mesh used for the object is null (does not exist, unassigned, not loaded, etc.
isMeshLoadedRAM	Returns a value indicating if the base mesh used for the object is loaded to memory (RAM).
isMeshLoadedVRAM	Returns a value indicating if the base mesh used for the object is loaded to video memory (VRAM).
type	Returns a DecalMesh type identifier.
getMeshInfo	Returns the base mesh that stores data on mesh bounds, surfaces, their number, names, and bounds, but doesn't contain any geometry.
getMeshForce	Returns the base mesh used for the object.
getMeshAsync	Returns the base mesh used for the object asynchronously.
getMeshForceVRAM	Returns the base mesh used for the object and loads it to video memory (VRAM).
getMeshAsyncVRAM	Returns the base mesh used for the object asynchronously and loads it to video memory (VRAM).
loadAsyncVRAM	Asynchronously loads the mesh to video memory (VRAM) if the async streaming mode for meshes is enabled.
loadAsyncRAM	Asynchronously loads the mesh to memory (RAM) if the async streaming mode for meshes is enabled.
loadForceVRAM	Performs force-loading of the mesh to video memory (VRAM) immediately.
loadForceRAM	Performs force-loading of the mesh to memory (RAM) immediately.
asyncCalculateNodes	Asynchronously calculates the mesh surface internal spatial tree used for quick calculation of collisions and intersections.
asyncCalculateEdges	Asynchronously calculates the edges of the mesh surface geometry.
applyMeshProcedural	Sets the specified mesh as the source mesh for the object.
getStatDrawCalls	Returns the number of draw calls (DIP) for the decal during the last frame.
getStatDrawCountViewport	Returns the number of times the decal was drawn in the viewport last frame.
getStatDrawCountReflection	Returns the number of times the decal was drawn during reflections rendering in the last frame.
getStatDrawCountShadow	Returns the number of times the decal was drawn during shadows rendering in the last frame.
getStatFrame	Returns the number of Engine frame, in which the decal was drawn last time.

DecalMesh Class

Members

static DecalMeshPtr create ( ) #

Constructor. Creates a new Mesh Decal.

static DecalMeshPtr create ( const char * path ) #

DecalMesh constructor. Creates a Mesh Decal with a base mesh loaded from the specified file.

Arguments

const char * path - Path to the base mesh file.

void setMeshPath ( const char * path ) #

Sets a new path to the source mesh for the current decal mesh. If the mesh is in the procedural mode, it will be reset.

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

const char * path - New path to the source .mesh-file to be set.

const char * getMeshPath ( ) const#

Returns the path to the source .mesh-file currently used as a base for the decal.

Return value

Path to the source .mesh-file.

static int type ( ) #

Returns a DecalMesh type identifier.

Return value

Type identifier.

Ptr<MeshStatic> getMeshInfo ( ) #

Returns the base mesh that stores data on mesh bounds, surfaces, their number, names, and bounds, but doesn't contain any geometry.

Notice

It's highly recommended NOT to edit the returned mesh.