cz.cuni.amis.pogamut.ut2004.agent.navigation

Interface IUT2004GetBackToNavGraph

All Known Implementing Classes:

UT2004GetBackToNavGraph

public interface IUT2004GetBackToNavGraph

This class is meant to provide easy "get-back-to-navigation-graph-in-order-I-can-safely-navigate-through-map" implementation.

Author:

Jimmy

Method Summary

Methods

Modifier and Type	Method and Description
void	addStuckDetector(IStuckDetector stuckDetector) Adds another stuck detector to be used for stuck detection :)
void	backToNavGraph() Start the class, let it take the bot back to navigation graph.
void	clearStuckDetectors() Removes ALL stuck detectors.
NavPoint	getNearestNavPoint() Returns nearest NavPoint to current bot's location.
boolean	isExecuting() Whether the class is executing (== working == trying to get the bot back on NavGraph == to make UT2004GetBackToNavGraph.isOnNavGraph() true).
boolean	isOnNavGraph() Whether the bot is currently on some NavPoint.
void	removeStuckDetector(IStuckDetector stuckDetector) Removes stuck detector.
void	setFocus(ILocated located) Sets focus of the bot when navigating (when using this object to run to some location target)! To reset focus call this method with null parameter.
void	stop() Stop the class.

Method Detail

getNearestNavPoint

NavPoint getNearestNavPoint()

Returns nearest NavPoint to current bot's location.

Returns:

isOnNavGraph

boolean isOnNavGraph()

Whether the bot is currently on some NavPoint.

isExecuting

boolean isExecuting()

Whether the class is executing (== working == trying to get the bot back on NavGraph == to make UT2004GetBackToNavGraph.isOnNavGraph() true).

Returns:

setFocus

void setFocus(ILocated located)

Sets focus of the bot when navigating (when using this object to run to some location target)! To reset focus call this method with null parameter.

Parameters:

located -

backToNavGraph

void backToNavGraph()

Start the class, let it take the bot back to navigation graph.

stop

void stop()

Stop the class.

addStuckDetector

void addStuckDetector(IStuckDetector stuckDetector)

Adds another stuck detector to be used for stuck detection :)

Parameters:

stuckDetector -

removeStuckDetector

void removeStuckDetector(IStuckDetector stuckDetector)

Removes stuck detector.

Parameters:

stuckDetector -

clearStuckDetectors

void clearStuckDetectors()

Removes ALL stuck detectors.