Package studio.magemonkey.fabled.api.enums

Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

studio.magemonkey.fabled.api.enums.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, Constable

public enum Direction
extends Enum<Direction>

Direction used in the Particle class that are defined by what directions it uses for 2D shapes

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
XY	X-axis and Y-axis
XZ	X-axis and Z-axis
YZ	Y-axis and Z-axis

Method Summary

Modifier and Type	Method	Description
Matrix3D	getMatrix()	Gets the rotation matrix for the direction.
static Direction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Direction[]	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

XY

public static final Direction XY

X-axis and Y-axis

YZ

public static final Direction YZ

Y-axis and Z-axis

XZ

public static final Direction XZ

X-axis and Z-axis

Method Details

values

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

getMatrix

public Matrix3D getMatrix()

Gets the rotation matrix for the direction. This matrix can be used to transform a point from the XY plane into the direction's plane.

Returns:

The rotation matrix