Sophie

Sophie

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

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: iMapNode 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>iMapNode Struct Reference</h1><!-- doxytag: class="iMapNode" --><!-- doxytag: inherits="iBase" -->A node.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="ivaria_2mapnode_8h-source.html">ivaria/mapnode.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iMapNode:</div>
<div class="dynsection">
<p><center><img src="structiMapNode__inherit__graph.png" border="0" usemap="#iMapNode__inherit__map" alt="Inheritance graph"></center>
<map name="iMapNode__inherit__map">
<area shape="rect" href="classscfImplementationExt1.html" title="scfImplementationExt1\&lt; csMapNode, csObject, iMapNode \&gt;" alt="" coords="5,161,419,188"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="184,7,240,33"><area shape="rect" href="classcsMapNode.html" title="A node." alt="" coords="164,239,260,265"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiMapNode-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 const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMapNode.html#1842a1272dc10806b9a0f18dfbdcc0de">GetPosition</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the position of the node.  <a href="#1842a1272dc10806b9a0f18dfbdcc0de"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiSector.html">iSector</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMapNode.html#5c60128c94580cb62563eb17d6a6825a">GetSector</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the sector of the node.  <a href="#5c60128c94580cb62563eb17d6a6825a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMapNode.html#367c54b2d0a8cc61557750a0afd72754">GetXVector</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the x vector of the node.  <a href="#367c54b2d0a8cc61557750a0afd72754"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMapNode.html#dee115f3f24a322932ab41766cb68a93">GetYVector</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the y vector of the node.  <a href="#dee115f3f24a322932ab41766cb68a93"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMapNode.html#3c4bbcfd50c116537469752f10dd6e9b">GetZVector</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the z vector of the node.  <a href="#3c4bbcfd50c116537469752f10dd6e9b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiObject.html">iObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMapNode.html#b857ca299b076df1aa20c68ff08a70b3">QueryObject</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>.  <a href="#b857ca299b076df1aa20c68ff08a70b3"></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="structiMapNode.html#5f392190f15710cbb50793ea68ed6928">SetPosition</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &amp;pos)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the position of the node.  <a href="#5f392190f15710cbb50793ea68ed6928"></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="structiMapNode.html#cea211be10e49c3e40b23fc8ca119e34">SetSector</a> (<a class="el" href="structiSector.html">iSector</a> *pSector)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the sector of the node.  <a href="#cea211be10e49c3e40b23fc8ca119e34"></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="structiMapNode.html#6533fc688da094a8e13c8e2a3dfde950">SetXVector</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &amp;vec)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the x vector of the node.  <a href="#6533fc688da094a8e13c8e2a3dfde950"></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="structiMapNode.html#054a6b5cb25950156e76abeed3507410">SetYVector</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &amp;vec)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the y vector of the node.  <a href="#054a6b5cb25950156e76abeed3507410"></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="structiMapNode.html#2135076e2dbc599f94102b74311560f8">SetZVector</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &amp;vec)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the z vector of the node.  <a href="#2135076e2dbc599f94102b74311560f8"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A node. 
<p>
This is an <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> that is bound to a position and a sector in the world. Nodes are typically created from a map file using the &lt;node&gt; attribute.<p>
Main creators of instances implementing this interface:<ul>
<li>The main loader creates instances of this internally.</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()</a> from <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> instances you get by calling <a class="el" href="structiObject.html#7d556c40d0c2f474559145bd257660e6" title="Return an iterator for all child objects.">iObject::GetIterator()</a> on <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> instances you get from <a class="el" href="structiSector.html#2cfe19e91ce3163cd6688ee135135c31" title="Get the iObject for this sector.">iSector::QueryObject()</a>. </li></ul>

<p>Definition at line <a class="el" href="ivaria_2mapnode_8h-source.html#l00044">44</a> of file <a class="el" href="ivaria_2mapnode_8h-source.html">mapnode.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1842a1272dc10806b9a0f18dfbdcc0de"></a><!-- doxytag: member="iMapNode::GetPosition" ref="1842a1272dc10806b9a0f18dfbdcc0de" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="classcsVector3.html">csVector3</a>&amp; iMapNode::GetPosition           </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>
Get the position of the node. 
<p>

<p>Implemented in <a class="el" href="classcsMapNode.html#ca3af07877181de149972417dd939311">csMapNode</a>.</p>

</div>
</div><p>
<a class="anchor" name="5c60128c94580cb62563eb17d6a6825a"></a><!-- doxytag: member="iMapNode::GetSector" ref="5c60128c94580cb62563eb17d6a6825a" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiSector.html">iSector</a>* iMapNode::GetSector           </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>
Get the sector of the node. 
<p>

