Kaim::RayCastQuery< TraverseLogic > Class Template Reference

#include <raycastquery.h>

Class Description

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.

Public Member Functions

virtual QueryType GetType () const
 Get query type. More...
 

Public Attributes

QueryProcessStatus m_processStatus
 Modified by the query within Advance(). Do not modify. More...
 
Ptr< IOnDonem_onDone
 The optional IOnDone instance to be called. Must be set manually by the user. See IOnDone. More...
 

Protected Attributes

Vec3f m_startPos3f
 The starting point of the line segment to be tested. More...
 
Vec3f m_collisionPos3f
 Updated to indicate the position at which the ray collided with the NavMesh border or NavTag. More...
 
Vec3f m_arrivalPos3f
 Updated during processing to indicate the final position of the ray at the end of the cast. More...
 
Vec2f m_maxMove2D
 A vector that represents the direction and the maximum distance the ray will travel. More...
 
NavTrianglePtr m_startTrianglePtr
 The NavMesh triangle that corresponds to m_startPos3f. You can set it as an input or retrieve it as an output of the query. More...
 
PositionSpatializationRange m_positionSpatializationRange
 The altitude range around the position to use when determining m_startTrianglePtr from the m_startPos3f. More...
 
NavTrianglePtr m_arrivalTrianglePtr
 Updated during processing to indicate the NavMesh triangle that corresponds to m_arrivalPos3f. More...
 
NavHalfEdgePtr m_collisionHalfEdgePtr
 If a collision has been detected, this is updated to indicate the triangle edge that the ray collided with. More...
 
RayCastQueryResult m_result
 Updated during processing to indicate the result of the query. More...
 
DynamicOutputMode m_dynamicOutputMode
 Specifies the type of data stored in m_queryDynamicOutput. More...
 
Ptr< QueryDynamicOutputm_queryDynamicOutput
 A ref-counted Ptr to a QueryDynamicOutput instance, used to store the data encountered during the query process. More...
 

Functions

 RayCastQuery ()
 
virtual ~RayCastQuery ()
 

Query framework functions

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...
 

For internal use only

void PerformQueryWithInputCoordPos (WorkingMemory *workingMemory)
 

Main API Functions

RayCastQueryResult GetResult () const
 
const Vec3fGetStartPos () const
 
const Vec3fGetCollisionPos () const
 
const Vec3fGetArrivalPos () const
 
const Vec2fGetMaxMove2D () const
 
const NavTrianglePtrGetStartTrianglePtr () const
 
const NavTrianglePtrGetArrivalTrianglePtr () const
 
const NavHalfEdgePtrGetCollisionNavHalfEdgePtr () const
 
DynamicOutputMode GetDynamicOutputMode () const
 
QueryDynamicOutputGetQueryDynamicOutput () const
 
const WorldIntegerPosGetStartIntegerPos () const
 
const WorldIntegerPosGetArrivalIntegerPos () const
 
const PositionSpatializationRangeGetPositionSpatializationRange () const
 
static CoordPos64 ResolveCollisionPointWhenPointsAreAligned (const CoordPos64 &edgeStartPos, const CoordPos64 &edgeEndPos, const CoordPos64 &startCoordPos64, const CoordPos64 &destCoordPos64)
 

For internal use only

void BindToDatabase (Database *database)
 
void Initialize (const Vec3f &startPos, const Vec2f &maxMove2D)
 
void SetStartTrianglePtr (const NavTrianglePtr &startTrianglePtr)
 
void SetPositionSpatializationRange (const PositionSpatializationRange &positionSpatializationRange)
 
void SetDynamicOutputMode (DynamicOutputMode dynamicOutputMode)
 
void SetQueryDynamicOutput (QueryDynamicOutput *queryDynamicOutput)
 
void SetStartIntegerPos (const WorldIntegerPos &startIntegerPos)
 
void SetResult (RayCastQueryResult result)
 

IQuery Functions

bool CanBeInitialized () const
 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. More...
 
bool IsInAQueryQueue () const
 Returns true if the query is currently registered in a QueryQueue. More...
 
bool IsSafeToReadResult () const
 Returns true if the query has been processed, is no longer in a queue, and OnDone (if there is one) has been called. More...
 
KyUInt32 PerformQueryBlocking (WorkingMemory *workingMemory=nullptr)
 Calls Advance() untill the query is done. More...
 
void OnDone ()
 Calls m_onDone IOnDone::OnDone() if m_onDone is not null. More...
 
KyResult SendVisualDebug ()
 Sends the query to the NavigationLab. More...
 
void SetTraverseLogicUserData (void *traverseLogicUserData)
 Sets m_traverseLogicUserData for queries that have a custom TraverseLogic, useless otherwise. More...
 
void * GetTraverseLogicUserData () const
 Gets m_traverseLogicUserData. More...
 

For internal use only

static const char * GetQueryTypeName (QueryType queryType)
 
Databasem_database
 The database on which the query will be performed. Set in Initialize(), do not directly modify. More...
 
void * m_traverseLogicUserData
 This userData is typically passed by the Bot. More...
 
QueryQueuem_queue
 Updated by the QueryQueue. Do not modify. More...
 
QueryStatusInQueue m_inQueueStatus
 Used by the QueryQueue. Do not modify. More...
 
KyUInt32 m_queryInfoId
 

Mandatory initialization calls to be done by derived classes

void Initialize ()
 Should be called by the derived class prior to perform the query or to push it in a QueryQueue. More...
 

Member Function Documentation

template<class TraverseLogic>
virtual void Kaim::RayCastQuery< TraverseLogic >::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
workingMemorySandbox 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::BaseRayCastQuery::GetType ( ) const
inlinevirtualinherited

Get query type.

Implements Kaim::IQuery.

void Kaim::IQuery::Initialize ( )
inlineinherited

Should be called by the derived class prior to perform the query or to push it in a QueryQueue.

BindToDatabase() must have been called once before. It sets m_processStatus to QueryNotStarted. The query can be pending or in-progress in a query queue, then calling Initialize() is an error. CanBeInitialized() can be called to test this.

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.

template<class TLogic >
void Kaim::RayCastQuery< TLogic >::PerformQuery ( WorkingMemory *  workingMemory = nullptr)
inline

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
workingMemorySandbox 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

Sets m_traverseLogicUserData for queries that have a custom TraverseLogic, useless otherwise.

Member Data Documentation

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 m_maxMove2D.
  • If a collision is detected, this point is derived from m_collisionPos3f by backtracking along the orientation of m_maxMove2D. This tends to ensure that m_arrivalPos3f will be inside the boundaries of the NavMesh.
NavTrianglePtr Kaim::BaseRayCastQuery::m_arrivalTrianglePtr
protectedinherited

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.

NavHalfEdgePtr Kaim::BaseRayCastQuery::m_collisionHalfEdgePtr
protectedinherited

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.

Database* Kaim::IQuery::m_database
inherited

The database on which the query will be performed. Set in Initialize(), do not directly modify.

DynamicOutputMode Kaim::BaseRayCastQuery::m_dynamicOutputMode
protectedinherited

Specifies the type of data stored in m_queryDynamicOutput.

QueryStatusInQueue Kaim::IQuery::m_inQueueStatus
inherited

Used by the QueryQueue. Do not 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

The altitude range around the position to use when determining m_startTrianglePtr from the m_startPos3f.

QueryProcessStatus Kaim::IQuery::m_processStatus
inherited

Modified by the query within Advance(). Do not modify.

Before reading m_processStatus, always ensure IsInAQueryQueue() returns false.

Ptr<QueryDynamicOutput> Kaim::BaseRayCastQuery::m_queryDynamicOutput
protectedinherited

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.

QueryQueue* Kaim::IQuery::m_queue
inherited

Updated by the QueryQueue. Do not modify.

RayCastQueryResult Kaim::BaseRayCastQuery::m_result
protectedinherited

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.

NavTrianglePtr Kaim::BaseRayCastQuery::m_startTrianglePtr
protectedinherited

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: