- initial import
- initial import
git-svn-id: https://siedziba.pl:790/svn/repos/php-imlib/trunk@7 455248ca-bdda-0310-9134-f4ebb693071a
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- Generated with PHPDoc, http://www.phpdoc.de -->
<html>
<head>
<title>PHP Imlib2 Classes - Imlib - Class: ImlibPoly</title>
<link href="phpdoc.css" rel="stylesheet" type="text/css">
</head>
<body>
<table width="100%" border="0">
<tr>
<td align="left" valign="top" bgcolor="#B0BAFF">
<table width="100%">
<tr>
<td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td>
<td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td>
<td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td>
<td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td>
<td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td>
<td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td>
</tr>
</table>
</td>
</tr>
<tr>
<td height="20" align="left" valign="top"><hr></td>
</tr>
<tr>
<td align="left" valign="top">
File: <a href="file:///home/matt/src/cvs/imlib/docs/class.ImlibPoly.php" target="_new">/home/matt/src/cvs/imlib/docs/class.ImlibPoly.php</a>
<h5>PHP Imlib2 Classes - Imlib</h5>
<h1>ImlibPoly</h1>
<a href="ImlibColor.html">ImlibColor</a><br> |<br> +-- <a href="ImlibCliprect.html">ImlibCliprect</a><br> |<br> +-- ImlibPoly<br>
<p>
Does everything relevant to creating and drawing or filling an n-point polygon
<p>
</td>
</tr>
<tr>
<td align="left" valign="top">
<h4>public class ImlibPoly extends <a href="ImlibCliprect.html">ImlibCliprect</a></h4>
Does everything relevant to creating and drawing or filling an n-point polygon
<br>
The routine for getting a polygon onto an image is generally to create one,add all its points (The order in which the points are added determines howthe polygon will be drawn), set the image to draw on, and draw.
<p>
<table>
<tr><td align="left" valign="top">Authors</td><td align="left" valign="top">Matt McClanahan <<a href="mailto:cardinal@dodds.net">cardinal@dodds.net</a>></td></tr>
<tr><td align="left" valign="top">Version</td><td align="left" valign="top">0.3</td></tr>
</table>
</td>
</tr>
<tr>
<td height="10" align="left" valign="top"> </td>
</tr>
<tr>
<td height="20" align="left" valign="top"><hr></td>
</tr>
<tr>
<td align="left" valign="top">
<table width="100%" border="0">
<tr>
<td align="left" valign="top"><h3>Methods inherited from ImlibCliprect</h3></td>
</tr>
<tr>
<td align="left" valign="top"><a href="ImlibCliprect.html#function_imlibcliprect">imlibcliprect</a>, <a href="ImlibCliprect.html#function_get_cliprect">get_cliprect</a>, <a href="ImlibCliprect.html#function_get_cliprect_array">get_cliprect_array</a>, <a href="ImlibCliprect.html#function_get_cliprect_inuse">get_cliprect_inuse</a>, <a href="ImlibCliprect.html#function_set_cliprect">set_cliprect</a>, <a href="ImlibCliprect.html#function_set_cliprect_array">set_cliprect_array</a>, <a href="ImlibCliprect.html#function_set_cliprect_inuse">set_cliprect_inuse</a></td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">
<table width="100%" border="0">
<tr>
<td align="left" valign="top"><h3>Methods inherited from ImlibColor</h3></td>
</tr>
<tr>
<td align="left" valign="top"><a href="ImlibColor.html#function_imlibcolor">imlibcolor</a>, <a href="ImlibColor.html#function_get_color">get_color</a>, <a href="ImlibColor.html#function_get_color_array">get_color_array</a>, <a href="ImlibColor.html#function_set_color">set_color</a>, <a href="ImlibColor.html#function_set_color_array">set_color_array</a></td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">
<table width="100%" border="0">
<tr>
<td colspan="2" align="left" valign="top"><h2>Public Method Summary</h2></td>
</tr>
<tr>
<td align="right" valign="top">void</td>
<td align="left" valign="top" width="100%"><a href="#function_ImlibPoly()"><h4>ImlibPoly()</h4></a>ImlibPoly constructor</td>
</tr>
<tr>
<td align="right" valign="top">bool</td>
<td align="left" valign="top" width="100%"><a href="#function_add_point()"><h4>add_point(int $x, int $y)</h4></a>Add a point to the current polygon</td>
</tr>
<tr>
<td align="right" valign="top">bool</td>
<td align="left" valign="top" width="100%"><a href="#function_contains_point()"><h4>contains_point(int $x, int $y)</h4></a>Checks if the current polygon contains a given point</td>
</tr>
<tr>
<td align="right" valign="top">bool</td>
<td align="left" valign="top" width="100%"><a href="#function_draw()"><h4>draw([ integer $closed ])</h4></a>Draw the current polygon on the current image</td>
</tr>
<tr>
<td align="right" valign="top">bool</td>
<td align="left" valign="top" width="100%"><a href="#function_fill()"><h4>fill()</h4></a>Fill the current polygon on the current image</td>
</tr>
<tr>
<td align="right" valign="top">bool</td>
<td align="left" valign="top" width="100%"><a href="#function_free()"><h4>free()</h4></a>Free the current polygon</td>
</tr>
<tr>
<td align="right" valign="top">bool</td>
<td align="left" valign="top" width="100%"><a href="#function_get_bounds()"><h4>get_bounds(int &$x1, int &$y1, int &$x2, int &$y2)</h4></a>Get the bounds of the polygon</td>
</tr>
<tr>
<td align="right" valign="top">int</td>
<td align="left" valign="top" width="100%"><a href="#function_get_image()"><h4>get_image()</h4></a>Get the current image resource id#</td>
</tr>
<tr>
<td align="right" valign="top">int</td>
<td align="left" valign="top" width="100%"><a href="#function_new_poly()"><h4>new_poly()</h4></a>Create a new polygon</td>
</tr>
<tr>
<td align="right" valign="top">void</td>
<td align="left" valign="top" width="100%"><a href="#function_set_image()"><h4>set_image(int $im)</h4></a>Set the image resource id# to draw on</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">
<table width="100%" border="0">
<tr>
<td align="left" valign="top"><h3>Fields inherited from ImlibCliprect</h3></td>
</tr>
<tr>
<td align="left" valign="top"><a href="ImlibCliprect.html#variable_$cliprect">$cliprect</a>, <a href="ImlibCliprect.html#variable_$cliprect_inuse">$cliprect_inuse</a></td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">
<table width="100%" border="0">
<tr>
<td align="left" valign="top"><h3>Fields inherited from ImlibColor</h3></td>
</tr>
<tr>
<td align="left" valign="top"><a href="ImlibColor.html#variable_$color">$color</a></td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">
<table width="100%" border="0">
<tr>
<td colspan="2" align="left" valign="top"><h2>Private Field Summary</h2></td>
</tr>
<tr>
<td align="right" valign="top">unknown</td>
<td align="left" valign="top" width="100%"><a href="#variable_$im"><h4>$im</h4></a>Resource id# of the image to draw on</td>
</tr>
<tr>
<td align="right" valign="top">unknown</td>
<td align="left" valign="top" width="100%"><a href="#variable_$poly"><h4>$poly</h4></a>The resource id# of the current polygon</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">
<table width="100%" border="0">
<tr>
<td colspan="2" align="left" valign="top"><h2>Public Method Details</h2></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_ImlibPoly()"><h4>ImlibPoly</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public void ImlibPoly( )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
ImlibPoly constructor
<br>
<p>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>void <p></td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_add_point()"><h4>add_point</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public bool add_point( int $x, int $y )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
Add a point to the current polygon
<br>
<p>
</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top">Parameter</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">$x</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">coordinate</td>
</tr>
</table>
</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">$y</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">coordinate</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>bool <p>False if there is no polygon set</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_contains_point()"><h4>contains_point</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public bool contains_point( int $x, int $y )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
Checks if the current polygon contains a given point
<br>
<p>
</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top">Parameter</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">$x</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">coordinate</td>
</tr>
</table>
</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">$y</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">coordinate</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>bool <p>True if it does, false otherwise</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_draw()"><h4>draw</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public bool draw( [ integer $closed ] )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
Draw the current polygon on the current image
<br>
<p>
</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top">Parameter</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">integer</td>
<td align="left" valign="top">$closed</td>
<td align="left" valign="top"><code>= >>1<<</code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">true, the polygon will be drawn with the endpoints connected</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>bool <p>False if there is no polygon or image set</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_fill()"><h4>fill</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public bool fill( )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
Fill the current polygon on the current image
<br>
<p>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>bool <p>False if there is no polygon or image set</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_free()"><h4>free</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public bool free( )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
Free the current polygon
<br>
<p>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>bool <p>False if there is no polygon or image set</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_get_bounds()"><h4>get_bounds</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public bool get_bounds( int &$x1, int &$y1, int &$x2, int &$y2 )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
Get the bounds of the polygon
<br>
<p>
</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top">Parameter</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">&$x1</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">left X coordinate</td>
</tr>
</table>
</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">&$y1</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">left Y coordinate</td>
</tr>
</table>
</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">&$x2</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">right X coordinate</td>
</tr>
</table>
</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">&$y2</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">right Y coordinate</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>bool <p>False if there is no polygon or image set</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_get_image()"><h4>get_image</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public int get_image( )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
Get the current image resource id#
<br>
<p>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>int <p>Current image resource id#</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_new_poly()"><h4>new_poly</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public int new_poly( )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
Create a new polygon
<br>
<p>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>int <p>Resource id# of the new polygon</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_set_image()"><h4>set_image</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public void set_image( int $im )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
Set the image resource id# to draw on
<br>
<p>
</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top">Parameter</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">$im</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">resource id#</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>void <p></td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
</table>
</tr>
<tr>
<td align="left" valign="top">
<table width="100%" border="0">
<tr>
<td colspan="2" align="left" valign="top"><h2>Private Field Details</h2></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="variable_$im"><h4>$im</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>private unknown $im</b>
<p>
>><code></code><<
<p>
Resource id# of the image to draw on
<br>
</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="variable_$poly"><h4>$poly</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>private unknown $poly</b>
<p>
>><code></code><<
<p>
The resource id# of the current polygon
<br>
</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
</table>
</tr>
<tr>
<td height="10" align="left" valign="top"><hr></td>
</tr>
<tr>
<td align="left" valign="top" bgcolor="#C0C0C0">
<table>
<tr>
<td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td>
<td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td>
<td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td>
<td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td>
<td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td>
<td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">PHPDoc 1.0beta</td>
</tr>
</table>
</body>
</html>