Создание 2D-маршрутов в пределах навигационной зоны с препятствиями
The example guides you through the process of setting up a scene with a simple navigation area and calculating a 2D route within it.В этом примере вы познакомитесь с процессом создания сцены с простой навигационной областью и расчета 2D-маршрута внутри нее.
Preparing SceneПодготовка сцены#
Before calculating routes, we should create a navigation area within which this logic will be executed. Our navigation area will be represented by a single navigation sector with obstacles. Also, we will add some auxiliary nodes that will serve as the start and destination points of the route.Прежде чем рассчитывать маршрут, мы должны создать область навигации, в пределах которой будет выполняться эта логика. Наша область навигации будет представлена одним навигационным сектором с препятствиями. Также мы добавим несколько вспомогательных нод, которые будут служить начальной и конечной точками маршрута.
- Create an empty project via SDK Browser.Создайте пустой проект с помощью SDK Browser.
- Open it in UnigineEditor and remove the unnecessary default nodes.Откройте его в UnigineEditor и удалите ненужные ноды.
-
In the Menu bar, choose Create -> Navigation -> Navigation Sector and place the node above the plane.В строке меню выберите Create -> Navigation -> Navigation Sector и поместите ноду над плоскостью.
To facilitate working with the navigation sectors, activate gizmos for Navigation nodes in the Helpers Panel.Чтобы упростить работу с навигационными секторами, включите gizmo для нод Navigation в панели Helpers. -
Adjust the Size of the sector in the Parameters window.Настройте значение Size для сектора в окне Parameters.
-
Add 2 nodes that will be used as the start and destination points of the route. We will create 2 boxes (Create -> Primitives -> Box), rename them start and finish, and place inside the navigation sector as pictured below.Добавьте 2 ноды, которые будут использоваться в качестве начальной и конечной точек маршрута. Мы создадим 2 кубика (Create -> Primitives -> Box), переименуем их в start и finish и разместим внутри навигационного сектора, как показано на рисунке ниже.
-
Create several primitives and place them inside the navigation area. We will add a capsule and two boxes.Создайте несколько примитивов и разместите их в области навигации. Мы добавим капсулу и два кубика.
-
Make them dynamic: switch from Immovable to Dynamic in the Parameters window.Сделайте их динамическими: переключите настройку с Immovable на Dynamic в окне Parameters.
-
For each primitive, create an obstacle of the required type: in the World Hierarchy window, right-click the primitive, choose Create -> Navigation, and select the obstacle. The created obstacle will be added as a child to the primitive node in the hierarchy.Для каждого примитива создайте препятствие требуемого типа: в окне World Hierarchy щелкните правой кнопкой мыши на примитив, выберите Create -> Navigation и выберите препятствие. Созданное препятствие будет добавлено как дочернее к ноде примитива в иерархии.
It will allow you to change the node and obstacle transformations at the same time without any extra configuration.Это позволит вам изменять трансформации нод и препятствий одновременно без какой-либо дополнительной настройки. -
Adjust the size of the created obstacles in the Parameters window if necessary.При необходимости отрегулируйте размер создаваемых препятствий в окне Parameters.
Creating Component for Route CalculationСоздание компонента для расчета маршрута#
The created navigation sector only provides 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-маршрута:
- Create the components folder in the data directory of your project: right-click in the Asset Browser and select Create Folder.Создайте папку components в каталоге data вашего проекта: щелкните правой кнопкой мыши в браузере ассетов и выберите Create Folder.
-
In the created folder, create a new component: right-click and select Create Code -> C# Component and specify a name for the component.В созданной папке создайте новый компонент: щелкните правой кнопкой мыши и выберите Create Code -> C# Component и укажите имя компонента.
- Open the component in IDE to implement pathfinding logic.Откройте компонент в IDE, чтобы реализовать логику поиска пути.
Implementing Component LogicРеализация логики компонента#
-
Declare component parameters:Объявим параметры компонентов:
- Two parameters that will accept nodes between which a route should be calculatedДва параметра, которые будут принимать ноды, между которыми должен быть рассчитан маршрут.
- Route colorЦвет маршрута.
public class Route2D : Component { // a node that will serve as a start point public Node startPoint = null; // a node that will serve as a destination point public Node finishPoint = null; // route color [ParameterColor] public vec4 routeColor = vec4.ZERO; // ... }
-
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() создадим маршрут и зададим радиус и высоту точки, которая будет перемещаться по маршруту. Перед созданием проверьте, указаны ли ноды, которые будут использоваться в качестве начальной и конечной точек.
// a route private PathRoute route = null; private void Init() { // check if the start and destination nodes are correctly specified via the component interface if (startPoint && finishPoint) { // create a new route route = new PathRoute(); // set a radius and height for the point which will move along the route route.Radius = 0.1f; route.Height = 0.1f; } }
-
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():
// enable the onscreen console messages to display info on route calculation Unigine.Console.Onscreen = true; // enable visualization of the calculated route Visualizer.Enabled = true;
-
In the Update() function, calculate the route from the start to destination node:В функции Update() вычислите маршрут от начальной ноды до конечной:
private void Update() { // check if the start and destination nodes are correctly specified via the component interface if (startPoint && finishPoint) { // calculate the path from the start to destination point // a destination point of the route is reached route.Create2D(startPoint.WorldPosition, finishPoint.WorldPosition); if (route.IsReached) { // if the destination point is reached, render the root in a specified color route.RenderVisualizer(routeColor); } else Log.Message($"{node.Name} 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() в качестве третьего аргумента. -
Implement the Shutdown() function to disable the visualizer and onscreen console messages:Реализуйте функцию Shutdown(), чтобы отключить визуализатор и сообщения на экране консоли:
private void Shutdown() { Unigine.Console.Onscreen = false; Visualizer.Enabled = false; }
Here is the full code of the component:Вот полный код компонента:
Route2D.cs
using System.Collections;
using System.Collections.Generic;
using Unigine;
[Component(PropertyGuid = "AUTOGENERATED_GUID")] // <-- this line is generated automatically for a new component
public class Route2D : Component
{
// a node that will serve as a start point
public Node startPoint = null;
// a node that will serve as a destination point
public Node finishPoint = null;
// route color
[ParameterColor]
public vec4 routeColor = vec4.ZERO;
// a route
private PathRoute route = null;
private void Init()
{
// check if the start and destination nodes are correctly specified via the component interface
if (startPoint && finishPoint)
{
// create a new route
route = new PathRoute();
// set a radius and height for the point which will move along the route
route.Radius = 0.1f;
route.Height = 0.1f;
// enable the onscreen console messages to display info on route calculation
Unigine.Console.Onscreen = true;
// enable visualization of the calculated route
Visualizer.Enabled = true;
}
}
private void Update()
{
// check if the start and destination nodes are correctly specified via the component interface
if (startPoint && finishPoint)
{
// calculate the path from the start to destination point
// a destination point of the route is reached
route.Create2D(startPoint.WorldPosition, finishPoint.WorldPosition);
if (route.IsReached)
{
// if the destination point is reached, render the root in a specified color
route.RenderVisualizer(routeColor);
}
else
Log.Message($"{node.Name} PathRoute not reached yet\n");
}
}
private void Shutdown()
{
Unigine.Console.Onscreen = false;
Visualizer.Enabled = false;
}
}
Assigning ComponentНазначение компонента#
When the component logic is implemented, you should assign it to a node.Когда логика компонента реализована, вы должны назначить ее на ноду.
- In UnigineEditor, select Create -> Node -> Dummy and place it in the navigation area.В UnigineEditor создайте ноду Create -> Node -> Dummy и поместите ее в область навигации.
- Select the dummy node and assign the Route2D.cs component to it in the Parameters window.Выберите эту ноду и назначьте на нее компонент Route2D.cs в окне Parameters.
-
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.
- Change the Route Color, if necessary.При необходимости измените значение Route Color.
Making Obstacles Move DynamicallyСоздание динамических препятствий#
Let's add a bit of complexity to the logic and make the nodes that are used as obstacles dynamically change.Давайте немного усложним логику и заставим ноды, которые используются в качестве препятствий, динамически изменяться.
- In the components folder, create the NodeRotator component.В папке components создайте компонент NodeRotator.
-
Implement rotation logic:Реализуйте логику вращения:
public class NodeRotator : Component { // parameter that sets an angular velocity of the node public vec3 angularVelocity = vec3.ZERO; private void Update() { // calculate the delta of rotation vec3 delta = angularVelocity * Game.IFps; // update node rotation node.SetRotation(node.GetRotation() * new quat(delta.x, delta.y, delta.z)); } }
-
Assign the component to the capsule primitive that should rotate and specify the Angular Velocity:Назначьте компоненту примитив capsule, который должен вращаться, и укажите Angular Velocity:
The obstacle will rotate as well.Препятствие также будет вращаться.
-
Group the sphere primitives and assign the component to the parent dummy node. It will make the spheres rotate around this parent node (as in the case of a sphere, rotation around its own axis won't affect the route calculation).Объедините в группу примитивы sphere и назначьте компонент родительской Node Dummy. Это заставит сферы вращаться вокруг этой родительской ноды (как и в случае сферы, вращение вокруг собственной оси не повлияет на расчет маршрута).
Visualizing Navigation AreaВизуализация области навигации#
To clearly show how the path is built inside the navigation area, let's implement the AreaVisualizer component that enables displaying the navigation area gizmo at run time:Чтобы наглядно показать, как строится путь внутри области навигации, давайте реализуем компонент AreaVisualizer, который позволяет отображать gizmo области навигации во время выполнения:
- In the components folder, create the AreaVisualizer component.В папке components создайте компонент AreaVisualizer.
-
Implement the logic:Реализуйте логику:
public class AreaVisualizer : Component { private NavigationSector navigationSector = null; private void Init() { // get the navigation sector to which the component is assigned navigationSector = node as NavigationSector; // enable rendering of the visualizer if (navigationSector) Visualizer.Enabled = true; } private void Update() { // display the navigation area gizmo if (navigationSector) navigationSector.RenderVisualizer(); } private void Shutdown() { // disable rendering of the visualizer Visualizer.Enabled = false; } }
- Assign the component to the navigation sector.Назначьте в компоненте навигационный сектор.
Trying OutПроверка#
Click Run to run the component logic and check the result.Нажмите Run, чтобы запустить логику компонента и проверить результат.