f826cda274d6d7695da2ae38014fc93b9a6c12e6
[scilab.git] / scilab / modules / graphics / help / en_US / twinkle.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA
5  * 
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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:lang="en" xml:id="twinkle">
17     <refnamediv>
18         <refname>twinkle</refname>
19         <refpurpose>is used to have a graphics entity twinkle</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>twinkle(h,[n])</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>h</term>
30                 <listitem>
31                     <para>a handle of a graphics entity.</para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>n</term>
36                 <listitem>
37                     <para>an integer.</para>
38                 </listitem>
39             </varlistentry>
40         </variablelist>
41     </refsection>
42     <refsection>
43         <title>Description</title>
44         <para>
45             <function>twinkle</function> let the graphics entity given by its handle <varname>h</varname> twinkle. It can be used to
46             find the graphics object corresponding to a graphics handle in the graphics window. By default the graphics
47             entity twinkles 5 times, but you can change this by using optional argument <varname>n</varname>.
48         </para>
49     </refsection>
50     <refsection>
51         <title>Examples</title>
52         <programlisting role="example"><![CDATA[ 
53 x=linspace(-2*%pi,2*%pi,100)';
54 plot2d(x,[sin(x),cos(x)]);
55 e=gce();
56 p1=e.children(1);
57 p2=e.children(2);
58 // cos plot twinkle
59 twinkle(p1)
60 // sin plot twinkle 10 times
61 twinkle(p2,10)
62 // axes twinkle
63 twinkle(gca())
64  ]]></programlisting>
65     </refsection>
66     <refsection role="see also">
67         <title>See Also</title>
68         <simplelist type="inline">
69             <member>
70                 <link linkend="graphics_entities">graphics entities</link>
71             </member>
72         </simplelist>
73     </refsection>
74 </refentry>