Sophie

Sophie

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

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: iPortalCallback 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>iPortalCallback Struct Reference<br>
<small>
[<a class="el" href="group__engine3d.html">Crystal Space 3D Engine</a>]</small>
</h1><!-- doxytag: class="iPortalCallback" --><!-- doxytag: inherits="iBase" -->When a sector is missing this callback will be called.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="portal_8h-source.html">iengine/portal.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iPortalCallback:</div>
<div class="dynsection">
<p><center><img src="structiPortalCallback__inherit__graph.png" border="0" usemap="#iPortalCallback__inherit__map" alt="Inheritance graph"></center>
<map name="iPortalCallback__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="structiPortalCallback-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 bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiPortalCallback.html#ab9f0a5403ee0f6b010a4db43270beeb">Traverse</a> (<a class="el" href="structiPortal.html">iPortal</a> *portal, <a class="el" href="structiBase.html">iBase</a> *context)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Traverse to the portal.  <a href="#ab9f0a5403ee0f6b010a4db43270beeb"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
When a sector is missing this callback will be called. 
<p>
If this callback returns false then this portal will not be traversed. Otherwise this callback has to set up the destination sector and return true. The given context will be either an instance of <a class="el" href="structiRenderView.html" title="This interface represents all information needed to render some object in a current...">iRenderView</a>, <a class="el" href="structiFrustumView.html" title="This structure represents all information needed for the frustum visibility calculator...">iFrustumView</a>, or else 0.<p>
This callback is used by:<ul>
<li><a class="el" href="structiPortal.html" title="This is the interface to the Portal objects.">iPortal</a> </li></ul>

<p>Definition at line <a class="el" href="portal_8h-source.html#l00129">129</a> of file <a class="el" href="portal_8h-source.html">portal.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ab9f0a5403ee0f6b010a4db43270beeb"></a><!-- doxytag: member="iPortalCallback::Traverse" ref="ab9f0a5403ee0f6b010a4db43270beeb" args="(iPortal *portal, iBase *context)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iPortalCallback::Traverse           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiPortal.html">iPortal</a> *&nbsp;</td>
          <td class="paramname"> <em>portal</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structiBase.html">iBase</a> *&nbsp;</td>
          <td class="paramname"> <em>context</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Traverse to the portal. 
<p>
It is safe to delete this callback in this function. 
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iengine/<a class="el" href="portal_8h-source.html">portal.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>