com.badlogic.gdx.ai.pfa.PathFinder Maven / Gradle / Ivy
/*******************************************************************************
* Copyright 2014 See AUTHORS file.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
******************************************************************************/
package com.badlogic.gdx.ai.pfa;
/** A {@code PathFinder} that can find a {@link GraphPath path} from one node in an arbitrary {@link Graph graph} to a goal node
* based on information provided by that graph.
*
* A fully implemented path finder can perform both interruptible and non-interruptible searches. If a specific path finder is not
* able to perform one of the two type of search then the corresponding method should throw an
* {@link UnsupportedOperationException}.
*
* @param Type of node
*
* @author davebaol */
public interface PathFinder {
/** Performs a non-interruptible search, trying to find a path made up of connections from the start node to the goal node
* attempting to honor costs provided by the graph.
*
* @param startNode the start node
* @param endNode the end node
* @param heuristic the heuristic function
* @param outPath the output path that will only be filled if a path is found, otherwise it won't get touched.
* @return {@code true} if a path was found; {@code false} otherwise. */
public boolean searchConnectionPath (N startNode, N endNode, Heuristic heuristic, GraphPath> outPath);
/** Performs a non-interruptible search, trying to find a path made up of nodes from the start node to the goal node attempting
* to honor costs provided by the graph.
*
* @param startNode the start node
* @param endNode the end node
* @param heuristic the heuristic function
* @param outPath the output path that will only be filled if a path is found, otherwise it won't get touched.
* @return {@code true} if a path was found; {@code false} otherwise. */
public boolean searchNodePath (N startNode, N endNode, Heuristic heuristic, GraphPath outPath);
/** Performs an interruptible search, trying to find a path made up of nodes from the start node to the goal node attempting to
* honor costs provided by the graph.
*
* @param request the pathfinding request
* @param timeToRun the time in nanoseconds that can be used to advance the search
* @return {@code true} if the search has finished; {@code false} otherwise. */
public boolean search (PathFinderRequest request, long timeToRun);
}