ezEngine  Release 25.03
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ezAiNavigation Class Referencefinal

Computes a path through a navigation mesh. More...

#include <Navigation.h>

Public Types

enum  State {
  Idle, StartNewSearch, InvalidCurrentPosition, InvalidTargetPosition,
  NoPathFound, PartialPathFound, FullPathFound, Searching
}
 

Public Member Functions

State GetState () const
 
void Update ()
 
void CancelNavigation ()
 
void SetCurrentPosition (const ezVec3 &vPosition)
 
void SetTargetPosition (const ezVec3 &vPosition)
 
const ezVec3 & GetTargetPosition () const
 
void SetNavmesh (ezAiNavMesh *pNavmesh)
 
void SetQueryFilter (const dtQueryFilter &filter)
 
void ComputeAllWaypoints (ezDynamicArray< ezVec3 > &out_waypoints) const
 
void DebugDrawPathCorridor (const ezDebugRendererContext &context, ezColor tilesColor, float fPolyRenderOffsetZ=0.1f)
 
void DebugDrawPathLine (const ezDebugRendererContext &context, ezColor straightLineColor, float fLineRenderOffsetZ=0.2f)
 
void DebugDrawState (const ezDebugRendererContext &context, const ezVec3 &vPosition) const
 
float GetCurrentElevation () const
 Returns the height of the navmesh at the current position.
 
void ComputeSteeringInfo (ezAiSteeringInfo &out_info, const ezVec2 &vForwardDir, float fMaxLookAhead=5.0f)
 

Public Attributes

float m_fPolySearchRadius = 0.5f
 
float m_fPolySearchUp = 1.5f
 
float m_fPolySearchDown = 1.5f
 

Static Public Attributes

static constexpr ezUInt32 MaxPathNodes = 64
 
static constexpr ezUInt32 MaxSearchNodes = MaxPathNodes * 8
 
constexpr static float c_fPathSearchBoundary = 10.0f
 

Detailed Description

Computes a path through a navigation mesh.

First call SetNavmesh() and SetQueryFilter().

When you need a path, call SetCurrentPosition() and SetTargetPosition() to inform the system of the current position and desired target location. Then call Update() once per frame to have it compute the path. Call GetState() to figure out whether a path exists. Use ComputeAllWaypoints() to get an entire path, e.g. for visualization. For steering this is not necessary. Instead use ComputeSteeringInfo() to plan the next step. Apply your steering behavior to your character as desired. Keep calling SetCurrentPosition() and SetTargetPosition() to inform the ezAiNavigation of the new state, and keep calling ComputeSteeringInfo() every frame for the updated path.

If the destination was reached, a completely different path should be computed, or the current path should be canceled, call CancelNavigation(). To start a new path search, call SetTargetPosition() again (and Update() every frame).

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