Kaim::MonodirectionalRayCanGoQuery< TraverseLogic > Class Template Reference

Kaim::MonodirectionalRayCanGoQuery< TraverseLogic > Class Template Reference

#include <monodirectionalraycangoquery.h>

Class Description

template<class TraverseLogic>
class Kaim::MonodirectionalRayCanGoQuery< TraverseLogic >

The MonodirectionalRayCanGoQuery is an internal version of the RayCanGoQuery that tests navTag switch along the ray It is used internally in the AstarQuery (refining) to deal with one-way navTagTransition.

Inherits Kaim::BaseRayCanGoQuery.

Public Member 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...
 
void PerformQueryWithInputCoordPos (WorkingMemory *workingMemory)
 Performs the query after SetStartIntegerPos() and SetDestIntegerPos() were called. More...
 
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...
 

BindToDatabase

void BindToDatabase (Database *database)
 Binds the query with database, clears inputs and results, sets the configuration to defaults. More...
 

input setters

void Initialize (const Vec3f &startPos, const Vec3f &destPos)
 Sets m_startPos3f, m_destPos3f. Clears inputs and results, leaves configuration unchanged. More...
 
void SetStartTrianglePtr (const NavTrianglePtr &startTrianglePtr)
 If no m_startTrianglePtr is set, it will be automatically computed from m_startPos3f. Cleared by Initialize(). More...
 
void SetDestTrianglePtr (const NavTrianglePtr &destTrianglePtr)
 If no m_destTrianglePtr is set, it will be automatically computed from m_destPos3f. Cleared by Initialize(). More...
 
void SetQueryDynamicOutput (QueryDynamicOutput *queryDynamicOutput)
 Will receive and store the dynamic data collected during the query process. More...
 
void SetStartIntegerPos (const WorldIntegerPos &startIntegerPos)
 
void SetDestIntegerPos (const WorldIntegerPos &destIntegerPos)
 

configuration setters

void SetPositionSpatializationRange (const PositionSpatializationRange &range)
 range to compute trianglePtr from position. More...
 
void SetDynamicOutputMode (DynamicOutputMode dynamicOutputMode)
 What type of data to collect and store in m_queryDynamicOutput. More...
 
void SetMarginMode (RayCanGoMarginMode marginMode)
 The margin mode to be used in this query to eventually ensure the ray is not too close to any NavMesh border. More...
 
void SetComputeCostMode (ComputeCostMode computeCostMode)
 Determines whether or not the query computes the approximate cost of following the line segment. More...
 

results getter

RayCanGoQueryResult GetResult () const
 
QueryDynamicOutputGetQueryDynamicOutput () const
 
KyFloat32 GetComputedCost () const
 

inputs getters

const Vec3fGetStartPos () const
 
const Vec3fGetDestPos () const
 
const NavTrianglePtrGetStartTrianglePtr () const
 
const NavTrianglePtrGetDestTrianglePtr () const
 
WorldIntegerPos GetStartIntegerPos () const
 
WorldIntegerPos GetDestIntegerPos () const
 

configuration getters

DynamicOutputMode GetDynamicOutputMode () const
 
const PositionSpatializationRangeGetPositionSpatializationRange () const
 
ComputeCostMode GetComputeCostMode () const
 
RayCanGoMarginMode GetMarginMode () const
 

inputs

Vec3f m_startPos3f
 The start position. Set by Initialize(). More...
 
NavTrianglePtr m_startTrianglePtr
 If no m_startTrianglePtr is set, it will be automatically computed from m_startPos3f. Cleared by Initialize(). More...
 
WorldIntegerPos m_startIntegerPos
 
Vec3f m_destPos3f
 The destination position. Set by Initialize(). More...
 
NavTrianglePtr m_destTrianglePtr
 If no m_destTrianglePtr is set, it will be automatically computed from m_destPos3f. Cleared by Initialize(). More...
 
WorldIntegerPos m_destIntegerPos
 

configuration

PositionSpatializationRange m_positionSpatializationRange
 range to compute trianglePtr from position. More...
 
DynamicOutputMode m_dynamicOutputMode
 What type of data to collect and store in m_queryDynamicOutput. More...
 
RayCanGoMarginMode m_marginMode
 The margin mode to be used in this query to eventually ensure the ray is not too close to any NavMesh border. More...
 
ComputeCostMode m_computeCostMode
 Determines whether or not the query computes the approximate cost of following the line segment. More...
 

results

RayCanGoQueryResult m_result
 Set to RAYCANGO_NOT_PROCESSED in Initialize(). More...
 
KyFloat32 m_cost
 Updated during processing to store the cost of the line segment, if enabled by m_computeCostMode. More...
 
Ptr< QueryDynamicOutputm_queryDynamicOutput
 Will receive and store the dynamic data collected during the query process. More...
 

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

void Kaim::BaseRayCanGoQuery::BindToDatabase ( Database database)
inherited

Binds the query with database, clears inputs and results, sets the configuration to defaults.

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::BaseRayCanGoQuery::GetType ( ) const
inlinevirtualinherited

Get query type.

Implements Kaim::IQuery.

void Kaim::BaseRayCanGoQuery::Initialize ( const Vec3f startPos,
const Vec3f destPos 
)
inherited

Sets m_startPos3f, m_destPos3f. Clears inputs and results, leaves configuration unchanged.

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::MonodirectionalRayCanGoQuery< 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.
template<class TLogic >
void Kaim::MonodirectionalRayCanGoQuery< TLogic >::PerformQueryWithInputCoordPos ( WorkingMemory *  workingMemory)
inline

Performs the query after SetStartIntegerPos() and SetDestIntegerPos() were called.

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::BaseRayCanGoQuery::SetComputeCostMode ( ComputeCostMode  computeCostMode)
inlineinherited

Determines whether or not the query computes the approximate cost of following the line segment.

If set to QUERY_COMPUTE_COST_ALONG_3DAXIS, the cost is calculated and stored in m_cost.

void Kaim::BaseRayCanGoQuery::SetDestTrianglePtr ( const NavTrianglePtr destTrianglePtr)
inlineinherited

If no m_destTrianglePtr is set, it will be automatically computed from m_destPos3f. Cleared by Initialize().

void Kaim::BaseRayCanGoQuery::SetDynamicOutputMode ( DynamicOutputMode  dynamicOutputMode)
inlineinherited

What type of data to collect and store in m_queryDynamicOutput.

Set to QUERY_SAVE_NOTHING in BindToDatabase().

void Kaim::BaseRayCanGoQuery::SetMarginMode ( RayCanGoMarginMode  marginMode)
inlineinherited

The margin mode to be used in this query to eventually ensure the ray is not too close to any NavMesh border.

void Kaim::BaseRayCanGoQuery::SetPositionSpatializationRange ( const PositionSpatializationRange range)
inlineinherited

range to compute trianglePtr from position.

Set to Database::GetPositionSpatializationRange() in BindToDatabase().

void Kaim::BaseRayCanGoQuery::SetQueryDynamicOutput ( QueryDynamicOutput queryDynamicOutput)
inlineinherited

Will receive and store the dynamic data collected during the query process.

Use SetDynamicOutputMode() to indicate what data to store. You pass an existing QueryDynamicOutput by calling SetQueryDynamicOutput() after Initialize(), but m_queryDynamicOutput can be assigned to a new QueryDynamicOutput instance if the memory is not big enough to hold the collected data. Set to nullptr in Initialize().

void Kaim::BaseRayCanGoQuery::SetStartTrianglePtr ( const NavTrianglePtr startTrianglePtr)
inlineinherited

If no m_startTrianglePtr is set, it will be automatically computed from m_startPos3f. Cleared by Initialize().

void Kaim::IQuery::SetTraverseLogicUserData ( void *  traverseLogicUserData)
inlineinherited

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

Member Data Documentation

ComputeCostMode Kaim::BaseRayCanGoQuery::m_computeCostMode
protectedinherited

Determines whether or not the query computes the approximate cost of following the line segment.

If set to QUERY_COMPUTE_COST_ALONG_3DAXIS, the cost is calculated and stored in m_cost.

KyFloat32 Kaim::BaseRayCanGoQuery::m_cost
protectedinherited

Updated during processing to store the cost of the line segment, if enabled by m_computeCostMode.

Database* Kaim::IQuery::m_database
inherited

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

Vec3f Kaim::BaseRayCanGoQuery::m_destPos3f
protectedinherited

The destination position. Set by Initialize().

NavTrianglePtr Kaim::BaseRayCanGoQuery::m_destTrianglePtr
protectedinherited

If no m_destTrianglePtr is set, it will be automatically computed from m_destPos3f. Cleared by Initialize().

DynamicOutputMode Kaim::BaseRayCanGoQuery::m_dynamicOutputMode
protectedinherited

What type of data to collect and store in m_queryDynamicOutput.

Set to QUERY_SAVE_NOTHING in BindToDatabase().

QueryStatusInQueue Kaim::IQuery::m_inQueueStatus
inherited

Used by the QueryQueue. Do not modify.

RayCanGoMarginMode Kaim::BaseRayCanGoQuery::m_marginMode
protectedinherited

The margin mode to be used in this query to eventually ensure the ray is not too close to any NavMesh border.

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::BaseRayCanGoQuery::m_positionSpatializationRange
protectedinherited

range to compute trianglePtr from position.

Set to Database::GetPositionSpatializationRange() in BindToDatabase().

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::BaseRayCanGoQuery::m_queryDynamicOutput
protectedinherited

Will receive and store the dynamic data collected during the query process.

Use SetDynamicOutputMode() to indicate what data to store. You pass an existing QueryDynamicOutput by calling SetQueryDynamicOutput() after Initialize(), but m_queryDynamicOutput can be assigned to a new QueryDynamicOutput instance if the memory is not big enough to hold the collected data. Set to nullptr in Initialize().

QueryQueue* Kaim::IQuery::m_queue
inherited

Updated by the QueryQueue. Do not modify.

RayCanGoQueryResult Kaim::BaseRayCanGoQuery::m_result
protectedinherited

Set to RAYCANGO_NOT_PROCESSED in Initialize().

Vec3f Kaim::BaseRayCanGoQuery::m_startPos3f
protectedinherited

The start position. Set by Initialize().

NavTrianglePtr Kaim::BaseRayCanGoQuery::m_startTrianglePtr
protectedinherited

If no m_startTrianglePtr is set, it will be automatically computed from m_startPos3f. Cleared by Initialize().

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: