ProjectionRect (cdm-core 6.0.0-beta1 API)

java.lang.Object
- ucar.unidata.geoloc.ProjectionRect

```
@Immutable
public class ProjectionRect
extends Object
```
Bounding box for ProjectionPoints. Note that getX() getY() really means getMinX(), getMinY(), rather than "upper left point" of the rectangle.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProjectionRect.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProjectionRect.Builder`

Constructor Summary

Constructors
Constructor and Description
`ProjectionRect()` default constructor, initialized to center (0,0) and width (10000, 10000)
`ProjectionRect(double x1, double y1, double x2, double y2)` construct a ProjectionRect from any two opposite corner points
`ProjectionRect(ProjectionPoint minimum, double width, double height)` Construct a ProjectionRect from any two opposite corner points.
`ProjectionRect(ProjectionPoint corner1, ProjectionPoint corner2)` Construct a ProjectionRect from any two opposite corner points.
`ProjectionRect(String spec)` Deprecated. use fromSpec(String spec)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static ProjectionRect.Builder`	`builder()`
`static ProjectionRect.Builder`	`builder(double x1, double y1, double x2, double y2)`
`boolean`	`contains(ProjectionPoint point)` Returns `true` if this bounding box contains `point`.
`boolean`	`contains(ProjectionRect rect)` Returns `true` if this bounding box contains `rect`.
`boolean`	`equals(Object o)`
`static ProjectionRect`	`fromSpec(String spec)` Construct a bounding box from a string, or null if incorrect format.
`double`	`getCenterX()` Returns the X coordinate of the center of the framing rectangle of the `Shape` in `double` precision.
`double`	`getCenterY()` Returns the Y coordinate of the center of the framing rectangle of the `Shape` in `double` precision.
`double`	`getHeight()`
`ProjectionPoint`	`getLowerLeftPoint()` Get the Lower Right Point (same as getMinPoint)
`ProjectionPoint`	`getLowerRightPoint()` Get the Lower Right Point
`ProjectionPoint`	`getMaxPoint()` Get the maximum corner of the bounding box.
`double`	`getMaxX()` Returns the largest X coordinate of the framing rectangle of the `Shape` in `double` precision.
`double`	`getMaxY()` Returns the largest Y coordinate of the framing rectangle of the `Shape` in `double` precision.
`ProjectionPoint`	`getMinPoint()` Get the minimum corner of the bounding box.
`double`	`getMinX()` Returns the smallest X coordinate of the framing rectangle of the `Shape` in `double` precision.
`double`	`getMinY()` Returns the smallest Y coordinate of the framing rectangle of the `Shape` in `double` precision.
`ProjectionPoint`	`getUpperLeftPoint()` Get the Upper Left Point
`ProjectionPoint`	`getUpperRightPoint()` Get the Upper Left Point (same as getMaxPoint)
`double`	`getWidth()`
`double`	`getX()` Deprecated. use getMinX
`double`	`getY()` Deprecated. use getMinY
`int`	`hashCode()`
`static ProjectionRect`	`intersect(ProjectionRect src1, ProjectionRect src2)` Intersects the pair of specified source `Rectangle2D` objects and puts the result into the specified destination `Rectangle2D` object.
`boolean`	`intersects(double x, double y, double w, double h)`
`boolean`	`intersects(ProjectionRect r)`
`boolean`	`isEmpty()`
`boolean`	`nearlyEquals(ProjectionRect other)` Returns the result of `nearlyEquals(ProjectionRect, double)`, with `Misc.defaultMaxRelativeDiffFloat`.
`boolean`	`nearlyEquals(ProjectionRect other, double maxRelDiff)` Returns `true` if this rectangle is nearly equal to `other`.
`ProjectionRect.Builder`	`toBuilder()` Turn into a mutable Builder.
`String`	`toString()` Return a String representation of this ProjectionRect that can be used in new ProjectionRect(String): "x, y, width, height"
`String`	`toString1()` Get a String representation of this object.
`String`	`toString2(int ndec)`

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

- Constructor Detail
  - ProjectionRect
```
public ProjectionRect()
```
    default constructor, initialized to center (0,0) and width (10000, 10000)
  - ProjectionRect
```
public ProjectionRect(ProjectionPoint corner1,
                      ProjectionPoint corner2)
```
    Construct a ProjectionRect from any two opposite corner points.
    
    Parameters:
    
    corner1 - a corner.
    
    corner2 - the opposite corner.
  - ProjectionRect
```
public ProjectionRect(ProjectionPoint minimum,
                      double width,
                      double height)
```
    Construct a ProjectionRect from any two opposite corner points.
    
    Parameters:
    
    minimum - lower left corner, ie the minimum x and y
    
    width - x width.
    
    height - y height
  - ProjectionRect
```
public ProjectionRect(double x1,
                      double y1,
                      double x2,
                      double y2)
```
    construct a ProjectionRect from any two opposite corner points
    
    Parameters:
    
    x1 - x coord of any corner of the bounding box
    
    y1 - y coord of the same corner as x1
    
    x2 - x coord of opposite corner from x1,y1
    
    y2 - y coord of same corner as x2
  - ProjectionRect
```
@Deprecated
public ProjectionRect(String spec)
```
    Deprecated. use fromSpec(String spec)
- Method Detail
  - fromSpec
```
@Nullable
public static ProjectionRect fromSpec(String spec)
```
    Construct a bounding box from a string, or null if incorrect format.
    
    Parameters:
    
    spec - "startx, starty, width, height"
  - getX
```
@Deprecated
public double getX()
```
    Deprecated. use getMinX
  - getY
```
@Deprecated
public double getY()
```
    Deprecated. use getMinY
  - getWidth
```
public double getWidth()
```
  - getHeight
```
public double getHeight()
```
  - getMinX
```
public double getMinX()
```
    Returns the smallest X coordinate of the framing rectangle of the Shape in double precision.
    
    Returns:
    
    the smallest X coordinate of the framing rectangle of the Shape.
    
    Since:
    
    1.2
  - getMinY
```
public double getMinY()
```
    Returns the smallest Y coordinate of the framing rectangle of the Shape in double precision.
    
    Returns:
    
    the smallest Y coordinate of the framing rectangle of the Shape.
    
    Since:
    
    1.2
  - getMaxX
```
public double getMaxX()
```
    Returns the largest X coordinate of the framing rectangle of the Shape in double precision.
    
    Returns:
    
    the largest X coordinate of the framing rectangle of the Shape.
    
    Since:
    
    1.2
  - getMaxY
```
public double getMaxY()
```
    Returns the largest Y coordinate of the framing rectangle of the Shape in double precision.
    
    Returns:
    
    the largest Y coordinate of the framing rectangle of the Shape.
    
    Since:
    
    1.2
  - getCenterX
```
public double getCenterX()
```
    Returns the X coordinate of the center of the framing rectangle of the Shape in double precision.
    
    Returns:
    
    the X coordinate of the center of the framing rectangle of the Shape.
    
    Since:
    
    1.2
  - getCenterY
```
public double getCenterY()
```
    Returns the Y coordinate of the center of the framing rectangle of the Shape in double precision.
    
    Returns:
    
    the Y coordinate of the center of the framing rectangle of the Shape.
    
    Since:
    
    1.2
  - isEmpty
```
public boolean isEmpty()
```
  - intersects
```
public boolean intersects(ProjectionRect r)
```
  - intersects
```
public boolean intersects(double x,
                          double y,
                          double w,
                          double h)
```
  - intersect
```
public static ProjectionRect intersect(ProjectionRect src1,
                                       ProjectionRect src2)
```
    Intersects the pair of specified source Rectangle2D objects and puts the result into the specified destination Rectangle2D object. One of the source rectangles can also be the destination to avoid creating a third Rectangle2D object, but in this case the original points of this source rectangle will be overwritten by this method.
    
    Parameters:
    
    src1 - the first of a pair of Rectangle2D objects to be intersected with each other
    
    src2 - the second of a pair of Rectangle2D objects to be intersected with each other
    
    Returns:
    
    the ProjectionRect that holds the results of the intersection of src1 and src2
    
    Since:
    
    1.2
  - contains
```
public boolean contains(ProjectionPoint point)
```
    Returns true if this bounding box contains point.
    
    Parameters:
    
    point - a point in projection coordinates.
    
    Returns:
    
    true if this bounding box contains point.
  - contains
```
public boolean contains(ProjectionRect rect)
```
    Returns true if this bounding box contains rect.
    
    Parameters:
    
    rect - a bounding box in projection coordinates
    
    Returns:
    
    true if this bounding box contains rect.
  - getLowerRightPoint
```
public ProjectionPoint getLowerRightPoint()
```
    Get the Lower Right Point
    
    Returns:
    
    the Lower Right Point
  - getUpperRightPoint
```
public ProjectionPoint getUpperRightPoint()
```
    Get the Upper Left Point (same as getMaxPoint)
    
    Returns:
    
    the Upper Left Point
  - getLowerLeftPoint
```
public ProjectionPoint getLowerLeftPoint()
```
    Get the Lower Right Point (same as getMinPoint)
    
    Returns:
    
    the Lower Right Point
  - getUpperLeftPoint
```
public ProjectionPoint getUpperLeftPoint()
```
    Get the Upper Left Point
    
    Returns:
    
    the Upper Left Point
  - getMinPoint
```
public ProjectionPoint getMinPoint()
```
    Get the minimum corner of the bounding box.
    
    Returns:
    
    minimum corner of the bounding box
  - getMaxPoint
```
public ProjectionPoint getMaxPoint()
```
    Get the maximum corner of the bounding box.
    
    Returns:
    
    maximum corner of the bounding box
  - toString1
```
public String toString1()
```
    Get a String representation of this object.
    
    Returns:
    
    a String representation of this object.
  - toString2
```
public String toString2(int ndec)
```
  - toString
```
public String toString()
```
    Return a String representation of this ProjectionRect that can be used in new ProjectionRect(String): "x, y, width, height"
    
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - nearlyEquals
```
public boolean nearlyEquals(ProjectionRect other)
```
    Returns the result of nearlyEquals(ProjectionRect, double), with Misc.defaultMaxRelativeDiffFloat.
  - nearlyEquals
```
public boolean nearlyEquals(ProjectionRect other,
                            double maxRelDiff)
```
    Returns true if this rectangle is nearly equal to other. The "near equality" of corners is determined using ProjectionPoint.nearlyEquals(ProjectionPoint, double), with the specified maxRelDiff.
    
    Parameters:
    
    other - the other rectangle to check.
    
    maxRelDiff - the maximum relative difference that two corners may have.
    
    Returns:
    
    true if this rectangle is nearly equal to other.
  - toBuilder
```
public ProjectionRect.Builder toBuilder()
```
    Turn into a mutable Builder. Can use toBuilder().build() to copy.
  - builder
```
public static ProjectionRect.Builder builder()
```
  - builder
```
public static ProjectionRect.Builder builder(double x1,
                                             double y1,
                                             double x2,
                                             double y2)
```

Class ProjectionRect

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProjectionRect

ProjectionRect

ProjectionRect

ProjectionRect

ProjectionRect

Method Detail

fromSpec

getX

getY

getWidth

getHeight

getMinX

getMinY

getMaxX

getMaxY

getCenterX

getCenterY

isEmpty

intersects

intersects

intersect

contains

contains

getLowerRightPoint

getUpperRightPoint

getLowerLeftPoint

getUpperLeftPoint

getMinPoint

getMaxPoint

toString1

toString2

toString

equals

hashCode

nearlyEquals

nearlyEquals

toBuilder

builder

builder