fr.lri.swingstates.canvas

Class CPolyLine

java.lang.Object

fr.lri.swingstates.canvas.CShape

fr.lri.swingstates.canvas.CPolyLine

All Implemented Interfaces:

CElement, GraphicalShape, java.lang.Cloneable

public class CPolyLine
extends CShape

An arbitrary shape for use with a Canvas. If filled, the fill paint is used to paint the interior. If outlined, the outline paint and stroke are used to draw the boundary. The shape is build using path operators such as lineTo.

Author:

Caroline Appert

Constructor Summary

Constructors

Constructor and Description
CPolyLine() Builds an empty CPolyLine.
CPolyLine(double x, double y) Builds a CPolyLine with an initial point (x, y).
CPolyLine(java.awt.geom.Point2D pt) Builds a CPolyLine with an initial point pt.

Method Summary

Methods

Modifier and Type	Method and Description
CPolyLine	arcTo(double start, double extent, double rx, double ry) Adds an arc segment to this polyline.
CPolyLine	close() Closes this polyLine by drawing a straight line from the current point to the starting point.
CShape	copyTo(CShape sms) Copies this shape into a destination shape.
CPolyLine	curveTo(double ctrlx1, double ctrly1, double ctrlx2, double ctrly2, double xEnd, double yEnd) Adds a cubic curve segment to this polyline.
CPolyLine	curveTo(java.awt.geom.Point2D ptCtrl1, java.awt.geom.Point2D ptCtrl2, java.awt.geom.Point2D ptEnd) Adds a cubic curve segment to this polyline.
CShape	duplicate() Creates a new copy of this shape and returns it.
CShape	fixReferenceShapeToCurrent() This method can be useful before changing the parent of a shape while keeping its transformation that can be inherited from its current parent.
CPolyLine	getArrow(double extent, double sizeArrow) Builds an arrow to end the current segment of this polyline.
java.awt.geom.Point2D	getCurrentPoint()
double	getStartX()
double	getStartY()
CPolyLine	lineTo(double x, double y) Adds a line segment to this polyline from the current point to point (x, y).
CPolyLine	lineTo(java.awt.geom.Point2D pt) Adds a line segment to this polyline from the current point to point pt.
CPolyLine	moveTo(double x, double y) Sets the current point of this polyLine to point (x, y).
CPolyLine	moveTo(java.awt.geom.Point2D pt) Sets the current point of this polyLine to point pt.
CPolyLine	quadTo(double ctrlx1, double ctrly1, double xEnd, double yEnd) Adds a quadric curve segment to this polyline.
CPolyLine	quadTo(java.awt.geom.Point2D ptCtrl, java.awt.geom.Point2D ptEnd) Adds a quadric curve segment to this polyline.
CPolyLine	removeLastSegment() Removes the last segment of this polyline, if any.
CPolyLine	reset(double x, double y) Resets this polyline to the unique point (x, y).
CPolyLine	reset(java.awt.geom.Point2D pt) Resets this polyline to the unique point pt.

Methods inherited from class fr.lri.swingstates.canvas.CShape

above, aboveAll, addChild, addGhost, addTag, addTag, addTag, addTo, animate, asEllipse, asImage, asPolyLine, asRectangle, asRectangularShape, asText, attachSM, below, belowAll, canvasToShape, canvasToShapeRef, clone, contains, contains, contains, contains, detachSM, duplicateWithTags, firstShape, getAbsShape, getAbsTransform, getAntialiasedShapes, getBoundingBox, getCanvas, getCenterX, getCenterY, getChild, getChildren, getChildrenCount, getClip, getFilledShapes, getFillPaint, getFirstAntialiasedShape, getFirstFilledShape, getFirstHavingTag, getFirstOutlinedShape, getGhost, getHeight, getHierarchy, getIntersection, getMaxX, getMaxY, getMinX, getMinY, getOutlinedShapes, getOutlinePaint, getParent, getReferenceX, getReferenceY, getRenderingHint, getRotation, getScaleX, getScaleY, getShape, getStroke, getSubtraction, getTags, getTransform, getTranslateX, getTranslateY, getTransparencyFill, getTransparencyOutline, getWidth, hasTag, hasTag, indexOf, intersects, isAbove, isAntialiased, isBelow, isDrawable, isFilled, isOnOutline, isOutlined, isPickable, isPicked, paint, pick, pickStyle, remove, removeAllChildren, removeChild, removeChild, removeGhost, removeTag, removeTag, rotateBy, rotateTo, scaleBy, scaleBy, scaleTo, scaleTo, setAntialiased, setClip, setDrawable, setFilled, setFillPaint, setOutlined, setOutlinePaint, setParent, setPickable, setReferencePoint, setReferencePoint, setRenderingHint, setShape, setStroke, setTransformToIdentity, setTransparencyFill, setTransparencyFill, setTransparencyOutline, setTransparencyOutline, shapeToCanvas, translateBy, translateTo

Methods inherited from class java.lang.Object

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

Constructor Detail

CPolyLine

public CPolyLine()

Builds an empty CPolyLine.

CPolyLine

public CPolyLine(double x,
         double y)

Builds a CPolyLine with an initial point (x, y).

Parameters:

x - The x coordinate of the initial point

y - The y coordinate of the initial point

CPolyLine

public CPolyLine(java.awt.geom.Point2D pt)

Builds a CPolyLine with an initial point pt.

Parameters:

pt - The initial point

Method Detail

fixReferenceShapeToCurrent

public CShape fixReferenceShapeToCurrent()

This method can be useful before changing the parent of a shape while keeping its transformation that can be inherited from its current parent. This method:

• sets the underlying Java2D shape to its transformed shape,
• resets the transformation to identity, i.e.,:
• rotation to angle 0, translation to vector (0, 0),
• scale to vector (1,1),
• reference point to (0.5, 0.5).
• removes parent and all children.

Specified by:

fixReferenceShapeToCurrent in interface CElement

Overrides:

fixReferenceShapeToCurrent in class CShape

Returns:

this shape.

reset

public CPolyLine reset(double x,
              double y)

Resets this polyline to the unique point (x, y).

Parameters:

x - The x coordinate of the initial point

y - The y coordinate of the initial point

Returns:

this polyLine

reset

public CPolyLine reset(java.awt.geom.Point2D pt)

Resets this polyline to the unique point pt.

Parameters:

pt - The point

Returns:

this polyLine

lineTo

public CPolyLine lineTo(double x,
               double y)

Adds a line segment to this polyline from the current point to point (x, y).

Parameters:

x - The x coordinate of the last point

y - the y coordinate of the last point

Returns:

this polyLine

lineTo

public CPolyLine lineTo(java.awt.geom.Point2D pt)

Adds a line segment to this polyline from the current point to point pt.

Parameters:

pt - The point

Returns:

this polyLine

moveTo

public CPolyLine moveTo(double x,
               double y)

Sets the current point of this polyLine to point (x, y).

Parameters:

x - The x coordinate of the current point to set

y - the y coordinate of the current point to set

Returns:

this polyLine

moveTo

public CPolyLine moveTo(java.awt.geom.Point2D pt)

Sets the current point of this polyLine to point pt.

Parameters:

pt - The point

Returns:

this polyLine

getArrow

public CPolyLine getArrow(double extent,
                 double sizeArrow)

Builds an arrow to end the current segment of this polyline. The arrow has the same graphical and geometrical attributes than this polyline but it is a NEW CPolyLine. It is not linked to this polyline and it is not added to the canvas.

Parameters:

extent - The extent of the arrow (in radians)

sizeArrow - The length of the arrow.

Returns:

The built arrow, null if distance between last point and current point is equal to zero.

arcTo

public CPolyLine arcTo(double start,
              double extent,
              double rx,
              double ry)

Adds an arc segment to this polyline. The arc is part of an ellipse of x radius rx and y radius ry centered at the current point and going from angle start to angle start+extent. See further explanations here.

Parameters:

start - The starting angle of the ellipse

extent - The extent angle of the arc

rx - The x radius of the ellipse

ry - The y radius of the ellipse

Returns:

this polyLine

getCurrentPoint

public java.awt.geom.Point2D getCurrentPoint()

Returns:

the coordinates most recently added to the end of the path as a Point2D object.

quadTo

public CPolyLine quadTo(double ctrlx1,
               double ctrly1,
               double xEnd,
               double yEnd)

Adds a quadric curve segment to this polyline. The curved segment starts at the current point and ends (xEnd, yEnd), and uses point (ctrlx1, ctrly1) as Bezier control point.

Parameters:

ctrlx1 - The x coordinate of the first Bezier control point

ctrly1 - The y coordinate of the first Bezier control point

xEnd - The x coordinate of the end point

yEnd - The y coordinate of the end point

Returns:

this polyLine

quadTo

public CPolyLine quadTo(java.awt.geom.Point2D ptCtrl,
               java.awt.geom.Point2D ptEnd)

Adds a quadric curve segment to this polyline. The curved segment starts at the current point and ends at ptEnd, and uses point ptCtrl as Bezier control point.

Parameters:

ptCtrl - The first Bezier control point

ptEnd - The end point

Returns:

this polyLine

curveTo

public CPolyLine curveTo(double ctrlx1,
                double ctrly1,
                double ctrlx2,
                double ctrly2,
                double xEnd,
                double yEnd)

Adds a cubic curve segment to this polyline. The curved segment starts at the current point and ends (xEnd, yEnd), and uses points (ctrlx1, ctrly1) and (ctrlx2, ctrly2) as Bezier control points.

Parameters:

ctrlx1 - The x coordinate of the first Bezier control point

ctrly1 - The y coordinate of the first Bezier control point

ctrlx2 - The x coordinate of the second Bezier control point

ctrly2 - The y coordinate of the second Bezier control point

xEnd - The x coordinate of the ending point

yEnd - The y coordinate of the ending point

Returns:

this polyLine

curveTo

public CPolyLine curveTo(java.awt.geom.Point2D ptCtrl1,
                java.awt.geom.Point2D ptCtrl2,
                java.awt.geom.Point2D ptEnd)

Adds a cubic curve segment to this polyline. The curved segment starts at the current point and ends at ptEnd, and uses points ptCtrl1 and ptCtrl2 as Bezier control points.

Parameters:

ptCtrl1 - The first Bezier control point

ptCtrl2 - The second Bezier control point

ptEnd - The ending point

Returns:

this polyLine

close

public CPolyLine close()

Closes this polyLine by drawing a straight line from the current point to the starting point.

Returns:

this polyLine

removeLastSegment

public CPolyLine removeLastSegment()

Removes the last segment of this polyline, if any.

Returns:

this polyline

copyTo

public CShape copyTo(CShape sms)

Copies this shape into a destination shape. The copy differs from the original as follows: If this shape is in a canvas, the copy is added to that canvas, on top of all other objects; The copy has no children, i.e. it is not the parent of any shape, even if the original has a parent.

Overrides:

copyTo in class CShape

Parameters:

sms - The destination shape

Returns:

this shape

duplicate

public CShape duplicate()

Creates a new copy of this shape and returns it.

Overrides:

duplicate in class CShape

Returns:

the copy.

See Also:

CShape.duplicateWithTags()

getStartX

public double getStartX()

Returns:

the x-coordinate of the starting point.

getStartY

public double getStartY()

Returns:

the x-coordinate of the starting point.