Kaim::PathFinderConfig Class Reference

Kaim::PathFinderConfig Class Reference

#include <pathfinderconfig.h>

Class Description

Class that aggregates most important parameters that allow to configure the PathFinding of a Bot.

Public Attributes

KyFloat32 m_fromOutsideNavMeshDistance
 The maximum distance from the start along the X axis and along the Y axis that will be searched for NavMesh, if the start point is outside the NavMesh. More...
 
KyFloat32 m_toOutsideNavMeshDistance
 The maximum distance from the destination along the X axis and along the Y axis that will be searched for NavMesh, if the destination point is outside the NavMesh. More...
 
KyFloat32 m_propagationBoxExtent
 The PathFinder propagation is limited to a 2d oriented bounding box computed by inflating the segment going from startPos to destPos by m_propagationBoxExtent. More...
 
PathFinderAbstractGraphTraversalMode m_abstractGraphTraversalMode
 Indicates if the PathFinder is allowed to traverse AbstractGraphs or not. More...
 
bool m_useDatabaseSpatializationRange
 Use Database spatialization range if true. More...
 
PositionSpatializationRange m_positionSpatializationRange
 The altitude range used to find NavMesh triangles that correspond to the start and destination points. More...
 
PathFinderQueryTryCanGoMode m_tryCanGoMode
 Indicates if a RayCanGoQuery should be used to try to find a straight path without running any traversal. More...
 

Member Data Documentation

PathFinderAbstractGraphTraversalMode Kaim::PathFinderConfig::m_abstractGraphTraversalMode

Indicates if the PathFinder is allowed to traverse AbstractGraphs or not.

default value:  PATHFINDER_TRAVERSE_ABSTRACT_GRAPHS

KyFloat32 Kaim::PathFinderConfig::m_fromOutsideNavMeshDistance

The maximum distance from the start along the X axis and along the Y axis that will be searched for NavMesh, if the start point is outside the NavMesh.

The search looks for triangles in an axis-aligned bounding box around the start point, with a half extent on the x and y axes equal to m_fromOutsideNavMeshDistance. To disable this feature, you can set this value to 0.f Default value is 1.5f meters.

PositionSpatializationRange Kaim::PathFinderConfig::m_positionSpatializationRange

The altitude range used to find NavMesh triangles that correspond to the start and destination points.

Used if m_useDatabaseSpatializationRange is false

KyFloat32 Kaim::PathFinderConfig::m_propagationBoxExtent

The PathFinder propagation is limited to a 2d oriented bounding box computed by inflating the segment going from startPos to destPos by m_propagationBoxExtent.

default value:  200.0f

KyFloat32 Kaim::PathFinderConfig::m_toOutsideNavMeshDistance

The maximum distance from the destination along the X axis and along the Y axis that will be searched for NavMesh, if the destination point is outside the NavMesh.

The search looks for triangles in an axis-aligned bounding box around the destination point, with a half extent on the x and y axes equal to m_fromOutsideNavMeshDistance. To disable this feature, you can set this value to 0.f Default value is 1.5f meters.

PathFinderQueryTryCanGoMode Kaim::PathFinderConfig::m_tryCanGoMode

Indicates if a RayCanGoQuery should be used to try to find a straight path without running any traversal.

Used only by some queries such as BasAStarQuery. Ignored otherwise.

default value:  PATHFINDER_TRY_RAYCANGO_IF_NO_COST

bool Kaim::PathFinderConfig::m_useDatabaseSpatializationRange

Use Database spatialization range if true.

Otherwise, use m_positionSpatializationRange.

default value:  true


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