Kaim::BaseDiskCanGoQuery Class Reference
#include <basediskcangoquery.h>
Base class for DiskCanGoQuery.
Inherits Kaim::IAtomicQuery.
Inherited by Kaim::DiskCanGoQuery< TraverseLogic >.
|
| virtual void | Advance (WorkingMemory *workingMemory)=0 |
| | This function is called by the QueryQueue to process one step on the query. More...
|
| |
| 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. |
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::BaseDiskCanGoQuery::BindToDatabase |
( |
Database * |
database | ) |
|
Binds the query with database, clears inputs and results, sets the configuration to defaults.
| 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::IQuery::GetTraverseLogicUserData |
( |
| ) |
const |
|
inlineinherited |
| virtual QueryType Kaim::BaseDiskCanGoQuery::GetType |
( |
| ) |
const |
|
inlinevirtual |
| void Kaim::BaseDiskCanGoQuery::Initialize |
( |
const Vec3f & |
startPos, |
|
|
const Vec3f & |
destPos, |
|
|
KyFloat32 |
radius |
|
) |
| |
| void Kaim::IQuery::Initialize |
( |
| ) |
|
|
inlineinherited |
| 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.
| 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::BaseDiskCanGoQuery::SetDestTrianglePtr |
( |
const NavTrianglePtr & |
destTrianglePtr | ) |
|
|
inline |
If no m_destTrianglePtr is set, it will be automatically computed from m_destPos3f. Cleared by Initialize().
| void Kaim::BaseDiskCanGoQuery::SetDynamicOutputMode |
( |
DynamicOutputMode |
dynamicOutputMode | ) |
|
|
inline |
range to compute trianglePtr from position.
Set to Database::GetPositionSpatializationRange() in BindToDatabase().
| void Kaim::BaseDiskCanGoQuery::SetQueryDynamicOutput |
( |
QueryDynamicOutput * |
queryDynamicOutput | ) |
|
|
inline |
Specifies how it behaves when the start disk cannot fit the navmesh.
Set to DISKCANGO_ADAPT_TO_STARTPOS in BindToDatabase().
| void Kaim::BaseDiskCanGoQuery::SetStartTrianglePtr |
( |
const NavTrianglePtr & |
startTrianglePtr | ) |
|
|
inline |
If no m_startTrianglePtr is set, it will be automatically computed from m_startPos3f. Cleared by Initialize().
| void Kaim::IQuery::SetTraverseLogicUserData |
( |
void * |
traverseLogicUserData | ) |
|
|
inlineinherited |
The database on which the query will be performed. Set in Initialize(), do not directly modify.
| Vec3f Kaim::BaseDiskCanGoQuery::m_destPos3f |
|
protected |
If no m_destTrianglePtr is set, it will be automatically computed from m_destPos3f. Cleared by Initialize().
| Ptr<IOnDone> Kaim::IQuery::m_onDone |
|
inherited |
The optional IOnDone instance to be called. Must be set manually by the user. See IOnDone.
range to compute trianglePtr from position.
Set to Database::GetPositionSpatializationRange() in BindToDatabase().
Modified by the query within Advance(). Do not modify.
Before reading m_processStatus, always ensure IsInAQueryQueue() returns false.
Specifies how it behaves when the start disk cannot fit the navmesh.
Set to DISKCANGO_ADAPT_TO_STARTPOS in BindToDatabase().
| Vec3f Kaim::BaseDiskCanGoQuery::m_startPos3f |
|
protected |
If no m_startTrianglePtr is set, it will be automatically computed from m_startPos3f. Cleared by Initialize().
| 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: