Kaim::RayCastFull3dQuery Class Reference
#include <raycastfull3dquery.h>
RayCast in full 3d useful for implementing picking on NavMesh.
However, it is not suited to replace a 3d raycast on geometry, since it doesn't detect walls.
Inherits Kaim::IAtomicQuery.
|
|
| RayCastFull3dQuery () |
| |
|
virtual | ~RayCastFull3dQuery () |
| |
|
| void | 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.) More...
|
| |
| void | Initialize (const Vec3f &startPos, const Vec3f &destPos) |
| | resets an initialized instance of this class with minimum input requirements. More...
|
| |
|
| 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...
|
| |
|
|
virtual Ptr< BaseBlobHandler > | CreateQueryBlobHandler () |
| |
|
virtual void | BuildQueryBlob (Kaim::BaseBlobHandler *) |
| |
|
virtual void | InitFromQueryBlob (World *, void *) |
| |
| virtual void Kaim::RayCastFull3dQuery::Advance |
( |
WorkingMemory * |
workingMemory | ) |
|
|
inlinevirtual |
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.
| void Kaim::RayCastFull3dQuery::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::IQuery::GetTraverseLogicUserData |
( |
| ) |
const |
|
inlineinherited |
| virtual QueryType Kaim::RayCastFull3dQuery::GetType |
( |
| ) |
const |
|
inlinevirtual |
| void Kaim::RayCastFull3dQuery::Initialize |
( |
const Vec3f & |
startPos, |
|
|
const Vec3f & |
destPos |
|
) |
| |
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.
| 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.
| void Kaim::RayCastFull3dQuery::PerformQuery |
( |
WorkingMemory * |
workingMemory = nullptr | ) |
|
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 |
| Vec3f Kaim::RayCastFull3dQuery::m_collisionPoint3f |
The database on which the query will be performed. Set in Initialize(), do not directly modify.
| Vec3f Kaim::RayCastFull3dQuery::m_destPos3f |
| 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.
Updated during processing to indicate the result of the query.
| Vec3f Kaim::RayCastFull3dQuery::m_startPos3f |
| 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: