Sophie

Sophie

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

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: csBaseRenderStepLoader Class 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>csBaseRenderStepLoader Class Reference<br>
<small>
[<a class="el" href="group__plugincommon.html">Common Plugin Classes</a>]</small>
</h1><!-- doxytag: class="csBaseRenderStepLoader" --><!-- doxytag: inherits="scfImplementation2&lt; csBaseRenderStepLoader, iLoaderPlugin, iComponent &gt;" -->Base class for render step loaders.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="basesteploader_8h-source.html">csplugincommon/renderstep/basesteploader.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for csBaseRenderStepLoader:</div>
<div class="dynsection">
<p><center><img src="classcsBaseRenderStepLoader__inherit__graph.png" border="0" usemap="#csBaseRenderStepLoader__inherit__map" alt="Inheritance graph"></center>
<map name="csBaseRenderStepLoader__inherit__map">
<area shape="rect" href="classscfImplementation2.html" title="scfImplementation2\&lt; csBaseRenderStepLoader, iLoaderPlugin, iComponent \&gt;" alt="" coords="156,161,687,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\&lt; csBaseRenderStepLoader \&gt;" alt="" coords="5,84,344,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="393,7,449,33"><area shape="rect" href="structiLoaderPlugin.html" title="This is a plugin for the loader based on document tree." alt="" coords="368,84,475,111"><area shape="rect" href="structiComponent.html" title="This interface describes a generic component in Crystal Space." alt="" coords="499,84,600,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="64,7,285,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classcsBaseRenderStepLoader-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 bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsBaseRenderStepLoader.html#db0825d1659e98f1a9bb1bd1be103cae">Initialize</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *<a class="el" href="classcsBaseRenderStepLoader.html#5f6152c3fc332dbc72ceebbf12f08696">object_reg</a>)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the component.  <a href="#db0825d1659e98f1a9bb1bd1be103cae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a>&lt; <a class="el" href="structiBase.html">iBase</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsBaseRenderStepLoader.html#3f792dcfa7a900c628f52d2376b68d5c">Parse</a> (<a class="el" href="structiDocumentNode.html">iDocumentNode</a> *node, <a class="el" href="structiStreamSource.html">iStreamSource</a> *ssource, <a class="el" href="structiLoaderContext.html">iLoaderContext</a> *ldr_context, <a class="el" href="structiBase.html">iBase</a> *context)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse a given document node and return a new object for it.  <a href="#3f792dcfa7a900c628f52d2376b68d5c"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f6152c3fc332dbc72ceebbf12f08696"></a><!-- doxytag: member="csBaseRenderStepLoader::object_reg" ref="5f6152c3fc332dbc72ceebbf12f08696" args="" -->
<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsBaseRenderStepLoader.html#5f6152c3fc332dbc72ceebbf12f08696">object_reg</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ef88f5ea9946096a775fe9bdaebaf644"></a><!-- doxytag: member="csBaseRenderStepLoader::synldr" ref="ef88f5ea9946096a775fe9bdaebaf644" args="" -->
<a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiSyntaxService.html">iSyntaxService</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsBaseRenderStepLoader.html#ef88f5ea9946096a775fe9bdaebaf644">synldr</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for render step loaders. 
<p>Definition at line <a class="el" href="basesteploader_8h-source.html#l00041">41</a> of file <a class="el" href="basesteploader_8h-source.html">basesteploader.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="db0825d1659e98f1a9bb1bd1be103cae"></a><!-- doxytag: member="csBaseRenderStepLoader::Initialize" ref="db0825d1659e98f1a9bb1bd1be103cae" args="(iObjectRegistry *object_reg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool csBaseRenderStepLoader::Initialize           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize the component. 
<p>
This is automatically called by system driver at startup so that plugin can do basic initialization stuff, register with the system driver and so on. 
<p>Implements <a class="el" href="structiComponent.html#b11e4707c25689ad1a88491a9ff09bf1">iComponent</a>.</p>

</div>
</div><p>
<a class="anchor" name="3f792dcfa7a900c628f52d2376b68d5c"></a><!-- doxytag: member="csBaseRenderStepLoader::Parse" ref="3f792dcfa7a900c628f52d2376b68d5c" args="(iDocumentNode *node, iStreamSource *ssource, iLoaderContext *ldr_context, iBase *context)=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="structiBase.html">iBase</a>&gt; csBaseRenderStepLoader::Parse           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiDocumentNode.html">iDocumentNode</a> *&nbsp;</td>
          <td class="paramname"> <em>node</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structiStreamSource.html">iStreamSource</a> *&nbsp;</td>
          <td class="paramname"> <em>ssource</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structiLoaderContext.html">iLoaderContext</a> *&nbsp;</td>
          <td class="paramname"> <em>ldr_context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structiBase.html">iBase</a> *&nbsp;</td>
          <td class="paramname"> <em>context</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Parse a given document node and return a new object for it. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>The node to parse. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ssource</em>&nbsp;</td><td>An optional stream source where we can get (additional) resources from, such as buffers, in a fast way. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ldr_context</em>&nbsp;</td><td>Can be used to get the context for the loading. You can use this to find meshes/materials/... </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>The context in which we are loading (can be the mesh wrapper for meshes for example). </td></tr>
  </table>
</dl>

<p>Implements <a class="el" href="structiLoaderPlugin.html#ff376915e15a6509eab7a4bdeed639ee">iLoaderPlugin</a>.</p>

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