Package heronarts.lx.pattern.form

Enum Class OrboxPattern.Shape

java.lang.Object

java.lang.Enum<OrboxPattern.Shape>

heronarts.lx.pattern.form.OrboxPattern.Shape

All Implemented Interfaces:

Serializable, Comparable<OrboxPattern.Shape>, Constable

Enclosing class:

OrboxPattern

public static enum OrboxPattern.Shape
extends Enum<OrboxPattern.Shape>

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
BOX
CYLINDER
NONE
ORB
SQUARE
X
Y
Z

Field Summary

Fields

Modifier and Type	Field	Description
final heronarts.lx.pattern.form.OrboxPattern.DistanceFunction	distance
final String	label

Method Summary

Modifier and Type	Method	Description
String	toString()
static OrboxPattern.Shape	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OrboxPattern.Shape[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final OrboxPattern.Shape NONE

BOX

public static final OrboxPattern.Shape BOX

ORB

public static final OrboxPattern.Shape ORB

SQUARE

public static final OrboxPattern.Shape SQUARE

CYLINDER

public static final OrboxPattern.Shape CYLINDER

X

public static final OrboxPattern.Shape X

Y

public static final OrboxPattern.Shape Y

Z

public static final OrboxPattern.Shape Z

Field Details

label

public final String label

distance

public final heronarts.lx.pattern.form.OrboxPattern.DistanceFunction distance

Method Details

values

public static OrboxPattern.Shape[] 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 OrboxPattern.Shape 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

toString

public String toString()

Overrides:

toString in class Enum<OrboxPattern.Shape>