Kaim::TraversalParameters Class Reference

Kaim::TraversalParameters Class Reference

#include <traversalparams.h>

Class Description

An internal class that stores parameters used to control the propagation of traversals through the NavMesh.

Instances of this class are transparently set up by queries that use traversals to explore the NavMesh, such as the AStarQuery.

Public Attributes

PathFinderAbstractGraphTraversalMode m_abstractGraphTraversalMode
 
KyFloat32 m_fromOutsideNavMeshDistance
 
KyUInt32 m_numberOfCanGoTestInRefinerPerFrame
 
KyUInt32 m_numberOfIntersectionTestPerFrame
 
KyUInt32 m_numberOfVisitedNodePerFrame
 
PositionSpatializationRange m_positionSpatializationRange
 
KyFloat32 m_toOutsideNavMeshDistance
 

Main API functions

KyUInt32 GetNumberOfProcessedNodePerFrame () const
 
KyFloat32 GetFromOutsideNavMeshDistance () const
 
KyFloat32 GetToOutsideNavMeshDistance () const
 
PathFinderAbstractGraphTraversalMode GetAbstractGraphTraversalMode () const
 
const PositionSpatializationRange & GetPositionSpatializationRange () const
 

Member Data Documentation

PathFinderAbstractGraphTraversalMode Kaim::TraversalParameters::m_abstractGraphTraversalMode

Indicates if the traversal should traverse AbstractGraphs.

KyFloat32 Kaim::TraversalParameters::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.

KyUInt32 Kaim::TraversalParameters::m_numberOfCanGoTestInRefinerPerFrame

The number of CanGo tests that will be processed each frame during the refiner part of the query.

KyUInt32 Kaim::TraversalParameters::m_numberOfIntersectionTestPerFrame

The number of intersections that will be processed each frame during the clamper part of the query.

KyUInt32 Kaim::TraversalParameters::m_numberOfVisitedNodePerFrame

The number of nodes that will be processed each frame during the traversal part of the AStar.

PositionSpatializationRange Kaim::TraversalParameters::m_positionSpatializationRange

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

KyFloat32 Kaim::TraversalParameters::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.


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