diff options
Diffstat (limited to 'docs/doxygen/nel/a03381.html')
| -rw-r--r-- | docs/doxygen/nel/a03381.html | 280 |
1 files changed, 280 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03381.html b/docs/doxygen/nel/a03381.html new file mode 100644 index 00000000..6704f337 --- /dev/null +++ b/docs/doxygen/nel/a03381.html @@ -0,0 +1,280 @@ +<!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::CShapeStream 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 Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NL3D::CShapeStream Class Reference</h1><code>#include <<a class="el" href="a06377.html">shape.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This class is used to serialize a shape. In reading, just create a <a class="el" href="a03381.html">CShapeStream</a> object and serial your class with your input stream using "serial (IStream&)". Then take back the shape pointer. It is yours. In writing, create a <a class="el" href="a03381.html">CShapeStream</a> object with a pointer on the <a class="el" href="a02539.html">IShape</a> you want to serialize and serial it with "serial (IStream&)". You have to register all the <a class="el" href="a02539.html">IShape</a> derived classes you want to serial. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a02539.html">IShape</a> CClassRegistry </dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a06377.html#l00178">178</a> of file <a class="el" href="a06377.html">shape.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> </td><td class="memItemRight" valign=bottom><a class="el" href="a03381.html#NL3D_1_1CShapeStreama0">CShapeStream</a> (<a class="el" href="a02539.html">IShape</a> *shape)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03381.html#NL3D_1_1CShapeStreama1">CShapeStream</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. Set the <a class="el" href="a02539.html">IShape</a> pointer to NULL. <a href="#NL3D_1_1CShapeStreama1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02539.html">IShape</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03381.html#NL3D_1_1CShapeStreama2">getShapePointer</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03381.html#NL3D_1_1CShapeStreama3">serial</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &f) throw (NLMISC::EStream)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">serial the shape. <a href="#NL3D_1_1CShapeStreama3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03381.html#NL3D_1_1CShapeStreama4">setShapePointer</a> (<a class="el" href="a02539.html">IShape</a> *shape)</td></tr> + +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02539.html">IShape</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03381.html#NL3D_1_1CShapeStreamr0">_Shape</a></td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NL3D_1_1CShapeStreama1" doxytag="NL3D::CShapeStream::CShapeStream" ></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"> NL3D::CShapeStream::CShapeStream </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Default constructor. Set the <a class="el" href="a02539.html">IShape</a> pointer to NULL. +<p> + +<p> +Definition at line <a class="el" href="a06376.html#l00091">91</a> of file <a class="el" href="a06376.html">shape.cpp</a>. +<p> +<div class="fragment"><pre>00092 { +00093 <a class="code" href="a03381.html#NL3D_1_1CShapeStreamr0">_Shape</a>=NULL; +00094 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CShapeStreama0" doxytag="NL3D::CShapeStream::CShapeStream" ></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"> NL3D::CShapeStream::CShapeStream </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02539.html">IShape</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>shape</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. Get a <a class="el" href="a02539.html">IShape</a> pointer. Used to output serialization. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>shape</em> </td><td>the pointer on the <a class="el" href="a02539.html">IShape</a> derived object you want to serialize.</td></tr> + </table> +</dl> + +<p> +Definition at line <a class="el" href="a06376.html#l00098">98</a> of file <a class="el" href="a06376.html">shape.cpp</a>. +<p> +References <a class="el" href="a06376.html#l00106">setShapePointer()</a>. +<p> +<div class="fragment"><pre>00099 { +00100 <span class="comment">// Set the pointer</span> +00101 <a class="code" href="a03381.html#NL3D_1_1CShapeStreama4">setShapePointer</a> (shape); +00102 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NL3D_1_1CShapeStreama2" doxytag="NL3D::CShapeStream::getShapePointer" ></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"> <a class="el" href="a02539.html">IShape</a> * NL3D::CShapeStream::getShapePointer </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const</td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the pointer to the <a class="el" href="a02539.html">IShape</a> object. Used to serial a shape in input. <dl compact><dt><b>Returns:</b></dt><dd>shape the pointer on the <a class="el" href="a02539.html">IShape</a> derived object serialized.</dd></dl> + +<p> +Definition at line <a class="el" href="a06376.html#l00113">113</a> of file <a class="el" href="a06376.html">shape.cpp</a>. +<p> +Referenced by <a class="el" href="a05824.html#l00305">NL3D::CInstanceLighter::light()</a>, <a class="el" href="a05824.html#l01502">NL3D::CInstanceLighter::lightIgSimple()</a>, <a class="el" href="a06378.html#l00427">NL3D::CShapeBank::load()</a>, and <a class="el" href="a05457.html#l00231">NL3D::CAsyncFileManager3D::CMeshLoad::run()</a>. +<p> +<div class="fragment"><pre>00114 { +00115 <span class="keywordflow">return</span> <a class="code" href="a03381.html#NL3D_1_1CShapeStreamr0">_Shape</a>; +00116 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CShapeStreama3" doxytag="NL3D::CShapeStream::serial" ></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"> void NL3D::CShapeStream::serial </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02270.html">NLMISC::IStream</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>f</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> throw (<a class="el" href="a03781.html">NLMISC::EStream</a>)<code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +serial the shape. +<p> + +<p> +Definition at line <a class="el" href="a06376.html#l00120">120</a> of file <a class="el" href="a06376.html">shape.cpp</a>. +<p> +References <a class="el" href="a05981.html#l00100">uint32</a>. +<p> +Referenced by <a class="el" href="a05824.html#l00305">NL3D::CInstanceLighter::light()</a>, and <a class="el" href="a05824.html#l01502">NL3D::CInstanceLighter::lightIgSimple()</a>. +<p> +<div class="fragment"><pre>00121 { +00122 <span class="comment">// First, serial an header or checking if it is correct</span> +00123 f.<a class="code" href="a02270.html#NLMISC_1_1IStreamz2035_0">serialCheck</a> ((<a class="code" href="a04558.html#a11">uint32</a>)'PAHS'); +00124 +00125 <span class="comment">// Then, serial the shape</span> +00126 f.<a class="code" href="a02270.html#NLMISC_1_1IStreamz2035_6">serialPolyPtr</a> (_Shape); +00127 +00128 <span class="comment">// Ok, it's done</span> +00129 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CShapeStreama4" doxytag="NL3D::CShapeStream::setShapePointer" ></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"> void NL3D::CShapeStream::setShapePointer </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02539.html">IShape</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>shape</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the pointer to the <a class="el" href="a02539.html">IShape</a> object. Used to serial a shape in output. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>shape</em> </td><td>the pointer on the <a class="el" href="a02539.html">IShape</a> derived object you want to serialize.</td></tr> + </table> +</dl> + +<p> +Definition at line <a class="el" href="a06376.html#l00106">106</a> of file <a class="el" href="a06376.html">shape.cpp</a>. +<p> +Referenced by <a class="el" href="a06376.html#l00098">CShapeStream()</a>. +<p> +<div class="fragment"><pre>00107 { +00108 <a class="code" href="a03381.html#NL3D_1_1CShapeStreamr0">_Shape</a>=shape; +00109 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NL3D_1_1CShapeStreamr0" doxytag="NL3D::CShapeStream::_Shape" ></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"> <a class="el" href="a02539.html">IShape</a>* <a class="el" href="a03381.html#NL3D_1_1CShapeStreamr0">NL3D::CShapeStream::_Shape</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06377.html#l00202">202</a> of file <a class="el" href="a06377.html">shape.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a06377.html">shape.h</a><li><a class="el" href="a06376.html">shape.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 07:44:15 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> |