Kaim::IQuery Class Reference
#include <iquery.h>
Abstract class for all queries.
Inherits Kaim::RefCountBase< C, Stat >.
Inherited by Kaim::IAtomicQuery, and Kaim::ITimeSlicedQuery.
|
|
virtual Ptr< BaseBlobHandler > | CreateQueryBlobHandler () |
| |
|
virtual void | BuildQueryBlob (Kaim::BaseBlobHandler *) |
| |
|
virtual void | InitFromQueryBlob (World *, void *) |
| |
| virtual void Kaim::IQuery::Advance |
( |
WorkingMemory * |
workingMemory | ) |
|
|
pure virtual |
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. |
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 >.
| void Kaim::IQuery::BindToDatabase |
( |
Database * |
database | ) |
|
|
inline |
| bool Kaim::IQuery::CanBeInitialized |
( |
| ) |
const |
|
inline |
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::IQuery::GetTraverseLogicUserData |
( |
| ) |
const |
|
inline |
| virtual QueryType Kaim::IQuery::GetType |
( |
| ) |
const |
|
pure virtual |
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.
| void Kaim::IQuery::Initialize |
( |
| ) |
|
|
inline |
| bool Kaim::IQuery::IsInAQueryQueue |
( |
| ) |
const |
|
inline |
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 |
|
inline |
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 |
( |
| ) |
|
|
inline |
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 | ) |
|
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.
| KyResult Kaim::IQuery::SendVisualDebug |
( |
| ) |
|
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 | ) |
|
|
inline |
The database on which the query will be performed. Set in Initialize(), do not directly modify.
| Ptr<IOnDone> Kaim::IQuery::m_onDone |
The optional IOnDone instance to be called. Must be set manually by the user. See IOnDone.
Modified by the query within Advance(). Do not modify.
Before reading m_processStatus, always ensure IsInAQueryQueue() returns false.
| void* Kaim::IQuery::m_traverseLogicUserData |
This userData is typically passed by the Bot.
The documentation for this class was generated from the following files:
- gwnavruntime/querysystem/iquery.h
- gwnavruntime/querysystem/iquery.cpp
Related help topics: