Kaim::InsidePosFromOutsidePosQuery< TraverseLogic > Class Template Reference
#include <insideposfromoutsideposquery.h>
template<class TraverseLogic>
class Kaim::InsidePosFromOutsidePosQuery< TraverseLogic >
The InsidePosFromOutsidePosQuery class finds a valid position inside the boundaries of the NavMesh, at a specified distance from the NavMesh boundary (by boundary we mean hole in the NavMesh.
or forbidden NavTag boundary). There are two available modes fore retrieving this "inside navmesh" position :
- INSIDEPOSFROMOUTSIDE_FROM_NEAREST_HALFEDGE : Retrieve the nearest NavMesh boundary the to the specified input position (m_inputPos3f) and computes an inside position from it.
- INSIDEPOSFROMOUTSIDE_FROM_RAYCAST : Retrieve the NavMesh boundary the nearest to the specified input position (m_inputPos3f) that collides in 2D with a ray going from the specified input position (m_inputPos3f) in the specified input direction (m_castDirection) and computes an inside position from it. This query is typically used to retrieve a valid NavMesh position from an input position lying outside the (X,Y) boundaries of the NavMesh. It can also be used with an input position that is inside the NavMesh. In either case, it finds a NavMesh boundary and then deduces a point inside that boundary. The search space is constrained within an axis-aligned bounding box centered on m_inputPos3f. The horizontal width of the bounding box is equal to 2 * m_horizontalTolerance along both the X and Y axes. The vertical height of the bounding box is retrieved from m_positionSpatializationRange. If a NavMesh boundary is found within the search space, and a valid position can be found near that boundary, the position is written to m_insidePos3f, and the triangle that contains the output position is written to m_insidePosTrianglePtr.
Inherits Kaim::BaseInsidePosFromOutsidePosQuery.
|
| virtual void | Advance (WorkingMemory *workingMemory) |
| | This function is called by the QueryQueue to process one step on the query. More...
|
| |
| void | PerformQuery (WorkingMemory *workingMemory=nullptr) |
| | If workingMemory param is nullptr, m_database.GetWorkingMemory() will be used. More...
|
| |
|
|
void | PerformQueryWithInputCoordPos (WorkingMemory *workingMemory) |
| |
|
KyResult | RetrieveNearestBorderHalfEdge (WorkingMemory *workingMemory, NavHalfEdgeRawPtr &borderHalfEdgeRawPtr, NavHalfEdgeRawPtr &prevBorderHalfEdgeRawPtr, NavHalfEdgeRawPtr &nextBorderHalfEdgeRawPtr, Vec3f &posOnBorderEdge, WorldIntegerPos &integerPosOnBorderEdge) |
| |
|
KyResult | RetrieveBorderHalfEdgeWithRayCast (WorkingMemory *workingMemory, NavHalfEdgeRawPtr &borderHalfEdgeRawPtr, NavHalfEdgeRawPtr &prevBorderHalfEdgeRawPtr, NavHalfEdgeRawPtr &nextBorderHalfEdgeRawPtr, Vec3f &posOnBorderEdge, WorldIntegerPos &integerPosOnBorderEdge) |
| |
template<class TraverseLogic >
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. |
Implements Kaim::IQuery.
| 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::BaseInsidePosFromOutsidePosQuery::GetType |
( |
| ) |
const |
|
inlinevirtualinherited |
| 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.
If workingMemory param is nullptr, m_database.GetWorkingMemory() will be used.
| 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 |
The database on which the query will be performed. Set in Initialize(), do not directly modify.
| KyFloat32 Kaim::BaseInsidePosFromOutsidePosQuery::m_distFromObstacle |
|
protectedinherited |
Specifies a preferred distance between the final chosen point and the border of the NavMesh.
If this value is specified, the query will attempt to find a final valid point that is this distance inside the border of the NavMesh. However, in some cases, the layout of the geometry may force the final valid point to be closer to the NavMesh border than this value.
| KyFloat32 Kaim::BaseInsidePosFromOutsidePosQuery::m_horizontalTolerance |
|
protectedinherited |
The horizontal half-width (along both the X and Y axes) of the axis-aligned bounding box within which the search is performed.
| Vec3f Kaim::BaseInsidePosFromOutsidePosQuery::m_inputPos3f |
|
protectedinherited |
The starting position for the query.
| Vec3f Kaim::BaseInsidePosFromOutsidePosQuery::m_insidePos3f |
|
protectedinherited |
Updated during processing to store the valid point found inside the NavMesh, if any.
| NavTrianglePtr Kaim::BaseInsidePosFromOutsidePosQuery::m_insidePosTrianglePtr |
|
protectedinherited |
Updated during processing to store the NavMesh triangle that contains m_insidePos3f.
| Ptr<IOnDone> Kaim::IQuery::m_onDone |
|
inherited |
The optional IOnDone instance to be called. Must be set manually by the user. See IOnDone.
The Z extent from m_inputPos3f of the axis-aligned bounding box within which the search is performed.
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 query.
| 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:
Related help topics: