Sophie

Sophie

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

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: csHitBeamResult 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>csHitBeamResult Struct Reference<br>
<small>
[<a class="el" href="group__engine3d__meshes.html">Mesh support</a>]</small>
</h1><!-- doxytag: class="csHitBeamResult" -->Return structure for the iMeshWrapper-&gt;HitBeam() routines.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="mesh_8h-source.html">iengine/mesh.h</a>&gt;</code>
<p>

<p>
<a href="structcsHitBeamResult-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 Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsHitBeamResult.html#5788e3ed7e5e19f5b9fb9aaa94f7503c">facehit</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Only for HitBeamBBox: Face number that was hit.  <a href="#5788e3ed7e5e19f5b9fb9aaa94f7503c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsHitBeamResult.html#330c6d9463688941e787ed02532a4227">hit</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">For all except HitBeamBBox: true if hit, false otherwise.  <a href="#330c6d9463688941e787ed02532a4227"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsVector3.html">csVector3</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsHitBeamResult.html#08fecfc060ce8bd85a8460543fc520ea">isect</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Intersection point in object space.  <a href="#08fecfc060ce8bd85a8460543fc520ea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structiMaterialWrapper.html">iMaterialWrapper</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsHitBeamResult.html#6c21e89b7987ca77ec18cfe60096bcae">material</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Only for HitBeamObject and HitBeam: the material that was hit.  <a href="#6c21e89b7987ca77ec18cfe60096bcae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsHitBeamResult.html#8e98abb2b27f2edf4e861be8bcca3b0a">polygon_idx</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Only for HitBeamObject: the polygon/triangle index that was hit.  <a href="#8e98abb2b27f2edf4e861be8bcca3b0a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsHitBeamResult.html#ee3b9a6e18a75c078e87f533d127b739">r</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Value between 0 and 1 indicating where on the segment the intersection occured.  <a href="#ee3b9a6e18a75c078e87f533d127b739"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Return structure for the iMeshWrapper-&gt;HitBeam() routines. 
<p>Definition at line <a class="el" href="mesh_8h-source.html#l00184">184</a> of file <a class="el" href="mesh_8h-source.html">mesh.h</a>.</p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="5788e3ed7e5e19f5b9fb9aaa94f7503c"></a><!-- doxytag: member="csHitBeamResult::facehit" ref="5788e3ed7e5e19f5b9fb9aaa94f7503c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structcsHitBeamResult.html#5788e3ed7e5e19f5b9fb9aaa94f7503c">csHitBeamResult::facehit</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Only for HitBeamBBox: Face number that was hit. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classcsIntersect3.html#72b865647ffce0210dfb6bb3ed157ca3" title="Intersect a segment or ray with a box.">csIntersect3::BoxSegment</a> </dd></dl>

<p>Definition at line <a class="el" href="mesh_8h-source.html#l00204">204</a> of file <a class="el" href="mesh_8h-source.html">mesh.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="330c6d9463688941e787ed02532a4227"></a><!-- doxytag: member="csHitBeamResult::hit" ref="330c6d9463688941e787ed02532a4227" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="structcsHitBeamResult.html#330c6d9463688941e787ed02532a4227">csHitBeamResult::hit</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
For all except HitBeamBBox: true if hit, false otherwise. 
<p>

<p>Definition at line <a class="el" href="mesh_8h-source.html#l00208">208</a> of file <a class="el" href="mesh_8h-source.html">mesh.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="08fecfc060ce8bd85a8460543fc520ea"></a><!-- doxytag: member="csHitBeamResult::isect" ref="08fecfc060ce8bd85a8460543fc520ea" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsVector3.html">csVector3</a> <a class="el" href="structcsHitBeamResult.html#08fecfc060ce8bd85a8460543fc520ea">csHitBeamResult::isect</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Intersection point in object space. 
<p>

<p>Definition at line <a class="el" href="mesh_8h-source.html#l00187">187</a> of file <a class="el" href="mesh_8h-source.html">mesh.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="6c21e89b7987ca77ec18cfe60096bcae"></a><!-- doxytag: member="csHitBeamResult::material" ref="6c21e89b7987ca77ec18cfe60096bcae" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structiMaterialWrapper.html">iMaterialWrapper</a>* <a class="el" href="structcsHitBeamResult.html#6c21e89b7987ca77ec18cfe60096bcae">csHitBeamResult::material</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Only for HitBeamObject and HitBeam: the material that was hit. 
<p>
Can be 0 in case the meshobject doesn't support getting the material. 
<p>Definition at line <a class="el" href="mesh_8h-source.html#l00199">199</a> of file <a class="el" href="mesh_8h-source.html">mesh.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="8e98abb2b27f2edf4e861be8bcca3b0a"></a><!-- doxytag: member="csHitBeamResult::polygon_idx" ref="8e98abb2b27f2edf4e861be8bcca3b0a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structcsHitBeamResult.html#8e98abb2b27f2edf4e861be8bcca3b0a">csHitBeamResult::polygon_idx</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Only for HitBeamObject: the polygon/triangle index that was hit. 
<p>

<p>Definition at line <a class="el" href="mesh_8h-source.html#l00194">194</a> of file <a class="el" href="mesh_8h-source.html">mesh.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="ee3b9a6e18a75c078e87f533d127b739"></a><!-- doxytag: member="csHitBeamResult::r" ref="ee3b9a6e18a75c078e87f533d127b739" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float <a class="el" href="structcsHitBeamResult.html#ee3b9a6e18a75c078e87f533d127b739">csHitBeamResult::r</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Value between 0 and 1 indicating where on the segment the intersection occured. 
<p>

<p>Definition at line <a class="el" href="mesh_8h-source.html#l00192">192</a> of file <a class="el" href="mesh_8h-source.html">mesh.h</a>.</p>

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