Interface FocusArea


@ForUseOnly public interface FocusArea
A focus area preset available for a specific image.
Since:
5.2.200705
  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull FocusAreaBuilder
    Returns a builder for creating a new FocusArea.
    @NotNull Rectangle
    Bounds as pixels specifying the focus area in relation to the original image size, where the top-left corner is represented by the coordinate 0x0.
    Provides the orientation represented as an optional 2D vector, which is to be considered as the viewing angle and field of view for calculating the total size of a resolution.
    @Nullable String
    A short text describing this focus point as title and tooltip text.
  • Method Details

    • builder

      @NotNull static @NotNull FocusAreaBuilder builder()
      Returns a builder for creating a new FocusArea.
      Returns:
      The builder instance.
      Since:
      5.2.200705
    • getTitle

      @Nullable @Nullable String getTitle()
      A short text describing this focus point as title and tooltip text.
      Returns:
      The focus area title if available.
      Since:
      5.2.200705
    • getBounds

      @NotNull @NotNull Rectangle getBounds()
      Bounds as pixels specifying the focus area in relation to the original image size, where the top-left corner is represented by the coordinate 0x0.
      Returns:
      A rectangle containing the focus area bounds.
      Since:
      5.2.200705
    • getOrientation

      @Nullable Point2D.Double getOrientation()
      Provides the orientation represented as an optional 2D vector, which is to be considered as the viewing angle and field of view for calculating the total size of a resolution. The vector will be evaluated with the center of the focus area as its origin, while x points to the left (negative) and right (positive) and y points up (negative) and down (positive). The vector's magnitude from the center in relation to the total size of the focus area may be used to determine the resolution's orientation and size in relation to the total focus area.
      Returns:
      The focus orientation.
      Since:
      5.2.200705