#include <diskcollisionquery.h>

Class Description

template<class TraverseLogic>
class Kaim::DiskCollisionQuery< TraverseLogic >

The DiskCollisionQuery class attempts to place the center of a disk with a specified radius (m_radius) at a specified position (m_centerPos3f), and tests whether the entire disk fits within the borders of the NavMesh without intersecting any forbidden NavTag (NavMesh borders).

Inherits Kaim::BaseDiskCollisionQuery.

Public Attributes
Database *	m_database

QueryStatusInQueue	m_inQueueStatus

QueryQueue *	m_queue

void *	m_traverseLogicUserData

Protected Attributes
Vec3f	m_centerPos3f

NavTrianglePtr	m_centerTrianglePtr

DynamicOutputMode	m_dynamicOutputMode

PositionSpatializationRange	m_positionSpatializationRange

Ptr< QueryDynamicOutput >	m_queryDynamicOutput

KyFloat32	m_radius

DiskCollisionQueryResult	m_result

Public Member Functions
	DiskCollisionQuery ()

virtual	~DiskCollisionQuery ()

Functions to set up the query
void	BindToDatabase (Database *database)

void	Initialize (const Vec3f &center, KyFloat32 radius)

write accessors for query inputs
void	SetCenterTrianglePtr (const NavTrianglePtr &centerTrianglePtr)

void	SetQueryDynamicOutput (QueryDynamicOutput *queryDynamicOutput)

write accessors for query parameters
void	SetPositionSpatializationRange (const PositionSpatializationRange &positionSpatializationRange)

void	SetDynamicOutputMode (DynamicOutputMode savingMode)

Query framework functions
virtual void	Advance (WorkingMemory *workingMemory)

void	PerformQuery (WorkingMemory *workingMemory=0)

Accessors
DiskCollisionQueryResult	GetResult () const

const Vec3f &	GetCenterPos () const

const NavTrianglePtr &	GetCenterTrianglePtr () const

KyFloat32	GetRadius () const

DynamicOutputMode	GetDynamicOutputMode () const

QueryDynamicOutput *	GetQueryDynamicOutput () const

const PositionSpatializationRange &	GetPositionSpatializationRange () const

For internal use only
void	PerformQueryWithInputCoordPos (WorkingMemory *workingMemory)

void	SetCenterIntegerPos (const WorldIntegerPos &centerIntegerPos)

const WorldIntegerPos &	GetCenterIntegerPos () 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)

Mandatory initialization calls to be done by derived classes
void	Initialize ()

Public Data Members
QueryProcessStatus	m_processStatus

Ptr< IOnDone >	m_onDone

Member Function Documentation

template<class TLogic >

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

workingMemory Sandbox memory used to perform queries.

Implements Kaim::IQuery.

template<class TLogic >

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

template<class TLogic >

void Kaim::DiskCollisionQuery< TLogic >::Initialize	(	const Vec3f &	center,
		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

center	Sets the value of m_centerPos3f.
radius	Sets the value of m_radius.

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::DiskCollisionQuery< TLogic >::PerformQuery ( WorkingMemory * workingMemory = 0 )

Performs the query.

Parameters

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

workingMemory Sandbox memory used to perform queries. If let to KY_NULL, the m_database internal WorkingMemory is used.

template<class TLogic >

void Kaim::DiskCollisionQuery< TLogic >::SetCenterTrianglePtr ( const NavTrianglePtr & centerTrianglePtr )

inline

The NavMesh triangle that corresponds to m_centerPos3f.

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.

template<class TLogic >

void Kaim::DiskCollisionQuery< 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::DiskCollisionQuery< 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::DiskCollisionQuery< TLogic >::SetQueryDynamicOutput ( QueryDynamicOutput * queryDynamicOutput )

inline

Write accessor for m_queryDynamicOutput.

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

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

inlineinherited

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

Member Data Documentation

Vec3f Kaim::BaseDiskCollisionQuery::m_centerPos3f

protectedinherited

The position of the center of the disk.

NavTrianglePtr Kaim::BaseDiskCollisionQuery::m_centerTrianglePtr

protectedinherited

The NavMesh triangle that corresponds to m_centerPos3f. Can be set as an input, or retrieved as an output of the query.

Database* Kaim::IQuery::m_database

inherited

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

DynamicOutputMode Kaim::BaseDiskCollisionQuery::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::BaseDiskCollisionQuery::m_positionSpatializationRange

protectedinherited

The altitude range around the position used when determining m_centerTrianglePtr from the m_centerPos3f.

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::BaseDiskCollisionQuery::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::BaseDiskCollisionQuery::m_radius

protectedinherited

The radius of the disk.

DiskCollisionQueryResult Kaim::BaseDiskCollisionQuery::m_result

protectedinherited

Updated during processing to indicate the result 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/diskcollisionquery.h
gwnavruntime/queries/diskcollisionquery.inl

Kaim::DiskCollisionQuery< TraverseLogic > Class Template Reference

Class Description

template<class TraverseLogic> class Kaim::DiskCollisionQuery< TraverseLogic >

Public Attributes

Protected Attributes

Public Member 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

Main API Functions

For internal use only

Mandatory initialization calls to be done by derived classes

Public Data Members

Member Function Documentation

Member Data Documentation

template<class TraverseLogic>
class Kaim::DiskCollisionQuery< TraverseLogic >