Kaim::CollisionRayCastQuery Class Reference
#include <collisionraycastquery.h>
Query that performs a 3D raycast against the physical geometry in a CollisionWorld.
As such, it does not represent passability like a RayCanGoQuery but whether there is a collision or not.
Provides a simple yes/no result (CollisionRayCastResult).
Inherits Kaim::IAtomicQuery.
|
| virtual void | Advance (WorkingMemory *workingMemory) |
| |
| void | PerformQuery (WorkingMemory *workingMemory=0) |
| |
|
|
CollisionRayCastResult | GetResult () const |
| |
|
const Vec3f & | GetStartPos () const |
| |
|
const Vec3f & | GetDestPos () const |
| |
|
|
static const char * | GetQueryTypeName (QueryType queryType) |
| |
| virtual void Kaim::CollisionRayCastQuery::Advance |
( |
WorkingMemory * |
workingMemory | ) |
|
|
virtual |
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::IQuery::BindToDatabase |
( |
Database * |
database | ) |
|
|
inlineinherited |
Should be called by the derived class before Initializing the query It sets m_database to the provided value.
It sets #m_userData to KY_NULL;
| void Kaim::CollisionRayCastQuery::BindToWorld |
( |
World * |
world | ) |
|
Associates the query to this world, 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::CollisionRayCastQuery::Initialize |
( |
const Vec3f & |
start, |
|
|
const Vec3f & |
dest |
|
) |
| |
Sets an instance of this class with minimum input requirements.
Clears all the input and output, lets all configuration parameters unchanged. They may be changed by calling the corresponding write accessors.
- Parameters
-
| startPos | Sets the value of #m_startPos3f. |
| destPos | Sets the value of #m_destPos3f. |
| 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::CollisionRayCastQuery::PerformQuery |
( |
WorkingMemory * |
workingMemory = 0 | ) |
|
Performs the query.
- Parameters
-
| workingMemory | Sandbox memory used to perform queries. |
| 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::IQuery::SetTraverseLogicUserData |
( |
void * |
traverseLogicUserData | ) |
|
|
inlineinherited |
Should be set for queries templated by a traverse logic, useless otherwise.
The database on which the query will be performed. Set in Initialize(), do not directly modify.
| Ptr<IOnDone> Kaim::IQuery::m_onDone |
|
inherited |
The optional IOnDone instance to be called. Must be set manually by the user. See IOnDone.
Modified by the query within Advance().
Do not modify.
Before reading m_processStatus, always ensure IsInAQueryQueue() returns false.
| 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: