diff options
Diffstat (limited to 'docs/doxygen/nel/class_NL3D__IShape.html')
| -rw-r--r-- | docs/doxygen/nel/class_NL3D__IShape.html | 324 |
1 files changed, 324 insertions, 0 deletions
diff --git a/docs/doxygen/nel/class_NL3D__IShape.html b/docs/doxygen/nel/class_NL3D__IShape.html new file mode 100644 index 00000000..38396c80 --- /dev/null +++ b/docs/doxygen/nel/class_NL3D__IShape.html @@ -0,0 +1,324 @@ +<!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> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </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> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </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> + + +<!-- 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> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.2 on Sun May 13 22:31:47 2001 --> +<center> +<a class="qindex" href="index.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">Compound List</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">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <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> </center> +<hr><h1>NL3D::IShape Class Reference</h1>The basic interface for shapes. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="shape_h-source.html">shape.h</a>></code> +<p> +Inheritance diagram for NL3D::IShape<p><center><img src="class_NL3D__IShape_inherit_graph.gif" border="0" usemap="#NL3D::IShape_inherit_map" alt="Inheritance graph"></center> +<map name="NL3D::IShape_inherit_map"> +<area href="class_NL3D__CMesh.html" shape="rect" coords="0,200,93,219"> +<area href="class_NL3D__CParticleSystemShape.html" shape="rect" coords="117,200,293,219"> +<area href="class_NL3D__CSkeletonShape.html" shape="rect" coords="317,200,459,219"> +<area href="class_NLMISC__CRefCount.html" shape="rect" coords="61,67,192,86"> +<area href="class_NLMISC__IStreamable.html" shape="rect" coords="216,67,352,86"> +<area href="class_NLMISC__IClassable.html" shape="rect" coords="221,0,347,19"> +</map> +<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for NL3D::IShape:<p><center><img src="class_NL3D__IShape_coll_graph.gif" border="0" usemap="#NL3D::IShape_coll_map" alt="Collaboration graph"></center> +<map name="NL3D::IShape_coll_map"> +<area href="class_NLMISC__CRefCount.html" shape="rect" coords="35,99,165,118"> +<area href="class_NLMISC__CRefCount__CPtrInfo.html" shape="rect" coords="0,0,187,19"> +<area href="class_NLMISC__IStreamable.html" shape="rect" coords="200,99,336,118"> +<area href="class_NLMISC__IClassable.html" shape="rect" coords="211,0,336,19"> +</map> +<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_NL3D__IShape-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> </td><td valign=bottom><a class="el" href="class_NL3D__IShape.html#a0">IShape</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="class_NL3D__IShape.html#a1">~IShape</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Dtor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_NL3D__CTransformShape.html">CTransformShape</a>* </td><td valign=bottom><a class="el" href="class_NL3D__IShape.html#a2">createInstance</a> (<a class="el" href="class_NL3D__CScene.html">CScene</a> &scene)</td></tr> +<tr><td> </td><td><font size=-1><em>create an instance of this shape.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="class_NL3D__IShape.html#a3">clip</a> (const std::vector<CPlane> &pyramid)</td></tr> +<tr><td> </td><td><font size=-1><em>clip this shape with a pyramid.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_NL3D__IShape.html#a4">render</a> (<a class="el" href="class_NL3D__IDriver.html">IDriver</a> *drv, <a class="el" href="class_NL3D__CTransformShape.html">CTransformShape</a> *trans) = 0</td></tr> +<tr><td> </td><td><font size=-1><em><a class="el" href="class_NL3D__IShape.html#a4">render</a>() this shape in a driver, with the specified TransformShape information.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The basic interface for shapes. +<p> +A shape is a kind of instanciable mesh. For simplicity, <a class="el" href="class_NL3D__IShape.html#a4">render</a>() and <a class="el" href="class_NL3D__IShape.html#a3">clip</a>() virtual method are provided, so majority of shape could be implemented by just define those methods, and let <a class="el" href="class_NL3D__IShape.html#a2">createInstance</a>() as default. But other complex shapes may be defined, by implement a compatible model which will comunicate with them. +<p> +Serialisation of a shape MUST be done with ISTREAM::serialPolyPtr. +<p> +<b>DERIVER</b> <b>RULES</b>:<ul> +<li>simple: just implement <a class="el" href="class_NL3D__IShape.html#a3">clip</a>() and <a class="el" href="class_NL3D__IShape.html#a4">render</a>(). The shape will be movable via <a class="el" href="class_NL3D__CTransform.html">CTransform</a>.<li>complex: if special interaction is needed between the instance and the shape:<ul> +<li>implement a special Model, derived from <a class="el" href="class_NL3D__CTransformShape.html">CTransformShape</a>, adding your instance behavior.<li>implement YourShape::createInstance(), so it create this good model.<li>implement your own communication system between the model and the shape.</ul> +</ul> +<dl compact><dt> +<b>Author(s): </b><dd> + Lionel Berenguier , Nevrax France </dl><dl compact><dt> +<b>Date: </b><dd> + 2000 </dl> +<p> + +<p> +Definition at line <a class="el" href="shape_h-source.html#l00066">66</a> of file <a class="el" href="shape_h-source.html">shape.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NL3D::IShape::IShape"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +NL3D::IShape::IShape ( + </b></td> + <td valign="bottom"><b> +)<code> [inline]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="shape_h-source.html#l00071">71</a> of file <a class="el" href="shape_h-source.html">shape.h</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NL3D::IShape::~IShape"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +NL3D::IShape::~IShape ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Dtor. +<p> + +<p> +Definition at line <a class="el" href="shape_h-source.html#l00073">73</a> of file <a class="el" href="shape_h-source.html">shape.h</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a3" doxytag="NL3D::IShape::clip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +bool NL3D::IShape::clip ( + </b></td> + <td valign="bottom"><b> +const std::vector< CPlane >& <em>pyramid</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +clip this shape with a pyramid. +<p> +the pyramid is given in object space so the shape do not need to know the matrix of the object. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>pyramid</em> + </td><td> + the clipping polytope, planes MUST be normalized. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> + true if the object is visible, false otherwise. The default behavior is to return true (never clipped). </dl> +<p> +Reimplemented in <a class="el" href="class_NL3D__CMesh.html#a10">NL3D::CMesh</a>, <a class="el" href="class_NL3D__CParticleSystemShape.html#a5">NL3D::CParticleSystemShape</a>, and <a class="el" href="class_NL3D__CSkeletonShape.html#a4">NL3D::CSkeletonShape</a>. +<p> +Definition at line <a class="el" href="shape_h-source.html#l00087">87</a> of file <a class="el" href="shape_h-source.html">shape.h</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NL3D::IShape::createInstance"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="class_NL3D__CTransformShape.html">CTransformShape</a> * NL3D::IShape::createInstance ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_NL3D__CScene.html">CScene</a> & <em>scene</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +create an instance of this shape. +<p> +The instance may be a <a class="el" href="class_NL3D__CTransformShape.html">CTransformShape</a>, or a specialized version of it. The default behavior is to createModel() a <a class="el" href="class_NL3D__CTransformShape.html">CTransformShape</a>, and just assign to it the Shape. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>scene</em> + </td><td> + the scene used to createModel(). </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> + the specialized instance for this shape. </dl> +<p> +Reimplemented in <a class="el" href="class_NL3D__CMesh.html#a9">NL3D::CMesh</a>, <a class="el" href="class_NL3D__CParticleSystemShape.html#a4">NL3D::CParticleSystemShape</a>, and <a class="el" href="class_NL3D__CSkeletonShape.html#a3">NL3D::CSkeletonShape</a>. +<p> +Definition at line <a class="el" href="shape_cpp-source.html#l00044">44</a> of file <a class="el" href="shape_cpp-source.html">shape.cpp</a>. </td> + </tr> +</table> +<a name="a4" doxytag="NL3D::IShape::render"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void NL3D::IShape::render ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_NL3D__IDriver.html">IDriver</a> * <em>drv</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="class_NL3D__CTransformShape.html">CTransformShape</a> * <em>trans</em> )<code> [pure virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<a class="el" href="class_NL3D__IShape.html#a4">render</a>() this shape in a driver, with the specified TransformShape information. +<p> +CTransfromShape call this method in the render traversal. +<p> +Reimplemented in <a class="el" href="class_NL3D__CMesh.html#a11">NL3D::CMesh</a>, <a class="el" href="class_NL3D__CParticleSystemShape.html#a6">NL3D::CParticleSystemShape</a>, and <a class="el" href="class_NL3D__CSkeletonShape.html#a5">NL3D::CSkeletonShape</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="shape_h-source.html">shape.h</a><li><a class="el" href="shape_cpp-source.html">shape.cpp</a></ul> + + +<!-- footer --> +<BR><FONT Size=+5> </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> |