aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/classNL3D_1_1CShapeStream.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen/nel/classNL3D_1_1CShapeStream.html')
-rw-r--r--docs/doxygen/nel/classNL3D_1_1CShapeStream.html321
1 files changed, 321 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNL3D_1_1CShapeStream.html b/docs/doxygen/nel/classNL3D_1_1CShapeStream.html
new file mode 100644
index 00000000..7cfc3b00
--- /dev/null
+++ b/docs/doxygen/nel/classNL3D_1_1CShapeStream.html
@@ -0,0 +1,321 @@
+<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
+<HTML>
+<HEAD>
+ <TITLE>nevrax.org : docs</TITLE>
+ <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css">
+ <link href="doxygen.css" rel="stylesheet" type="text/css">
+</HEAD>
+<BODY MARGINHEIGHT="0" MARGINWIDTH="0">
+
+<!-- uplinks -->
+<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
+ <TR>
+ <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
+ <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
+ </TR>
+</TABLE>
+
+<!-- banner Nevrax -->
+<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%>
+ <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR>
+</TABLE>
+
+<!-- main table -->
+<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%>
+ <TR>
+ <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD>
+ <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">
+
+ <!------ Begin Box ------>
+ <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black>
+ <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF>
+ <TABLE cellspacing=0 cellpadding=1 border=0>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr>
+ </TABLE>
+ </TD></TR></TABLE></TD></TR></TABLE>
+ <!------ End Box ------>
+
+ </TD>
+ <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">
+
+<!-- title -->
+<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td>
+<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A>
+</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT="">
+</td></tr></table>
+&nbsp;
+
+<!-- block -->
+<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD>
+ <TD><B>Documentation</B></TD>
+ <TD ALIGN=RIGHT>&nbsp;</td>
+</tr></table>
+<!-- Generated by Doxygen 1.2.14 -->
+<center>
+<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> &nbsp; </center>
+<hr><h1>NL3D::CShapeStream Class Reference</h1>This class is used to serialize a shape.
+<a href="#_details">More...</a>
+<p>
+<code>#include &lt;<a class="el" href="shape_8h-source.html">shape.h</a>&gt;</code>
+<p>
+<a href="classNL3D_1_1CShapeStream-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
+<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
+<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CShapeStream.html#a0">CShapeStream</a> ()</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Default constructor. Set the <a class="el" href="classNL3D_1_1IShape.html">IShape</a> pointer to NULL.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CShapeStream.html#a1">CShapeStream</a> (<a class="el" href="classNL3D_1_1IShape.html">IShape</a> *shape)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Constructor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CShapeStream.html#a2">setShapePointer</a> (<a class="el" href="classNL3D_1_1IShape.html">IShape</a> *shape)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Set the pointer to the <a class="el" href="classNL3D_1_1IShape.html">IShape</a> object.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a class="el" href="classNL3D_1_1IShape.html">IShape</a> *&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CShapeStream.html#a3">getShapePointer</a> () const</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Get the pointer to the <a class="el" href="classNL3D_1_1IShape.html">IShape</a> object.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CShapeStream.html#a4">serial</a> (<a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &amp;f) throw (NLMISC::EStream)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>serial the shape.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
+<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
+<tr><td nowrap align=right valign=top><a class="el" href="classNL3D_1_1IShape.html">IShape</a> *&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CShapeStream.html#o0">_Shape</a></td></tr>
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+This class is used to serialize a shape.
+<p>
+In reading, just create a <a class="el" href="classNL3D_1_1CShapeStream.html">CShapeStream</a> object and serial your class with your input stream using "serial (IStream&amp;)". Then take back the shape pointer. It is yours. In writing, create a <a class="el" href="classNL3D_1_1CShapeStream.html">CShapeStream</a> object with a pointer on the <a class="el" href="classNL3D_1_1IShape.html">IShape</a> you want to serialize and serial it with "serial (IStream&amp;)". You have to register all the <a class="el" href="classNL3D_1_1IShape.html">IShape</a> derived classes you want to serial. <dl compact><dt><b>
+See also: </b><dd>
+<a class="el" href="classNL3D_1_1IShape.html">IShape</a> CClassRegistry </dl>
+<p>
+
+<p>
+Definition at line <a class="el" href="shape_8h-source.html#l00172">172</a> of file <a class="el" href="shape_8h-source.html">shape.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a name="a0" doxytag="NL3D::CShapeStream::CShapeStream"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> NL3D::CShapeStream::CShapeStream </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Default constructor. Set the <a class="el" href="classNL3D_1_1IShape.html">IShape</a> pointer to NULL.
+<p>
+
+<p>
+Definition at line <a class="el" href="shape_8cpp-source.html#l00091">91</a> of file <a class="el" href="shape_8cpp-source.html">shape.cpp</a>.
+<p>
+References <a class="el" href="shape_8h-source.html#l00196">_Shape</a>. </td>
+ </tr>
+</table>
+<a name="a1" doxytag="NL3D::CShapeStream::CShapeStream"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> NL3D::CShapeStream::CShapeStream </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="classNL3D_1_1IShape.html">IShape</a> *&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>shape</em> </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Constructor.
+<p>
+Get a <a class="el" href="classNL3D_1_1IShape.html">IShape</a> pointer. Used to output serialization. <dl compact><dt><b>
+Parameters: </b><dd>
+<table border=0 cellspacing=2 cellpadding=0>
+<tr><td valign=top><em>shape</em>&nbsp;</td><td>
+the pointer on the <a class="el" href="classNL3D_1_1IShape.html">IShape</a> derived object you want to serialize. </td></tr>
+</table>
+</dl>
+<p>
+Definition at line <a class="el" href="shape_8cpp-source.html#l00098">98</a> of file <a class="el" href="shape_8cpp-source.html">shape.cpp</a>.
+<p>
+References <a class="el" href="shape_8cpp-source.html#l00106">setShapePointer</a>. </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a name="a3" doxytag="NL3D::CShapeStream::getShapePointer"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> <a class="el" href="classNL3D_1_1IShape.html">IShape</a> * NL3D::CShapeStream::getShapePointer </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap> const</td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Get the pointer to the <a class="el" href="classNL3D_1_1IShape.html">IShape</a> object.
+<p>
+Used to serial a shape in input. <dl compact><dt><b>
+Returns: </b><dd>
+shape the pointer on the <a class="el" href="classNL3D_1_1IShape.html">IShape</a> derived object serialized. </dl>
+<p>
+Definition at line <a class="el" href="shape_8cpp-source.html#l00113">113</a> of file <a class="el" href="shape_8cpp-source.html">shape.cpp</a>.
+<p>
+References <a class="el" href="shape_8h-source.html#l00196">_Shape</a>. </td>
+ </tr>
+</table>
+<a name="a4" doxytag="NL3D::CShapeStream::serial"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NL3D::CShapeStream::serial </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>f</em> </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap> throw (<a class="el" href="structNLMISC_1_1EStream.html">NLMISC::EStream</a>)<code> [virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+serial the shape.
+<p>
+
+<p>
+Definition at line <a class="el" href="shape_8cpp-source.html#l00120">120</a> of file <a class="el" href="shape_8cpp-source.html">shape.cpp</a>. </td>
+ </tr>
+</table>
+<a name="a2" doxytag="NL3D::CShapeStream::setShapePointer"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NL3D::CShapeStream::setShapePointer </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="classNL3D_1_1IShape.html">IShape</a> *&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>shape</em> </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the pointer to the <a class="el" href="classNL3D_1_1IShape.html">IShape</a> object.
+<p>
+Used to serial a shape in output. <dl compact><dt><b>
+Parameters: </b><dd>
+<table border=0 cellspacing=2 cellpadding=0>
+<tr><td valign=top><em>shape</em>&nbsp;</td><td>
+the pointer on the <a class="el" href="classNL3D_1_1IShape.html">IShape</a> derived object you want to serialize. </td></tr>
+</table>
+</dl>
+<p>
+Definition at line <a class="el" href="shape_8cpp-source.html#l00106">106</a> of file <a class="el" href="shape_8cpp-source.html">shape.cpp</a>.
+<p>
+References <a class="el" href="shape_8h-source.html#l00196">_Shape</a>.
+<p>
+Referenced by <a class="el" href="shape_8cpp-source.html#l00098">CShapeStream</a>. </td>
+ </tr>
+</table>
+<hr><h2>Member Data Documentation</h2>
+<a name="o0" doxytag="NL3D::CShapeStream::_Shape"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> <a class="el" href="classNL3D_1_1IShape.html">IShape</a>* NL3D::CShapeStream::_Shape<code> [private]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="shape_8h-source.html#l00196">196</a> of file <a class="el" href="shape_8h-source.html">shape.h</a>.
+<p>
+Referenced by <a class="el" href="shape_8cpp-source.html#l00091">CShapeStream</a>, <a class="el" href="shape_8cpp-source.html#l00113">getShapePointer</a>, and <a class="el" href="shape_8cpp-source.html#l00106">setShapePointer</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following files:<ul>
+<li><a class="el" href="shape_8h-source.html">shape.h</a><li><a class="el" href="shape_8cpp-source.html">shape.cpp</a></ul>
+
+
+<!-- footer -->
+<BR><FONT Size=+5>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </FONT>
+</TD>
+<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD>
+</TR>
+</TABLE>
+</BODY>
+</HTML>