#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 }

Public Attributes
Database *	m_database

QueryStatusInQueue	m_inQueueStatus

QueryQueue *	m_queue

void *	m_traverseLogicUserData

Public Member Functions
	IPathFinderQuery ()

virtual	~IPathFinderQuery ()

Path *	GetPath () const

ChannelArray *	GetChannelArray () const

const Vec3f &	GetStartPos () const

void	SetNavigationProfileId (KyUInt32 navigationProfileId)

KyUInt32	GetNavigationProfileId () const

Virtual Member Functions
virtual const Vec3f *	GetDestination () const =0

virtual void	GetPathFinderTextResult (String &) const

virtual void	DisplayPropagationBounds (ScopedDisplayList &) const

virtual PathFinderResult	GetPathFinderResult () const =0

Public Data Members
Vec3f	m_startPos3f

Ptr< Path >	m_path

KyUInt32	m_navigationProfileId

PathFinderQueryComputeChannelMode	m_computeChannelMode

ChannelComputerConfig	m_channelComputerConfig

KyUInt32	m_dataBaseChangeIdx

bool	m_enableAdvancedVisualDebug

Main API Functions
bool	CanBeInitialized () const

bool	IsInAQueryQueue () const

bool	IsSafeToReadResult () const

void	PerformQueryBlocking (WorkingMemory *workingMemory=0)

void	OnDone ()

KyResult	SendVisualDebug ()

void	SetTraverseLogicUserData (void *traverseLogicUserData)

void *	GetTraverseLogicUserData () const

Pure virtual functions
virtual QueryType	GetType () const =0

virtual void	Advance (WorkingMemory *workingMemory)=0

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

Internal Virtual functions for NavigationLab Remote Query processing
These functions are used by IQuery::SendVisualDebug() and also used by the NavigationLab to request remote execution: using VisualDebugClient::Send(IQuery) to ask for a query to be executed using VisualDebugServer::Send(IQuery) to send back the query result. Queries that can be visual debug override these 3 functions. By convenience, such queries provide a static function with the following signature: /code static Ptr<BaseBlobHandler> CreateStaticQueryBlobHandler(); /endcode
virtual Ptr< BaseBlobHandler >	CreateQueryBlobHandler ()

virtual void	BuildQueryBlob (Kaim::BaseBlobHandler *)

virtual void	InitFromQueryBlob (World , void )

Public Data Members
QueryProcessStatus	m_processStatus

Ptr< IOnDone >	m_onDone

Public Member Functions
void	Initialize ()

Pure virtual functions
virtual void	ReleaseWorkingMemoryOnCancelDuringProcess (WorkingMemory *workingMemory)=0

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.

It MUST NEVER, under any circumstances, take too long. As a guideline, consider 0.1ms as too long.

It is under the responsibility of this function to update m_processStatus. Obviously, if the query is atomic (i.e. not time-sliced), a 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 ( ScopedDisplayList & ) 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 KY_NULL.

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

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::BaseBestGraphVertexPathFinderQuery, and Kaim::BasePathFromPolylineQuery.

void Kaim::ITimeSlicedQuery::Initialize ( )

inlineinherited

Should be called by the derived class before trying to perform the query or to push it in a QueryQueue.

This function calls IQuery::Initialize().

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 the OnDone function of the IOnDone object if provided.

Called automatically by the QueryQueue during the World::Update() (in FlushQueries() step) when this query has been completed.

Not called if this query is canceled.

Note that the member m_onDone is reset to KY_NULL at the end of this function.

void Kaim::IQuery::PerformQueryBlocking ( WorkingMemory * workingMemory = 0 )

inherited

Process the query at once whether it is time-sliced or not.

Parameters

workingMemory Sandbox memory used to perform queries. If let to KY_NULL, the m_database internal WorkingMemory is used.

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::AStarQuery< TraverseLogic >, Kaim::BestGraphVertexPathFinderQuery< VertexFinderLogic >, Kaim::DynamicNavMeshQuery, and Kaim::CircleArcSplineComputationQuery.

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

inlineinherited

Should be set for queries templated by a traverse logic, 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.

KyUInt32 Kaim::IPathFinderQuery::m_dataBaseChangeIdx

Stores the revision of the Database when the Path has been computed.

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

Public Member Functions

Virtual Member Functions

Public Data Members

Main API Functions

Pure virtual functions

For internal use only

Internal Virtual functions for NavigationLab Remote Query processing

Public Data Members

Public Member Functions

Pure virtual functions

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation