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.
RecastNavigation::RecastNavigationMeshRequests Class Referenceabstract

The interface for request API of @RecastNavigationMeshRequestBus. More...

#include <RecastNavigationMeshBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual bool UpdateNavigationMeshBlockUntilCompleted ()=0
 
virtual bool UpdateNavigationMeshAsync ()=0
 
virtual AZStd::shared_ptr< NavMeshQueryGetNavigationObject ()=0
 

Detailed Description

The interface for request API of @RecastNavigationMeshRequestBus.

Member Function Documentation

◆ GetNavigationObject()

virtual AZStd::shared_ptr< NavMeshQuery > RecastNavigation::RecastNavigationMeshRequests::GetNavigationObject ( )
pure virtual
Returns
the underlying navigation objects with the associated synchronization object.

◆ UpdateNavigationMeshAsync()

virtual bool RecastNavigation::RecastNavigationMeshRequests::UpdateNavigationMeshAsync ( )
pure virtual

Re-calculates the navigation mesh within the defined world area. Notifies when completed using @RecastNavigationMeshNotificationBus.

Returns
false if another update operation is already in progress

◆ UpdateNavigationMeshBlockUntilCompleted()

virtual bool RecastNavigation::RecastNavigationMeshRequests::UpdateNavigationMeshBlockUntilCompleted ( )
pure virtual

Re-calculates the navigation mesh within the defined world area. Blocking call.

Returns
false if another update operation is already in progress

The documentation for this class was generated from the following file: