#include <segmentcangoquery.h>

Class Description

template<class TraverseLogic>
class Kaim::SegmentCanGoQuery< TraverseLogic >

The SegmentCanGoQuery class tests whether a line segment-with a specified half-width (m_radius)-can move along a straight line segment from a starting point to an ending point without:

a collision with the NavMesh border.

crossing a forbidden NavTag. The line segment is considered to be orthogonal to the direction between m_startPos3f and m_destPos3f, as follows:

m_startA      +---->-------->--------->---------->--------------+
              |                                                 |
              |                                                 | => m_radius
              |                                                 |
              |                                                 |
m_startPos3f  X                                                 X  => m_destPos3f
              |                                                 |
              |                                                 |
              |                                                 | => m_radius
              |                                                 |
m_startB      +---->-------->--------->---------->--------------+

Inherits Kaim::BaseSegmentCanGoQuery.

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

Protected Attributes
Vec3f	m_startPos3f
	The starting point of the line segment to be tested. More...

Vec3f	m_destPos3f
	The ending point of the line segment to be tested. More...

NavTrianglePtr	m_startTrianglePtr
	The NavMesh triangle that corresponds to m_startPos3f. You can set it as an input or retrieve it as an output of the query. More...

NavTrianglePtr	m_destTrianglePtr
	The NavMesh triangle that corresponds to m_destPos3f. It will be computed automatically during the query. More...

KyFloat32	m_radius
	The radius of the disk. More...

PositionSpatializationRange	m_positionSpatializationRange
	The altitude range around the position to use when determining m_startTrianglePtr and m_destTrianglePtr from the m_startPos3f and m_destPos3f. More...

SegmentCanGoQueryResult	m_result
	Updated during processing to indicate the results of the query. More...

DynamicOutputMode	m_dynamicOutputMode
	Specifies the type of data stored in m_queryDynamicOutput. More...

Ptr< QueryDynamicOutput >	m_queryDynamicOutput
	A ref-counted Ptr to a QueryDynamicOutput instance, used to store the data encountered during the query process. More...

Functions
	SegmentCanGoQuery ()

virtual	~SegmentCanGoQuery ()

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 &startPos, const Vec3f &destPos, KyFloat32 radius)
	Sets an instance of this class with minimum input requirements. More...

write accessors for query inputs
void	SetStartTrianglePtr (const NavTrianglePtr &startTrianglePtr)
	Set The NavMesh triangle that corresponds to m_startPos3f. More...

void	SetQueryDynamicOutput (QueryDynamicOutput *queryDynamicOutput)
	Write accessor for m_queryDynamicOutput. More...

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

void	SetDynamicOutputMode (DynamicOutputMode savingMode)
	Write accessor for m_dynamicOutputMode. 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
SegmentCanGoQueryResult	GetResult () const

const Vec3f &	GetStartPos () const

const Vec3f &	GetDestPos () const

const NavTrianglePtr &	GetStartTrianglePtr () const

const NavTrianglePtr &	GetDestTrianglePtr () const

KyFloat32	GetRadius () const

DynamicOutputMode	GetDynamicOutputMode () const

QueryDynamicOutput *	GetQueryDynamicOutput () const

const PositionSpatializationRange &	GetPositionSpatializationRange () const

For internal use only
void	PerformQueryWithInputCoordPos (WorkingMemory *workingMemory)

void	SetStartIntegerPos (const WorldIntegerPos &startIntegerPos)

void	SetDestIntegerPos (const WorldIntegerPos &destIntegerPos)

const WorldIntegerPos &	GetStartIntegerPos () const

const WorldIntegerPos &	GetDestIntegerPos () const

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

template<class TLogic >

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

template<class TLogic >

void Kaim::SegmentCanGoQuery< 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

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

inlinevirtualinherited

Get query type.

Implements Kaim::IQuery.

template<class TLogic >

void Kaim::SegmentCanGoQuery< TLogic >::Initialize	(	const Vec3f &	startPos,
		const Vec3f &	destPos,
		KyFloat32	radius
	)

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

startPos	Sets the value of m_startPos3f.
destPos	Sets the value of m_destPos3f.
radius	Sets the value of m_radius.

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::SegmentCanGoQuery< 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

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.

template<class TLogic >

void Kaim::SegmentCanGoQuery< TLogic >::SetDynamicOutputMode ( DynamicOutputMode savingMode )

inline

Write accessor for m_dynamicOutputMode.

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

template<class TLogic >

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

template<class TLogic >

void Kaim::SegmentCanGoQuery< TLogic >::SetQueryDynamicOutput ( QueryDynamicOutput * queryDynamicOutput )

inline

Write accessor for m_queryDynamicOutput.

Call this method after Initialize(), during which m_queryDynamicOutput is set to nullptr.

template<class TLogic >

void Kaim::SegmentCanGoQuery< 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

Sets m_traverseLogicUserData for queries that have a custom TraverseLogic, 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::BaseSegmentCanGoQuery::m_destPos3f

protectedinherited

The ending point of the line segment to be tested.

NavTrianglePtr Kaim::BaseSegmentCanGoQuery::m_destTrianglePtr

protectedinherited

The NavMesh triangle that corresponds to m_destPos3f. It will be computed automatically during the query.

DynamicOutputMode Kaim::BaseSegmentCanGoQuery::m_dynamicOutputMode

protectedinherited

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

protectedinherited

The altitude range around the position to use when determining m_startTrianglePtr and m_destTrianglePtr from the 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::BaseSegmentCanGoQuery::m_queryDynamicOutput

protectedinherited

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.

QueryQueue* Kaim::IQuery::m_queue

inherited

Updated by the QueryQueue. Do not modify.

KyFloat32 Kaim::BaseSegmentCanGoQuery::m_radius

protectedinherited

The radius of the disk.

SegmentCanGoQueryResult Kaim::BaseSegmentCanGoQuery::m_result

protectedinherited

Updated during processing to indicate the results of the query.

Vec3f Kaim::BaseSegmentCanGoQuery::m_startPos3f

protectedinherited

The starting point of the line segment to be tested.

NavTrianglePtr Kaim::BaseSegmentCanGoQuery::m_startTrianglePtr

protectedinherited

The NavMesh triangle that corresponds to m_startPos3f. You can set it as an input or retrieve it 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:

gwnavruntime/queries/segmentcangoquery.h
gwnavruntime/queries/segmentcangoquery.inl

Kaim::SegmentCanGoQuery< TraverseLogic > Class Template Reference

Class Description

template<class TraverseLogic> class Kaim::SegmentCanGoQuery< TraverseLogic >

Public Member Functions

Public Attributes

Protected Attributes

Functions

Functions to set up the query

write accessors for query inputs

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

template<class TraverseLogic>
class Kaim::SegmentCanGoQuery< TraverseLogic >