Package de.metaphoriker.pathetic.api.pathing.configuration

Class HeuristicWeights

java.lang.Object

de.metaphoriker.pathetic.api.pathing.configuration.HeuristicWeights

public final class HeuristicWeights
extends Object

Represents a set of weights used to calculate a heuristic for the A* pathfinding algorithm. These weights influence the prioritization of different path characteristics during the search.

This class defines weights for the following distance metrics:

• Manhattan Distance: Prioritizes direct movement along axes.
• Octile Distance: Allows for diagonal movement for finer-grained pathing.
• Perpendicular Distance: Penalizes deviation from the straight line to the target, aiding in smoother paths.
• Height Difference: Factors in elevation changes when calculating path costs.

Field Summary

Fields

Modifier and Type	Field	Description
static final HeuristicWeights	DIRECT_PATH_WEIGHTS	Provides a set of weights strongly prioritizing the shortest direct path, even if diagonally.
static final HeuristicWeights	NATURAL_PATH_WEIGHTS	Provides a set of default heuristic weights that may be suitable for natural pathfinding.

Method Summary

Modifier and Type	Method	Description
static HeuristicWeights	create(double manhattanWeight, double octileWeight, double perpendicularWeight, double heightWeight)
boolean	equals(Object o)
double	getHeightWeight()
double	getManhattanWeight()
double	getOctileWeight()
double	getPerpendicularWeight()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NATURAL_PATH_WEIGHTS

public static final HeuristicWeights NATURAL_PATH_WEIGHTS

Provides a set of default heuristic weights that may be suitable for natural pathfinding. These values can be adjusted for specific scenarios.

DIRECT_PATH_WEIGHTS

public static final HeuristicWeights DIRECT_PATH_WEIGHTS

Provides a set of weights strongly prioritizing the shortest direct path, even if diagonally.

Method Details

create

public static HeuristicWeights create(double manhattanWeight,
 double octileWeight,
 double perpendicularWeight,
 double heightWeight)

getManhattanWeight

public double getManhattanWeight()

getOctileWeight

public double getOctileWeight()

getPerpendicularWeight

public double getPerpendicularWeight()

getHeightWeight

public double getHeightWeight()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object