Kaim::BaseAStarQuery Class Reference
#include <baseastarquery.h>
Base class for AstarQuery.
Inherits Kaim::IPathFinderQuery.
Inherited by Kaim::AStarQuery< TraverseLogic >.
|
|
void | SetNavigationProfileId (KyUInt32 navigationProfileId) |
| |
|
KyUInt32 | GetNavigationProfileId () const |
| |
|
| virtual QueryType | GetType () const |
| | Get query type. More...
|
| |
|
virtual void | BuildQueryBlob (BaseBlobHandler *blobHandler) |
| |
|
virtual void | InitFromQueryBlob (World *world, void *blob) |
| |
|
virtual Ptr< BaseBlobHandler > | CreateQueryBlobHandler () |
| |
|
|
void | ComputePathRefinerConfigInternals () |
| |
|
const PathRefinerConfig & | GetPathRefinerConfig () const |
| |
|
| virtual void | Advance (WorkingMemory *workingMemory)=0 |
| | This function is called by the QueryQueue to process one step on the query. More...
|
| |
|
| 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 >.
| void Kaim::BaseAStarQuery::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::BaseAStarQuery::DisplayPropagationBounds |
( |
DisplayList & |
| ) |
const |
|
virtual |
Fill the displayList with display info that may help to understand a PathFinderFailure (mainly propagation bounds)
Reimplemented from Kaim::IPathFinderQuery.
| virtual const Vec3f* Kaim::BaseAStarQuery::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::BaseAStarQuery::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::BaseAStarQuery::GetType |
( |
| ) |
const |
|
inlinevirtual |
| void Kaim::BaseAStarQuery::Initialize |
( |
const Vec3f & |
startPos, |
|
|
const Vec3f & |
destPos |
|
) |
| |
Clears inputs and results, leaves configuration unchanged.
| 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::BaseAStarQuery::SetDestNavGraphEdgePtr |
( |
const NavGraphEdgePtr & |
destNavGraphEdgePtr, |
|
|
NavGraphEdgeDirection |
destNavGraphEdgeDirection |
|
) |
| |
|
inline |
Sets destination inside a NavGraphEdge. destNavGraphEdgeDirection specifies if query can start in reverse edge if it exists.
| void Kaim::BaseAStarQuery::SetDestNavGraphVertexPtr |
( |
const NavGraphVertexPtr & |
destNavGraphVertexPtr | ) |
|
|
inline |
Sets destination to a NavGraphVertex.
| void Kaim::BaseAStarQuery::SetDestTrianglePtr |
( |
const NavTrianglePtr & |
destTrianglePtr | ) |
|
|
inline |
If no destTrianglePtr is set, it will be automatically computed during the query. Optional input.
| void Kaim::BaseAStarQuery::SetStartNavGraphEdgePtr |
( |
const NavGraphEdgePtr & |
startNavGraphEdgePtr, |
|
|
NavGraphEdgeDirection |
startNavGraphEdgeDirection |
|
) |
| |
|
inline |
Sets start inside a NavGraphEdge. if startNavGraphEdgeDirection specifies if query can start in reverse edge if it exists.
| void Kaim::BaseAStarQuery::SetStartNavGraphVertexPtr |
( |
const NavGraphVertexPtr & |
startNavGraphVertexPtr | ) |
|
|
inline |
Sets start to a NavGraphVertex. Optional input.
| void Kaim::BaseAStarQuery::SetStartTrianglePtr |
( |
const NavTrianglePtr & |
startTrianglePtr | ) |
|
|
inline |
If no startTrianglePtr is set, it will be automatically computed during the query.
| void Kaim::IQuery::SetTraverseLogicUserData |
( |
void * |
traverseLogicUserData | ) |
|
|
inlineinherited |
| PathFinderAbstractGraphTraversalMode Kaim::BaseAStarQuery::m_abstractGraphTraversalMode |
|
protected |
default PATHFINDER_TRAVERSE_ABSTRACT_GRAPHS
| Ptr<Path> Kaim::BaseAStarQuery::m_abstractPath |
|
protected |
The Abstract Path found by the query.
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.
| Vec3f Kaim::BaseAStarQuery::m_destInsidePos3f |
|
protected |
if m_destInsidePos3f is outside NavMesh it is the computed inside pos in the 2d range of m_toOutsideNavMeshDistance
| NavGraphEdgeDirection Kaim::BaseAStarQuery::m_destNavGraphEdgeDirection |
|
protected |
if NAVGRAPHEDGE_BIDIRECTIONAL query ends also inside m_startNavGraphEdgePtr reverse edge if it exists.
if valid, query ends inside a NavGraphEdge
if valid, query ends at m_startNavGraphVertexPtr
| Vec3f Kaim::BaseAStarQuery::m_destPos3f |
|
protected |
The destination position.
If no m_destTrianglePtr is set, it will be automatically computed from m_destPos3f.
| 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.
default PathClamperFlag_ClampAll
Modified by the query within Advance(). Do not modify.
Before reading m_processStatus, always ensure IsInAQueryQueue() returns false.
| KyFloat32 Kaim::BaseAStarQuery::m_propagationBoxExtent |
|
protected |
limits propagation to the (start-dest) segment inflated by m_propagationBoxExtent. default 200.0f
Updated during processing to indicate the result of the PathFinderQueryResult query.
| Vec3f Kaim::BaseAStarQuery::m_startInsidePos3f |
|
protected |
if m_startPos3f is outside NavMesh it is the computed inside pos in the 2d range of m_fromOutsideNavMeshDistance
| NavGraphEdgeDirection Kaim::BaseAStarQuery::m_startNavGraphEdgeDirection |
|
protected |
if NAVGRAPHEDGE_BIDIRECTIONAL query starts also inside m_startNavGraphEdgePtr reverse edge if it exists.
if valid, query starts inside a NavGraphEdge
if valid, query starts at m_startNavGraphVertexPtr
| Vec3f Kaim::IPathFinderQuery::m_startPos3f |
|
inherited |
The starting position for the Path request.
If no m_startTrianglePtr is set, it will be automatically computed from m_startPos3f.
| void* Kaim::IQuery::m_traverseLogicUserData |
|
inherited |
This userData is typically passed by the Bot.
default PATHFINDER_TRY_RAYCANGO_IF_NO_COST
The documentation for this class was generated from the following files:
- gwnavruntime/queries/utils/baseastarquery.h
- gwnavruntime/queries/utils/baseastarquery.cpp
Examples: