#include <bestgraphvertexpathfinderquery.h>

Class Description

template<class VertexFinderLogic>
class Kaim::BestGraphVertexPathFinderQuery< VertexFinderLogic >

This query propagates outward through the NavMesh from the starting position.

Each time the query encounters a NavGraph vertex, it calls the customizer that you pass in the template argument to determine whether that vertex should be chosen as the destination for the path, or whether the search should continue. The template argument should be a class that contains the same methods as the customizer accepted by the TraverseLogic class, plus the following methods:

OnGraphVertexVisitedResult OnGraphVertexVisited(const NavGraphVertexRawPtr& currentGraphVertex, const NavGraphVertexRawPtr& bestGraphVertex, Ptr<Path> pathToBest)

OnPathToGraphVertexComputedResult OnPathToGraphVertexComputed(const NavGraphVertexRawPtr& currentGraphVertex, Ptr<Path> pathToCurrent, const NavGraphVertexRawPtr& bestGraphVertex, Ptr<Path> pathToBest)

It's a common pattern to have VertexFinderLogic inherit from TraverseLogic, for ex: DefaultTraverseLogic. The OnGraphVertexVisited() method is called for each vertex encountered during the propagation. It indicates by its return value whether or not the vertex should be chosen as the best so far, and whether or not the query should continue. It can also indicate that the path to the candidate vertex must be tested before a decision can be made; in this case the query also calls the OnPathToGraphVertexComputed() method, providing the path to the candidate vertex and the path to the best vertex found so far. the propagation is limited in 2d to a circle centered in startPos and with m_propagationRadius as radius. (you can change it with the SetPropagationRadius method)

Inherits Kaim::BaseBestGraphVertexPathFinderQuery.

Public Types
enum	PathFinderResult { PathFinderNotInitialized, PathFinderNotComputed, PathFinderUnderProcess, PathFinderSuccess, PathFinderFailure, PathFinderFailure_NavDataChanged }
	Enumerates the possible status of a IPathFinderQuery. More...

Public Member Functions
virtual QueryType	GetType () const
	Get query type. More...

virtual void	GetPathFinderTextResult (String &) const
	Fills the String with an explanation of the result. Use this to debug your pathfinder query. More...

virtual void	DisplayPropagationBounds (DisplayList &displayList) const
	Fill the displayList with display info that may help to understand a PathFinderFailure (mainly propagation bounds) More...

virtual const Vec3f *	GetDestination () const
	This function is virtual because not all the PathFinders have a preset destination, it may return nullptr. More...

Public Attributes
QueryProcessStatus	m_processStatus
	Modified by the query within Advance(). Do not modify. More...

Ptr< IOnDone >	m_onDone
	The optional IOnDone instance to be called. Must be set manually by the user. See IOnDone. More...

Protected Attributes
NavTrianglePtr	m_startTrianglePtr
	The NavMesh triangle that corresponds to m_startPos3f. If not valid, it will be computed. More...

NavGraphEdgePtr	m_startNavGraphEdgePtr
	if valid, propagation start using the m_startNavGraphEdgePtr More...

NavGraphEdgeDirection	m_startNavGraphEdgeDirection
	if NAVGRAPHEDGE_BIDIRECTIONAL propagation uses m_startNavGraphEdgePtr reverse edge if it exists. More...

NavGraphVertexPtr	m_startNavGraphVertexPtr
	if valid, propagation start using the m_startNavGraphVertexPtr More...

BestGraphVertexPathFinderQueryResult	m_result
	Updated during processing to indicate the result of the PathFinderQueryResult query. More...

Functions
	BestGraphVertexPathFinderQuery ()

virtual	~BestGraphVertexPathFinderQuery ()

Query framework functions
virtual void	Advance (WorkingMemory *workingMemory)
	Performs a single iteration of the PathFinder. More...

virtual void	ReleaseWorkingMemoryOnCancelDuringProcess (WorkingMemory *workingMemory=nullptr)
	Called when a query is canceled in FlushCommands while its status is QueryInProcess to make sure that the WorkingMemory is left in valid state (typically, no WorkingMemory buffer should be in used after this call). More...

For internal use only
bool	TraversalHasVisitedNavDataChanged ()

Functions
void	SetNavigationProfileId (KyUInt32 navigationProfileId)

KyUInt32	GetNavigationProfileId () const

Public Data Members
KyUInt32	m_navigationProfileId

Vec3f	m_startPos3f
	The starting position for the Path request. More...

PathFinderQueryComputeChannelMode	m_computeChannelMode
	The mode toggling Channels computation. More...

ChannelComputerConfig	m_channelComputerConfig
	The parameter set specific to Channels computation. More...

FullDebug	m_fullDebug

bool	m_doClampRawPath

KyUInt32	m_lastAdvanceDatabaseChangeIdx

Ptr< Path >	m_path
	The Path found by the query. More...

IQuery Functions
bool	CanBeInitialized () const
	In the case of a query processed in a QueryQueue, this must be tested before initializing the query, to prevent modifying the query during the process. More...

bool	IsInAQueryQueue () const
	Returns true if the query is currently registered in a QueryQueue. More...

bool	IsSafeToReadResult () const
	Returns true if the query has been processed, is no longer in a queue, and OnDone (if there is one) has been called. More...

KyUInt32	PerformQueryBlocking (WorkingMemory *workingMemory=nullptr)
	Calls Advance() untill the query is done. More...

void	OnDone ()
	Calls m_onDone IOnDone::OnDone() if m_onDone is not null. More...

KyResult	SendVisualDebug ()
	Sends the query to the NavigationLab. More...

void	SetTraverseLogicUserData (void *traverseLogicUserData)
	Sets m_traverseLogicUserData for queries that have a custom TraverseLogic, useless otherwise. More...

void *	GetTraverseLogicUserData () const
	Gets m_traverseLogicUserData. More...

For internal use only
static const char *	GetQueryTypeName (QueryType queryType)

Database *	m_database
	The database on which the query will be performed. Set in Initialize(), do not directly modify. More...

void *	m_traverseLogicUserData
	This userData is typically passed by the Bot. More...

QueryQueue *	m_queue
	Updated by the QueryQueue. Do not modify. More...

QueryStatusInQueue	m_inQueueStatus
	Used by the QueryQueue. Do not modify. More...

KyUInt32	m_queryInfoId

Member Enumeration Documentation

enum Kaim::IPathFinderQuery::PathFinderResult

inherited

Enumerates the possible status of a IPathFinderQuery.

Enumerator
PathFinderNotInitialized	The IPathFinderQuery is not yet initialized.
PathFinderNotComputed	The IPathFinderQuery is initialized but has not been processed.
PathFinderUnderProcess	The IPathFinderQuery is currently under process.
PathFinderSuccess	The IPathFinderQuery has been completed and a Path has been found.
PathFinderFailure	The IPathFinderQuery has been completed but no Path has been found.
PathFinderFailure_NavDataChanged	The IPathFinderQuery ended prematurely due to changes into NavData.

Member Function Documentation

template<class VFL >

void Kaim::BestGraphVertexPathFinderQuery< VFL >::Advance ( WorkingMemory * workingMemory )

inlinevirtual

Performs a single iteration of the PathFinder.

This function is called by the QueryQueue to process one step on the query. One call to Advance should be short (< 0.1ms as too long). It's Advance() responsibility to update m_processStatus. If the query is atomic, one call to Advance() will fully perform the query and set m_processStatus to QueryDone. If the query is time-sliced, several calls to Advance() will be needed to complete the query. the first call should set m_processStatus to Kaim::QueryInProcess and the last one to Kaim::QueryDone.

Parameters

workingMemory Sandbox memory used to perform queries.

Implements Kaim::IQuery.

bool Kaim::IQuery::CanBeInitialized ( ) const

inlineinherited

In the case of a query processed in a QueryQueue, this must be tested before initializing the query, to prevent modifying the query during the process.

void Kaim::BaseBestGraphVertexPathFinderQuery::DisplayPropagationBounds ( DisplayList & ) const

virtualinherited

Fill the displayList with display info that may help to understand a PathFinderFailure (mainly propagation bounds)

Reimplemented from Kaim::IPathFinderQuery.

virtual const Vec3f* Kaim::BaseBestGraphVertexPathFinderQuery::GetDestination ( ) const

inlinevirtualinherited

This function is virtual because not all the PathFinders have a preset destination, it may return nullptr.

Implements Kaim::IPathFinderQuery.

void Kaim::BaseBestGraphVertexPathFinderQuery::GetPathFinderTextResult ( String & ) const

virtualinherited

Fills the String with an explanation of the result. Use this to debug your pathfinder query.

Reimplemented from Kaim::IPathFinderQuery.

void* Kaim::IQuery::GetTraverseLogicUserData ( ) const

inlineinherited

Gets m_traverseLogicUserData.

virtual QueryType Kaim::BaseBestGraphVertexPathFinderQuery::GetType ( ) const

inlinevirtualinherited

Get query type.

Implements Kaim::IQuery.

bool Kaim::IQuery::IsInAQueryQueue ( ) const

inlineinherited

Returns true if the query is currently registered in a QueryQueue.

If true, you must not push it again in QueryQueue (even the same one). If false, you must not try to cancel it from the QueryQueue.

bool Kaim::IQuery::IsSafeToReadResult ( ) const

inlineinherited

Returns true if the query has been processed, is no longer in a queue, and OnDone (if there is one) has been called.

