<!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: iPortalContainer 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 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 Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iPortalContainer Struct Reference<br>
<small>
[<a class="el" href="group__engine3d.html">Crystal Space 3D Engine</a>]</small>
</h1><!-- doxytag: class="iPortalContainer" --><!-- doxytag: inherits="iBase" -->A container for portals.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="portalcontainer_8h-source.html">iengine/portalcontainer.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iPortalContainer:</div>
<div class="dynsection">
<p><center><img src="structiPortalContainer__inherit__graph.png" border="0" usemap="#iPortalContainer__inherit__map" alt="Inheritance graph"></center>
<map name="iPortalContainer__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="40,7,96,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiPortalContainer-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="structiPortal.html">iPortal</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiPortalContainer.html#f0e4cfabc98977664533d487042d9e22">CreatePortal</a> (<a class="el" href="classcsVector3.html">csVector3</a> *vertices, int num)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new portal. <a href="#f0e4cfabc98977664533d487042d9e22"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiPortalContainer.html#fc188e691c26105f786fc7c898358f73">Draw</a> (<a class="el" href="structiRenderView.html">iRenderView</a> *rview)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Render the portal container. <a href="#fc188e691c26105f786fc7c898358f73"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiPortal.html">iPortal</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiPortalContainer.html#e4fdb1f2ea384a02d69af74c55e00505">GetPortal</a> (int idx) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a specific portal. <a href="#e4fdb1f2ea384a02d69af74c55e00505"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiPortalContainer.html#0464373435981c6fb2103bc364060e3a">GetPortalCount</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of portals in this contain. <a href="#0464373435981c6fb2103bc364060e3a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiPortalContainer.html#dfd7d801f722b3f8785f77db6ce577fb">RemovePortal</a> (<a class="el" href="structiPortal.html">iPortal</a> *portal)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a portal. <a href="#dfd7d801f722b3f8785f77db6ce577fb"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A container for portals.
<p>
Main creators of instances implementing this interface:<ul>
<li><a class="el" href="structiEngine.html#504165d54bce4969ed47560efa729f55" title="Create an empty portal container in some sector.">iEngine::CreatePortalContainer()</a></li><li><a class="el" href="structiEngine.html#4d22a0d356014e1808b76c1545eb2a3a" title="Convenience function to create a portal from one sector to another and make this...">iEngine::CreatePortal()</a></li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="group__scf.html#g2e8cf383ca5045f2b0c05374ff0107c3" title="Helper function around iBase::QueryInterface.">scfQueryInterface<iMeshObject>()</a> from a portal container mesh.</li></ul>
<p>
Main users of this interface:<ul>
<li><a class="el" href="structiEngine.html" title="This interface is the main interface to the 3D engine.">iEngine</a> </li></ul>
<p>Definition at line <a class="el" href="portalcontainer_8h-source.html#l00050">50</a> of file <a class="el" href="portalcontainer_8h-source.html">portalcontainer.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f0e4cfabc98977664533d487042d9e22"></a><!-- doxytag: member="iPortalContainer::CreatePortal" ref="f0e4cfabc98977664533d487042d9e22" args="(csVector3 *vertices, int num)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiPortal.html">iPortal</a>* iPortalContainer::CreatePortal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcsVector3.html">csVector3</a> * </td>
<td class="paramname"> <em>vertices</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>num</em></td><td> </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>
Create a new portal.
<p>
</div>
</div><p>
<a class="anchor" name="fc188e691c26105f786fc7c898358f73"></a><!-- doxytag: member="iPortalContainer::Draw" ref="fc188e691c26105f786fc7c898358f73" args="(iRenderView *rview)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iPortalContainer::Draw </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiRenderView.html">iRenderView</a> * </td>
<td class="paramname"> <em>rview</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Render the portal container.
<p>
</div>
</div><p>
<a class="anchor" name="e4fdb1f2ea384a02d69af74c55e00505"></a><!-- doxytag: member="iPortalContainer::GetPortal" ref="e4fdb1f2ea384a02d69af74c55e00505" args="(int idx) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiPortal.html">iPortal</a>* iPortalContainer::GetPortal </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a specific portal.
<p>
</div>
</div><p>
<a class="anchor" name="0464373435981c6fb2103bc364060e3a"></a><!-- doxytag: member="iPortalContainer::GetPortalCount" ref="0464373435981c6fb2103bc364060e3a" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iPortalContainer::GetPortalCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of portals in this contain.
<p>
</div>
</div><p>
<a class="anchor" name="dfd7d801f722b3f8785f77db6ce577fb"></a><!-- doxytag: member="iPortalContainer::RemovePortal" ref="dfd7d801f722b3f8785f77db6ce577fb" args="(iPortal *portal)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iPortalContainer::RemovePortal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiPortal.html">iPortal</a> * </td>
<td class="paramname"> <em>portal</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a portal.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iengine/<a class="el" href="portalcontainer_8h-source.html">portalcontainer.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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3468
