Unigine.PathRoute Class
This class calculates the shortest 2D or 3D route around the obstacles within connected navigation areas and sets the size and velocity of the point moving along this route.
- In case of 2D route, a point moves in the lower plane of the navigation area. The Z coordinate is not taken into account when calculating the 2D route. The height and radius values set for the point via the setHeight() and setRadius() functions are used to check whether the navigation area can take part in pathfinding: if the height or radius set for the point is greater than the size of the navigation area, such navigation area will be discarded. If the height difference between the connected areas exceeds the maximum height, the navigation area is also discarded from calculations.
- In case of 3D route (available only for navigation sectors), a point moves in 3 dimensions. The radius set for the point via the setRadius() function is used to check whether the navigation sector can take part in pathfinding: if the radius set for the point is greater than the size of the navigation sector, it will be discarded. Also the point cannot rise up higher than the maximum height set for the navigation sector.
Functions of the PathRoute class enable to ignore the specified navigation areas and obstacles. Also the maximum time acceptable to get to the destination point and the maximum danger factor can be limited as well.
Notice
To choose between navigation areas, A* algorithm is used.
Warning
- There is no connection between functions of the PathRoute class and functions of the Path class.
- 3D navigation feature is experimental and not recommended for production use.
See Also#
- The Creating Routes usage example demonstrating how to create routes and recalculate them considering obstacles
- A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/paths/ folder
PathRoute Class
Properties
float Velocity#
The current velocity of the point moving along the route.
set
Sets the velocity of the point that moves along the route.
set value -
Velocity of the point that moves along the route.
float Radius#
The current radius that is required to move the point along the route inside the navigation area.
set
Sets the radius that is required to move the point along the route inside the navigation area. If the specified radius exceeds the size of the navigation area, the point will not move inside it.
set value -
Radius that is required to move the point inside the navigation area. If a negative value is provided, 0 will be used instead.
int ObstacleMask#
The current obstacle mask. the obstacle is taken into account if its obstacle mask matches the obstacle mask of the route.
set
Sets the obstacle mask. The obstacle is taken into account if its obstacle mask matches the obstacle mask of the route.
set value -
An integer value, each bit of which is used to set a mask.
int NumPoints#
The number of turning points along the route.
int NavigationMask#
The current navigation mask. 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.
set
Sets the navigation mask. 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.
set value -
An integer value, each bit of which is used to set a mask.
float MaxTime#
The current maximum time for reaching the destination point. if the route takes longer, the point will not move along it.
set
Sets the maximum time for reaching the destination point. If the route takes longer, the point will not move along it.
set value -
Maximum movement time.
float MaxHeight#
The current maximum height difference between the connected navigation areas acceptable when finding the 2d route. in case of the 3d route, it is the maximum height the point can move up to.
set
Sets the maximum height difference between the connected navigation areas acceptable when finding the 2D route. In case of the 3D route, it is the maximum height the point can move up to.
set value -
Maximum height.
float MaxDangerous#
The maximum danger factor acceptable for moving along this route. if the navigation areas have a higher danger factor, the point will not move along it.
set
Sets the maximum danger factor acceptable for moving along this route. If the navigation areas have a higher danger factor, the point will not move along it.
set value -
Maximum danger factor.
float MaxAngle#
Cosine of the maximum possible angle between navigation mesh polygons. for example, this option enables to exclude walls when calculating a valid route.
set
Sets cosine of the maximum possible angle between navigation mesh polygons. For example, this option enables to exclude walls when calculating a valid route.
set value -
Maximum angle cosine.
float Height#
The current height that is required to move the point along the 2d route inside the navigation area.
set
Sets the height that is required to move the point along the 2D route inside the navigation area. If the specified height exceeds the height of the navigation area, the point will not move inside it.
set value -
Height that is required to move the point inside the navigation area. If a negative value is provided, 0 will be used instead.
bool IsReady#
A value indicating that a route is calculated.
bool IsReached#
A value indicating that a destination point of the route is reached.
bool IsQueued#
A value indicating that a route is queued to be calculated.
float Time#
The time that is required for the point to move along the route.
float Distance#
The length of the route.
float Dangerous#
The highest danger factor of the navigation areas met along the route.
Members
static PathRoute ( float radius = 0.0f ) #
Constructor. Creates a new 2D or 3D route. The radius is used to check whether the point can move inside a navigation area or this navigation area should be excluded from pathfinding.Arguments
- float radius - Radius of the point moving along the route.
void SetExcludeNavigations ( Node[] exclude_navigations ) #
Sets the list of navigation sectors and navigation meshes to be ignored during pathfinding.Arguments
- Node[] exclude_navigations - Array of the ignored navigation areas.
Node[] GetExcludeNavigations ( ) #
Returns the list of navigation sectors and navigation meshes excluded from pathfinding.Arguments
Return value
Container to store the result.void SetExcludeObstacles ( Node[] obstacles ) #
Sets the list of obstacles to be ignored during pathfinding.Arguments
- Node[] obstacles - Array of the ignored obstacles.
Node[] GetExcludeObstacles ( ) #
Returns the list of obstacles ignored during pathfinding.Return value
Container for obstacles.Obstacle GetIntersection ( PathRouteIntersection intersection ) #
Returns the first intersected obstacle.Arguments
- PathRouteIntersection intersection - PathRouteIntersection node.
Return value
Intersected obstacle.Navigation GetNavigation ( int num ) #
Returns the navigation sector or mesh within which the specified route point is located.Arguments
- int num - Point number.
Return value
Navigation sector or navigation mesh.Obstacle GetObstacle ( int num ) #
Returns the obstacle around which the route is turning.Arguments
- int num - Point number.
Return value
Obstacle.vec3 GetPoint ( int num ) #
Returns the coordinates of the turning point in the route.Arguments
- int num - Point number.
Return value
Point coordinates.void AddExcludeNavigation ( Node navigation ) #
Sets a navigation sector or a navigation mesh to be ignored during pathfinding. Excluded sectors/meshes are added into the list.Arguments
- Node navigation - A navigation area to be ignored.
void AddExcludeObstacle ( Node obstacle ) #
Sets an obstacle to be ignored during pathfinding. Excluded obstacles are added into the list.Arguments
- Node obstacle - An obstacle to be ignored.
void Create2D ( vec3 p0, vec3 p1, int delay = 0 ) #
Calculates a 2D route between the given points with the specified delay.Arguments
- vec3 p0 - The starting point.
- vec3 p1 - The destination point.
- int delay - The number of frames which is possible to delay pathfinding calculations. 0 means the pathfinding should be calculated immediately.
void Create3D ( vec3 p0, vec3 p1, int delay = 0 ) #
Calculates a 3D route between the given points with the specified delay.Arguments
- vec3 p0 - The starting point.
- vec3 p1 - The destination point.
- int delay - The number of frames which is possible to delay pathfinding calculations. 0 means the pathfinding should be calculated immediately.
void RemoveExcludeNavigation ( Node navigation ) #
Removes a navigation sector or a navigation mesh from the list of ignored ones during pathfinding.Arguments
- Node navigation - A navigation area.
void RemoveExcludeObstacle ( Node obstacle ) #
Removes an obstacle from the list of ignored ones during pathfinding.Arguments
- Node obstacle - An obstacle.
void RenderVisualizer ( vec4 color ) #
Renders the route in a given color.Notice
You should enable the engine visualizer by the show_visualizer 1 console command.
Arguments
- vec4 color - Route color.
Last update:
2020-04-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)