Kaim::RayCastQuery< TraverseLogic > Class Template Reference
#include <raycastquery.h>
template<class TraverseLogic>
class Kaim::RayCastQuery< TraverseLogic >
The RayCastQuery class tests whether a ray (with a width of 0) can be cast from a starting point (m_startPos3f) in a specified direction (#maxMove2D) without:
- a collision with the outside border of the NavMesh.
crossing a forbidden NavTag (a triangle whose NavTag is considered as non-traversable by the traverseLogic).
If a collision is found, the point of collision is recorded (m_collisionPos3f). If no collision is found, the ray stops at the maximum distance from the start point.
In either case, the last valid position along the ray is recorded in m_arrivalPos3f.
Inherits Kaim::BaseRayCastQuery.
|
|
| RayCastQuery () |
| |
|
virtual | ~RayCastQuery () |
| |
|
| virtual void | Advance (WorkingMemory *workingMemory) |
| |
| void | PerformQuery (WorkingMemory *workingMemory=0) |
| |
|
|
void | PerformQueryWithInputCoordPos (WorkingMemory *workingMemory) |
| |
|
void | SetStartIntegerPos (const WorldIntegerPos &startIntegerPos) |
| |
|
const WorldIntegerPos & | GetStartIntegerPos () const |
| |
|
const WorldIntegerPos & | GetArrivalIntegerPos () const |
| |
|
|
static const char * | GetQueryTypeName (QueryType queryType) |
| |
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. |
Implements Kaim::IQuery.
Binds the query with the specified Database, clears all the inputs and outputs and sets all other parameters to their default value (they may be changed by calling the corresponding write accessors.)
- Parameters
-
| database | A pointer to the Database on which the query must be performed. |
| 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.
Sets an instance of this class with minimum input requirements.
Clears all the output, and let all other parameters unchanged. They may be changed by calling the corresponding write accessors.
- Parameters
-
| void Kaim::IQuery::Initialize |
( |
| ) |
|
|
inlineinherited |
Should be called by the derived class before trying to perform the query or to push it in a QueryQueue.
The query must have been bound to a Database before.
It sets m_processStatus to Kaim::QueryNotStarted. As some query framework components (such as QueryQueue) relies on these members, you cannot call SetUp() unless CanBeInitialized() returns true.
| 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.
Performs the query.
- Parameters
-
| workingMemory | Sandbox memory used to perform queries. If let to KY_NULL, the m_database internal WorkingMemory is used. |
| 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. |
template<class TLogic >
| void Kaim::RayCastQuery< TLogic >::SetPositionSpatializationRange |
( |
const PositionSpatializationRange & |
positionSpatializationRange | ) |
|
|
inline |
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. Call this method after Initialize(), during which it is cleared.
| void Kaim::IQuery::SetTraverseLogicUserData |
( |
void * |
traverseLogicUserData | ) |
|
|
inlineinherited |
Should be set for queries templated by a traverse logic, useless otherwise.
| Vec3f Kaim::BaseRayCastQuery::m_arrivalPos3f |
|
protectedinherited |
Updated during processing to indicate the final position of the ray at the end of the cast.
- If no collision has been detected, this is the triangle arrived at by traversing the NavMesh in the direction of #maxMove2D.
- If a collision is detected, this point is derived from m_collisionPos3f by backtracking along the orientation of #maxMove2D. This tends to ensure that m_arrivalPos3f will be inside the boundaries of the NavMesh.
Updated during processing to indicate the NavMesh triangle that corresponds to m_arrivalPos3f.
Due to the imprecision of floating-point calculations, this triangle may be invalid even after moving m_arrivalPos3f back from the point of collision.
If a collision has been detected, this is updated to indicate the triangle edge that the ray collided with.
| Vec3f Kaim::BaseRayCastQuery::m_collisionPos3f |
|
protectedinherited |
Updated to indicate the position at which the ray collided with the NavMesh border or NavTag.
The database on which the query will be performed. Set in Initialize(), do not directly modify.
| Vec2f Kaim::BaseRayCastQuery::m_maxMove2D |
|
protectedinherited |
A vector that represents the direction and the maximum distance the ray will travel.
If this distance is too high (approximately 32 times the length of a NavCell), performing the query can result in an integer overflow during calculation: in such case the query quits early and sets m_result to RAYCAST_DONE_QUERY_TOO_LONG.
| Ptr<IOnDone> Kaim::IQuery::m_onDone |
|
inherited |
The optional IOnDone instance to be called. Must be set manually by the user. See IOnDone.
| PositionSpatializationRange Kaim::BaseRayCastQuery::m_positionSpatializationRange |
|
protectedinherited |
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 it 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.
Updated during processing to indicate the result of the query.
| Vec3f Kaim::BaseRayCastQuery::m_startPos3f |
|
protectedinherited |
The starting point of the line segment to be tested.
The NavMesh triangle that corresponds to m_startPos3f. You can set it as an input or retrieve it as an output 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: