org.mdiutil.geom

Class ClippableShape

java.lang.Object

org.mdiutil.geom.ClippableShape

All Implemented Interfaces:

Shape

public class ClippableShape
extends Object
implements Shape

This class represents a shape that can be clipped, as it is possible to do with an Area.

For know, this class makes heavy use of the ShapeNormalizer class, so you have to be aware that the conversion can have some imperfections, due to the conversion from a set of curves to arcs. However, as this class is mostly useful for converting to graphic formats that don't deal well with clipping paths, and considering that most of the times, these formats don't handle curves (for example, see WMF format), this is not really a problem.

Field Summary

Fields

Modifier and Type	Field and Description
static double	ASSUME_ZERO 1.0E-4: Constant used for coordinates equality.
protected Shape	shape The internal clipped Shape.

Constructor Summary

Constructors

Constructor and Description
ClippableShape(Shape shape) Create a new ClippableShape.

Method Summary

Modifier and Type	Method and Description
boolean	contains(double x, double y) Defer to Shape.contains(double, double) with the resulting clipped Shape.
boolean	contains(double x, double y, double w, double h) Defer to Shape.contains(double, double, double, double) with the resulting clipped Shape.
boolean	contains(Point2D p) Defer to Shape.contains(java.awt.geom.Point2D) with the resulting clipped Shape.
boolean	contains(Rectangle2D r) Defer to Shape.contains(java.awt.geom.Rectangle2D) with the resulting clipped Shape.
Rectangle	getBounds() Return the bounds of the resulting clipped Shape.
Rectangle2D	getBounds2D() Return the bounds of the resulting clipped Shape.
PathIterator	getPathIterator(AffineTransform at)
PathIterator	getPathIterator(AffineTransform at, double flatness)
Shape	getPeerShape() Return the peer shape.
Shape	getUnclosedShape(Shape shape, boolean closeProperty) Return the associated unclosed shape.
void	intersect(Area rhs) Perform the intersection of this shape with the area.
void	intersectAsArea(Area rhs) Perform the intersection of the area associated to this shape with the area, after transforming this shape to an Area.
boolean	intersects(double x, double y, double w, double h)
boolean	intersects(Rectangle2D r)

Methods inherited from class java.lang.Object

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

Field Detail

shape

protected Shape shape

The internal clipped Shape.

ASSUME_ZERO

public static final double ASSUME_ZERO

1.0E-4: Constant used for coordinates equality. Its value is 0.0001.

See Also:

Constant Field Values

Constructor Detail

ClippableShape

public ClippableShape(Shape shape)

Create a new ClippableShape.

Parameters:

shape - the peer shape

Method Detail

intersect

public void intersect(Area rhs)

Perform the intersection of this shape with the area. The shape will becomes the intersected shape.

The algorithm is the following intersect(Area) :

• if the peer Shape of this Clippable shape is an area, just use the intersect method of the Area class, that deals well in these cases
• if not, it is a plain Shape and we are on our own :
  • first the shape is stripped to its possible CLOSE path segments, these being transformed into plain LINETO, CUBICTO, and QUADTO segments
  • then we use ShapeNormalizer to normalize the resulting Shape and get the associated Vector of elementary shapes : Line2D, Polygon2D, Polyline2D, ArC2D
  • then we get the associated Area for each of the associated segments :
    • each line of the Shape is transformed into a Polygon, from which the line is one of the vertex of this polygon (the other dimension is arbitrary taken as 1 to have a corresponding closed Shape, suitable to have a corresponding Area
    • arcs don't have to be transformed, as they are already suitable to have an Area
  • finally we use the intersect method for each of these areas and retrieve the "good" segments in the corresponding path.

Parameters:

rhs - the area to intersect

intersectAsArea

public void intersectAsArea(Area rhs)

Perform the intersection of the area associated to this shape with the area, after transforming this shape to an Area.

Parameters:

rhs - the area to intersect

getPeerShape

public Shape getPeerShape()

Return the peer shape.

Returns:

the peer shape

getUnclosedShape

public Shape getUnclosedShape(Shape shape,
                              boolean closeProperty)

Return the associated unclosed shape.

Parameters:

shape - the shape to convert to an unclosed Shape

closeProperty - true if the CLOSE segment will result in a Line, false if it will be omitted

Returns:

the associated unclosed shape

contains

public boolean contains(Rectangle2D r)

Defer to Shape.contains(java.awt.geom.Rectangle2D) with the resulting clipped Shape.

Specified by:

contains in interface Shape

Parameters:

r - the Rectangle

Returns:

true if the clipped Shape contains the Rectangle

contains

public boolean contains(Point2D p)

Defer to Shape.contains(java.awt.geom.Point2D) with the resulting clipped Shape.

Specified by:

contains in interface Shape

Parameters:

p - the Point

Returns:

true if the clipped Shape contains the Point

contains

public boolean contains(double x,
                        double y)

Defer to Shape.contains(double, double) with the resulting clipped Shape.

Specified by:

contains in interface Shape

Parameters:

x - the x coordinate of the Point

y - the y coordinate of the Point

Returns:

true if the clipped Shape contains the Point

contains

public boolean contains(double x,
                        double y,
                        double w,
                        double h)

Defer to Shape.contains(double, double, double, double) with the resulting clipped Shape.

Specified by:

contains in interface Shape

Parameters:

x - the x coordinate of the rectangle

y - the y coordinate of the rectangle

w - the width of the rectangle

h - the height of the rectangle

Returns:

true if the clipped Shape contains the rectangle

getBounds

public Rectangle getBounds()

Return the bounds of the resulting clipped Shape.

Specified by:

getBounds in interface Shape

Returns:

the bounds

getBounds2D

public Rectangle2D getBounds2D()

Return the bounds of the resulting clipped Shape.

Specified by:

getBounds2D in interface Shape

Returns:

the bounds

getPathIterator

public PathIterator getPathIterator(AffineTransform at)

Specified by:

getPathIterator in interface Shape

getPathIterator

public PathIterator getPathIterator(AffineTransform at,
                                    double flatness)

Specified by:

getPathIterator in interface Shape

intersects

public boolean intersects(Rectangle2D r)

Specified by:

intersects in interface Shape

intersects

public boolean intersects(double x,
                          double y,
                          double w,
                          double h)

Specified by:

intersects in interface Shape