Open 3D Engine RecastNavigation Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
RecastNavigation::RecastNavigationProviderRequests Class Referenceabstract

The interface for @RecastNavigationProviderRequestBus. More...

#include <RecastNavigationProviderBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual AZStd::vector< AZStd::shared_ptr< TileGeometry > > CollectGeometry (float tileSize, float borderSize)=0
 
virtual bool CollectGeometryAsync (float tileSize, float borderSize, AZStd::function< void(AZStd::shared_ptr< TileGeometry >)> tileCallback)=0
 
virtual int GetNumberOfTiles (float tileSize) const =0
 
virtual AZ::Aabb GetWorldBounds () const =0
 

Detailed Description

The interface for @RecastNavigationProviderRequestBus.

Member Function Documentation

◆ CollectGeometry()

virtual AZStd::vector< AZStd::shared_ptr< TileGeometry > > RecastNavigation::RecastNavigationProviderRequests::CollectGeometry ( float  tileSize,
float  borderSize 
)
pure virtual

Collects the geometry (triangles) within the configured area.

Parameters
tileSizeA navigation mesh is made up of tiles. Each tile is a square of the same size.
borderSizeAn additional extent in each dimension around each tile. In order for navigation tiles to connect to their respective neighboring tiles, they need additional geometry in the near vicinity.
Returns
a container with triangle data for each tile.

◆ CollectGeometryAsync()

virtual bool RecastNavigation::RecastNavigationProviderRequests::CollectGeometryAsync ( float  tileSize,
float  borderSize,
AZStd::function< void(AZStd::shared_ptr< TileGeometry >)>  tileCallback 
)
pure virtual

Collects the geometry (triangles) within the configured area and returns the result via the callback @tileCallback.

Parameters
tileSizeA navigation mesh is made up of tiles. Each tile is a square of the same size.
borderSizeAn additional extent in each dimension around each tile. In order for navigation tiles to connect to their respective neighboring tiles, they need additional geometry in the near vicinity.
tileCallbackwill be called once for each tile with geometry data and one last time to indicate the end of the operation with an empty shared_ptr
Returns
true if an async operation was scheduled, false otherwise

◆ GetNumberOfTiles()

virtual int RecastNavigation::RecastNavigationProviderRequests::GetNumberOfTiles ( float  tileSize) const
pure virtual

A navigation mesh is made up of tiles. Each tile is a square of the same size.

Parameters
tileSizesize of square tiles that make up a navigation mesh.
Returns
number of tiles that would be necessary to the cover the required area provided by @GetWorldBounds.

◆ GetWorldBounds()

virtual AZ::Aabb RecastNavigation::RecastNavigationProviderRequests::GetWorldBounds ( ) const
pure virtual

Returns the world bounds that this surveyor is configured to collect geometry.

Returns
an axis aligned bounding box of the world bounds.
The documentation for this class was generated from the following file: