aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a03944.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/doxygen/nel/a03944.html392
1 files changed, 392 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03944.html b/docs/doxygen/nel/a03944.html
new file mode 100644
index 00000000..d2cc6321
--- /dev/null
+++ b/docs/doxygen/nel/a03944.html
@@ -0,0 +1,392 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>NeL: NL3D::UShapeBank class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.3.6 -->
+<div class="qindex"> <form class="search" action="search.php" method="get">
+<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
+<h1>NL3D::UShapeBank Class Reference</h1><code>#include &lt;<a class="el" href="a06628.html">u_shape_bank.h</a>&gt;</code>
+<p>
+<p>Inheritance diagram for NL3D::UShapeBank:
+<p><center><img src="a03944.png" usemap="#NL3D::UShapeBank_map" border="0" alt=""></center>
+<map name="NL3D::UShapeBank_map">
+<area href="a03380.html" alt="NL3D::CShapeBankUser" shape="rect" coords="0,56,149,80">
+</map>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Game interface for managing shape bank<p>
+<dl compact><dt><b>Author:</b></dt><dd>Matthieu Besson <p>
+Nevrax France </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a06628.html#l00048">48</a> of file <a class="el" href="a06628.html">u_shape_bank.h</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 void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03944.html#NL3D_1_1UShapeBanka0">addShapeCache</a> (const std::string &amp;shapeCacheName)=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a03943.html">UShape</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03944.html#NL3D_1_1UShapeBanka1">getShape</a> (const std::string &amp;shapeName)=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03944.html#NL3D_1_1UShapeBanka2">linkShapeToShapeCache</a> (const std::string &amp;shapeName, const std::string &amp;shapeCacheName)=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03944.html#NL3D_1_1UShapeBanka3">preLoadShapesFromBNP</a> (const std::string &amp;shapeCacheName, const std::string &amp;bnpName, const std::string &amp;wildCard, <a class="el" href="a03873.html">NLMISC::IProgressCallback</a> *progress=NULL, bool flushTextures=false)=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03944.html#NL3D_1_1UShapeBanka4">preLoadShapesFromDirectory</a> (const std::string &amp;shapeCacheName, const std::string &amp;path, const std::string &amp;wildCard, bool recurs=false, <a class="el" href="a03873.html">NLMISC::IProgressCallback</a> *progress=NULL, bool flushTextures=false)=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03944.html#NL3D_1_1UShapeBanka5">removeShapeCache</a> (const std::string &amp;shapeCacheName)=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03944.html#NL3D_1_1UShapeBanka6">reset</a> ()=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03944.html#NL3D_1_1UShapeBanka7">setShapeCacheSize</a> (const std::string &amp;shapeCacheName, <a class="el" href="a04558.html#a10">sint32</a> maxSize)=0</td></tr>
+
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="NL3D_1_1UShapeBanka0" doxytag="NL3D::UShapeBank::addShapeCache" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void NL3D::UShapeBank::addShapeCache </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>shapeCacheName</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Add a new ShapeCache. If already exist do nothing.
+<p>
+Implemented in <a class="el" href="a03380.html#NL3D_1_1CShapeBankUsera0">NL3D::CShapeBankUser</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1UShapeBanka1" doxytag="NL3D::UShapeBank::getShape" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual <a class="el" href="a03943.html">UShape</a> NL3D::UShapeBank::getShape </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>shapeName</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Return a <a class="el" href="a03943.html">UShape</a> proxy from this name. NB: if not found the mesh is not loaded, and the proxy returned will be empty
+<p>
+Implemented in <a class="el" href="a03380.html#NL3D_1_1CShapeBankUsera1">NL3D::CShapeBankUser</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1UShapeBanka2" doxytag="NL3D::UShapeBank::linkShapeToShapeCache" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void NL3D::UShapeBank::linkShapeToShapeCache </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>shapeName</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>const std::string &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>shapeCacheName</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</td>
+ <td class="md" colspan="2"><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Link a shape to a ShapeCache. The ShapeCache must exist and must not contains the shape.
+<p>
+Implemented in <a class="el" href="a03380.html#NL3D_1_1CShapeBankUsera2">NL3D::CShapeBankUser</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1UShapeBanka3" doxytag="NL3D::UShapeBank::preLoadShapesFromBNP" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void NL3D::UShapeBank::preLoadShapesFromBNP </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>shapeCacheName</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>const std::string &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>bnpName</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>const std::string &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>wildCard</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap><a class="el" href="a03873.html">NLMISC::IProgressCallback</a> *&nbsp;</td>
+ <td class="mdname" nowrap> <em>progress</em> = NULL, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>bool&nbsp;</td>
+ <td class="mdname" nowrap> <em>flushTextures</em> = false</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</td>
+ <td class="md" colspan="2"><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+PreLoad all shapes (.shape, .ps, .skel...) files from a directory into a shapeCache. same as <a class="el" href="a03944.html#NL3D_1_1UShapeBanka4">preLoadShapesFromDirectory()</a> but take a BNP name which must have been added with <a class="el" href="a02261.html#NLMISC_1_1CBigFilea0">CBigFile::add()</a> or through <a class="el" href="a03072.html#NLMISC_1_1CPathe1">CPath::addSearchBigFile()</a> <dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign=top><em>bnpName</em>&nbsp;</td><td>eg: "characters.bnp" (NB: set the bigFileNAme without any path). </td></tr>
+ <tr><td valign=top><em>flushTex</em>&nbsp;</td><td>: true to flush the texture of each shape when it is loaded</td></tr>
+ </table>
+</dl>
+
+<p>
+Implemented in <a class="el" href="a03380.html#NL3D_1_1CShapeBankUsera3">NL3D::CShapeBankUser</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1UShapeBanka4" doxytag="NL3D::UShapeBank::preLoadShapesFromDirectory" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void NL3D::UShapeBank::preLoadShapesFromDirectory </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>shapeCacheName</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>const std::string &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>path</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>const std::string &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>wildCard</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>bool&nbsp;</td>
+ <td class="mdname" nowrap> <em>recurs</em> = false, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap><a class="el" href="a03873.html">NLMISC::IProgressCallback</a> *&nbsp;</td>
+ <td class="mdname" nowrap> <em>progress</em> = NULL, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>bool&nbsp;</td>
+ <td class="mdname" nowrap> <em>flushTextures</em> = false</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</td>
+ <td class="md" colspan="2"><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+PreLoad all shapes (.shape, .ps, .skel...) files from a directory into a shapeCache. Shapes are Loaded if not present, assigned to the given cache, and fit in the cache Size as max possible. NB: crash if you try to load a non shape file (eg: a .dds etc...) <dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign=top><em>shapeCacheName</em>&nbsp;</td><td>name of a shapeCache created with <a class="el" href="a03944.html#NL3D_1_1UShapeBanka0">addShapeCache()</a>/setShapeCacheSize(). no-op if don't exist </td></tr>
+ <tr><td valign=top><em>path</em>&nbsp;</td><td>a valid path (local or not) where to find shapes. NB: CPath is used to load the shapes. </td></tr>
+ <tr><td valign=top><em>wildcard</em>&nbsp;</td><td>a filter string like: "*.shape", "??_HOM*.shape". NB: strlwr-ed internally </td></tr>
+ <tr><td valign=top><em>recurs</em>&nbsp;</td><td>true if want to recurs in sub directory</td></tr>
+ </table>
+</dl>
+
+<p>
+Implemented in <a class="el" href="a03380.html#NL3D_1_1CShapeBankUsera4">NL3D::CShapeBankUser</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1UShapeBanka5" doxytag="NL3D::UShapeBank::removeShapeCache" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void NL3D::UShapeBank::removeShapeCache </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>shapeCacheName</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Remove a ShapeCache. All shapes in the shape cache are deleted. All links are redirected to the default ShapeCache.
+<p>
+Implemented in <a class="el" href="a03380.html#NL3D_1_1CShapeBankUsera5">NL3D::CShapeBankUser</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1UShapeBanka6" doxytag="NL3D::UShapeBank::reset" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void NL3D::UShapeBank::reset </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Remove all ShapeCache and suppress all links (even the link to the default cache are removed)
+<p>
+Implemented in <a class="el" href="a03380.html#NL3D_1_1CShapeBankUsera6">NL3D::CShapeBankUser</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1UShapeBanka7" doxytag="NL3D::UShapeBank::setShapeCacheSize" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void NL3D::UShapeBank::setShapeCacheSize </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>shapeCacheName</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap><a class="el" href="a04558.html#a10">sint32</a>&nbsp;</td>
+ <td class="mdname" nowrap> <em>maxSize</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</td>
+ <td class="md" colspan="2"><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the shapeCache shapeCacheName the new size.(delete shapes if maxsize&lt;shapeCacheSize).
+<p>
+Implemented in <a class="el" href="a03380.html#NL3D_1_1CShapeBankUsera7">NL3D::CShapeBankUser</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="a06628.html">u_shape_bank.h</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 08:50:05 2004 for NeL by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
+</a>1.3.6 </small></address>
+</body>
+</html>