Создание маршрутов в пределах связанных навигационных секторов

The created navigation sectors only provide the area within which routes are calculated. The routes themselves must be created from the code. So, let's create the corresponding C++ component for 2D route calculation.Созданные навигационные сектора предоставляют только область, в пределах которой рассчитываются маршруты. Сами маршруты должны быть созданы из кода. Итак, давайте создадим соответствующий компонент C++ для расчета 2D-маршрута.

Примечание

If you have completed the previous guide on creating routes within a simple navigation sector, you can skip this step and copy the implemented Route2D component to the source folder of your project (both the *.h and *.cpp files).Если вы следовали инструкциям предыдущего руководства по созданию маршрутов в рамках простого навигационного сектора, вы можете пропустить этот шаг и скопировать реализованный компонент Route2D в папку source вашего проекта (оба файла *.h и *.cpp).

Add a new Route2D class inherited from the ComponentBase class (the *.h and *.cpp files) to the project. The class name will be used as the property name.Добавьте в проект новый класс Route2D, унаследованный от класса ComponentBase (файлы *.h и *.cpp). Имя класса будет использоваться в качестве имени свойства.

Примечание

If you have copied the Route2D component on the previous step, you can skip this one.Если вы скопировали компонент Route2D на предыдущем шаге, вы можете пропустить этот шаг.

1. In the Route2D.h file, declare a component class, parameters, and a route:В файле Route2D.h объявите класс компонента, параметры и маршрут:

   • Two parameters that will accept nodes between which a route should be calculated.два параметра, которые будут принимать ноды, между которыми должен быть рассчитан маршрут;
   • Route color.цвет маршрута.
   Исходный код (C++)

   #include <UnigineComponentSystem.h>
   #include <UniginePathFinding.h>
   
   using namespace Unigine;
   using namespace Math;
   
   // derive the component from the ComponentBase class
   class Route2D : public ComponentBase
   {
   public:
   
   	// declare constructor and destructor and define a property name. The Route2D.prop file containing all parameters listed below will be saved in your project's data folder
   	COMPONENT_DEFINE(Route2D, ComponentBase);
   	// declare methods to be called at the corresponding stages of the execution sequence
   	COMPONENT_INIT(init);
   	COMPONENT_UPDATE(update);
   	COMPONENT_SHUTDOWN(shutdown);
   
   	// declare parameters of the component
   	PROP_PARAM(Node, startPoint, NULL);
   	PROP_PARAM(Node, finishPoint, NULL);
   	PROP_PARAM(Color, routeColor, vec4_zero);
   
   	void init();
   	void update();
   	void shutdown();
   
   private:
   	// declare a route
   	PathRoutePtr route;
   };

2. In the Route2D.cpp file, register the component.В файле Route2D.cpp зарегистрируйте компонент.

   Исходный код (C++)

   #include "Route2D.h"
   
   REGISTER_COMPONENT(Route2D);

3. Create a route and set the radius and height for the point which will move along the route in the init() method. Before creation, check if the nodes to be used as the start and finish points are specified.В методе Init() создайте маршрут и задайте радиус и высоту, необходимые для перемещения точки по маршруту. Перед созданием проверьте, указаны ли ноды, которые будут использоваться в качестве начальной и конечной точек.

   Исходный код (C++)

   #include "Route2D.h"
   #include <UnigineNode.h>
   #include <UnigineConsole.h>
   #include <UnigineVisualizer.h>
   #include <UnigineLog.h>
   
   REGISTER_COMPONENT(Route2D);
   
   void Route2D::init() {
   	// check if the start and destination nodes are correctly specified via the component interface
   	if (startPoint && finishPoint)
   	{
   		// create a new route
   		route = PathRoute::create();
   
   		// set a radius and height for the point which will move along the route
   		route->setRadius(0.1f);
   		route->setHeight(0.1f);
   	}
   }

4. To enable displaying the calculated route at run time, turn on the Visualizer. Additionally, you can output console messages to the application screen. Add the following logic to the init() function:Чтобы включить отображение рассчитанного маршрута во время выполнения, включите функцию Visualizer. Кроме того, вы можете выводить сообщения консоли на экран приложения. Добавьте следующую логику в функцию init():

   Исходный код (C++)

   Console::setOnscreen(true);
   Visualizer::setEnabled(true);

5. In the update() function, calculate the route from the start to destination node:В функции update() вычислите маршрут от начальной до конечной ноды:

   Исходный код (C++)

   void Route2D::update() {
   
   	if (startPoint && finishPoint)
   	{
   		route->create2D(startPoint->getWorldPosition(), finishPoint->getWorldPosition());
   		if (route->isReached())
   		{
   			// if the destination point is reached, render the root in a specified color
   			route->renderVisualizer(routeColor);
   		}
   		else
   			Log::message("PathRoute not reached yet\n");
   	}
   }

   Примечание

   Here the route is recalculated each frame. However, it is not optimal for application performance. Instead, you can calculate the route once per several frames: pass a delay to the create2D() function as the third argument.Здесь маршрут пересчитывается для каждого кадра. Однако это не оптимально для производительности приложения. Вместо этого вы можете рассчитать маршрут один раз для нескольких кадров: передайте задержку функции Create2D() в качестве третьего аргумента.

6. Implement the shutdown() function to disable the visualizer and onscreen console messages:Реализуйте функцию shutdown(), чтобы отключить визуализатор и сообщения на экране консоли:

   Исходный код (C++)

   void Route2D::shutdown() {
   
   	Console::setOnscreen(false);
   	Visualizer::setEnabled(false);
   
   }

7. The component is registered automatically by the Component System upon its initialization. However, you should add the following to the AppSystemLogic::init() method:Компонент регистрируется системой компонентов автоматически при его инициализации. Однако в метод AppSystemLogic::init() следует добавить следующее:

   Исходный код (C++)

   #include <UnigineComponentSystem.h>
   
   int AppSystemLogic::init()
   {
   	// initialize ComponentSystem and register components
   	Unigine::ComponentSystem::get()->initialize();
   
   	return 1;
   }

8. Build the project and run it once to generate the property for the Route2D component. It will be located in the data/ComponentSystem folder.Создайте проект и запустите его один раз, чтобы сгенерировать свойство для компонента Route2D. Оно будет находиться в папке data/ComponentSystem.

Here is the full code of the component:Вот полный код компонента:

#pragma once

#include <UnigineComponentSystem.h>
#include <UniginePathFinding.h>

using namespace Unigine;
using namespace Math;

// derive the component from the ComponentBase class
class Route2D : public ComponentBase
{
public:

	// declare constructor and destructor and define a property name. The Route2D.prop file containing all parameters listed below will be saved in your project's data folder
	COMPONENT_DEFINE(Route2D, ComponentBase);
	// declare methods to be called at the corresponding stages of the execution sequence
	COMPONENT_INIT(init);
	COMPONENT_UPDATE(update);
	COMPONENT_SHUTDOWN(shutdown);

	// declare parameters of the component
	PROP_PARAM(Node, startPoint, NULL);
	PROP_PARAM(Node, finishPoint, NULL);
	PROP_PARAM(Color, routeColor, vec4_zero);

	void init();
	void update();
	void shutdown();

private:
	// a route
	PathRoutePtr route;
};

#include "Route2D.h"
#include <UnigineNode.h>
#include <UnigineConsole.h>
#include <UnigineVisualizer.h>
#include <UnigineLog.h>

REGISTER_COMPONENT(Route2D);

void Route2D::init() {
	// check if the start and destination nodes are correctly specified via the component interface
	if (startPoint && finishPoint)
	{
		// create a new route
		route = PathRoute::create();

		// set a radius and height for the point which will move along the route
		route->setRadius(0.1f);
		route->setHeight(0.1f);

		Console::setOnscreen(true);
		Visualizer::setEnabled(true);
	}
}

void Route2D::update() {

	if (startPoint && finishPoint)
	{
		route->create2D(startPoint->getWorldPosition(), finishPoint->getWorldPosition());
		if (route->isReached())
		{
			// if the destination point is reached, render the root in a specified color
			route->renderVisualizer(routeColor);
		}
		else
			Log::message("PathRoute not reached yet\n");
	}
}

void Route2D::shutdown() {
	
	Console::setOnscreen(false);
	Visualizer::setEnabled(false);
}

When the component logic is implemented and the property is generated, you should assign it to a node.Когда логика компонента реализована и свойство сгенерировано, вы должны назначить его на ноду.

1. In UnigineEditor, select Create -> Node -> Dummy and place it in the navigation area.В UnigineEditor выберите ноду Create -> Node -> Dummy и поместите ее в область навигации.
2. Select the dummy node and assign the Route2D property to it in the Parameters window.Выберите эту ноду и назначьте на нее свойство Route2D в окне Parameters.

3. In the component parameters, specify the start and finish static meshes in the Start Point and Finish Point fields.В параметрах компонента укажите статические меши start и finish в полях Start Point и Finish Point.

   

4. Change the Route Color, if necessary.При необходимости измените значение Route Color.

1. Add a new AreaVisualizer class inherited from the ComponentBase class (the *.h and *.cpp files) to the project.Добавьте в проект новый класс AreaVisualizer, унаследованный от класса ComponentBase (файлы *.h и *.cpp).

2. Implement the logic:Реализуйте логику:

   Исходный код (C++)

   #pragma once
   #include <UnigineComponentSystem.h>
   #include <UniginePathFinding.h>
   
   using namespace Unigine;
   
   class AreaVisualizer : public ComponentBase
   {
   public:
   	COMPONENT_DEFINE(AreaVisualizer, ComponentBase);
   	COMPONENT_UPDATE(update);
   
   	void update();
   };

   Исходный код (C++)

   #include "AreaVisualizer.h"
   
   #include <UnigineVisualizer.h>
   
   REGISTER_COMPONENT(AreaVisualizer);
   
   void AreaVisualizer::update()
   {
   	// display the navigation area gizmo
   	node->renderVisualizer();
   }

3. Build the project and run it once again to generate the property for the AreaVisualizer component.Создайте проект и запустите его еще раз, чтобы сгенерировать свойство для компонента AreaVisualizer.
4. Assign the component to each navigation sector forming the navigation area.Назначьте компонент на каждый навигационный сектор, образующий область навигации.

Launch the application to check the result.Запустите приложение, чтобы проверить результат.

You can force the Route2D component to calculate a 3D route within the same navigation area by changing a single line of the code. Replace the create2D() function call with the following:Вы можете заставить компонент Route2D рассчитать трехмерный маршрут в пределах той же области навигации, изменив одну строку кода. Замените вызов функции create2D() следующим:

route->create3D(startPoint->getWorldPosition(), finishPoint->getWorldPosition());

Then build the project and run it once again to re-generate the property for the Route2D component.Затем создайте проект и запустите его еще раз, чтобы повторно сгенерировать свойство для компонента Route2D.