aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authormertz2003-02-04 16:49:02 +0000
committermertz2003-02-04 16:49:02 +0000
commita81fe15be4d054cdd70cbb348e24c5dbdbc06313 (patch)
tree1954542a1274dd95f345c932e8a7c33580429709 /doc
parentb58be23952d19375ff7abcef4d3e356117f13e3d (diff)
downloadtkzinc-a81fe15be4d054cdd70cbb348e24c5dbdbc06313.zip
tkzinc-a81fe15be4d054cdd70cbb348e24c5dbdbc06313.tar.gz
tkzinc-a81fe15be4d054cdd70cbb348e24c5dbdbc06313.tar.bz2
tkzinc-a81fe15be4d054cdd70cbb348e24c5dbdbc06313.tar.xz
- ajout de quelques liens au sein de la doc.
- description sommaire des items icon, reticle, map, triangles
Diffstat (limited to 'doc')
-rw-r--r--doc/refman.tex51
1 files changed, 31 insertions, 20 deletions
diff --git a/doc/refman.tex b/doc/refman.tex
index a861e23..9c5b8c3 100644
--- a/doc/refman.tex
+++ b/doc/refman.tex
@@ -292,7 +292,7 @@ This document is also referenced as CENA technical note NT03-532.
\item curve items support now a higher level of description: they may be composed of line
segments, and bezier segments. In the future they may also support other kinds of segments
(such as arcs...).
-\item the coords method accept a list of arrays as well as flat list of coordinates.
+\item the coords method accepts a list of arrays as well as flat list of coordinates.
When coords returns more than one point it is always a list of arrays.
(and no more a flat list of x y x y ...). {\bf Beware this is an small incompatible change in the API}.
\item operators of the contour command have been replaced by a flag which indicates
@@ -1385,12 +1385,12 @@ reference) and all list parameters are given as array references.
After these first two parameters come some item type specific arguments. Here is
detailed description of these arguments by type:
\begin{description}
- \item{\bf arc} \\
+ \item{\objectref{arc}}\\
The arc type expects a list of four floating point numbers \verb+xo yo xc yc+,
giving the coordinates of the origin and the corner of the enclosing rectangle.
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} \\
+ \item{\objectref{curve}}\\
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
@@ -1410,10 +1410,10 @@ reference) and all list parameters are given as array references.
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.
- \item{\bf rectangle} \\
+ \item{\objectref{rectangle}}\\
The rectangle type expects a list of four floating point numbers \verb+xo yo xc yc+,
giving the coordinates of the origin and the corner of the rectangle.
- \item{\bf triangles} \\
+ \item{\objectref{triangles}}\\
The triangles type expects a list of at least 6 floating point numbers
\verb+x0 y0 x1 y1+ \verb+... xn yn+, giving the coordinates of the vertices of the triangles
composing this item. The triangles layout is defined by the attribute
@@ -1421,11 +1421,10 @@ reference) and all list parameters are given as array references.
are arranged in a fan with the first point being the center and the other
points defining the perimeter. If \attributeref{triangles}{fan} is false, the
triangles are arranged in a strip.
- (XXX Afficher un diagramme avec l'ordre des sommets).
- \item{\bf tabular, track, waypoint} \\
+ \item{\objectref{tabular}, \objectref{track}, \objectref{waypoint}}\\
These types expects the number of fields they will manage in the label or
tabular form. This number must be greater or equal to zero.
- \item{\bf group, icon, map, reticle, text, window} \\
+ \item{\objectref{group}, \objectref{icon}, \objectref{map}, \objectref{reticle}, \objectref{text}, \objectref{window}}\\
These types doesn't expect type specific arguments.
\end{description}
@@ -2580,8 +2579,6 @@ displayed. The defaut value is {\tt true}.}
\section{Track items}
\object{track}
-XXX A relire et reprendre
-
Track items have been designed for figuring out typical radar information for Air Traffic
Control. However they may certainly be used by other kinds of radar view and surely by
other kind of plan view with many moving objects and associated textual information.
@@ -3101,7 +3098,11 @@ must be inserted in the text to have multiple lines. The default value is {\tt 0
\section{Icon items}
\object{icon}
-Icon items are used for XXX.
+Icon items are used for displaying bitmap images. Any bitmap file format
+supported by Tk can be used. If the bitmap file supports transparency
+(not alpha-blending, only full transparency), TkZinc will render this transparent area.
+With openGL, icons can be rotated or scaled. However, attributes \attributeref{icon}{composerotation}
+and \attributeref{icon}{composescale} must be set before rotation and scaling.
Applicable attributes for \ident{icon} are:
@@ -3159,7 +3160,11 @@ is {\tt true}.}
\section{Reticle items}
\object{reticle}
-Reticle items are used for XXX.
+Reticle items are set of concentric circles. The number of circles can be either
+finite or not. Some periodic circles may be different, they are called bright circles; they
+can be configured differently from other circles. This item has mainly be designed for
+radar display images, to help user evaluationg distances from the central point.
+Reticle cannot handle events.
Applicable attributes for \ident{reticle} are:
@@ -3221,7 +3226,12 @@ is {\tt true}.}
\object{map}
-Map items are used for XXX.
+Map items are typically used for displaying maps on a radar display view. Maps are
+not be sensitive to mouse or keyboard events, but have been designed to efficiently display
+large set of points, segments, arcs, and simple texts. A map item is associated to a mapinfo.
+This mapinfo entity can be either initialized with the \conceptref{videomap}{videomapcmd}
+command or more generally created and edited with a set of commands described in the
+\conceptref{The mapinfo related commands}{mapinfocmds} section.
Applicable attributes for \ident{map} are:
@@ -3546,17 +3556,18 @@ is {\tt true}.}
\section{Triangles items}
\object{triangles}
-XXX A relire et reprendre
-
- Triangles items are used for XXX.
+Triangles items are used for displaying complexe surfaces with variables colors
+and transparencies. For example, it can be used to create a circular color selector
+displaying a range of colors. The way triangles composing a triangle item are arranged
+is defined by the \attributeref{triangles}{fan} option.
- This item has been added to provide access to a basic openGL geometric construction but
- it is also available in the X environment albeit with less features.
+This item has been added to provide access to a basic openGL geometric construction but
+it is also available in the X environment albeit with less features.
- Applicable attributes for \ident{triangles} are:
+Applicable attributes for \ident{triangles} are:
\attribute{triangles}{colors}{gradientlist}{Specifies the colors of each vertex of the
-triangles XXX.}
+triangles.} %% XXX what if less/more colors than vertex?
\attribute{triangles}{composealpha}{boolean}{Specifies if the alpha value inherited from
the parent group should be composed with the alpha of this item. The default value is {\tt true}.}