Kaim::MoveOnNavMeshQuery< TraverseLogic > Class Template Reference

Kaim::MoveOnNavMeshQuery< TraverseLogic > Class Template Reference

#include <moveonnavmeshquery.h>

Class Description

template<class TraverseLogic>
class Kaim::MoveOnNavMeshQuery< TraverseLogic >

This class is used to get move bots on the NavMesh without physics engine.

Inherits Kaim::BaseMoveOnNavMeshQuery.

Public Attributes

Databasem_database
 
QueryStatusInQueue m_inQueueStatus
 
QueryQueuem_queue
 
void * m_traverseLogicUserData
 
bool m_visualDebugActivated
 

Protected Attributes

Vec3f m_arrivalPos3f
 
KyFloat32 m_distanceToBoundary
 
KyFloat32 m_moveDistance
 
Vec2f m_normalizedDir2d
 
MoveOnNavMeshQueryResult m_result
 
Vec3f m_startPos3f
 
NavTrianglePtr m_startTrianglePtr
 

Public Member Functions

static QueryType GetStaticType ()
 
virtual QueryType GetType () const
 
 MoveOnNavMeshQuery ()
 
virtual ~MoveOnNavMeshQuery ()
 

Functions to set up the query

void BindToDatabase (Database *database)
 
void Initialize (const Vec3f &startPos, const Vec2f &normalizedDir2d, KyFloat32 maxDist)
 

write accessors for query inputs

void SetStartTrianglePtr (const NavTrianglePtr &startTrianglePtr)
 

write accessors for query parameters

void SetDistanceToBoundary (KyFloat32 distanceToBoundary)
 

Query framework functions

virtual void Advance (WorkingMemory *workingMemory)
 
void PerformQuery (WorkingMemory *workingMemory=0)
 

Accessors

MoveOnNavMeshQueryResult GetResult () const
 
const Vec3fGetStartPos () const
 
const Vec3fGetArrivalPos () const
 
const Vec2fGetNormalizedDir2d () const
 
const NavTrianglePtrGetStartTrianglePtr () const
 
KyFloat32 GetDistanceToBoundary () const
 
KyFloat32 GetDistance () const
 
KyFloat32 GetAltitudeTolerance () const
 

For internal use only

void PerformQueryWithInputCoordPos (WorkingMemory *workingMemory)
 
void SetStartIntegerPos (const WorldIntegerPos &startIntegerPos)
 
const WorldIntegerPosGetStartIntegerPos () 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
 

For internal use only

static const char * GetQueryTypeName (QueryType queryType)
 

Internal Virtual functions for NavigationLab Remote Query processing

These functions are used by IQuery::SendVisualDebug() and also used by the NavigationLab to request remote execution: using VisualDebugClient::Send(IQuery*) to ask for a query to be executed using VisualDebugServer::Send(IQuery*) to send back the query result.

Queries that can be visual debug override these 3 functions.

By convenience, such queries provide a static function with the following signature: /code static Ptr<BaseBlobHandler> CreateStaticQueryBlobHandler(); /endcode

virtual Ptr< BaseBlobHandler > CreateQueryBlobHandler ()
 
virtual void BuildQueryBlob (Kaim::BaseBlobHandler *)
 
virtual void InitFromQueryBlob (World *, void *)
 

Mandatory initialization calls to be done by derived classes

void Initialize ()
 

Public Data Members

QueryProcessStatus m_processStatus
 
Ptr< IOnDonem_onDone
 

Member Function Documentation

template<class TLogic >
void Kaim::MoveOnNavMeshQuery< TLogic >::Advance ( WorkingMemory *  workingMemory)
inlinevirtual

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.

Implements Kaim::IQuery.

template<class TLogic >
void Kaim::MoveOnNavMeshQuery< TLogic >::BindToDatabase ( Database database)
inline

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

template<class TLogic >
void Kaim::MoveOnNavMeshQuery< TLogic >::Initialize ( const Vec3f startPos,
const Vec2f normalizedDir2d,
KyFloat32  maxDist 
)
inline

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

Parameters
startPosSets the value of #m_startPos3f.
normalizedDir2dSets the value of #m_normalizedDir2d.
maxDistSets the value of #m_moveDistance.
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.

template<class TLogic >
void Kaim::MoveOnNavMeshQuery< TLogic >::PerformQuery ( WorkingMemory *  workingMemory = 0)

Performs the query.

Parameters
workingMemorySandbox memory used to perform queries. If let to KY_NULL, the m_database internal WorkingMemory is used.
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.
template<class TLogic >
void Kaim::MoveOnNavMeshQuery< TLogic >::SetDistanceToBoundary ( KyFloat32  distanceToBoundary)
inline

Set the minimal distance the arrival position should be from any NavMesh border.

Call this method after BindToDatabase(), during which #m_distanceToBoundary is set to its default value.

template<class TLogic >
void Kaim::MoveOnNavMeshQuery< TLogic >::SetStartTrianglePtr ( const NavTrianglePtr startTrianglePtr)
inline

Set the NavMesh triangle that corresponds to #m_startPos3f.

If a valid NavTrianglePtr is specified, this value will be used.

If no value is specified, it will be automatically computed during the query. Call this method after Initialize(), during which it is cleared.

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

Should be set for queries templated by a traverse logic, useless otherwise.

Member Data Documentation

Vec3f Kaim::BaseMoveOnNavMeshQuery::m_arrivalPos3f
protectedinherited

Updated during processing to indicate the final position of the ray at the end of the cast.

  • If no collision was detected, the result is the triangle arrived at by traversing the NavMesh in the direction of #m_normalizedDir2d.
  • If a collision is detected, the result is derived from the collision point by backtracking along the orientation of #m_normalizedDir2d. This ensures #m_arrivalPos3f will be inside the boundaries of the NavMesh.
Database* Kaim::IQuery::m_database
inherited

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

KyFloat32 Kaim::BaseMoveOnNavMeshQuery::m_distanceToBoundary
protectedinherited

The minimal distance to NavMesh boundary the resulting position should be.

When the movement hits a boundary, we move back the final position so that it is at #m_distanceToBoundary meters from this boundary.

QueryStatusInQueue Kaim::IQuery::m_inQueueStatus
inherited

Used by the QueryQueue. Do not modify.

KyFloat32 Kaim::BaseMoveOnNavMeshQuery::m_moveDistance
protectedinherited

Determines the maximum distance the disk will travel.

If this distance is too far from the starting point (approximately 32 times the length of a NavData cell), running the query can result in an integer overflow during calculation.

Vec2f Kaim::BaseMoveOnNavMeshQuery::m_normalizedDir2d
protectedinherited

A normalized vector representing the direction the ray is cast.

Ptr<IOnDone> Kaim::IQuery::m_onDone
inherited

The optional IOnDone instance to be called. Must be set manually by the user. See IOnDone.

QueryProcessStatus Kaim::IQuery::m_processStatus
inherited

Modified by the query within Advance().

Do not modify.

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

QueryQueue* Kaim::IQuery::m_queue
inherited

Updated by the QueryQueue. Do not modify.

MoveOnNavMeshQueryResult Kaim::BaseMoveOnNavMeshQuery::m_result
protectedinherited

Updated during processing to indicate the result of the query.

Vec3f Kaim::BaseMoveOnNavMeshQuery::m_startPos3f
protectedinherited

The starting point of the line segment being tested.

NavTrianglePtr Kaim::BaseMoveOnNavMeshQuery::m_startTrianglePtr
protectedinherited

The NavMesh triangle corresponding to #m_startPos3f. It can be an input, or it can be retrieved as an output of the query.

void* Kaim::IQuery::m_traverseLogicUserData
inherited

This userData is typically passed by the Bot.

bool Kaim::BaseMoveOnNavMeshQuery::m_visualDebugActivated
inherited

When toggle on, the query will send visual debug information.


The documentation for this class was generated from the following files: