Sophie

Sophie

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

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: iSceneNode 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>iSceneNode Struct Reference<br>
<small>
[<a class="el" href="group__engine3d.html">Crystal Space 3D Engine</a>]</small>
</h1><!-- doxytag: class="iSceneNode" --><!-- doxytag: inherits="iBase" -->This interface represents a node in the scene graph.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="scenenode_8h-source.html">iengine/scenenode.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iSceneNode:</div>
<div class="dynsection">
<p><center><img src="structiSceneNode__inherit__graph.png" border="0" usemap="#iSceneNode__inherit__map" alt="Inheritance graph"></center>
<map name="iSceneNode__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="27,7,83,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiSceneNode-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 <br>
<a class="el" href="classcsRefArray.html">csRefArray</a><br>
&lt; <a class="el" href="structiSceneNode.html">iSceneNode</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSceneNode.html#8766708183db53c92810db7b311ea163">GetChildren</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The children of this scene node.  <a href="#8766708183db53c92810db7b311ea163"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a><br>
&lt; <a class="el" href="structiSceneNodeArray.html">iSceneNodeArray</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSceneNode.html#6afac70a5e96a264235456d8ff8c0028">GetChildrenArray</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The children of this scene node.  <a href="#6afac70a5e96a264235456d8ff8c0028"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiMovable.html">iMovable</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSceneNode.html#2916081f052599ce3e5d9af7994da914">GetMovable</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the movable for this scene node.  <a href="#2916081f052599ce3e5d9af7994da914"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiSceneNode.html">iSceneNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSceneNode.html#7aef1c02e66868580f9108bb3ec07d2e">GetParent</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the parent scene node.  <a href="#7aef1c02e66868580f9108bb3ec07d2e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiCamera.html">iCamera</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSceneNode.html#3fb7125c1d03bc40d91563f47705059f">QueryCamera</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the corresponding camera.  <a href="#3fb7125c1d03bc40d91563f47705059f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiLight.html">iLight</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSceneNode.html#962847d52d9a71d7c75dbf668654da92">QueryLight</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the corresponding light.  <a href="#962847d52d9a71d7c75dbf668654da92"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiMeshWrapper.html">iMeshWrapper</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSceneNode.html#8c90a461189cbed9ba858012fe134e49">QueryMesh</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the corresponding mesh.  <a href="#8c90a461189cbed9ba858012fe134e49"></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="structiSceneNode.html#e524be2495c2a22cb019cb8626a56efe">SetParent</a> (<a class="el" href="structiSceneNode.html">iSceneNode</a> *parent)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the parent scene node.  <a href="#e524be2495c2a22cb019cb8626a56efe"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This interface represents a node in the scene graph. 
<p>
It basically represents an object, light, or camera. The scene graph is build out of scene nodes and movables.<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="structiMeshWrapper.html#eb7e6250d1212132215b2bc22e88a63b" title="Get the scene node that this object represents.">iMeshWrapper::QuerySceneNode()</a></li><li><a class="el" href="structiLight.html#8a30a1abe6d01660d6a4f2e4fde35ca5" title="Get the scene node that this object represents.">iLight::QuerySceneNode()</a></li><li><a class="el" href="structiCamera.html#ec8055b3a79a5ffe1097340cec91ddf0" title="Get the scene node that this object represents.">iCamera::QuerySceneNode()</a></li><li><a class="el" href="structiMovable.html#143c8f53fdcb9d6fa3e8ae52af4c44ac" title="Get the scene node that this movable belongs too.">iMovable::GetSceneNode()</a></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="scenenode_8h-source.html#l00063">63</a> of file <a class="el" href="scenenode_8h-source.html">scenenode.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8766708183db53c92810db7b311ea163"></a><!-- doxytag: member="iSceneNode::GetChildren" ref="8766708183db53c92810db7b311ea163" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="classcsRefArray.html">csRefArray</a>&lt;<a class="el" href="structiSceneNode.html">iSceneNode</a>&gt;&amp; iSceneNode::GetChildren           </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>
The children of this scene node. 
<p>

</div>
</div><p>
<a class="anchor" name="6afac70a5e96a264235456d8ff8c0028"></a><!-- doxytag: member="iSceneNode::GetChildrenArray" ref="6afac70a5e96a264235456d8ff8c0028" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a>&lt;<a class="el" href="structiSceneNodeArray.html">iSceneNodeArray</a>&gt; iSceneNode::GetChildrenArray           </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>
The children of this scene node. 
<p>

</div>
</div><p>
<a class="anchor" name="2916081f052599ce3e5d9af7994da914"></a><!-- doxytag: member="iSceneNode::GetMovable" ref="2916081f052599ce3e5d9af7994da914" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiMovable.html">iMovable</a>* iSceneNode::GetMovable           </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 movable for this scene node. 
<p>

</div>
</div><p>
<a class="anchor" name="7aef1c02e66868580f9108bb3ec07d2e"></a><!-- doxytag: member="iSceneNode::GetParent" ref="7aef1c02e66868580f9108bb3ec07d2e" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiSceneNode.html">iSceneNode</a>* iSceneNode::GetParent           </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 parent scene node. 
<p>

</div>
</div><p>
<a class="anchor" name="3fb7125c1d03bc40d91563f47705059f"></a><!-- doxytag: member="iSceneNode::QueryCamera" ref="3fb7125c1d03bc40d91563f47705059f" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiCamera.html">iCamera</a>* iSceneNode::QueryCamera           </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 corresponding camera. 
<p>
Returns 0 if this is not a node for a camera. 
</div>
</div><p>
<a class="anchor" name="962847d52d9a71d7c75dbf668654da92"></a><!-- doxytag: member="iSceneNode::QueryLight" ref="962847d52d9a71d7c75dbf668654da92" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiLight.html">iLight</a>* iSceneNode::QueryLight           </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 corresponding light. 
<p>
Returns 0 if this is not a node for a light. 
</div>
</div><p>
<a class="anchor" name="8c90a461189cbed9ba858012fe134e49"></a><!-- doxytag: member="iSceneNode::QueryMesh" ref="8c90a461189cbed9ba858012fe134e49" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiMeshWrapper.html">iMeshWrapper</a>* iSceneNode::QueryMesh           </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 corresponding mesh. 
<p>
Returns 0 if this is not a node for a mesh. 
</div>
</div><p>
<a class="anchor" name="e524be2495c2a22cb019cb8626a56efe"></a><!-- doxytag: member="iSceneNode::SetParent" ref="e524be2495c2a22cb019cb8626a56efe" args="(iSceneNode *parent)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iSceneNode::SetParent           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiSceneNode.html">iSceneNode</a> *&nbsp;</td>
          <td class="paramname"> <em>parent</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the parent scene node. 
<p>

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