com.badlogic.gdx.ai.pfa

Class PathFinderRequest<N>

java.lang.Object

com.badlogic.gdx.ai.pfa.PathFinderRequest<N>

Type Parameters:

N - Type of node

public class PathFinderRequest<N>
extends java.lang.Object

A request for interruptible pathfinding that should be sent to a PathFinderQueue through a Telegram.

Field Summary

Fields

Modifier and Type	Field and Description
Telegraph	client
MessageDispatcher	dispatcher
N	endNode
int	executionFrames
Heuristic<N>	heuristic
boolean	pathFound
int	responseMessageCode
GraphPath<N>	resultPath
static int	SEARCH_DONE
static int	SEARCH_FINALIZED
static int	SEARCH_INITIALIZED
static int	SEARCH_NEW
N	startNode
int	status
boolean	statusChanged

Constructor Summary

Constructors

Constructor and Description
PathFinderRequest() Creates an empty PathFinderRequest
PathFinderRequest(N startNode, N endNode, Heuristic<N> heuristic, GraphPath<N> resultPath) Creates a PathFinderRequest with the given arguments that uses the singleton message dispatcher provided by MessageManager.
PathFinderRequest(N startNode, N endNode, Heuristic<N> heuristic, GraphPath<N> resultPath, MessageDispatcher dispatcher) Creates a PathFinderRequest with the given arguments.

Method Summary

Modifier and Type	Method and Description
void	changeStatus(int newStatus)
boolean	finalizeSearch(long timeToRun) Interruptible method called by PathFinderQueue when the path finder has completed the search.
boolean	initializeSearch(long timeToRun) Interruptible method called by the PathFinderRequestControl as soon as this request starts to be served.
boolean	search(PathFinder<N> pathFinder, long timeToRun)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SEARCH_NEW

public static final int SEARCH_NEW

See Also:

Constant Field Values

SEARCH_INITIALIZED

public static final int SEARCH_INITIALIZED

See Also:

Constant Field Values

SEARCH_DONE

public static final int SEARCH_DONE

See Also:

Constant Field Values

SEARCH_FINALIZED

public static final int SEARCH_FINALIZED

See Also:

Constant Field Values

startNode

public N startNode

endNode

public N endNode

heuristic

public Heuristic<N> heuristic

resultPath

public GraphPath<N> resultPath

executionFrames

public int executionFrames

pathFound

public boolean pathFound

status

public int status

statusChanged

public boolean statusChanged

client

public Telegraph client

responseMessageCode

public int responseMessageCode

dispatcher

public MessageDispatcher dispatcher

Constructor Detail

PathFinderRequest

public PathFinderRequest()

Creates an empty PathFinderRequest

PathFinderRequest

public PathFinderRequest(N startNode,
                         N endNode,
                         Heuristic<N> heuristic,
                         GraphPath<N> resultPath)

Creates a PathFinderRequest with the given arguments that uses the singleton message dispatcher provided by MessageManager.

PathFinderRequest

public PathFinderRequest(N startNode,
                         N endNode,
                         Heuristic<N> heuristic,
                         GraphPath<N> resultPath,
                         MessageDispatcher dispatcher)

Creates a PathFinderRequest with the given arguments.

Method Detail

changeStatus

public void changeStatus(int newStatus)

initializeSearch

public boolean initializeSearch(long timeToRun)

Interruptible method called by the PathFinderRequestControl as soon as this request starts to be served.

Parameters:

timeToRun - the time in nanoseconds that this call can use on the current frame

Returns:

true if initialization has completed; false if more time is needed to complete.

search

public boolean search(PathFinder<N> pathFinder,
                      long timeToRun)

Parameters:

pathFinder - the path finder

timeToRun - the time in nanoseconds that this call can use on the current frame

Returns:

true if the search has completed; false if more time is needed to complete.

finalizeSearch

public boolean finalizeSearch(long timeToRun)

Interruptible method called by PathFinderQueue when the path finder has completed the search. You have to check the pathFound field of this request to know if a path has been found.

Parameters:

timeToRun - the time in nanoseconds that this call can use on the current frame

Returns:

true if finalization has completed; false if more time is needed to complete.