WsfRouteComputer Class Reference

#include <WsfRouteComputer.hpp>

Inheritance diagram for WsfRouteComputer:

Public Member Functions
virtual	~WsfRouteComputer ()
virtual bool	ComputeFindPath (WsfMover &aMover, WsfRoute &aRoute)
virtual bool	ComputeSetRoute (WsfMover &aMover, WsfRoute &aRoute, int &aInitialPointIndex)
virtual bool	ComputeUpdateRoute (WsfMover &aMover, WsfRoute &aRoute)
virtual bool	ComputeExtrapolate (WsfMover &aMover, WsfRoute &aRoute)
virtual bool	ReturnToRoute (WsfMover &aMover, WsfRoute &aRoute)
virtual bool	IsNavMesh ()
virtual bool	GetEnabled ()

Detailed Description

WsfRouteComputer provides an interface to the WsfRouteMover which allows modifying the route to be traversed.

Constructor & Destructor Documentation

~WsfRouteComputer()

virtual WsfRouteComputer::~WsfRouteComputer ( )

inlinevirtual

Member Function Documentation

ComputeExtrapolate()

virtual bool WsfRouteComputer::ComputeExtrapolate ( WsfMover & aMover, WsfRoute & aRoute )

inlinevirtual

Called when a mover begins extrapolating at the end of a route.

Parameters

aMover	The mover that is performing the movement.
aRoute	A route which will replace extrapolation behavior if 'true' is returned. Returns 'true' if aRoute was modified.

Reimplemented in WsfPathFinder.

ComputeFindPath()

virtual bool WsfRouteComputer::ComputeFindPath ( WsfMover & aMover, WsfRoute & aRoute )

inlinevirtual

Called when FindAndSetPath is called on a mover

Parameters

aMover	The mover that is performing the movement.
aRoute	The route to be transformed. Returns 'true' if aRoute was modified.

Reimplemented in WsfNavigationMesh, and WsfPathFinder.

ComputeSetRoute()

virtual bool WsfRouteComputer::ComputeSetRoute ( WsfMover & aMover, WsfRoute & aRoute, int & aInitialPointIndex )

inlinevirtual

Called when a mover is given an initial route.

Parameters

aMover	The mover that is performing the movement.
aRoute	The route to be transformed.
aInitialPointIndex	The index of the point within the route where movement is to start. Returns 'true' if aRoute was modified.

Reimplemented in WsfNavigationMesh, and WsfPathFinder.

ComputeUpdateRoute()

virtual bool WsfRouteComputer::ComputeUpdateRoute ( WsfMover & aMover, WsfRoute & aRoute )

inlinevirtual

Called when a mover is given an updated route.

Parameters

aMover	The mover that is performing the movement.
aRoute	The route to be transformed. Returns 'true' if aRoute was modified.

Reimplemented in WsfPathFinder.

GetEnabled()

virtual bool WsfRouteComputer::GetEnabled ( )

inlinevirtual

IsNavMesh()

virtual bool WsfRouteComputer::IsNavMesh ( )

inlinevirtual

Reimplemented in WsfNavigationMesh.

ReturnToRoute()

virtual bool WsfRouteComputer::ReturnToRoute ( WsfMover & aMover, WsfRoute & aRoute )

inlinevirtual

Reimplemented in WsfPathFinder.

---

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

• WsfRouteComputer.hpp