dc056de7268234a699f510edade7758301162275
[scilab.git] / scilab / modules / graphics / help / fr_FR / geometric_shapes / xarrows.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="xarrows">
3     <refnamediv>
4         <refname>xarrows</refname>
5         <refpurpose>dessine un ensemble de flèches  </refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Séquence d'appel</title>
9         <synopsis>xarrows(nx, ny, [arsize, color])</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Paramètres</title>
13         <variablelist>
14             <varlistentry>
15                 <term>nx, ny  </term>
16                 <listitem>
17                     <para>valeurs réelles ou matrices de même taille.
18                     </para>
19                 </listitem>
20             </varlistentry>
21             <varlistentry>
22                 <term>arsize  </term>
23                 <listitem>
24                     <para>
25                         réel, taille des têtes des flèches. La valeur par défaut peut être obtenue  en prenant <varname>arsize</varname> = -1.
26                     </para>
27                 </listitem>
28             </varlistentry>
29             <varlistentry>
30                 <term>color  </term>
31                 <listitem>
32                     <para>
33                         matrice ou scalaire. Si <varname>color</varname> est positif il donne la couleur de ligne pour toutes les flèches. S'il est négatif  la couleur courante est utilisé. S'il est un vecteur, <literal>color(i)</literal> donne la couleur pour la flèche <literal>i</literal>.
34                     </para>
35                 </listitem>
36             </varlistentry>
37         </variablelist>
38     </refsection>
39     <refsection>
40         <title>Description</title>
41         <para>
42             <function>xarrows</function> dessine un ensemble de flèches données par <varname>nx</varname> et <varname>ny</varname>.
43             Si <varname>nx</varname> et <varname>ny</varname> sont des vecteurs,
44             la flèche numéro i est définie par
45             <literal>(nx(i),ny(i))--&gt;(nx(i+1),ny(i+1))</literal>.
46             Si <varname>nx</varname> et <varname>ny</varname> sont des matrices :
47         </para>
48         <programlisting role=""><![CDATA[ 
49 nx = [xi_1 x1_2 ...; xf_1 xf_2 ...]
50 ny = [yi_1 y1_2 ...; yf_1 yf_2 ...]
51  ]]></programlisting>
52         <para>
53             la flèche numéro <literal>k</literal> est définie par <literal>(xi_k,yi_k)--&gt;(xf_k,yf_k)</literal>.
54         </para>
55         <para>
56             <function>xarrows</function> utilise l'échelle graphique courante, qui peut être définie par appel préalable d'une fonction graphique de haut niveau comme <function>plot2d</function>.
57         </para>
58     </refsection>
59     <refsection>
60         <title>Exemples</title>
61         <programlisting role="example"><![CDATA[ 
62 x = 2*%pi*(0:7)/8
63 x1 = [sin(x); 9*sin(x)];
64 y1 = [cos(x); 9*cos(x)];
65 plot2d([-10,10], [-10,10], [-1,-1], "022")
66 xset("clipgrf")
67 xarrows(x1, y1, -1, [1:7,9]) //8-th color is white
68 xset("clipoff")
69  ]]></programlisting>
70         
71         <scilab:image>
72             x = 2*%pi*(0:7)/8
73             x1 = [sin(x); 9*sin(x)];
74             y1 = [cos(x); 9*cos(x)];
75             plot2d([-10,10], [-10,10], [-1,-1], "022")
76             xset("clipgrf")
77             xarrows(x1, y1, -1, [1:7,9])
78             xset("clipoff")
79         </scilab:image>
80     </refsection>
81 </refentry>