Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 1385

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: csgeom/csrect.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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csgeom/csrect.h</h1><a href="csrect_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">    Crystal Space Engine: rectangle class interface</span>
<a name="l00003"></a>00003 <span class="comment">    Copyright (C) 2001 by Jorrit Tyberghein</span>
<a name="l00004"></a>00004 <span class="comment">    Copyright (C) 1998,1999 by Andrew Zabolotny &lt;bit@eltech.ru&gt;</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00008"></a>00008 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00009"></a>00009 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00014"></a>00014 <span class="comment">    Library General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00017"></a>00017 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00018"></a>00018 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00019"></a>00019 <span class="comment">*/</span>
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef __CS_RECT_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define __CS_RECT_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00032"></a>00032 
<a name="l00053"></a><a class="code" href="classcsRect.html">00053</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a>
<a name="l00054"></a>00054 {
<a name="l00055"></a>00055 <span class="keyword">public</span>:
<a name="l00057"></a><a class="code" href="classcsRect.html#8a89993941d84448b7d31a757fc90aaf">00057</a>   <span class="keywordtype">int</span> xmin, ymin, xmax, ymax;
<a name="l00058"></a>00058 
<a name="l00060"></a>00060   <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> ();
<a name="l00061"></a>00061 
<a name="l00063"></a>00063   <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> (<span class="keywordtype">int</span> ixmin, <span class="keywordtype">int</span> iymin, <span class="keywordtype">int</span> ixmax, <span class="keywordtype">int</span> iymax);
<a name="l00064"></a>00064 
<a name="l00066"></a>00066   <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> (<span class="keyword">const</span> <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> &amp;copy);
<a name="l00067"></a>00067 
<a name="l00069"></a>00069   ~<a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> ();
<a name="l00070"></a>00070 
<a name="l00072"></a>00072   <span class="keywordtype">void</span> Intersect (<span class="keywordtype">int</span> ixmin, <span class="keywordtype">int</span> iymin, <span class="keywordtype">int</span> ixmax, <span class="keywordtype">int</span> iymax);
<a name="l00073"></a>00073 
<a name="l00075"></a><a class="code" href="classcsRect.html#b3bd31c18d8a6e659ad8c0d83d0b35f5">00075</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Intersect (<span class="keyword">const</span> <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> &amp;other)
<a name="l00076"></a>00076   { Intersect (other.<a class="code" href="classcsRect.html#00ea0f16c06bb426e5fa93f513344ab2" title="Rectangle bounds.">xmin</a>, other.<a class="code" href="classcsRect.html#8a89993941d84448b7d31a757fc90aaf">ymin</a>, other.<a class="code" href="classcsRect.html#43ef15d71e44265993a01c1b518fb8cf">xmax</a>, other.<a class="code" href="classcsRect.html#29ebcabf97186ccf144ec2f068e726d2">ymax</a>); }
<a name="l00077"></a>00077 
<a name="l00079"></a>00079   <span class="keywordtype">bool</span> Intersects (<span class="keyword">const</span> <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> &amp;target) <span class="keyword">const</span>;
<a name="l00080"></a>00080 
<a name="l00085"></a>00085   <span class="keywordtype">void</span> Union (<span class="keywordtype">int</span> ixmin, <span class="keywordtype">int</span> iymin, <span class="keywordtype">int</span> ixmax, <span class="keywordtype">int</span> iymax);
<a name="l00086"></a>00086 
<a name="l00091"></a><a class="code" href="classcsRect.html#0834916fa979a8322d6cba110c3978ae">00091</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Union (<span class="keyword">const</span> <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> &amp;other)
<a name="l00092"></a>00092   { Union (other.<a class="code" href="classcsRect.html#00ea0f16c06bb426e5fa93f513344ab2" title="Rectangle bounds.">xmin</a>, other.<a class="code" href="classcsRect.html#8a89993941d84448b7d31a757fc90aaf">ymin</a>, other.<a class="code" href="classcsRect.html#43ef15d71e44265993a01c1b518fb8cf">xmax</a>, other.<a class="code" href="classcsRect.html#29ebcabf97186ccf144ec2f068e726d2">ymax</a>); }
<a name="l00093"></a>00093 
<a name="l00099"></a>00099   <span class="keywordtype">void</span> Exclude (<span class="keywordtype">int</span> ixmin, <span class="keywordtype">int</span> iymin, <span class="keywordtype">int</span> ixmax, <span class="keywordtype">int</span> iymax);
<a name="l00100"></a>00100 
<a name="l00102"></a><a class="code" href="classcsRect.html#45b677df1a032060d9df6dcadd7f417e">00102</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Exclude (<span class="keyword">const</span> <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> &amp;other)
<a name="l00103"></a>00103   { Exclude (other.<a class="code" href="classcsRect.html#00ea0f16c06bb426e5fa93f513344ab2" title="Rectangle bounds.">xmin</a>, other.<a class="code" href="classcsRect.html#8a89993941d84448b7d31a757fc90aaf">ymin</a>, other.<a class="code" href="classcsRect.html#43ef15d71e44265993a01c1b518fb8cf">xmax</a>, other.<a class="code" href="classcsRect.html#29ebcabf97186ccf144ec2f068e726d2">ymax</a>); }
<a name="l00104"></a>00104 
<a name="l00109"></a>00109   <span class="keywordtype">void</span> Subtract (<span class="keyword">const</span> <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> &amp;rect);
<a name="l00110"></a>00110 
<a name="l00112"></a><a class="code" href="classcsRect.html#12ae235caf1eb1b30ce80644665209ad">00112</a>   <span class="keyword">inline</span> <span class="keywordtype">bool</span> IsEmpty ()<span class="keyword"> const</span>
<a name="l00113"></a>00113 <span class="keyword">  </span>{ <span class="keywordflow">return</span> (xmin &gt;= xmax) || (ymin &gt;= ymax); }
<a name="l00114"></a>00114 
<a name="l00116"></a><a class="code" href="classcsRect.html#bdbba8bbcfee4fce0c1f82c0efebfff5">00116</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> MakeEmpty ()
<a name="l00117"></a>00117   { xmin = xmax = 0; }
<a name="l00118"></a>00118 
<a name="l00120"></a><a class="code" href="classcsRect.html#03b3854e1b5105ae89e31fad6e40342c">00120</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Set (<span class="keywordtype">int</span> ixmin, <span class="keywordtype">int</span> iymin, <span class="keywordtype">int</span> ixmax, <span class="keywordtype">int</span> iymax)
<a name="l00121"></a>00121   {
<a name="l00122"></a>00122     xmin = ixmin; xmax = ixmax;
<a name="l00123"></a>00123     ymin = iymin; ymax = iymax;
<a name="l00124"></a>00124   }
<a name="l00125"></a>00125 
<a name="l00127"></a><a class="code" href="classcsRect.html#e342253839cf304143e1b95b468706bd">00127</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Set (<span class="keyword">const</span> <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> &amp;target)
<a name="l00128"></a>00128   {
<a name="l00129"></a>00129     xmin = target.<a class="code" href="classcsRect.html#00ea0f16c06bb426e5fa93f513344ab2" title="Rectangle bounds.">xmin</a>; xmax = target.<a class="code" href="classcsRect.html#43ef15d71e44265993a01c1b518fb8cf">xmax</a>;
<a name="l00130"></a>00130     ymin = target.<a class="code" href="classcsRect.html#8a89993941d84448b7d31a757fc90aaf">ymin</a>; ymax = target.<a class="code" href="classcsRect.html#29ebcabf97186ccf144ec2f068e726d2">ymax</a>;
<a name="l00131"></a>00131   }
<a name="l00132"></a>00132 
<a name="l00134"></a><a class="code" href="classcsRect.html#b1123b6e14df91ecd657f9cfca016ea5">00134</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> SetPos (<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y)
<a name="l00135"></a>00135   { 
<a name="l00136"></a>00136         <span class="keywordtype">int</span> w = Width(), h=Height(); 
<a name="l00137"></a>00137     
<a name="l00138"></a>00138         xmin = x; ymin = y; 
<a name="l00139"></a>00139         xmax = xmin+w;
<a name="l00140"></a>00140         ymax = ymin+h;
<a name="l00141"></a>00141    }
<a name="l00142"></a>00142 
<a name="l00144"></a><a class="code" href="classcsRect.html#2d69bcac7242166991602b51a27cf46b">00144</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> SetSize (<span class="keywordtype">int</span> w, <span class="keywordtype">int</span> h)
<a name="l00145"></a>00145   { xmax = xmin + w; ymax = ymin + h; }
<a name="l00146"></a>00146 
<a name="l00148"></a><a class="code" href="classcsRect.html#9924d0804ffbeada0a7f55a605f6b502">00148</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Move (<span class="keywordtype">int</span> dX, <span class="keywordtype">int</span> dY)
<a name="l00149"></a>00149   { xmin += dX; xmax += dX; ymin += dY; ymax += dY; }
<a name="l00150"></a>00150 
<a name="l00152"></a><a class="code" href="classcsRect.html#630af3d29f09ab394d89f3c4cf418232">00152</a>   <span class="keyword">inline</span> <span class="keywordtype">int</span> Width ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> xmax - xmin; }
<a name="l00153"></a>00153 
<a name="l00155"></a><a class="code" href="classcsRect.html#c40654ef74b63a975c7e4bdc4ced14ee">00155</a>   <span class="keyword">inline</span> <span class="keywordtype">int</span> Height ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> ymax - ymin; }
<a name="l00156"></a>00156 
<a name="l00158"></a><a class="code" href="classcsRect.html#70114df6efe235c08ab7d4028289605b">00158</a>   <span class="keyword">inline</span> <span class="keywordtype">bool</span> Contains (<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y)<span class="keyword"> const</span>
<a name="l00159"></a>00159 <span class="keyword">  </span>{ <span class="keywordflow">return</span> (x &gt;= xmin) &amp;&amp; (x &lt; xmax) &amp;&amp; (y &gt;= ymin) &amp;&amp; (y &lt; ymax); }
<a name="l00160"></a>00160 
<a name="l00162"></a><a class="code" href="classcsRect.html#99a92c4b49d20a3a85ab37090b316fd0">00162</a>   <span class="keyword">inline</span> <span class="keywordtype">bool</span> ContainsRel (<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y)<span class="keyword"> const</span>
<a name="l00163"></a>00163 <span class="keyword">  </span>{ <span class="keywordflow">return</span> (x &gt;= 0) &amp;&amp; (x &lt; Width ()) &amp;&amp; (y &gt;= 0) &amp;&amp; (y &lt; Height ()); }
<a name="l00164"></a>00164 
<a name="l00166"></a><a class="code" href="classcsRect.html#ee9cf05aab162768717c98f0c4a3c55a">00166</a>   <span class="keyword">inline</span> <span class="keywordtype">bool</span> Equal (<span class="keywordtype">int</span> ixmin, <span class="keywordtype">int</span> iymin, <span class="keywordtype">int</span> ixmax, <span class="keywordtype">int</span> iymax)<span class="keyword"> const</span>
<a name="l00167"></a>00167 <span class="keyword">  </span>{ <span class="keywordflow">return</span> (xmin == ixmin) &amp;&amp; (ymin == iymin) &amp;&amp;
<a name="l00168"></a>00168            (xmax == ixmax) &amp;&amp; (ymax == iymax); }
<a name="l00170"></a><a class="code" href="classcsRect.html#28f042ff0b2e8266797d29fbfb416ee2">00170</a>   <span class="keyword">inline</span> <span class="keywordtype">bool</span> Equal (<span class="keyword">const</span> <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> &amp;other)<span class="keyword"> const</span>
<a name="l00171"></a>00171 <span class="keyword">  </span>{ <span class="keywordflow">return</span> Equal (other.<a class="code" href="classcsRect.html#00ea0f16c06bb426e5fa93f513344ab2" title="Rectangle bounds.">xmin</a>, other.<a class="code" href="classcsRect.html#8a89993941d84448b7d31a757fc90aaf">ymin</a>, other.<a class="code" href="classcsRect.html#43ef15d71e44265993a01c1b518fb8cf">xmax</a>, other.<a class="code" href="classcsRect.html#29ebcabf97186ccf144ec2f068e726d2">ymax</a>); }
<a name="l00172"></a>00172 
<a name="l00174"></a><a class="code" href="classcsRect.html#4ea6880818424780ccb4b14d6b87cde2">00174</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Normalize ()
<a name="l00175"></a>00175   {
<a name="l00176"></a>00176     <span class="keywordflow">if</span> (xmin &gt; xmax) { <span class="keywordtype">int</span> tmp = xmin; xmin = xmax; xmax = tmp; }
<a name="l00177"></a>00177     <span class="keywordflow">if</span> (ymin &gt; ymax) { <span class="keywordtype">int</span> tmp = ymin; ymin = ymax; ymax = tmp; }
<a name="l00178"></a>00178   }
<a name="l00179"></a>00179 
<a name="l00181"></a><a class="code" href="classcsRect.html#60e4ae3c22be287cfb8cc4f4bbab509b">00181</a>   <span class="keyword">inline</span> <span class="keywordtype">int</span> Area ()<span class="keyword"> const</span>
<a name="l00182"></a>00182 <span class="keyword">  </span>{
<a name="l00183"></a>00183     <span class="keywordflow">if</span> (IsEmpty ())
<a name="l00184"></a>00184       <span class="keywordflow">return</span> 0;
<a name="l00185"></a>00185     <span class="keywordflow">else</span>
<a name="l00186"></a>00186       <span class="keywordflow">return</span> Width () * Height ();
<a name="l00187"></a>00187   }
<a name="l00188"></a>00188 
<a name="l00193"></a>00193   <span class="keywordtype">void</span> AddAdjacent (<span class="keyword">const</span> <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> &amp;rect);
<a name="l00194"></a>00194   
<a name="l00196"></a><a class="code" href="classcsRect.html#5de958974a6a3cdc1fbdcaa97169861e">00196</a>   <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator == (<span class="keyword">const</span> <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a>&amp; rect)<span class="keyword"> const</span>
<a name="l00197"></a>00197 <span class="keyword">  </span>{
<a name="l00198"></a>00198     <span class="keywordflow">return</span> Equal (rect);
<a name="l00199"></a>00199   }
<a name="l00200"></a>00200 
<a name="l00202"></a><a class="code" href="classcsRect.html#2ec1ca26dc254478425bfcd2eed5971b">00202</a>   <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator != (<span class="keyword">const</span> <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> &amp;rect)<span class="keyword"> const</span>
<a name="l00203"></a>00203 <span class="keyword">  </span>{
<a name="l00204"></a>00204     <span class="keywordflow">return</span> !Equal (rect);
<a name="l00205"></a>00205   }
<a name="l00206"></a>00206 
<a name="l00208"></a><a class="code" href="classcsRect.html#81452e0e7e3a6890afd67cff156f858b">00208</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Extend (<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y)
<a name="l00209"></a>00209   {
<a name="l00210"></a>00210     <span class="keywordflow">if</span> (xmin &gt; x) xmin = x; <span class="keywordflow">if</span> (xmax &lt; x+1) xmax = x+1;
<a name="l00211"></a>00211     <span class="keywordflow">if</span> (ymin &gt; y) ymin = y; <span class="keywordflow">if</span> (ymax &lt; y+1) ymax = y+1;
<a name="l00212"></a>00212   }
<a name="l00213"></a>00213 
<a name="l00215"></a>00215   <span class="keywordtype">void</span> Join (<span class="keyword">const</span> <a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> &amp;rect);
<a name="l00216"></a>00216 
<a name="l00218"></a>00218   <span class="keywordtype">void</span> Outset(<span class="keywordtype">int</span> n);
<a name="l00219"></a>00219 
<a name="l00221"></a>00221   <span class="keywordtype">void</span> Inset(<span class="keywordtype">int</span> n);
<a name="l00222"></a>00222 
<a name="l00230"></a>00230   <span class="keywordtype">bool</span> ClipLineGeneral (<span class="keywordtype">int</span>&amp; x1, <span class="keywordtype">int</span>&amp; y1, <span class="keywordtype">int</span>&amp; x2, <span class="keywordtype">int</span>&amp; y2);
<a name="l00231"></a>00231 
<a name="l00239"></a>00239   <span class="keywordtype">bool</span> ClipLine (<span class="keywordtype">int</span>&amp; x1, <span class="keywordtype">int</span>&amp; y1, <span class="keywordtype">int</span>&amp; x2, <span class="keywordtype">int</span>&amp; y2);
<a name="l00240"></a>00240 
<a name="l00248"></a>00248   <span class="keywordtype">bool</span> ClipLineSafe (<span class="keywordtype">int</span>&amp; x1, <span class="keywordtype">int</span>&amp; y1, <span class="keywordtype">int</span>&amp; x2, <span class="keywordtype">int</span>&amp; y2);
<a name="l00249"></a>00249 };
<a name="l00250"></a>00250 
<a name="l00253"></a>00253 <span class="preprocessor">#endif // __CS_RECT_H__</span>
<a name="l00254"></a>00254 <span class="preprocessor"></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>