|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjpicedt.graphic.model.AbstractElement
jpicedt.graphic.model.DefaultLeafElement
jpicedt.graphic.model.AbstractCurve
jpicedt.graphic.model.PicSmoothPolygon
A multicurve, either close or not, whose geometry is specified using a polygon, in such a way that the curve snakes
"smoothly" along the polygon. For each polygon point, a coefficient helps altering the smoothness of the
the path. Like the class it inherits from, this element has a variable number of user-controlled points that can be
added/inserted/deleted by the user.
Each polygon point is also an anchor point (e.g. for grid alignment).
Implementation notes : inherited pts
ArrayList acts as an array of specification
points for the multicurve (this behaviour being mostly inherited from superclass). Besides, there's an
ArrayList of PicPoint's, namely polygonPts
, which backs the geometry
of the polygon, and acts as a list of user-controlled points.
Moving a control-point thus updates specification points as appropriate.
[SR:todo:11/01/2003] add documentation about curve equation.
Field Summary | |
protected static int |
COEF_SLIDER_MAX
Max value of smoothness coefficient accessible to Jslider in the geometry editor |
protected static int |
COEF_SLIDER_MIN
Min value of smoothness coefficient accessible to JSlider in the geometry editor |
protected static double |
DEFAULT_SMOOTH_COEFF
the default value for the smoothness coefficient on startup. |
protected ArrayList |
polygonPts
An array of PicPoint's backing the geometry of the polygon. |
protected ArrayList |
smoothCoeff
The following array contains one Double per polygon point, specifying how close to polygon points the curve should go along. |
Fields inherited from class jpicedt.graphic.model.AbstractCurve |
FIRST_CURVE_END_POINT, FIRST_SEGMENT_CONTROL_POINT, INVALID_POINT_INDEX, isClosed, LAST_CURVE_END_POINT, SECOND_SEGMENT_CONTROL_POINT, SUBDIVISION_POINT |
Fields inherited from class jpicedt.graphic.model.DefaultLeafElement |
nodeConnections, nodeName, pts |
Fields inherited from class jpicedt.graphic.model.AbstractElement |
attributeSet, parent, view |
Constructor Summary | |
PicSmoothPolygon()
Create a new empty open smooth polygon, with a default attribute set. |
|
PicSmoothPolygon(boolean closed)
Create a new empty smooth polygon, open or closed, with a default attribute set bound to it. |
|
PicSmoothPolygon(boolean closed,
PicAttributeSet set)
Create a new empty smooth polygon with the given attribute set. |
|
PicSmoothPolygon(PicPoint[] polygonPts,
boolean closed,
double[] smoothCoeffs,
PicAttributeSet set)
Create a new smooth polygon initialized from the given array of PicPoint's, using the given array of smoothness values. |
|
PicSmoothPolygon(PicPoint[] polyPts,
boolean closed,
double smoothCoeff,
PicAttributeSet set)
Create a new smooth polygon initialized from the given array of PicPoint's. |
|
PicSmoothPolygon(PicPoint[] polygonPts,
boolean closed,
PicAttributeSet set)
Create a new smooth polygon initialized from the given array of PicPoint's, using the default smoothness value. |
|
PicSmoothPolygon(PicSmoothPolygon poly)
"cloning" constructor (to be used by clone()) |
Method Summary | |
void |
addPoint(int ptIndex,
PicPoint pt)
Adds the given polygon point at the given position, shifting ensuing point indices to the right. |
void |
addPoint(int ptIndex,
PicPoint pt,
double smoothCoeff)
Adds the given polygon point at the given position, shifting ensuing point indices to the right. |
void |
addPoint(PicPoint pt)
adds the given point at the end of this PicSmoothPolygon. |
void |
addPoint(PicPoint pt,
double smoothCoeff)
adds the given point with the given smoothness-coefficient at the end of this PicSmoothPolygon. |
Object |
clone()
Overide Object.clone() method |
PicMultiCurve |
convertToMultiCurve()
converts this PicSmoothPolygon to a PicMultiCurve, by simply relying on the appropriate constructor in class PicMultiCurve . |
PEAction[] |
createActions(ActionDispatcher actionDispatcher,
ActionLocalizer localizer,
HitInfo hi)
Create an array of Action's related to this object |
AbstractCustomizer |
createCustomizer()
Returns a customizer (Swing) component |
Rectangle2D |
getBoundingBox(Rectangle2D r)
Returns the bounding box (ie the surrounding rectangle) in double precision This implementation compute the bb from the union of : the bb as computed by super-class and the smallest rectangle that encompasses all the polygon-points. |
int |
getFirstPointIndex()
Returns the index of the first user-controlled point that can be retrieved by getPoint() . |
int |
getLastPointIndex()
Returns the index of the last user-controlled point that can be retrieved by getPoint() . |
String |
getName()
Returns a non-localised string representing this object's name This default implementation returns the class name. |
PicPoint |
getPoint(int numPoint,
PicPoint src)
Return the user-controlled point (ie a polygon point, not a bezier point) having the given index. |
double |
getPointX(int index)
This implementation returns the X-coord of the polygon-point with the same index. |
double |
getPointY(int index)
This implementation returns the Y-coord of the polygon-point with the same index. |
protected PicPoint |
getPolygonPoint(int numPoint)
Return a reference on the polygon point with the given index. |
double |
getSmoothCoefficient(int index)
|
void |
removeLastPoint()
removes the last point of this PicSmoothPolygon. |
void |
removePoint(int pos)
Remove a point at the given position from this PicSmoothPolygon, then fire a changed-update. |
void |
rotate(PicPoint ptOrg,
double angle)
Rotate this Element by the given angle along the given point |
void |
scale(double ptOrgX,
double ptOrgY,
double sx,
double sy)
Scale this object by (sx,sy) using (ptOrgX,ptOrgY) as the origin. |
void |
setClosed(boolean state)
set close path state, then fires a changed-update. |
void |
setPoint(int index,
PicPoint pt,
EditPointConstraint constraint)
Set the user-controlled point with the given index to the given value. |
void |
setSmoothCoefficient(int index,
double c)
|
void |
shear(PicPoint ptOrg,
double shx,
double shy)
Shear this Element by the given params wrt to the given origin |
int |
splitSegment(int segIdx,
PicPoint pt)
Split the given polygon segment (starting from 0), by inserting a new polygon point at the appropriate position. |
int |
splitSegment(int segIdx,
PicPoint pt,
double smoothCoeff)
Split the given polygon segment (starting from 0), by inserting a new polygon point at the appropriate position. |
String |
toString()
Used for debugging purpose. |
void |
translate(double dx,
double dy)
Translate this Element by (dx,dy) ; this implementation translates the specification-points, then fires a changed-update event. |
Methods inherited from class jpicedt.graphic.model.DefaultLeafElement |
addConnection, fireChangedUpdate, forwardChangedUpdate, getAllowsChildren, getNodeName, getNumberOfSpecificationPoints, getPoint, getSpecificationPoint, getSpecificationPointX, getSpecificationPointY, isNode, isNodeable, iterator, nodeConnectionOrigin, nodeReferencePoint, nodeReferencePointX, nodeReferencePointY, removeAllConnections, removeConnection, setNodeName, setPoint, setSpecificationPoint |
Methods inherited from class jpicedt.graphic.model.AbstractElement |
anchorPointsIterator, getAttribute, getAttributeSet, getDrawing, getParent, getView, removeView, scale, setAttribute, setAttributeSet, setParent, setViewFromFactory |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected ArrayList polygonPts
protected ArrayList smoothCoeff
protected static double DEFAULT_SMOOTH_COEFF
protected static int COEF_SLIDER_MIN
protected static int COEF_SLIDER_MAX
Constructor Detail |
public PicSmoothPolygon()
public PicSmoothPolygon(boolean closed)
closed
- whether the generated multi-curve will be closed or notpublic PicSmoothPolygon(boolean closed, PicAttributeSet set)
set
- attribute set to be bound to this elementclosed
- whether the generated multi-curve will be closed or notpublic PicSmoothPolygon(PicPoint[] polyPts, boolean closed, double smoothCoeff, PicAttributeSet set)
polyPts
- array of PicPoint's specifying the polygon geometry.set
- attribute set to be bound to this elementclosed
- whether the generated multi-curve will be closed or notsmoothCoeff
- the default smoothness value for each polygon pointpublic PicSmoothPolygon(PicPoint[] polygonPts, boolean closed, double[] smoothCoeffs, PicAttributeSet set)
polygonPts
- array of PicPoint's specifying the polygon geometry.set
- attribute set to be bound to this elementclosed
- whether the generated multi-curve will be closed or notpublic PicSmoothPolygon(PicPoint[] polygonPts, boolean closed, PicAttributeSet set)
polygonPts
- array of PicPoint's specifying the polygon geometry.set
- attribute set to be bound to this elementclosed
- whether the generated multi-curve will be closed or notpublic PicSmoothPolygon(PicSmoothPolygon poly)
poly
- PicSmoothPolygon to be clonedMethod Detail |
public Object clone()
clone
in interface Element
clone
in class DefaultLeafElement
public String getName()
DefaultLeafElement
getName
in interface Element
getName
in class DefaultLeafElement
public int getFirstPointIndex()
getPoint()
.
This implementation returns 0.
getFirstPointIndex
in interface Element
getFirstPointIndex
in class DefaultLeafElement
public int getLastPointIndex()
getPoint()
.
This default implementation returns the number of polygon-points minus one.
getLastPointIndex
in interface Element
getLastPointIndex
in class DefaultLeafElement
public PicPoint getPoint(int numPoint, PicPoint src)
setPoint
method.
getPoint
in interface Element
getPoint
in class DefaultLeafElement
numPoint
- the point index, should be greater or equal to the value returned by
getFirstPointIndex
, and lower or equal to getLastPointIndex
.
numPoint
;
if src
is null, allocates a new PicPoint and return it,
otherwise directly modifies src
and returns it as well for convenience.protected final PicPoint getPolygonPoint(int numPoint)
public double getPointX(int index)
getPointX
in interface Element
getPointX
in class DefaultLeafElement
index
- the point index, should be greater or equal to the value returned by
getFirstPointIndex
, and lower or equal to getLastPointIndex
.
index
.public double getPointY(int index)
getPointY
in interface Element
getPointY
in class DefaultLeafElement
index
- the point index, should be greater or equal to the value returned by
getFirstPointIndex
, and lower or equal to getLastPointIndex
.
index
.public void translate(double dx, double dy)
translate
in interface Element
translate
in class DefaultLeafElement
dx
- The X coordinate of translation vectordy
- The Y coordinate of translation vectorpublic void scale(double ptOrgX, double ptOrgY, double sx, double sy)
sx
and sy
may be negative.
This method eventually fires a changed-update event.
scale
in interface Element
scale
in class DefaultLeafElement
public void rotate(PicPoint ptOrg, double angle)
rotate
in interface Element
rotate
in class DefaultLeafElement
angle
- rotation angle in radianspublic void shear(PicPoint ptOrg, double shx, double shy)
shear
in interface Element
shear
in class DefaultLeafElement
public void setPoint(int index, PicPoint pt, EditPointConstraint constraint)
setPoint
in interface Element
setPoint
in class AbstractCurve
constraint
- not used so farpublic void addPoint(PicPoint pt)
addPoint
in class AbstractCurve
public void addPoint(PicPoint pt, double smoothCoeff)
public void addPoint(int ptIndex, PicPoint pt)
public void addPoint(int ptIndex, PicPoint pt, double smoothCoeff)
public int splitSegment(int segIdx, PicPoint pt)
splitSegment
in class AbstractCurve
segIdx
- index of the polygon segment that must be split.pt
- the PicPoint to be added
public int splitSegment(int segIdx, PicPoint pt, double smoothCoeff)
segIdx
- index of the polygon segment that must be split.smoothCoeff
- the smoothness coefficient to be used for the new polygon point.pt
- the PicPoint to be addedpublic void removePoint(int pos)
Nothing is done if this polygon has only one point.
removePoint
in class AbstractCurve
pos
- index of point to be removedpublic void removeLastPoint()
removePoint(polygonPts.size()-1)
public PicMultiCurve convertToMultiCurve()
PicMultiCurve
.
convertToMultiCurve
in interface PicMultiCurveConvertable
public double getSmoothCoefficient(int index)
index
- Description of the Parameter
public void setSmoothCoefficient(int index, double c)
index
- index of point whose smoothCoeff is to be adjustedc
- value of the smoothCoeffpublic void setClosed(boolean state)
setClosed
in class AbstractCurve
state
- The new closed valuepublic Rectangle2D getBoundingBox(Rectangle2D r)
getBoundingBox
in interface Element
getBoundingBox
in class DefaultLeafElement
public String toString()
toString
in class AbstractCurve
public PEAction[] createActions(ActionDispatcher actionDispatcher, ActionLocalizer localizer, HitInfo hi)
createActions
in interface ActionFactory
createActions
in class AbstractCurve
actionDispatcher
- dispatches events to the proper PECanvaslocalizer
- i18n localizer for PEAction'spublic AbstractCustomizer createCustomizer()
CustomizerFactory
createCustomizer
in interface CustomizerFactory
createCustomizer
in class AbstractCurve
|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |