Bug 9859 fixed: It was not possible to draw arrows in 3D with xarrows
[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 en 2D ou 3D.</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Séquence d'appel</title>
9         <synopsis>xarrows(nx, ny [,nz] [,arsize, color])</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Paramètres</title>
13         <variablelist>
14             <varlistentry>
15                 <term>nx, ny, nz</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>, <varname>ny</varname> et <varname>nz</varname>.
43             Si <varname>nz</varname> n'est pas spécifié, alors les flèches sont dessinées en 2D.
44             Si <varname>nx</varname>, <varname>ny</varname> et <varname>nz</varname> sont des vecteurs,
45             la flèche numéro i est définie par
46             <literal>(nx(i),ny(i),nz(i))--&gt;(nx(i+1),ny(i+1),nz(i+1))</literal>.
47             Si <varname>nx</varname>, <varname>ny</varname> et <varname>nz</varname> sont des matrices :
48         </para>
49         <programlisting role=""><![CDATA[ 
50 nx = [xi_1 xi_2 ...; xf_1 xf_2 ...]
51 ny = [yi_1 yi_2 ...; yf_1 yf_2 ...]
52 nz = [zi_1 zi_2 ...; zf_1 zf_2 ...]
53  ]]></programlisting>
54         <para>
55             la flèche numéro <literal>k</literal> est définie par <literal>(xi_k,yi_k,zi_k)--&gt;(xf_k,yf_k,zf_k)</literal>.
56         </para>
57         <para>
58             <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>.
59         </para>
60     </refsection>
61     <refsection>
62         <title>Exemples</title>
63         <programlisting role="example"><![CDATA[ 
64 x = 2*%pi*(0:7)/8
65 x1 = [sin(x); 9*sin(x)];
66 y1 = [cos(x); 9*cos(x)];
67 plot2d([-10,10], [-10,10], [-1,-1], "022")
68 xset("clipgrf")
69 xarrows(x1, y1, -1, [1:7,9]) //8-th color is white
70 xset("clipoff")
71  ]]></programlisting>
72         
73         <scilab:image>
74             x = 2*%pi*(0:7)/8
75             x1 = [sin(x); 9*sin(x)];
76             y1 = [cos(x); 9*cos(x)];
77             plot2d([-10,10], [-10,10], [-1,-1], "022")
78             xset("clipgrf")
79             xarrows(x1, y1, -1, [1:7,9])
80             xset("clipoff")
81         </scilab:image>
82         <programlisting role="example"><![CDATA[
83 N = 100;
84 zi = linspace(-1,2,N);
85 zf = zi;
86 theta = (zi - min(zi))/(max(zi)-min(zi))*720;
87 xi = zeros(1,N);  xf = cosd(theta);
88 yi = zeros(1,N);  yf = sind(theta);
89 clf, plot3d([-1 1 1 1],[-1 -1 -1 1],[-1 -1 2 2])
90 xarrows([xi;xf],[yi;yf],[zi;zf],0.7, 32*rand(1,N))
91  ]]></programlisting>
92         <scilab:image>
93 N = 100;
94 zi = linspace(-1,2,N);
95 zf = zi;
96 theta = (zi - min(zi))/(max(zi)-min(zi))*720;
97 xi = zeros(1,N);  xf = cosd(theta);
98 yi = zeros(1,N);  yf = sind(theta);
99 clf, plot3d([-1 1 1 1],[-1 -1 -1 1],[-1 -1 2 2])
100 xarrows([xi;xf],[yi;yf],[zi;zf],0.7, 32*rand(1,N))
101         </scilab:image>
102     </refsection>
103     <refsection>
104         <title>Historique</title>
105         <revhistory>
106             <revision>
107                 <revnumber>5.5.0</revnumber>
108                 <revremark>Les flèches peuvent être dessinées en 3D.</revremark>
109             </revision>
110         </revhistory>
111     </refsection>
112 </refentry>