com.b3dgs.lionengine.game.pathfinding
Class Path

java.lang.Object
  extended by com.b3dgs.lionengine.game.pathfinding.Path

public class Path
extends java.lang.Object

A path determined by some path finding algorithm. A series of steps from the starting location to the target location. This includes a step for the initial location.


Constructor Summary
Path()
           
 
Method Summary
 void appendStep(int x, int y)
          Append a step to the path.
 boolean contains(int x, int y)
          Check if this path contains the given step.
 int getLength()
          Get the length of the path, i.e. the number of steps.
 Step getStep(int index)
          Get the step at a given index in the path.
 int getX(int index)
          Get the x coordinate for the step at the given index.
 int getY(int index)
          Get the y coordinate for the step at the given index.
 void prependStep(int x, int y)
          Prepend a step to the path.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Path

public Path()
Method Detail

getLength

public int getLength()
Get the length of the path, i.e. the number of steps.

Returns:
number of steps in this path.

getStep

public Step getStep(int index)
Get the step at a given index in the path.

Parameters:
index - index of the step to retrieve. Note this should be <= 0 and > getLength();
Returns:
step information, the position on the map.

getX

public int getX(int index)
Get the x coordinate for the step at the given index.

Parameters:
index - index of the step whose x coordinate should be retrieved.
Returns:
x coordinate at the step.

getY

public int getY(int index)
Get the y coordinate for the step at the given index.

Parameters:
index - index of the step whose y coordinate should be retrieved.
Returns:
y coordinate at the step.

appendStep

public void appendStep(int x,
                       int y)
Append a step to the path.

Parameters:
x - x coordinate of the new step.
y - y coordinate of the new step.

prependStep

public void prependStep(int x,
                        int y)
Prepend a step to the path.

Parameters:
x - x coordinate of the new step.
y - y coordinate of the new step.

contains

public boolean contains(int x,
                        int y)
Check if this path contains the given step.

Parameters:
x - x coordinate of the step to check for.
y - y coordinate of the step to check for.
Returns:
True if the path contains the given step.