Module com.marginallyclever.robotoverlord

Package com.marginallyclever.ro3

Enum Class FrameOfReference

java.lang.Object

java.lang.Enum<FrameOfReference>

com.marginallyclever.ro3.FrameOfReference

All Implemented Interfaces:

Serializable, Comparable<FrameOfReference>, Constable

public enum FrameOfReference
extends Enum<FrameOfReference>

Used for determining the frame of reference for a given operation in 3D space.

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
CAMERA
LOCAL
WORLD

Method Summary

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

Enum Constant Details

WORLD

public static final FrameOfReference WORLD

LOCAL

public static final FrameOfReference LOCAL

CAMERA

public static final FrameOfReference CAMERA

Method Details

values

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