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

#include <DetourNavigationComponent.h>

Inherits AZ::Component, and DetourNavigationRequestBus::Handler.

Public Member Functions

 AZ_COMPONENT (DetourNavigationComponent, "{B9A8F260-2772-4C94-8DE4-850C94A8F2AC}")
 
 DetourNavigationComponent (AZ::EntityId navQueryEntityId, float nearestDistance)
 
AZStd::vector< AZ::Vector3 > FindPathBetweenEntities (AZ::EntityId fromEntity, AZ::EntityId toEntity) override
 
AZStd::vector< AZ::Vector3 > FindPathBetweenPositions (const AZ::Vector3 &fromWorldPosition, const AZ::Vector3 &toWorldPosition) override
 
void SetNavigationMeshEntity (AZ::EntityId navMeshEntity) override
 
AZ::EntityId GetNavigationMeshEntity () const override
 
void Activate () override
 
void Deactivate () override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

Calculates paths over the associated navigation mesh. Provides APIs to find a path between two entities or two world positions.

Constructor & Destructor Documentation

◆ DetourNavigationComponent()

RecastNavigation::DetourNavigationComponent::DetourNavigationComponent ( AZ::EntityId  navQueryEntityId,
float  nearestDistance 
)

Constructor to be used by Editor variant to pass the configuration in.

Parameters
navQueryEntityIdentity id of the entity with a navigation mesh component.
nearestDistancedistance to use when finding nearest point on the navigation mesh when points provided to FindPath are outside of the navigation mesh.

Member Function Documentation

◆ Activate()

void RecastNavigation::DetourNavigationComponent::Activate ( )
override

AZ::Component overrides ...

◆ FindPathBetweenEntities()

AZStd::vector<AZ::Vector3> RecastNavigation::DetourNavigationComponent::FindPathBetweenEntities ( AZ::EntityId  fromEntity,
AZ::EntityId  toEntity 
)
override

DetourNavigationRequestBus overrides ...

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