math.geom2d.polygon
Class HRectangle2D

java.lang.Object
  java.awt.geom.RectangularShape
      java.awt.geom.Rectangle2D
          java.awt.geom.Rectangle2D.Double
              math.geom2d.polygon.HRectangle2D

All Implemented Interfaces:

Shape, Serializable, Cloneable, CirculinearDomain2D, CirculinearShape2D, Domain2D, Polygon2D, Shape2D

public class HRectangle2D
extends Rectangle2D.Double
implements Polygon2D

HRectangle2D defines a rectangle with edges parallel to main axis. Thus, it can not be rotated, contrary to Rectangle2D. This class is actually simply a wrapper of class java.awt.geom.Rectangle2D.Double with interface AbstractPolygon.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.geom.Rectangle2D

Rectangle2D.Double, Rectangle2D.Float

Field Summary

Fields inherited from class java.awt.geom.Rectangle2D.Double

height, width, x, y

Fields inherited from class java.awt.geom.Rectangle2D

OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP

Fields inherited from interface math.geom2d.Shape2D

ACCURACY

Constructor Summary

HRectangle2D()
Empty constructor (size and position zero)

HRectangle2D(double x0, double y0, double w, double h)
Main constructor

HRectangle2D(Point2D point, double w, double h)
Main constructor

HRectangle2D(Rectangle2D rect)
Constructor from awt, to allow easy construction from existing apps.

Method Summary

Domain2D	clip(Box2D box) Returns the clipping of the rectangle, as an instance of HRectangle2D.
Polygon2D	complement() Returns the complementary polygon.
void	draw(Graphics2D g2) Draw the shape on the given graphics.
boolean	equals(Object obj) Test if rectangles are the same.
void	fill(Graphics2D g2) Fills the interior of the domain, using the Graphics current Paint.
CirculinearBoundarySet2D<LinearRing2D>	getBoundary() Returns the boundary of the set.
Box2D	getBoundingBox() Returns the bounding box of the shape.
CirculinearDomain2D	getBuffer(double dist) Computes the buffer of the shape, formed by the set of points located at a distance from the shape that is lower or equal to d.
double	getDistance(double x, double y) get the distance of the shape to the given point, specified by x and y, or the distance of point to the frontier of the shape in the case of a plain (i.e. fillable) shape.
double	getDistance(Point2D p) get the distance of the shape to the given point, or the distance of point to the frontier of the shape in the case of a plain shape.
int	getEdgeNumber() Returns the number of edges of the polygon
Collection<LineSegment2D>	getEdges() Return the edges as line segments of the polygon
Collection<LinearRing2D>	getRings() Returns the set of rings comprising the boundary of this polygon.
double	getSignedDistance(double x, double y) Get the signed distance of the shape to the given point : this distance is positive if the point lies outside the shape, and is negative if the point lies inside the shape.
double	getSignedDistance(Point2D p) Get the signed distance of the shape to the given point : this distance is positive if the point lies outside the shape, and is negative if the point lies inside the shape.
Point2D	getVertex(int i) Returns the i-th vertex of the polygon.
int	getVertexNumber() Returns the number of vertex, which is 4.
Collection<Point2D>	getVertices() Returns the vertices (singular points) of the polygon
boolean	isBounded() Always returns true, because a rectangle is always bounded.
SimplePolygon2D	transform(AffineTransform2D trans) Return the new Polygon created by an affine transform of this polygon.
CirculinearDomain2D	transform(CircleInversion2D inv) Transforms the shape by a circle inversion.

Methods inherited from class java.awt.geom.Rectangle2D.Double

createIntersection, createUnion, getBounds2D, getHeight, getWidth, getX, getY, isEmpty, outcode, setRect, setRect, toString

Methods inherited from class java.awt.geom.Rectangle2D

add, add, add, contains, contains, getPathIterator, getPathIterator, hashCode, intersect, intersects, intersectsLine, intersectsLine, outcode, setFrame, union

Methods inherited from class java.awt.geom.RectangularShape

clone, contains, contains, getBounds, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface math.geom2d.Shape2D

contains, contains, isEmpty

Constructor Detail

HRectangle2D

public HRectangle2D(double x0,
                    double y0,
                    double w,
                    double h)

Main constructor

HRectangle2D

public HRectangle2D()

Empty constructor (size and position zero)

HRectangle2D

public HRectangle2D(Rectangle2D rect)

Constructor from awt, to allow easy construction from existing apps.

HRectangle2D

public HRectangle2D(Point2D point,
                    double w,
                    double h)

Main constructor

Method Detail

isBounded

public boolean isBounded()

Always returns true, because a rectangle is always bounded.

Specified by:

isBounded in interface Shape2D

getVertices

public Collection<Point2D> getVertices()

Description copied from interface: Polygon2D

Returns the vertices (singular points) of the polygon

Specified by:

getVertices in interface Polygon2D

getVertex

public Point2D getVertex(int i)

Returns the i-th vertex of the polygon.

Specified by:

getVertex in interface Polygon2D

Parameters:

i - index of the vertex, between 0 and 3

getVertexNumber

public int getVertexNumber()

Returns the number of vertex, which is 4.

Specified by:

getVertexNumber in interface Polygon2D

Since:

0.6.3

getEdges

public Collection<LineSegment2D> getEdges()

Description copied from interface: Polygon2D

Return the edges as line segments of the polygon

Specified by:

getEdges in interface Polygon2D

getEdgeNumber

public int getEdgeNumber()

Description copied from interface: Polygon2D

Returns the number of edges of the polygon

Specified by:

getEdgeNumber in interface Polygon2D

getRings

public Collection<LinearRing2D> getRings()

Description copied from interface: Polygon2D

Returns the set of rings comprising the boundary of this polygon.

Specified by:

getRings in interface Polygon2D

Returns:

the set of boundary rings.

transform

public CirculinearDomain2D transform(CircleInversion2D inv)

Description copied from interface: CirculinearShape2D

Transforms the shape by a circle inversion. The result is still an instance a CirculinearShape2D.

Specified by:

transform in interface CirculinearDomain2D

Specified by:

transform in interface CirculinearShape2D

Parameters:

inv - the circle inversion

Returns:

the transformed shape

getBuffer

public CirculinearDomain2D getBuffer(double dist)

Description copied from interface: CirculinearShape2D

Computes the buffer of the shape, formed by the set of points located at a distance from the shape that is lower or equal to d.

Specified by:

getBuffer in interface CirculinearShape2D

Parameters:

dist - the maximal distance between a point of the buffer and the shape

Returns:

the buffer of the shape

getBoundary

public CirculinearBoundarySet2D<LinearRing2D> getBoundary()

Description copied from interface: Domain2D

Returns the boundary of the set. This boundary is either a continuous non intersecting curve (connected domain), or a set of non intersecting continuous curve (one continuous non-intersection for each connected part of the domain).

The returned curve is oriented, with an interior and an exterior.

Specified by:

getBoundary in interface CirculinearDomain2D

Specified by:

getBoundary in interface Domain2D

Specified by:

getBoundary in interface Polygon2D

Returns:

the boundary of the domain

complement

public Polygon2D complement()

Description copied from interface: Polygon2D

Returns the complementary polygon.

Specified by:

complement in interface Domain2D

Specified by:

complement in interface Polygon2D

Returns:

the polygon complementary to this

getDistance

public double getDistance(Point2D p)

Description copied from interface: Shape2D

get the distance of the shape to the given point, or the distance of point to the frontier of the shape in the case of a plain shape.

Specified by:

getDistance in interface Shape2D

getDistance

public double getDistance(double x,
                          double y)

Description copied from interface: Shape2D

get the distance of the shape to the given point, specified by x and y, or the distance of point to the frontier of the shape in the case of a plain (i.e. fillable) shape.

Specified by:

getDistance in interface Shape2D

getSignedDistance

public double getSignedDistance(Point2D p)

Get the signed distance of the shape to the given point : this distance is positive if the point lies outside the shape, and is negative if the point lies inside the shape. In this case, absolute value of distance is equals to the distance to the border of the shape.

getSignedDistance

public double getSignedDistance(double x,
                                double y)

Get the signed distance of the shape to the given point : this distance is positive if the point lies outside the shape, and is negative if the point lies inside the shape. In this case, absolute value of distance is equals to the distance to the border of the shape.

clip

public Domain2D clip(Box2D box)

Returns the clipping of the rectangle, as an instance of HRectangle2D. If rectangle is outside clipping box, returns an instance of HRectangle with 0 width and height.

Specified by:

clip in interface Domain2D

Specified by:

clip in interface Shape2D

Parameters:

box - the clipping box

Returns:

the clipped shape

draw

public void draw(Graphics2D g2)

Description copied from interface: Shape2D

Draw the shape on the given graphics. If the shape is empty, nothing is drawn. If the shape is unbounded, an exception is thrown.

Specified by:

draw in interface Domain2D

Specified by:

draw in interface Shape2D

Parameters:

g2 - the Graphics to draw on

fill

public void fill(Graphics2D g2)

Description copied from interface: Domain2D

Fills the interior of the domain, using the Graphics current Paint.

Specified by:

fill in interface Domain2D

Parameters:

g2 - the Graphics to fill on

getBoundingBox

public Box2D getBoundingBox()

Description copied from interface: Shape2D

Returns the bounding box of the shape.

Specified by:

getBoundingBox in interface Shape2D

Returns:

the bounding box of the shape.

equals

public boolean equals(Object obj)

Test if rectangles are the same. We consider two rectangles are equal if their corners are the same. Then, we can have different origins and different angles, but equal rectangles.

Overrides:

equals in class Rectangle2D

transform

public SimplePolygon2D transform(AffineTransform2D trans)

Return the new Polygon created by an affine transform of this polygon.

Specified by:

transform in interface Domain2D

Specified by:

transform in interface Polygon2D

Specified by:

transform in interface Shape2D

Parameters:

trans - an affine transform

Returns:

the transformed shape