注意！这个版本的文档是过时的，因为它描述了一个较老的SDK版本！请切换到最新SDK版本的文档。

Unigine::NodeLayer Class

Header:	#include <UnigineNodes.h>
Inherits:	Node

A layer node is a zero-sized node that has no visual representation and enables to save all its child nodes into a separate .node file. Layer nodes should be used to split the world into several logical parts and save each of them in a .node file so that each layer and its child nodes can be edited without affecting the source .world file.

Notice

The layer node itself is not stored in the .node file.

Creating a Layer#

To create a layer node, perform as follows:

Create an instance of the NodeLayer class.
Release script ownership so that the node can be added to UnigineEditor.
Add the node to UnigineEditor (wherein, node ownership will be passed to the editor automatically).

You can also specify such settings as a name, transformation and so on.

Source code (C++)

#include <UnigineEditor.h>
#include <UnigineNodes.h>

using namespace Unigine;

int AppWorldLogic::init() {
	
	// create a layer node
	NodeLayerPtr layer = NodeLayer::create();
	// set a name
	layer->setName("LayerNode");

	return 1;
}

Editing a Layer#

Editing a layer node includes adding, deleting, modifying its child nodes. For example, you can add new nodes as follows:

Source code (C++)

// AppWorldLogic.cpp

#include <UnigineEditor.h>
#include <UnigineNodes.h>

using namespace Unigine;
using namespace Math;

int AppWorldLogic::init() {
	
	// create a layer node
	NodeLayerPtr layer = NodeLayer::create("unigine_project/nodes/layer_0.node");
	// set a name for the node
	layer->setName("layer_0");

	// create child nodes
	for (int y = -10; y <= 10; y++)
	{
		for (int x = -10; x <= 10; x++)
		{

			// create a mesh
			MeshPtr mesh = Mesh::create();
			mesh->addBoxSurface("box_0", vec3(1.0f));
			// create a node (e.g. an instance of the ObjectMeshDynamic class)
			ObjectMeshDynamicPtr node = ObjectMeshDynamic::create(mesh);
			// assign a material to the surfaces of the object
			for (int i = 0; i < node->getNumSurfaces(); i++)
			{
				node->setMaterial("mesh_base", i);
			}
			// set node transformation
			node->setWorldTransform(translate(Vec3(x * 2, y * 2, 0.0f)));
			// set a name for the node
			node->setName(String::format("mesh_%d_%d", x + 10, y + 10).get());
			// add the node as a child to the layer node
			layer->addWorldChild(node);
		}
	}

	return 1;
}

Saving a Layer#

Changes made in the child nodes of the layer node can be saved on the disk by saving the world. The nodes will be saved in the separate .node file specified for the layer, not in the .world file.

Source code (C++)

#include <UnigineConsole.h>
#include <UnigineEditor.h>
#include <UnigineString.h>

using namespace Unigine;
using namespace Math;

int AppWorldLogic::init() {
	
	// create a layer node
	NodeLayerPtr layer = NodeLayer::create("unigine_project/nodes/layer_0.node");
	// set a name for the node
	layer->setName("layer_0");

	// create child nodes
	for (int y = -10; y <= 10; y++)
	{
		for (int x = -10; x <= 10; x++)
		{

			// create a mesh
			MeshPtr mesh = Mesh::create();
			mesh->addBoxSurface("box_0", vec3(1.0f));
			// create a node (e.g. an instance of the ObjectMeshDynamic class)
			ObjectMeshDynamicPtr node = ObjectMeshDynamic::create(mesh);
			// assign a material to the surfaces of the object
			for (int i = 0; i < node->getNumSurfaces(); i++)
			{
				node->setMaterial("mesh_base", i);
			}
			// set node transformation
			node->setWorldTransform(translate(Vec3(x * 2, y * 2, 0.0f)));
			// set a name for the node
			node->setName(String::format("mesh_%d_%d", x + 10, y + 10).get());
			// add the node as a child to the layer node
			layer->addWorldChild(node);
		}
	}

	// save the world
	Console::run("world_save unigine_project");

	return 1;
}

Instead of saving the world, you can manually save child nodes of the layer into the .node file by using the World::saveNodes() function:

Source code (C++)

// declare array of nodes
Vector<NodePtr> nodes;
// append child nodes of the layer to the declared array
for (int i = 0; i < layer->getNumChildren(); i++) {
	nodes.append(layer->getChild(i));
}
// save nodes to the .node file
if (World::saveNodes(layer->getNodeName(), nodes) == 0) {
	Log::error("Layer hasn't been saved\n");
}

Name	Description View: Sort by:
*create*	Constructor.
setNodeName	Updates the name of the node layer: a path to a .node file where child nodes of the layer are stored.
getNodeName	Returns the name of the node layer: a path to a .node file where child nodes of the layer are stored.
type	Returns the type of the node.

NodeLayer Class

Members

static NodeLayerPtr create ( const char * name ) #

Constructor. Creates a node layer with specified file name to store it.

Arguments

const char * name - Name of the layer.

void setNodeName ( const char * name ) #

Updates the name of the node layer: a path to a .node file where child nodes of the layer are stored.

Arguments

const char * name - Path to a .node file.

const char * getNodeName ( ) #

Returns the name of the node layer: a path to a .node file where child nodes of the layer are stored.

Return value

Path to the .node file.

static int type ( ) #

Returns the type of the node.

Return value

NodeLayer type identifier.

Last update: 2020-11-24

Help improve this article

Report a problem related to this article

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

Unigine::NodeLayer Class

Creating a Layer#

Editing a Layer#

Saving a Layer#

See Also#

Methods:

NodeLayer Class

Members

static NodeLayerPtr create ( const char * name ) #

Arguments

void setNodeName ( const char * name ) #

Arguments

const char * getNodeName ( ) #

Return value

static int type ( ) #

Return value