<!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: iRegion 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>iRegion Struct Reference<br>
<small>
[<a class="el" href="group__engine3d.html">Crystal Space 3D Engine</a>]</small>
</h1><!-- doxytag: class="iRegion" --><!-- doxytag: inherits="iBase" -->A region.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="region_8h-source.html">iengine/region.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iRegion:</div>
<div class="dynsection">
<p><center><img src="structiRegion__inherit__graph.png" border="0" usemap="#iRegion__inherit__map" alt="Inheritance graph"></center>
<map name="iRegion__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="11,7,67,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiRegion-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegion.html#8ead00c536e895b9316a6c8d9281fab4">Add</a> (<a class="el" href="structiObject.html">iObject</a> *obj)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an object to this region. <a href="#8ead00c536e895b9316a6c8d9281fab4"></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="structiRegion.html#23cea0f6a46d22747e6348b78ab36c33">Clear</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear this region without removing the entities in it. <a href="#23cea0f6a46d22747e6348b78ab36c33"></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="structiRegion.html#8af636613b654b9addd6b072c9026361">DeleteAll</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete all entities in this region. <a href="#8af636613b654b9addd6b072c9026361"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiCameraPosition.html">iCameraPosition</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegion.html#cb795221e56d03fc3581ddeb2ee6e937">FindCameraPosition</a> (const char *iName)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a camera position in this region by name. <a href="#cb795221e56d03fc3581ddeb2ee6e937"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="structiMaterialWrapper.html">iMaterialWrapper</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegion.html#ba8f6358d59b6d9b48a2af910e6d8630">FindMaterial</a> (const char *iName)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a material in this region by name. <a href="#ba8f6358d59b6d9b48a2af910e6d8630"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="structiMeshFactoryWrapper.html">iMeshFactoryWrapper</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegion.html#3dc23ff6e625040c9aa9f576bc4aaa91">FindMeshFactory</a> (const char *iName)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a mesh factory in this region by name. <a href="#3dc23ff6e625040c9aa9f576bc4aaa91"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiMeshWrapper.html">iMeshWrapper</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegion.html#3bdb88277cc96b8ad834a301d53b631e">FindMeshObject</a> (const char *iName)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a sprite in this region by name. <a href="#3bdb88277cc96b8ad834a301d53b631e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiSector.html">iSector</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegion.html#e92e635c013f857196f078b85436b8f4">FindSector</a> (const char *iName)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a sector in this region by name. <a href="#e92e635c013f857196f078b85436b8f4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiTextureWrapper.html">iTextureWrapper</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegion.html#d8cdd4094036d9c957d6e59d26094ae6">FindTexture</a> (const char *iName)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a texture in this region by name. <a href="#d8cdd4094036d9c957d6e59d26094ae6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegion.html#e49c519014c34dee4884dd3cef9919c1">IsInRegion</a> (<a class="el" href="structiObject.html">iObject</a> *obj)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if some object is in this region. <a href="#e49c519014c34dee4884dd3cef9919c1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegion.html#cf0a31210a67628ec28b16c4879978cf">Prepare</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prepare all objects in this region. <a href="#cf0a31210a67628ec28b16c4879978cf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegion.html#c8ac238857b5828f9fc5f55beb000c7b">PrepareTextures</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prepare all textures and materials in this region. <a href="#c8ac238857b5828f9fc5f55beb000c7b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiObject.html">iObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegion.html#75a405bbb29d58d06929280d32d8a0db">QueryObject</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> for this region. <a href="#75a405bbb29d58d06929280d32d8a0db"></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="structiRegion.html#ca7aaccffd239ad4b31dcdb08113afd9">Remove</a> (<a class="el" href="structiObject.html">iObject</a> *obj)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove an object from this region. <a href="#ca7aaccffd239ad4b31dcdb08113afd9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegion.html#e3c8d9b4ce4bfc1e6a3cf700ace715f6">ShineLights</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do lighting calculations (or read from cache). <a href="#e3c8d9b4ce4bfc1e6a3cf700ace715f6"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A region.
<p>
A region is basically a collection of objects in the 3D engine that can be treated as a unit.<p>
Main creators of instances implementing this interface:<ul>
<li><a class="el" href="structiEngine.html#115c27681a8da759bb77d5c6ddc9e58f" title="Create a new region and add it to the region list.">iEngine::CreateRegion()</a></li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="structiEngine.html#115c27681a8da759bb77d5c6ddc9e58f" title="Create a new region and add it to the region list.">iEngine::CreateRegion()</a> </li></ul>
<p>Definition at line <a class="el" href="region_8h-source.html#l00050">50</a> of file <a class="el" href="region_8h-source.html">region.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8ead00c536e895b9316a6c8d9281fab4"></a><!-- doxytag: member="iRegion::Add" ref="8ead00c536e895b9316a6c8d9281fab4" args="(iObject *obj)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iRegion::Add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiObject.html">iObject</a> * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add an object to this region.
<p>
</div>
</div><p>
<a class="anchor" name="23cea0f6a46d22747e6348b78ab36c33"></a><!-- doxytag: member="iRegion::Clear" ref="23cea0f6a46d22747e6348b78ab36c33" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iRegion::Clear </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear this region without removing the entities in it.
<p>
The entities will simply get unconnected from this region.
</div>
</div><p>
<a class="anchor" name="8af636613b654b9addd6b072c9026361"></a><!-- doxytag: member="iRegion::DeleteAll" ref="8af636613b654b9addd6b072c9026361" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iRegion::DeleteAll </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete all entities in this region.
<p>
</div>
</div><p>
<a class="anchor" name="cb795221e56d03fc3581ddeb2ee6e937"></a><!-- doxytag: member="iRegion::FindCameraPosition" ref="cb795221e56d03fc3581ddeb2ee6e937" args="(const char *iName)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiCameraPosition.html">iCameraPosition</a>* iRegion::FindCameraPosition </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>iName</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a camera position in this region by name.
<p>
</div>
</div><p>
<a class="anchor" name="ba8f6358d59b6d9b48a2af910e6d8630"></a><!-- doxytag: member="iRegion::FindMaterial" ref="ba8f6358d59b6d9b48a2af910e6d8630" args="(const char *iName)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiMaterialWrapper.html">iMaterialWrapper</a>* iRegion::FindMaterial </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>iName</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a material in this region by name.
<p>
</div>
</div><p>
<a class="anchor" name="3dc23ff6e625040c9aa9f576bc4aaa91"></a><!-- doxytag: member="iRegion::FindMeshFactory" ref="3dc23ff6e625040c9aa9f576bc4aaa91" args="(const char *iName)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiMeshFactoryWrapper.html">iMeshFactoryWrapper</a>* iRegion::FindMeshFactory </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>iName</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a mesh factory in this region by name.
<p>
</div>
</div><p>
<a class="anchor" name="3bdb88277cc96b8ad834a301d53b631e"></a><!-- doxytag: member="iRegion::FindMeshObject" ref="3bdb88277cc96b8ad834a301d53b631e" args="(const char *iName)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiMeshWrapper.html">iMeshWrapper</a>* iRegion::FindMeshObject </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>iName</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a sprite in this region by name.
<p>
</div>
</div><p>
<a class="anchor" name="e92e635c013f857196f078b85436b8f4"></a><!-- doxytag: member="iRegion::FindSector" ref="e92e635c013f857196f078b85436b8f4" args="(const char *iName)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiSector.html">iSector</a>* iRegion::FindSector </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>iName</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a sector in this region by name.
<p>
</div>
</div><p>
<a class="anchor" name="d8cdd4094036d9c957d6e59d26094ae6"></a><!-- doxytag: member="iRegion::FindTexture" ref="d8cdd4094036d9c957d6e59d26094ae6" args="(const char *iName)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiTextureWrapper.html">iTextureWrapper</a>* iRegion::FindTexture </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>iName</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a texture in this region by name.
<p>
</div>
</div><p>
<a class="anchor" name="e49c519014c34dee4884dd3cef9919c1"></a><!-- doxytag: member="iRegion::IsInRegion" ref="e49c519014c34dee4884dd3cef9919c1" args="(iObject *obj)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iRegion::IsInRegion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiObject.html">iObject</a> * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if some object is in this region.
<p>
The speed of this function is independent of the number of objects in this region (i.e. very fast).
</div>
</div><p>
<a class="anchor" name="cf0a31210a67628ec28b16c4879978cf"></a><!-- doxytag: member="iRegion::Prepare" ref="cf0a31210a67628ec28b16c4879978cf" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iRegion::Prepare </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Prepare all objects in this region.
<p>
This has to be called directly after loading new objects. This function is equivalent to calling <a class="el" href="structiRegion.html#c8ac238857b5828f9fc5f55beb000c7b" title="Prepare all textures and materials in this region.">PrepareTextures()</a> followed by <a class="el" href="structiRegion.html#e3c8d9b4ce4bfc1e6a3cf700ace715f6" title="Do lighting calculations (or read from cache).">ShineLights()</a>.
</div>
</div><p>
<a class="anchor" name="c8ac238857b5828f9fc5f55beb000c7b"></a><!-- doxytag: member="iRegion::PrepareTextures" ref="c8ac238857b5828f9fc5f55beb000c7b" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iRegion::PrepareTextures </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Prepare all textures and materials in this region.
<p>
</div>
</div><p>
<a class="anchor" name="75a405bbb29d58d06929280d32d8a0db"></a><!-- doxytag: member="iRegion::QueryObject" ref="75a405bbb29d58d06929280d32d8a0db" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiObject.html">iObject</a>* iRegion::QueryObject </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> for this region.
<p>
</div>
</div><p>
<a class="anchor" name="ca7aaccffd239ad4b31dcdb08113afd9"></a><!-- doxytag: member="iRegion::Remove" ref="ca7aaccffd239ad4b31dcdb08113afd9" args="(iObject *obj)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iRegion::Remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiObject.html">iObject</a> * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove an object from this region.
<p>
</div>
</div><p>
<a class="anchor" name="e3c8d9b4ce4bfc1e6a3cf700ace715f6"></a><!-- doxytag: member="iRegion::ShineLights" ref="e3c8d9b4ce4bfc1e6a3cf700ace715f6" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iRegion::ShineLights </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Do lighting calculations (or read from cache).
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iengine/<a class="el" href="region_8h-source.html">region.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
>
3496
