walker.blue.path.lib.base

Class AbstractPathfinderNode

java.lang.Object

walker.blue.path.lib.base.AbstractPathfinderNode

All Implemented Interfaces:

java.lang.Comparable<AbstractPathfinderNode>

Direct Known Subclasses:

GraphNode, GridNode

public abstract class AbstractPathfinderNode
extends java.lang.Object
implements java.lang.Comparable<AbstractPathfinderNode>

This abstract class holds basic node information needed to find a path between two nodes in a group of nodes.

Field Summary

Fields

Modifier and Type	Field and Description
protected double	g Distance from the starting node to this node following the current path
protected double	h Estimated distance from this node to the destination node
protected RectCoordinates	location Used to give an x, y, and z position of the node in 3D space.
protected AbstractPathfinderNode	parent Holds the parent node that will help with following the path

Constructor Summary

Constructors

Constructor and Description
AbstractPathfinderNode(int x, int y, int z) Class constructor
AbstractPathfinderNode(RectCoordinates location) Class constructor taking in pre-made RectCoordinates location.

Method Summary

Modifier and Type	Method and Description
int	compareTo(AbstractPathfinderNode another) Calculates the f values of both nodes, which is just the addition of the g and h values, to determine whether the other node is farther or closer to the destination while following the current path.
double	getG() Returns the distance from the node to the start node in the path search taking the current path that reaches this node.
double	getH() Returns the approximate distance from this node to the destination node in the path search.
RectCoordinates	getLocation() Returns the location of the node in the grid
AbstractPathfinderNode	getParent() Gets the parent node of this node
void	setG(double val) Sets the g value for this node.
void	setH(double val) Sets the h value for this node.
void	setParent(AbstractPathfinderNode parent) Sets the parent of this node.
java.lang.String	toString() Returns a formatted String holding the location of the node.

Methods inherited from class java.lang.Object

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

Field Detail

location

protected RectCoordinates location

Used to give an x, y, and z position of the node in 3D space.

parent

protected AbstractPathfinderNode parent

Holds the parent node that will help with following the path

g

protected double g

Distance from the starting node to this node following the current path

h

protected double h

Estimated distance from this node to the destination node

Constructor Detail

AbstractPathfinderNode

public AbstractPathfinderNode(int x,
                              int y,
                              int z)

Class constructor

Parameters:

x - the column the node is located in the grid

y - the row the node is located in the grid

z - the aisle the node is located in the grid

AbstractPathfinderNode

public AbstractPathfinderNode(RectCoordinates location)

Class constructor taking in pre-made RectCoordinates location.

Parameters:

location - the index of the node in the grid

Method Detail

getLocation

public RectCoordinates getLocation()

Returns the location of the node in the grid

Returns:

the location of the node in the grid

getParent

public AbstractPathfinderNode getParent()

Gets the parent node of this node

Returns:

the parent node of this node as an AbstractPathfinderNode

setParent

public void setParent(AbstractPathfinderNode parent)

Sets the parent of this node. Used when calculating a path.

Parameters:

parent - new parent

getG

public double getG()

Returns the distance from the node to the start node in the path search taking the current path that reaches this node.

Returns:

the distance between the start node and this node

setG

public void setG(double val)

Sets the g value for this node. Used when calculating a path.

Parameters:

val - new value of G

getH

public double getH()

Returns the approximate distance from this node to the destination node in the path search.

Returns:

the approximate distance from this node to the destination

setH

public void setH(double val)

Sets the h value for this node. Used when calculating a path.

Parameters:

val - new value of H

compareTo

public int compareTo(AbstractPathfinderNode another)

Calculates the f values of both nodes, which is just the addition of the g and h values, to determine whether the other node is farther or closer to the destination while following the current path.

Specified by:

compareTo in interface java.lang.Comparable<AbstractPathfinderNode>

Parameters:

another - the other AbstractPathfinderNode being compared to this one

Returns:

-1 if this node has a smaller f value, 0 if both nodes have the same f value, 1 if this node has a greater f value

toString

public java.lang.String toString()

Returns a formatted String holding the location of the node.

Overrides:

toString in class java.lang.Object

Returns:

String