Sophie

Sophie

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

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: iVisibilityObject 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>iVisibilityObject Struct Reference<br>
<small>
[<a class="el" href="group__engine3d__vis.html">Visibility</a>]</small>
</h1><!-- doxytag: class="iVisibilityObject" --><!-- doxytag: inherits="iBase" -->An object that wants to know if it is visible or not for some visibility culler needs to implement this interface.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="viscull_8h-source.html">iengine/viscull.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iVisibilityObject:</div>
<div class="dynsection">
<p><center><img src="structiVisibilityObject__inherit__graph.png" border="0" usemap="#iVisibilityObject__inherit__map" alt="Inheritance graph"></center>
<map name="iVisibilityObject__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="35,7,91,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiVisibilityObject-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 <a class="el" href="classcsFlags.html">csFlags</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiVisibilityObject.html#cc0dcbf6bacf04dee327aa3d5214e898">GetCullerFlags</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get flags for this object.  <a href="#cc0dcbf6bacf04dee327aa3d5214e898"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiMeshWrapper.html">iMeshWrapper</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiVisibilityObject.html#e372954a163379ab43dc71169b3d547d">GetMeshWrapper</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the reference to the mesh wrapper from this object.  <a href="#e372954a163379ab43dc71169b3d547d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiMovable.html">iMovable</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiVisibilityObject.html#9e0b3f844147c87b56d3bf944d4eea7b">GetMovable</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the reference to the movable from this object.  <a href="#9e0b3f844147c87b56d3bf944d4eea7b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiObjectModel.html">iObjectModel</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiVisibilityObject.html#11860dcf9e8f8da8fc54112ae6057a00">GetObjectModel</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the object model corresponding with this object.  <a href="#11860dcf9e8f8da8fc54112ae6057a00"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An object that wants to know if it is visible or not for some visibility culler needs to implement this interface. 
<p>
Main creators of instances implementing this interface:<ul>
<li>Mesh wrapper in the engine implements this.</li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="group__scf.html#g4866d026c88c980b43d36906766c5db6">SCF_QUERY_INTERFACE()</a> from <a class="el" href="structiMeshWrapper.html" title="A mesh wrapper is an engine-level object that wraps around an actual mesh object...">iMeshWrapper</a>.</li></ul>
<p>
Main users of this interface:<ul>
<li>Visibility culler plugins (<a class="el" href="structiVisibilityCuller.html" title="This interface represents a visibility culling system.">iVisibilityCuller</a>). </li></ul>

<p>Definition at line <a class="el" href="viscull_8h-source.html#l00252">252</a> of file <a class="el" href="viscull_8h-source.html">viscull.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="cc0dcbf6bacf04dee327aa3d5214e898"></a><!-- doxytag: member="iVisibilityObject::GetCullerFlags" ref="cc0dcbf6bacf04dee327aa3d5214e898" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classcsFlags.html">csFlags</a>&amp; iVisibilityObject::GetCullerFlags           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get flags for this object. 
<p>
This is a combination of zero or more of the following flags. See the documentation with these flags for more info:<ul>
<li><a class="el" href="group__engine3d__vis.html#g39aedbb767403fb92218c04880bea2a6" title="This is a good occluder.">CS_CULLER_HINT_GOODOCCLUDER</a></li><li><a class="el" href="group__engine3d__vis.html#gf9eaf6c105d2c8abc6ed0068e8a64657" title="This is a bad occluder.">CS_CULLER_HINT_BADOCCLUDER</a> </li></ul>

</div>
</div><p>
<a class="anchor" name="e372954a163379ab43dc71169b3d547d"></a><!-- doxytag: member="iVisibilityObject::GetMeshWrapper" ref="e372954a163379ab43dc71169b3d547d" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiMeshWrapper.html">iMeshWrapper</a>* iVisibilityObject::GetMeshWrapper           </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 reference to the mesh wrapper from this object. 
<p>

</div>
</div><p>
<a class="anchor" name="9e0b3f844147c87b56d3bf944d4eea7b"></a><!-- doxytag: member="iVisibilityObject::GetMovable" ref="9e0b3f844147c87b56d3bf944d4eea7b" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiMovable.html">iMovable</a>* iVisibilityObject::GetMovable           </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 reference to the movable from this object. 
<p>

</div>
</div><p>
<a class="anchor" name="11860dcf9e8f8da8fc54112ae6057a00"></a><!-- doxytag: member="iVisibilityObject::GetObjectModel" ref="11860dcf9e8f8da8fc54112ae6057a00" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiObjectModel.html">iObjectModel</a>* iVisibilityObject::GetObjectModel           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the object model corresponding with this object. 
<p>

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