org.piccolo2d.nodes

Class PArea

java.lang.Object

org.piccolo2d.PNode

org.piccolo2d.nodes.PShape

org.piccolo2d.nodes.PArea

All Implemented Interfaces:

Printable, Serializable, Cloneable

public final class PArea
extends PShape

Area node.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.piccolo2d.PNode

PNode.PSceneGraphDelegate

Field Summary

Fields inherited from class org.piccolo2d.nodes.PShape

DEFAULT_PAINT, DEFAULT_STROKE, DEFAULT_STROKE_PAINT

Fields inherited from class org.piccolo2d.PNode

FILL_STRATEGY_ASPECT_COVER, FILL_STRATEGY_ASPECT_FIT, FILL_STRATEGY_EXACT_FIT, PROPERTY_BOUNDS, PROPERTY_CHILDREN, PROPERTY_CHILDREN_PICKABLE, PROPERTY_CLIENT_PROPERTIES, PROPERTY_CODE_BOUNDS, PROPERTY_CODE_CHILDREN, PROPERTY_CODE_CHILDREN_PICKABLE, PROPERTY_CODE_CLIENT_PROPERTIES, PROPERTY_CODE_FULL_BOUNDS, PROPERTY_CODE_PAINT, PROPERTY_CODE_PARENT, PROPERTY_CODE_PICKABLE, PROPERTY_CODE_TRANSFORM, PROPERTY_CODE_TRANSPARENCY, PROPERTY_CODE_VISIBLE, PROPERTY_FULL_BOUNDS, PROPERTY_PAINT, PROPERTY_PARENT, PROPERTY_PICKABLE, PROPERTY_TRANSFORM, PROPERTY_TRANSPARENCY, PROPERTY_VISIBLE, SCENE_GRAPH_DELEGATE

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor and Description
PArea() Create a new area node with an empty area.
PArea(Area area) Create a new area node with the specified area.
PArea(Area area, Stroke stroke) Create a new area node with the specified area and stroke.
PArea(Shape shape) Create a new area node with the specified shape.
PArea(Shape shape, Stroke stroke) Create a new area node with the specified shape and stroke.
PArea(Stroke stroke) Create a new area node with an empty area and the specified stroke.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Area area) Add the shape of the specified area to the shape of this area node.
void	exclusiveOr(Area area) Set the shape of this area node to be the combined area of its current shape and the shape of the specified area, minus their intersection.
Area	getArea() Return a copy of the area backing this area node.
Area	getAreaReference() Return the area backing this node.
protected Shape	getShape() Return the shape for this shape node.
void	intersect(Area area) Set the shape of this area node to the intersection of its current shape and the shape of the specified area.
boolean	isEmpty() Return true if this area node represents an empty area.
boolean	isPolygonal() Return true if this area node consists entirely of straight-edged polygonal geometry.
boolean	isRectangular() Return true if this area node is rectangular in shape.
boolean	isSingular() Return true if this area node is comprised of a single closed subpath.
void	reset() Removes all of the geometry from this area node and restores it to an empty area.
void	subtract(Area area) Subtract the shape of the specified area from the shape of this area node.
protected void	transform(AffineTransform transform) Apply the specified transform to the shape for this shape node.

Methods inherited from class org.piccolo2d.nodes.PShape

getBoundsWithStroke, getStroke, getStrokePaint, internalUpdateBounds, intersects, paint, setStroke, setStrokePaint, updateBoundsFromShape

Methods inherited from class org.piccolo2d.PNode

addActivity, addAttribute, addChild, addChild, addChildren, addInputEventListener, addPropertyChangeListener, addPropertyChangeListener, animateToBounds, animateToColor, animateToPositionScaleRotation, animateToRelativePosition, animateToTransform, animateToTransparency, animateTransformToBounds, centerBoundsOnPoint, centerFullBoundsOnPoint, clone, computeFullBounds, endResizeBounds, findIntersectingNodes, fireChildPropertyChange, firePropertyChange, fullIntersects, fullPaint, fullPick, getAllNodes, getAllNodes, getAttribute, getAttribute, getBooleanAttribute, getBounds, getBoundsChanged, getBoundsReference, getBoundsVolatile, getChild, getChildBoundsInvalid, getChildBoundsVolatile, getChildPaintInvalid, getChildrenCount, getChildrenIterator, getChildrenPickable, getChildrenReference, getClientProperties, getClientPropertyKeysEnumeration, getDoubleAttribute, getFullBounds, getFullBoundsInvalid, getFullBoundsReference, getGlobalBounds, getGlobalFullBounds, getGlobalRotation, getGlobalScale, getGlobalToLocalTransform, getGlobalTranslation, getHeight, getInputEventListeners, getIntegerAttribute, getInverseTransform, getListenerList, getLocalToGlobalTransform, getName, getOccluded, getOffset, getPaint, getPaintInvalid, getParent, getPickable, getPropertyChangeParentMask, getRoot, getRotation, getScale, getTransform, getTransformReference, getTransparency, getUnionOfChildrenBounds, getVisible, getWidth, getX, getXOffset, getY, getYOffset, globalToLocal, globalToLocal, globalToLocal, indexOfChild, invalidateFullBounds, invalidateLayout, invalidatePaint, isAncestorOf, isDescendentOf, isDescendentOfRoot, isOpaque, layoutChildren, lerp, localToGlobal, localToGlobal, localToGlobal, localToParent, localToParent, localToParent, lower, lower, lowerBelow, lowerToBottom, lowerToBottom, offset, paintAfterChildren, parentBoundsChanged, parentToLocal, parentToLocal, parentToLocal, pick, pickAfterChildren, print, print, raise, raise, raiseAbove, raiseToTop, raiseToTop, removeAllChildren, removeChild, removeChild, removeChildren, removeFromParent, removeInputEventListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaintFrom, reparent, replaceWith, resetBounds, rotate, rotateAboutPoint, rotateAboutPoint, rotateInPlace, scale, scaleAboutPoint, scaleAboutPoint, setBounds, setBounds, setBoundsChanged, setChildBoundsInvalid, setChildBoundsVolatile, setChildPaintInvalid, setChildrenPickable, setFullBoundsInvalid, setGlobalRotation, setGlobalScale, setGlobalTranslation, setHeight, setName, setOccluded, setOffset, setOffset, setPaint, setPaintInvalid, setParent, setPickable, setPropertyChangeParentMask, setRotation, setScale, setTransform, setTransparency, setVisible, setWidth, setX, setY, signalBoundsChanged, startResizeBounds, toImage, toImage, toImage, toImage, transformBy, translate, validateFullBounds, validateFullPaint

Methods inherited from class java.lang.Object

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

Constructor Detail

PArea

public PArea()

Create a new area node with an empty area.

PArea

public PArea(Stroke stroke)

Create a new area node with an empty area and the specified stroke.

Parameters:

stroke - stroke

PArea

public PArea(Shape shape)

Create a new area node with the specified shape.

Parameters:

shape - shape, must not be null

PArea

public PArea(Shape shape,
     Stroke stroke)

Create a new area node with the specified shape and stroke.

Parameters:

shape - shape, must not be null

stroke - stroke

PArea

public PArea(Area area)

Create a new area node with the specified area.

Parameters:

area - area, must not be null

PArea

public PArea(Area area,
     Stroke stroke)

Create a new area node with the specified area and stroke.

Parameters:

area - area, must not be null

stroke - stroke

Method Detail

getArea

public Area getArea()

Return a copy of the area backing this area node.

Returns:

a copy of the area backing this area node

getAreaReference

public Area getAreaReference()

Return the area backing this node. The returned area must not be modified or the bounds of this node may no longer be valid and any area property change listeners will not be notified.

Returns:

the area backing this area node

add

public void add(Area area)

Add the shape of the specified area to the shape of this area node. The resulting shape of this area node will include the union of both shapes, or all areas that were contained in either this or the specified area.

Parameters:

area - area to add, must not be null

Throws:

NullPointerException - if area is null

exclusiveOr

public void exclusiveOr(Area area)

Set the shape of this area node to be the combined area of its current shape and the shape of the specified area, minus their intersection. The resulting shape of this area node will include only areas that were contained in either this area node or in the specified area, but not in both.

Parameters:

area - area to exclusive or, must not be null

Throws:

NullPointerException - if area is null

intersect

public void intersect(Area area)

Set the shape of this area node to the intersection of its current shape and the shape of the specified area. The resulting shape of this area node will include only areas that were contained in both this area node and also in the specified area.

Parameters:

area - area to intersect, must not be null

Throws:

NullPointerException - if area is null

subtract

public void subtract(Area area)

Subtract the shape of the specified area from the shape of this area node. The resulting shape of this area node will include areas that were contained only in this area node and not in the specified area.

Parameters:

area - area to subtract, must not be null

Throws:

NullPointerException - if area is null

reset

public void reset()

Removes all of the geometry from this area node and restores it to an empty area.

isEmpty

public boolean isEmpty()

Return true if this area node represents an empty area.

Returns:

true if this area node represents an empty area

isPolygonal

public boolean isPolygonal()

Return true if this area node consists entirely of straight-edged polygonal geometry.

Returns:

true if this area node consists entirely of straight-edged polygonal geometry

isRectangular

public boolean isRectangular()

Return true if this area node is rectangular in shape.

Returns:

true if this area node is rectangular in shape

isSingular

public boolean isSingular()

Return true if this area node is comprised of a single closed subpath. This method returns true if the path contains 0 or 1 subpaths, or false if the path contains more than 1 subpath. The subpaths are counted by the number of SEG_MOVETO segments that appear in the path.

Returns:

true if this area node is comprised of a single closed subpath

getShape

protected Shape getShape()

Return the shape for this shape node.

Specified by:

getShape in class PShape

Returns:

the shape for this shape node

transform

protected void transform(AffineTransform transform)

Apply the specified transform to the shape for this shape node.

Specified by:

transform in class PShape

Parameters:

transform - transform to apply to the shape for this shape node