Enum AxisReferenceFrame
- java.lang.Object
-
- java.lang.Enum<AxisReferenceFrame>
-
- org.apache.commons.geometry.euclidean.threed.rotation.AxisReferenceFrame
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<AxisReferenceFrame>
public enum AxisReferenceFrame extends java.lang.Enum<AxisReferenceFrame>
Enum defining the possible reference frames for locating axis positions during a rotation sequence.
-
-
Constructor Summary
Constructors Modifier Constructor Description private
AxisReferenceFrame()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static AxisReferenceFrame
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static AxisReferenceFrame[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
RELATIVE
public static final AxisReferenceFrame RELATIVE
Defines a relative reference frame for a rotation sequence. Sequences with this type of reference frame are called intrinsic rotations.When using a relative reference frame, each successive axis is located relative to the "thing" being rotated and not to some external frame of reference. For example, say that a rotation sequence is defined around the
x
,y
, andz
axes in that order. The first rotation will occur around the standardx
axis. The second rotation, however, will occur around they
axis after it has been rotated by the first rotation; we can call this new axisy'
. Similarly, the third rotation will occur aroundz''
, which may or may not match the originalz
axis. A good real-world example of this type of situation is an airplane, where a pilot makes a sequence of rotations in order, with each rotation using the airplane's own up/down, left/right, back/forward directions as the frame of reference.
-
ABSOLUTE
public static final AxisReferenceFrame ABSOLUTE
Defines an absolute reference frame for a rotation sequence. Sequences with this type of reference frame are called extrinsic rotations.In contrast with the relative reference frame, the absolute reference frame remains fixed throughout a rotation sequence, with each rotation axis not affected by the rotations.
-
-
Method Detail
-
values
public static AxisReferenceFrame[] 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 (AxisReferenceFrame c : AxisReferenceFrame.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AxisReferenceFrame valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-