Module net.anwiba.commons.utilities

Package net.anwiba.commons.utilities.math

Enum Class DirectionOrientation

java.lang.Object

java.lang.Enum<DirectionOrientation>

net.anwiba.commons.utilities.math.DirectionOrientation

All Implemented Interfaces:

Serializable, Comparable<DirectionOrientation>, Constable

public enum DirectionOrientation
extends Enum<DirectionOrientation>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DirectionOrientation.Orientation

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GEOGRAPHIC_NORTH
MATH

Method Summary

Modifier and Type	Method	Description
static DirectionAngle	addClockwise(DirectionAngle direction, Angle angle)
static Angle	between(DirectionAngle direction, DirectionAngle other)
static DirectionAngle	convertTo(DirectionAngle direction, DirectionOrientation orientation)
static DirectionAngle	subtractClockwise(DirectionAngle direction, Angle angle)
static DirectionOrientation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DirectionOrientation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MATH

public static final DirectionOrientation MATH

GEOGRAPHIC_NORTH

public static final DirectionOrientation GEOGRAPHIC_NORTH

Method Details

values

public static DirectionOrientation[] 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 DirectionOrientation 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

convertTo

public static DirectionAngle convertTo(DirectionAngle direction,
 DirectionOrientation orientation)

addClockwise

public static DirectionAngle addClockwise(DirectionAngle direction,
 Angle angle)

subtractClockwise

public static DirectionAngle subtractClockwise(DirectionAngle direction,
 Angle angle)

between

public static Angle between(DirectionAngle direction,
 DirectionAngle other)