php-doc-en/reference/cairo/cairofillrule.xml
2012-01-03 07:06:01 +00:00

113 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.cairofillrule" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The CairoFillRule class</title>
<titleabbrev>CairoFillRule</titleabbrev>
<partintro>
<!-- {{{ CairoFillRule intro -->
<section xml:id="cairofillrule.intro">
&reftitle.intro;
<para>
A <classname>CairoFillRule</classname> is used to select how paths are filled. For both fill rules, whether or not a
point is included in the fill is determined by taking a ray from that point to infinity and looking at intersections
with the path. The ray can be in any direction, as long as it doesn't pass through the end point of a segment or have
a tricky intersection such as intersecting tangent to the path. (Note that filling is not actually implemented in
this way. This is just a description of the rule that is applied.)
</para>
<para>
The default fill rule is <constant>CairoFillRule::WINDING</constant>.
</para>
</section>
<!-- }}} -->
<section xml:id="cairofillrule.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>CairoFillRule</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>CairoFillRule</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairofillrule.constants.winding">CairoFillRule::WINDING</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairofillrule.constants.even-odd">CairoFillRule::EVEN_ODD</varname>
<initializer>1</initializer>
</fieldsynopsis>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ CairoFillRule constants -->
<section xml:id="cairofillrule.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="cairofillrule.constants.winding">
<term><constant>CairoFillRule::WINDING</constant></term>
<listitem>
<para>If the path crosses the ray from left-to-right, counts +1. If the path crosses the ray from right to left,
counts -1. (Left and right are determined from the perspective of looking along the ray from the starting point.)
If the total count is non-zero, the point will be filled.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairofillrule.constants.even-odd">
<term><constant>CairoFillRule::EVEN_ODD</constant></term>
<listitem>
<para>Counts the total number of intersections, without regard to the orientation of the contour.
If the total number of intersections is odd, the point will be filled. </para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
</phpdoc:classref>
<!-- 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
-->