XyBounds

java.lang.Object
- com.partnersoft.geometry.xy.XyBounds

All Implemented Interfaces:

Immutable, XyArea<XyBounds>, XyShape<XyBounds>, java.lang.Iterable<XyPoint>
```
public class XyBounds
extends java.lang.Object
implements XyArea<XyBounds>
```
Rectangular bounds, expressed as minimum and maximum x and y.
While a rectangular shape may serve these purposes just as well, having a purpose-specific class does improve code semantics. With that in mind, this class intentionally does not currently implement Shape - however I am considering the pros and cons of that decision.
Copyright 2007 Partner Software, Inc.

Author:

Paul Reavis

Constructor Summary

Constructors
Constructor and Description
`XyBounds(double[] coords, int start, int end)`
`XyBounds(DoubleBuffer coords)`
`XyBounds(double x, double y)` Creates a degenerate bounds containing a single point.
`XyBounds(double x1, double y1, double... additionalCoords)` Creates a bounds from the given x1 and y1 plus additional coordinate pairs.
`XyBounds(DynamicDoubleArray coords)`
`XyBounds(java.lang.Iterable<XyPoint> points)` Creates a bounds containing the given points.
`XyBounds(XyPoint... points)` Creates a bounds containing the given points.
`XyBounds(XyPoint point)` Creates a degenerate bounds containing a single XyPoint.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`contains(double x, double y)` Returns true if the given point's are greater than or equal to the minimums and less than (but not equal to) the maximums.
`boolean`	`contains(XyBounds bounds)` Returns true if the given bounds is equal to or inside this one.
`boolean`	`contains(XyPoint point)` Returns true if the given point's are greater than or equal to the minimums and less than (but not equal to) the maximums.
`boolean`	`equals(java.lang.Object nother)`
`double`	`getArea()` Returns the 2-dimensional area covered by this...
`XyBounds`	`getBounds()` Returns an XyBounds object representing the rectangular extents of this shape.
`XyPoint`	`getCenter()` The center point.
`double`	`getHeight()` Height of these bounds.
`XyPoint`	`getMaximumPoint()` Returns a point with both maximum x and y; this is the same as getNeCorner().
`double`	`getMaximumX()`
`double`	`getMaximumY()`
`XyPoint`	`getMinimumPoint()` Returns a point with both minimum x and y; this is the same as getSwCorner().
`double`	`getMinimumX()`
`double`	`getMinimumY()`
`XyPoint`	`getNeCorner()` The top-right, or "northeast", corner, consisting of maximum x and maximum y.
`XyPoint`	`getNwCorner()` The top-left, or "northwest", corner, consisting of minimum x and maximum y.
`double`	`getPerimeter()` Returns the total length of the lines and/or curves bounding the area.
`XyPoint`	`getSeCorner()` The bottom-right, or "southeast", corner, consisting of maximum x and minimum y.
`XyPoint`	`getSwCorner()` The bottom-left, or "southwest", corner, consisting of minimum x and minimum y.
`double`	`getWidth()` Width of these bounds.
`XyBounds`	`intersectionWith(XyBounds nother)` Returns the intersection of this bounds with the given bounds.
`boolean`	`intersects(XyBounds nother)` Returns true if this bounds intersects the one given.
`java.util.Iterator<XyPoint>`	`iterator()`
`XyBounds`	`scaledBy(double factor)` Return a scaled version of the shape by multiplying all coordinates by the given factor in both dimensions.
`XyBounds`	`stretchedToInclude(double x, double y)` Returns a new XyBounds that is expanded to include the given point.
`XyBounds`	`stretchedToInclude(XyBounds nother)` Returns a new XyBounds that is expanded to include the given bounds.
`XyBounds`	`stretchedToInclude(XyPoint point)` Returns a new XyBounds that is expanded to include the given point.
`XyPolygon`	`toPolygon()` Same as `XyArea.toPolygon(XyAngle)` with a default angle granularity of 1/60 circle (1 degree, pi/30 radians).
`XyPolygon`	`toPolygon(XyAngle granularity)` Converts this area to a polygon which approximates it in some fashion.
`XyRectangle`	`toRectangle()` Returns an XyRectangle covering the same area as these bounds.
`java.lang.String`	`toString()`
`XyShape`	`transformedBy(XyTransform transform)` Transform the shape using the given transform.
`XyBounds`	`translatedBy(double offsetX, double offsetY)` Translate the shape by adding all coordinates to the given x and y offsets.
`XyBounds`	`unionWith(XyBounds nother)` Returns the union of this bounds with the given bounds.
`XyBounds`	`withMaxima(double newMaximumX, double newMaximumY)` Returns a modified version of this bounds with the given maxima.
`XyBounds`	`withMaxima(XyPoint newMaxima)` Returns a modified version of this bounds with the given maxima.
`XyBounds`	`withMaximumX(double newMaximumX)` Returns a modified version of this bounds with the given maximumX.
`XyBounds`	`withMaximumY(double newMaximumY)` Returns a modified version of this bounds with the given maximumY.
`XyBounds`	`withMinima(double newMinimumX, double newMinimumY)` Returns a modified version of this bounds with the given minima.
`XyBounds`	`withMinima(XyPoint newMinima)` Returns a modified version of this bounds with the given minima.
`XyBounds`	`withMinimumX(double newMinimumX)` Returns a modified version of this bounds with the given minimumX.
`XyBounds`	`withMinimumY(double newMinimumY)` Returns a modified version of this bounds with the given minimumY.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - XyBounds
```
public XyBounds(double x,
        double y)
```
    Creates a degenerate bounds containing a single point.
  - XyBounds
