Module com.io7m.jcoords.core

Package com.io7m.jcoords.core.conversion

Enum CAxisSystemHandedness

java.lang.Object

java.lang.Enum<CAxisSystemHandedness>

com.io7m.jcoords.core.conversion.CAxisSystemHandedness

All Implemented Interfaces:

Serializable, Comparable<CAxisSystemHandedness>

public enum CAxisSystemHandedness
extends Enum<CAxisSystemHandedness>

The handedness of a coordinate system.

Enum Constant Summary

Enum Constants

Enum Constant	Description
LEFT_HANDED	The system is left-handed.
RIGHT_HANDED	The system is right-handed.

Method Summary

Modifier and Type	Method	Description
static CAxisSystemHandedness	ofSystem(CAxisSystem system)	Determine the handedness of the coordinate system formed by the given axes.
static CAxisSystemHandedness	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CAxisSystemHandedness[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEFT_HANDED

public static final CAxisSystemHandedness LEFT_HANDED

The system is left-handed.

RIGHT_HANDED

public static final CAxisSystemHandedness RIGHT_HANDED

The system is right-handed.

Method Detail

values

public static CAxisSystemHandedness[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CAxisSystemHandedness c : CAxisSystemHandedness.values())
    System.out.println(c);

Returns:

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

valueOf

public static CAxisSystemHandedness valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

ofSystem

public static CAxisSystemHandedness ofSystem(CAxisSystem system)

Determine the handedness of the coordinate system formed by the given axes.

Parameters:

system - The axes

Returns:

The handedness