diff options
| -rw-r--r-- | doc/refman.tex | 34 |
1 files changed, 20 insertions, 14 deletions
diff --git a/doc/refman.tex b/doc/refman.tex index c21aea0..35a2784 100644 --- a/doc/refman.tex +++ b/doc/refman.tex @@ -320,7 +320,7 @@ format documentation has been enhanced. \item anti-overlapping of tracks labels works again \item tsave can now be used to know if a named transformation is already defined \item gname can now be used to know if a named gradient is already defined -\item new tags can now be used : ``pathTags'' to go through groups. Yet to be documented! +\item new tags can now be used : ``pathTags'' to go through groups. \item find and addtag commands have been modified to be ``pathTag'' compliant \item the clone command only clone one item when using a tag. \item all items have now a -composealpha option @@ -1390,17 +1390,22 @@ reference) and all list parameters are given as array references. The origin should be the top left vertex of the enclosing rectangle and the corner the bottom right vertex of the rectangle. \item{\bf curve} \\ - The curve type expects either a flat list or a list of list. In the first case, the flat list + The curve type expects either a flat list or a list of lists. In the first case, the flat list must be a list of floating point numbers \verb+x0 y0 x1 y1 ... xn yn+, giving the coordinates of the curve vertices. The number of values should be - pair (or the last value will be discarded) but the list can be empty to build + even (or the last value will be discarded) but the list can be empty to build an empty invisible curve. In the second case, the list must contain lists of 2 or 3 - items: xi, yi and and an optionnal point type. Currently, the only available point type - is 'c' for a cubic bezier control point. For example in perl/Tk: the following list + elements: xi, yi and and an optionnal point type. Currently, the only available point type + is 'c' for a cubic bezier control point. For example in perl/Tk, the following list is an example of 2 beziers segments with a straight segment in between: - \verb+( [x0, y0], [x1, y1, 'c'], [x2, y2, 'c'], [x3, y3], [x4, y4, 'c'], [x5, y5] )+ As - There is only on control point (point 4) for the second cubic bezier, the omitted second - control point will be defaulted to point 4. + +\code{ +( [x0, y0], [x1, y1, 'c'], [x2, y2, 'c'], [x3, y3], + [x4, y4, 'c'], [x5, y5] ) +} + + As there is only on control point, \code{[x4, y4, 'c']} , for the second cubic bezier, + the omitted second control point will be defaulted to the same point. A curve can be defined later with the \cmdref{contour} or \cmdref{coords} commands. As a side effect of the curve behavior, a one vertex curve is essentially the same as an empty curve, it only waste some more memory. @@ -1716,7 +1721,7 @@ false. If the command is invoked with only the tagOrId parameter, it returns the number of contours composing the item. In fact it always returns the number of contours after a command has been conducted, it happens that with this reduced form nothing is done - except returning the number of contours.. + except returning the number of contours. On items that do not support the contour command, the returned value is 0 or 1 depending on the item having a contour or not. For example {\tt Tracks} yield 0 while @@ -1724,7 +1729,7 @@ false. {\tt coordListOrTagOrId} specifies a list of coordinates (either a flat list of X and Y, or a list similar to the one allowed for a curve item) or an item describing a - contour. If a flat list is specified it should contain a pair number of floating point values + contour. If a flat list is specified it should contain an even number of floating point values specifying the contour vertices X and Y in order. If a tag or an id is specified, it is should be from one of these classes: arc, curve, icon, rectangle, tabular, text, window. The external shape of the item will be used as the contour. If {\tt @@ -1737,7 +1742,8 @@ false. \item{\ident{add}} to extend the surface of the curve. In this case there is a mandatory flag describing the way the contour will be added. It may take the following values: \begin{description} - \item{0} the list of points is taken unchanged. + \item{0} the list of points is taken unchanged. In this case, the {\tt coordListOrTagOrId} + parameter cannot be a tag and must be an explicit list of points. \item{1} the list of points is reverted, if needed, so that the points defines a {\bf counterclockwise} contour. \item{-1} the list of points is reverted,if needed, so that the points defines @@ -1764,7 +1770,7 @@ false. optional {\tt contour} gives the contour, if available, that should be operated. The default contour is 0. The optional {\tt index} gives the vertex index that should be operated in the given contour. The optional {\tt coordList} is either a flat list (of - one or more vertices described as X, Y floating point values) or a list of list + one or more vertices described as X, Y floating point values) or a list of lists [X Y ?type?] such as described in the curve item. The coordinates will be used to replace or add coordinates to the current contour. @@ -1780,8 +1786,8 @@ false. read. For all items that do not support multiple contours (currently all except curves) the {\tt contour} parameter should be omitted or specified as zero. - When \tt{coords} is used to get more than one point, the return value is \bf{always} a - list of lists. Each sub list contains X, Y and 'c' if the point is a bezier control point. + When {\tt coords} is used to get more than one point, the return value is {\bf always} a + list of lists. Each sub list contains X, Y, and 'c' if the point is a bezier control point. The optional parameters must be combined to produce a given behavior. Here are the various form recognized by the command: |