Bug 8231 fixed: xrect doc did not say that clipping property was inherited
[scilab.git] / scilab / modules / graphics / help / fr_FR / geometric_shapes / xrects.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="xrects">
3     <refnamediv>
4         <refname>xrects</refname>
5         <refpurpose>dessine ou remplit un ensemble de rectangles  </refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Séquence d'appel</title>
9         <synopsis>xrects(rects,[fill])</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Paramètres</title>
13         <variablelist>
14             <varlistentry>
15                 <term>rects  </term>
16                 <listitem>
17                     <para>matrice de taille (4,n).
18                     </para>
19                 </listitem>
20             </varlistentry>
21             <varlistentry>
22                 <term>fill  </term>
23                 <listitem>
24                     <para>vecteur de taille n.
25                     </para>
26                 </listitem>
27             </varlistentry>
28         </variablelist>
29     </refsection>
30     <refsection>
31         <title>Description</title>
32         <para>
33             <literal>xrects</literal> dessine ou remplit un ensemble de rectangles. 
34             Chaque colonne de <literal>rects</literal> décrit un 
35             rectangle (point en haut à gauche, largeur, hauteur) en coordonnées utilisateur:
36             <literal>rects=[x1 y1 w1 h1;x2 y2 w2 h2;...]'</literal>.
37         </para>
38         <para>
39             <literal>fill(i)</literal> définit le motif utilisé pour dessiner ou remplir le rectangle i:
40         </para>
41         <para>
42             si <literal>fill(i)&lt;0</literal>, le rectangle <literal>i</literal> est dessiné avec la couleur
43             <literal>-fill(i)</literal>.
44         </para>
45         <para>
46             si <literal>fill(i)&gt;0</literal>, le rectangle <literal>i</literal> est rempli avec la couleur
47             <literal>fill(i)</literal>.
48         </para>
49         <para>
50             si <literal>fill(i)=0</literal>, le rectangle <literal>i</literal> est dessiné avec le style de ligne courant.
51         </para>
52         <warning>Notez que la valeur de la hauteur est positive en allant vers la bas.</warning>
53         <warning>Les rectangles créés héritent de la propriété de clip de l'axe courant.</warning>
54     </refsection>
55     <refsection>
56         <title>Exemples</title>
57         <programlisting role="example"><![CDATA[ 
58 plot2d([-100,500],[-50,50],[-1,-1],"022")
59 cols=[-34,-33,-32,-20:5:20,32,33,34];
60 x=400*(0:14)/14; step=20;
61 rects=[x;10*ones(x);step*ones(x);30*ones(x)];
62 xrects(rects,cols)
63 xnumb(x,15*ones(x),cols)
64  ]]></programlisting>
65         <scilab:image>
66             plot2d([-100,500],[-50,50],[-1,-1],"022")
67             cols=[-34,-33,-32,-20:5:20,32,33,34];
68             x=400*(0:14)/14; step=20;
69             rects=[x;10*ones(x);step*ones(x);30*ones(x)];
70             xrects(rects,cols)
71             xnumb(x,15*ones(x),cols)
72         </scilab:image>
73         
74     </refsection>
75     <refsection role="see also">
76         <title>Voir aussi</title>
77         <simplelist type="inline">
78             <member>
79                 <link linkend="xfrect">xfrect</link>
80             </member>
81             <member>
82                 <link linkend="xrect">xrect</link>
83             </member>
84         </simplelist>
85     </refsection>
86 </refentry>