Package org.rspeer.commons.math

Enum Class Distance

java.lang.Object

java.lang.Enum<Distance>

org.rspeer.commons.math.Distance

All Implemented Interfaces:

Serializable, Comparable<Distance>, Constable, DistanceEvaluator

public enum Distance
extends Enum<Distance>
implements DistanceEvaluator

Enum containing various DistanceEvaluator's

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHEBYSHEV
EUCLIDEAN
EUCLIDEAN_SQUARED
MANHATTAN
PATHING	This implementation may return Double.MAX_VALUE if the positions are on varying levels, or Integer.MAX_VALUE if pathfinding failed.

Method Summary

Modifier and Type	Method	Description
static double	between(SceneNode from, SceneNode to)
abstract double	evaluate(int x1, int y1, int level1, int x2, int y2, int level2)
static double	evaluate(DistanceEvaluator algo, SceneNode from, SceneNode to)
static DistanceEvaluator	getDefaultEvaluator()
static Distance	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Distance[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.rspeer.commons.math.DistanceEvaluator

evaluate

Enum Constant Details

EUCLIDEAN

public static final Distance EUCLIDEAN

EUCLIDEAN_SQUARED

public static final Distance EUCLIDEAN_SQUARED

MANHATTAN

public static final Distance MANHATTAN

CHEBYSHEV

public static final Distance CHEBYSHEV

PATHING

public static final Distance PATHING

This implementation may return Double.MAX_VALUE if the positions are on varying levels, or Integer.MAX_VALUE if pathfinding failed.

Method Details

values

public static Distance[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Distance valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getDefaultEvaluator

public static DistanceEvaluator getDefaultEvaluator()

between

public static double between(SceneNode from,
 SceneNode to)

evaluate

public static double evaluate(DistanceEvaluator algo,
 SceneNode from,
 SceneNode to)

evaluate

public abstract double evaluate(int x1,
 int y1,
 int level1,
 int x2,
 int y2,
 int level2)

Specified by:

evaluate in interface DistanceEvaluator