Package io.scanbot.sdk.image

Enum ImageOrigin

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ImageOrigin>
    public enum ImageOrigin
extends java.lang.Enum<ImageOrigin>
    Location of the image origin in the image coordinate system.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BOTTOM_LEFT
      Origin is at the bottom left corner of the image.
      BOTTOM_RIGHT
      Origin is at the bottom right corner of the image.
      TOP_LEFT
      Origin is at the top left corner of the image.
      TOP_RIGHT
      Origin is at the top right corner of the image.

    • Method Summary

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

      • TOP_LEFT

        public static final ImageOrigin TOP_LEFT
        Origin is at the top left corner of the image.

      • TOP_RIGHT

        public static final ImageOrigin TOP_RIGHT
        Origin is at the top right corner of the image.

      • BOTTOM_LEFT

        public static final ImageOrigin BOTTOM_LEFT
        Origin is at the bottom left corner of the image.

      • BOTTOM_RIGHT

        public static final ImageOrigin BOTTOM_RIGHT
        Origin is at the bottom right corner of the image.

    • Method Detail

      • values

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

      • valueOf

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