Sophie

Sophie

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

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/box.h File Reference (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/box.h File Reference</h1>Bounding boxes for 2D and 3D space. <a href="#_details">More...</a>
<p>
<code>#include &quot;csextern.h&quot;</code><br>
<code>#include &quot;<a class="el" href="cstypes_8h-source.html">cstypes.h</a>&quot;</code><br>
<code>#include &quot;<a class="el" href="csrect_8h-source.html">csgeom/csrect.h</a>&quot;</code><br>
<code>#include &quot;<a class="el" href="math_8h-source.html">csgeom/math.h</a>&quot;</code><br>
<code>#include &quot;<a class="el" href="vector2_8h-source.html">csgeom/vector2.h</a>&quot;</code><br>
<code>#include &quot;<a class="el" href="vector3_8h-source.html">csgeom/vector3.h</a>&quot;</code><br>
<code>#include &quot;<a class="el" href="segment_8h-source.html">csgeom/segment.h</a>&quot;</code><br>
<code>#include &quot;<a class="el" href="csutil_2array_8h-source.html">csutil/array.h</a>&quot;</code><br>

<p>
<a href="box_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsBox2.html">csBox2</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A bounding box in 2D space.  <a href="classcsBox2.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsBox3.html">csBox3</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A bounding box in 3D space.  <a href="classcsBox3.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsBox3_1_1bEdge.html">csBox3::bEdge</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsBox3_1_1Outline.html">csBox3::Outline</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This table also contains an array of sides visible from that region.  <a href="structcsBox3_1_1Outline.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geom__utils.html#g5acebae804990b2e4fc030a61c662e48">CS_BOUNDINGBOX_MAXVALUE</a>&nbsp;&nbsp;&nbsp;1000000000.</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The maximum value that a coordinate in the bounding box can use.  <a href="group__geom__utils.html#g5acebae804990b2e4fc030a61c662e48"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Corner indices</div></td></tr>
<tr><td colspan="2"><div class="groupText">For <a class="el" href="classcsBox2.html#bab16fdf3533f20f0d8a210ae6195f0f" title="Return every corner of this bounding box from 0 to 3.">csBox2::GetCorner()</a>. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#gg06fc87d81c62e9abb8790b6e5713c55b86d75fcdcc57f10b7e00afa9571b2d56">CS_BOX_CORNER_xy</a> =  0, 
<a class="el" href="group__geom__utils.html#gg06fc87d81c62e9abb8790b6e5713c55baa41ac3e362d3bab01aadf9aa6e89ed3">CS_BOX_CORNER_xY</a> =  1, 
<a class="el" href="group__geom__utils.html#gg06fc87d81c62e9abb8790b6e5713c55b66981a2c120c408cd6a662687e809536">CS_BOX_CORNER_Xy</a> =  2, 
<a class="el" href="group__geom__utils.html#gg06fc87d81c62e9abb8790b6e5713c55b22189c053382e35184dbc0d0c4056c49">CS_BOX_CORNER_XY</a> =  3, 
<br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#gg06fc87d81c62e9abb8790b6e5713c55b26daf5755b88f571d2f8b44b8a4eb1f2">CS_BOX_CENTER2</a> =  4
<br>
 }</td></tr>

<tr><td colspan="2"><div class="groupHeader">Indices of edges for csBox2.</div></td></tr>
<tr><td colspan="2"><div class="groupText">Index e+1 is opposite edge of e (with e even). <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#ggdf764cbdea00d65edcd07bb9953ad2b7b42077b10139d5a537a31773f9d82116">CS_BOX_EDGE_xy_Xy</a> =  0, 
<a class="el" href="group__geom__utils.html#ggdf764cbdea00d65edcd07bb9953ad2b7e9cda4d3571c9e32d2aba7e4e36255b8">CS_BOX_EDGE_Xy_xy</a> =  1, 
<a class="el" href="group__geom__utils.html#ggdf764cbdea00d65edcd07bb9953ad2b7d9e23645086f99891c4ca5eccba117a1">CS_BOX_EDGE_Xy_XY</a> =  2, 
<a class="el" href="group__geom__utils.html#ggdf764cbdea00d65edcd07bb9953ad2b76e0c54f9e09d052f5da9c4d157720922">CS_BOX_EDGE_XY_Xy</a> =  3, 
<br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#ggdf764cbdea00d65edcd07bb9953ad2b7def3cca359637bed9cbd0240ffd2051d">CS_BOX_EDGE_XY_xY</a> =  4, 
<a class="el" href="group__geom__utils.html#ggdf764cbdea00d65edcd07bb9953ad2b70f820cda4b14b108a4a8eea2f04a399a">CS_BOX_EDGE_xY_XY</a> =  5, 
<a class="el" href="group__geom__utils.html#ggdf764cbdea00d65edcd07bb9953ad2b7703caeef06bfab521bdb139104d80154">CS_BOX_EDGE_xY_xy</a> =  6, 
<a class="el" href="group__geom__utils.html#ggdf764cbdea00d65edcd07bb9953ad2b7675911addea7e87c3a8c8d7dff2ccb98">CS_BOX_EDGE_xy_xY</a> =  7
<br>
 }</td></tr>

<tr><td colspan="2"><div class="groupHeader">Indices of corner vertices for csBox3.</div></td></tr>
<tr><td colspan="2"><div class="groupText">Used by <a class="el" href="classcsBox3.html#414acf5fe1fee22d056e65fd0aa89fd8" title="Return every corner of this bounding box from 0 to 7.">csBox3::GetCorner()</a>. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#gg99fb83031ce9923c84392b4e92f956b589d329160331dbc52961462fa640e016">CS_BOX_CORNER_xyz</a> =  0, 
<a class="el" href="group__geom__utils.html#gg99fb83031ce9923c84392b4e92f956b50adf66ef9191dbadc5ff14a6bad51070">CS_BOX_CORNER_xyZ</a> =  1, 
<a class="el" href="group__geom__utils.html#gg99fb83031ce9923c84392b4e92f956b5ce4d8a92c8104f1f48452cb3d312d47c">CS_BOX_CORNER_xYz</a> =  2, 
<a class="el" href="group__geom__utils.html#gg99fb83031ce9923c84392b4e92f956b5cf591c4f61dc416d2f12e53caa0fc804">CS_BOX_CORNER_xYZ</a> =  3, 
<br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#gg99fb83031ce9923c84392b4e92f956b5d13ea13c11becbf554b5ae66e58faa24">CS_BOX_CORNER_Xyz</a> =  4, 
<a class="el" href="group__geom__utils.html#gg99fb83031ce9923c84392b4e92f956b5764db01cad89323ece3563d24b822a9a">CS_BOX_CORNER_XyZ</a> =  5, 
<a class="el" href="group__geom__utils.html#gg99fb83031ce9923c84392b4e92f956b52b8f79719b79e9a75f8284feb3cafdf5">CS_BOX_CORNER_XYz</a> =  6, 
<a class="el" href="group__geom__utils.html#gg99fb83031ce9923c84392b4e92f956b59249f548cf717ea61e140681e58aeac5">CS_BOX_CORNER_XYZ</a> =  7, 
<br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#gg99fb83031ce9923c84392b4e92f956b58240f71d83e88f58c9c7da2a583e3c03">CS_BOX_CENTER3</a> =  8
<br>
 }</td></tr>

<tr><td colspan="2"><div class="groupHeader">Indices of faces for csBox3.</div></td></tr>
<tr><td colspan="2"><div class="groupText">Used by <a class="el" href="classcsBox3.html#8c7d43af0ac4126c7ece33a794c8323f" title="Get a side of this box as a 2D box.">csBox3::GetSide()</a>. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#ggbc6126af1d45847bc59afa0aa3216b04bf5848df27bb69f664cbd291d39420ee">CS_BOX_SIDE_x</a> =  0, 
<a class="el" href="group__geom__utils.html#ggbc6126af1d45847bc59afa0aa3216b0445dd9cccdf41c83a927d6407db8d896d">CS_BOX_SIDE_X</a> =  1, 
<a class="el" href="group__geom__utils.html#ggbc6126af1d45847bc59afa0aa3216b046a332bf491cf4c6d41382d86e048b2af">CS_BOX_SIDE_y</a> =  2, 
<a class="el" href="group__geom__utils.html#ggbc6126af1d45847bc59afa0aa3216b04609482712abd0e66fdc499c79446e436">CS_BOX_SIDE_Y</a> =  3, 
<br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#ggbc6126af1d45847bc59afa0aa3216b04d7e05664a7c62642086c8208312f7e0f">CS_BOX_SIDE_z</a> =  4, 
<a class="el" href="group__geom__utils.html#ggbc6126af1d45847bc59afa0aa3216b047406d4fc7aaf58e925da20fa75e958c7">CS_BOX_SIDE_Z</a> =  5, 
<a class="el" href="group__geom__utils.html#ggbc6126af1d45847bc59afa0aa3216b043f565d480903f9a9037e5a4f557ac32d">CS_BOX_INSIDE</a> =  6
<br>
 }</td></tr>

<tr><td colspan="2"><div class="groupHeader">Indices of edges for csBox3.</div></td></tr>
<tr><td colspan="2"><div class="groupText">Index e+1 is opposite edge of e (with e even). <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c28c05175d3a2a4c149f796f4c6f64b0f">CS_BOX_EDGE_Xyz_xyz</a> =  0, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06cf1b6f3bca9b6f462f95b3ee037ea45b9">CS_BOX_EDGE_xyz_Xyz</a> =  1, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06cab03491e2bc4107e684f35213bcbcd61">CS_BOX_EDGE_xyz_xYz</a> =  2, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c66b26777890e8aa3a1548c43b8db5e6a">CS_BOX_EDGE_xYz_xyz</a> =  3, 
<br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c0287c5a744c7f5f969f704b7417918e0">CS_BOX_EDGE_xYz_XYz</a> =  4, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06cfd27ca2b7840189a4e65b6574f1dfae8">CS_BOX_EDGE_XYz_xYz</a> =  5, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c335c45578982e7a26b9d26f4fb0273fc">CS_BOX_EDGE_XYz_Xyz</a> =  6, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c26ef6a1c17df15e763df523ca4d6092a">CS_BOX_EDGE_Xyz_XYz</a> =  7, 
<br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c8364a7525248aaa39bf3754f87ab0e6e">CS_BOX_EDGE_Xyz_XyZ</a> =  8, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c7beb6b0163fcf275a4b4f9e898e17ec6">CS_BOX_EDGE_XyZ_Xyz</a> =  9, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c1e9f896d12d1a99e0c222045a11d6911">CS_BOX_EDGE_XyZ_XYZ</a> =  10, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06ce3504080e396e00052243b9c0dc3c8c1">CS_BOX_EDGE_XYZ_XyZ</a> =  11, 
<br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06cab569a7997e86dd33ba8636830a2d46f">CS_BOX_EDGE_XYZ_XYz</a> =  12, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c52ad8f1f084dbdedfcf455b97b237945">CS_BOX_EDGE_XYz_XYZ</a> =  13, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06cfba0050e6b406ec4837ca5ecb876cac2">CS_BOX_EDGE_XYZ_xYZ</a> =  14, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c70555ffeea5abe887d7c2b11d52a3fe2">CS_BOX_EDGE_xYZ_XYZ</a> =  15, 
<br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c43b1277678de6c48152cfd869f6a52e2">CS_BOX_EDGE_xYZ_xYz</a> =  16, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c98abe1d1ea24fd6e0e79e71997c48029">CS_BOX_EDGE_xYz_xYZ</a> =  17, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c7d2b31db7d0e7f15105194030fed4a23">CS_BOX_EDGE_xYZ_xyZ</a> =  18, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06cd023f48dcdce21774666352abed6b56b">CS_BOX_EDGE_xyZ_xYZ</a> =  19, 
<br>
&nbsp;&nbsp;<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06caea4a1129a5c51aae234283ce02df056">CS_BOX_EDGE_xyZ_xyz</a> =  20, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c80fb3e69e2048893619b1d79d1af1f31">CS_BOX_EDGE_xyz_xyZ</a> =  21, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06c6e42bf64feb368b283b43cd588c81007">CS_BOX_EDGE_xyZ_XyZ</a> =  22, 
<a class="el" href="group__geom__utils.html#ggdc29c2ff13d900c2f185ee95427fb06cd7607d9544acab7162ea123acc6fb711">CS_BOX_EDGE_XyZ_xyZ</a> =  23
<br>
 }</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Bounding boxes for 2D and 3D space. 
<p>

<p>Definition in file <a class="el" href="box_8h-source.html">box.h</a>.</p>
<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>