Help build: remove the householder image demo which open scinotes
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_data_structures / blocks / scicos_graphics.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scicos
4  * 
5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  * 
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  * 
22  * See the file ./license.txt
23  -->
24 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="scicos_graphics">
25     <refnamediv>
26         <refname>scicos_graphics</refname>
27         <refpurpose>Define a graphics structure</refpurpose>
28     </refnamediv>
29     <refsection id="Module_scicos_graphics">
30         <title>Module</title>
31         <itemizedlist>
32             <listitem>
33                 <para>
34                     <link linkend="xcos">xcos</link>
35                 </para>
36             </listitem>
37         </itemizedlist>
38     </refsection>
39     <refsection id="graphics_scicos_graphics">
40         <title>graphics</title>
41         <para>
42             Scilab object including
43             graphical information concerning
44             the features of the block.
45         </para>
46         <para>
47         </para>
48         <para>
49         </para>
50         <para>
51             Size : 14.
52         </para>
53         <para>
54             Type : scilab list.
55         </para>
56         <para>
57             
58         </para>
59         <itemizedlist>
60             <listitem>
61                 <para>
62                     <emphasis role="bold">orig</emphasis>
63                 </para>
64                 <para> Vector [xo,yo], where xo is the x coordinate of the block origin and yo is the y coordinate of the block origin.</para>
65                 <para> 
66                     [xo,yo] is the coordinate of down-left point of
67                     the block shape.
68                 </para>
69                 <para>
70                 </para>
71                 <para> 
72                     Size : 2.
73                 </para>
74                 <para>
75                     Type : row vector of real.
76                 </para>
77             </listitem>
78             <listitem>
79                 <para>
80                     <emphasis role="bold">sz</emphasis>
81                 </para>
82                 <para> Vector [w,h], where w is the block width and h the block height.</para>
83                 <para> 
84                     Size : 2.
85                 </para>
86                 <para>
87                     Type : row vector of real.
88                 </para>
89             </listitem>
90             <listitem>
91                 <para>
92                     <emphasis role="bold">flip</emphasis>
93                 </para>
94                 <para> Set the block orientation. If true the input ports are on the left of the box and output ports are on the right.</para>
95                 <para> If false the input ports are on the right of the box and output ports are on the left.</para>
96                 <para> 
97                     Size : 1.
98                 </para>
99                 <para>
100                     Type : boolean.
101                 </para>
102             </listitem>
103             <listitem>
104                 <para>
105                     <emphasis role="bold">theta</emphasis>
106                 </para>
107                 <para> Set the angle of the Scicos object.</para>
108                 <para> This value is in degree and is included in [-360,360].</para>
109                 <para> 
110                     Size : 1.
111                 </para>
112                 <para>
113                     Type : real.
114                 </para>
115             </listitem>
116             <listitem>
117                 <para>
118                     <emphasis role="bold">exprs</emphasis>
119                 </para>
120                 <para> Strings including formal expressions used in the dialog box of the block.</para>
121                 <para> 
122                     Size : number of formal expressions.
123                 </para>
124                 <para>
125                     Type : column vector of strings.
126                 </para>
127             </listitem>
128             <listitem>
129                 <para>
130                     <emphasis role="bold">pin</emphasis>
131                 </para>
132                 <para> Vector. pin(i) is the number of the link connected to the ith regular input port (counting from one), or 0 if this port is not connected.</para>
133                 <para> 
134                     Size : number of regular input ports.
135                 </para>
136                 <para>
137                     Type : column vector of integers.
138                 </para>
139             </listitem>
140             <listitem>
141                 <para>
142                     <emphasis role="bold">pout</emphasis>
143                 </para>
144                 <para> Vector. pout(i) is the number of the link connected to the ith regular output port (counting from one), or 0 if this port is not connected.</para>
145                 <para> 
146                     Size : number of regular output ports.
147                 </para>
148                 <para>
149                     Type : column vector of integers.
150                 </para>
151             </listitem>
152             <listitem>
153                 <para>
154                     <emphasis role="bold">pein</emphasis>
155                 </para>
156                 <para> Vector. pein(i) is the number of the link connected to the ith event input port (counting from one), or 0 if this port is not connected.</para>
157                 <para> 
158                     Size : number of events input ports.
159                 </para>
160                 <para>
161                     Type : column vector of integers.
162                 </para>
163             </listitem>
164             <listitem>
165                 <para>
166                     <emphasis role="bold">peout</emphasis>
167                 </para>
168                 <para> Vector. peout(i) is the number of the link connected to the ith event output port (counting from one), or 0 if this port is not connected.</para>
169                 <para> 
170                     Size : number of events output ports.
171                 </para>
172                 <para>
173                     Type : column vector of integers.
174                 </para>
175             </listitem>
176             <listitem>
177                 <para>
178                     <emphasis role="bold">gr_i</emphasis>
179                 </para>
180                 <para> Strings including Scilab graphics expressions for customizing the block graphical aspect. This field may be set with Icon sub_menu.</para>
181                 <para> 
182                     Size : -.
183                 </para>
184                 <para>
185                     Type : column vector of strings.
186                 </para>
187             </listitem>
188             <listitem>
189                 <para>
190                     <emphasis role="bold">id</emphasis>
191                 </para>
192                 <para> A string including an identification for the block. The string is displayed under the block in the diagram.</para>
193                 <para> 
194                     Size : 1.
195                 </para>
196                 <para>
197                     Type : string.
198                 </para>
199             </listitem>
200             <listitem>
201                 <para>
202                     <emphasis role="bold">in_implicit</emphasis>
203                 </para>
204                 <para> A vector of strings including 'E' or 'I'.</para>
205                 <para> 'E' and 'I' stand respectively for explicit and implicit port, and this vector indicates the nature of each input port. For regular blocks (not implicit), this vector is empty or contains only "E".</para>
206                 <para> 
207                     Size : nul or number of regular input ports.
208                 </para>
209                 <para>
210                     Type : column vector of strings.
211                 </para>
212             </listitem>
213             <listitem>
214                 <para>
215                     <emphasis role="bold">out_implicit</emphasis>
216                 </para>
217                 <para> A vector of strings including 'E' or 'I'.</para>
218                 <para> 'E' and 'I' stand respectively for explicit and implicit port, and this vector indicates the nature of each output port. For regular blocks (not implicit), this vector is empty or contains only "E".</para>
219                 <para> 
220                     Size : nul or number of regular output ports.
221                 </para>
222                 <para>
223                     Type : column vector of strings.
224                 </para>
225             </listitem>
226             <listitem>
227                 <para>
228                     <emphasis role="bold">in_style</emphasis>
229                 </para>
230                 <para> A vector of strings including JGraphX key values style properties.</para>
231                 <para>
232                     These style can be used to place text or to change port aspect (eg. round, green port). This is set in semicolon separated key=value set. For example <literal>"shape=ellipse;fillColor=green"</literal> for a round and green port
233                 </para>
234                 <para> 
235                     Size : nul or number of regular input ports.
236                 </para>
237                 <para>
238                     Type : column vector of strings.
239                 </para>
240             </listitem>
241             <listitem>
242                 <para>
243                     <emphasis role="bold">out_style</emphasis>
244                 </para>
245                 <para> A vector of strings including JGraphX key values style properties.</para>
246                 <para>
247                     These style can be used to place text or to change port aspect (eg. round, green port). This is set in semicolon separated key=value set. For example <literal>"shape=ellipse;fillColor=green"</literal> for a round and green port
248                 </para>
249                 <para> 
250                     Size : nul or number of regular output ports.
251                 </para>
252                 <para>
253                     Type : column vector of strings.
254                 </para>
255             </listitem>
256             <listitem>
257                 <para>
258                     <emphasis role="bold">in_label</emphasis>
259                 </para>
260                 <para> A vector of strings including ports labels.</para>
261                 <para>These labels can be used to update text or to trace information.</para>
262                 <para> 
263                     Size : nul or number of regular input ports.
264                 </para>
265                 <para>
266                     Type : column vector of strings.
267                 </para>
268             </listitem>
269             <listitem>
270                 <para>
271                     <emphasis role="bold">out_label</emphasis>
272                 </para>
273                 <para> A vector of strings including ports labels.</para>
274                 <para>These labels can be used to update text or to trace information.</para>
275                 <para> 
276                     Size : nul or number of regular output ports.
277                 </para>
278                 <para>
279                     Type : column vector of strings.
280                 </para>
281             </listitem>
282             <listitem>
283                 <para>
284                     <emphasis role="bold">style</emphasis>
285                 </para>
286                 <para> A string.</para>
287                 <para> A vector of strings including JGraphX key values style properties.</para>
288                 <para>
289                     These style can be used to place text or to change block aspect (eg. shape, image, text). This is set in semicolon separated key=value set. For example <literal>"shape=ellipse;fillColor=red"</literal> for a round and green block
290                 </para>
291                 <para> 
292                     Size : nul or 1.
293                 </para>
294                 <para>
295                     Type : a string.
296                 </para>
297             </listitem>
298         </itemizedlist>
299     </refsection>
300     <refsection id="Filecontent_scicos_graphics">
301         <title>File content</title>
302         <itemizedlist>
303             <listitem>
304                 <para> SCI/modules/scicos/macros/scicos_scicos/scicos_graphics.sci</para>
305             </listitem>
306         </itemizedlist>
307     </refsection>
308 </refentry>