org.piccolo2d.nodes

Class PPath

java.lang.Object

org.piccolo2d.PNode

org.piccolo2d.nodes.PShape

org.piccolo2d.nodes.PPath

All Implemented Interfaces:

Printable, Serializable, Cloneable

Direct Known Subclasses:

PPath.Double, PPath.Float

public abstract class PPath
extends PShape

Abstract path node.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PPath.Double Path node with coordinates stored in double precision floating point.
static class	PPath.Float Path node with coordinates stored in single precision floating point.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	append(PathIterator pathIterator, boolean connect) Append the geometry of the specified path iterator to this path node, possibly connecting the new geometry to the existing path segments with a line segment.
void	append(Shape shape, boolean connect) Append the geometry of the specified shape to this path node, possibly connecting the new geometry to the existing path segments with a line segment.
void	closePath() Close the current subpath by drawing a straight line back to the coordinates of the last moveTo.
static PPath	createArc(double x, double y, double width, double height, double start, double extent, int type) Create and return a new path node with the specified arc in double precision floating point coordinates.
static PPath	createArc(float x, float y, float width, float height, float start, float extent, int type) Create and return a new path node with the specified arc in single precision floating point coordinates.
static PPath	createCubicCurve(double x1, double y1, double ctrlx1, double ctrly1, double ctrlx2, double ctrly2, double x2, double y2) Create and return a new path node with the specified cubic curve in double precision floating point coordinates.
static PPath	createCubicCurve(float x1, float y1, float ctrlx1, float ctrly1, float ctrlx2, float ctrly2, float x2, float y2) Create and return a new path node with the specified cubic curve in single precision floating point coordinates.
static PPath	createEllipse(double x, double y, double width, double height) Create and return a new path node with the specified ellipse in double precision floating point coordinates.
static PPath	createEllipse(float x, float y, float width, float height) Create and return a new path node with the specified ellipse in single precision floating point coordinates.
static PPath	createLine(double x1, double y1, double x2, double y2) Create and return a new path node with the specified line in double precision floating point coordinates.
static PPath	createLine(float x1, float y1, float x2, float y2) Create and return a new path node with the specified line in single precision floating point coordinates.
static PPath	createQuadCurve(double x1, double y1, double ctrlx, double ctrly, double x2, double y2) Create and return a new path node with the specified quadratic curve in double precision floating point coordinates.
static PPath	createQuadCurve(float x1, float y1, float ctrlx, float ctrly, float x2, float y2) Create and return a new path node with the specified quadratic curve in single precision floating point coordinates.
static PPath	createRectangle(double x, double y, double width, double height) Create and return a new path node with the specified rectangle in double precision floating point coordinates.
static PPath	createRectangle(float x, float y, float width, float height) Create and return a new path node with the specified rectangle in single precision floating point coordinates.
static PPath	createRoundRectangle(double x, double y, double width, double height, double arcWidth, double arcHeight) Create and return a new path node with the specified round rectangle in double precision floating point coordinates.
static PPath	createRoundRectangle(float x, float y, float width, float height, float arcWidth, float arcHeight) Create and return a new path node with the specified round rectangle in single precision floating point coordinates.
void	curveTo(double x1, double y1, double x2, double y2, double x3, double y3) Add a curved segment, defined by three new points, to this path node by drawing a Bézier curve that intersects both the current coordinates and the specified coordinates (x3,y3), using the specified points (x1,y1) and (x2,y2) as Bézier control points.
Path2D	getPath() Return a copy of the path backing this path node.
Path2D	getPathReference() Return the path backing this node.
protected Shape	getShape() Return the shape for this shape node.
void	lineTo(double x, double y) Add a point to this path node by drawing a straight line from the current coordinates to the new specified coordinates specified in double precision.
void	moveTo(double x, double y) Add a point to this path node by moving to the specified coordinates specified in double precision.
void	quadTo(double x1, double y1, double x2, double y2) Add a curved segment, defined by two new points, to this path node by drawing a Quadratic curve that intersects both the current coordinates and the specified coordinates (x2,y2), using the specified point (x1,y1) as a quadratic parametric control point.
void	reset() Reset the geometry for this path node to empty.
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

Method Detail

createArc

public static final PPath createArc(float x,
              float y,
              float width,
              float height,
              float start,
              float extent,
              int type)

Create and return a new path node with the specified arc in single precision floating point coordinates.

Parameters:

x - x coordinate of the upper-left corner of the arc's framing rectangle

y - y coordinate of the upper-left corner of the arc's framing rectangle

width - width of the full ellipse of which this arc is a partial section

height - height of the full ellipse of which this arc is a partial section

start - starting angle of the arc in degrees

extent - angular extent of the arc in degrees

type - closure type for the arc, one of Arc2D.OPEN, Arc2D.CHORD, or Arc2D.PIE

Returns:

a new path node with the specified arc in single precision floating point coordinates

createCubicCurve

public static final PPath createCubicCurve(float x1,
                     float y1,
                     float ctrlx1,
                     float ctrly1,
                     float ctrlx2,
                     float ctrly2,
                     float x2,
                     float y2)

Create and return a new path node with the specified cubic curve in single precision floating point coordinates.

Parameters:

x1 - x coordinate of the start point

y1 - y coordinate of the start point

ctrlx1 - x coordinate of the first control point

ctrly1 - y coordinate of the first control point

ctrlx2 - x coordinate of the second control point

ctrly2 - y coordinate of the second control point

x2 - x coordinate of the end point

y2 - y coordinate of the end point

Returns:

a new path node with the specified cubic curve in single precision floating point coordinates

createEllipse

public static final PPath createEllipse(float x,
                  float y,
                  float width,
                  float height)

Create and return a new path node with the specified ellipse in single precision floating point coordinates.

Parameters:

x - x coordinate

y - y coordinate

width - width

height - height

Returns:

a new path node with the specified ellipse in single precision floating point coordinates

createLine

public static final PPath createLine(float x1,
               float y1,
               float x2,
               float y2)

Create and return a new path node with the specified line in single precision floating point coordinates.

Parameters:

x1 - x coordinate of the start point

y1 - y coordinate of the start point

x2 - x coordinate of the end point

y2 - y coordinate of the end point

Returns:

a new path node with the specified line in single precision floating point coordinates

createQuadCurve

public static final PPath createQuadCurve(float x1,
                    float y1,
                    float ctrlx,
                    float ctrly,
                    float x2,
                    float y2)

Create and return a new path node with the specified quadratic curve in single precision floating point coordinates.

Parameters:

x1 - x coordinate of the start point

y1 - y coordinate of the start point

ctrlx - x coordinate of the control point

ctrly - y coordinate of the control point

x2 - x coordinate of the end point

y2 - y coordinate of the end point

Returns:

a new path node with the specified quadratic curve in single precision floating point coordinates

createRectangle

public static final PPath createRectangle(float x,
                    float y,
                    float width,
                    float height)

Create and return a new path node with the specified rectangle in single precision floating point coordinates.

Parameters:

x - x coordinate

y - y coordinate

width - width

height - height

Returns:

a new path node with the specified rectangle in single precision floating point coordinates

createRoundRectangle

public static final PPath createRoundRectangle(float x,
                         float y,
                         float width,
                         float height,
                         float arcWidth,
                         float arcHeight)

Create and return a new path node with the specified round rectangle in single precision floating point coordinates.

Parameters:

x - x coordinate

y - y coordinate

width - width

height - height

arcWidth - width of the arc that rounds off the corners

arcHeight - height of the arc that rounds off the corners

Returns:

a new path node with the specified round rectangle in single precision floating point coordinates

createArc

public static final PPath createArc(double x,
              double y,
              double width,
              double height,
              double start,
              double extent,
              int type)

Create and return a new path node with the specified arc in double precision floating point coordinates.

Parameters:

x - x coordinate of the upper-left corner of the arc's framing rectangle

y - y coordinate of the upper-left corner of the arc's framing rectangle

width - width of the full ellipse of which this arc is a partial section

height - height of the full ellipse of which this arc is a partial section

start - starting angle of the arc in degrees

extent - angular extent of the arc in degrees

type - closure type for the arc, one of Arc2D.OPEN, Arc2D.CHORD, or Arc2D.PIE

Returns:

a new path node with the specified arc in double precision floating point coordinates

createCubicCurve

public static final PPath createCubicCurve(double x1,
                     double y1,
                     double ctrlx1,
                     double ctrly1,
                     double ctrlx2,
                     double ctrly2,
                     double x2,
                     double y2)

Create and return a new path node with the specified cubic curve in double precision floating point coordinates.

Parameters:

x1 - x coordinate of the start point

y1 - y coordinate of the start point

ctrlx1 - x coordinate of the first control point

ctrly1 - y coordinate of the first control point

ctrlx2 - x coordinate of the second control point

ctrly2 - y coordinate of the second control point

x2 - x coordinate of the end point

y2 - y coordinate of the end point

Returns:

a new path node with the specified cubic curve in double precision floating point coordinates

createEllipse

public static final PPath createEllipse(double x,
                  double y,
                  double width,
                  double height)

Create and return a new path node with the specified ellipse in double precision floating point coordinates.

Parameters:

x - x coordinate

y - y coordinate

width - width

height - height

Returns:

a new path node with the specified ellipse in double precision floating point coordinates

createLine

public static final PPath createLine(double x1,
               double y1,
               double x2,
               double y2)

Create and return a new path node with the specified line in double precision floating point coordinates.

Parameters:

x1 - x coordinate of the start point

y1 - y coordinate of the start point

x2 - x coordinate of the end point

y2 - y coordinate of the end point

Returns:

a new path node with the specified line in double precision floating point coordinates

createQuadCurve

public static final PPath createQuadCurve(double x1,
                    double y1,
                    double ctrlx,
                    double ctrly,
                    double x2,
                    double y2)

Create and return a new path node with the specified quadratic curve in double precision floating point coordinates.

Parameters:

x1 - x coordinate of the start point

y1 - y coordinate of the start point

ctrlx - x coordinate of the control point

ctrly - y coordinate of the control point

x2 - x coordinate of the end point

y2 - y coordinate of the end point

Returns:

a new path node with the specified quadratic curve in double precision floating point coordinates

createRectangle

public static final PPath createRectangle(double x,
                    double y,
                    double width,
                    double height)

Create and return a new path node with the specified rectangle in double precision floating point coordinates.

Parameters:

x - x coordinate

y - y coordinate

width - width

height - height

Returns:

a new path node with the specified rectangle in double precision floating point coordinates

createRoundRectangle

public static final PPath createRoundRectangle(double x,
                         double y,
                         double width,
                         double height,
                         double arcWidth,
                         double arcHeight)

Create and return a new path node with the specified round rectangle in double precision floating point coordinates.

Parameters:

x - x coordinate

y - y coordinate

width - width

height - height

arcWidth - width of the arc that rounds off the corners

arcHeight - height of the arc that rounds off the corners

Returns:

a new path node with the specified round rectangle in double precision floating point coordinates

getPath

public final Path2D getPath()

Return a copy of the path backing this path node.

Returns:

a copy of the path backing this path node

getPathReference

public final Path2D getPathReference()

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

Returns:

the path backing this path node

append

public final void append(Shape shape,
          boolean connect)

Append the geometry of the specified shape to this path node, possibly connecting the new geometry to the existing path segments with a line segment. If the connect parameter is true and the path is not empty then any initial moveTo in the geometry of the appended shape is turned into a lineTo segment. If the destination coordinates of such a connecting lineTo segment match the ending coordinates of a currently open subpath then the segment is omitted as superfluous. The winding rule of the specified shape is ignored and the appended geometry is governed by the winding rule specified for this path node.

Parameters:

shape - shape to append to this path node

connect - true to turn an initial moveTo segment into a lineTo segment to connect the new geometry to the existing path

append

public final void append(PathIterator pathIterator,
          boolean connect)

Append the geometry of the specified path iterator to this path node, possibly connecting the new geometry to the existing path segments with a line segment. If the connect parameter is true and the path is not empty then any initial moveTo in the geometry of the appended path iterator is turned into a lineTo segment. If the destination coordinates of such a connecting lineTo segment match the ending coordinates of a currently open subpath then the segment is omitted as superfluous.

Parameters:

pathIterator - path iterator to append to this path node

connect - true to turn an initial moveTo segment into a lineTo segment to connect the new geometry to the existing path

curveTo

public final void curveTo(double x1,
           double y1,
           double x2,
           double y2,
           double x3,
           double y3)

Add a curved segment, defined by three new points, to this path node by drawing a Bézier curve that intersects both the current coordinates and the specified coordinates (x3,y3), using the specified points (x1,y1) and (x2,y2) as Bézier control points. All coordinates are specified in double precision.

Parameters:

x1 - x coordinate of the first Bézier control point

y1 - y coordinate of the first Bézier control point

x2 - x coordinate of the second Bézier control point

y2 - y coordinate of the second Bézier control point

x3 - x coordinate of the final end point

y3 - y coordinate of the final end point

lineTo

public final void lineTo(double x,
          double y)

Add a point to this path node by drawing a straight line from the current coordinates to the new specified coordinates specified in double precision.

Parameters:

x - x coordinate

y - y coordinate

moveTo

public final void moveTo(double x,
          double y)

Add a point to this path node by moving to the specified coordinates specified in double precision.

Parameters:

x - x coordinate

y - y coordinate

quadTo

public final void quadTo(double x1,
          double y1,
          double x2,
          double y2)

Add a curved segment, defined by two new points, to this path node by drawing a Quadratic curve that intersects both the current coordinates and the specified coordinates (x2,y2), using the specified point (x1,y1) as a quadratic parametric control point. All coordinates are specified in double precision.

Parameters:

x1 - x coordinate of the quadratic control point

y1 - y coordinate of the quadratic control point

x2 - x coordinate of the final end point

y2 - y coordinate of the final end point

reset

public final void reset()

Reset the geometry for this path node to empty.

closePath

public final void closePath()

Close the current subpath by drawing a straight line back to the coordinates of the last moveTo. If the path is already closed then this method has no effect.

getShape

protected final Shape getShape()

Return the shape for this shape node.

Specified by:

getShape in class PShape

Returns:

the shape for this shape node

transform

protected final 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