Attached to a Scene a navigation component will act as a building block for all pathfinding requests and queries. It maintains for you navigation maps and common obstacles. Using the navigation API you can create offline a navigation mesh that will be used for future map creations and real-time updates.

All navigation start with a basic list of abilities that will dictate what type of movements can be performed. This set of Ability is then propagated to all Map maintained by the structure which in turn have a direct impact on the subsequent navigation queries evaluated at runtime.

Static Variables

Name	Description
`ability_count`	Total amount of possible Ability used to navigate Map.
Declaration unsigned char ability_count
`map_count`	Amount of Map currently available for Navigation.
Declaration unsigned char map_count
`obstacle_count`	Total amount of Obstacle that can affect a navigation Map.
Declaration unsigned int obstacle_count
`scene`	Parent Scene that maintains the active Navigation.
Declaration Scene *scene
`geometry`	Geometry information that are used to create the Navigation mesh.
Declaration Geometry geometry
`ability_default`	Reference to the basic Ability necessary to travel around Map.
Declaration Ability *ability_default

Variables

Name	Description
`cell_size`	Specify the size of each cell.
Declaration float cell_size Range 0.1 to 1.0
`cell_height`	Controls the maximum height of each cell.
Declaration float cell_height Range 0.1 to 1.0
`walkable_slope_angle`	Maximum inclination (in degrees) of the slope all agents size should be able to climb.
Declaration float walkable_slope_angle Range 0.01 to 90 degrees
`display_offset`	Debug draw offset used by the editor to avoid Z-fighting in the viewport.
Declaration float display_offset Range 0.0 to 2.0
`draw_mode`	Bit mask formed from DrawMode values used to debug draw the Navigation (editor only).
Declaration DrawMode draw_mode

Functions

