Sophie

Sophie

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

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: iHazeHull Struct 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 class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>iHazeHull Struct Reference<br>
<small>
[<a class="el" href="group__meshplugins.html">Mesh plugins</a>]</small>
</h1><!-- doxytag: class="iHazeHull" --><!-- doxytag: inherits="iBase" -->A mesh specially meant for use by the haze.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="haze_8h-source.html">imesh/haze.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iHazeHull:</div>
<div class="dynsection">
<p><center><img src="structiHazeHull__inherit__graph.png" border="0" usemap="#iHazeHull__inherit__map" alt="Inheritance graph"></center>
<map name="iHazeHull__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="17,7,73,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiHazeHull-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeHull.html#966b0b5f02fb726155f6014d01fe3e23">GetEdge</a> (int edge_num, int &amp;vertex_idx_1, int &amp;vertex_idx_2) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get the two (unordered) points of an edge (by index)  <a href="#966b0b5f02fb726155f6014d01fe3e23"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeHull.html#5238a7f7096269bc910d49b872781951">GetEdgeCount</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get the total number of edges  <a href="#5238a7f7096269bc910d49b872781951"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeHull.html#958f983dc5f4cbdb1d9d8943edb1805f">GetPolEdge</a> (int polygon_num, int vertex_num, int &amp;start_idx, int &amp;end_idx) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the edge index that starts at given vertex number in polygon Also returns the start and end vertex-idx of the edge (in clockwise order).  <a href="#958f983dc5f4cbdb1d9d8943edb1805f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeHull.html#9742facd08285f8061a13bd86c89ff82">GetPolVertex</a> (int polygon_num, int vertex_num) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get vertexindex in a polygon (given vertex number in polygon)  <a href="#9742facd08285f8061a13bd86c89ff82"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeHull.html#681ddbb3eadf9b7ffb31e487d46bd4e6">GetPolVerticeCount</a> (int polygon_num) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get the number of vertices in a polygon  <a href="#681ddbb3eadf9b7ffb31e487d46bd4e6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeHull.html#39ea303811773d04ea084b30d22380d2">GetPolygonCount</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get the number of polygons  <a href="#39ea303811773d04ea084b30d22380d2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeHull.html#22b033a281f90fca11277e29596f0256">GetVertex</a> (<a class="el" href="classcsVector3.html">csVector3</a> &amp;res, int vertex_idx) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get a vertex by index  <a href="#22b033a281f90fca11277e29596f0256"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiHazeHull.html#bb277811883a6635a1cb462ca16df58e">GetVerticeCount</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get the total number of vertices  <a href="#bb277811883a6635a1cb462ca16df58e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A mesh specially meant for use by the haze. 
<p>
This mesh must be a convex hull. for example: cubes, boxes, spheres, cones, cylinders, pyramids. A convex hull object can be defined as follows: from any point inside the object, all of the polygons are completely visible (none are obscured by other polygons from the convex hull). The ordering of the vertices (vertice numbering) is important when multiple hulls are used. Also edges must be numbered, with a number for each undirected edge. (i.e. a-&gt;b and b-&gt;a have the same edge number). Polygons thus have N vertices and N edges. For a particular polygon, the edges return their points in clockwise ordering. 
<p>Definition at line <a class="el" href="haze_8h-source.html#l00050">50</a> of file <a class="el" href="haze_8h-source.html">haze.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="966b0b5f02fb726155f6014d01fe3e23"></a><!-- doxytag: member="iHazeHull::GetEdge" ref="966b0b5f02fb726155f6014d01fe3e23" args="(int edge_num, int &amp;vertex_idx_1, int &amp;vertex_idx_2) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iHazeHull::GetEdge           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>edge_num</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int &amp;&nbsp;</td>
          <td class="paramname"> <em>vertex_idx_1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int &amp;&nbsp;</td>
          <td class="paramname"> <em>vertex_idx_2</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
get the two (unordered) points of an edge (by index) 
<p>

</div>
</div><p>
<a class="anchor" name="5238a7f7096269bc910d49b872781951"></a><!-- doxytag: member="iHazeHull::GetEdgeCount" ref="5238a7f7096269bc910d49b872781951" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int iHazeHull::GetEdgeCount           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
get the total number of edges 
<p>

</div>
</div><p>
<a class="anchor" name="958f983dc5f4cbdb1d9d8943edb1805f"></a><!-- doxytag: member="iHazeHull::GetPolEdge" ref="958f983dc5f4cbdb1d9d8943edb1805f" args="(int polygon_num, int vertex_num, int &amp;start_idx, int &amp;end_idx) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int iHazeHull::GetPolEdge           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>polygon_num</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>vertex_num</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int &amp;&nbsp;</td>
          <td class="paramname"> <em>start_idx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int &amp;&nbsp;</td>
          <td class="paramname"> <em>end_idx</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the edge index that starts at given vertex number in polygon Also returns the start and end vertex-idx of the edge (in clockwise order). 
<p>

</div>
</div><p>
<a class="anchor" name="9742facd08285f8061a13bd86c89ff82"></a><!-- doxytag: member="iHazeHull::GetPolVertex" ref="9742facd08285f8061a13bd86c89ff82" args="(int polygon_num, int vertex_num) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int iHazeHull::GetPolVertex           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>polygon_num</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>vertex_num</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
get vertexindex in a polygon (given vertex number in polygon) 
<p>

</div>
</div><p>
<a class="anchor" name="681ddbb3eadf9b7ffb31e487d46bd4e6"></a><!-- doxytag: member="iHazeHull::GetPolVerticeCount" ref="681ddbb3eadf9b7ffb31e487d46bd4e6" args="(int polygon_num) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int iHazeHull::GetPolVerticeCount           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>polygon_num</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
get the number of vertices in a polygon 
<p>

</div>
</div><p>
<a class="anchor" name="39ea303811773d04ea084b30d22380d2"></a><!-- doxytag: member="iHazeHull::GetPolygonCount" ref="39ea303811773d04ea084b30d22380d2" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int iHazeHull::GetPolygonCount           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
get the number of polygons 
<p>

</div>
</div><p>
<a class="anchor" name="22b033a281f90fca11277e29596f0256"></a><!-- doxytag: member="iHazeHull::GetVertex" ref="22b033a281f90fca11277e29596f0256" args="(csVector3 &amp;res, int vertex_idx) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iHazeHull::GetVertex           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>res</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>vertex_idx</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
get a vertex by index 
<p>

</div>
</div><p>
<a class="anchor" name="bb277811883a6635a1cb462ca16df58e"></a><!-- doxytag: member="iHazeHull::GetVerticeCount" ref="bb277811883a6635a1cb462ca16df58e" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int iHazeHull::GetVerticeCount           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
get the total number of vertices 
<p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>imesh/<a class="el" href="haze_8h-source.html">haze.h</a></ul>
<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>