org.piccolo2d.nodes

Class PShape

java.lang.Object

org.piccolo2d.PNode

org.piccolo2d.nodes.PShape

All Implemented Interfaces:

Printable, Serializable, Cloneable

Direct Known Subclasses:

PArea, PPath

public abstract class PShape
extends PNode

Abstract shape node.

See Also:

Serialized Form

Nested Class Summary

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

PNode.PSceneGraphDelegate

Field Summary

Fields

Modifier and Type	Field and Description
static Paint	DEFAULT_PAINT Default paint for this shape node, Color.WHITE.
static Stroke	DEFAULT_STROKE Default stroke, a basic stroke of width 1.0f.
static Paint	DEFAULT_STROKE_PAINT Default stroke paint, Color.BLACK.

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

Modifier	Constructor and Description
protected	PShape() This is an abstract class that cannot be instantiated directly.

Method Summary

Methods

Modifier and Type	Method and Description
protected Rectangle2D	getBoundsWithStroke() Return the bounds of this node, taking the stroke into consideration if necessary.
protected abstract Shape	getShape() Return the shape for this shape node.
Stroke	getStroke() Return the stroke for this shape node.
Paint	getStrokePaint() Return the stroke paint for this shape node.
protected void	internalUpdateBounds(double x, double y, double width, double height) Gives nodes a chance to update their internal structure before bounds changed notifications are sent.
boolean	intersects(Rectangle2D bounds) Return true if this node intersects the given rectangle specified in local bounds.
protected void	paint(PPaintContext paintContext) Paint this node behind any of its children nodes.
void	setStroke(Stroke stroke) Set the stroke for this shape node to stroke.
void	setStrokePaint(Paint strokePaint) Set the stroke paint for this shape node to strokePaint.
protected abstract void	transform(AffineTransform transform) Apply the specified transform to the shape for this shape node.
protected void	updateBoundsFromShape() Update the bounds of this shape node from its shape.

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

Field Detail

DEFAULT_PAINT

public static final Paint DEFAULT_PAINT

Default paint for this shape node, Color.WHITE.

DEFAULT_STROKE

public static final Stroke DEFAULT_STROKE

Default stroke, a basic stroke of width 1.0f.

DEFAULT_STROKE_PAINT

public static final Paint DEFAULT_STROKE_PAINT

Default stroke paint, Color.BLACK.

Constructor Detail

PShape

protected PShape()

This is an abstract class that cannot be instantiated directly.

Method Detail

getShape

protected abstract Shape getShape()

Return the shape for this shape node.

Returns:

the shape for this shape node

transform

protected abstract void transform(AffineTransform transform)

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

Parameters:

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

getStroke

public final Stroke getStroke()

Return the stroke for this shape node. Defaults to DEFAULT_STROKE.

Returns:

the stroke for this shape node

setStroke

public final void setStroke(Stroke stroke)

Set the stroke for this shape node to stroke. This is a bound property.

Parameters:

stroke - stroke for this shape node

getStrokePaint

public final Paint getStrokePaint()

Return the stroke paint for this shape node. Defaults to DEFAULT_STROKE_PAINT.

Returns:

the stroke paint for this shape node

setStrokePaint

public final void setStrokePaint(Paint strokePaint)

Set the stroke paint for this shape node to strokePaint. This is a bound property.

Parameters:

strokePaint - stroke paint for this shape node

updateBoundsFromShape

protected final void updateBoundsFromShape()

Update the bounds of this shape node from its shape.

getBoundsWithStroke

protected final Rectangle2D getBoundsWithStroke()

Return the bounds of this node, taking the stroke into consideration if necessary.

Returns:

the bounds of this node, taking the stroke into consideration if necessary

internalUpdateBounds

protected final void internalUpdateBounds(double x,
                        double y,
                        double width,
                        double height)

Gives nodes a chance to update their internal structure before bounds changed notifications are sent. When this message is recived the nodes bounds field will contain the new value. See PPath for an example that uses this method.

Overrides:

internalUpdateBounds in class PNode

Parameters:

x - x position of bounds

y - y position of bounds

width - width to apply to the bounds

height - height to apply to the bounds

intersects

public final boolean intersects(Rectangle2D bounds)

Return true if this node intersects the given rectangle specified in local bounds. If the geometry of this node is complex this method can become expensive, it is therefore recommended that fullIntersects is used for quick rejects before calling this method.

Overrides:

intersects in class PNode

Parameters:

bounds - the bounds to test for intersection against

Returns:

true if the given rectangle intersects this nodes geometry.

paint

protected void paint(PPaintContext paintContext)

Paint this node behind any of its children nodes. Subclasses that define a different appearance should override this method and paint themselves there.

Overrides:

paint in class PNode

Parameters:

paintContext - the paint context to use for painting the node