imagefilledarc.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imagefilledarc" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imagefilledarc</refname>
  <refpurpose>Draw a partial arc and fill it</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>imagefilledarc</methodname>
   <methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
   <methodparam><type>int</type><parameter>center_x</parameter></methodparam>
   <methodparam><type>int</type><parameter>center_y</parameter></methodparam>
   <methodparam><type>int</type><parameter>width</parameter></methodparam>
   <methodparam><type>int</type><parameter>height</parameter></methodparam>
   <methodparam><type>int</type><parameter>start_angle</parameter></methodparam>
   <methodparam><type>int</type><parameter>end_angle</parameter></methodparam>
   <methodparam><type>int</type><parameter>color</parameter></methodparam>
   <methodparam><type>int</type><parameter>style</parameter></methodparam>
  </methodsynopsis>
  <para>
   Draws a partial arc centered at the specified coordinate in the
   given <parameter>image</parameter>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &gd.image.description;
    <varlistentry>
     <term><parameter>center_x</parameter></term>
     <listitem>
      <para>
       x-coordinate of the center.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>center_y</parameter></term>
     <listitem>
      <para>
       y-coordinate of the center.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>width</parameter></term>
     <listitem>
      <para>
       The arc width.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>height</parameter></term>
     <listitem>
      <para>
       The arc height.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>start_angle</parameter></term>
     <listitem>
      <para>
       The arc start angle, in degrees.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>end_angle</parameter></term>
     <listitem>
      <para>
       The arc end angle, in degrees.
       0° is located at the three-o'clock position, and the arc is drawn
       clockwise.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>color</parameter></term>
     <listitem>
      <para>
       &gd.identifier.color;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>style</parameter></term>
     <listitem>
      <para>
       A bitwise OR of the following possibilities:
       <orderedlist>
        <listitem><simpara><constant>IMG_ARC_PIE</constant></simpara></listitem>
        <listitem><simpara><constant>IMG_ARC_CHORD</constant></simpara></listitem>
        <listitem><simpara><constant>IMG_ARC_NOFILL</constant></simpara></listitem>
        <listitem><simpara><constant>IMG_ARC_EDGED</constant></simpara></listitem>
       </orderedlist>
       <constant>IMG_ARC_PIE</constant> and <constant>IMG_ARC_CHORD</constant> are
       mutually exclusive; <constant>IMG_ARC_CHORD</constant> just
       connects the starting and ending angles with a straight line, while
       <constant>IMG_ARC_PIE</constant> produces a rounded edge.
       <constant>IMG_ARC_NOFILL</constant> indicates that the arc
       or chord should be outlined, not filled.  <constant>IMG_ARC_EDGED</constant>,
       used together with <constant>IMG_ARC_NOFILL</constant>, indicates that the
       beginning and ending angles should be connected to the center - this is a
       good way to outline (rather than fill) a 'pie slice'.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &gd.changelog.image-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Creating a 3D looking pie</title>
    <programlisting role="php">
<![CDATA[
<?php

// create image
$image = imagecreatetruecolor(100, 100);

// allocate some colors
$white    = imagecolorallocate($image, 0xFF, 0xFF, 0xFF);
$gray     = imagecolorallocate($image, 0xC0, 0xC0, 0xC0);
$darkgray = imagecolorallocate($image, 0x90, 0x90, 0x90);
$navy     = imagecolorallocate($image, 0x00, 0x00, 0x80);
$darknavy = imagecolorallocate($image, 0x00, 0x00, 0x50);
$red      = imagecolorallocate($image, 0xFF, 0x00, 0x00);
$darkred  = imagecolorallocate($image, 0x90, 0x00, 0x00);

// make the 3D effect
for ($i = 60; $i > 50; $i--) {
   imagefilledarc($image, 50, $i, 100, 50, 0, 45, $darknavy, IMG_ARC_PIE);
   imagefilledarc($image, 50, $i, 100, 50, 45, 75 , $darkgray, IMG_ARC_PIE);
   imagefilledarc($image, 50, $i, 100, 50, 75, 360 , $darkred, IMG_ARC_PIE);
}

imagefilledarc($image, 50, 50, 100, 50, 0, 45, $navy, IMG_ARC_PIE);
imagefilledarc($image, 50, 50, 100, 50, 45, 75 , $gray, IMG_ARC_PIE);
imagefilledarc($image, 50, 50, 100, 50, 75, 360 , $red, IMG_ARC_PIE);


// flush image
header('Content-type: image/png');
imagepng($image);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <mediaobject>
     <alt>Output of example : Creating a 3D looking pie</alt>
     <imageobject>
      <imagedata fileref="en/reference/image/figures/imagefilledarc.png"/>
     </imageobject>
    </mediaobject>
   </example>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->