## Uses of Class
com.io7m.jregions.core.unparameterized.areas.AreaBI

- Packages that use AreaBI
  Package | Description
  --- | ---
  com.io7m.jregions.core.unparameterized.areas | Area types.
  com.io7m.jregions.generators | Quickcheck generators.

- - ### Uses of AreaBI in com.io7m.jregions.core.unparameterized.areas

    Methods in com.io7m.jregions.core.unparameterized.areas that return AreaBI
    Modifier and Type | Method and Description
    --- | ---
    `static AreaBI` | AreasBI.`alignCenter(AreaBI outer, AreaBI inner)` Align the area `inner` such that the center of the area is equal to the center of `outer`.
    `static AreaBI` | AreasBI.`alignHorizontallyCenter(AreaBI outer, AreaBI inner)` Align the area `inner` horizontally in the center of `outer`.
    `static AreaBI` | AreasBI.`alignHorizontallyMaxX(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignHorizontallyMaxXOffset(AreaBI, AreaBI, java.math.BigInteger)` with a zero offset.
    `static AreaBI` | AreasBI.`alignHorizontallyMaxXOffset(AreaBI outer, AreaBI inner, BigInteger offset)` Align the area `inner` horizontally against the inside maximum-x edge of `outer`.
    `static AreaBI` | AreasBI.`alignHorizontallyMinX(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignHorizontallyMinXOffset(AreaBI, AreaBI, java.math.BigInteger)` with a zero offset.
    `static AreaBI` | AreasBI.`alignHorizontallyMinXOffset(AreaBI outer, AreaBI inner, BigInteger offset)` Align the area `inner` horizontally against the inside minimum-x edge of `outer`.
    `static AreaBI` | AreasBI.`alignMaxYMaxX(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignMaxYMaxXOffset(AreaBI, AreaBI, java.math.BigInteger, java.math.BigInteger)` with zero offsets.
    `static AreaBI` | AreasBI.`alignMaxYMaxXOffset(AreaBI outer, AreaBI inner, BigInteger offset_x, BigInteger 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`.
    `static AreaBI` | AreasBI.`alignMaxYMinX(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignMaxYMinXOffset(AreaBI, AreaBI, java.math.BigInteger, java.math.BigInteger)` with zero offsets.
    `static AreaBI` | AreasBI.`alignMaxYMinXOffset(AreaBI outer, AreaBI inner, BigInteger offset_x, BigInteger 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`.
    `static AreaBI` | AreasBI.`alignMinYMaxX(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignMinYMaxXOffset(AreaBI, AreaBI, java.math.BigInteger, java.math.BigInteger)` with zero offsets.
    `static AreaBI` | AreasBI.`alignMinYMaxXOffset(AreaBI outer, AreaBI inner, BigInteger offset_x, BigInteger 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`.
    `static AreaBI` | AreasBI.`alignMinYMinX(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignMinYMinXOffset(AreaBI, AreaBI, java.math.BigInteger, java.math.BigInteger)` with zero offsets.
    `static AreaBI` | AreasBI.`alignMinYMinXOffset(AreaBI outer, AreaBI inner, BigInteger offset_x, BigInteger 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`.
    `static AreaBI` | AreasBI.`alignVerticallyCenter(AreaBI outer, AreaBI inner)` Align the area `inner` vertically in the center of `outer`.
    `static AreaBI` | AreasBI.`alignVerticallyMaxY(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignVerticallyMaxYOffset(AreaBI, AreaBI, java.math.BigInteger)` with a zero offset.
    `static AreaBI` | AreasBI.`alignVerticallyMaxYOffset(AreaBI outer, AreaBI inner, BigInteger offset)` Align the area `inner` vertically against the inside maximum-y edge of `outer`.
    `static AreaBI` | AreasBI.`alignVerticallyMinY(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignVerticallyMinYOffset(AreaBI, AreaBI, java.math.BigInteger)` with a zero offset.
    `static AreaBI` | AreasBI.`alignVerticallyMinYOffset(AreaBI outer, AreaBI inner, BigInteger offset)` Align the area `inner` vertically against the inside minimum-y edge of `outer`.
    `AreaBI` | AreaBI.Builder.`build()` Builds a new `AreaBI`.
    `static AreaBI` | AreasBI.`containing(AreaBI a, AreaBI b)` Construct a area that will contain both `a` and `b`.
    `static AreaBI` | AreasBI.`create(BigInteger x, BigInteger y, BigInteger width, BigInteger height)` Create an area of width `width` and height `height`, placing the minimum corner at `(x, y)`.
    `static AreaBI` | AreasBI.`fitBetweenHorizontal(AreaBI fit, AreaBI a, AreaBI b)` Attempt to fit `fit` between `a` and `b`, horizontally.
    `static AreaBI` | AreasBI.`fitBetweenVertical(AreaBI fit, AreaBI a, AreaBI b)` Attempt to fit `fit` between `a` and `b`, vertically.
    `static AreaBI` | AreasBI.`hollowOut(AreaBI outer, BigInteger min_x_offset, BigInteger max_x_offset, BigInteger min_y_offset, BigInteger max_y_offset)` Construct a new area that fits inside `outer` based on the given offsets from each edge.
    `static AreaBI` | AreasBI.`hollowOutEvenly(AreaBI outer, BigInteger offset)` Equivalent to calling `AreasBI.hollowOut(AreaBI, java.math.BigInteger, java.math.BigInteger, java.math.BigInteger, java.math.BigInteger)` with `offset` for all offset parameters.
    `static AreaBI` | AreasBI.`moveAbsolute(AreaBI area, BigInteger x, BigInteger y)` Move the given area to `(x, y)`.
    `static AreaBI` | AreasBI.`moveRelative(AreaBI area, BigInteger x, BigInteger y)` Move the given area by `(x, y)`.
    `static AreaBI` | AreasBI.`moveToOrigin(AreaBI area)` Move the given area to `(0, 0)`.
    `static AreaBI` | AreaBI.`of(BigInteger minimumX, BigInteger maximumX, BigInteger minimumY, BigInteger maximumY)` Construct a new immutable `AreaBI` instance.
    `static AreaBI` | AreasBI.`scaleFromCenter(AreaBI area, BigInteger x_diff, BigInteger y_diff)` Scale `area` by adding `x_diff` to the width, and `y_diff` to the height.
    `static AreaBI` | AreasBI.`scaleFromMaxYMaxX(AreaBI area, BigInteger x_diff, BigInteger y_diff)` Scale `area` by adding `x_diff` to the width, and `y_diff` to the height.
    `static AreaBI` | AreasBI.`scaleFromMaxYMinX(AreaBI area, BigInteger x_diff, BigInteger y_diff)` Scale `area` by adding `x_diff` to the width, and `y_diff` to the height.
    `static AreaBI` | AreasBI.`scaleFromMinYMaxX(AreaBI area, BigInteger x_diff, BigInteger y_diff)` Scale `area` by adding `x_diff` to the width, and `y_diff` to the height.
    `static AreaBI` | AreasBI.`scaleFromMinYMinX(AreaBI area, BigInteger x_diff, BigInteger y_diff)` Scale `area` by adding `x_diff` to the width, and `y_diff` to the height.
    `static AreaBI` | AreasBI.`setSizeFromCenter(AreaBI area, BigInteger width, BigInteger height)` Set the width and height of `area` to `width` and `height`, respectively.
    `static AreaBI` | AreasBI.`setSizeFromMaxYMaxX(AreaBI area, BigInteger width, BigInteger height)` Set the width and height of `area` to `width` and `height`, respectively.
    `static AreaBI` | AreasBI.`setSizeFromMaxYMinX(AreaBI area, BigInteger width, BigInteger height)` Set the width and height of `area` to `width` and `height`, respectively.
    `static AreaBI` | AreasBI.`setSizeFromMinYMaxX(AreaBI area, BigInteger width, BigInteger height)` Set the width and height of `area` to `width` and `height`, respectively.
    `static AreaBI` | AreasBI.`setSizeFromMinYMinX(AreaBI area, BigInteger width, BigInteger height)` Set the width and height of `area` to `width` and `height`, respectively.

    Methods in com.io7m.jregions.core.unparameterized.areas that return types with arguments of type AreaBI
    Modifier and Type | Method and Description
    --- | ---
    `static AreaXSplitBI<AreaBI>` | AreasBI.`splitAlongParallelToX(AreaBI area, BigInteger y)` Split `area` along a line parallel to the X axis placed at `y` units from its own minimum-y edge.
    `static AreaYSplitBI<AreaBI>` | AreasBI.`splitAlongParallelToY(AreaBI area, BigInteger x)` Split `area` along a line parallel to the Y axis placed at `x` units from its own minimum-x edge.

    Methods in com.io7m.jregions.core.unparameterized.areas with parameters of type AreaBI
    Modifier and Type | Method and Description
    --- | ---
    `static AreaBI` | AreasBI.`alignCenter(AreaBI outer, AreaBI inner)` Align the area `inner` such that the center of the area is equal to the center of `outer`.
    `static AreaBI` | AreasBI.`alignHorizontallyCenter(AreaBI outer, AreaBI inner)` Align the area `inner` horizontally in the center of `outer`.
    `static AreaBI` | AreasBI.`alignHorizontallyMaxX(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignHorizontallyMaxXOffset(AreaBI, AreaBI, java.math.BigInteger)` with a zero offset.
    `static AreaBI` | AreasBI.`alignHorizontallyMaxXOffset(AreaBI outer, AreaBI inner, BigInteger offset)` Align the area `inner` horizontally against the inside maximum-x edge of `outer`.
    `static AreaBI` | AreasBI.`alignHorizontallyMinX(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignHorizontallyMinXOffset(AreaBI, AreaBI, java.math.BigInteger)` with a zero offset.
    `static AreaBI` | AreasBI.`alignHorizontallyMinXOffset(AreaBI outer, AreaBI inner, BigInteger offset)` Align the area `inner` horizontally against the inside minimum-x edge of `outer`.
    `static AreaBI` | AreasBI.`alignMaxYMaxX(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignMaxYMaxXOffset(AreaBI, AreaBI, java.math.BigInteger, java.math.BigInteger)` with zero offsets.
    `static AreaBI` | AreasBI.`alignMaxYMaxXOffset(AreaBI outer, AreaBI inner, BigInteger offset_x, BigInteger 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`.
    `static AreaBI` | AreasBI.`alignMaxYMinX(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignMaxYMinXOffset(AreaBI, AreaBI, java.math.BigInteger, java.math.BigInteger)` with zero offsets.
    `static AreaBI` | AreasBI.`alignMaxYMinXOffset(AreaBI outer, AreaBI inner, BigInteger offset_x, BigInteger 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`.
    `static AreaBI` | AreasBI.`alignMinYMaxX(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignMinYMaxXOffset(AreaBI, AreaBI, java.math.BigInteger, java.math.BigInteger)` with zero offsets.
    `static AreaBI` | AreasBI.`alignMinYMaxXOffset(AreaBI outer, AreaBI inner, BigInteger offset_x, BigInteger 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`.
    `static AreaBI` | AreasBI.`alignMinYMinX(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignMinYMinXOffset(AreaBI, AreaBI, java.math.BigInteger, java.math.BigInteger)` with zero offsets.
    `static AreaBI` | AreasBI.`alignMinYMinXOffset(AreaBI outer, AreaBI inner, BigInteger offset_x, BigInteger 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`.
    `static AreaBI` | AreasBI.`alignVerticallyCenter(AreaBI outer, AreaBI inner)` Align the area `inner` vertically in the center of `outer`.
    `static AreaBI` | AreasBI.`alignVerticallyMaxY(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignVerticallyMaxYOffset(AreaBI, AreaBI, java.math.BigInteger)` with a zero offset.
    `static AreaBI` | AreasBI.`alignVerticallyMaxYOffset(AreaBI outer, AreaBI inner, BigInteger offset)` Align the area `inner` vertically against the inside maximum-y edge of `outer`.
    `static AreaBI` | AreasBI.`alignVerticallyMinY(AreaBI outer, AreaBI inner)` Equivalent to calling `AreasBI.alignVerticallyMinYOffset(AreaBI, AreaBI, java.math.BigInteger)` with a zero offset.
    `static AreaBI` | AreasBI.`alignVerticallyMinYOffset(AreaBI outer, AreaBI inner, BigInteger offset)` Align the area `inner` vertically against the inside minimum-y edge of `outer`.
    `static AreaBI` | AreasBI.`containing(AreaBI a, AreaBI b)` Construct a area that will contain both `a` and `b`.
    `static boolean` | AreasBI.`contains(AreaBI a, AreaBI b)` Determine whether or not one area contains another.
    `static boolean` | AreasBI.`containsPoint(AreaBI a, BigInteger x, BigInteger y)` Determine whether or not a area contains a given point.
    `static boolean` | AreasBI.`couldFitInside(AreaBI a, AreaBI b)` Determine whether or not one area could fit inside another.
    `static AreaBI` | AreasBI.`fitBetweenHorizontal(AreaBI fit, AreaBI a, AreaBI b)` Attempt to fit `fit` between `a` and `b`, horizontally.
    `static AreaBI` | AreasBI.`fitBetweenVertical(AreaBI fit, AreaBI a, AreaBI b)` Attempt to fit `fit` between `a` and `b`, vertically.
    `static AreaBI` | AreasBI.`hollowOut(AreaBI outer, BigInteger min_x_offset, BigInteger max_x_offset, BigInteger min_y_offset, BigInteger max_y_offset)` Construct a new area that fits inside `outer` based on the given offsets from each edge.
    `static AreaBI` | AreasBI.`hollowOutEvenly(AreaBI outer, BigInteger offset)` Equivalent to calling `AreasBI.hollowOut(AreaBI, java.math.BigInteger, java.math.BigInteger, java.math.BigInteger, java.math.BigInteger)` with `offset` for all offset parameters.
    `static AreaBI` | AreasBI.`moveAbsolute(AreaBI area, BigInteger x, BigInteger y)` Move the given area to `(x, y)`.
    `static AreaBI` | AreasBI.`moveRelative(AreaBI area, BigInteger x, BigInteger y)` Move the given area by `(x, y)`.
    `static AreaBI` | AreasBI.`moveToOrigin(AreaBI area)` Move the given area to `(0, 0)`.
    `static boolean` | AreasBI.`overlaps(AreaBI a, AreaBI b)` Determine whether or not two areas overlap.
    `static AreaBI` | AreasBI.`scaleFromCenter(AreaBI area, BigInteger x_diff, BigInteger y_diff)` Scale `area` by adding `x_diff` to the width, and `y_diff` to the height.
    `static AreaBI` | AreasBI.`scaleFromMaxYMaxX(AreaBI area, BigInteger x_diff, BigInteger y_diff)` Scale `area` by adding `x_diff` to the width, and `y_diff` to the height.
    `static AreaBI` | AreasBI.`scaleFromMaxYMinX(AreaBI area, BigInteger x_diff, BigInteger y_diff)` Scale `area` by adding `x_diff` to the width, and `y_diff` to the height.
    `static AreaBI` | AreasBI.`scaleFromMinYMaxX(AreaBI area, BigInteger x_diff, BigInteger y_diff)` Scale `area` by adding `x_diff` to the width, and `y_diff` to the height.
    `static AreaBI` | AreasBI.`scaleFromMinYMinX(AreaBI area, BigInteger x_diff, BigInteger y_diff)` Scale `area` by adding `x_diff` to the width, and `y_diff` to the height.
    `static AreaBI` | AreasBI.`setSizeFromCenter(AreaBI area, BigInteger width, BigInteger height)` Set the width and height of `area` to `width` and `height`, respectively.
    `static AreaBI` | AreasBI.`setSizeFromMaxYMaxX(AreaBI area, BigInteger width, BigInteger height)` Set the width and height of `area` to `width` and `height`, respectively.
    `static AreaBI` | AreasBI.`setSizeFromMaxYMinX(AreaBI area, BigInteger width, BigInteger height)` Set the width and height of `area` to `width` and `height`, respectively.
    `static AreaBI` | AreasBI.`setSizeFromMinYMaxX(AreaBI area, BigInteger width, BigInteger height)` Set the width and height of `area` to `width` and `height`, respectively.
    `static AreaBI` | AreasBI.`setSizeFromMinYMinX(AreaBI area, BigInteger width, BigInteger height)` Set the width and height of `area` to `width` and `height`, respectively.
    `static String` | AreasBI.`show(AreaBI area)`
    `static String` | AreasBI.`showToBuilder(AreaBI area, StringBuilder sb)`
    `static AreaXSplitBI<AreaBI>` | AreasBI.`splitAlongParallelToX(AreaBI area, BigInteger y)` Split `area` along a line parallel to the X axis placed at `y` units from its own minimum-y edge.
    `static AreaYSplitBI<AreaBI>` | AreasBI.`splitAlongParallelToY(AreaBI area, BigInteger x)` Split `area` along a line parallel to the Y axis placed at `x` units from its own minimum-x edge.

  - ### Uses of AreaBI in com.io7m.jregions.generators

    Methods in com.io7m.jregions.generators that return AreaBI
    Modifier and Type | Method and Description
    --- | ---
    `AreaBI` | AreaBIGenerator.`next()`

Copyright © 2017 <code@io7m.com> http://io7m.com