com.kheops.jmap.spatial

Class Rectangle

java.lang.Object

com.kheops.jmap.spatial.DefaultGeometry

com.kheops.jmap.spatial.Rectangle

All Implemented Interfaces:

Geometry, Surface, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

Rectangle.Double, Rectangle.Float

public abstract class Rectangle
extends DefaultGeometry
implements Surface

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Rectangle.Double
static class	Rectangle.Float

Field Summary

Fields

Modifier and Type	Field and Description
protected Point	coord

Fields inherited from interface com.kheops.jmap.spatial.Geometry

GEOMETRY_ANNOTATION, GEOMETRY_COMPLEX, GEOMETRY_ELLIPSE, GEOMETRY_LINE, GEOMETRY_LINEAR_RING, GEOMETRY_LINESTRING, GEOMETRY_MULTI_ANNOTATION, GEOMETRY_MULTI_LINESTRING, GEOMETRY_MULTI_POINT, GEOMETRY_MULTI_POLYGON, GEOMETRY_POINT, GEOMETRY_POLYGON, GEOMETRY_RECTANGLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Rectangle()

Method Summary

Modifier and Type	Method and Description
Rectangle	add(Rectangle rect) Modifies this rectangle so that it is equal to the sum of the two rectangles.
static Rectangle	add(Rectangle r1, Rectangle r2) Adds the second rectangle to the first rectangle specified.
double	area() Computes and returns the surface area.
java.lang.String	asText() Returns this geometry encoded using the Well-Known Text (WKT) standard.
Geometry	boundary() Returns the boundary of this geometry as a line string.
Point	centroid() Returns the centroid of the current surface.
abstract Rectangle	clone() Clones this geometry.
boolean	contains(double x, double y) Deprecated. use contains(double, double, double)
boolean	contains(double x, double y, double tolerance)
boolean	contains(Point coord) Deprecated. use contains(Point, PrecisionModel)
boolean	contains(Point coord, PrecisionModel precisionModel)
static Rectangle	createBigRectangle()
void	createBounds() Updates the geometry bounds from the current geometry.
boolean	equals(java.lang.Object o)
Rectangle	getBounds() Returns the minimum bounding rectangle of this geometry.
Point	getCenteredPoint() This method returns a point that is typically centered on the geometry.
Point	getCoord()
short	getGeometryId() Returns the geometry class id.
int	getGeometryType() Returns the geometry type for this geometry.
abstract double	getHeight()
abstract double	getMaxX()
abstract double	getMaxY()
abstract double	getMinX()
abstract double	getMinY()
abstract double	getWidth()
Rectangle	inflate(double factor)
static Geometry	intersection(Geometry geo, Rectangle rect) Deprecated.
static Geometry	intersection(Geometry geo, Rectangle rect, PrecisionModel precisionModel)
Rectangle	intersection(Rectangle rect)
static boolean	intersects(LineString l, Rectangle rect, PrecisionModel precisionModel) fast intersects test (faster than the one for geometries in general)
static boolean	intersects(Point p, Rectangle rect) Deprecated.
static boolean	intersects(Point p, Rectangle rect, PrecisionModel precisionModel) fast intersects test (faster than the one for geometries in general)
static boolean	intersects(Polygon poly, Rectangle rect, PrecisionModel precisionModel) fast intersects test (faster than the one for geometries in general)
boolean	intersects(Rectangle rect) Deprecated.
static boolean	intersects(Rectangle rect, double x, double y, double width, double height) Deprecated.
static boolean	intersects(Rectangle rect, double x, double y, double width, double height, PrecisionModel precisionModel)
boolean	intersects(Rectangle rect, PrecisionModel precisionModel)
double	length() Returns the geometry length.
Point	pointOnSurface() Returns a point that is located in the interior of this surface geometry.
Point[]	serialize() Returns this geometry as an array of Point.
void	setBounds(Rectangle rect) Sets the new bounds of this rectangle.
void	setCoord(double x, double y)
void	setCoord(Point coord)
abstract void	setHeight(double height)
abstract void	setWidth(double width)
boolean	spatiallyEquals(Geometry geometry, PrecisionModel precisionModel) Tests if this geometry is equal to the argument, on a topological point of view.
java.awt.Rectangle	toAwtRectangle()
Polygon	toPolygon()
Polygon	toPolygon(double maxNodeDistance) Creates a polygon from the rectangle, inserting nodes along the sides of the rectangle so that the maximum distance between 2 nodes is less than the specified distance.
Geometry	transform(Transformation tr) Creates a clone of the current rectangle and returns the new instance tranformed with the specified geometry transformation. The returned geometry can be of any geometry types after the transformation.
void	translate(double dx, double dy) Translate this geometry with the specified values.
static Rectangle	translate(Rectangle rect, double dx, double dy) Creates a clone of the specified rectangle et translates it by the specified values.

Methods inherited from class com.kheops.jmap.spatial.DefaultGeometry

spatiallyEquals

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.kheops.jmap.spatial.Geometry

sizeOf, spatiallyEquals, toString

Field Detail

coord

protected Point coord

Constructor Detail

Rectangle

protected Rectangle()

Method Detail

createBigRectangle

public static Rectangle createBigRectangle()

pointOnSurface

public Point pointOnSurface()

Description copied from interface: Surface

Returns a point that is located in the interior of this surface geometry.

Specified by:

pointOnSurface in interface Surface

Returns:

a point on thge surface.

getCenteredPoint

public Point getCenteredPoint()

Description copied from interface: Geometry

This method returns a point that is typically centered on the geometry. If the geometry is a point, the point is returned. If it is a line, a point on the curve interpolated at 50% is returned. If the geometry is a surface, the centroid is returned if it is inside the polygon, if not, a point inside the polygon (but likely not exactly in the center) will be returned. If the geometry is a collection, the method is called on the first part of the collection.

Specified by:

getCenteredPoint in interface Geometry

Returns:

a point likely at the center of the geometry

See Also:

Geometry.getCenteredPoint()

getHeight

public abstract double getHeight()

Returns:

getCoord

public Point getCoord()

Returns:

Bottom-left coordinates

getWidth

public abstract double getWidth()

Returns:

setHeight

public abstract void setHeight(double height)

Parameters:

height -

clone

public abstract Rectangle clone()

Description copied from class: DefaultGeometry

Clones this geometry.

Specified by:

clone in interface Geometry

Specified by:

clone in class DefaultGeometry

Returns:

a deep copy of the current geometry.

setCoord

public void setCoord(double x,
                     double y)

Parameters:

x -

y -

setCoord

public void setCoord(Point coord)

Parameters:

coord -

setWidth

public abstract void setWidth(double width)

Parameters:

width -

getMinX

public abstract double getMinX()

getMinY

public abstract double getMinY()

getMaxX

public abstract double getMaxX()

getMaxY

public abstract double getMaxY()

createBounds

public void createBounds()

Description copied from interface: Geometry

Updates the geometry bounds from the current geometry.

Specified by:

createBounds in interface Geometry

getBounds

public Rectangle getBounds()

Description copied from interface: Geometry

Returns the minimum bounding rectangle of this geometry.

Specified by:

getBounds in interface Geometry

Returns:

the bounding box of this geometry.

setBounds

public void setBounds(Rectangle rect)

Sets the new bounds of this rectangle.

Parameters:

rect - the new bounds to set.

area

public double area()

Description copied from interface: Surface

Computes and returns the surface area.

Specified by:

area in interface Geometry

Specified by:

area in interface Surface

Returns:

the surface area.

length

public double length()

Description copied from interface: Geometry

Returns the geometry length. If the geometry is a surface, then the geometry perimeter shall be returned.

Specified by:

length in interface Geometry

Returns:

the geometry length.

centroid

public Point centroid()

Description copied from interface: Surface

Returns the centroid of the current surface.

Specified by:

centroid in interface Surface

Returns:

the centroid.

add

public Rectangle add(Rectangle rect)

Modifies this rectangle so that it is equal to the sum of the two rectangles. The result contains the two rectangles entirely.

Parameters:

rect - the rectangle to add

Returns:

the modified rectangle

intersects

@Deprecated
public boolean intersects(Rectangle rect)

Deprecated.

Parameters:

rect -

Returns:

intersects

public boolean intersects(Rectangle rect,
                          PrecisionModel precisionModel)

intersects

@Deprecated
public static boolean intersects(Rectangle rect,
                                             double x,
                                             double y,
                                             double width,
                                             double height)

Deprecated.

Parameters:

rect -

x -

y -

width -

height -

Returns:

intersects

public static boolean intersects(Rectangle rect,
                                 double x,
                                 double y,
                                 double width,
                                 double height,
                                 PrecisionModel precisionModel)

intersection

public Rectangle intersection(Rectangle rect)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

spatiallyEquals

public boolean spatiallyEquals(Geometry geometry,
                               PrecisionModel precisionModel)

Description copied from interface: Geometry

Tests if this geometry is equal to the argument, on a topological point of view.

Specified by:

spatiallyEquals in interface Geometry

Parameters:

geometry - the geometry to be tested.

precisionModel - the precision model to use while comparing geometries.

Returns:

whether or not both geometries are spatially equals.

contains

@Deprecated
public boolean contains(Point coord)

Deprecated. use contains(Point, PrecisionModel)

Parameters:

coord -

contains

public boolean contains(Point coord,
                        PrecisionModel precisionModel)

contains

@Deprecated
public boolean contains(double x,
                                    double y)

Deprecated. use contains(double, double, double)

Parameters:

x -

y -

contains

public boolean contains(double x,
                        double y,
                        double tolerance)

translate

public void translate(double dx,
                      double dy)

Description copied from interface: Geometry

Translate this geometry with the specified values.

Specified by:

translate in interface Geometry

Parameters:

dx - translation on the X-axis.

dy - translation on the Y-axis.

inflate

public Rectangle inflate(double factor)

add

public static Rectangle add(Rectangle r1,
                            Rectangle r2)

Adds the second rectangle to the first rectangle specified. If one of the rectangle is null, the other non-null rectangle is returned. If both rectangles are null, null is returned.

Parameters:

r1 - the first rectangle

r2 - the second rectangle

Returns:

the addition of both rectangles.

translate

public static Rectangle translate(Rectangle rect,
                                  double dx,
                                  double dy)

Creates a clone of the specified rectangle et translates it by the specified values.

Parameters:

rect - the rectangle to translate.

dx - the value to add to the X coordinate.

dy - the value to add to the Y coordinate.

Returns:

a new rectangle initialized using the specified rectangle and translated by the specified values.

intersects

@Deprecated
public static boolean intersects(Point p,
                                             Rectangle rect)

Deprecated.

fast intersects test (faster than the one for geometries in general)

Parameters:

p -

rect -

precisionModel -

Returns:

intersects

public static boolean intersects(Point p,
                                 Rectangle rect,
                                 PrecisionModel precisionModel)

fast intersects test (faster than the one for geometries in general)

Parameters:

p -

rect -

precisionModel -

Returns:

intersects

public static boolean intersects(LineString l,
                                 Rectangle rect,
                                 PrecisionModel precisionModel)

fast intersects test (faster than the one for geometries in general)

Parameters:

l -

rect -

precisionModel -

Returns:

intersects

public static boolean intersects(Polygon poly,
                                 Rectangle rect,
                                 PrecisionModel precisionModel)

fast intersects test (faster than the one for geometries in general)

Parameters:

poly -

rect -

precisionModel -

Returns:

intersection

@Deprecated
public static Geometry intersection(Geometry geo,
                                                Rectangle rect)

Deprecated.

Parameters:

geo -

rect -

Returns:

intersection

public static Geometry intersection(Geometry geo,
                                    Rectangle rect,
                                    PrecisionModel precisionModel)

toAwtRectangle

public java.awt.Rectangle toAwtRectangle()

getGeometryId

public short getGeometryId()

Description copied from interface: Geometry

Returns the geometry class id. This method is useful for geometry serialization.

Specified by:

getGeometryId in interface Geometry

Returns:

a new Polygon

getGeometryType

public int getGeometryType()

Description copied from interface: Geometry

Returns the geometry type for this geometry.

Specified by:

getGeometryType in interface Geometry

Returns:

the geometry type.

See Also:

for more details.

transform

public Geometry transform(Transformation tr)

Creates a clone of the current rectangle and returns the new instance tranformed with the specified geometry transformation.
The returned geometry can be of any geometry types after the transformation.

Specified by:

transform in interface Geometry

Parameters:

tr - the transformation to apply.

Returns:

the newly created and transformed geometry instance.

toPolygon

public Polygon toPolygon()

toPolygon

public Polygon toPolygon(double maxNodeDistance)

Creates a polygon from the rectangle, inserting nodes along the sides of the rectangle so that the maximum distance between 2 nodes is less than the specified distance.

Parameters:

maxNodeDistance - the maximum distance between 2 nodes of the polygon

Returns:

the resulting polygon

boundary

public Geometry boundary()

Description copied from interface: Geometry

Returns the boundary of this geometry as a line string.

Specified by:

boundary in interface Geometry

Returns:

a line string which defines the boundary of the current geometry.

serialize

public Point[] serialize()

Description copied from interface: Geometry

Returns this geometry as an array of Point.

Specified by:

serialize in interface Geometry

Returns:

this geometry as an array of Point.

asText

public java.lang.String asText()

Description copied from class: DefaultGeometry

Returns this geometry encoded using the Well-Known Text (WKT) standard.

Specified by:

asText in interface Geometry

Overrides:

asText in class DefaultGeometry

Returns:

a WKT geometry.