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::DetourNavigationRequests Class Referenceabstract

Interface for path finding API. More...

#include <DetourNavigationBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void SetNavigationMeshEntity (AZ::EntityId navMeshEntity)=0
 
virtual AZ::EntityId GetNavigationMeshEntity () const =0
 
virtual AZStd::vector< AZ::Vector3 > FindPathBetweenEntities (AZ::EntityId fromEntity, AZ::EntityId toEntity)=0
 
virtual AZStd::vector< AZ::Vector3 > FindPathBetweenPositions (const AZ::Vector3 &fromWorldPosition, const AZ::Vector3 &toWorldPosition)=0
 

Detailed Description

Interface for path finding API.

Member Function Documentation

◆ FindPathBetweenEntities()

virtual AZStd::vector< AZ::Vector3 > RecastNavigation::DetourNavigationRequests::FindPathBetweenEntities ( AZ::EntityId  fromEntity,
AZ::EntityId  toEntity 
)
pure virtual

Blocking call that finds a walkable path between two entities.

Parameters
fromEntityThe starting point of the path from the position of this entity.
toEntityThe end point of the path is at the position of this entity.
Returns
If a path is found, returns a vector of waypoints. An empty vector is returned if a path was not found.

◆ FindPathBetweenPositions()

virtual AZStd::vector< AZ::Vector3 > RecastNavigation::DetourNavigationRequests::FindPathBetweenPositions ( const AZ::Vector3 &  fromWorldPosition,
const AZ::Vector3 &  toWorldPosition 
)
pure virtual

Blocking call that finds a walkable path between two world positions.

Parameters
fromWorldPositionThe starting point of the path.
toWorldPositionThe end point of the path to find.
Returns
If a path is found, returns a vector of waypoints. An empty vector is returned if a path was not found.

◆ GetNavigationMeshEntity()

virtual AZ::EntityId RecastNavigation::DetourNavigationRequests::GetNavigationMeshEntity ( ) const
pure virtual

An entity with a navigation mesh is required to calculate paths.

Returns
the associated entity with @RecastNavigationMeshComponent

◆ SetNavigationMeshEntity()

virtual void RecastNavigation::DetourNavigationRequests::SetNavigationMeshEntity ( AZ::EntityId  navMeshEntity)
pure virtual

An entity with a navigation mesh is required to calculate paths.

Parameters
navMeshEntityan entity with @RecastNavigationMeshComponent
The documentation for this class was generated from the following file: