edu.umd.cs.piccolox.swt
Class PSWTPath

java.lang.Object
  edu.umd.cs.piccolo.PNode
      edu.umd.cs.piccolox.swt.PSWTPath

All Implemented Interfaces:

java.lang.Cloneable, java.awt.print.Printable, java.io.Serializable

public class PSWTPath

extends PNode

PPath is a wrapper around a java.awt.geom.GeneralPath. The setBounds method works by scaling the path to fit into the specified bounds. This normally works well, but if the specified base bounds get too small then it is impossible to expand the path shape again since all its numbers have tended to zero, so application code may need to take this into consideration.

One option that applications have is to call startResizeBounds before starting an interaction that may make the bounds very small, and calling endResizeBounds when this interaction is finished. When this is done PPath will use a copy of the original path to do the resizing so the numbers in the path wont loose resolution.

This class also provides methods for constructing common shapes using a general path.

Version:

1.0

Author:

Jesse Grosjean

See Also:

Serialized Form

Field Summary

static java.lang.String	PROPERTY_SHAPE The property name that identifies a change of this node's path.
static java.lang.String	PROPERTY_STROKE_PAINT The property name that identifies a change of this node's stroke paint (see getStrokePaint).

Fields inherited from class edu.umd.cs.piccolo.PNode

PROPERTY_BOUNDS, PROPERTY_CHILDREN, PROPERTY_CHILDREN_PICKABLE, PROPERTY_CLIENT_PROPERTIES, PROPERTY_FULL_BOUNDS, PROPERTY_PAINT, PROPERTY_PARENT, PROPERTY_PICKABLE, PROPERTY_TRANSFORM, PROPERTY_TRANSPARENCY, PROPERTY_VISIBLE

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

PSWTPath()

PSWTPath(java.awt.Shape aShape)

Method Summary

static PSWTPath	createEllipse(float x, float y, float width, float height)
static PSWTPath	createPolyline(float[] xp, float[] yp)
static PSWTPath	createPolyline(java.awt.geom.Point2D[] points)
static PSWTPath	createRectangle(float x, float y, float width, float height)
java.awt.Paint	getStrokePaint()
boolean	intersects(java.awt.geom.Rectangle2D aBounds) 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.
protected java.lang.String	paramString() Returns a string representing the state of this node.
boolean	setBounds(double x, double y, double width, double height) Set the bounds of this node to the given value.
void	setPathToEllipse(float x, float y, float width, float height)
void	setPathToPolyline(float[] xp, float[] yp)
void	setPathToPolyline(java.awt.geom.Point2D[] points)
void	setPathToRectangle(float x, float y, float width, float height)
void	setShape(java.awt.Shape aShape)
void	setStrokeColor(java.awt.Paint aPaint)
void	updateBoundsFromPath()

Methods inherited from class edu.umd.cs.piccolo.PNode

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

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_STROKE_PAINT

public static final java.lang.String PROPERTY_STROKE_PAINT

The property name that identifies a change of this node's stroke paint (see getStrokePaint). Both old and new value will be set correctly to Paint objects in any property change event.

See Also:

Constant Field Values

PROPERTY_SHAPE

public static final java.lang.String PROPERTY_SHAPE

The property name that identifies a change of this node's path. In any property change event the new value will be a reference to this node's path, but old value will always be null.

See Also:

Constant Field Values

Constructor Detail

PSWTPath

public PSWTPath()

PSWTPath

public PSWTPath(java.awt.Shape aShape)

Method Detail

createRectangle

public static PSWTPath createRectangle(float x,
                                       float y,
                                       float width,
                                       float height)

createEllipse

public static PSWTPath createEllipse(float x,
                                     float y,
                                     float width,
                                     float height)

createPolyline

public static PSWTPath createPolyline(java.awt.geom.Point2D[] points)

createPolyline

public static PSWTPath createPolyline(float[] xp,
                                      float[] yp)

getStrokePaint

public java.awt.Paint getStrokePaint()

setStrokeColor

public void setStrokeColor(java.awt.Paint aPaint)

setBounds

public boolean setBounds(double x,
                         double y,
                         double width,
                         double height)

Description copied from class: PNode

Set the bounds of this node to the given value. These bounds are stored in the local coordinate system of this node. If the width or height is less then or equal to zero then the bound's emtpy bit will be set to true. Subclasses must call the super.setBounds() method.

Overrides:

setBounds in class PNode

Returns:

true if the bounds changed.

intersects

public boolean intersects(java.awt.geom.Rectangle2D aBounds)

Description copied from class: PNode

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:

aBounds - the bounds to test for intersection against

Returns:

true if the given rectangle intersects this nodes geometry.

updateBoundsFromPath

public void updateBoundsFromPath()

paint

protected void paint(PPaintContext paintContext)

Description copied from class: PNode

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

setShape

public void setShape(java.awt.Shape aShape)

setPathToRectangle

public void setPathToRectangle(float x,
                               float y,
                               float width,
                               float height)

setPathToEllipse

public void setPathToEllipse(float x,
                             float y,
                             float width,
                             float height)

setPathToPolyline

public void setPathToPolyline(java.awt.geom.Point2D[] points)

setPathToPolyline

public void setPathToPolyline(float[] xp,
                              float[] yp)

paramString

protected java.lang.String paramString()

Returns a string representing the state of this node. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

paramString in class PNode

Returns:

a string representation of this node's state