Enum Direction

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Direction>

    public enum Direction
    extends java.lang.Enum<Direction>
    A direction in the plane. As a convenience, directions provide unit vector components (manhattan metric) for both the conventional plane and screen coordinates (y axis reversed).
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      E  
      N  
      NE  
      NW  
      S  
      SE  
      SW  
      W  
    • Field Summary

      Fields 
      Modifier and Type Field Description
      int screenX
      The horizontal distance moved in this direction in screen coordinates.
      int screenY
      The vertical distance moved in this direction in screen coordinates.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Direction valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Direction[] 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
    • Field Detail

      • screenX

        public final int screenX
        The horizontal distance moved in this direction in screen coordinates.
      • screenY

        public final int screenY
        The vertical distance moved in this direction in screen coordinates.
    • Method Detail

      • values

        public static Direction[] 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 (Direction c : Direction.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Direction 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