If true, it's guaranteed to be safe to read the results of this query. Will return false if the Query has been cancelled or has not yet been processed.

void Kaim::IQuery::OnDone ( )

inlineinherited

Calls m_onDone IOnDone::OnDone() if m_onDone is not null.

Called automatically by the QueryQueue during the World::Update() (in the FlushQueries() step) when this query has been completed. OnDone() is not called if the query is canceled. Note that the member m_onDone is reset to nullptr at the end of this function.

KyUInt32 Kaim::IQuery::PerformQueryBlocking ( WorkingMemory * workingMemory = nullptr )

inherited

Calls Advance() untill the query is done.

Parameters

workingMemory Sandbox memory used to perform queries. If not set, m_database.GetWorkingMemory() will be used.

Returns: the number of call to Advance() (timesliced iterations) it took to perform the query.

template<class VFL >

void Kaim::BestGraphVertexPathFinderQuery< VFL >::ReleaseWorkingMemoryOnCancelDuringProcess ( WorkingMemory * workingMemory = nullptr )

inlinevirtual

Called when a query is canceled in FlushCommands while its status is QueryInProcess to make sure that the WorkingMemory is left in valid state (typically, no WorkingMemory buffer should be in used after this call).

Implements Kaim::ITimeSlicedQuery.

KyResult Kaim::IQuery::SendVisualDebug ( )

inherited

Sends the query to the NavigationLab.

Currently the implementation transform the query using a DisplayList, and the display list is shown only at the frame SendVisualDebug is called.

void Kaim::IQuery::SetTraverseLogicUserData ( void * traverseLogicUserData )

inlineinherited

Sets m_traverseLogicUserData for queries that have a custom TraverseLogic, useless otherwise.

Member Data Documentation

ChannelComputerConfig Kaim::IPathFinderQuery::m_channelComputerConfig

inherited

The parameter set specific to Channels computation.

PathFinderQueryComputeChannelMode Kaim::IPathFinderQuery::m_computeChannelMode

inherited

The mode toggling Channels computation.

Database* Kaim::IQuery::m_database

inherited

The database on which the query will be performed. Set in Initialize(), do not directly modify.

QueryStatusInQueue Kaim::IQuery::m_inQueueStatus

inherited

Used by the QueryQueue. Do not modify.

Ptr<IOnDone> Kaim::IQuery::m_onDone

inherited

The optional IOnDone instance to be called. Must be set manually by the user. See IOnDone.

Ptr<Path> Kaim::IPathFinderQuery::m_path

inherited

The Path found by the query.

QueryProcessStatus Kaim::IQuery::m_processStatus

inherited

Modified by the query within Advance(). Do not modify.

Before reading m_processStatus, always ensure IsInAQueryQueue() returns false.

QueryQueue* Kaim::IQuery::m_queue

inherited

Updated by the QueryQueue. Do not modify.

BestGraphVertexPathFinderQueryResult Kaim::BaseBestGraphVertexPathFinderQuery::m_result

protectedinherited

Updated during processing to indicate the result of the PathFinderQueryResult query.

NavGraphEdgeDirection Kaim::BaseBestGraphVertexPathFinderQuery::m_startNavGraphEdgeDirection

protectedinherited

if NAVGRAPHEDGE_BIDIRECTIONAL propagation uses m_startNavGraphEdgePtr reverse edge if it exists.

NavGraphEdgePtr Kaim::BaseBestGraphVertexPathFinderQuery::m_startNavGraphEdgePtr

protectedinherited

if valid, propagation start using the m_startNavGraphEdgePtr

NavGraphVertexPtr Kaim::BaseBestGraphVertexPathFinderQuery::m_startNavGraphVertexPtr

protectedinherited

if valid, propagation start using the m_startNavGraphVertexPtr

Vec3f Kaim::IPathFinderQuery::m_startPos3f

inherited

The starting position for the Path request.

NavTrianglePtr Kaim::BaseBestGraphVertexPathFinderQuery::m_startTrianglePtr

protectedinherited

The NavMesh triangle that corresponds to m_startPos3f. If not valid, it will be computed.

void* Kaim::IQuery::m_traverseLogicUserData

inherited

This userData is typically passed by the Bot.

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

gwnavruntime/queries/bestgraphvertexpathfinderquery.h
gwnavruntime/queries/bestgraphvertexpathfinderquery.inl

Kaim::BestGraphVertexPathFinderQuery< VertexFinderLogic > Class Template Reference

Class Description

template<class VertexFinderLogic> class Kaim::BestGraphVertexPathFinderQuery< VertexFinderLogic >

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Functions

Query framework functions

For internal use only

Functions

Public Data Members

IQuery Functions

For internal use only

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation

template<class VertexFinderLogic>
class Kaim::BestGraphVertexPathFinderQuery< VertexFinderLogic >