java.awt.geom

Class RectangularShape

public abstract class RectangularShape extends Object implements Shape, Cloneable

This class provides a generic framework, and several helper methods, for subclasses which represent geometric objects inside a rectangular frame. This does not specify any geometry except for the bounding box.

Since: 1.2

UNKNOWN: updated to 1.4

Constructor Summary
protected	RectangularShape() Default constructor.

Method Summary
Object	clone() Create a new shape of the same run-time type with the same contents as this one.
boolean	contains(Point2D p) Tests if a point is inside the boundary of the shape.
boolean	contains(Rectangle2D r) Tests if the shape completely contains the given rectangle.
Rectangle	getBounds() Returns a bounding box for this shape, in integer format.
double	getCenterX() Return the x coordinate of the center point of the framing rectangle.
double	getCenterY() Return the y coordinate of the center point of the framing rectangle.
Rectangle2D	getFrame() Return the frame around this object.
abstract double	getHeight() Get the height of the framing rectangle.
double	getMaxX() Get the maximum x coordinate in the frame.
double	getMaxY() Get the maximum y coordinate in the frame.
double	getMinX() Get the minimum x coordinate in the frame.
double	getMinY() Get the minimum y coordinate in the frame.
PathIterator	getPathIterator(AffineTransform at, double flatness) Return an iterator along the shape boundary.
abstract double	getWidth() Get the width of the framing rectangle.
abstract double	getX() Get the x coordinate of the upper-left corner of the framing rectangle.
abstract double	getY() Get the y coordinate of the upper-left corner of the framing rectangle.
boolean	intersects(Rectangle2D r) Tests if a rectangle and this shape share common internal points.
abstract boolean	isEmpty() Test if the shape is empty, meaning that no points are inside it.
abstract void	setFrame(double x, double y, double w, double h) Set the framing rectangle of this shape to the given coordinate and size.
void	setFrame(Point2D p, Dimension2D d) Set the framing rectangle of this shape to the given coordinate and size.
void	setFrame(Rectangle2D r) Set the framing rectangle of this shape to the given rectangle.
void	setFrameFromCenter(double centerX, double centerY, double cornerX, double cornerY) Set the framing rectangle of this shape using the center of the frame, and one of the four corners.
void	setFrameFromCenter(Point2D center, Point2D corner) Set the framing rectangle of this shape using the center of the frame, and one of the four corners.
void	setFrameFromDiagonal(double x1, double y1, double x2, double y2) Set the framing rectangle of this shape using two points on a diagonal.
void	setFrameFromDiagonal(Point2D p1, Point2D p2) Set the framing rectangle of this shape using two points on a diagonal.

Constructor Detail

RectangularShape

protected RectangularShape()

Default constructor.

Method Detail

clone

public Object clone()

Create a new shape of the same run-time type with the same contents as this one.

Returns: the clone

contains

public boolean contains(Point2D p)

Tests if a point is inside the boundary of the shape.

Parameters: p the point to test

Returns: true if the point is inside the shape

Throws: NullPointerException if p is null

See Also: RectangularShape

contains

public boolean contains(Rectangle2D r)

Tests if the shape completely contains the given rectangle.

Parameters: r the rectangle to test

Returns: true if r is contained in this shape

Throws: NullPointerException if r is null

See Also: RectangularShape

getBounds

public Rectangle getBounds()

Returns a bounding box for this shape, in integer format. Notice that you may get a tighter bound with getBounds2D.

Returns: a bounding box

getCenterX

public double getCenterX()

Return the x coordinate of the center point of the framing rectangle.

Returns: the central x coordinate

getCenterY

public double getCenterY()

Return the y coordinate of the center point of the framing rectangle.

Returns: the central y coordinate

getFrame

public Rectangle2D getFrame()

Return the frame around this object. Note that this may be a looser bounding box than getBounds2D.

Returns: the frame, in double precision

See Also: RectangularShape

getHeight

public abstract double getHeight()

Get the height of the framing rectangle.

Returns: the height

getMaxX

public double getMaxX()

Get the maximum x coordinate in the frame. This is misnamed, or else Sun has a bug, because the implementation returns getX()+getWidth() even when getWidth() is negative.

Returns: the maximum x coordinate

getMaxY

public double getMaxY()

Get the maximum y coordinate in the frame. This is misnamed, or else Sun has a bug, because the implementation returns getY()+getHeight() even when getHeight() is negative.

Returns: the maximum y coordinate

getMinX

public double getMinX()

Get the minimum x coordinate in the frame. This is misnamed, or else Sun has a bug, because the implementation returns getX() even when getWidth() is negative.

Returns: the minimum x coordinate

getMinY

public double getMinY()

Get the minimum y coordinate in the frame. This is misnamed, or else Sun has a bug, because the implementation returns getY() even when getHeight() is negative.

Returns: the minimum y coordinate

getPathIterator

public PathIterator getPathIterator(AffineTransform at, double flatness)

Return an iterator along the shape boundary. If the optional transform is provided, the iterator is transformed accordingly. The path is flattened until all segments differ from the curve by at most the value of the flatness parameter, within the limits of the default interpolation recursion limit of 1024 segments between actual points. Each call returns a new object, independent from others in use. The result is threadsafe if and only if the iterator returned by {@link #getPathIterator(AffineTransform)} is as well.

Parameters: at an optional transform to apply to the iterator flatness the desired flatness

Returns: a new iterator over the boundary

Throws: IllegalArgumentException if flatness is invalid

Since: 1.2

getWidth

public abstract double getWidth()

Get the width of the framing rectangle.

Returns: the width

getX

public abstract double getX()

Get the x coordinate of the upper-left corner of the framing rectangle.

Returns: the x coordinate

getY

public abstract double getY()

Get the y coordinate of the upper-left corner of the framing rectangle.

Returns: the y coordinate

intersects

public boolean intersects(Rectangle2D r)

Tests if a rectangle and this shape share common internal points.

Parameters: r the rectangle to test

Returns: true if the rectangle intersects this shpae

Throws: NullPointerException if r is null

See Also: RectangularShape

isEmpty

public abstract boolean isEmpty()

Test if the shape is empty, meaning that no points are inside it.

Returns: true if the shape is empty

setFrame

public abstract void setFrame(double x, double y, double w, double h)

Set the framing rectangle of this shape to the given coordinate and size.

Parameters: x the new x coordinate y the new y coordinate w the new width h the new height

setFrame

public void setFrame(Point2D p, Dimension2D d)

Set the framing rectangle of this shape to the given coordinate and size.

Parameters: p the new point d the new dimension

Throws: NullPointerException if p or d is null

setFrame

public void setFrame(Rectangle2D r)

Set the framing rectangle of this shape to the given rectangle.

Parameters: r the new framing rectangle

Throws: NullPointerException if r is null

setFrameFromCenter

public void setFrameFromCenter(double centerX, double centerY, double cornerX, double cornerY)

Set the framing rectangle of this shape using the center of the frame, and one of the four corners. The area will be positive.

Parameters: centerX the x coordinate at the center centerY the y coordinate at the center cornerX the x coordinate at a corner cornerY the y coordinate at a corner

setFrameFromCenter

public void setFrameFromCenter(Point2D center, Point2D corner)

Set the framing rectangle of this shape using the center of the frame, and one of the four corners. The area will be positive.

Parameters: center the center point corner a corner point

Throws: NullPointerException if either point is null

setFrameFromDiagonal

public void setFrameFromDiagonal(double x1, double y1, double x2, double y2)

Set the framing rectangle of this shape using two points on a diagonal. The area will be positive.

Parameters: x1 the first x coordinate y1 the first y coordinate x2 the second x coordinate y2 the second y coordinate

setFrameFromDiagonal

public void setFrameFromDiagonal(Point2D p1, Point2D p2)

Set the framing rectangle of this shape using two points on a diagonal. The area will be positive.

Parameters: p1 the first point p2 the second point

Throws: NullPointerException if either point is null