#include <trianglefromposquery.h>

Class Description

The TriangleFromPosQuery class takes a position in the 3D space (m_inputPos3f), and finds the nearest triangle in the NavMesh that covers the same (X,Y) coordinates.

The search can look above and below the position at the same time, or it can be limited to above- or below-only. If a triangle is found, it is written to m_resultTrianglePtr.

Inherits Kaim::IAtomicQuery.

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< IOnDone >	m_onDone
	The optional IOnDone instance to be called. Must be set manually by the user. See IOnDone. More...

Private Attributes
Vec3f	m_inputPos3f
	input position More...

PositionSpatializationRange	m_positionSpatializationRange
	The altitude tolerance around m_inputPos3f that will be searched for triangles. More...

TriangleFromPosQueryType	m_queryType
	An element from the TriangleFromPosQueryType enumeration that indicates whether to look for triangles only above m_inputPos3f (NEARESTTRIANGLE_FIND_NEAREST_ABOVE), only below m_inputPos3f (NEARESTTRIANGLE_FIND_NEAREST_BELOW), or to look for only the nearest triangle above and below (NEARESTTRIANGLE_FIND_NEAREST). More...

NavTrianglePtr	m_resultTrianglePtr
	Updated during processing to store the nearest triangle found to m_inputPos3f. More...

KyFloat32	m_altitudeInTriangle
	Updated during processing to indicate the projected altitude of m_inputPos3f on the triangle stored in m_resultTrianglePtr. More...

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

Functions
	TriangleFromPosQuery ()

virtual	~TriangleFromPosQuery ()

Functions to set up the query
void	BindToDatabase (Database *database)
	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.) More...

void	Initialize (const Vec3f &pos)
	resets an initialized instance of this class with minimum input requirements. More...

write accessors for query parameters
void	SetPositionSpatializationRange (const PositionSpatializationRange &positionSpatializationRange)
	Write accessor for m_positionSpatializationRange. More...

void	SetQueryType (TriangleFromPosQueryType queryType)
	Write accessor for m_queryType. More...

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

Accessors
TriangleFromPosQueryResult	GetResult () const

const Vec3f &	GetInputPos () const

const NavTrianglePtr &	GetResultTrianglePtr () const

TriangleFromPosQueryType	GetQueryType () const

KyFloat32	GetAltitudeOfProjectionInTriangle () const

const PositionSpatializationRange &	GetPositionSpatializationRange () const

For internal use only
void	SetInputIntegerPos (const WorldIntegerPos &integerPos)

const WorldIntegerPos &	GetInputIntegerPos () const

void	PerformQueryWithInputCoordPos (WorkingMemory *workingMemory)

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

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

void Kaim::TriangleFromPosQuery::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.

void Kaim::TriangleFromPosQuery::BindToDatabase ( Database * database )

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

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

void* Kaim::IQuery::GetTraverseLogicUserData ( ) const

inlineinherited

Gets m_traverseLogicUserData.

virtual QueryType Kaim::TriangleFromPosQuery::GetType ( ) const

inlinevirtual

Get query type.

Implements Kaim::IQuery.

void Kaim::TriangleFromPosQuery::Initialize ( const Vec3f & pos )

resets an initialized 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

pos	Sets the value of m_inputPos3f.

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.

void Kaim::TriangleFromPosQuery::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::TriangleFromPosQuery::SetPositionSpatializationRange ( const PositionSpatializationRange & positionSpatializationRange )

inline

Write accessor for m_positionSpatializationRange.

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

void Kaim::TriangleFromPosQuery::SetQueryType ( TriangleFromPosQueryType queryType )

inline

Write accessor for m_queryType.

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

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

inlineinherited

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

Member Data Documentation

KyFloat32 Kaim::TriangleFromPosQuery::m_altitudeInTriangle

private

Updated during processing to indicate the projected altitude of m_inputPos3f on the triangle stored in m_resultTrianglePtr.

Database* Kaim::IQuery::m_database

inherited

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

Vec3f Kaim::TriangleFromPosQuery::m_inputPos3f

private

input position

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::TriangleFromPosQuery::m_positionSpatializationRange

private

The altitude tolerance around m_inputPos3f that will be searched for triangles.

QueryProcessStatus Kaim::IQuery::m_processStatus

inherited

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

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

TriangleFromPosQueryType Kaim::TriangleFromPosQuery::m_queryType

private

An element from the TriangleFromPosQueryType enumeration that indicates whether to look for triangles only above m_inputPos3f (NEARESTTRIANGLE_FIND_NEAREST_ABOVE), only below m_inputPos3f (NEARESTTRIANGLE_FIND_NEAREST_BELOW), or to look for only the nearest triangle above and below (NEARESTTRIANGLE_FIND_NEAREST).

QueryQueue* Kaim::IQuery::m_queue

inherited

Updated by the QueryQueue. Do not modify.

TriangleFromPosQueryResult Kaim::TriangleFromPosQuery::m_result

private

Updated during processing to indicate the result of the query.

NavTrianglePtr Kaim::TriangleFromPosQuery::m_resultTrianglePtr

private

Updated during processing to store the nearest triangle found to m_inputPos3f.

If no triangle is found, m_resultTrianglePtr is set to an invalid NavTrianglePtr.

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:

gwnavruntime/queries/trianglefromposquery.h
gwnavruntime/queries/trianglefromposquery.cpp
gwnavruntime/queries/trianglefromposquery.inl

Kaim::TriangleFromPosQuery Class Reference

Class Description

Public Member Functions

Public Attributes

Private Attributes

Functions

Functions to set up the query

write accessors for query parameters

Query framework functions

Accessors

For internal use only

IQuery Functions

For internal use only

Mandatory initialization calls to be done by derived classes

Member Function Documentation

Member Data Documentation