Kaim::BasePathFromPolylineQuery Class Reference
#include <basepathfrompolylinequery.h>
Base class for AstarQuery.
Inherits Kaim::IPathFinderQuery.
Inherited by Kaim::PathFromPolylineQuery< TraverseLogic >.
|
|
void | SetNavigationProfileId (KyUInt32 navigationProfileId) |
| |
|
KyUInt32 | GetNavigationProfileId () const |
| |
|
| virtual void | Advance (WorkingMemory *workingMemory)=0 |
| | This function is called by the QueryQueue to process one step on the query. More...
|
| |
|
|
virtual Ptr< BaseBlobHandler > | CreateQueryBlobHandler () |
| |
|
virtual void | BuildQueryBlob (Kaim::BaseBlobHandler *) |
| |
|
virtual void | InitFromQueryBlob (World *, void *) |
| |
|
| 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...
|
| |
| 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.
| virtual void Kaim::IPathFinderQuery::DisplayPropagationBounds |
( |
DisplayList & |
| ) |
const |
|
inlinevirtualinherited |
| const Vec3f * Kaim::BasePathFromPolylineQuery::GetDestination |
( |
| ) |
const |
|
inlinevirtual |
This function is virtual because not all the PathFinders have a preset destination, it may return nullptr.
Implements Kaim::IPathFinderQuery.
| void Kaim::BasePathFromPolylineQuery::GetPathFinderTextResult |
( |
String & |
| ) |
const |
|
virtual |
Fills the String with an explanation of the result. Use this to debug your pathfinder query.
Reimplemented from Kaim::IPathFinderQuery.
| void* Kaim::IQuery::GetTraverseLogicUserData |
( |
| ) |
const |
|
inlineinherited |
| virtual QueryType Kaim::BasePathFromPolylineQuery::GetType |
( |
| ) |
const |
|
inlinevirtual |
| 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.
| virtual void Kaim::ITimeSlicedQuery::ReleaseWorkingMemoryOnCancelDuringProcess |
( |
WorkingMemory * |
workingMemory | ) |
|
|
pure virtualinherited |
| 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 |
The parameter set specific to Channels computation.
The mode toggling Channels computation.
The database on which the query will be performed. Set in Initialize(), do not directly modify.
| KyUInt32 Kaim::BasePathFromPolylineQuery::m_numberOfIntersectionTestPerAdvance |
The number of intersections that will be processed each frame during the clamper part of the query.
| KyUInt32 Kaim::BasePathFromPolylineQuery::m_numberOfRayCastPerAdavance |
The number of CanGo tests that will be processed each frame during the refiner part of the query.
| 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 |
|
inherited |
The Path found by the query.
The altitude range used to find NavMesh triangles that correspond to the start and destination points.
Modified by the query within Advance(). Do not modify.
Before reading m_processStatus, always ensure IsInAQueryQueue() returns false.
Updated during processing to indicate the result of the PathFinderQueryResult query.
| Vec3f Kaim::IPathFinderQuery::m_startPos3f |
|
inherited |
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 files: