Kaim::BaseDiskCanGoQuery Class Reference

Kaim::BaseDiskCanGoQuery Class Referenceabstract

#include <basediskcangoquery.h>

Class Description

Base class for DiskCanGoQuery.

Inherits Kaim::IAtomicQuery.

Inherited by Kaim::DiskCanGoQuery< TraverseLogic >.

Public Attributes

Databasem_database
 
QueryStatusInQueue m_inQueueStatus
 
QueryQueuem_queue
 
void * m_traverseLogicUserData
 

Protected Attributes

Vec3f m_destPos3f
 
NavTrianglePtr m_destTrianglePtr
 
DynamicOutputMode m_dynamicOutputMode
 
PositionSpatializationRange m_positionSpatializationRange
 
Ptr< QueryDynamicOutputm_queryDynamicOutput
 
DiskCanGoQueryType m_queryType
 
KyFloat32 m_radius
 
DiskCanGoQueryResult m_result
 
Vec3f m_startPos3f
 
NavTrianglePtr m_startTrianglePtr
 

Main API functions

DiskCanGoQueryResult GetResult () const
 
const Vec3fGetStartPos () const
 
const Vec3fGetDestPos () const
 
const NavTrianglePtrGetStartTrianglePtr () const
 
const NavTrianglePtrGetDestTrianglePtr () const
 
KyFloat32 GetRadius () const
 
DiskCanGoQueryType GetQueryType () const
 
DynamicOutputMode GetDynamicOutputMode () const
 
QueryDynamicOutputGetQueryDynamicOutput () const
 
const WorldIntegerPosGetStartIntegerPos () const
 
const WorldIntegerPosGetDestIntegerPos () const
 
const PositionSpatializationRange & GetPositionSpatializationRange () const
 

Main API Functions

bool CanBeInitialized () const
 
bool IsInAQueryQueue () const
 
bool IsSafeToReadResult () const
 
void PerformQueryBlocking (WorkingMemory *workingMemory=0)
 
void OnDone ()
 
KyResult SendVisualDebug ()
 
void SetTraverseLogicUserData (void *traverseLogicUserData)
 
void * GetTraverseLogicUserData () const
 

Pure virtual functions

virtual void Advance (WorkingMemory *workingMemory)=0
 

For internal use only

static const char * GetQueryTypeName (QueryType queryType)
 

Mandatory initialization calls to be done by derived classes

void Initialize ()
 

Public Data Members

QueryProcessStatus m_processStatus
 
Ptr< IOnDonem_onDone
 

Member Function Documentation

virtual void Kaim::IQuery::Advance ( WorkingMemory *  workingMemory)
pure virtualinherited

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
workingMemorySandbox memory used to perform queries.

Implemented in Kaim::AStarQuery< TraverseLogic >, Kaim::BestGraphVertexPathFinderQuery< VertexFinderLogic >, Kaim::SpatializedPointCollectorInAABBQuery< SpatializedPointCollectorFilter >, Kaim::SpatializedPointCollectorInAABBQuery< Kaim::AvoidanceComputerCollectorFilter >, Kaim::SegmentCastQuery< TraverseLogic >, Kaim::DiskCastQuery< TraverseLogic >, Kaim::SegmentCanGoQuery< TraverseLogic >, Kaim::TriangleFromPosQuery, Kaim::DiskCanGoQuery< TraverseLogic >, Kaim::RayCastQuery< TraverseLogic >, Kaim::MultipleFloorTrianglesFromPosQuery, Kaim::RayCanGoQuery< TraverseLogic >, Kaim::MonodirectionalRayCanGoQuery< TraverseLogic >, Kaim::DiskExpansionQuery< TraverseLogic >, Kaim::InsidePosFromOutsidePosQuery< TraverseLogic >, Kaim::RayCastOnSegmentQuery< TraverseLogic >, Kaim::DynamicNavMeshQuery, Kaim::RayCanGoOnSegmentQuery< TraverseLogic >, Kaim::MoveOnNavMeshQuery< TraverseLogic >, Kaim::FindFirstVisiblePositionOnPathQuery< TraverseLogic >, Kaim::DiskCollisionQuery< TraverseLogic >, Kaim::CircleArcSplineComputationQuery, Kaim::TriangleFromPosAndTriangleSeedQuery, Kaim::NearestBorderHalfEdgeFromPosQuery< TraverseLogic >, Kaim::RayCastFull3dQuery, and Kaim::CollisionRayCastQuery.

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::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::IQuery::PerformQueryBlocking ( WorkingMemory *  workingMemory = 0)
inherited

Process the query at once whether it is time-sliced or not.

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

Member Data Documentation

Database* Kaim::IQuery::m_database
inherited

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

Vec3f Kaim::BaseDiskCanGoQuery::m_destPos3f
protected

The end point of the line segment to be tested.

NavTrianglePtr Kaim::BaseDiskCanGoQuery::m_destTrianglePtr
protected

The NavMesh triangle that corresponds to m_destPos3f.

It will be computed automatically during the query.

DynamicOutputMode Kaim::BaseDiskCanGoQuery::m_dynamicOutputMode
protected

Specifies the type of data stored in m_queryDynamicOutput.

QueryStatusInQueue Kaim::IQuery::m_inQueueStatus
inherited

Used by the QueryQueue. Do not modify.

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::BaseDiskCanGoQuery::m_positionSpatializationRange
protected

The altitude range around the position used when determining m_startTrianglePtr and m_destTrianglePtr from m_startPos3f and m_destPos3f.

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::BaseDiskCanGoQuery::m_queryDynamicOutput
protected

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.

DiskCanGoQueryType Kaim::BaseDiskCanGoQuery::m_queryType
protected

An element from the DiskCanGoQueryType enumeration that indicates if a degraded query should be run when the the starting point lies within the NavMesh but the radius collides with the border of the NavMesh.

QueryQueue* Kaim::IQuery::m_queue
inherited

Updated by the QueryQueue. Do not modify.

KyFloat32 Kaim::BaseDiskCanGoQuery::m_radius
protected

The radius of the disk.

DiskCanGoQueryResult Kaim::BaseDiskCanGoQuery::m_result
protected

Updated during processing to indicate the result of the query.

Vec3f Kaim::BaseDiskCanGoQuery::m_startPos3f
protected

The start point of the line segment to be tested.

NavTrianglePtr Kaim::BaseDiskCanGoQuery::m_startTrianglePtr
protected

The NavMesh triangle that corresponds to m_startPos3f.

Can be set as an input, or retrieved 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: