deegree 2.1 (2007/11/08 09:57 build-328-official)

org.deegree.model.csct.resources
Class XRectangle2D

java.lang.Object
  extended by java.awt.geom.RectangularShape
      extended by java.awt.geom.Rectangle2D
          extended by org.deegree.model.csct.resources.XRectangle2D
All Implemented Interfaces:
Shape, Serializable, Cloneable

public class XRectangle2D
extends Rectangle2D
implements Serializable

Serializable, high-performance double-precision rectangle. Instead of using x, y, width and height, this class store rectangle's coordinates into the following fields: xmin, xmax, ymin et ymax. Methods likes contains and intersects are faster, which make this class more appropriate for using intensively inside a loop.

Version:
1.0
Author:
Martin Desruisseaux
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class java.awt.geom.Rectangle2D
Rectangle2D.Double, Rectangle2D.Float
 
Field Summary
 double xmax
          Coordonn�es x maximale du rectangle.
 double xmin
          Coordonn�es x minimale du rectangle.
 double ymax
          Coordonn�es y maximale du rectangle.
 double ymin
          Coordonn�es y minimale du rectangle.
 
Fields inherited from class java.awt.geom.Rectangle2D
OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP
 
Constructor Summary
XRectangle2D()
          Construit un rectangle par d�faut.
XRectangle2D(double x, double y, double width, double height)
          Construit un rectangle avec les coordonn�es sp�cifi�es.
XRectangle2D(Rectangle2D rect)
          Construit un rectangle avec une copie des coordonn�es du rectangle sp�cifi�e.
 
Method Summary
 void add(double x, double y)
          Adds a point, specified by the double precision arguments x and y, to this Rectangle2D.
 void add(Rectangle2D rect)
          Adds a Rectangle2D object to this Rectangle2D.
 boolean contains(double x, double y)
          Tests if a specified coordinate is inside the boundary of this Rectangle2D.
 boolean contains(double x, double y, double width, double height)
          Tests if the interior of this Rectangle2D entirely contains the specified set of rectangular coordinates.
 Rectangle2D createIntersection(Rectangle2D rect)
          Returns a new Rectangle2D object representing the intersection of this Rectangle2D with the specified Rectangle2D.
 Rectangle2D createUnion(Rectangle2D rect)
          Returns a new Rectangle2D object representing the union of this Rectangle2D with the specified Rectangle2D.
 double getCenterX()
          Returns the X coordinate of the center of the rectangle.
 double getCenterY()
          Returns the Y coordinate of the center of the rectangle.
 double getHeight()
          Returns the height of the framing rectangle in double precision.
 double getMaxX()
          Returns the largest X coordinate of the rectangle.
 double getMaxY()
          Returns the largest Y coordinate of the rectangle.
 double getMinX()
          Returns the smallest X coordinate of the rectangle.
 double getMinY()
          Returns the smallest Y coordinate of the rectangle.
 double getWidth()
          Returns the width of the framing rectangle in double precision.
 double getX()
          Returns the X coordinate of the upper left corner of the framing rectangle in double precision.
 double getY()
          Returns the Y coordinate of the upper left corner of the framing rectangle in double precision.
 boolean intersects(double x, double y, double width, double height)
          Tests if the interior of this Rectangle2D intersects the interior of a specified set of rectangular coordinates.
 boolean isEmpty()
          Determines whether the RectangularShape is empty.
 int outcode(double x, double y)
          Determines where the specified coordinates lie with respect to this Rectangle2D.
 void setRect(double x, double y, double width, double height)
          Sets the location and size of this Rectangle2D to the specified double values.
 void setRect(Rectangle2D r)
          Sets this Rectangle2D to be the same as the specified Rectangle2D.
 String toString()
          Returns the String representation of this Rectangle2D.
 
Methods inherited from class java.awt.geom.Rectangle2D
add, equals, getBounds2D, getPathIterator, getPathIterator, hashCode, intersect, intersectsLine, intersectsLine, outcode, setFrame, union
 
Methods inherited from class java.awt.geom.RectangularShape
clone, contains, contains, getBounds, getFrame, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

xmin

public double xmin
Coordonn�es x minimale du rectangle.


ymin

public double ymin
Coordonn�es y minimale du rectangle.


xmax

public double xmax
Coordonn�es x maximale du rectangle.


ymax

public double ymax
Coordonn�es y maximale du rectangle.

Constructor Detail

XRectangle2D

public XRectangle2D()
Construit un rectangle par d�faut. Les coordonn�es du rectangle seront (0,0,0,0).


XRectangle2D

public XRectangle2D(double x,
                    double y,
                    double width,
                    double height)
Construit un rectangle avec les coordonn�es sp�cifi�es.


XRectangle2D

public XRectangle2D(Rectangle2D rect)
Construit un rectangle avec une copie des coordonn�es du rectangle sp�cifi�e.

Method Detail

isEmpty

public boolean isEmpty()
Determines whether the RectangularShape is empty. When the RectangularShape is empty, it encloses no area.

Specified by:
isEmpty in class RectangularShape
Returns:
true if the RectangularShape is empty; false otherwise.

getX

public double getX()
Returns the X coordinate of the upper left corner of the framing rectangle in double precision.

Specified by:
getX in class RectangularShape
Returns:
the x coordinate of the upper left corner of the framing rectangle.

getY

public double getY()
Returns the Y coordinate of the upper left corner of the framing rectangle in double precision.

Specified by:
getY in class RectangularShape
Returns:
the y coordinate of the upper left corner of the framing rectangle.

getWidth

public double getWidth()
Returns the width of the framing rectangle in double precision.

Specified by:
getWidth in class RectangularShape
Returns:
the width of the framing rectangle.

getHeight

public double getHeight()
Returns the height of the framing rectangle in double precision.

Specified by:
getHeight in class RectangularShape
Returns:
the height of the framing rectangle.

getMinX

public double getMinX()
Returns the smallest X coordinate of the rectangle.

Overrides:
getMinX in class RectangularShape

getMinY

public double getMinY()
Returns the smallest Y coordinate of the rectangle.

Overrides:
getMinY in class RectangularShape

getMaxX

public double getMaxX()
Returns the largest X coordinate of the rectangle.

Overrides:
getMaxX in class RectangularShape

getMaxY

public double getMaxY()
Returns the largest Y coordinate of the rectangle.

Overrides:
getMaxY in class RectangularShape

getCenterX

public double getCenterX()
Returns the X coordinate of the center of the rectangle.

Overrides:
getCenterX in class RectangularShape

getCenterY

public double getCenterY()
Returns the Y coordinate of the center of the rectangle.

Overrides:
getCenterY in class RectangularShape

setRect

public void setRect(double x,
                    double y,
                    double width,
                    double height)
Sets the location and size of this Rectangle2D to the specified double values.

Specified by:
setRect in class Rectangle2D
Parameters:
x - the x-coordinates to which to set the location of the upper left corner of this Rectangle2D
y - the y-coordinates to which to set the location of the upper left corner of this Rectangle2D
width - the value to use to set the width of this Rectangle2D
height - the value to use to set the height of this Rectangle2D

setRect

public void setRect(Rectangle2D r)
Sets this Rectangle2D to be the same as the specified Rectangle2D.

Overrides:
setRect in class Rectangle2D
Parameters:
r - the specified Rectangle2D

contains

public boolean contains(double x,
                        double y)
Tests if a specified coordinate is inside the boundary of this Rectangle2D.

Specified by:
contains in interface Shape
Overrides:
contains in class Rectangle2D
Parameters:
x - the x-coordinates to test.
y - the y-coordinates to test.
Returns:
true if the specified coordinates are inside the boundary of this Rectangle2D; false otherwise.

intersects

public boolean intersects(double x,
                          double y,
                          double width,
                          double height)
Tests if the interior of this Rectangle2D intersects the interior of a specified set of rectangular coordinates.

Specified by:
intersects in interface Shape
Overrides:
intersects in class Rectangle2D
Parameters:
x - the x-coordinates of the upper left corner of the specified set of rectangular coordinates
y - the y-coordinates of the upper left corner of the specified set of rectangular coordinates
width - the width of the specified set of rectangular coordinates
height - the height of the specified set of rectangular coordinates
Returns:
true if this Rectangle2D intersects the interior of a specified set of rectangular coordinates; false otherwise.

contains

public boolean contains(double x,
                        double y,
                        double width,
                        double height)
Tests if the interior of this Rectangle2D entirely contains the specified set of rectangular coordinates.

Specified by:
contains in interface Shape
Overrides:
contains in class Rectangle2D
Parameters:
x - the x-coordinates of the upper left corner of the specified set of rectangular coordinates
y - the y-coordinates of the upper left corner of the specified set of rectangular coordinates
width - the width of the specified set of rectangular coordinates
height - the height of the specified set of rectangular coordinates
Returns:
true if this Rectangle2D entirely contains specified set of rectangular coordinates; false otherwise.

outcode

public int outcode(double x,
                   double y)
Determines where the specified coordinates lie with respect to this Rectangle2D. This method computes a binary OR of the appropriate mask values indicating, for each side of this Rectangle2D, whether or not the specified coordinates are on the same side of the edge as the rest of this Rectangle2D.

Specified by:
outcode in class Rectangle2D
Parameters:
x - the specified x-coordinates
y - the specified y-coordinates
Returns:
the logical OR of all appropriate out codes.
See Also:
Rectangle2D.OUT_LEFT, Rectangle2D.OUT_TOP, Rectangle2D.OUT_RIGHT, Rectangle2D.OUT_BOTTOM

createIntersection

public Rectangle2D createIntersection(Rectangle2D rect)
Returns a new Rectangle2D object representing the intersection of this Rectangle2D with the specified Rectangle2D.

Specified by:
createIntersection in class Rectangle2D
Parameters:
rect - the Rectangle2D to be intersected with this Rectangle2D
Returns:
the largest Rectangle2D contained in both the specified Rectangle2D and in this Rectangle2D.

createUnion

public Rectangle2D createUnion(Rectangle2D rect)
Returns a new Rectangle2D object representing the union of this Rectangle2D with the specified Rectangle2D.

Specified by:
createUnion in class Rectangle2D
Parameters:
rect - the Rectangle2D to be combined with this Rectangle2D
Returns:
the smallest Rectangle2D containing both the specified Rectangle2D and this Rectangle2D.

add

public void add(double x,
                double y)
Adds a point, specified by the double precision arguments x and y, to this Rectangle2D. The resulting Rectangle2D is the smallest Rectangle2D that contains both the original Rectangle2D and the specified point.

After adding a point, a call to contains with the added point as an argument does not necessarily return true. The contains method does not return true for points on the right or bottom edges of a rectangle. Therefore, if the added point falls on the left or bottom edge of the enlarged rectangle, contains returns false for that point.

Overrides:
add in class Rectangle2D

add

public void add(Rectangle2D rect)
Adds a Rectangle2D object to this Rectangle2D. The resulting Rectangle2D is the union of the two Rectangle2D objects.

Overrides:
add in class Rectangle2D
Parameters:
rect - the Rectangle2D to add to this Rectangle2D.

toString

public String toString()
Returns the String representation of this Rectangle2D.

Overrides:
toString in class Object
Returns:
a String representing this Rectangle2D.

deegree 2.1 (2007/11/08 09:57 build-328-official)

an open source project founded by lat/lon, Bonn, Germany.
For more information visit: http://deegree.sourceforge.net