com.sharkysoft.fig.extra.shape

Class CompoundShape

java.lang.Object

com.sharkysoft.fig.extra.shape.CompoundShape

All Implemented Interfaces:

Shape

public class CompoundShape
extends Object
implements Shape

Represents multiple shapes as a single shape.

Details: A CompoundShape aggregates multiple Shapes into a single Shape. To build a CompoundShape, create a new instance using the default constructor, and then add each individual subshape using add(Shape).

Author:

Sharky

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Shape>	mShapes

Constructor Summary

Constructors

Constructor and Description
CompoundShape() Initializes empty compound.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Shape iShape) Adds shape to compound.
boolean	contains(double iX, double iY) Determines whether point is contained in compound.
boolean	contains(double iX, double iY, double iW, double iH) Determines whether rectangle is contained in compound.
boolean	contains(Point2D iP) Determines whether point is contained in compound.
boolean	contains(Rectangle2D iR) Determines whether rectangle is contained in compound.
Rectangle	getBounds() Computes bounds of entire compound.
Rectangle2D	getBounds2D() Computes bounds of entire compound.
PathIterator	getPathIterator(AffineTransform iTrans) Iterates path of entire shape.
PathIterator	getPathIterator(AffineTransform iTrans, double iFlatness) Iterates path of entire shape.
boolean	intersects(double iX, double iY, double iW, double iH) Determines whether rectangle intersects compound.
boolean	intersects(Rectangle2D iR) Determines whether rectangle intersects compound.
void	remove(Shape iShape) Removes subshape.

Methods inherited from class java.lang.Object

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

Field Detail

mShapes

protected final List<Shape> mShapes

Constructor Detail

CompoundShape

public CompoundShape()

Initializes empty compound.

Details: This default constructor initializes an empty compound with the default winding rule, which is PathIterator.WIND_EVEN_ODD. After creating a new instance, you should add the subshapes using add(Shape).

Method Detail

add

public void add(Shape iShape)

Adds shape to compound.

Details: add adds the given subshape to this compound.

Parameters:

iShape - the subshape to add

remove

public void remove(Shape iShape)

Removes subshape.

Details: remove removes the given subshape from this compound. If the shape to remove is not a part of this compound, no action is taken and no harm is done.

Parameters:

iShape - the subshape to remove

getBounds

public Rectangle getBounds()

Computes bounds of entire compound.

Details: getBounds returns a rectangle that totally every subshape in this compound.

Specified by:

getBounds in interface Shape

Returns:

the enclosing rectangle

getBounds2D

public Rectangle2D getBounds2D()

Computes bounds of entire compound.

Details: getBounds returns a rectangle that totally every subshape in this compound.

Specified by:

getBounds2D in interface Shape

Returns:

the enclosing rectangle

contains

public boolean contains(double iX,
               double iY)

Determines whether point is contained in compound.

Details: contains returns true if the given point lies within this compound shape, false otherwise. Containment is determined by testing the point for containment in each individual subshape. If any of the subshapes' contains methods reports that the subshape contains the point, then the entire compound is reported to contain the point.

Specified by:

contains in interface Shape

Parameters:

iX - x coordinate of point

iY - y coordinate of point

Returns:

true iff point is contained

contains

public boolean contains(Point2D iP)

Determines whether point is contained in compound.

Details: contains returns true if the given point lies within this compound shape, false otherwise. Containment is determined by testing the point for containment in each individual subshape. If any of the subshapes' contains methods reports that the subshape contains the point, then the entire compound is reported to contain the point.

Specified by:

contains in interface Shape

Parameters:

iP - the point

Returns:

true iff point is contained

intersects

public boolean intersects(double iX,
                 double iY,
                 double iW,
                 double iH)

Determines whether rectangle intersects compound.

Details: intersects returns true if the given rectangle intersects this compound shape, false otherwise. Intersection is determined by testing the rectangle for intersection with each individual subshape. If any of the subshapes' intersects methods reports that the subshape intersects with the rectangle, then the entire compound is reported to intersect with the rectangle.

Specified by:

intersects in interface Shape

Parameters:

iX - rectangle origin, x coordinate

iY - rectangle origin, y coordinate

iW - rectangle width

iH - rectangle height

Returns:

true iff rectangle intersects

intersects

public boolean intersects(Rectangle2D iR)

Determines whether rectangle intersects compound.

Details: intersects returns true if the given rectangle intersects this compound shape, false otherwise. Intersection is determined by testing the rectangle for intersection with each individual subshape. If any of the subshapes' intersects methods reports that the subshape intersects with the rectangle, then the entire compound is reported to intersect with the rectangle.

Specified by:

intersects in interface Shape

Parameters:

iR - the rectangle

Returns:

true iff rectangle intersects

contains

public boolean contains(double iX,
               double iY,
               double iW,
               double iH)

Determines whether rectangle is contained in compound.

Details: contains returns true if the given rectangle lies entirely within this compound shape, false otherwise.

Containment is determined by testing the rectangle for complete containment in each individual subshape. If any of the subshapes' contains methods reports that the subshape contains the point, then the entire compound is reported to contain the point.

Note that this implementation is not entirely perfect. For example, if a portion of the rectangle is enclosed in one subshape, and the remaining portion is covered by another subshape, this implementation may still report that the entire rectangle is not contained in the composite, if there is no single subshape that completely encloses it.

Specified by:

contains in interface Shape

Parameters:

iX - the rectangle, x-origin

iY - the rectangle, y-origin

iW - the rectangle, width

iH - the rectangle, height

Returns:

true iff rectangle is contained

contains

public boolean contains(Rectangle2D iR)

Determines whether rectangle is contained in compound.

Details: contains returns true if the given rectangle lies entirely within this compound shape, false otherwise.

Containment is determined by testing the rectangle for complete containment in each individual subshape. If any of the subshapes' contains methods reports that the subshape contains the point, then the entire compound is reported to contain the point.

Note that this implementation is not entirely perfect. For example, if a portion of the rectangle is enclosed in one subshape, and the remaining portion is covered by another subshape, this implementation may still report that the entire rectangle is not contained in the composite, if there is no single subshape that completely encloses it.

Specified by:

contains in interface Shape

Parameters:

iR - the rectangle

Returns:

true iff rectangle is contained

getPathIterator

public PathIterator getPathIterator(AffineTransform iTrans)

Iterates path of entire shape.

Details: getPathIterator returns a single path iterator for this entire compound shape, in compliance with the Shape.getPathIterator(AffineTransform) specification.

Specified by:

getPathIterator in interface Shape

Parameters:

iTrans - transformation for path

Returns:

the iterator

getPathIterator

public PathIterator getPathIterator(AffineTransform iTrans,
                           double iFlatness)

Iterates path of entire shape.

Details: getPathIterator returns a single path iterator for this entire compound shape, in compliance with the Shape.getPathIterator(AffineTransform, double) specification.

Specified by:

getPathIterator in interface Shape

Parameters:

iTrans - transformation for path

iFlatness - the flatness value

Returns:

the iterator