Xcos help: "Demonstrations blocks" palette examples
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Demonstrationsblocks_pal / BOUNCE.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="BOUNCE">
25     <refnamediv>
26         <refname>BOUNCE</refname>
27         <refpurpose>Balls coordinates generator</refpurpose>
28     </refnamediv>
29     <refsection>
30         <title>Block Screenshot</title>
31         <para>
32             <inlinemediaobject>
33                 <imageobject>
34                     <imagedata fileref="../../../../images/palettes/BOUNCE.png" align="center" valign="middle"/>
35                 </imageobject>
36             </inlinemediaobject>
37         </para>
38     </refsection>
39     <refsection id="Contents_BOUNCE">
40         <title>Contents</title>
41         <itemizedlist>
42             <listitem>
43                 <para>
44                     <link linkend="BOUNCE">Balls coordinates generator</link>
45                 </para>
46             </listitem>
47             <listitem>
48                 <itemizedlist>
49                     <listitem>
50                         <para>
51                             <xref linkend="Palette_BOUNCE">Palette</xref>
52                         </para>
53                     </listitem>
54                     <listitem>
55                         <para>
56                             <xref linkend="Dialogbox_BOUNCE">Dialog box</xref>
57                         </para>
58                     </listitem>
59                     <listitem>
60                         <para>
61                             <xref linkend="Defaultproperties_BOUNCE">Default properties</xref>
62                         </para>
63                     </listitem>
64                     <listitem>
65                         <para>
66                             <xref linkend="Interfacingfunction_BOUNCE">Interfacing function</xref>
67                         </para>
68                     </listitem>
69                     <listitem>
70                         <para>
71                             <xref linkend="Computationalfunction_BOUNCE">Computational function</xref>
72                         </para>
73                     </listitem>
74                 </itemizedlist>
75             </listitem>
76         </itemizedlist>
77     </refsection>
78     <refsection id="Palette_BOUNCE">
79         <title>Palette</title>
80         <itemizedlist>
81             <listitem>
82                 <para>
83                     <link linkend="Demonstrationsblocks_pal">Demonstrations blocks palette</link>
84                 </para>
85             </listitem>
86         </itemizedlist>
87     </refsection>
88     <refsection id="Dialogbox_BOUNCE">
89         <title>Dialog box</title>
90         <para>
91             <inlinemediaobject>
92                 <imageobject>
93                     <imagedata fileref="../../../../images/gui/BOUNCE_gui.gif" align="center" valign="middle"/>
94                 </imageobject>
95             </inlinemediaobject>
96         </para>
97         <para>
98             
99         </para>
100         <itemizedlist>
101             <listitem>
102                 <para>
103                     <emphasis role="bold">Mass</emphasis>
104                 </para>
105                 <para> The parameter description 1.</para>
106                 <para> Properties : Type 'vec' of size -1. </para>
107             </listitem>
108             <listitem>
109                 <para>
110                     <emphasis role="bold">Radius</emphasis>
111                 </para>
112                 <para> The parameter description 2.</para>
113                 <para> Properties : Type 'vec' of size -1. </para>
114             </listitem>
115             <listitem>
116                 <para>
117                     <emphasis role="bold">[xmin,xmax,ymin,ymax]</emphasis>
118                 </para>
119                 <para> The parameter description 3.</para>
120                 <para> Properties : Type 'vec' of size -1. </para>
121             </listitem>
122             <listitem>
123                 <para>
124                     <emphasis role="bold">xpos</emphasis>
125                 </para>
126                 <para> The parameter description 4.</para>
127                 <para> Properties : Type 'vec' of size -1. </para>
128             </listitem>
129             <listitem>
130                 <para>
131                     <emphasis role="bold">xdpos</emphasis>
132                 </para>
133                 <para> The parameter description 5.</para>
134                 <para> Properties : Type 'vec' of size -1. </para>
135             </listitem>
136             <listitem>
137                 <para>
138                     <emphasis role="bold">ypos</emphasis>
139                 </para>
140                 <para> The parameter description 6.</para>
141                 <para> Properties : Type 'vec' of size -1. </para>
142             </listitem>
143             <listitem>
144                 <para>
145                     <emphasis role="bold">ydpos</emphasis>
146                 </para>
147                 <para> The parameter description 7.</para>
148                 <para> Properties : Type 'vec' of size -1. </para>
149             </listitem>
150             <listitem>
151                 <para>
152                     <emphasis role="bold">g (gravity)</emphasis>
153                 </para>
154                 <para> The parameter description 8.</para>
155                 <para> Properties : Type 'vec' of size 1. </para>
156             </listitem>
157             <listitem>
158                 <para>
159                     <emphasis role="bold">C (aerodynamic coeff</emphasis>
160                 </para>
161                 <para> The parameter description 9.</para>
162                 <para> Properties : Type 'vec' of size 1.</para>
163             </listitem>
164         </itemizedlist>
165     </refsection>
166     <refsection id="Defaultproperties_BOUNCE">
167         <title>Default properties</title>
168         <itemizedlist>
169             <listitem>
170                 <para>
171                     <emphasis role="bold">always active:</emphasis> yes
172                 </para>
173             </listitem>
174             <listitem>
175                 <para>
176                     <emphasis role="bold">direct-feedthrough:</emphasis> no
177                 </para>
178             </listitem>
179             <listitem>
180                 <para>
181                     <emphasis role="bold">zero-crossing:</emphasis> yes
182                 </para>
183             </listitem>
184             <listitem>
185                 <para>
186                     <emphasis role="bold">mode:</emphasis> no
187                 </para>
188             </listitem>
189             <listitem>
190                 <para>
191                     <emphasis role="bold">regular outputs:</emphasis>
192                 </para>
193                 <para>
194                     <emphasis role="bold">- port 1 : size [2,1] / type 1</emphasis>
195                 </para>
196                 <para>
197                     <emphasis role="bold">- port 2 : size [2,1] / type 1</emphasis>
198                 </para>
199             </listitem>
200             <listitem>
201                 <para>
202                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
203                 </para>
204             </listitem>
205             <listitem>
206                 <para>
207                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
208                 </para>
209             </listitem>
210             <listitem>
211                 <para>
212                     <emphasis role="bold">continuous-time state:</emphasis> yes
213                 </para>
214             </listitem>
215             <listitem>
216                 <para>
217                     <emphasis role="bold">discrete-time state:</emphasis> no
218                 </para>
219             </listitem>
220             <listitem>
221                 <para>
222                     <emphasis role="bold">object discrete-time state:</emphasis> no
223                 </para>
224             </listitem>
225             <listitem>
226                 <para>
227                     <emphasis role="bold">name of computational function:</emphasis>
228                     <emphasis role="italic">bounce_ball</emphasis>
229                 </para>
230             </listitem>
231         </itemizedlist>
232     </refsection>
233     <refsection id="Interfacingfunction_BOUNCE">
234         <title>Interfacing function</title>
235         <itemizedlist>
236             <listitem>
237                 <para> SCI/modules/scicos_blocks/macros/Misc/BOUNCE.sci</para>
238             </listitem>
239         </itemizedlist>
240     </refsection>
241     <refsection id="Computationalfunction_BOUNCE">
242         <title>Computational function</title>
243         <itemizedlist>
244             <listitem>
245                 <para> SCI/modules/scicos_blocks/src/c/bounce_ball.c (Type 4)</para>
246             </listitem>
247         </itemizedlist>
248     </refsection>
249     <refsection id="Example_BOUNCE">
250         <title>BOUNCE example:</title>
251         <link type="scilab" linkend="scilab.xcos/xcos/demos/bounce.zcos">
252             <inlinemediaobject>
253                 <imageobject>
254                     <imagedata align="center" fileref="../../../../demos/bounce.zcos" valign="middle"/>
255                 </imageobject>
256             </inlinemediaobject>
257         </link>
258     </refsection>
259     <refsection>
260         <title>See Also</title>
261         <simplelist type="inline">
262             <member>
263                 <link linkend="BOUNCEXY">BOUNCEXY</link>
264             </member>
265         </simplelist>
266     </refsection>
267 </refentry>