org.xguzm.pathfinding.grid.finders

Class GridFinderOptions

java.lang.Object

org.xguzm.pathfinding.PathFinderOptions

org.xguzm.pathfinding.grid.finders.GridFinderOptions

public class GridFinderOptions
extends PathFinderOptions

The options for the pathfinding behavior on a NavigationGridGraph.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowDiagonal Wether diagonal movement is allowed within the grid.
float	diagonalMovementCost The cost of moving one cell over both the x and y axis
boolean	dontCrossCorners When true, diagonal movement requires both neighbors to be open.
boolean	isYDown When false, (0,0) is located at the bottom left of the grid.
float	orthogonalMovementCost The cost of moving one cell over the x or y axis

Fields inherited from class org.xguzm.pathfinding.PathFinderOptions

heuristic

Constructor Summary

Constructors

Constructor and Description
GridFinderOptions() Constructs a new GridFinderOptions with the default values:
GridFinderOptions(boolean allowDiagonals, boolean dontCrossCorners, Heuristic heuristic, boolean isyDown, float orthogonalMovementCost, float diagonalMovementCost)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

allowDiagonal

public boolean allowDiagonal

Wether diagonal movement is allowed within the grid.

Note: This will be ignored in JumpPointFinder, as diagonal movement is required for it

Default value is true

dontCrossCorners

public boolean dontCrossCorners

When true, diagonal movement requires both neighbors to be open. When false, diagonal movement can be achieved by having only one open nighbor

Example: To go from (1,1) to (2,2) when this is set to true, where (x) denotes a non walkable cell, the following applies

                 Valid           Invalid
             +---+---+---+    +---+---+---+
             |   |   | 0 |    |   | x | 0 |
             +---+---+---+    +---+---+---+
 when True   |   | 0 |   |    |   | 0 |   |
             +---+---+---+    +---+---+---+
             |   |   |   |    |   |   |   |
             +---+---+---+    +---+---+---+
  
             
             +---+---+---+    
             |   | x | 0 |    
             +---+---+---+    
 when false  |   | 0 |   |    none
             +---+---+---+    
             |   |   |   |    
             +---+---+---+    
 

If allowDiagonal is false, this setting is ignored.

Default value is true

isYDown

public boolean isYDown

When false, (0,0) is located at the bottom left of the grid. When true, (0,0) is located at the top left of the grid

Default value is false

orthogonalMovementCost

public float orthogonalMovementCost

The cost of moving one cell over the x or y axis

diagonalMovementCost

public float diagonalMovementCost

The cost of moving one cell over both the x and y axis

Constructor Detail

GridFinderOptions

public GridFinderOptions()

Constructs a new GridFinderOptions with the default values:

 allowDiagonal = true  
 dontCrossCorners = true
 PathFinderOptions.heuristic = ManhattanDistance
 isYDown = false
 orthogonalMovementCost = 1
 diagonalMovementCost = 1.4
 

GridFinderOptions

public GridFinderOptions(boolean allowDiagonals,
                         boolean dontCrossCorners,
                         Heuristic heuristic,
                         boolean isyDown,
                         float orthogonalMovementCost,
                         float diagonalMovementCost)