#include <circlearcsplinecomputationquery.h>

Class Description

Base class for CircleArcSplineComputationQuery.

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

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 &startPosition, const ChannelSectionPtr &startSection, const Vec3f &endPosition, const ChannelSectionPtr &endSection)
	Sets an instance of this class with minimum input requirements. More...

write accessors for query parameters
void	SetStartConstraint (const Vec2f &constraint)

void	SetEndConstraint (const Vec2f &constraint)

void	SetSplineConfig (const SplineComputationConfig &config)

SplineComputationConfig &	GetSplineConfig ()

Query framework functions
virtual void	Advance (WorkingMemory *workingMemory)
	Performs a single iteration of the spline computation query. More...

void	PerformQuery (WorkingMemory *workingMemory=nullptr)
	If workingMemory param is nullptr, m_database.GetWorkingMemory() will be used. More...

virtual void	ReleaseWorkingMemoryOnCancelDuringProcess (WorkingMemory *workingMemory=nullptr)
	Called when a query is canceled in FlushCommands while its status is QueryInProcess to make sure that the WorkingMemory is left in valid state (typically, no WorkingMemory buffer should be in used after this call). More...

Accessors
const SplineComputationConfig &	GetSplineConfig () const

const Vec3f &	GetStartPos () const

const Vec3f &	GetEndPos () const

const ChannelSectionPtr &	GetStartChannelSectionPtr () const

const ChannelSectionPtr &	GetEndChannelSectionPtr () const

CircleArcSplineComputationQueryResult	GetResult () const

const CircleArcSplineComputer &	GetComputer () const

CircleArcSplineComputationResult	GetComputerResult () const

KyUInt32	GetOutputCount () const

const RadiusProfileCircleArcSplineComputerOutput &	GetOutput (KyUInt32 index) 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)

Internal Virtual functions for NavigationLab Remote Query processing
virtual Ptr< BaseBlobHandler >	CreateQueryBlobHandler ()

virtual void	BuildQueryBlob (Kaim::BaseBlobHandler *)

virtual void	InitFromQueryBlob (World , void )

Functions
void	Initialize ()
	Should be called by the derived class before trying to perform the query or to push it in a QueryQueue. More...

Member Function Documentation

void Kaim::CircleArcSplineComputationQuery::Advance ( WorkingMemory * workingMemory )

virtual

Performs a single iteration of the spline computation query.

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

inlinevirtual

Get query type.

Implements Kaim::IQuery.

void Kaim::CircleArcSplineComputationQuery::Initialize	(	const Vec3f &	startPosition,
		const ChannelSectionPtr &	startSection,
		const Vec3f &	endPosition,
		const ChannelSectionPtr &	endSection
	)

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

startPosition	Sets the value of m_startPosition.
startSection	Sets the value of m_startSection.
endPosition	Sets the value of m_endPosition.
endSection	Sets the value of m_endSection.

void Kaim::ITimeSlicedQuery::Initialize ( )

inlineinherited

Should be called by the derived class before trying to perform the query or to push it in a QueryQueue.

This function calls IQuery::Initialize().

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

void Kaim::CircleArcSplineComputationQuery::ReleaseWorkingMemoryOnCancelDuringProcess ( WorkingMemory * workingMemory = nullptr )

virtual

Called when a query is canceled in FlushCommands while its status is QueryInProcess to make sure that the WorkingMemory is left in valid state (typically, no WorkingMemory buffer should be in used after this call).

Implements Kaim::ITimeSlicedQuery.

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/queries/circlearcsplinecomputationquery.h
gwnavruntime/queries/circlearcsplinecomputationquery.cpp

Kaim::CircleArcSplineComputationQuery Class Reference

Class Description

Public Member Functions

Public Attributes

Functions to set up the query

write accessors for query parameters

Query framework functions

Accessors

IQuery Functions

For internal use only

Internal Virtual functions for NavigationLab Remote Query processing

Functions

Member Function Documentation

Member Data Documentation