<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://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: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="xfarc">
    <refnamediv>
        <refname>xfarc</refname>
        <refpurpose>Fill a part of an ellipse</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>xfarc(x,y,w,h,a1,a2)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>x,y,w,h</term>
                <listitem>
                    <para>four real values defining a rectangle.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>a1,a2</term>
                <listitem>
                    <para>real values defining a sector.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>xfarc</literal> fills a part of an ellipse contained in the rectangle
            <literal>(x,y,w,h)</literal>
            (upper-left point, width, height), and in the sector defined by
            the angle <literal>alpha1</literal> and the angle <literal>alpha1+alpha2</literal>.
            <literal>alpha1</literal> and <literal>alpha2</literal> are
            given respectively by <literal>a1/64</literal> degrees and <literal>a2/64</literal> degrees.
            This function uses the current color and user coordinates.
        </para>
        <para>If a2 is equal to 360*64, a complete circle will be drawn.</para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
// isoview scaling
plot2d(0,0,-1,"031"," ",[-2,-2,2,2])
xfarc(-0.5,0.5,1,1,0,90*64)
xfarc(0.5,0.5,1,1,0,360*64)
gce().background = 2;
 ]]></programlisting>
        <scilab:image>
            // isoview scaling
            plot2d(0,0,-1,"031"," ",[-2,-2,2,2])
            xfarc(-0.5,0.5,1,1,0,90*64)
            xfarc(0.5,0.5,1,1,0,360*64)
            gce().background = 2;
        </scilab:image>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="xarc">xarc</link>
            </member>
            <member>
                <link linkend="xarcs">xarcs</link>
            </member>
            <member>
                <link linkend="xfarcs">xfarcs</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
