#include <collisionraycastquery.h>

Class Description

Query that performs a 3D raycast against the physical geometry in a CollisionWorld.

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

From/To Blob
static Ptr< BaseBlobHandler >	CreateStaticQueryBlobHandler ()

virtual void	BuildQueryBlob (BaseBlobHandler *blobHandler)

virtual void	InitFromQueryBlob (World world, void blob)

virtual Ptr< BaseBlobHandler >	CreateQueryBlobHandler ()

Functions
	CollisionRayCastQuery ()

virtual	~CollisionRayCastQuery ()

void	BindToWorld (World *world)
	Associates the query to this world, 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 &start, const Vec3f &dest)
	Sets an instance of this class with minimum input requirements. More...

virtual void	Advance (WorkingMemory *)
	workingMemory is not used More...

void	PerformQuery ()
	Performs the query. More...

CollisionRayCastResult	GetResult () const

const Vec3f &	GetStartPos () const

const Vec3f &	GetDestPos () 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
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

static const char *	GetQueryTypeName (QueryType queryType)

Mandatory initialization calls to be done by derived classes
void	BindToDatabase (Database *database)
	Should be called by the derived class before Initializing the query Sets m_database and sets m_traverseLogicUserData to nullptr;. More...

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::CollisionRayCastQuery::Advance ( WorkingMemory * )

virtual

workingMemory is not used

Implements Kaim::IQuery.

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

inlineinherited

Should be called by the derived class before Initializing the query Sets m_database and sets m_traverseLogicUserData to nullptr;.

void Kaim::CollisionRayCastQuery::BindToWorld ( World * world )

Associates the query to this world, 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.)

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

inlinevirtual

Get query type.

Implements Kaim::IQuery.

void Kaim::CollisionRayCastQuery::Initialize	(	const Vec3f &	start,
		const Vec3f &	dest
	)

Sets an instance of this class with minimum input requirements.

Clears all the input and output, lets all configuration parameters unchanged. They may be changed by calling the corresponding write accessors.

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::CollisionRayCastQuery::PerformQuery ( )

Performs the query.

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

Database* Kaim::IQuery::m_database

inherited

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

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.

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.

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/collision/collisionraycastquery.h
gwnavruntime/collision/collisionraycastquery.cpp

Kaim::CollisionRayCastQuery Class Reference

Class Description

Public Member Functions

Public Attributes

From/To Blob

Functions

IQuery Functions

For internal use only

Mandatory initialization calls to be done by derived classes

Member Function Documentation

Member Data Documentation