b4333e58bf2c556aee00fd93ba68c40510684a7f
[scilab.git] / scilab / modules / graphics / help / pt_BR / 2d_plot / champ.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) ENPC - Jean-Philippe Chancelier
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="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="champ" xml:lang="pt">
17     <refnamediv>
18         <refname>champ</refname>
19         <refpurpose>esboço de campo vetorial 2d</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Seqüência de Chamamento</title>
23         <synopsis>champ(x,y,fx,fy,[arfact,rect,strf])
24             champ(x,y,fx,fy,&lt;opt_args&gt;)
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Parâmetros</title>
29         <variablelist>
30             <varlistentry>
31                 <term>x,y</term>
32                 <listitem>
33                     <para>dois vetores que definem o grid</para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>fx</term>
38                 <listitem>
39                     <para>uma matriz que descreve o componente x do campo vetorial.
40                         <literal>fx(i,j)</literal> é o componente x do campo vetorial no
41                         ponto <literal>(x(i),y(j))</literal>.
42                     </para>
43                 </listitem>
44             </varlistentry>
45             <varlistentry>
46                 <term>fy</term>
47                 <listitem>
48                     <para>uma matriz que descreve o componente y do campo vetorial.
49                         <literal>fy(i,j)</literal>é o componente y do campo vetorial no
50                         ponto <literal>(x(i),y(j))</literal>.
51                     </para>
52                 </listitem>
53             </varlistentry>
54             <varlistentry>
55                 <term>&lt;opt_args&gt;</term>
56                 <listitem>
57                     <para>representa a seqüência de declarações
58                         <literal>key1=value1,key2=value2</literal>,... onde
59                         <literal>key1</literal>, <literal>key2,...</literal> podem ser um
60                         dos seguintes: arfact, rect, strf (ver abaixo).
61                     </para>
62                 </listitem>
63             </varlistentry>
64             <varlistentry>
65                 <term>arfact</term>
66                 <listitem>
67                     <para>um argumento opcional do tipo real que fornece um fator de
68                         escala para a exibição das cabeças das setas no esboço (o valor
69                         padrão é 1.0).
70                     </para>
71                 </listitem>
72             </varlistentry>
73             <varlistentry>
74                 <term>rect</term>
75                 <listitem>
76                     <para>
77                         um vetor <literal>rect=[xmin,ymin,xmax,ymax]</literal> que
78                         fornece as fronteiras da moldura gráfica à ser utilizada.
79                     </para>
80                 </listitem>
81             </varlistentry>
82             <varlistentry>
83                 <term>strf</term>
84                 <listitem>
85                     <para>um string de comprimento 3 "xyz" que possui o mesmo
86                         significado do parâmetro <literal>strf</literal> de
87                         <literal>plot2d</literal>. O primeiro caractere não tem efeito com
88                         <literal>champ</literal>.
89                     </para>
90                 </listitem>
91             </varlistentry>
92         </variablelist>
93     </refsection>
94     <refsection>
95         <title>Descrição</title>
96         <para>
97             <literal>champ</literal> desenha um campo vetorial 2d. O comprimento
98             das setas é proporcional é proporcional à intensidade do campo.
99         </para>
100         <para>Se você quiser setas coloridas com a cor das setas dependendo da
101             intensidade do campo, use <literal>gce().colored = "on"</literal>.
102         </para>
103         <para>
104             Entre com o comando <literal>champ()</literal> para visualizar uma
105             demonstração.
106         </para>
107     </refsection>
108     <refsection>
109         <title>Exemplos</title>
110         <programlisting role="example"><![CDATA[
111 // usando rect como fronteiras do esboço
112 champ(-5:5,-5:5,rand(11,11),rand(11,11),rect=[-10,-10,10,10],arfact=2)
113 // usando (x,y) para conseguir obter
114 clf()
115 champ(-5:5,-5:5,rand(11,11),rand(11,11),2,[-10,-10,10,10],"021")
116  ]]></programlisting>
117     </refsection>
118     <refsection role="see also">
119         <title>Ver Também</title>
120         <simplelist type="inline">
121             <member>
122                 <link linkend="fchamp">fchamp</link>
123             </member>
124             <member>
125                 <link linkend="xarrows">xarrows</link>
126             </member>
127             <member>
128                 <link linkend="polyline_properties">Arrowed polyline</link>
129             </member>
130         </simplelist>
131     </refsection>
132 </refentry>