File: rectangle_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 (328 lines) | stat: -rw-r--r-- 11,039 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
<?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="rectangle_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:ns3="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>rectangle_properties</refname>

    <refpurpose>Descrio de propriedades da entidade Rectangle
    (retngulo)</refpurpose>
  </refnamediv>

  <refsection>
    <title>Descrio</title>

    <para>A entidade Rectangle  uma folha na hierarquia de entidades
    grficas. Esta entidade define parmetros para retngulos preenchidos ou
    no.</para>

    <variablelist>
      <varlistentry>
        <term>parent:</term>

        <listitem>
          <para>esta propriedade contm o manipulador da raiz. A raiz de uma
          entidade Rectangle deve ser do tipo <literal>"Axes"</literal> ou
          <literal>"Compound"</literal>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>children:</term>

        <listitem>
          <para>esta propriedade contm um vetor com os galhos do manipulador.
          Contudo, manipuladores rectangle no possuem galhos correntemente.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>mark_mode:</term>

        <listitem>
          <para>este campo contm o valor padro da propriedade
          <literal>mark_mode</literal> para a poligonal. Deve ser
          <literal>"on"</literal> (marcas desenhadas) ou
          <literal>"off"</literal> (nenhuma marca desenhada). </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>mark_style:</term>

        <listitem>
          <para>a propriedade <literal>mark_style</literal>  utilizada para
          selecionar o tipo de marca utilizada quando a propriedade
          <literal>mark_mode</literal>  <literal>"on"</literal>. O valor  um
          inteiro em [0 14] que significa: ponto, sinal de mais, cruz,
          estrela, rombo preenchido, rombo, tringulo para cima, tringulo
          para baixo, rombo mais, crculo, astersco, quadrado, tringulo para
          direita, tringulo para esquerda e pentagrama.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>mark_size_unit:</term>

        <listitem>
          <para>este campo contm o valor padro da propriedade
          <literal>mark_size_unit</literal> property value. Se
          <literal>mark_size_unit</literal> for ajustado para
          <literal>"point"</literal>, ento o valor de
          <literal>mark_size</literal>  diretamente dado em pontos. Quando
          <literal>mark_size_unit</literal>  ajustado para
          <literal>"tabulated"</literal>, <literal>mark_size</literal> 
          computado em relao ao array de tamanho de fonte: logo, seu valor
          deve ser um inteiro em [0 5] que significa 8pt, 10pt, 12pt, 14pt,
          18pt e 24pt. Note que <link linkend="xrect">xrect</link> como
          padro; quando se utiliza a funo <literal>tabulated</literal> como
          padro; quando se utiliza a funo <link linkend="plot">plot</link>
          o modo <literal>point</literal>  automaticamente habilitado.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>mark_size:</term>

        <listitem>
          <para>A propriedade <literal>mark_size</literal>  utilizada para
          escolher o tamanho das marcas quando a propriedade
          <literal>mark_mode</literal>  <literal>"on"</literal>. Deve ser um
          valor inteiro em [0 5] que significa 8pt, 10pt, 12pt, 14pt, 18pt e
          24pt.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>mark_foreground:</term>

        <listitem>
          <para>este campo contm o valor da propriedade
          <literal>mark_foreground</literal> que  a cor da borda das marcas.
          O valor deve ser um ndice de cor (relativo ao mapa de cores
          corrente).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>mark_background:</term>

        <listitem>
          <para>este campo contm o valor da propriedade
          <literal>mark_background</literal> que  a cor da face das marcas. O
          valor deve ser um ndice de cor (relativo ao mapa de cores
          corrente).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>line_mode:</term>

        <listitem>
          <para>este campo contm o valor padro da propriedade
          <literal>line_mode</literal> para a poligonal. O valor pode ser
          <literal>"on" </literal>(linha desenhada) ou
          <literal>"off"</literal> (nenhuma linha desenhada). </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>fill_mode:</term>

        <listitem>
          <para>Se o valor da propriedade <literal>fill_mode</literal> 
          <literal>"on"</literal>, o retngulo  preenchido com a cor de
          primeiro plano, <literal>mark_mode</literal> tambm deve ter valor
          <literal>"off"</literal>. Seno, o valor da propriedade 
          <literal>"off"</literal> apenas a forma o contorno do retngulo 
          desenhado utilizando-se a cor de primeiro plano. </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>line_style:</term>

        <listitem>
          <para>a propriedade <literal>line_style</literal> deve ser um
          inteiro em [1 6]. 1 stands significa linha slida, o restante
          seleciona tracejados. </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>thickness:</term>

        <listitem>
          <para>este campo contm o valor padro da propriedade
          <literal>thickness</literal> (espessura) da linha. Deve ser um
          inteiro positivo. </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>foreground:</term>

        <listitem>
          <para>este campo contm a cor utilizada para desenhar a linha de
          contorno do retngulo. Seu valor deve ser um ndice de cor (relativo
          ao mapa de cores corrente). </para>
        </listitem>
      </varlistentry>

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

        <listitem>
          <para>este campo contm a cor utilizada para preencher a parte
          interna do retngulo. Seu valor deve ser um ndice de cor (relativo
          ao mapa de cores corrente). </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>data:</term>

        <listitem>
          <para>esta propriedade retorna as coordenadas do ponto superior
          esquerdo do retngulo, sua altura e largura em unidades de dados dos
          eixos. O resultado  uma matriz
          <literal>[xleft,yup,[zup],width,height]</literal></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>visible:</term>

        <listitem>
          <para>este campo contm o valor da propriedade
          <literal>visible</literal> para a entidade. Pode ser <literal>"on"
          </literal> ou <literal>"off"</literal> . Por padro, o retngulo 
          visvel, a propriedade  <literal>"on"</literal>. Se
          <literal>"off"</literal> o retngulo no  exibido na tela.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>clip_state:</term>

        <listitem>
          <para>este campo contm o valor da propriedade
          <literal>clip_state</literal> para o retngulo. o valor de
          clip_state pode ser :</para>

          <itemizedlist>
            <listitem>
              <para><literal>"off"</literal> ignifica que o retngulo no 
              recortado. </para>
            </listitem>

            <listitem>
              <para><literal>"clipgrf"</literal> significa que o retngulo 
              recortado fora da caixa dos eixos. </para>
            </listitem>

            <listitem>
              <para><literal>"on"</literal> significa que o retngulo 
              recortado fora do retngulo dado pela propriedade
              clip_box.</para>
            </listitem>
          </itemizedlist>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>clip_box:</term>

        <listitem>
          <para>este campo determina a propriedade <literal>clip_box</literal>
          property. Por padro seu valor  uma matriz vazia se a propriedade
          clip_state  "off". Em outros casos, o vetor
          <literal>[x,y,w,h]</literal> (ponto superior esquerdo, largura,
          altura) define as pores do retngulo a ser exibido, contudo o
          valor da propriedade <literal>clip_state</literal> ser
          alterado.</para>
        </listitem>
      </varlistentry>

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

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

  <refsection>
    <title>Exemplos</title>

    <programlisting role="example"><![CDATA[ 
a=get("current_axes");//obtendo o manipulador dos novos eixos criados
a.data_bounds=[-2,-2;2,2];

xrect(-1,1,2,2)

r=get("hdl");//obtendo o manipulador da entidade corrente (aqui, a entidade Rectangle)
r.type
r.parent.type
r.foreground=13;
r.line_style=2;
r.fill_mode="on";
r.background=color('red');
r.clip_box=[-1 1;1 1];
r.data(:,[3 4])=[1/2 1/2];
r.data(:,[1 2])=[1/2 1/2];
r.clip_state="off"
 ]]></programlisting>
  </refsection>

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

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

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

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

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

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

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

      <member><link
      linkend="graphics_entities">graphics_entities</link></member>
    </simplelist>
  </refsection>

  <refsection>
    <title>Autor</title>

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