public final class AreasBI extends 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.
| Modifier and Type | Method and Description |
|---|---|
static AreaBI |
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 |
alignHorizontallyCenter(AreaBI outer,
AreaBI inner)
Align the area
inner horizontally in the center of outer. |
static AreaBI |
alignHorizontallyMaxX(AreaBI outer,
AreaBI inner)
Equivalent to calling
alignHorizontallyMaxXOffset(AreaBI,
AreaBI, java.math.BigInteger) with a zero offset. |
static AreaBI |
alignHorizontallyMaxXOffset(AreaBI outer,
AreaBI inner,
BigInteger offset)
Align the area
inner horizontally against the inside maximum-x edge
of outer. |
static AreaBI |
alignHorizontallyMinX(AreaBI outer,
AreaBI inner)
Equivalent to calling
alignHorizontallyMinXOffset(AreaBI, AreaBI,
java.math.BigInteger) with a zero offset. |
static AreaBI |
alignHorizontallyMinXOffset(AreaBI outer,
AreaBI inner,
BigInteger offset)
Align the area
inner horizontally against the inside minimum-x edge
of outer. |
static AreaBI |
alignMaxYMaxX(AreaBI outer,
AreaBI inner)
Equivalent to calling
alignMaxYMaxXOffset(AreaBI, AreaBI,
java.math.BigInteger, java.math.BigInteger) with zero offsets. |
static AreaBI |
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 |
alignMaxYMinX(AreaBI outer,
AreaBI inner)
Equivalent to calling
alignMaxYMinXOffset(AreaBI, AreaBI,
java.math.BigInteger, java.math.BigInteger) with zero offsets. |
static AreaBI |
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 |
alignMinYMaxX(AreaBI outer,
AreaBI inner)
Equivalent to calling
alignMinYMaxXOffset(AreaBI, AreaBI,
java.math.BigInteger, java.math.BigInteger) with zero offsets. |
static AreaBI |
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 |
alignMinYMinX(AreaBI outer,
AreaBI inner)
Equivalent to calling
alignMinYMinXOffset(AreaBI, AreaBI,
java.math.BigInteger, java.math.BigInteger) with zero offsets. |
static AreaBI |
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 |
alignVerticallyCenter(AreaBI outer,
AreaBI inner)
Align the area
inner vertically in the center of outer. |
static AreaBI |
alignVerticallyMaxY(AreaBI outer,
AreaBI inner)
Equivalent to calling
alignVerticallyMaxYOffset(AreaBI, AreaBI,
java.math.BigInteger) with a zero offset. |
static AreaBI |
alignVerticallyMaxYOffset(AreaBI outer,
AreaBI inner,
BigInteger offset)
Align the area
inner vertically against the inside maximum-y edge
of outer. |
static AreaBI |
alignVerticallyMinY(AreaBI outer,
AreaBI inner)
Equivalent to calling
alignVerticallyMinYOffset(AreaBI, AreaBI,
java.math.BigInteger) with a zero offset. |
static AreaBI |
alignVerticallyMinYOffset(AreaBI outer,
AreaBI inner,
BigInteger offset)
Align the area
inner vertically against the inside minimum-y edge
of outer. |
static AreaBI |
containing(AreaBI a,
AreaBI b)
Construct a area that will contain both
a and b. |
static boolean |
contains(AreaBI a,
AreaBI b)
Determine whether or not one area contains another.
|
static boolean |
containsPoint(AreaBI a,
BigInteger x,
BigInteger y)
Determine whether or not a area contains a given point.
|
static boolean |
couldFitInside(AreaBI a,
AreaBI b)
Determine whether or not one area could fit inside another.
|
static AreaBI |
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 |
fitBetweenHorizontal(AreaBI fit,
AreaBI a,
AreaBI b)
Attempt to fit
fit between a and b, horizontally. |
static AreaBI |
fitBetweenVertical(AreaBI fit,
AreaBI a,
AreaBI b)
Attempt to fit
fit between a and b, vertically. |
static AreaBI |
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 |
hollowOutEvenly(AreaBI outer,
BigInteger offset)
Equivalent to calling
hollowOut(AreaBI, java.math.BigInteger, java.math.BigInteger,
java.math.BigInteger, java.math.BigInteger) with offset for all offset parameters. |
static AreaBI |
moveAbsolute(AreaBI area,
BigInteger x,
BigInteger y)
Move the given area to
(x, y). |
static AreaBI |
moveRelative(AreaBI area,
BigInteger x,
BigInteger y)
Move the given area by
(x, y). |
static AreaBI |
moveToOrigin(AreaBI area)
Move the given area to
(0, 0). |
static boolean |
overlaps(AreaBI a,
AreaBI b)
Determine whether or not two areas overlap.
|
static AreaBI |
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 |
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 |
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 |
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 |
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 |
setSizeFromCenter(AreaBI area,
BigInteger width,
BigInteger height)
Set the width and height of
area to width and height, respectively. |
static AreaBI |
setSizeFromMaxYMaxX(AreaBI area,
BigInteger width,
BigInteger height)
Set the width and height of
area to width and height, respectively. |
static AreaBI |
setSizeFromMaxYMinX(AreaBI area,
BigInteger width,
BigInteger height)
Set the width and height of
area to width and height, respectively. |
static AreaBI |
setSizeFromMinYMaxX(AreaBI area,
BigInteger width,
BigInteger height)
Set the width and height of
area to width and height, respectively. |
static AreaBI |
setSizeFromMinYMinX(AreaBI area,
BigInteger width,
BigInteger height)
Set the width and height of
area to width and height, respectively. |
static String |
show(AreaBI area) |
static String |
showToBuilder(AreaBI area,
StringBuilder sb) |
static AreaSizeBI |
size(AreaBI area) |
static AreaXSplitBI<AreaBI> |
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> |
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. |
public static AreaBI create(BigInteger x, BigInteger y, BigInteger width, BigInteger height)
width and height height, placing
the minimum corner at (x, y).x - The X value of the minimum cornery - The Y value of the minimum cornerwidth - The width of the areaheight - The height of the areapublic static boolean contains(AreaBI a, AreaBI 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.
a - Area Ab - Area Btrue iff a contains bpublic static AreaBI moveRelative(AreaBI area, BigInteger x, BigInteger y)
(x, y).area - The areax - The amount to move on the X axisy - The amount to move on the Y axispublic static AreaBI moveAbsolute(AreaBI area, BigInteger x, BigInteger y)
(x, y).area - The areax - The position to which to move on the X axisy - The position to which to move on the Y axispublic static AreaBI moveToOrigin(AreaBI area)
(0, 0).area - The areapublic static AreaBI alignHorizontallyCenter(AreaBI outer, AreaBI inner)
inner horizontally in the center of outer.outer - The outer areainner - The inner areapublic static AreaBI alignHorizontallyMinX(AreaBI outer, AreaBI inner)
alignHorizontallyMinXOffset(AreaBI, AreaBI,
java.math.BigInteger) with a zero offset.outer - The outer areainner - The inner areapublic static AreaBI alignHorizontallyMinXOffset(AreaBI outer, AreaBI inner, BigInteger offset)
inner horizontally against the inside minimum-x edge
of outer. The area will be at least offset units from the
minimum-x edge.outer - The outer areainner - The inner areaoffset - The offset from the edge
spublic static AreaBI alignHorizontallyMaxX(AreaBI outer, AreaBI inner)
alignHorizontallyMaxXOffset(AreaBI,
AreaBI, java.math.BigInteger) with a zero offset.outer - The outer areainner - The inner areapublic static AreaBI alignHorizontallyMaxXOffset(AreaBI outer, AreaBI inner, BigInteger offset)
inner horizontally against the inside maximum-x edge
of outer. The area will be at least offset units from the
maximum-x edge.outer - The outer areainner - The inner areaoffset - The offset from the edge
spublic static AreaBI alignVerticallyMinY(AreaBI outer, AreaBI inner)
alignVerticallyMinYOffset(AreaBI, AreaBI,
java.math.BigInteger) with a zero offset.outer - The outer areainner - The inner areapublic static AreaBI alignVerticallyMinYOffset(AreaBI outer, AreaBI inner, BigInteger offset)
inner vertically against the inside minimum-y edge
of outer. The area will be at least offset units from the
minimum-y edge.outer - The outer areainner - The inner areaoffset - The offset from the edge
spublic static AreaBI alignVerticallyMaxY(AreaBI outer, AreaBI inner)
alignVerticallyMaxYOffset(AreaBI, AreaBI,
java.math.BigInteger) with a zero offset.outer - The outer areainner - The inner areapublic static AreaBI alignVerticallyMaxYOffset(AreaBI outer, AreaBI inner, BigInteger offset)
inner vertically against the inside maximum-y edge
of outer. The area will be at least offset units from the
maximum-y edge.outer - The outer areainner - The inner areaoffset - The offset from the edge
spublic static AreaBI alignVerticallyCenter(AreaBI outer, AreaBI inner)
inner vertically in the center of outer.outer - The outer areainner - The inner areapublic static AreaBI alignMinYMinX(AreaBI outer, AreaBI inner)
alignMinYMinXOffset(AreaBI, AreaBI,
java.math.BigInteger, java.math.BigInteger) with zero offsets.outer - The outer areainner - The inner areapublic static AreaBI alignMinYMinXOffset(AreaBI outer, AreaBI inner, BigInteger offset_x, BigInteger offset_y)
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.outer - The outer areainner - The inner areaoffset_x - The offset from the minimum-x edgeoffset_y - The offset from the minimum-y edgepublic static AreaBI alignMinYMaxX(AreaBI outer, AreaBI inner)
alignMinYMaxXOffset(AreaBI, AreaBI,
java.math.BigInteger, java.math.BigInteger) with zero offsets.outer - The outer areainner - The inner areapublic static AreaBI alignMinYMaxXOffset(AreaBI outer, AreaBI inner, BigInteger offset_x, BigInteger offset_y)
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.outer - The outer areainner - The inner areaoffset_x - The offset from the maximum-x edgeoffset_y - The offset from the minimum-y edgepublic static AreaBI alignMaxYMinX(AreaBI outer, AreaBI inner)
alignMaxYMinXOffset(AreaBI, AreaBI,
java.math.BigInteger, java.math.BigInteger) with zero offsets.outer - The outer areainner - The inner areapublic static AreaBI alignMaxYMinXOffset(AreaBI outer, AreaBI inner, BigInteger offset_x, BigInteger offset_y)
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.outer - The outer areainner - The inner areaoffset_x - The offset from the minimum-x edgeoffset_y - The offset from the maximum-y edgepublic static AreaBI alignMaxYMaxX(AreaBI outer, AreaBI inner)
alignMaxYMaxXOffset(AreaBI, AreaBI,
java.math.BigInteger, java.math.BigInteger) with zero offsets.outer - The outer areainner - The inner areapublic static AreaBI alignMaxYMaxXOffset(AreaBI outer, AreaBI inner, BigInteger offset_x, BigInteger offset_y)
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.outer - The outer areainner - The inner areaoffset_x - The offset from the maximum-x edgeoffset_y - The offset from the maximum-y edgepublic static AreaBI alignCenter(AreaBI outer, AreaBI inner)
inner such that the center of the area is equal to
the center of outer.outer - The outer areainner - The inner areapublic static AreaBI hollowOut(AreaBI outer, BigInteger min_x_offset, BigInteger max_x_offset, BigInteger min_y_offset, BigInteger max_y_offset)
outer based on the given
offsets from each edge.outer - The containing areamin_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)public static AreaBI hollowOutEvenly(AreaBI outer, BigInteger offset)
hollowOut(AreaBI, java.math.BigInteger, java.math.BigInteger,
java.math.BigInteger, java.math.BigInteger) with offset for all offset parameters.outer - The containing areaoffset - The offset from each edge (must be non-negative)public static AreaBI setSizeFromCenter(AreaBI area, BigInteger width, BigInteger height)
Set the width and height of area to width and height, respectively.
The area is resized from its own center.
area - The areawidth - The new width (must be non-negative)height - The new height (must be non-negative)public static AreaBI setSizeFromMinYMinX(AreaBI area, BigInteger width, BigInteger height)
Set the width and height of area to width and height, respectively.
The area is resized by moving its minimum-y-minimum-x corner.
area - The areawidth - The new width (must be non-negative)height - The new height (must be non-negative)public static AreaBI setSizeFromMinYMaxX(AreaBI area, BigInteger width, BigInteger height)
Set the width and height of area to width and height, respectively.
The area is resized by moving its minimum-y-maximum-x corner.
area - The areawidth - The new width (must be non-negative)height - The new height (must be non-negative)public static AreaBI setSizeFromMaxYMaxX(AreaBI area, BigInteger width, BigInteger height)
Set the width and height of area to width and height, respectively.
The area is resized by moving its maximum-y-maximum-x corner.
area - The areawidth - The new width (must be non-negative)height - The new height (must be non-negative)public static AreaBI setSizeFromMaxYMinX(AreaBI area, BigInteger width, BigInteger height)
Set the width and height of area to width and height, respectively.
The area is resized by moving its maximum-y-minimum-x corner.
area - The areawidth - The new width (must be non-negative)height - The new height (must be non-negative)public static AreaBI scaleFromMinYMinX(AreaBI area, BigInteger x_diff, BigInteger y_diff)
Scale area by adding x_diff to the width, and y_diff to the height. The size of the resulting area is clamped so that
its width and height are always non-negative.
The area is resized by moving its minimum-y-minimum-x corner.
area - The areax_diff - The X differencey_diff - The Y differencepublic static AreaBI scaleFromMinYMaxX(AreaBI area, BigInteger x_diff, BigInteger y_diff)
Scale area by adding x_diff to the width, and y_diff to the height. The size of the resulting area is clamped so that
its width and height are always non-negative.
The area is resized by moving its minimum-y-maximum-x corner.
area - The areax_diff - The X differencey_diff - The Y differencepublic static AreaBI scaleFromMaxYMinX(AreaBI area, BigInteger x_diff, BigInteger y_diff)
Scale area by adding x_diff to the width, and y_diff to the height. The size of the resulting area is clamped so that
its width and height are always non-negative.
The area is resized by moving its maximum-y-minimum-x corner.
area - The areax_diff - The X differencey_diff - The Y differencepublic static AreaBI scaleFromMaxYMaxX(AreaBI area, BigInteger x_diff, BigInteger y_diff)
Scale area by adding x_diff to the width, and y_diff to the height. The size of the resulting area is clamped so that
its width and height are always non-negative.
The area is resized by moving its maximum-y-maximum-x corner.
area - The areax_diff - The X differencey_diff - The Y differencepublic static AreaBI scaleFromCenter(AreaBI area, BigInteger x_diff, BigInteger y_diff)
Scale area by adding x_diff to the width, and y_diff to the height. The size of the resulting area is clamped so that
its width and height are always non-negative.
The area is resized from its own center.
area - The areax_diff - The X differencey_diff - The Y differencepublic static boolean overlaps(AreaBI a, AreaBI b)
Determine whether or not two areas overlap.
Overlapping is reflexive: overlaps(a, a) == true.
Overlapping is symmetric: overlaps(a, b) == contains(b, a).
Overlapping is not necessarily transitive.
a - An areab - An areatrue iff a overlaps bpublic static boolean couldFitInside(AreaBI a, AreaBI 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.
a - An areab - An areatrue iff a could fit inside bpublic static AreaBI containing(AreaBI a, AreaBI b)
a and b.a - An areab - An areaa and bpublic static boolean containsPoint(AreaBI a, BigInteger x, BigInteger y)
Determine whether or not a area contains a given point.
a - An areax - The X coordinate of the pointy - The Y coordinate of the pointtrue iff a contains (x, y)public static AreaBI fitBetweenHorizontal(AreaBI fit, AreaBI a, AreaBI b)
fit between a and b, horizontally.fit - The area to be fitteda - An areab - An areapublic static AreaBI fitBetweenVertical(AreaBI fit, AreaBI a, AreaBI b)
fit between a and b, vertically.fit - The area to be fitteda - An areab - An areapublic static AreaXSplitBI<AreaBI> splitAlongParallelToX(AreaBI area, BigInteger y)
area along a line parallel to the X axis placed at
y units from its own minimum-y edge.area - The area to be splity - The relative Y coordinate of the splitting edgepublic static AreaYSplitBI<AreaBI> splitAlongParallelToY(AreaBI area, BigInteger x)
area along a line parallel to the Y axis placed at
x units from its own minimum-x edge.area - The area to be splitx - The relative X coordinate of the splitting edgepublic static String show(AreaBI area)
area - The areapublic static AreaSizeBI size(AreaBI area)
area - The areapublic static String showToBuilder(AreaBI area, StringBuilder sb)
area - The areasb - A string builderCopyright © 2017 <code@io7m.com> http://io7m.com