java.lang.Object
com.io7m.jregions.core.unparameterized.areas.AreasBD

public final class AreasBD
extends java.lang.Object

Functions over areas.

These functions operate using the concepts of minimum-x, maximum-x, minimum-y, and maximum-y edges. It is up to individual applications to assign meaning to these edges such as "left" for minimum-x and "top" for minimum-y.

  • Method Details

    • create

      public static AreaBD create​(java.math.BigDecimal x, java.math.BigDecimal y, java.math.BigDecimal size_x, java.math.BigDecimal size_y)
      Create an area of size size_x on the X axis and size size_y on the Y axis, placing the minimum corner at (x, y).
      Parameters:
      x - The X value of the minimum corner
      y - The Y value of the minimum corner
      size_x - The size of the area on the X axis
      size_y - The size of the area on the Y axis
      Returns:
      An area
    • contains

      public static boolean contains​(AreaBD a, AreaBD b)

      Determine whether or not one area contains another.

      Containing is reflexive: contains(a, a) == true.

      Containing is transitive: contains(a, b) → contains(b, c) → contains(a, c).

      Containing is not necessarily symmetric.

      Parameters:
      a - Area A
      b - Area B
      Returns:
      true iff a contains b
    • moveRelative

      public static AreaBD moveRelative​(AreaBD area, java.math.BigDecimal x, java.math.BigDecimal y)
      Move the given area by (x, y).
      Parameters:
      area - The area
      x - The amount to move on the X axis
      y - The amount to move on the Y axis
      Returns:
      A moved area
    • moveRelativeClampedX

      public static AreaBD moveRelativeClampedX​(AreaBD container, AreaBD area, java.math.BigDecimal x)
      Move the given area by x, without allowing area to leave container.
      Parameters:
      container - The container area
      area - The area
      x - The amount to move on the X axis
      Returns:
      A moved area
      Since:
      3.0.0
    • moveRelativeClampedY

      public static AreaBD moveRelativeClampedY​(AreaBD container, AreaBD area, java.math.BigDecimal y)
      Move the given area by y, without allowing area to leave container.
      Parameters:
      container - The container area
      area - The area
      y - The amount to move on the Y axis
      Returns:
      A moved area
      Since:
      3.0.0
    • moveRelativeClamped

      public static AreaBD moveRelativeClamped​(AreaBD container, AreaBD area, java.math.BigDecimal x, java.math.BigDecimal y)
      Move the given area by (x, y), without allowing area to leave container.
      Parameters:
      container - The container area
      area - The area
      x - The amount to move on the X axis
      y - The amount to move on the Y axis
      Returns:
      A moved area
      Since:
      3.0.0
    • moveAbsolute

      public static AreaBD moveAbsolute​(AreaBD area, java.math.BigDecimal x, java.math.BigDecimal y)
      Move the given area to (x, y).
      Parameters:
      area - The area
      x - The position to which to move on the X axis
      y - The position to which to move on the Y axis
      Returns:
      A moved area
    • moveToOrigin

      public static AreaBD moveToOrigin​(AreaBD area)
      Move the given area to (0, 0).
      Parameters:
      area - The area
      Returns:
      A moved area
    • alignOnXCenter

      public static AreaBD alignOnXCenter​(AreaBD outer, AreaBD inner)
      Align the area inner along the X axis in the center of outer.
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
      Since:
      1.1.0
    • alignOnXMinX

      public static AreaBD alignOnXMinX​(AreaBD outer, AreaBD inner)
      Equivalent to calling alignOnXMinXOffset(AreaBD, AreaBD, java.math.BigDecimal) with a zero offset.
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
      Since:
      1.1.0
    • alignOnXMinXOffset

      public static AreaBD alignOnXMinXOffset​(AreaBD outer, AreaBD inner, java.math.BigDecimal offset)
      Align the area inner along the X axis against the inside minimum-x edge of outer. The area will be at least offset units from the minimum-x edge.
      Parameters:
      outer - The outer area
      inner - The inner area
      offset - The offset from the edge
      Returns:
      An aligned area
      Since:
      1.1.0
    • alignOnXMaxX

      public static AreaBD alignOnXMaxX​(AreaBD outer, AreaBD inner)
      Equivalent to calling alignOnXMaxXOffset(AreaBD, AreaBD, java.math.BigDecimal) with a zero offset.
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
      Since:
      1.1.0
    • alignOnXMaxXOffset

      public static AreaBD alignOnXMaxXOffset​(AreaBD outer, AreaBD inner, java.math.BigDecimal offset)
      Align the area inner along the X axis against the inside maximum-x edge of outer. The area will be at least offset units from the maximum-x edge.
      Parameters:
      outer - The outer area
      inner - The inner area
      offset - The offset from the edge
      Returns:
      An aligned area
      Since:
      1.1.0
    • alignOnYMinY

      public static AreaBD alignOnYMinY​(AreaBD outer, AreaBD inner)
      Equivalent to calling alignOnYMinYOffset(AreaBD, AreaBD, java.math.BigDecimal) with a zero offset.
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
      Since:
      1.1.0
    • alignOnYMinYOffset

      public static AreaBD alignOnYMinYOffset​(AreaBD outer, AreaBD inner, java.math.BigDecimal offset)
      Align the area inner along the Y axis against the inside minimum-y edge of outer. The area will be at least offset units from the minimum-y edge.
      Parameters:
      outer - The outer area
      inner - The inner area
      offset - The offset from the edge
      Returns:
      An aligned area
      Since:
      1.1.0
    • alignOnYMaxY

      public static AreaBD alignOnYMaxY​(AreaBD outer, AreaBD inner)
      Equivalent to calling alignOnYMaxYOffset(AreaBD, AreaBD, java.math.BigDecimal) with a zero offset.
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
      Since:
      1.1.0
    • alignOnYMaxYOffset

      public static AreaBD alignOnYMaxYOffset​(AreaBD outer, AreaBD inner, java.math.BigDecimal offset)
      Align the area inner along the Y axis against the inside maximum-y edge of outer. The area will be at least offset units from the maximum-y edge.
      Parameters:
      outer - The outer area
      inner - The inner area
      offset - The offset from the edge
      Returns:
      An aligned area
      Since:
      1.1.0
    • alignOnYCenter

      public static AreaBD alignOnYCenter​(AreaBD outer, AreaBD inner)
      Align the area inner along the Y axis in the center of outer.
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
      Since:
      1.1.0
    • alignHorizontallyCenter

      @Deprecated public static AreaBD alignHorizontallyCenter​(AreaBD outer, AreaBD inner)
      Align the area inner horizontally in the center of outer.
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
    • alignHorizontallyMinX

      @Deprecated public static AreaBD alignHorizontallyMinX​(AreaBD outer, AreaBD inner)
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
    • alignHorizontallyMinXOffset

      @Deprecated public static AreaBD alignHorizontallyMinXOffset​(AreaBD outer, AreaBD inner, java.math.BigDecimal offset)
      Align the area inner horizontally against the inside minimum-x edge of outer. The area will be at least offset units from the minimum-x edge.
      Parameters:
      outer - The outer area
      inner - The inner area
      offset - The offset from the edge
      Returns:
      An aligned area
    • alignHorizontallyMaxX

      @Deprecated public static AreaBD alignHorizontallyMaxX​(AreaBD outer, AreaBD inner)
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
    • alignHorizontallyMaxXOffset

      @Deprecated public static AreaBD alignHorizontallyMaxXOffset​(AreaBD outer, AreaBD inner, java.math.BigDecimal offset)
      Align the area inner horizontally against the inside maximum-x edge of outer. The area will be at least offset units from the maximum-x edge.
      Parameters:
      outer - The outer area
      inner - The inner area
      offset - The offset from the edge
      Returns:
      An aligned area
    • alignVerticallyMinY

      @Deprecated public static AreaBD alignVerticallyMinY​(AreaBD outer, AreaBD inner)
      Equivalent to calling alignVerticallyMinYOffset(AreaBD, AreaBD, java.math.BigDecimal) with a zero offset.
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
    • alignVerticallyMinYOffset

      @Deprecated public static AreaBD alignVerticallyMinYOffset​(AreaBD outer, AreaBD inner, java.math.BigDecimal offset)
      Align the area inner vertically against the inside minimum-y edge of outer. The area will be at least offset units from the minimum-y edge.
      Parameters:
      outer - The outer area
      inner - The inner area
      offset - The offset from the edge
      Returns:
      An aligned area
    • alignVerticallyMaxY

      @Deprecated public static AreaBD alignVerticallyMaxY​(AreaBD outer, AreaBD inner)
      Equivalent to calling alignVerticallyMaxYOffset(AreaBD, AreaBD, java.math.BigDecimal) with a zero offset.
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
    • alignVerticallyMaxYOffset

      @Deprecated public static AreaBD alignVerticallyMaxYOffset​(AreaBD outer, AreaBD inner, java.math.BigDecimal offset)
      Align the area inner vertically against the inside maximum-y edge of outer. The area will be at least offset units from the maximum-y edge.
      Parameters:
      outer - The outer area
      inner - The inner area
      offset - The offset from the edge
      Returns:
      An aligned area
    • alignVerticallyCenter

      @Deprecated public static AreaBD alignVerticallyCenter​(AreaBD outer, AreaBD inner)
      Align the area inner vertically in the center of outer.
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
    • alignMinYMinX

      public static AreaBD alignMinYMinX​(AreaBD outer, AreaBD inner)
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
    • alignMinYMinXOffset

      public static AreaBD alignMinYMinXOffset​(AreaBD outer, AreaBD inner, java.math.BigDecimal offset_x, java.math.BigDecimal offset_y)
      Align the area inner such that the minimum-y edge is at least offset_y from the inside minimum-y edge of outer and the minimum-x edge is at least offset_x from the inside minimum-x edge of outer.
      Parameters:
      outer - The outer area
      inner - The inner area
      offset_x - The offset from the minimum-x edge
      offset_y - The offset from the minimum-y edge
      Returns:
      An aligned area
    • alignMinYMaxX

      public static AreaBD alignMinYMaxX​(AreaBD outer, AreaBD inner)
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
    • alignMinYMaxXOffset

      public static AreaBD alignMinYMaxXOffset​(AreaBD outer, AreaBD inner, java.math.BigDecimal offset_x, java.math.BigDecimal offset_y)
      Align the area inner such that the minimum-y edge is at least offset_y from the inside minimum-y edge of outer and the maximum-x edge is at least offset_x from the inside maximum-x edge of outer.
      Parameters:
      outer - The outer area
      inner - The inner area
      offset_x - The offset from the maximum-x edge
      offset_y - The offset from the minimum-y edge
      Returns:
      An aligned area
    • alignMaxYMinX

      public static AreaBD alignMaxYMinX​(AreaBD outer, AreaBD inner)
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
    • alignMaxYMinXOffset

      public static AreaBD alignMaxYMinXOffset​(AreaBD outer, AreaBD inner, java.math.BigDecimal offset_x, java.math.BigDecimal offset_y)
      Align the area inner such that the maximum-y edge is at least offset_y from the inside maximum-y edge of outer and the minimum-x edge is at least offset_x from the inside minimum-x edge of outer.
      Parameters:
      outer - The outer area
      inner - The inner area
      offset_x - The offset from the minimum-x edge
      offset_y - The offset from the maximum-y edge
      Returns:
      An aligned area
    • alignMaxYMaxX

      public static AreaBD alignMaxYMaxX​(AreaBD outer, AreaBD inner)
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
    • alignMaxYMaxXOffset

      public static AreaBD alignMaxYMaxXOffset​(AreaBD outer, AreaBD inner, java.math.BigDecimal offset_x, java.math.BigDecimal offset_y)
      Align the area inner such that the maximum-y edge is at least offset_y from the inside maximum-y edge of outer and the maximum-x edge is at least offset_x from the inside maximum-x edge of outer.
      Parameters:
      outer - The outer area
      inner - The inner area
      offset_x - The offset from the maximum-x edge
      offset_y - The offset from the maximum-y edge
      Returns:
      An aligned area
    • alignCenter

      public static AreaBD alignCenter​(AreaBD outer, AreaBD inner)
      Align the area inner such that the center of the area is equal to the center of outer.
      Parameters:
      outer - The outer area
      inner - The inner area
      Returns:
      An aligned area
    • hollowOut

      public static AreaBD hollowOut​(AreaBD outer, java.math.BigDecimal min_x_offset, java.math.BigDecimal max_x_offset, java.math.BigDecimal min_y_offset, java.math.BigDecimal max_y_offset)
      Construct a new area that fits inside outer based on the given offsets from each edge.
      Parameters:
      outer - The containing area
      min_x_offset - The offset from the minimum-x edge (must be non-negative)
      max_x_offset - The offset from the maximum-x edge (must be non-negative)
      min_y_offset - The offset from the minimum-y edge (must be non-negative)
      max_y_offset - The offset from the maximum-y edge (must be non-negative)
      Returns:
      A new area
    • hollowOutEvenly

      public static AreaBD hollowOutEvenly​(AreaBD outer, java.math.BigDecimal offset)
      Parameters:
      outer - The containing area
      offset - The offset from each edge (must be non-negative)
      Returns:
      A new area
    • setSizeFromCenter

      public static AreaBD setSizeFromCenter​(AreaBD area, java.math.BigDecimal sizeX, java.math.BigDecimal sizeY)

      Set the sizeX and sizeY of area to sizeX and sizeY, respectively.

      The area is resized from its own center.

      Parameters:
      area - The area
      sizeX - The new sizeX (must be non-negative)
      sizeY - The new sizeY (must be non-negative)
      Returns:
      A resized area
    • setSizeFromMinYMinX

      public static AreaBD setSizeFromMinYMinX​(AreaBD area, java.math.BigDecimal sizeX, java.math.BigDecimal sizeY)

      Set the sizeX and sizeY of area to sizeX and sizeY, respectively.

      The area is resized by moving its minimum-y-minimum-x corner.

      Parameters:
      area - The area
      sizeX - The new sizeX (must be non-negative)
      sizeY - The new sizeY (must be non-negative)
      Returns:
      A resized area
    • setSizeFromMinYMaxX

      public static AreaBD setSizeFromMinYMaxX​(AreaBD area, java.math.BigDecimal sizeX, java.math.BigDecimal sizeY)

      Set the sizeX and sizeY of area to sizeX and sizeY, respectively.

      The area is resized by moving its minimum-y-maximum-x corner.

      Parameters:
      area - The area
      sizeX - The new sizeX (must be non-negative)
      sizeY - The new sizeY (must be non-negative)
      Returns:
      A resized area
    • setSizeFromMaxYMaxX

      public static AreaBD setSizeFromMaxYMaxX​(AreaBD area, java.math.BigDecimal sizeX, java.math.BigDecimal sizeY)

      Set the sizeX and sizeY of area to sizeX and sizeY, respectively.

      The area is resized by moving its maximum-y-maximum-x corner.

      Parameters:
      area - The area
      sizeX - The new sizeX (must be non-negative)
      sizeY - The new sizeY (must be non-negative)
      Returns:
      A resized area
    • setSizeFromMaxYMinX

      public static AreaBD setSizeFromMaxYMinX​(AreaBD area, java.math.BigDecimal sizeX, java.math.BigDecimal sizeY)

      Set the sizeX and sizeY of area to sizeX and sizeY, respectively.

      The area is resized by moving its maximum-y-minimum-x corner.

      Parameters:
      area - The area
      sizeX - The new sizeX (must be non-negative)
      sizeY - The new sizeY (must be non-negative)
      Returns:
      A resized area
    • scaleFromMinYMinX

      public static AreaBD scaleFromMinYMinX​(AreaBD area, java.math.BigDecimal x_diff, java.math.BigDecimal y_diff)

      Scale area by adding x_diff to the sizeX, and y_diff to the sizeY. The size of the resulting area is clamped so that its sizeX and sizeY are always non-negative.

      The area is resized by moving its minimum-y-minimum-x corner.

      Parameters:
      area - The area
      x_diff - The X difference
      y_diff - The Y difference
      Returns:
      A resized area
    • scaleFromMinYMaxX

      public static AreaBD scaleFromMinYMaxX​(AreaBD area, java.math.BigDecimal x_diff, java.math.BigDecimal y_diff)

      Scale area by adding x_diff to the sizeX, and y_diff to the sizeY. The size of the resulting area is clamped so that its sizeX and sizeY are always non-negative.

      The area is resized by moving its minimum-y-maximum-x corner.

      Parameters:
      area - The area
      x_diff - The X difference
      y_diff - The Y difference
      Returns:
      A resized area
    • scaleFromMaxYMinX

      public static AreaBD scaleFromMaxYMinX​(AreaBD area, java.math.BigDecimal x_diff, java.math.BigDecimal y_diff)

      Scale area by adding x_diff to the sizeX, and y_diff to the sizeY. The size of the resulting area is clamped so that its sizeX and sizeY are always non-negative.

      The area is resized by moving its maximum-y-minimum-x corner.

      Parameters:
      area - The area
      x_diff - The X difference
      y_diff - The Y difference
      Returns:
      A resized area
    • scaleFromMaxYMaxX

      public static AreaBD scaleFromMaxYMaxX​(AreaBD area, java.math.BigDecimal x_diff, java.math.BigDecimal y_diff)

      Scale area by adding x_diff to the sizeX, and y_diff to the sizeY. The size of the resulting area is clamped so that its sizeX and sizeY are always non-negative.

      The area is resized by moving its maximum-y-maximum-x corner.

      Parameters:
      area - The area
      x_diff - The X difference
      y_diff - The Y difference
      Returns:
      A resized area
    • scaleFromCenter

      public static AreaBD scaleFromCenter​(AreaBD area, java.math.BigDecimal x_diff, java.math.BigDecimal y_diff)

      Scale area by adding x_diff to the sizeX, and y_diff to the sizeY. The size of the resulting area is clamped so that its sizeX and sizeY are always non-negative.

      The area is resized from its own center.

      Parameters:
      area - The area
      x_diff - The X difference
      y_diff - The Y difference
      Returns:
      A resized area
    • overlaps

      public static boolean overlaps​(AreaBD a, AreaBD b)

      Determine whether or not two areas overlap.

      Overlapping is reflexive: overlaps(a, a) == true.

      Overlapping is symmetric: overlaps(a, b) == overlaps(b, a).

      Overlapping is not necessarily transitive.

      Parameters:
      a - An area
      b - An area
      Returns:
      true iff a overlaps b
    • couldFitInside

      public static boolean couldFitInside​(AreaBD a, AreaBD b)

      Determine whether or not one area could fit inside another.

      Fitting is reflexive: couldFitInside(a, a) == true.

      Fitting is transitive: couldFitInside(a, b) → couldFitInside(b, c) → couldFitInside(a, c).

      Fitting is not necessarily symmetric.

      Parameters:
      a - An area
      b - An area
      Returns:
      true iff a could fit inside b
    • containing

      public static AreaBD containing​(AreaBD a, AreaBD b)
      Construct a area that will contain both a and b.
      Parameters:
      a - An area
      b - An area
      Returns:
      An area containing a and b
    • containsPoint

      public static boolean containsPoint​(AreaBD a, java.math.BigDecimal x, java.math.BigDecimal y)

      Determine whether or not a area contains a given point.

      Parameters:
      a - An area
      x - The X coordinate of the point
      y - The Y coordinate of the point
      Returns:
      true iff a contains (x, y)
    • fitBetweenHorizontal

      @Deprecated public static AreaBD fitBetweenHorizontal​(AreaBD fit, AreaBD a, AreaBD b)
      Attempt to fit fit between a and b, horizontally.
      Parameters:
      fit - The area to be fitted
      a - An area
      b - An area
      Returns:
      A fitted area
    • fitBetweenVertical

      @Deprecated public static AreaBD fitBetweenVertical​(AreaBD fit, AreaBD a, AreaBD b)
      Attempt to fit fit between a and b, vertically.
      Parameters:
      fit - The area to be fitted
      a - An area
      b - An area
      Returns:
      A fitted area
    • fitBetweenOnX

      public static AreaBD fitBetweenOnX​(AreaBD fit, AreaBD a, AreaBD b)
      Attempt to fit fit between a and b, horizontally.
      Parameters:
      fit - The area to be fitted
      a - An area
      b - An area
      Returns:
      A fitted area
    • fitBetweenOnY

      public static AreaBD fitBetweenOnY​(AreaBD fit, AreaBD a, AreaBD b)
      Attempt to fit fit between a and b, vertically.
      Parameters:
      fit - The area to be fitted
      a - An area
      b - An area
      Returns:
      A fitted area
    • splitAlongParallelToX

      public static AreaXSplitBD<AreaBD> splitAlongParallelToX​(AreaBD area, java.math.BigDecimal y)
      Split area along a line parallel to the X axis placed at y units from its own minimum-y edge.
      Parameters:
      area - The area to be split
      y - The relative Y coordinate of the splitting edge
      Returns:
      A pair of areas
    • splitAlongParallelToY

      public static AreaYSplitBD<AreaBD> splitAlongParallelToY​(AreaBD area, java.math.BigDecimal x)
      Split area along a line parallel to the Y axis placed at x units from its own minimum-x edge.
      Parameters:
      area - The area to be split
      x - The relative X coordinate of the splitting edge
      Returns:
      A pair of areas
    • splitAlongXY

      public static AreaXYSplitBD<AreaBD> splitAlongXY​(AreaBD area, java.math.BigDecimal x, java.math.BigDecimal y)
      Split area along a two axis-aligned perpendicular lines that intercept at (x, y).
      Parameters:
      area - The area to be split
      x - The relative X coordinate of the splitting edge
      y - The relative Y coordinate of the splitting edge
      Returns:
      The four resulting quadrants
      Since:
      1.1.0
    • show

      public static java.lang.String show​(AreaBD area)
      Parameters:
      area - The area
      Returns:
      A terse string describing the position and size of the area
    • size

      public static AreaSizeBD size​(AreaBD area)
      Parameters:
      area - The area
      Returns:
      The size of the area
    • showToBuilder

      public static java.lang.String showToBuilder​(AreaBD area, java.lang.StringBuilder sb)
      Parameters:
      area - The area
      sb - A string builder
      Returns:
      A terse string describing the position and size of the area