File: figure_properties.xml

package info (click to toggle)
scilab 5.2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 334,832 kB
  • ctags: 52,586
  • sloc: xml: 526,945; ansic: 223,590; fortran: 163,080; java: 56,934; cpp: 33,840; tcl: 27,936; sh: 20,397; makefile: 9,908; ml: 9,451; perl: 1,323; cs: 614; lisp: 30
file content (407 lines) | stat: -rw-r--r-- 15,750 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA - Djalel Abdemouche
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 *
 -->
<refentry version="5.0-subset Scilab" xml:id="figure_properties" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:ns4="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:db="http://docbook.org/ns/docbook">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>

  <refnamediv>
    <refname>figure_properties</refname>

    <refpurpose>Descrio das propriedades da entidade grfica Figure
    (figura)</refpurpose>
  </refnamediv>

  <refsection>
    <title>Descrio</title>

    <para>A figura  o topo da hierarquia de entidades grficas. Esta entidade
    contm um nmero de propriedades designadas a controlar muitos aspectos da
    exibio de objetos grficos do Scilab. Estas propriedades esto dividas
    em duas categorias. Propriedades que contm informao sobre a prpria
    figura e outras relacionadas a valores padres para criao de
    galhos.</para>

    <variablelist>
      <varlistentry>
        <term>Figure properties:</term>

        <listitem>
          <variablelist>
            <varlistentry>
              <term>children:</term>

              <listitem>
                <para> estes manipuladores representam o vetor dos galhos da
                figura. Note que todos os galhos de figuras so do tipo
                <literal>"Axes"</literal>. Tambm tenha em mente que, ao se
                criar uma entidade figura (utilizando o comando <link
                linkend="scf">scf</link>), uma entidade
                <literal>Axes</literal> (de eixos)  simultaneamente criada.
                </para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>figure_style:</term>

              <listitem>
                <para>o valor deste campo determina o estilo da figura. Desde
                o Scilab 5.0, o modo grfico antigo foi desabilitado. Esta
                propriedade  mantida por compatibilidade, mas no pode ser
                alterada.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>figure_position:</term>

              <listitem>
                <para> este campo contm a posio em pixel da janela de
                grficos na tela.  um vetor <literal>[x,y]</literal>
                definindo a posio do canto superior esquerdo da janela. A
                posio <literal>[0,0]</literal>  o canto superior esquerdo
                da tela.</para>

                <para>A posio inicial de uma janela de grficos  tomada a
                partir da entidade figura padro (ver <link
                linkend="gdf">gdf</link>). A nica excesso  quando o valor
                <literal>figure_position</literal> da figura padro 
                <literal>[-1,-1]</literal>. Neste caso, A posio inicial da
                janela de grficos  ajustada automaticamente pelo sistema de
                janelamento.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>figure_size:</term>

              <listitem>
                <para>esta propriedade controla o tamanho em pixel da janela
                de grficos da tela. O tamanho  o vetor
                <literal>[width,height]</literal>.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>axes_size:</term>

              <listitem>
                <para>usado para especificar o tamanho da janela de grficos
                virtual. O tamanho  o vetor <literal>[width,height]
                </literal>. A janela de grficos virtual deveria ser maior que
                a parte realmente visvel na tela. Esta propriedade no
                poderia ser alterada se a figura est aportada com outros
                elementos.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>auto_resize:</term>

              <listitem>
                <para>esta propriedade determina se a janela de grficos 
                redimensionada. Se o valor  <literal>"on"</literal> ento a
                propriedade <literal>axes_size</literal>  igualada a
                <literal>figure_size</literal> e os galhos eixos so ampliados
                de modo correspondente. Se o valor  <literal>"off"</literal>,
                <literal>axes_size</literal> no pode ser redimensionado
                quando <literal>figure_size</literal>  modificado. </para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>viewport:</term>

              <listitem>
                <para>posio da parte visvel do grfico na janela</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>figure_name:</term>

              <listitem>
                <para>este campo contm o nome da figura. O nome  um string
                exibido no topo da janela de grficos. Pode conter um nico
                substring <literal>%d</literal> que ser substituido por
                <literal>figure_id</literal>. Em nenhum outro caso o caractere
                %  permitido dentro do nome.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>figure_id:</term>

              <listitem>
                <para>este campo contm o identificador da figura.  um nmero
                inteiro que  ajustado na criao da figura e no pode ser
                mudado depois. </para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>info_message:</term>

              <listitem>
                <para>este string ajusta o texto que ser exibido na barra de
                informaes da janela.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>color_map:</term>

              <listitem>
                <para>propriedade que define o mapa de cores utilizado pela
                figura. O mapa de cores  uma matriz <literal>m</literal> por
                <literal>3</literal>. <literal>m</literal>  o nmero de
                cores. O nmero da cor i  dado pela tripla 3-uple
                <literal>R</literal>, <literal>G</literal>,
                <literal>B</literal> correspondentes respectivamente s
                intensidades de vermelho, verde e azul entre 0 e 1.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>pixmap:</term>

              <listitem>
                <para>esta propriedade controla o status de pixmap de uma
                janela de grficos. Se o valor  <literal>"off"</literal> os
                grficos so diretamente exibidos na tela. Se 
                <literal>"on"</literal> os grficos so feitos em um pixmap e
                so enviados  janela atravs do comando
                <literal>show_pixmap()</literal>.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>pixel_drawing_mode:</term>

              <listitem>
                <para>este campo define a operao bit a bit usada para
                desenhar o pixel na tela. O modo padro 
                <literal>copy</literal> que significa dizer que o pixel 
                desenhado como requerido. De modo mais geral, a operao bit a
                bit  realizada entre a cor do pixel fonte e a cor do pixel j
                presente na tela. As operaes so:
                <literal>"clear"</literal>, <literal>"and"</literal>,
                <literal>"andReverse"</literal> , <literal>"copy"</literal>,
                <literal>"andInverted"</literal> , <literal>"noop"</literal> ,
                <literal>"xor"</literal> , <literal>"or"</literal> ,
                <literal>"nor"</literal> , <literal>"equiv"</literal> ,
                <literal>"invert"</literal> , <literal>"orReverse"</literal> ,
                <literal>"copyInverted"</literal> ,
                <literal>"orInverted"</literal> , <literal>"nand"</literal> ,
                <literal>"set"</literal> ,</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>immediate_drawing:</term>

              <listitem>
                <para>esta propriedade controla a exibio da figura. Pode ser
                <literal>"on"</literal> (modo padro) ou
                <literal>"off"</literal>.  utilizada par atrasar uma grande
                sucesso de comandos grficos (implicando vrios esboos ou
                re-esboos). Note que, ao se utilizar os comandos
                <literal>drawlater</literal> ou <literal>drawnow</literal> 
                utilizada par atrasar uma grande sucesso de comandos grficos
                (implicando vrios esboos ou re-esboos). Note que, ao se
                utilizar os comandos <literal>'off'</literal> ou
                <literal>'on'</literal>).</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>background:</term>

              <listitem>
                <para>esta propriedade controla a cor de plano de fundo da
                figura. O valor  um ndice de cor correspondente ao mapa de
                cores corrente. </para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>event_handler</term>

              <listitem>
                <para>um string. O nome da funo do Scilab que dever
                manipular os eventos. Note que definir um string vazio
                desabilitar o manipulador de eventos. Para mais informaes
                sobre o manipulador de eventos, veja a ajuda <link
                linkend="eventhandlerfunctions">event handler
                functions</link>.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>event_handler_enable</term>

              <listitem>
                <para>habilita ou desabilita o manipulador de eventos. Seu
                valor deve ser "on" ou "off".</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>user_data:</term>

              <listitem>
                <para>este campo pode ser utilizado para se armazenar qualquer
                varivel Scilab na estrutura de dados da entidade figura e
                recuper-la.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>tag:</term>

              <listitem>
                <para>este campo pode ser utilizado para armazenar um string
                geralmente utilizado para identificar o controle. Ele permite
                fornecer um "nome". Principalmente utilizado em conjuno a
                findobj().</para>
              </listitem>
            </varlistentry>
          </variablelist>
        </listitem>
      </varlistentry>
    </variablelist>

    <variablelist>
      <varlistentry>
        <term>Valores padres para galhos: </term>

        <listitem>
          <variablelist>
            <varlistentry>
              <term>visible:</term>

              <listitem>
                <para>este campo determina se o contedo da figura deve ser
                redesenhado. O valor pode ser <literal>"on"</literal> ou
                <literal>"off"</literal>.</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>rotation_style:</term>

              <listitem>
                <para>este campo est relacionado ao boto "3D Rot". Toma
                <literal>unary</literal> como valor (padro) para rotacionar
                apenas o esboo 3d selecionado. Em outros casos o valor pode
                ser <literal>multiple</literal>: todos os esboos 3d so
                rotacionados.</para>
              </listitem>
            </varlistentry>
          </variablelist>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>Nota sobre valores padres:</term>

        <listitem>
          <para>todas estas propriedades e campos listados herdam
            valores de valores padres armazenados num modelo de figura.
            Estes valores padres podem ser vistos e salvos. Para faz-lo,
            use o comando <literal>get("default_figure")</literal>: ele
            retorna o manipulador grfico de uma figura. Note que nenhuma
            janela de grficos  criada por este comando. As prximas
            figuras criadas herdaro valores deste modelo (ver o exemplo 2
            abaixo).</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Exemplos</title>

    <programlisting role="example"><![CDATA[ 
lines(0) // desabilitando paginamento vertical
//Exemplo 1
f=get("current_figure") //obtendo o manipulador da figura corrente: 
                                           //se nenhum existir, cria uma figura e retorna o manipulador correspondente
f.figure_position
f.figure_size=[200,200]
f.background=2
f.children  // pode-se ver que uma entidade Axes j existe
delete(f);
f=gcf(); // atalho de macro  &lt;=&gt; f=get("current_figure")
f.pixmap = "on" // ajusta o status de pixmap para on
plot2d() // nada acontece na tela...
show_pixmap() // ...exibe o pixmap na tela
//Exemplo 2 : configuraes de default_figure
df=get("default_figure") // obtendo os valores padres (o atalho  gdf() )
// vamos mudar os padres...
df.color_map=hotcolormap(128)
df.background= 110 // ajustando o plano de fundo para um tipo de amarelo (note que estamos utilizando um ndice de cor dentro do mapa de cores color_map redefinido previamente)
scf(122); // criando uma nova figura de nmero122 com o novo padro
plot2d()
scf(214);
t=-%pi:0.3:%pi;
plot3d(t,t,sin(t)'*cos(t),35,45,'X@Y@Z',[15,2,4]);
 ]]></programlisting>
  </refsection>

  <refsection>
    <title>Ver Tambm</title>

    <simplelist type="inline">
      <member><link linkend="lines">lines</link></member>

      <member><link linkend="set">set</link></member>

      <member><link linkend="get">get</link></member>

      <member><link linkend="scf">scf</link></member>

      <member><link linkend="gcf">gcf</link></member>

      <member><link linkend="gdf">gdf</link></member>

      <member><link linkend="gca">gca</link></member>

      <member><link linkend="gda">gda</link></member>

      <member><link linkend="axes_properties">axes_properties</link></member>

      <member><link linkend="show_pixmap">show_pixmap</link></member>

      <member><link linkend="clear_pixmap">clear_pixmap</link></member>

      <member><link linkend="hotcolormap">hotcolormap</link></member>

      <member><link linkend="eventhandlerfunctions">event handler
      functions</link></member>
    </simplelist>
  </refsection>

  <refsection>
    <title>Autor</title>

    <para>Djalel ABDEMOUCHE</para>
  </refsection>
</refentry>