<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: igeom/clip2d.h Source File (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <h1>igeom/clip2d.h</h1><a href="clip2d_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2000 by Jorrit Tyberghein</span> <a name="l00003"></a>00003 <span class="comment"></span> <a name="l00004"></a>00004 <span class="comment"> This library is free software; you can redistribute it and/or</span> <a name="l00005"></a>00005 <span class="comment"> modify it under the terms of the GNU Library General Public</span> <a name="l00006"></a>00006 <span class="comment"> License as published by the Free Software Foundation; either</span> <a name="l00007"></a>00007 <span class="comment"> version 2 of the License, or (at your option) any later version.</span> <a name="l00008"></a>00008 <span class="comment"></span> <a name="l00009"></a>00009 <span class="comment"> This library is distributed in the hope that it will be useful,</span> <a name="l00010"></a>00010 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00011"></a>00011 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="l00012"></a>00012 <span class="comment"> Library General Public License for more details.</span> <a name="l00013"></a>00013 <span class="comment"></span> <a name="l00014"></a>00014 <span class="comment"> You should have received a copy of the GNU Library General Public</span> <a name="l00015"></a>00015 <span class="comment"> License along with this library; if not, write to the Free</span> <a name="l00016"></a>00016 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span> <a name="l00017"></a>00017 <span class="comment">*/</span> <a name="l00018"></a>00018 <a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_IGEOM_CLIP2D_H__</span> <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IGEOM_CLIP2D_H__</span> <a name="l00021"></a>00021 <span class="preprocessor"></span> <a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="scf__interface_8h.html" title="Crystal Space Shared Class Facility (SCF) - interface creation support.">csutil/scf_interface.h</a>"</span> <a name="l00031"></a>00031 <a name="l00032"></a>00032 <span class="keyword">class </span><a class="code" href="classcsBox2.html" title="A bounding box in 2D space.">csBox2</a>; <a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>; <a name="l00034"></a>00034 <a name="l00036"></a><a class="code" href="group__geom__utils.html#g341887053b96768adb51e5df20878869">00036</a> <span class="preprocessor">#define MAX_OUTPUT_VERTICES 64</span> <a name="l00037"></a>00037 <span class="preprocessor"></span> <a name="l00046"></a>00046 <span class="keyword">enum</span> <a name="l00047"></a>00047 { <a name="l00049"></a><a class="code" href="group__geom__utils.html#gg109bfaad92bd6d348dab484aec11edbb327d20023b6a973b24df4878ac1ca2a9">00049</a> <a class="code" href="group__geom__utils.html#gg109bfaad92bd6d348dab484aec11edbb327d20023b6a973b24df4878ac1ca2a9" title="The input polygon is completely outside of clipper polygon.">CS_CLIP_OUTSIDE</a> = 0, <a name="l00051"></a><a class="code" href="group__geom__utils.html#gg109bfaad92bd6d348dab484aec11edbb5545e595302e89c3de51ec06a09ad73f">00051</a> <a class="code" href="group__geom__utils.html#gg109bfaad92bd6d348dab484aec11edbb5545e595302e89c3de51ec06a09ad73f" title="The input polygon was partially inside, partially outside.">CS_CLIP_CLIPPED</a> = 1, <a name="l00053"></a><a class="code" href="group__geom__utils.html#gg109bfaad92bd6d348dab484aec11edbb75e75d608a45eea6c9fda90b04aeefbd">00053</a> <a class="code" href="group__geom__utils.html#gg109bfaad92bd6d348dab484aec11edbb75e75d608a45eea6c9fda90b04aeefbd" title="The input polygon is completely inside (thus has not changed).">CS_CLIP_INSIDE</a> = 2 <a name="l00054"></a>00054 }; <a name="l00065"></a><a class="code" href="structcsVertexStatus.html">00065</a> <span class="keyword">struct </span><a class="code" href="structcsVertexStatus.html" title="The clipper can output additional information about each vertex in output polygon...">csVertexStatus</a> <a name="l00066"></a>00066 { <a name="l00071"></a><a class="code" href="structcsVertexStatus.html#10f72f3a72d0f4c2247cd2e3aea02364">00071</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="structcsVertexStatus.html#10f72f3a72d0f4c2247cd2e3aea02364" title="The type of vertex.">Type</a>; <a name="l00073"></a><a class="code" href="structcsVertexStatus.html#f806090dc9cfa0147b19ac4c8fc6ef40">00073</a> <span class="keywordtype">size_t</span> <a class="code" href="structcsVertexStatus.html#f806090dc9cfa0147b19ac4c8fc6ef40" title="Original vertex number (for CS_VERTEX_ORIGINAL and CS_VERTEX_ONEDGE).">Vertex</a>; <a name="l00075"></a><a class="code" href="structcsVertexStatus.html#722b6f229060130fed7cf7b0b10db2c4">00075</a> <span class="keywordtype">float</span> <a class="code" href="structcsVertexStatus.html#722b6f229060130fed7cf7b0b10db2c4" title="Additional information for CS_VERTEX_ONEDGE (0..1, the &#39;t&#39; parameter).">Pos</a>; <a name="l00076"></a>00076 }; <a name="l00077"></a>00077 <a name="l00079"></a>00079 <span class="keyword">enum</span> <a name="l00080"></a>00080 { <a name="l00082"></a><a class="code" href="group__geom__utils.html#gg550cb4231d535863c55643bbd2d3c6bab2c5f01a5c75c95a126f9352fecc63db">00082</a> <a class="code" href="group__geom__utils.html#gg550cb4231d535863c55643bbd2d3c6bab2c5f01a5c75c95a126f9352fecc63db" title="The output vertex is one of the input vertices.">CS_VERTEX_ORIGINAL</a> = 0, <a name="l00084"></a><a class="code" href="group__geom__utils.html#gg550cb4231d535863c55643bbd2d3c6ba5648edc14e0bc979178d7f7cf4ad76d5">00084</a> <a class="code" href="group__geom__utils.html#gg550cb4231d535863c55643bbd2d3c6ba5648edc14e0bc979178d7f7cf4ad76d5" title="The output vertex is located on one of the edges of the original polygon.">CS_VERTEX_ONEDGE</a> = 1, <a name="l00086"></a><a class="code" href="group__geom__utils.html#gg550cb4231d535863c55643bbd2d3c6ba38ad988c5e359fec3a8328c9965a691c">00086</a> <a class="code" href="group__geom__utils.html#gg550cb4231d535863c55643bbd2d3c6ba38ad988c5e359fec3a8328c9965a691c" title="The output vertex is located somewhere inside the original polygon.">CS_VERTEX_INSIDE</a> = 2 <a name="l00087"></a>00087 }; <a name="l00094"></a><a class="code" href="structiClipper2D.html">00094</a> <span class="keyword">struct </span><a class="code" href="structiClipper2D.html" title="This interfaces represents a 2D clipper for polygons.">iClipper2D</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a> <a name="l00095"></a>00095 { <a name="l00096"></a>00096 SCF_INTERFACE(<a class="code" href="structiClipper2D.html" title="This interfaces represents a 2D clipper for polygons.">iClipper2D</a>, 2, 0, 0); <a name="l00102"></a>00102 <span class="keyword">virtual</span> <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> <a class="code" href="structiClipper2D.html#2b9dcd9f97500ea210e434a2f5f02299" title="Clip a set of 2D points and return in &#39;OutPolygon&#39; which is expected to contain...">Clip</a> (<a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> *InPolygon, <span class="keywordtype">size_t</span> InCount, <a name="l00103"></a>00103 <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> *OutPolygon, <span class="keywordtype">size_t</span> &OutCount) = 0; <a name="l00104"></a>00104 <a name="l00113"></a>00113 <span class="keyword">virtual</span> <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> <a class="code" href="structiClipper2D.html#2b9dcd9f97500ea210e434a2f5f02299" title="Clip a set of 2D points and return in &#39;OutPolygon&#39; which is expected to contain...">Clip</a> (<a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> *InPolygon, <span class="keywordtype">size_t</span> InCount, <a name="l00114"></a>00114 <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> *OutPolygon, <span class="keywordtype">size_t</span> &OutCount, <a class="code" href="classcsBox2.html" title="A bounding box in 2D space.">csBox2</a> &BoundingBox) = 0; <a name="l00115"></a>00115 <a name="l00125"></a>00125 <span class="keyword">virtual</span> <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> <a class="code" href="structiClipper2D.html#2b9dcd9f97500ea210e434a2f5f02299" title="Clip a set of 2D points and return in &#39;OutPolygon&#39; which is expected to contain...">Clip</a> (<a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> *InPolygon, <span class="keywordtype">size_t</span> InCount, <a name="l00126"></a>00126 <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> *OutPolygon, <span class="keywordtype">size_t</span> &OutCount, <a class="code" href="structcsVertexStatus.html" title="The clipper can output additional information about each vertex in output polygon...">csVertexStatus</a> *OutStatus) = 0; <a name="l00127"></a>00127 <a name="l00132"></a>00132 <span class="keyword">virtual</span> <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> <a class="code" href="structiClipper2D.html#372dfc98a91136aee698f9baaf2ed962" title="Wrapper function: clip a polygon in-place.">ClipInPlace</a> (<a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> *InPolygon, <span class="keywordtype">size_t</span> &InOutCount, <a name="l00133"></a>00133 <a class="code" href="classcsBox2.html" title="A bounding box in 2D space.">csBox2</a> &BoundingBox) = 0; <a name="l00134"></a>00134 <a name="l00142"></a>00142 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiClipper2D.html#f79ddb0aa5da86b8fe78d25395385de6" title="Classify some bounding box against this clipper.">ClassifyBox</a> (<span class="keyword">const</span> <a class="code" href="classcsBox2.html" title="A bounding box in 2D space.">csBox2</a> &box) = 0; <a name="l00143"></a>00143 <a name="l00145"></a>00145 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiClipper2D.html#c0b0813e21123d4211d8cd093b8dd3ba" title="Return true if given point is inside (or on bound) of clipper polygon.">IsInside</a> (<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>& v) = 0; <a name="l00146"></a>00146 <a name="l00148"></a>00148 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structiClipper2D.html#624994070bdb107a90f8902ba332a937" title="Return number of vertices for this clipper polygon.">GetVertexCount</a> () = 0; <a name="l00149"></a>00149 <a name="l00151"></a>00151 <span class="keyword">virtual</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> *<a class="code" href="structiClipper2D.html#8210d2f967bdd837630a6caccea43169" title="Return a pointer to the array of csVector2&#39;s.">GetClipPoly</a> () = 0; <a name="l00152"></a>00152 <a name="l00154"></a><a class="code" href="structiClipper2D.html#03ed976bdb8cd014a5dabccc06bd3730">00154</a> <span class="keyword">enum</span> <a class="code" href="structiClipper2D.html#03ed976bdb8cd014a5dabccc06bd3730" title="The type of a clipper.">ClipperType</a> <a name="l00155"></a>00155 { <a name="l00157"></a><a class="code" href="structiClipper2D.html#03ed976bdb8cd014a5dabccc06bd3730e0b781f11ae6a39b9efcfe103d52e7f0">00157</a> <a class="code" href="structiClipper2D.html#03ed976bdb8cd014a5dabccc06bd3730e0b781f11ae6a39b9efcfe103d52e7f0" title="This clipper contains a polygon.">clipperPoly</a>, <a name="l00159"></a><a class="code" href="structiClipper2D.html#03ed976bdb8cd014a5dabccc06bd37301ad4ee39e028ea58c417ba29820b0da7">00159</a> <a class="code" href="structiClipper2D.html#03ed976bdb8cd014a5dabccc06bd37301ad4ee39e028ea58c417ba29820b0da7" title="This clipper contains a box. Can be used for some optimizations.">clipperBox</a> <a name="l00160"></a>00160 }; <a name="l00164"></a>00164 <span class="keyword">virtual</span> <a class="code" href="structiClipper2D.html#03ed976bdb8cd014a5dabccc06bd3730" title="The type of a clipper.">ClipperType</a> <a class="code" href="structiClipper2D.html#7016695a49e465211d75df6224a17979" title="Retrieve the type of this clipper.">GetClipperType</a>() <span class="keyword">const</span> = 0; <a name="l00165"></a>00165 }; <a name="l00166"></a>00166 <a name="l00169"></a>00169 <span class="preprocessor">#endif // __CS_IGEOM_CLIP2D_H__</span> </pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>