Fix help issues (warnings + wrong format in files)
[scilab.git] / scilab / modules / graphics / help / pt_BR / graphics_entities.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) INRIA
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.1-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: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="graphics_entities" xml:lang="en">
14     <refnamediv>
15         <refname>graphics_entities</refname>
16         <refpurpose>Descrição das estruturas de dados de entidades
17             gráficas
18         </refpurpose>
19     </refnamediv>
20     <refsection>
21         <title>Descrição</title>
22         <para>No Scilab, uma janela de gráficos e os desenhos contidos nela são
23             representados por entidades hierárquicas. O topo do nível hierárquico é a
24             Figure (figura). cada Figure define pelo menos um galho do tipo Axes
25             (eixos). Cada entidade Axes contém um conjunto de folhas que são objetos
26             gráficos básicos como Polylines, Rectangles, Arcs, Segs,... (poligonais,
27             retângulos, arcos e segmentos). Também pode ser do tipo Compound
28             (composto) que são conjuntos recursivos de entidades. O interesse
29             principal no novo modo de gráficos é facilitar a mudança de propriedades.
30             O novo modo de gráficos fornece um conjunto de rotinas gráficas de
31             alto-nível (ver <link linkend="set">set</link>, <link linkend="get">get</link>) utilizadas para controlar propriedades dos
32             objetos como dados, cores, coordenadas e escalas, cores e aparências sem
33             que seja necessário entrar novamente os comandos de gráficos
34             iniciais.
35         </para>
36         <para>Entidades gráficas do Scilab estão associadas a variáveis do tipo
37             <literal>handle</literal>. (manipuladores). O manipulador é um
38             identificador único que é associado a cada instância de uma entidade
39             gráfica criada. Utilizando-se manipuladores, é possível tanger
40             propriedades de entidades através das rotinas "set" e "get". Os
41             manipuladores também são utilizados para manipular objetos gráficos, para
42             movê-los, para fazer cópias ou deletá-los.
43         </para>
44         <para/>
45         <variablelist>
46             <varlistentry>
47                 <term>Figure:</term>
48                 <listitem>
49                     <para>a entidade figura é o topo da hierarquia de entidades
50                         gráficas. Esta entidade define os parâmetros para a figura em si
51                         tanto quanto os valores padrões dos parâmetros para criação de
52                         galhos. Os galhos das figuras são as entidades de eixos.
53                     </para>
54                     <para>O manipulador da figura corrente (a figura para onde os
55                         desenhos foram enviados) pode ser obtido utilizando-se
56                         <literal>get("current_figure")</literal> e pode ser ajustado
57                         utilizando-se <literal>set("current_figure",h)</literal>, onde
58                         <literal>h</literal> pode ser tanto um manipulador da figura ou um
59                         idenficador da figura <literal>figure_id</literal> neste último
60                         caso, se não existir, um é automaticamente criado.
61                     </para>
62                     <para>
63                         Veja <link linkend="figure_properties">figure_properties</link> para
64                         detalhes.
65                     </para>
66                 </listitem>
67             </varlistentry>
68             <varlistentry>
69                 <term>Axes:</term>
70                 <listitem>
71                     <para>a entidade de eixos está no segundo nível da hierarquia de
72                         entidades gráficas. Esta entidade define parâmetros para a mudança
73                         de coordenadas dos eixos e o desenho dos eixos tanto quanto os
74                         parâmetros padrões para criação de seus galhos. Ver <link linkend="axes_properties">axes_properties</link> for details. para
75                         detalhes. O manipulador dos eixos correntes pode ser obtido
76                         utilizando-se <literal>get("current_axes")</literal>.
77                     </para>
78                 </listitem>
79             </varlistentry>
80             <varlistentry>
81                 <term>Compound:</term>
82                 <listitem>
83                     <para>a entidade composta é simplesmente um vetor de galhos com uma
84                         única propriedade (propriedade de visibilidade). É usada para colar
85                         um conjunto de entidades.
86                     </para>
87                     <para>
88                         Ver as documentações <link linkend="glue">glue</link>, <link linkend="unglue">unglue</link> e <link linkend="Compound_properties">Compound_properties</link>.
89                     </para>
90                 </listitem>
91             </varlistentry>
92             <varlistentry>
93                 <term>Axis:</term>
94                 <listitem>
95                     <para>a entidade eixo é uma folha da hierarquia de entidades
96                         gráficas. Esta entidade define os parâmetros de escala de um eixo e
97                         aparência.
98                     </para>
99                     <para>
100                         Ver <link linkend="axis_properties">axis_properties</link>
101                         para detalhes.
102                     </para>
103                 </listitem>
104             </varlistentry>
105             <varlistentry>
106                 <term>Polyline:</term>
107                 <listitem>
108                     <para>a entidade poligonal é uma folha na hierarquia de entidades
109                         gráficas. define propriedades de desenho de poligonais e extensões
110                         poligonais 2d e 3d.
111                     </para>
112                     <para>
113                         Ver <link linkend="polyline_properties">polyline_properties</link> para
114                         detalhes.
115                     </para>
116                 </listitem>
117             </varlistentry>
118             <varlistentry>
119                 <term>Arc:</term>
120                 <listitem>
121                     <para>a entidade arco é uma folha na hierarquia de entidades
122                         gráficas. Esta entidade define parâmetros para elipses e partes de
123                         elipses.
124                     </para>
125                     <para>
126                         Ver <link linkend="arc_properties">arc_properties</link> para
127                         detalhes.
128                     </para>
129                 </listitem>
130             </varlistentry>
131             <varlistentry>
132                 <term>Rectangle:</term>
133                 <listitem>
134                     <para>a entidade retângulo é uma folha na hierarquia de entidades
135                         gráficas. Esta entidade define parâmetros para retângulos e
136                         retângulos preenchidos.
137                     </para>
138                     <para>
139                         Ver <link linkend="rectangle_properties">rectangle_properties</link> para
140                         detalhes.
141                     </para>
142                 </listitem>
143             </varlistentry>
144             <varlistentry>
145                 <term>Surface:</term>
146                 <listitem>
147                     <para>a entidade superfície é uma folha na hierarquia de entidades
148                         gráficas. possui sub-tipos <literal>Fac3d</literal> ou
149                         <literal>Plot3d</literal>. Esta entidade define parâmetros para
150                         esboço de superfícies 3d.
151                     </para>
152                     <para>
153                         Ver <link linkend="surface_properties">surface_properties</link> para
154                         detalhes.
155                     </para>
156                 </listitem>
157             </varlistentry>
158             <varlistentry>
159                 <term>Fec:</term>
160                 <listitem>
161                     <para>a entidade Fec é uma folha na hierarquia de entidades
162                         gráficas. Representa esboços de elementos 2d finitos.
163                     </para>
164                     <para>
165                         Ver <link linkend="fec_properties">fec_properties</link> para
166                         detalhes
167                     </para>
168                 </listitem>
169             </varlistentry>
170             <varlistentry>
171                 <term>Grayplot:</term>
172                 <listitem>
173                     <para>a entidade Grayplot é uma folha na hierarquia de entidades
174                         gráficas. Representa esboços 2d de superfícies utilizando cores e
175                         imagens.
176                     </para>
177                     <para>
178                         Ver <link linkend="grayplot_properties">grayplot_properties</link> para
179                         detalhes.
180                     </para>
181                 </listitem>
182             </varlistentry>
183             <varlistentry>
184                 <term>Matplot:</term>
185                 <listitem>
186                     <para>a entidade Matplot é uma folha na hierarquia de entidades
187                         gráficas. Representa esboços 2d utilizando matrizes de
188                         inteiros.
189                     </para>
190                     <para>
191                         Ver <link linkend="Matplot_properties">Matplot_properties</link> para
192                         detalhes.
193                     </para>
194                 </listitem>
195             </varlistentry>
196             <varlistentry>
197                 <term>Segs:</term>
198                 <listitem>
199                     <para> a entidade de segmentos é uma folha na hierarquia de
200                         entidades gráficas. Esta entidade define parâmetros um conjunto de
201                         flechas ou segmentos coloridos.
202                     </para>
203                     <para>
204                         Ver <link linkend="segs_properties">segs_properties</link>
205                         para detalhes
206                     </para>
207                 </listitem>
208             </varlistentry>
209             <varlistentry>
210                 <term>Champ:</term>
211                 <listitem>
212                     <para>a entidade Champ é uma folha na hierarquia de entidades
213                         gráficas. Esta entidade define parâmetros para esboços 2d de campos
214                         vetoriais.
215                     </para>
216                     <para>
217                         Ver <link linkend="champ_properties">champ_properties</link>
218                         para detalhes.
219                     </para>
220                 </listitem>
221             </varlistentry>
222             <varlistentry>
223                 <term>Text:</term>
224                 <listitem>
225                     <para>a entidade texto é uma folha na hierarquia de entidades
226                         gráficas. Esta entidade define parâmetros para impressão de
227                         strings.
228                     </para>
229                     <para>
230                         Ver <link linkend="text_properties">text_properties</link>
231                         para detalhes.
232                     </para>
233                 </listitem>
234             </varlistentry>
235             <varlistentry>
236                 <term>Label:</term>
237                 <listitem>
238                     <para>a entidade rótulo é um galho da entidade gráfica
239                         <literal>Axes</literal> (de eixos). Esta entidade define parâmetros
240                         para os rótulos dos 3 eixos x, y e z desenhados em uma janela de
241                         gráficos.
242                     </para>
243                     <para>
244                         Ver <link linkend="label_properties">label_properties</link>
245                         para detalhes.
246                     </para>
247                 </listitem>
248             </varlistentry>
249             <varlistentry>
250                 <term>Legend:</term>
251                 <listitem>
252                     <para>a legenda é uma folha na hierarquia de entidades gráficas.
253                         Esta entidade define parâmetros para legendas desenhadas impressas
254                         sob gráficos <literal>plot2dx</literal>. Esta entidade requer
255                         futuros desenvolvimentos.
256                     </para>
257                     <para>
258                         Ver <link linkend="legend_properties">legend_properties</link>
259                         para detalhes.
260                     </para>
261                 </listitem>
262             </varlistentry>
263         </variablelist>
264     </refsection>
265     <refsection>
266         <title>Exemplos</title>
267         <programlisting role="example"><![CDATA[ 
268 //execute este exemplo linha por linha
269
270 scf() //criando figura no modo de entidade
271
272 //obtendo o manipulador da entidade Figure e exibindo suas propriedades
273 f=get("current_figure") 
274 a=f.children // o manipulador da galho Axes
275 x=(1:10)';  plot2d(x,[x.^2 x.^1.5])
276 e=a.children //Compound de duas poligonais
277
278 p1=e.children(1) //as propriedades das últimas poligonais desenhadas
279  
280 p1.foreground=5;  // mudando a cor da poligonal
281 e.children.thickness=5; // mudando a espessura das poligonais
282
283 delete(e.children(2))
284
285 move(e.children,[0,30]) //transladando a poligonal
286
287 a.axes_bounds=[0 0 0.5 0.5]; 
288
289 subplot(222) //criando uma nova entidade Axes
290 plot(1:10);
291 a1=f.children(1); //obtendo seu manipulador
292 copy(e.children,a1); //copiando a poligonal do primeiro esboço nos novos eixos
293 a1.data_bounds=[1 0;10 100]; //mudando os limites dos eixos
294
295 set("current_figure",10) //criando uma nova figura com figure_id=10
296 plot3d() //os desenhos são enviados à nova figura com figure_id=10
297 set("current_figure",f) //torna a figura anterior a corrente
298 plot2d(x,x^3)  //os desenhos são enviados à figura inicial
299  ]]></programlisting>
300     </refsection>
301     <refsection role="see also">
302         <title>Ver Também</title>
303         <simplelist type="inline">
304             <member>
305                 <link linkend="set">set</link>
306             </member>
307             <member>
308                 <link linkend="get">get</link>
309             </member>
310             <member>
311                 <link linkend="move">move</link>
312             </member>
313             <member>
314                 <link linkend="delete">delete</link>
315             </member>
316             <member>
317                 <link linkend="object_editor">object_editor</link>
318             </member>
319             <member>
320                 <link linkend="plot">plot</link>
321             </member>
322             <member>
323                 <link linkend="surf">surf</link>
324             </member>
325         </simplelist>
326     </refsection>
327 </refentry>