eu.id3.face

## Enum PortraitInstruction

- java.lang.Object
- - java.lang.Enum<PortraitInstruction>
  - - eu.id3.face.PortraitInstruction

- All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PortraitInstruction>

      public enum PortraitInstruction
      extends java.lang.Enum<PortraitInstruction>

  Enumerates the instructions to be given to the user for effective portrait capture.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `ADJUST_LIGHTNING` Ensure your face is well-lit.
    `CENTER_FACE` Center your face in the frame.
    `CLOSE_MOUTH` Close your mouth.
    `ENSURE_NEUTRAL_EXPRESSION` Ensure a neutral expression.
    `FACE_PARTIALLY_HIDDEN` Remove any obstacle from your face.
    `IMAGE_OUT_OF_FOCUS` Image is out of focus.
    `LOOK_AWAY` Look away.
    `LOOK_STRAIGHT` Look directly at the camera.
    `LOW_CONTRAST` The image contrast is too low.
    `LOWER_HEAD` Lower your head.
    `MOVE_BACK` Move back from the camera.
    `MOVE_CLOSER` Move closer to the camera.
    `MOVE_DOWN` Move your face lower to align with the camera.
    `MOVE_LEFT` Move your face to the left.
    `MOVE_RIGHT` Move your face to the right.
    `MOVE_UP` Move your face higher to align with the camera.
    `NONE` No instruction given.
    `OPEN_MOUTH` Open your mouth.
    `RAISE_HEAD` Raise your head.
    `REMOVE_FACE_MASK` Remove your face mask.
    `REMOVE_GLASSES` Remove your glasses.
    `REMOVE_HEAD_COVERINGS` Remove any head coverings.
    `REMOVE_SUNGLASSES` Remove your sunglasses.
    `ROTATE_HEAD` Rotate your head in the specified direction.
    `SMILE` Smile.
    `STAY_STILL` Stay still in front of the camera.
    `TURN_HEAD_LEFT` Turn your head to the left.
    `TURN_HEAD_RIGHT` Turn your head to the right.
    `TURN_HEAD_SLIGHTLY` Turn your head slightly.
    `UNBALANCED_COLORS` Image colors are not balanced correctly.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static PortraitInstruction` | `fromValue(int value)` Creates an enumeration value from int.
    `int` | `getValue()` Gets the enumeration value as int.
    `static PortraitInstruction` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
    `static PortraitInstruction[]` | `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

    - #### NONE

          public static final PortraitInstruction NONE

      No instruction given.

    - #### CENTER_FACE

          public static final PortraitInstruction CENTER_FACE

      Center your face in the frame.

    - #### LOOK_STRAIGHT

          public static final PortraitInstruction LOOK_STRAIGHT

      Look directly at the camera.

    - #### LOOK_AWAY

          public static final PortraitInstruction LOOK_AWAY

      Look away.

    - #### ADJUST_LIGHTNING

          public static final PortraitInstruction ADJUST_LIGHTNING

      Ensure your face is well-lit.

    - #### LOW_CONTRAST

          public static final PortraitInstruction LOW_CONTRAST

      The image contrast is too low.

    - #### UNBALANCED_COLORS

          public static final PortraitInstruction UNBALANCED_COLORS

      Image colors are not balanced correctly.

    - #### IMAGE_OUT_OF_FOCUS

          public static final PortraitInstruction IMAGE_OUT_OF_FOCUS

      Image is out of focus.

    - #### MOVE_CLOSER

          public static final PortraitInstruction MOVE_CLOSER

      Move closer to the camera.

    - #### MOVE_BACK

          public static final PortraitInstruction MOVE_BACK

      Move back from the camera.

    - #### MOVE_DOWN

          public static final PortraitInstruction MOVE_DOWN

      Move your face lower to align with the camera.

    - #### MOVE_UP

          public static final PortraitInstruction MOVE_UP

      Move your face higher to align with the camera.

    - #### MOVE_RIGHT

          public static final PortraitInstruction MOVE_RIGHT

      Move your face to the right.

    - #### MOVE_LEFT

          public static final PortraitInstruction MOVE_LEFT

      Move your face to the left.

    - #### STAY_STILL

          public static final PortraitInstruction STAY_STILL

      Stay still in front of the camera.

    - #### CLOSE_MOUTH

          public static final PortraitInstruction CLOSE_MOUTH

      Close your mouth.

    - #### OPEN_MOUTH

          public static final PortraitInstruction OPEN_MOUTH

      Open your mouth.

    - #### SMILE

          public static final PortraitInstruction SMILE

      Smile.

    - #### ENSURE_NEUTRAL_EXPRESSION

          public static final PortraitInstruction ENSURE_NEUTRAL_EXPRESSION

      Ensure a neutral expression.

    - #### FACE_PARTIALLY_HIDDEN

          public static final PortraitInstruction FACE_PARTIALLY_HIDDEN

      Remove any obstacle from your face.

    - #### TURN_HEAD_LEFT

          public static final PortraitInstruction TURN_HEAD_LEFT

      Turn your head to the left.

    - #### TURN_HEAD_RIGHT

          public static final PortraitInstruction TURN_HEAD_RIGHT

      Turn your head to the right.

    - #### RAISE_HEAD

          public static final PortraitInstruction RAISE_HEAD

      Raise your head.

    - #### LOWER_HEAD

          public static final PortraitInstruction LOWER_HEAD

      Lower your head.

    - #### ROTATE_HEAD

          public static final PortraitInstruction ROTATE_HEAD

      Rotate your head in the specified direction.

    - #### TURN_HEAD_SLIGHTLY

          public static final PortraitInstruction TURN_HEAD_SLIGHTLY

      Turn your head slightly.

    - #### REMOVE_HEAD_COVERINGS

          public static final PortraitInstruction REMOVE_HEAD_COVERINGS

      Remove any head coverings.

    - #### REMOVE_FACE_MASK

          public static final PortraitInstruction REMOVE_FACE_MASK

      Remove your face mask.

    - #### REMOVE_GLASSES

          public static final PortraitInstruction REMOVE_GLASSES

      Remove your glasses.

    - #### REMOVE_SUNGLASSES

          public static final PortraitInstruction REMOVE_SUNGLASSES

      Remove your sunglasses.

  - ### Method Detail

    - #### values

          public static PortraitInstruction[] 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 (PortraitInstruction c : PortraitInstruction.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

    - #### valueOf

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

    - #### getValue

          public int getValue()

      Gets the enumeration value as int.
      Returns:
        The value.

    - #### fromValue

          public static PortraitInstruction fromValue(int value)

      Creates an enumeration value from int.
      Parameters:
        `value` - The int value.
      Returns:
        The created PortraitInstruction.

Copyright © id3 Technologies. All rights reserved. eu.id3.face