<!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: iRegionList 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>iRegionList Struct Reference<br>
<small>
[<a class="el" href="group__engine3d.html">Crystal Space 3D Engine</a>]</small>
</h1><!-- doxytag: class="iRegionList" --><!-- doxytag: inherits="iBase" -->A list of region objects.
<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 iRegionList:</div>
<div class="dynsection">
<p><center><img src="structiRegionList__inherit__graph.png" border="0" usemap="#iRegionList__inherit__map" alt="Inheritance graph"></center>
<map name="iRegionList__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="23,7,79,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiRegionList-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 int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegionList.html#15202e660f3305d5da89c66ba577dce5">Add</a> (<a class="el" href="structiRegion.html">iRegion</a> *obj)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a region. <a href="#15202e660f3305d5da89c66ba577dce5"></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="structiRegionList.html#bbc3b8c8c6088f3dfb3ab516471f5e41">Find</a> (<a class="el" href="structiRegion.html">iRegion</a> *obj) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a region and return its index. <a href="#bbc3b8c8c6088f3dfb3ab516471f5e41"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiRegion.html">iRegion</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegionList.html#9ef9ed1d0f4ba1b2c7ce60f9efbbb946">FindByName</a> (const char *Name) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a region by name. <a href="#9ef9ed1d0f4ba1b2c7ce60f9efbbb946"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiRegion.html">iRegion</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiRegionList.html#87d792ddc27b7f0bdbc19dc5390da0b9">Get</a> (int n) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a region by index. <a href="#87d792ddc27b7f0bdbc19dc5390da0b9"></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="structiRegionList.html#437bf8987958ee6f76edbf502f80a2d4">GetCount</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of regions in this list. <a href="#437bf8987958ee6f76edbf502f80a2d4"></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="structiRegionList.html#ab8ec07dfc94567f09990c09d6c70a3e">Remove</a> (int n)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the nth region. <a href="#ab8ec07dfc94567f09990c09d6c70a3e"></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="structiRegionList.html#855016ee22f79dc9d6c0a94541af1e3b">Remove</a> (<a class="el" href="structiRegion.html">iRegion</a> *obj)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a region. <a href="#855016ee22f79dc9d6c0a94541af1e3b"></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="structiRegionList.html#c0960fcd904eadea89bed1584e5d2d7e">RemoveAll</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all regions. <a href="#c0960fcd904eadea89bed1584e5d2d7e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A list of region objects.
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="structiEngine.html#5bbd0804c6644fda86696f181a0e3bd6" title="Get the list of all regions.">iEngine::GetRegions()</a> </li></ul>
<p>Definition at line <a class="el" href="region_8h-source.html#l00122">122</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="15202e660f3305d5da89c66ba577dce5"></a><!-- doxytag: member="iRegionList::Add" ref="15202e660f3305d5da89c66ba577dce5" args="(iRegion *obj)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iRegionList::Add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiRegion.html">iRegion</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 a region.
<p>
</div>
</div><p>
<a class="anchor" name="bbc3b8c8c6088f3dfb3ab516471f5e41"></a><!-- doxytag: member="iRegionList::Find" ref="bbc3b8c8c6088f3dfb3ab516471f5e41" args="(iRegion *obj) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iRegionList::Find </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiRegion.html">iRegion</a> * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a region and return its index.
<p>
</div>
</div><p>
<a class="anchor" name="9ef9ed1d0f4ba1b2c7ce60f9efbbb946"></a><!-- doxytag: member="iRegionList::FindByName" ref="9ef9ed1d0f4ba1b2c7ce60f9efbbb946" args="(const char *Name) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiRegion.html">iRegion</a>* iRegionList::FindByName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Name</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a region by name.
<p>
</div>
</div><p>
<a class="anchor" name="87d792ddc27b7f0bdbc19dc5390da0b9"></a><!-- doxytag: member="iRegionList::Get" ref="87d792ddc27b7f0bdbc19dc5390da0b9" args="(int n) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiRegion.html">iRegion</a>* iRegionList::Get </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a region by index.
<p>
</div>
</div><p>
<a class="anchor" name="437bf8987958ee6f76edbf502f80a2d4"></a><!-- doxytag: member="iRegionList::GetCount" ref="437bf8987958ee6f76edbf502f80a2d4" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iRegionList::GetCount </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>
Return the number of regions in this list.
<p>
</div>
</div><p>
<a class="anchor" name="ab8ec07dfc94567f09990c09d6c70a3e"></a><!-- doxytag: member="iRegionList::Remove" ref="ab8ec07dfc94567f09990c09d6c70a3e" args="(int n)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iRegionList::Remove </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove the nth region.
<p>
</div>
</div><p>
<a class="anchor" name="855016ee22f79dc9d6c0a94541af1e3b"></a><!-- doxytag: member="iRegionList::Remove" ref="855016ee22f79dc9d6c0a94541af1e3b" args="(iRegion *obj)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iRegionList::Remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiRegion.html">iRegion</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 a region.
<p>
</div>
</div><p>
<a class="anchor" name="c0960fcd904eadea89bed1584e5d2d7e"></a><!-- doxytag: member="iRegionList::RemoveAll" ref="c0960fcd904eadea89bed1584e5d2d7e" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iRegionList::RemoveAll </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove all regions.
<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
>
3498
