#include <ipathfinderquery.h>

Class Description

Base class for all pathfinder queries.

Pathfinder queries takes all at least a start position as input and returns a Path as an output.

Inherited by Kaim::BaseAStarQuery, Kaim::BaseBestGraphVertexPathFinderQuery, and Kaim::BasePathFromPolylineQuery.

Public Types
enum	PathFinderResult { PathFinderNotInitialized, PathFinderNotComputed, PathFinderUnderProcess, PathFinderSuccess, PathFinderFailure, PathFinderFailure_NavDataChanged }
	Enumerates the possible status of a IPathFinderQuery. 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...

Functions
	IPathFinderQuery ()

virtual	~IPathFinderQuery ()

Path *	GetPath () const

const Vec3f &	GetStartPos () const

void	SetNavigationProfileId (KyUInt32 navigationProfileId)

KyUInt32	GetNavigationProfileId () const

Virtual Member Functions
virtual const Vec3f *	GetDestination () const =0
	This function is virtual because not all the PathFinders have a preset destination, it may return nullptr. 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 &) const
	Fill the displayList with display info that may help to understand a PathFinderFailure (mainly propagation bounds) More...

virtual PathFinderResult	GetPathFinderResult () const =0

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...

Pure virtual functions - Query framework contract
virtual QueryType	GetType () const =0
	Get query type. More...

virtual void	Advance (WorkingMemory *workingMemory)=0
	This function is called by the QueryQueue to process one step on the query. More...

For internal use only
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

static const char *	GetQueryTypeName (QueryType queryType)

Internal Virtual functions for NavigationLab Remote Query processing
virtual Ptr< BaseBlobHandler >	CreateQueryBlobHandler ()

virtual void	BuildQueryBlob (Kaim::BaseBlobHandler *)

virtual void	InitFromQueryBlob (World , void )

Pure virtual functions
virtual void	ReleaseWorkingMemoryOnCancelDuringProcess (WorkingMemory *workingMemory)=0
	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...

Member Enumeration Documentation

enum Kaim::IPathFinderQuery::PathFinderResult

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

virtual void Kaim::IQuery::Advance ( WorkingMemory * workingMemory )

pure virtualinherited

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.

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.

virtual void Kaim::IPathFinderQuery::DisplayPropagationBounds ( DisplayList & ) const

inlinevirtual

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

Reimplemented in Kaim::BaseAStarQuery, and Kaim::BaseBestGraphVertexPathFinderQuery.

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

pure virtual

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

Implemented in Kaim::BaseAStarQuery, Kaim::BasePathFromPolylineQuery, and Kaim::BaseBestGraphVertexPathFinderQuery.

virtual void Kaim::IPathFinderQuery::GetPathFinderTextResult ( String & ) const

inlinevirtual

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

Reimplemented in Kaim::BaseAStarQuery, Kaim::BasePathFromPolylineQuery, and Kaim::BaseBestGraphVertexPathFinderQuery.

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

inlineinherited

Gets m_traverseLogicUserData.

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

pure virtualinherited

Get query type.

Implemented in Kaim::BaseMultiDestinationPathFinderQuery, Kaim::BaseAStarQuery, Kaim::DynamicNavMeshQuery, Kaim::BaseDiskCastQuery, Kaim::BaseDiskCanGoQuery, Kaim::BasePathFromPolylineQuery, Kaim::BaseBestGraphVertexPathFinderQuery, Kaim::TriangleFromPosQuery, Kaim::BaseRayCastOnSegmentQuery, Kaim::BaseRayCanGoQuery, Kaim::MultipleFloorTrianglesFromPosQuery, Kaim::BaseRayCastQuery, Kaim::TriangleFromPosAndTriangleSeedQuery, Kaim::BaseRayCanGoOnSegmentQuery, Kaim::BaseSegmentCastQuery, Kaim::BaseInsidePosFromOutsidePosQuery, Kaim::BaseSegmentCanGoQuery, Kaim::BaseDiskExpansionQuery, Kaim::BaseFindFirstVisiblePositionOnPathQuery, Kaim::BaseDiskCollisionQuery, Kaim::BaseSpatializedPointCollectorInAABBQuery, Kaim::CircleArcSplineComputationQuery, Kaim::RayCastFull3dQuery, Kaim::BaseNearestBorderHalfEdgeFromPosQuery, Kaim::MoveOnNavMeshQuery< TraverseLogic >, and Kaim::CollisionRayCastQuery.

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.

virtual void Kaim::ITimeSlicedQuery::ReleaseWorkingMemoryOnCancelDuringProcess ( WorkingMemory * workingMemory )

pure virtualinherited

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).

Implemented in Kaim::DynamicNavMeshQuery, Kaim::BestGraphVertexPathFinderQuery< VertexFinderLogic >, Kaim::CircleArcSplineComputationQuery, and Kaim::AStarQuery< TraverseLogic >.

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

The parameter set specific to Channels computation.

PathFinderQueryComputeChannelMode Kaim::IPathFinderQuery::m_computeChannelMode

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

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.

Vec3f Kaim::IPathFinderQuery::m_startPos3f

The starting position for the Path request.

void* Kaim::IQuery::m_traverseLogicUserData

inherited

This userData is typically passed by the Bot.

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

gwnavruntime/queries/ipathfinderquery.h

Kaim::IPathFinderQuery Class Reference

Class Description

Public Types

Public Attributes

Functions

Virtual Member Functions

Public Data Members

IQuery Functions

Pure virtual functions - Query framework contract

For internal use only

Internal Virtual functions for NavigationLab Remote Query processing

Pure virtual functions

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation