Package org.geotools.grid.hexagon

Enum HexagonOrientation

  • All Implemented Interfaces:
    Serializable, Comparable<HexagonOrientation>
    public enum HexagonOrientation
extends Enum<HexagonOrientation>
    Constants to describe the orientation of a Hexagon.
    • An ANGLED element has a "pointy" top with a single vertex touching the upper edge of its bounding rectangle.
    • A FLAT element has edges that run along the upper and lower edges of its bounding rectangle
    Author:
    michael

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ANGLED
      An ANGLED element has a "pointy" top with a single vertex touching the upper edge of its bounding rectangle.
      FLAT
      A FLAT element has edges that run along the upper and lower edges of its bounding rectangle

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static HexagonOrientation valueOf​(String name)
      Returns the enum constant of this type with the specified name.
      static HexagonOrientation[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class Enum

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

      • Methods inherited from class Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • ANGLED

        public static final HexagonOrientation ANGLED
        An ANGLED element has a "pointy" top with a single vertex touching the upper edge of its bounding rectangle.

      • FLAT

        public static final HexagonOrientation FLAT
        A FLAT element has edges that run along the upper and lower edges of its bounding rectangle

    • Method Detail

      • values

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

      • valueOf

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