<p>Implemented in <a class="el" href="classcsMapNode.html#5618ff6289318b123816b7465412b334">csMapNode</a>.</p>

</div>
</div><p>
<a class="anchor" name="367c54b2d0a8cc61557750a0afd72754"></a><!-- doxytag: member="iMapNode::GetXVector" ref="367c54b2d0a8cc61557750a0afd72754" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="classcsVector3.html">csVector3</a>&amp; iMapNode::GetXVector           </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>
Get the x vector of the node. 
<p>

<p>Implemented in <a class="el" href="classcsMapNode.html#f761b5e784fbbae7d0c3a53334f427a9">csMapNode</a>.</p>

</div>
</div><p>
<a class="anchor" name="dee115f3f24a322932ab41766cb68a93"></a><!-- doxytag: member="iMapNode::GetYVector" ref="dee115f3f24a322932ab41766cb68a93" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="classcsVector3.html">csVector3</a>&amp; iMapNode::GetYVector           </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>
Get the y vector of the node. 
<p>

<p>Implemented in <a class="el" href="classcsMapNode.html#51e5043ddd997a27d7975169a51443fc">csMapNode</a>.</p>

</div>
</div><p>
<a class="anchor" name="3c4bbcfd50c116537469752f10dd6e9b"></a><!-- doxytag: member="iMapNode::GetZVector" ref="3c4bbcfd50c116537469752f10dd6e9b" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="classcsVector3.html">csVector3</a>&amp; iMapNode::GetZVector           </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>
Get the z vector of the node. 
<p>

<p>Implemented in <a class="el" href="classcsMapNode.html#8b1f4b5e5fa48c5424164de28e2c2c2c">csMapNode</a>.</p>

</div>
</div><p>
<a class="anchor" name="b857ca299b076df1aa20c68ff08a70b3"></a><!-- doxytag: member="iMapNode::QueryObject" ref="b857ca299b076df1aa20c68ff08a70b3" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiObject.html">iObject</a>* iMapNode::QueryObject           </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>
Get the <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>. 
<p>

<p>Implemented in <a class="el" href="classcsMapNode.html#fad30d54e55b125a3787c1cc345ff688">csMapNode</a>.</p>

</div>
</div><p>
<a class="anchor" name="5f392190f15710cbb50793ea68ed6928"></a><!-- doxytag: member="iMapNode::SetPosition" ref="5f392190f15710cbb50793ea68ed6928" args="(const csVector3 &amp;pos)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iMapNode::SetPosition           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>pos</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the position of the node. 
<p>

<p>Implemented in <a class="el" href="classcsMapNode.html#01eae0831dcdc66124c25018250fe61d">csMapNode</a>.</p>

</div>
</div><p>
<a class="anchor" name="cea211be10e49c3e40b23fc8ca119e34"></a><!-- doxytag: member="iMapNode::SetSector" ref="cea211be10e49c3e40b23fc8ca119e34" args="(iSector *pSector)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iMapNode::SetSector           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiSector.html">iSector</a> *&nbsp;</td>
          <td class="paramname"> <em>pSector</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the sector of the node. 
<p>

<p>Implemented in <a class="el" href="classcsMapNode.html#4dcc3d9005f231c3a51127c27871d3b1">csMapNode</a>.</p>

</div>
</div><p>
<a class="anchor" name="6533fc688da094a8e13c8e2a3dfde950"></a><!-- doxytag: member="iMapNode::SetXVector" ref="6533fc688da094a8e13c8e2a3dfde950" args="(const csVector3 &amp;vec)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iMapNode::SetXVector           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>vec</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the x vector of the node. 
<p>

<p>Implemented in <a class="el" href="classcsMapNode.html#417b7021e3e01d0d429801919512e085">csMapNode</a>.</p>

</div>
</div><p>
<a class="anchor" name="054a6b5cb25950156e76abeed3507410"></a><!-- doxytag: member="iMapNode::SetYVector" ref="054a6b5cb25950156e76abeed3507410" args="(const csVector3 &amp;vec)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iMapNode::SetYVector           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>vec</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the y vector of the node. 
<p>

<p>Implemented in <a class="el" href="classcsMapNode.html#d7676197e97e6d9dcdc0baa362ff36a2">csMapNode</a>.</p>

</div>
</div><p>
<a class="anchor" name="2135076e2dbc599f94102b74311560f8"></a><!-- doxytag: member="iMapNode::SetZVector" ref="2135076e2dbc599f94102b74311560f8" args="(const csVector3 &amp;vec)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iMapNode::SetZVector           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>vec</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the z vector of the node. 
<p>

<p>Implemented in <a class="el" href="classcsMapNode.html#2f943921fcec228fa46b81f9427e4eda">csMapNode</a>.</p>

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