Name	Description
`Build`	Build the Navigation mesh using the active config. and the current drawable object selection from its parent Scene.
Declaration void Build( void )
`Clear`	Clear the Navigation mesh.
Declaration void Clear( void )
`AddAbility`	Create a new Ability.
Declaration Ability AddAbility( const char name, int cap ) Parameters `name`: A unique name to identify the Ability within the Navigation. `cap`: Unique bit id to apply to the Ability; `0` to let the system assign one automatically. Return Value A new Ability reference associated to the active Navigation.
`GetAbility`	Retrieve an existing Navigation Ability using its name as key.
Declaration Ability GetAbility( const char name ) Parameters `name`: The name of the Ability to retrieve. Return Value A valid Ability reference upon success; else `nil` on failure.
`GetAbilityAt`	Retrieve an Ability reference by index.
Declaration Ability GetAbilityAt( unsigned char index ) Parameters* `index`: Index of the Navigation Ability to retrieve. Return Value A valid Ability if successful; `nil` if the Ability index does not correspond to any.
`GetAbilityIndex`	Return the internal list index of an Ability.
Declaration int GetAbilityIndex( const Ability ability ) Parameters* `ability`: A valid Ability reference. Return Value `-1` if the Ability received in parameter is not associated to the current Navigation; else the list index of the Ability.
`RemoveAbility`	Remove a specific Ability.
Declaration bool RemoveAbility( Ability ability ) Parameters* `ability`: Reference to the Ability to remove. Return Value `true` on success; else `false` if the Ability is not connected to the active Navigation.
`RemoveAbilityAt`	Remove an Ability using its index as key.
Declaration bool RemoveAbilityAt( const int index ) Parameters `index`: Internal index of the Ability to remove. Return Value `true` if the operation is a success; else return `false`.
`SetDefaultAbility`	Set the default Ability that all agent should be able to perform in order to find paths on a Map.
Declaration bool SetDefaultAbility( Ability ability ) Parameters* `ability`: The Ability to use as default. Return Value `true` on if the Ability received in parameter is valid; else return `false`.
`SetDefaultAbilityAt`	Helper to set the default Ability using an index.
Declaration bool SetDefaultAbilityAt( unsigned char index ) Parameters `index`: Index of the Ability to set as default. Return Value `true` if the Ability index is valid; else return `false`.
`AddMap`	Create a new Navigation Map.
Declaration Map AddMap( const char name, int cap ) Parameters `name`: A unique name to identify the Map within the active Navigation. `cap`: Bit id to identify and create bit mask during queries. Set this value to `0` to let the system assign one automatically. Return Value A new Map reference.
`GetMap`	Retrieve an existing Map using its name as key.
Declaration Map GetMap( const char name ) Parameters `name`: The name of the Map to retrieve. Return Value If successful, an existing Map reference; else `nil`.
`GetMapAt`	Retrieve a Map using its internal index.
Declaration Map GetMapAt( const unsigned char index ) Parameters* `index`: Index of the Map to retrieve. Return Value A valid Map reference; else `nil` if the index is invalid.
`GetMapIndex`	Return the internal index of a specific Map.
Declaration int GetMapIndex( const Map map ) Parameters* `map`: A valid Map reference. Return Value `-1` if the Map received in parameter does not correspond to any maps maintained by the active Navigation. If successful will return the internal index of the Map.
`RemoveMap`	Remove a specific Map from the active Navigation.
Declaration bool RemoveMap( Map map ) Parameters* `map`: Reference to the Map to remove. Return Value `true` if removed successfully; else `false` if the reference is not found.
`RemoveMapAt`	Remove a Map by index.
Declaration bool RemoveMapAt( int index ) Parameters `index`: Index of the Map to remove. Return Value `true` if removed successfully; else `false` if the index is out of bounds.
`SwapMap`	Remove a specific Map from the active Navigation.
Declaration void SwapMap( unsigned char index0, unsigned char index1 ) Parameters `index0`: Index of the first Map to swap. `index1`: Index of the second Map to swap. Return Value `false` if one of the two index is invalid; else return `true`.
`AddObstacle`	Create a new Obstacle to apply on one or more Map.
Declaration Obstacle AddObstacle( const char name, const vec3 location, float height, float radius, int map_mask ) Parameters `name`: A name to identify the Obstacle. `location`: The location where to place the new Obstacle. `height`: The height of the Obstacle. `radius`: The radius of the Obstacle. `map_mask`: Bit mask created using Map caps to tell the system which map(s) should be affected by the Obstacle. Return Value A new Obstacle reference.
`GetObstacle`	Helper function to retrieve an Obstacle using by name.
Declaration Obstacle GetObstacle( const char name ) Parameters `name`: Name of the Obstacle to return. Return Value A valid Obstacle reference if successful; else return `nil`.
`GetObstacleAt`	Retrieve an Obstacle using its index as key.
Declaration Obstacle GetObstacleAt( unsigned int index ) Parameters* `index`: Index of the Obstacle to retrieve. Return Value An existing Obstacle reference; if the `index` is invalid; `nil`.
`GetObstacleAtLocation`	Retrieve an Obstacle located at a specific position.
Declaration Obstacle GetObstacleAtLocation( const vec3 location ) Parameters* `location`: World position to test. Return Value An existing Obstacle reference if the location is within its radius; else return `nil`.
`GetObstacleIndex`	Return the index of a specific Obstacle.
Declaration int GetObstacleIndex( const Obstacle obstacle ) Parameters* `obstacle`: A valid Obstacle reference. Return Value `-1` if the Obstacle reference is invalid; else the internal list index of the `obstacle` received in parameter.
`RemoveObstacle`	Remove a specific Obstacle from the active Navigation.
Declaration bool RemoveObstacle( Obstacle obstacle ) Parameters* `obstacle`: Reference to the Obstacle to remove. Return Value `true` if removed successfully; else return `false`.
`RemoveObstacleAt`	Remove an Obstacle by index.
Declaration bool RemoveObstacleAt( int index ) Parameters `index`: Index of the Obstacle to remove. Return Value `true` if removed successfully; else `false` if the index is out of bounds.
`Sync`	Manually perform a synchronization steps to ensure that the tile cache of each Map have been updated.
Declaration void Sync( void )
`Update`	Force the update of all maps.
Declaration void Update( void )
`UpdateObstacles`	Manually force the update of all obstacles.
Declaration void UpdateObstacles( void )

DrawMode

Debug draw mode flags used by the editor to visualize the different elements that are part of an existing Navigation structure.

fDrawMesh: Draw the navigation mesh.
fDrawMaps: Draw all maps (individual Map visibility can be turned on/off, see the Map page).
fDrawZones: Draw all zones for each Map.
fDrawObstacles: Draw all obstacles.
fDrawConnections: Draw all connections.
fDrawZonesNames: Draw the name of each Zone.
fDrawObstaclesNames: Draw the name of each Obstacle.
fDrawConnectionsNames: Draw the name of each Connection.
fDrawEnabled: Global flag that enables or disable the Navigation debug draw.