Open topic with navigation

com.hp.lft.sdk

## Class ImageMaskArea

- java.lang.Object
- - com.hp.lft.sdk.ImageMaskArea

-     public class ImageMaskArea
      extends java.lang.Object

  A class representing image mask rectangle areas. You can use it to define a rectangle area to include and/or to exclude.
  If include and exclude areas overlap, the exclude overrides the include.

- - ### Constructor Summary

    Constructor and Description
    `ImageMaskArea()` Initializes a new instance of the ImageMaskArea class that does not receive any rectangles as parameters.
    `ImageMaskArea(java.awt.Rectangle includeRectangle, java.awt.Rectangle excludeRectangle)` Initializes a new instance of the ImageMaskArea class that can get include and exclude areas.

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.awt.Rectangle` | `getExcludeRectangle()` Gets the rectangle area to exclude from the mask image.
    `java.awt.Rectangle` | `getIncludeRectangle()` Gets the rectangle area to include in the mask image.
    `void` | `setExcludeRectangle(java.awt.Rectangle excludeRectangle)` Sets the rectangle area to exclude from the mask image.
    `void` | `setIncludeRectangle(java.awt.Rectangle includeRectangle)` Sets the rectangle area to include in the mask image.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### ImageMaskArea

          public ImageMaskArea()

      Initializes a new instance of the ImageMaskArea class that does not receive any rectangles as parameters.

    - #### ImageMaskArea

          public ImageMaskArea(java.awt.Rectangle includeRectangle,
                               java.awt.Rectangle excludeRectangle)

      Initializes a new instance of the ImageMaskArea class that can get include and exclude areas.
      Parameters:
        `includeRectangle` - The area to include in the mask.
        `excludeRectangle` - The area to exclude from the mask.

  - ### Method Detail

    - #### getIncludeRectangle

          public java.awt.Rectangle getIncludeRectangle()

      Gets the rectangle area to include in the mask image.
      Returns:
        The rectangle area to include in the mask image.

    - #### getExcludeRectangle

          public java.awt.Rectangle getExcludeRectangle()

      Gets the rectangle area to exclude from the mask image.
      If include and exclude areas overlap, the exclude overrides the include.
      Returns:
        The rectangle area to exclude from the mask image.

    - #### setIncludeRectangle

          public void setIncludeRectangle(java.awt.Rectangle includeRectangle)

      Sets the rectangle area to include in the mask image.
      If include and exclude areas overlap, the exclude overrides the include.
      Parameters:
        `includeRectangle` - The area to include in the mask.

    - #### setExcludeRectangle

          public void setExcludeRectangle(java.awt.Rectangle excludeRectangle)

      Sets the rectangle area to exclude from the mask image.
      If include and exclude areas overlap, the exclude overrides the include.
      Parameters:
        `excludeRectangle` - The area to exclude from the mask.