aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a03882.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/doxygen/nel/a03882.html87
1 files changed, 87 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03882.html b/docs/doxygen/nel/a03882.html
new file mode 100644
index 00000000..26169e71
--- /dev/null
+++ b/docs/doxygen/nel/a03882.html
@@ -0,0 +1,87 @@
+<!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::ITransformName 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::ITransformName Class Reference</h1><code>#include &lt;<a class="el" href="a06608.html">u_instance_group.h</a>&gt;</code>
+<p>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Callback class used at instancegroup loading<p>
+<dl compact><dt><b>Author:</b></dt><dd>Matthieu 'TrapII' Besson <p>
+Nevrax France </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>2002 </dd></dl>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a06608.html#l00077">77</a> of file <a class="el" href="a06608.html">u_instance_group.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 std::string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03882.html#NL3D_1_1ITransformNamea0">transformName</a> (<a class="el" href="a04558.html#a15">uint</a> <a class="el" href="a04223.html#a566">index</a>, const std::string &amp;instanceName, const std::string &amp;shapeName)=0</td></tr>
+
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="NL3D_1_1ITransformNamea0" doxytag="NL3D::ITransformName::transformName" ></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 std::string NL3D::ITransformName::transformName </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a15">uint</a>&nbsp;</td>
+ <td class="mdname" nowrap> <em>index</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>instanceName</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>shapeName</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>
+transformName is called at the addToScene(Async) moment to transform the name of an instance to another name. This should be useful to replace various shapes by others like in a shape-template. The function is called with the name of the shape and the user must return the new name of the shape. NB: This is called after the 'startAddingIG' calls in the <a class="el" href="a03856.html">IIGAddBegin</a> callback <dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign=top><em>instanceName</em>&nbsp;</td><td>is the name of the instance contained in the instance group (user string) </td></tr>
+ <tr><td valign=top><em>shapeName</em>&nbsp;</td><td>is the name of the instance contained in the instance group (user string) </td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>the new name of the shape which must be loaded in place of the param</dd></dl>
+
+<p>
+Referenced by <a class="el" href="a06350.html#l00766">NL3D::CInstanceGroup::addToSceneAsync()</a>, <a class="el" href="a06350.html#l00552">NL3D::CInstanceGroup::getShapeName()</a>, and <a class="el" href="a06350.html#l00828">NL3D::CInstanceGroup::stopAddToSceneAsync()</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="a06608.html">u_instance_group.h</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 08:41:18 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>