Kaim::TriangleFromPosQuery Class Reference
#include <trianglefromposquery.h>
The TriangleFromPosQuery class takes a position in the 3D space (m_inputPos3f), and finds the nearest triangle in the NavMesh that covers the same (X,Y) coordinates.
The search can look above and below the position at the same time, or it can be limited to above- or below-only.
If a triangle is found, it is written to m_resultTrianglePtr.
Inherits Kaim::IAtomicQuery.
|
|
| TriangleFromPosQuery () |
| |
|
virtual | ~TriangleFromPosQuery () |
| |
|
| virtual void | Advance (WorkingMemory *workingMemory) |
| |
| void | PerformQuery (WorkingMemory *workingMemory=0) |
| |
|
|
void | SetInputIntegerPos (const WorldIntegerPos &integerPos) |
| |
|
const WorldIntegerPos & | GetInputIntegerPos () const |
| |
|
void | PerformQueryWithInputCoordPos (WorkingMemory *workingMemory) |
| |
|
|
static const char * | GetQueryTypeName (QueryType queryType) |
| |
| void Kaim::TriangleFromPosQuery::Advance |
( |
WorkingMemory * |
workingMemory | ) |
|
|
inlinevirtual |
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.
| void Kaim::TriangleFromPosQuery::BindToDatabase |
( |
Database * |
database | ) |
|
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.
| void Kaim::TriangleFromPosQuery::Initialize |
( |
const Vec3f & |
pos | ) |
|
resets an initialized 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.
| void Kaim::TriangleFromPosQuery::PerformQuery |
( |
WorkingMemory * |
workingMemory = 0 | ) |
|
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. |
| void Kaim::TriangleFromPosQuery::SetPositionSpatializationRange |
( |
const PositionSpatializationRange & |
positionSpatializationRange | ) |
|
|
inline |
| void Kaim::IQuery::SetTraverseLogicUserData |
( |
void * |
traverseLogicUserData | ) |
|
|
inlineinherited |
Should be set for queries templated by a traverse logic, useless otherwise.
| KyFloat32 Kaim::TriangleFromPosQuery::m_altitudeInTriangle |
|
private |
The database on which the query will be performed. Set in Initialize(), do not directly modify.
| Vec3f Kaim::TriangleFromPosQuery::m_inputPos3f |
|
private |
The position on the (X,Y) plane used to retrieve the nearest triangle.
| 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::TriangleFromPosQuery::m_positionSpatializationRange |
|
private |
The altitude tolerance around m_inputPos3f that will be searched for triangles.
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: