<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 * Copyright (C) 2015, 2016, 2018 - Samuel GOUGEON
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<refentry 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"
        xmlns:scilab="http://www.scilab.org" xml:id="twinkle" xml:lang="pt">
    <refnamediv>
        <refname>twinkle</refname>
        <refpurpose>Faz uma entidade gráfica piscar</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Seqüência de Chamamento</title>
        <synopsis>
            twinkle
            twinkle(n)
            twinkle(h)
            twinkle(h,n)
        </synopsis>
    </refsynopsisdiv>
    <refsection role="arguments">
        <title>Parâmetros</title>
        <variablelist>
            <varlistentry>
                <term>h</term>
                <listitem>
                    <para>
                    identificador ou vetor de identificadores de uma ou várias entidades gráficas
                    para piscar. Por padrão, a entidade gráfica atual apontada por
                    <literal>gce()</literal> é considerada.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>n</term>
                <listitem>
                    <para>número de flashes. Por padrão, n = 5</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection role="description">
        <title>Descrição</title>
        <para>
            <function>twinkle</function> pisca <varname>n</varname> times objects
            gráficos cujos identificadores são especificados em <varname>h</varname>.
            Se alguns dos objetos são inicialmente invisíveis, eles piscam com o
            outros, tornam-se invisíveis novamente após o relâmpago.
        </para>
        <para>
            If <function>twinkle()</function> is run while no graphical figure exists,
            it does nothing and returns. If the handle <varname>h</varname> has some invalid
            components (the entity has been deleted in the meantime),
            <function>twinkle(h..)</function> yields an error.
        </para>
    </refsection>
    <refsection role="examples">
        <title>Exemplos</title>
        <programlisting role="example"><![CDATA[
clf
plot()
twinkle     // twinkles the last group of curves plotted in the plot() example
twinkle(3)  // twinkles it only three times

clf
x = linspace(-2*%pi,2*%pi,100)';
plot2d(x,[sin(x),cos(x)]);
e = gce();
p1 = e.children(1);
p2 = e.children(2);
twinkle(p1)     // fazendo piscar o esboço de cos
twinkle(p2,10)  // fazendo piscar o esboço de sin piscar
twinkle(gca())  // eixos piscando
 ]]></programlisting>
    <para/>
        <programlisting role="example"><![CDATA[
// Blinking a subset of many curves, with some initially invisible ones
clf
plot()
c = gca().children.children(1:10);
c(1:5).visible = "off";
sleep(5,'s')
twinkle(c)
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Ver Também</title>
        <simplelist type="inline">
            <member>
                <link linkend="graphics_entities">graphics_entities</link>
            </member>
        </simplelist>
    </refsection>
    <refsection role="history">
        <title>Histórico</title>
        <revhistory>
            <revision>
                <revnumber>6.0</revnumber>
                <revdescription>
                    <para>twinkle() and twinkle(n) added.</para>
                </revdescription>
            </revision>
            <revision>
                <revnumber>6.1</revnumber>
                <revdescription>
                    <para>Several independent objects can now be blinked together.</para>
                </revdescription>
            </revision>
        </revhistory>
    </refsection>
</refentry>
