This page has been translated automatically.
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1
注意! 这个版本的文档是过时的,因为它描述了一个较老的SDK版本!请切换到最新SDK版本的文档。
注意! 这个版本的文档描述了一个不再受支持的旧SDK版本!请升级到最新的SDK版本。

Navigation Class

This class contains functions that enable to get or change parameters of a navigation area within which pathfinding is performed. The navigation area can be either a navigation sector or a navigation mesh.

For example, by using the functions of this class, you can scale velocity of the point moving inside the navigation area. Or you can change the danger factor of the area.

See Also

  • Articles of the Navigation Area section
  • a set of samples located in the data/samples/paths folder

Navigation Class

This class inherits from Node

Members


float getDangerous ()

Returns the current danger factor that indicates if the point that moves inside the navigation area should try to avoid this area.
Notice
If the danger factor exceeds the maximum danger factor set for the route, the navigation area will be excluded from pathfinding calculations.

Return value

The danger factor.

int getNavigationMask ()

Returns the current navigation mask of the navigation area. The navigation mask of the navigation area must match the navigation mask of the route that is calculated within it. Otherwise, the area will not participate in pathfinding.

Return value

An integer value, each bit of which is used to set a mask.

Navigation getNavigation (int num)

Returns the specified connected navigation area.

Arguments

  • int num - The navigation area number.

Return value

The navigation area.

int getNumNavigations ()

Returns the number of navigation areas that intersect the current one.

Return value

The number of connected navigation areas.

Examples

The following example prints the number of navigation sectors that intersect the given one:

Source code (UnigineScript)
NavigationSector sector_0;

int i = engine.editor.findNode("sector_0");
sector_0 = node_cast(engine.editor.getNode(i));

log.message("sector_0 getNumNavigations() = %i",sector_0.getNumNavigations());

int getQuality ()

Returns the quality of optimization of the route that has already been calculated. The quality value specifies the number of iterations that are used for taking the short cut.

Return value

The quality value.

float getVelocity ()

Returns the current scaling factor for velocity of the point that moves inside the navigation area along the calculated route.

Return value

The velocity scaling factor.

int inside2D (vec3 point, float radius)

Depending on the type of the navigation area, the function performs the following:
  • For navigation sectors, it checks whether the given point is inside the navigation sector. The height of the navigation sector (Z coordinate) is ignored.
  • For navigation meshes, it checks whether the given point is inside the navigation mesh and the distance from the point to the mesh is in range [-height;height]. Here height is a height of the navigation mesh.

Arguments

  • vec3 point - Point coordinates.
  • float radius - The radius of the point. The radius is used to exclude exceeding the navigation mesh by the point. If the radius is set, it is more likely that the point will be inside the navigation mesh.
    Notice
    When calling the function for NavigationSector, this option is irrelevant.

Return value

1 if the point is inside the navigation area; otherwise, 0.

int inside3D (vec3 point, float radius)

Depending on the type of the navigation area, the function performs the following:
  • For navigation sectors, it checks whether the given point is inside the navigation area. Notice that the height of the navigation sector (Z coordinate) is also taken into account.
  • For navigation meshes, it checks whether the given point is inside the navigation mesh and the distance from the point to the mesh is in range [0;height]. Here height is a height of the navigation mesh.

Arguments

  • vec3 point - Point coordinates.
  • float radius - The radius of the point. The radius is used to exclude exceeding the navigation mesh by the point. If the radius is set, it is more likely that the point will be inside the navigation mesh.
    Notice
    When calling the function for NavigationSector, this option is irrelevant.

Return value

1 it the point is inside the navigation area; otherwise, 0.

void setDangerous (float dangerous)

Sets the danger factor that indicates if the point that moves inside the navigation area should try to avoid this area.
Notice
If the danger factor exceeds the maximum danger factor set for the route, the navigation area will be excluded from pathfinding calculations.

Arguments

  • float dangerous - Danger factor.

void setNavigationMask (int mask)

Sets a navigation mask for the navigation area. The navigation mask of the navigation area must match the navigation mask of the route that is calculated within it. Otherwise, the area will not participate in pathfinding. By using the navigation mask, you can specify navigation ares that must be ignored during pathfinding.

Arguments

  • int mask - An integer value, each bit of which is used to set a mask.

void setQuality (int q)

Sets a quality of optimization of the route that has already been calculated. This value specifies the number of iterations that are used for taking the short cut. However, the higher the value, the longer the route calculation will take.

Arguments

  • int q - A quality value. If a negative value is provided, 0 will be used instead.

void setVelocity (float velocity)

Sets a scaling factor for velocity of the point that moves inside the navigation area along the calculated route.

Arguments

  • float velocity - A velocity scaling factor.
Last update: 2017-07-03
Build: ()