Sophie

Sophie

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

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: iModelLoader 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>iModelLoader Struct Reference<br>
<small>
[<a class="el" href="group__loadsave.html">Loading &amp; Saving support</a>]</small>
</h1><!-- doxytag: class="iModelLoader" --><!-- doxytag: inherits="iBase" -->Some loader plugins implement this as an easier way to load a factory from code.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="modelload_8h-source.html">imap/modelload.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iModelLoader:</div>
<div class="dynsection">
<p><center><img src="structiModelLoader__inherit__graph.png" border="0" usemap="#iModelLoader__inherit__map" alt="Inheritance graph"></center>
<map name="iModelLoader__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="31,7,87,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiModelLoader-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="structiModelLoader.html#b09793396f557a7d1574806a44436057">IsRecognized</a> (<a class="el" href="structiDataBuffer.html">iDataBuffer</a> *buffer)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Test if the model is recognized by this model loader.  <a href="#b09793396f557a7d1574806a44436057"></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="structiModelLoader.html#f742ccf8747d3cedfea0f35233d58bf2">IsRecognized</a> (const char *filename)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Test if the model is recognized by this model loader.  <a href="#f742ccf8747d3cedfea0f35233d58bf2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="structiMeshFactoryWrapper.html">iMeshFactoryWrapper</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiModelLoader.html#2db59440943609726c56f2acaf811f4e">Load</a> (const char *factname, <a class="el" href="structiDataBuffer.html">iDataBuffer</a> *buffer)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a mesh factory and load the given model into it.  <a href="#2db59440943609726c56f2acaf811f4e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="structiMeshFactoryWrapper.html">iMeshFactoryWrapper</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiModelLoader.html#6805a0f80dc5db0b9f0aea4b6bce950f">Load</a> (const char *factname, const char *filename)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a mesh factory and load the given model into it.  <a href="#6805a0f80dc5db0b9f0aea4b6bce950f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Some loader plugins implement this as an easier way to load a factory from code. 
<p>
Main creators of instances implementing this interface:<ul>
<li>gmesh3ds plugin (crystalspace.mesh.loader.factory.genmesh.3ds)</li><li>spr3md2 plugin (crystalspace.mesh.loader.factory.sprite.3d.md2)</li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="group__scf.html#gb779ffb37d64ca82d74d416d188d0707" title="Tell plugin manager to load a plugin.">csLoadPlugin()</a> </li></ul>

<p>Definition at line <a class="el" href="modelload_8h-source.html#l00044">44</a> of file <a class="el" href="modelload_8h-source.html">modelload.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b09793396f557a7d1574806a44436057"></a><!-- doxytag: member="iModelLoader::IsRecognized" ref="b09793396f557a7d1574806a44436057" args="(iDataBuffer *buffer)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iModelLoader::IsRecognized           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiDataBuffer.html">iDataBuffer</a> *&nbsp;</td>
          <td class="paramname"> <em>buffer</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Test if the model is recognized by this model loader. 
<p>

</div>
</div><p>
<a class="anchor" name="f742ccf8747d3cedfea0f35233d58bf2"></a><!-- doxytag: member="iModelLoader::IsRecognized" ref="f742ccf8747d3cedfea0f35233d58bf2" args="(const char *filename)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iModelLoader::IsRecognized           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>filename</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Test if the model is recognized by this model loader. 
<p>

</div>
</div><p>
<a class="anchor" name="2db59440943609726c56f2acaf811f4e"></a><!-- doxytag: member="iModelLoader::Load" ref="2db59440943609726c56f2acaf811f4e" args="(const char *factname, iDataBuffer *buffer)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiMeshFactoryWrapper.html">iMeshFactoryWrapper</a>* iModelLoader::Load           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>factname</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structiDataBuffer.html">iDataBuffer</a> *&nbsp;</td>
          <td class="paramname"> <em>buffer</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>
Create a mesh factory and load the given model into 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>factname</em>&nbsp;</td><td>The name of the factory. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>buffer</em>&nbsp;</td><td>The buffer containing the file. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a mesh factory wrapper on success or otherwise 0. The error will be reported to the reporter. </dd></dl>

</div>
</div><p>
<a class="anchor" name="6805a0f80dc5db0b9f0aea4b6bce950f"></a><!-- doxytag: member="iModelLoader::Load" ref="6805a0f80dc5db0b9f0aea4b6bce950f" args="(const char *factname, const char *filename)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiMeshFactoryWrapper.html">iMeshFactoryWrapper</a>* iModelLoader::Load           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>factname</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>filename</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>
Create a mesh factory and load the given model into 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>factname</em>&nbsp;</td><td>The name of the factory. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The VFS name of the file. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a mesh factory wrapper on success or otherwise 0. The error will be reported to the reporter. </dd></dl>

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