Sophie

Sophie

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

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: iCameraPositionList 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>iCameraPositionList Struct Reference<br>
<small>
[<a class="el" href="group__engine3d__views.html">Views &amp; Cameras</a>]</small>
</h1><!-- doxytag: class="iCameraPositionList" --><!-- doxytag: inherits="iBase" -->A list of camera position objects.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="campos_8h-source.html">iengine/campos.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iCameraPositionList:</div>
<div class="dynsection">
<p><center><img src="structiCameraPositionList__inherit__graph.png" border="0" usemap="#iCameraPositionList__inherit__map" alt="Inheritance graph"></center>
<map name="iCameraPositionList__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="52,7,108,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiCameraPositionList-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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCameraPositionList.html#95ab94c2b074c9e17df52ee9bdacfb9b">Add</a> (<a class="el" href="structiCameraPosition.html">iCameraPosition</a> *obj)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a camera position.  <a href="#95ab94c2b074c9e17df52ee9bdacfb9b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCameraPositionList.html#d8843793fd9944b5914a0b32c7c4ed08">Find</a> (<a class="el" href="structiCameraPosition.html">iCameraPosition</a> *obj) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find a camera position and return its index.  <a href="#d8843793fd9944b5914a0b32c7c4ed08"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiCameraPosition.html">iCameraPosition</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCameraPositionList.html#5de4f2eb95e8ccc863e954d598c62b50">FindByName</a> (const char *Name) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find a camera position by name.  <a href="#5de4f2eb95e8ccc863e954d598c62b50"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiCameraPosition.html">iCameraPosition</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCameraPositionList.html#ccfb7d05d33cc3063a038e51fa313c14">Get</a> (int n) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a camera position by index.  <a href="#ccfb7d05d33cc3063a038e51fa313c14"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCameraPositionList.html#d2918880c25b5b2fbe4e5ad80872dbcb">GetCount</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of camera positions in this list.  <a href="#d2918880c25b5b2fbe4e5ad80872dbcb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiCameraPosition.html">iCameraPosition</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCameraPositionList.html#e2f07c78bc282954a2d5619a60e0bfbd">NewCameraPosition</a> (const char *name)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new empty camera position.  <a href="#e2f07c78bc282954a2d5619a60e0bfbd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCameraPositionList.html#28d8c9bd359f998044c5a4c13b16daff">Remove</a> (int n)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove the nth camera position.  <a href="#28d8c9bd359f998044c5a4c13b16daff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCameraPositionList.html#47912c0cf50fc4a157c3adc94f800efd">Remove</a> (<a class="el" href="structiCameraPosition.html">iCameraPosition</a> *obj)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove a camera position.  <a href="#47912c0cf50fc4a157c3adc94f800efd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiCameraPositionList.html#f058f0282a137a2759465f53de7740e8">RemoveAll</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove all camera positions.  <a href="#f058f0282a137a2759465f53de7740e8"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A list of camera position objects. 
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="structiEngine.html#348a3938335559585a520288ae188c62" title="Get the list of camera positions.">iEngine::GetCameraPositions()</a></li></ul>
<p>
Main users of this interface:<ul>
<li>Engine stores them.</li><li>Application uses them. </li></ul>

<p>Definition at line <a class="el" href="campos_8h-source.html#l00128">128</a> of file <a class="el" href="campos_8h-source.html">campos.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="95ab94c2b074c9e17df52ee9bdacfb9b"></a><!-- doxytag: member="iCameraPositionList::Add" ref="95ab94c2b074c9e17df52ee9bdacfb9b" args="(iCameraPosition *obj)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int iCameraPositionList::Add           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiCameraPosition.html">iCameraPosition</a> *&nbsp;</td>
          <td class="paramname"> <em>obj</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a camera position. 
<p>

</div>
</div><p>
<a class="anchor" name="d8843793fd9944b5914a0b32c7c4ed08"></a><!-- doxytag: member="iCameraPositionList::Find" ref="d8843793fd9944b5914a0b32c7c4ed08" args="(iCameraPosition *obj) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int iCameraPositionList::Find           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiCameraPosition.html">iCameraPosition</a> *&nbsp;</td>
          <td class="paramname"> <em>obj</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Find a camera position and return its index. 
<p>

</div>
</div><p>
<a class="anchor" name="5de4f2eb95e8ccc863e954d598c62b50"></a><!-- doxytag: member="iCameraPositionList::FindByName" ref="5de4f2eb95e8ccc863e954d598c62b50" args="(const char *Name) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiCameraPosition.html">iCameraPosition</a>* iCameraPositionList::FindByName           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>Name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Find a camera position by name. 
<p>

</div>
</div><p>
<a class="anchor" name="ccfb7d05d33cc3063a038e51fa313c14"></a><!-- doxytag: member="iCameraPositionList::Get" ref="ccfb7d05d33cc3063a038e51fa313c14" args="(int n) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiCameraPosition.html">iCameraPosition</a>* iCameraPositionList::Get           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>n</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return a camera position by index. 
<p>

</div>
</div><p>
<a class="anchor" name="d2918880c25b5b2fbe4e5ad80872dbcb"></a><!-- doxytag: member="iCameraPositionList::GetCount" ref="d2918880c25b5b2fbe4e5ad80872dbcb" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int iCameraPositionList::GetCount           </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>
Return the number of camera positions in this list. 
<p>

</div>
</div><p>
<a class="anchor" name="e2f07c78bc282954a2d5619a60e0bfbd"></a><!-- doxytag: member="iCameraPositionList::NewCameraPosition" ref="e2f07c78bc282954a2d5619a60e0bfbd" args="(const char *name)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiCameraPosition.html">iCameraPosition</a>* iCameraPositionList::NewCameraPosition           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a new empty camera position. 
<p>

</div>
</div><p>
<a class="anchor" name="28d8c9bd359f998044c5a4c13b16daff"></a><!-- doxytag: member="iCameraPositionList::Remove" ref="28d8c9bd359f998044c5a4c13b16daff" args="(int n)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iCameraPositionList::Remove           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>n</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Remove the nth camera position. 
<p>

</div>
</div><p>
<a class="anchor" name="47912c0cf50fc4a157c3adc94f800efd"></a><!-- doxytag: member="iCameraPositionList::Remove" ref="47912c0cf50fc4a157c3adc94f800efd" args="(iCameraPosition *obj)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iCameraPositionList::Remove           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiCameraPosition.html">iCameraPosition</a> *&nbsp;</td>
          <td class="paramname"> <em>obj</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Remove a camera position. 
<p>

</div>
</div><p>
<a class="anchor" name="f058f0282a137a2759465f53de7740e8"></a><!-- doxytag: member="iCameraPositionList::RemoveAll" ref="f058f0282a137a2759465f53de7740e8" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iCameraPositionList::RemoveAll           </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>
Remove all camera positions. 
<p>

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