```
public XyBounds(double x1,
        double y1,
        double... additionalCoords)
```
    Creates a bounds from the given x1 and y1 plus additional coordinate pairs. X and Y must alternate.
  - XyBounds
```
public XyBounds(XyPoint point)
```
    Creates a degenerate bounds containing a single XyPoint.
  - XyBounds
```
public XyBounds(XyPoint... points)
```
    Creates a bounds containing the given points.
  - XyBounds
```
public XyBounds(java.lang.Iterable<XyPoint> points)
```
    Creates a bounds containing the given points.
  - XyBounds
```
public XyBounds(double[] coords,
        int start,
        int end)
```
  - XyBounds
```
public XyBounds(DoubleBuffer coords)
```
  - XyBounds
```
public XyBounds(DynamicDoubleArray coords)
```
- Method Detail
  - withMinimumX
```
public XyBounds withMinimumX(double newMinimumX)
```
    Returns a modified version of this bounds with the given minimumX.
  - withMinimumY
```
public XyBounds withMinimumY(double newMinimumY)
```
    Returns a modified version of this bounds with the given minimumY.
  - withMaximumX
```
public XyBounds withMaximumX(double newMaximumX)
```
    Returns a modified version of this bounds with the given maximumX.
  - withMaximumY
```
public XyBounds withMaximumY(double newMaximumY)
```
    Returns a modified version of this bounds with the given maximumY.
  - withMinima
```
public XyBounds withMinima(double newMinimumX,
                  double newMinimumY)
```
    Returns a modified version of this bounds with the given minima.
  - withMaxima
```
public XyBounds withMaxima(double newMaximumX,
                  double newMaximumY)
```
    Returns a modified version of this bounds with the given maxima.
  - withMinima
```
public XyBounds withMinima(XyPoint newMinima)
```
    Returns a modified version of this bounds with the given minima.
  - withMaxima
```
public XyBounds withMaxima(XyPoint newMaxima)
```
    Returns a modified version of this bounds with the given maxima.
  - stretchedToInclude
```
public XyBounds stretchedToInclude(double x,
                          double y)
```
    Returns a new XyBounds that is expanded to include the given point.
  - stretchedToInclude
```
public XyBounds stretchedToInclude(XyPoint point)
```
    Returns a new XyBounds that is expanded to include the given point.
  - stretchedToInclude
```
public XyBounds stretchedToInclude(XyBounds nother)
```
    Returns a new XyBounds that is expanded to include the given bounds.
    
    Parameters:
    nother - other bounds to include.
  - contains
```
public boolean contains(XyPoint point)
```
    Returns true if the given point's are greater than or equal to the minimums and less than (but not equal to) the maximums.
    
    Specified by:
    
    contains in interface XyArea<XyBounds>
    
    Parameters:
    point - point to test for containment
    
    Returns:
    true if point is inside bounds
  - contains
```
public boolean contains(double x,
               double y)
```
    Returns true if the given point's are greater than or equal to the minimums and less than (but not equal to) the maximums.
    
    Returns:
    true if point is inside bounds
  - contains
```
public boolean contains(XyBounds bounds)
```
    Returns true if the given bounds is equal to or inside this one.
    
    Returns:
    true if bounds is inside this bounds
  - intersects
```
public boolean intersects(XyBounds nother)
```
    Returns true if this bounds intersects the one given.
  - intersectionWith
```
public XyBounds intersectionWith(XyBounds nother)
```
    Returns the intersection of this bounds with the given bounds. Returns null if there is none.
  - unionWith
```
public XyBounds unionWith(XyBounds nother)
```
    Returns the union of this bounds with the given bounds.
  - toRectangle
```
public XyRectangle toRectangle()
```
    Returns an XyRectangle covering the same area as these bounds.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object nother)
```
    Overrides:
    
    equals in class java.lang.Object
  - getMinimumX
```
public double getMinimumX()
```
  - getMinimumY
```
public double getMinimumY()
```
  - getMaximumX
```
public double getMaximumX()
```
  - getMaximumY
```
public double getMaximumY()
```
  - getMinimumPoint
```
public XyPoint getMinimumPoint()
```
    Returns a point with both minimum x and y; this is the same as getSwCorner().
    
    Returns:
    minimum point
  - getMaximumPoint
```
public XyPoint getMaximumPoint()
```
    Returns a point with both maximum x and y; this is the same as getNeCorner().
    
    Returns:
    maximum point
  - getNwCorner
```
public XyPoint getNwCorner()
```
    The top-left, or "northwest", corner, consisting of minimum x and maximum y.
    
    Returns:
    northwest corner point
  - getSwCorner
```
public XyPoint getSwCorner()
```
    The bottom-left, or "southwest", corner, consisting of minimum x and minimum y.
    
    Returns:
    southwest corner point
  - getNeCorner
```
public XyPoint getNeCorner()
```
    The top-right, or "northeast", corner, consisting of maximum x and maximum y.
    
    Returns:
    northeast corner point
  - getSeCorner
```
public XyPoint getSeCorner()
```
    The bottom-right, or "southeast", corner, consisting of maximum x and minimum y.
    
    Returns:
    northwest corner point
  - getCenter
```
public XyPoint getCenter()
```
    The center point.
    
    Returns:
    center
  - getWidth
```
public double getWidth()
```
    Width of these bounds.
  - getHeight
```
public double getHeight()
```
    Height of these bounds.
  - getBounds
```
public XyBounds getBounds()
```
    Description copied from interface: XyShape
    
    Returns an XyBounds object representing the rectangular extents of this shape.
    
    Specified by:
    
    getBounds in interface XyShape<XyBounds>
  - transformedBy
```
public XyShape transformedBy(XyTransform transform)
```
    Description copied from interface: XyShape
    
    Transform the shape using the given transform. Due to potential distortion the result may be a different type of shape than this one.
    
    Specified by:
    
    transformedBy in interface XyShape<XyBounds>
    
    Parameters:
    transform - affine transform to apply.
    
    Returns:
    transformed result
  - iterator
```
public java.util.Iterator<XyPoint> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<XyPoint>
  - scaledBy
```
public XyBounds scaledBy(double factor)
```
    Description copied from interface: XyShape
    
    Return a scaled version of the shape by multiplying all coordinates by the given factor in both dimensions. This resulting shape must be of the same class as the original.
    
    Specified by:
    
    scaledBy in interface XyShape<XyBounds>
    
    Parameters:
    factor - scaling factor
    
    Returns:
    scaled result
  - translatedBy
```
public XyBounds translatedBy(double offsetX,
                    double offsetY)
```
    Description copied from interface: XyShape
    
    Translate the shape by adding all coordinates to the given x and y offsets. The resulting shape must be of the same class as the original.
    
    Specified by:
    
    translatedBy in interface XyShape<XyBounds>
    
    Parameters:
    offsetX - offset for the x dimension
    offsetY - offset for the y dimension
    
    Returns:
    offset result
  - getArea
```
public double getArea()
```
    Description copied from interface: XyArea
    
    Returns the 2-dimensional area covered by this... area.
    
    Specified by:
    
    getArea in interface XyArea<XyBounds>
    
    Returns:
    geometric area of this shape
  - getPerimeter
```
public double getPerimeter()
```
    Description copied from interface: XyArea
    
    Returns the total length of the lines and/or curves bounding the area.
    
    Specified by:
    
    getPerimeter in interface XyArea<XyBounds>
    
    Returns:
    geometric perimeter of this shape
  - toPolygon
```
public XyPolygon toPolygon()
```
    Description copied from interface: XyArea
    
    Same as XyArea.toPolygon(XyAngle) with a default angle granularity of 1/60 circle (1 degree, pi/30 radians).
    
    Specified by:
    
    toPolygon in interface XyArea<XyBounds>
  - toPolygon
```
public XyPolygon toPolygon(XyAngle granularity)
```
    Description copied from interface: XyArea
    
    Converts this area to a polygon which approximates it in some fashion. For example, a circle can be converted to a polygon with enough sides to roughly approximate its shape. Areas consisting of linked line segments can be represented exactly.
    The angle parameter allows a certain level of control of the output. Essentially it dictates the minimum angular granularity used to approximate curved paths. For example, a circle would be turned into a polygon by placing points around the circle, separated by the given angle.
    
    Specified by:
    
    toPolygon in interface XyArea<XyBounds>

Class XyBounds

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XyBounds

XyBounds

XyBounds

XyBounds

XyBounds

XyBounds

XyBounds

XyBounds

Method Detail

withMinimumX

withMinimumY

withMaximumX

withMaximumY

withMinima

withMaxima

withMinima

withMaxima

stretchedToInclude

stretchedToInclude

stretchedToInclude

contains

contains

contains

intersects

intersectionWith

unionWith

toRectangle

toString

equals

getMinimumX

getMinimumY

getMaximumX

getMaximumY

getMinimumPoint

getMaximumPoint

getNwCorner

getSwCorner

getNeCorner

getSeCorner

getCenter

getWidth

getHeight

getBounds

transformedBy

iterator

scaledBy

translatedBy

getArea

getPerimeter

toPolygon

toPolygon