Kaim::BaseDiskExpansionQuery Class Reference
#include <basediskexpansionquery.h>
Inherits Kaim::IAtomicQuery.
Inherited by Kaim::DiskExpansionQuery< 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 >.
| 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::BaseDiskExpansionQuery::GetType |
( |
| ) |
const |
|
inlinevirtual |
| 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::IQuery::SetTraverseLogicUserData |
( |
void * |
traverseLogicUserData | ) |
|
|
inlineinherited |
| Vec3f Kaim::BaseDiskExpansionQuery::m_centerPos3f |
|
protected |
The position of the center of the disk.
The NavMesh triangle that corresponds to m_centerPos3f.
If a valid NavTrianglePtr is specified, this value will be used. If no value is specified, it will be automatically computed during the query.
Updated during processing to indicate the triangle edge that the disk collided with (if a collision is detected).
| Vec3f Kaim::BaseDiskExpansionQuery::m_collisionPos3f |
|
protected |
Updated during processing to indicate the position of the collision on the NavMesh border (if a collision is detected).
The database on which the query will be performed. Set in Initialize(), do not directly modify.
| Ptr<IOnDone> Kaim::IQuery::m_onDone |
|
inherited |
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.
A ref-counted Ptr to a QueryDynamicOutput instance, used to store the data encountered during the query process.
You have to first call SetDynamicOutputMode(), after BindToDatabase() that set m_dynamicOutputMode to QUERY_SAVE_NOTHING by default and before processing the query, to define the data type you want to gather. You can keep the Ptr for reuse and reassign it to another query by calling SetQueryDynamicOutput() after the BindToDatabase(), but in this case, be careful: the query may swap the underlying instance when processing if the provided buffer is to short. In this case, it is more sure to always update the Ptr when the query process is over.
| KyFloat32 Kaim::BaseDiskExpansionQuery::m_radiusMax |
|
protected |
The maximum radius for the disk. If the disk expands to this radius without a collision, the query stops.
Updated during processing to indicate the result of the query.
| KyFloat32 Kaim::BaseDiskExpansionQuery::m_resultRadius |
|
protected |
Updated during processing to indicate the final result of the disk at the end of the query:
- If no collision is detected, this value will match m_radiusMax.
- If a collision is detected, this value will be the largest valid radius that fits in the available space.
| KyFloat32 Kaim::BaseDiskExpansionQuery::m_safetyDist |
|
protected |
When a collision is detected, the radius is decreased by this distance, to ensure the final disk will lie completely within the valid area of the NavMesh.
units: meters
default value: 0.01
| 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: