| java.lang.Object
 org.jfree.util.ShapeUtilities
| ShapeUtilities | | public class ShapeUtilities (Code) | | Utility methods for
Shape objects.
author:
David Gilbert |
| Method Summary | |
| public static Shape | clone(Shape shape)
Returns a clone of the specified shape, or null. | | public static boolean | contains(Rectangle2D rect1, Rectangle2D rect2)
Checks, whether the given rectangle1 fully contains rectangle 2
(even if rectangle 2 has a height or width of zero!).
Parameters:
rect1 - the first rectangle.
Parameters:
rect2 - the second rectangle. | | public static Shape | createDiagonalCross(float l, float t)
Creates a diagonal cross shape.
Parameters:
l - the length of each 'arm'.
Parameters:
t - the thickness. | | public static Shape | createDiamond(float s)
Creates a diamond shape.
Parameters:
s - the size factor (equal to half the height of the diamond). | | public static Shape | createDownTriangle(float s)
Creates a triangle shape that points downwards.
Parameters:
s - the size factor (equal to half the height of the triangle). | | public static Shape | createLineRegion(Line2D line, float width)
Creates a region surrounding a line segment by 'widening' the line
segment. | | public static Shape | createRegularCross(float l, float t)
Creates a diagonal cross shape.
Parameters:
l - the length of each 'arm'.
Parameters:
t - the thickness. | | public static Shape | createTranslatedShape(Shape shape, double transX, double transY)
Creates and returns a translated shape.
Parameters:
shape - the shape (null not permitted).
Parameters:
transX - the x translation (in Java2D space).
Parameters:
transY - the y translation (in Java2D space). | | public static Shape | createTranslatedShape(Shape shape, RectangleAnchor anchor, double locationX, double locationY)
Translates a shape to a new location such that the anchor point
(relative to the rectangular bounds of the shape) aligns with the
specified (x, y) coordinate in Java2D space.
Parameters:
shape - the shape (null not permitted).
Parameters:
anchor - the anchor (null not permitted).
Parameters:
locationX - the x-coordinate (in Java2D space).
Parameters:
locationY - the y-coordinate (in Java2D space). | | public static Shape | createUpTriangle(float s)
Creates a triangle shape that points upwards.
Parameters:
s - the size factor (equal to half the height of the triangle). | | public static void | drawRotatedShape(Graphics2D g2, Shape shape, double angle, float x, float y)
Draws a shape with the specified rotation about (x, y). | | public static boolean | equal(Shape s1, Shape s2)
Tests two shapes for equality. | | public static boolean | equal(Line2D l1, Line2D l2)
Compares two lines are returns true if they are equal or
both null.
Parameters:
l1 - the first line (null permitted).
Parameters:
l2 - the second line (null permitted). | | public static boolean | equal(Ellipse2D e1, Ellipse2D e2)
Compares two ellipses and returns true if they are equal or
both null.
Parameters:
e1 - the first ellipse (null permitted).
Parameters:
e2 - the second ellipse (null permitted). | | public static boolean | equal(Arc2D a1, Arc2D a2)
Compares two arcs and returns true if they are equal or
both null.
Parameters:
a1 - the first arc (null permitted).
Parameters:
a2 - the second arc (null permitted). | | public static boolean | equal(Polygon p1, Polygon p2)
Tests two polygons for equality. | | public static boolean | equal(GeneralPath p1, GeneralPath p2)
Tests two polygons for equality. | | public static Point2D | getPointInRectangle(double x, double y, Rectangle2D area)
Returns a point based on (x, y) but constrained to be within the bounds
of a given rectangle.
Parameters:
x - the x-coordinate.
Parameters:
y - the y-coordinate.
Parameters:
area - the constraining rectangle (null not permitted). | | public static boolean | intersects(Rectangle2D rect1, Rectangle2D rect2)
Checks, whether the given rectangle1 fully contains rectangle 2
(even if rectangle 2 has a height or width of zero!).
Parameters:
rect1 - the first rectangle.
Parameters:
rect2 - the second rectangle. | | public static Shape | rotateShape(Shape base, double angle, float x, float y)
Rotates a shape about the specified coordinates.
Parameters:
base - the shape (null permitted, returns null).
Parameters:
angle - the angle (in radians).
Parameters:
x - the x coordinate for the rotation point (in Java2D space).
Parameters:
y - the y coordinate for the rotation point (in Java2D space). |
| clone | | public static Shape clone(Shape shape)(Code) | | Returns a clone of the specified shape, or null. At the
current time, this method supports cloning for instances of
Line2D, RectangularShape, Area
and GeneralPath.
RectangularShape includes Arc2D,
Ellipse2D, Rectangle2D,
RoundRectangle2D.
Parameters:
shape - the shape to clone (null permitted, returns null). A clone or null. |
| contains | | public static boolean contains(Rectangle2D rect1, Rectangle2D rect2)(Code) | | Checks, whether the given rectangle1 fully contains rectangle 2
(even if rectangle 2 has a height or width of zero!).
Parameters:
rect1 - the first rectangle.
Parameters:
rect2 - the second rectangle. A boolean. |
| createDiagonalCross | | public static Shape createDiagonalCross(float l, float t)(Code) | | Creates a diagonal cross shape.
Parameters:
l - the length of each 'arm'.
Parameters:
t - the thickness. A diagonal cross shape. |
| createDiamond | | public static Shape createDiamond(float s)(Code) | | Creates a diamond shape.
Parameters:
s - the size factor (equal to half the height of the diamond). A diamond shape. |
| createDownTriangle | | public static Shape createDownTriangle(float s)(Code) | | Creates a triangle shape that points downwards.
Parameters:
s - the size factor (equal to half the height of the triangle). A triangle shape. |
| createLineRegion | | public static Shape createLineRegion(Line2D line, float width)(Code) | | Creates a region surrounding a line segment by 'widening' the line
segment. A typical use for this method is the creation of a
'clickable' region for a line that is displayed on-screen.
Parameters:
line - the line (null not permitted).
Parameters:
width - the width of the region. A region that surrounds the line. |
| createRegularCross | | public static Shape createRegularCross(float l, float t)(Code) | | Creates a diagonal cross shape.
Parameters:
l - the length of each 'arm'.
Parameters:
t - the thickness. A diagonal cross shape. |
| createTranslatedShape | | public static Shape createTranslatedShape(Shape shape, double transX, double transY)(Code) | | Creates and returns a translated shape.
Parameters:
shape - the shape (null not permitted).
Parameters:
transX - the x translation (in Java2D space).
Parameters:
transY - the y translation (in Java2D space). The translated shape. |
| createTranslatedShape | | public static Shape createTranslatedShape(Shape shape, RectangleAnchor anchor, double locationX, double locationY)(Code) | | Translates a shape to a new location such that the anchor point
(relative to the rectangular bounds of the shape) aligns with the
specified (x, y) coordinate in Java2D space.
Parameters:
shape - the shape (null not permitted).
Parameters:
anchor - the anchor (null not permitted).
Parameters:
locationX - the x-coordinate (in Java2D space).
Parameters:
locationY - the y-coordinate (in Java2D space). A new and translated shape. |
| createUpTriangle | | public static Shape createUpTriangle(float s)(Code) | | Creates a triangle shape that points upwards.
Parameters:
s - the size factor (equal to half the height of the triangle). A triangle shape. |
| drawRotatedShape | | public static void drawRotatedShape(Graphics2D g2, Shape shape, double angle, float x, float y)(Code) | | Draws a shape with the specified rotation about (x, y).
Parameters:
g2 - the graphics device (null not permitted).
Parameters:
shape - the shape (null not permitted).
Parameters:
angle - the angle (in radians).
Parameters:
x - the x coordinate for the rotation point.
Parameters:
y - the y coordinate for the rotation point. |
| equal | | public static boolean equal(Shape s1, Shape s2)(Code) | | Tests two shapes for equality. If both shapes are null,
this method will return true.
In the current implementation, the following shapes are supported:
Ellipse2D, Line2D and Rectangle2D
(implicit).
Parameters:
s1 - the first shape (null permitted).
Parameters:
s2 - the second shape (null permitted). A boolean. |
| equal | | public static boolean equal(Line2D l1, Line2D l2)(Code) | | Compares two lines are returns true if they are equal or
both null.
Parameters:
l1 - the first line (null permitted).
Parameters:
l2 - the second line (null permitted). A boolean. |
| equal | | public static boolean equal(Ellipse2D e1, Ellipse2D e2)(Code) | | Compares two ellipses and returns true if they are equal or
both null.
Parameters:
e1 - the first ellipse (null permitted).
Parameters:
e2 - the second ellipse (null permitted). A boolean. |
| equal | | public static boolean equal(Arc2D a1, Arc2D a2)(Code) | | Compares two arcs and returns true if they are equal or
both null.
Parameters:
a1 - the first arc (null permitted).
Parameters:
a2 - the second arc (null permitted). A boolean. |
| equal | | public static boolean equal(Polygon p1, Polygon p2)(Code) | | Tests two polygons for equality. If both are null this
method returns true.
Parameters:
p1 - polygon 1 (null permitted).
Parameters:
p2 - polygon 2 (null permitted). A boolean. |
| equal | | public static boolean equal(GeneralPath p1, GeneralPath p2)(Code) | | Tests two polygons for equality. If both are null this
method returns true.
Parameters:
p1 - path 1 (null permitted).
Parameters:
p2 - path 2 (null permitted). A boolean. |
| getPointInRectangle | | public static Point2D getPointInRectangle(double x, double y, Rectangle2D area)(Code) | | Returns a point based on (x, y) but constrained to be within the bounds
of a given rectangle.
Parameters:
x - the x-coordinate.
Parameters:
y - the y-coordinate.
Parameters:
area - the constraining rectangle (null not permitted). A point within the rectangle.
throws:
NullPointerException - if area is null. |
| intersects | | public static boolean intersects(Rectangle2D rect1, Rectangle2D rect2)(Code) | | Checks, whether the given rectangle1 fully contains rectangle 2
(even if rectangle 2 has a height or width of zero!).
Parameters:
rect1 - the first rectangle.
Parameters:
rect2 - the second rectangle. A boolean. |
| rotateShape | | public static Shape rotateShape(Shape base, double angle, float x, float y)(Code) | | Rotates a shape about the specified coordinates.
Parameters:
base - the shape (null permitted, returns null).
Parameters:
angle - the angle (in radians).
Parameters:
x - the x coordinate for the rotation point (in Java2D space).
Parameters:
y - the y coordinate for the rotation point (in Java2D space). the rotated shape. |
|
|