Kaim::BaseAStarQuery Class Reference
#include <baseastarquery.h>
Base class for AstarQuery.
Inherits Kaim::IPathFinderQuery.
Inherited by Kaim::AStarQuery< TraverseLogic >.
|
| virtual void | Advance (WorkingMemory *workingMemory)=0 |
| |
|
|
static const char * | GetQueryTypeName (QueryType queryType) |
| |
| virtual void Kaim::IQuery::Advance |
( |
WorkingMemory * |
workingMemory | ) |
|
|
pure virtualinherited |
This function is called by the QueryQueue to process one step on the query.
It MUST NEVER, under any circumstances, take too long. As a guideline, consider 0.1ms as too long.
It is under the responsibility of this function to update m_processStatus. Obviously, if the query is atomic (i.e. not time-sliced), a 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::AStarQuery< TraverseLogic >, Kaim::BestGraphVertexPathFinderQuery< VertexFinderLogic >, Kaim::SpatializedPointCollectorInAABBQuery< SpatializedPointCollectorFilter >, Kaim::SpatializedPointCollectorInAABBQuery< Kaim::AvoidanceComputerCollectorFilter >, Kaim::SegmentCastQuery< TraverseLogic >, Kaim::DiskCastQuery< TraverseLogic >, Kaim::SegmentCanGoQuery< TraverseLogic >, Kaim::TriangleFromPosQuery, Kaim::DiskCanGoQuery< TraverseLogic >, Kaim::RayCastQuery< TraverseLogic >, Kaim::MultipleFloorTrianglesFromPosQuery, Kaim::RayCanGoQuery< TraverseLogic >, Kaim::MonodirectionalRayCanGoQuery< TraverseLogic >, Kaim::DiskExpansionQuery< TraverseLogic >, Kaim::InsidePosFromOutsidePosQuery< TraverseLogic >, Kaim::RayCastOnSegmentQuery< TraverseLogic >, Kaim::DynamicNavMeshQuery, Kaim::RayCanGoOnSegmentQuery< TraverseLogic >, Kaim::MoveOnNavMeshQuery< TraverseLogic >, Kaim::FindFirstVisiblePositionOnPathQuery< TraverseLogic >, Kaim::DiskCollisionQuery< TraverseLogic >, Kaim::CircleArcSplineComputationQuery, Kaim::TriangleFromPosAndTriangleSeedQuery, Kaim::NearestBorderHalfEdgeFromPosQuery< TraverseLogic >, Kaim::RayCastFull3dQuery, and Kaim::CollisionRayCastQuery.
| 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::BaseAStarQuery::DisplayPropagationBounds |
( |
ScopedDisplayList & |
| ) |
const |
|
virtual |
Fill the displayList with display info that may help to understand a PathFinderFailure (mainly propagation bounds)
Reimplemented from Kaim::IPathFinderQuery.
| const Vec3f * Kaim::BaseAStarQuery::GetDestination |
( |
| ) |
const |
|
inlinevirtual |
This function is virtual because not all the PathFinders have a preset destination, it may return KY_NULL.
Implements Kaim::IPathFinderQuery.
| virtual 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::ITimeSlicedQuery::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 the OnDone function of the IOnDone object if provided.
Called automatically by the QueryQueue during the World::Update() (in FlushQueries() step) when this query has been completed.
Not called if this query is canceled.
Note that the member m_onDone is reset to KY_NULL at the end of this function.
| void Kaim::IQuery::PerformQueryBlocking |
( |
WorkingMemory * |
workingMemory = 0 | ) |
|
|
inherited |
Process the query at once whether it is time-sliced or not.
- Parameters
-
| workingMemory | Sandbox memory used to perform queries. If let to KY_NULL, the m_database internal WorkingMemory is used. |
| virtual void Kaim::ITimeSlicedQuery::ReleaseWorkingMemoryOnCancelDuringProcess |
( |
WorkingMemory * |
workingMemory | ) |
|
|
pure virtualinherited |
| void Kaim::IQuery::SetTraverseLogicUserData |
( |
void * |
traverseLogicUserData | ) |
|
|
inlineinherited |
Should be set for queries templated by a traverse logic, useless otherwise.
| 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.
| KyUInt32 Kaim::IPathFinderQuery::m_dataBaseChangeIdx |
|
inherited |
Stores the revision of the Database when the Path has been computed.
| Vec3f Kaim::BaseAStarQuery::m_destInsidePos3f |
|
protected |
if m_destPos3f is slightly outside and we hook on the NavMesh, it is the computed inside pos, else it is equal to m_destPos3f.
| Vec3f Kaim::BaseAStarQuery::m_destPos3f |
|
protected |
The destination point for the path request.
The NavMesh triangle that corresponds to m_destPos3f.
If a valid NavTrianglePtr is specified, this value will be used.
If no value is specified, it will be automatically computed during the query.
As an input AND output parameter, this member is cleared during the Setup of the Query and should therefore be specified
| NavGraphEdgeDirection Kaim::BaseAStarQuery::m_navGraphEdgePathfindMode |
|
protected |
Whether we should pathfind on that edge both ways or not.
| 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.
Modified by the query within Advance().
Do not modify.
Before reading m_processStatus, always ensure IsInAQueryQueue() returns false.
| KyFloat32 Kaim::BaseAStarQuery::m_propagationBoxExtent |
|
protected |
the propagation is limited to a 2d oriented bounding box computed by inflating the segment going from startPos to destPos by this value
Updated during processing to indicate the result of the PathFinderQueryResult query.
| Vec3f Kaim::BaseAStarQuery::m_startInsidePos3f |
|
protected |
if m_startPos3f is slightly outside and we hook on the NavMesh, it is the computed inside pos, else it is equal to m_startPos3f.
When this NavGraph edge is valid, that means that you want the path to start with that edge.
When this NavGraph vertex is valid, that means that you want the path to start at that vertice.
| Vec3f Kaim::IPathFinderQuery::m_startPos3f |
|
inherited |
The starting position for the Path request.
The NavMesh triangle that corresponds to m_startPos3f.
If a valid NavTrianglePtr is specified, this value will be used.
If no value is specified, it will be automatically computed during the query.
As an input AND output parameter, this member is cleared during the Setup of the Query and should therefore be specified
| void* Kaim::IQuery::m_traverseLogicUserData |
|
inherited |
This userData is typically passed by the Bot.
The documentation for this class was generated from the following file:
Related help topics: