#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
bool	m_visualDebugActivated
	When toggle on, the query will send visual debug information. More...

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

Ptr< IOnDone >	m_onDone
	The optional IOnDone instance to be called. Must be set manually by the user. See IOnDone. More...

Protected Attributes
WorldIntegerPos	m_startIntegerPos
	m_startIntegerPos More...

Vec3f	m_startPos3f
	The starting point of the line segment being tested. More...

Vec2f	m_normalizedDir2d
	A normalized vector representing the direction the ray is cast. More...

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

KyFloat32	m_distanceToBoundary
	The minimal safety distance to NavMesh boundary the resulting position should be. More...

KyFloat32	m_moveDistance
	Determines the maximum distance the disk will travel. More...

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

MoveOnNavMeshQueryResult	m_result
	Updated during processing to indicate the result of the query. More...

Functions
static QueryType	GetStaticType ()

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

virtual	~MoveOnNavMeshQuery ()

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
MoveOnNavMeshQueryResult	GetResult () const

const Vec3f &	GetStartPos () const

const Vec3f &	GetArrivalPos () const

const Vec2f &	GetNormalizedDir2d () const

const NavTrianglePtr &	GetStartTrianglePtr () const

KyFloat32	GetDistanceToBoundary () const

KyFloat32	GetDistance () const

const WorldIntegerPos &	GetStartIntegerPos () const

For internal use only
static KyFloat32	CapDistanceToBoundary (Kaim::Database *database, KyFloat32 distanceToBoundary)

void	BindToDatabase (Database *database)

void	Initialize (const Vec3f &startPos, const Vec2f &normalizedDir2d, KyFloat32 maxDist)

void	SetStartTrianglePtr (const NavTrianglePtr &startTrianglePtr)

void	SetDistanceToBoundary (KyFloat32 distanceToBoundary)

void	SetStartIntegerPos (const WorldIntegerPos &startIntegerPos)

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)

Database *	m_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...

QueryQueue *	m_queue
	Updated by the QueryQueue. Do not modify. More...

QueryStatusInQueue	m_inQueueStatus
	Used by the QueryQueue. Do not modify. More...

KyUInt32	m_queryInfoId

Internal Virtual functions for NavigationLab Remote Query processing
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 ()
	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::MoveOnNavMeshQuery< 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

workingMemory Sandbox 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

Gets m_traverseLogicUserData.

template<class TraverseLogic>

virtual QueryType Kaim::MoveOnNavMeshQuery< TraverseLogic >::GetType ( ) const

inlinevirtual

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::MoveOnNavMeshQuery< TLogic >::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

Sets m_traverseLogicUserData for queries that have a custom TraverseLogic, 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 safety 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. It must not be greater than half of PixelSize and strictly positive.

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.

WorldIntegerPos Kaim::BaseMoveOnNavMeshQuery::m_startIntegerPos

protectedinherited

m_startIntegerPos

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:

gwnavruntime/queries/moveonnavmeshquery.h
gwnavruntime/queries/moveonnavmeshquery.inl

Kaim::MoveOnNavMeshQuery< TraverseLogic > Class Template Reference

Class Description

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

Public Attributes

Protected Attributes

Functions

For internal use only

Main API Functions

For internal use only

IQuery Functions

For internal use only

Internal Virtual functions for NavigationLab Remote Query processing

Mandatory initialization calls to be done by derived classes

Member Function Documentation

Member Data Documentation

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