Kaim::BaseMultiDestinationPathFinderQuery Class Reference

Kaim::BaseMultiDestinationPathFinderQuery Class Referenceabstract

#include <basemultidestinationpathfinderquery.h>

Class Description

Base class for MultiDestinationPathFinderQuery.

Inherits Kaim::ITimeSlicedQuery.

Inherited by Kaim::MultiDestinationPathFinderQuery< TraverseLogic >.

Public Member Functions

virtual QueryType GetType () const
 Get query type. More...
 
KyUInt32 GetFinalOutputMode () const
 possible returned values are defined by MultiDestinationPathFinderFinalOutput enum More...
 
void SetFinalOutputMode (KyUInt32 finalOutputMode)
 cf MultiDestinationPathFinderFinalOutput enum More...
 

Public Attributes

QueryProcessStatus m_processStatus
 Modified by the query within Advance(). Do not modify. More...
 
Ptr< IOnDonem_onDone
 The optional IOnDone instance to be called. Must be set manually by the user. See IOnDone. More...
 

Protected Attributes

PathFinderQueryComputeChannelMode m_computeChannelMode
 The mode toggling Channels computation. More...
 
ChannelComputerConfig m_channelComputerConfig
 The parameter set specific to Channels computation. More...
 
KyUInt32 m_finalOutputMode
 cf enum MultiDestinationPathFinderFinalOutput More...
 

For internal use only

PathGetRawPath (KyUInt32 destIdx) const
 

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 void Advance (WorkingMemory *workingMemory)=0
 This function is called by the QueryQueue to process one step on the query. More...
 

For internal use only

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

Functions

void Initialize ()
 Should be called by the derived class before trying to perform the query or to push it in a QueryQueue. More...
 

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 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
workingMemorySandbox memory used to perform queries.

Implemented in Kaim::DynamicNavMeshQuery, Kaim::SpatializedPointCollectorInAABBQuery< SpatializedPointCollectorFilter >, Kaim::SpatializedPointCollectorInAABBQuery< Kaim::AvoidanceComputerCollectorFilter >, Kaim::SegmentCastQuery< TraverseLogic >, Kaim::SegmentCanGoQuery< TraverseLogic >, Kaim::TriangleFromPosQuery, Kaim::DiskCastQuery< TraverseLogic >, Kaim::MultipleFloorTrianglesFromPosQuery, Kaim::BestGraphVertexPathFinderQuery< VertexFinderLogic >, Kaim::DiskExpansionQuery< TraverseLogic >, Kaim::RayCastOnSegmentQuery< TraverseLogic >, Kaim::CircleArcSplineComputationQuery, Kaim::AStarQuery< TraverseLogic >, Kaim::FindFirstVisiblePositionOnPathQuery< TraverseLogic >, Kaim::TriangleFromPosAndTriangleSeedQuery, Kaim::RayCastFull3dQuery, Kaim::CollisionRayCastQuery, Kaim::RayCastQuery< TraverseLogic >, Kaim::InsidePosFromOutsidePosQuery< TraverseLogic >, Kaim::MoveOnNavMeshQuery< TraverseLogic >, Kaim::NearestBorderHalfEdgeFromPosQuery< TraverseLogic >, Kaim::DiskCanGoQuery< TraverseLogic >, Kaim::RayCanGoOnSegmentQuery< TraverseLogic >, Kaim::DiskCollisionQuery< TraverseLogic >, Kaim::RayCanGoQuery< TraverseLogic >, and Kaim::MonodirectionalRayCanGoQuery< TraverseLogic >.

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.

KyUInt32 Kaim::BaseMultiDestinationPathFinderQuery::GetFinalOutputMode ( ) const
inline

possible returned values are defined by MultiDestinationPathFinderFinalOutput enum

void* Kaim::IQuery::GetTraverseLogicUserData ( ) const
inlineinherited
virtual QueryType Kaim::BaseMultiDestinationPathFinderQuery::GetType ( ) const
inlinevirtual

Get query type.

Implements Kaim::IQuery.

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 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
workingMemorySandbox 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::BaseMultiDestinationPathFinderQuery::SetFinalOutputMode ( KyUInt32  finalOutputMode)
inline

cf MultiDestinationPathFinderFinalOutput enum

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

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

Member Data Documentation

ChannelComputerConfig Kaim::BaseMultiDestinationPathFinderQuery::m_channelComputerConfig
protected

The parameter set specific to Channels computation.

PathFinderQueryComputeChannelMode Kaim::BaseMultiDestinationPathFinderQuery::m_computeChannelMode
protected

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::BaseMultiDestinationPathFinderQuery::m_finalOutputMode
protected

cf enum MultiDestinationPathFinderFinalOutput

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.

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.

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: