Kaim::BasePathProgressComputer Class Reference

Kaim::BasePathProgressComputer Class Referenceabstract

#include <basepathprogresscomputer.h>

Class Description

The abstract base class for PathProgressComputer classes.

PathProgressComputer maintains the progress of a Bot along a Path. PathProgressComputer does NOT compute the output trajectory (spline or velocity...), the Trajectory class has this responsibility. PathProgressComputer is stateless and shared among bots that use the same NavigationProfile. There is a BasePathProgressComputer abstract base class and a PathProgressComputer<TraverseLogic> concrete class so that the Bot can call pathProgressComputer->Update() without being templated by TraverseLogic. Users are not supposed to implement their own implementation of BasePathProgressComputer.

Inherits Kaim::RefCountBase< C, Stat >.

Inherited by Kaim::PathProgressComputer< TraverseLogic >.

Functions

 BasePathProgressComputer ()
 
virtual ~BasePathProgressComputer ()
 
void SetPathEventListObserver (const Ptr< IPathEventListObserver > &m_pathEventListObserver)
 Sets the SetPathEventListObserver. More...
 
Ptr< IPathEventListObserverGetPathEventListObserver ()
 
void SetPositionOnPathCheckPointValidator (const Ptr< IPositionOnPathValidator > &positionOnPathCheckPointValidator)
 Sets the IPositionOnPathValidator to be used to validate target on path check points. More...
 
Ptr< IPositionOnPathValidatorGetPositionOnPathCheckPointValidator ()
 

Pure Virtual Functions

virtual void Update (Bot *bot, KyFloat32 simulationTimeInSeconds)=0
 

Member Function Documentation

void Kaim::BasePathProgressComputer::SetPathEventListObserver ( const Ptr< IPathEventListObserver > &  m_pathEventListObserver)

Sets the SetPathEventListObserver.

void Kaim::BasePathProgressComputer::SetPositionOnPathCheckPointValidator ( const Ptr< IPositionOnPathValidator > &  positionOnPathCheckPointValidator)

Sets the IPositionOnPathValidator to be used to validate target on path check points.


The documentation for this class was generated from the following files: