Enum 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.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ABSOLUTE
      Defines an absolute reference frame for a rotation sequence.
      RELATIVE
      Defines a relative reference frame for 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.
      • 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

      • 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, and z axes in that order. The first rotation will occur around the standard x axis. The second rotation, however, will occur around the y axis after it has been rotated by the first rotation; we can call this new axis y'. Similarly, the third rotation will occur around z'', which may or may not match the original z 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.

    • Constructor Detail

      • AxisReferenceFrame

        private AxisReferenceFrame()
    • 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 name
        java.lang.NullPointerException - if the argument is null