<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) ENPC - Jean-Philippe Chancelier
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * 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:ns3="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="xarrows" xml:lang="pt">
    <refnamediv>
        <refname>xarrows</refname>
        <refpurpose>desenha um conjunto de setas</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Seqüência de Chamamento</title>
        <synopsis>xarrows(nx, ny, [arsize, color])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Parâmetros</title>
        <variablelist>
            <varlistentry>
                <term>nx,ny</term>
                <listitem>
                    <para>vetores ou matrizes de reais de mesmo tamanho </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>arsize</term>
                <listitem>
                    <para>escalar real, o tamanho da cabeça da seta. O tamanho padrão
                        pode ser obtido ajustando <varname>arsize</varname> para -1.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>color</term>
                <listitem>
                    <para>
                        matriz ou escalar. Se <varname>color</varname> for um escalar
                        positivo, fornece a cor a ser usada em todas as setas. Se for
                        negativo, a cor corrente é utilizada. Se for um vetor
                        <literal>color(i)</literal> fornece a cor a ser utilizada no vetor
                        <literal>i</literal>.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Descrição</title>
        <para>
            <function>xarrows</function> desenha um conjunto de setas dadas por
            <varname>nx</varname> e <varname>ny</varname>. Se <varname>nx</varname> e
            <varname>ny</varname> forem vetores, a i-ésima seta é definida por
            <literal>(nx(i),ny(i))--&gt;(nx(i+1),ny(i+1))</literal>. Se
            <varname>nx</varname> e <varname>ny</varname> são matrizes:
        </para>
        <programlisting role=""><![CDATA[
nx=[xi_1 x1_2 ...; xf_1 xf_2 ...]
ny=[yi_1 y1_2 ...; yf_1 yf_2 ...]
 ]]></programlisting>
        <para>
            a <literal>k</literal>-ésima seta é definida por
            <literal>(xi_k,yi_k)--&gt;(xf_k,yf_k)</literal>.
        </para>
        <para>
            <function>xarrows</function> utiliza a escala de gráficos corrente que
            pode ser ajustada através de uma chamada a uma função de esboço de
            alto-nível como <function>plot2d</function>.
        </para>
    </refsection>
    <refsection>
        <title>Exemplos</title>
        <programlisting role="example"><![CDATA[
x = 2*%pi*(0:7)/8
x1 = [sin(x); 9*sin(x)];
y1 = [cos(x); 9*cos(x)];
plot2d([-10,10], [-10,10], [-1,-1], "022")
gca().clip_state = "clipgrf";
xarrows(x1, y1, -1, [1:7,9]) //8-th color is white
gca().clip_state = "off";
 ]]></programlisting>
        <scilab:image>
            x = 2*%pi*(0:7)/8
            x1 = [sin(x); 9*sin(x)];
            y1 = [cos(x); 9*cos(x)];
            plot2d([-10,10], [-10,10], [-1,-1], "022")
            gca().clip_state = "clipgrf";
            xarrows(x1, y1, -1, [1:7,9])
            gca().clip_state = "off";
        </scilab:image>
    </refsection>
</refentry>
