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.
RecastNavigation::RecastNavigationMeshConfig Class Referencefinal

#include <RecastNavigationMeshConfig.h>

Inherits AZ::ComponentConfig.

Public Member Functions

 AZ_RTTI (RecastNavigationMeshConfig, "{472141BB-7C36-4D2C-A508-78DB0D3C07F2}")
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

float m_tileSize = 32.f
 
int m_borderSize = 20
 
float m_cellSize = 0.4f
 
float m_cellHeight = 0.4f
 
float m_agentMaxSlope = 45.0f
 
float m_agentHeight = 2.0f
 
float m_agentRadius = 0.6f
 
float m_agentMaxClimb = 0.9f
 
float m_edgeMaxError = 1.3f
 
float m_edgeMaxLen = 12.0f
 
int m_maxVerticesPerPoly = 6
 
float m_detailSampleDist = 6.0f
 
float m_detailSampleMaxError = 1.0f
 
int m_regionMinSize = 8
 
int m_regionMergeSize = 20
 
bool m_filterLowHangingObstacles = true
 
bool m_filterLedgeSpans = true
 
bool m_filterWalkableLowHeightSpans = true
 
bool m_enableDebugDraw = false
 If enabled, draw the navigation mesh in the game.
 
bool m_enableEditorPreview = false
 If enabled, previews the navigation mesh in the Editor's viewport.
 

Detailed Description

See @rcConfig from Recast library for documentation on these parameters. @Reflect method provides that documentation as tooltips in the Editor.

Note
Pay attention to the units of the properties in this configuration, some of them are in world units (regular O3DE world space) and others are in Recast voxels, which are defined by @m_cellSize. 1 voxel = 1 @m_cellSize in world units.

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