Fix the documentation. If the examples are the same, they should have the same syntax...
[scilab.git] / scilab / modules / graphics / help / pt_BR / geometric_shapes / xarrows.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) ENPC - Jean-Philippe Chancelier
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xarrows" xml:lang="en">
14     <refnamediv>
15         <refname>xarrows</refname>
16         <refpurpose>desenha um conjunto de setas</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Seqüência de Chamamento</title>
20         <synopsis>xarrows(nx, ny, [arsize, color])</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Parâmetros</title>
24         <variablelist>
25             <varlistentry>
26                 <term>nx,ny</term>
27                 <listitem>
28                     <para>vetores ou matrizes de reais de mesmo tamanho </para>
29                 </listitem>
30             </varlistentry>
31             <varlistentry>
32                 <term>arsize</term>
33                 <listitem>
34                     <para>escalar real, o tamanho da cabeça da seta. O tamanho padrão
35                         pode ser obtido ajustando <varname>arsize</varname> para -1. 
36                     </para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>color</term>
41                 <listitem>
42                     <para>
43                         matriz ou escalar. Se <varname>color</varname> for um escalar
44                         positivo, fornece a cor a ser usada em todas as setas. Se for
45                         negativo, a cor corrente é utilizada. Se for um vetor
46                         <literal>color(i)</literal> fornece a cor a ser utilizada no vetor
47                         <literal>i</literal>.
48                     </para>
49                 </listitem>
50             </varlistentry>
51         </variablelist>
52     </refsection>
53     <refsection>
54         <title>Descrição</title>
55         <para>
56             <function>xarrows</function> desenha um conjunto de setas dadas por
57             <varname>nx</varname> e <varname>ny</varname>. Se <varname>nx</varname> e
58             <varname>ny</varname> forem vetores, a i-ésima seta é definida por
59             <literal>(nx(i),ny(i))--&gt;(nx(i+1),ny(i+1))</literal>. Se
60             <varname>nx</varname> e <varname>ny</varname> são matrizes:
61         </para>
62         <programlisting role=""><![CDATA[ 
63 nx=[xi_1 x1_2 ...; xf_1 xf_2 ...]
64 ny=[yi_1 y1_2 ...; yf_1 yf_2 ...]
65  ]]></programlisting>
66         <para>
67             a <literal>k</literal>-ésima seta é definida por
68             <literal>(xi_k,yi_k)--&gt;(xf_k,yf_k)</literal>.
69         </para>
70         <para>
71             <function>xarrows</function> utiliza a escala de gráficos corrente que
72             pode ser ajustada através de uma chamada a uma função de esboço de
73             alto-nível como <function>plot2d</function>.
74         </para>
75     </refsection>
76     <refsection>
77         <title>Exemplos</title>
78         <programlisting role="example"><![CDATA[ 
79 x = 2*%pi*(0:7)/8
80 x1 = [sin(x); 9*sin(x)];
81 y1 = [cos(x); 9*cos(x)];
82 plot2d([-10,10], [-10,10], [-1,-1], "022")
83 xset("clipgrf")
84 xarrows(x1, y1, -1, [1:7,9]) //8-th color is white
85 xset("clipoff")
86  ]]></programlisting>
87         <scilab:image>
88             x = 2*%pi*(0:7)/8
89             x1 = [sin(x); 9*sin(x)];
90             y1 = [cos(x); 9*cos(x)];
91             plot2d([-10,10], [-10,10], [-1,-1], "022")
92             xset("clipgrf")
93             xarrows(x1, y1, -1, [1:7,9])
94             xset("clipoff")
95         </scilab:image>
96     </refsection>
97 </refentry>