Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni.enumerate

Enum Class EAxis

java.lang.Object

java.lang.Enum<EAxis>

com.github.stephengold.joltjni.enumerate.EAxis

All Implemented Interfaces:

Serializable, Comparable<EAxis>, Constable

public enum EAxis
extends Enum<EAxis>

Enumerate the degrees of freedom in a SixDofConstraint. (native type: SixDOFConstraintSettings::EAxis)

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
Num	total number of degrees of freedom
RotationX	X-axis rotation
RotationY	Y-axis rotation
RotationZ	Z-axis rotation
TranslationX	X-axis translation
TranslationY	Y-axis translation
TranslationZ	Z-axis translation

Method Summary

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

TranslationX

public static final EAxis TranslationX

X-axis translation

TranslationY

public static final EAxis TranslationY

Y-axis translation

TranslationZ

public static final EAxis TranslationZ

Z-axis translation

RotationX

public static final EAxis RotationX

X-axis rotation

RotationY

public static final EAxis RotationY

Y-axis rotation

RotationZ

public static final EAxis RotationZ

Z-axis rotation

Num

public static final EAxis Num

total number of degrees of freedom

Method Details

values

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