diff options
Diffstat (limited to 'docs/doxygen/nel/classNLPACS_1_1COrderedChain.html')
| -rw-r--r-- | docs/doxygen/nel/classNLPACS_1_1COrderedChain.html | 870 |
1 files changed, 870 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLPACS_1_1COrderedChain.html b/docs/doxygen/nel/classNLPACS_1_1COrderedChain.html new file mode 100644 index 00000000..40f65616 --- /dev/null +++ b/docs/doxygen/nel/classNLPACS_1_1COrderedChain.html @@ -0,0 +1,870 @@ +<!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.14 --> +<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>NLPACS::COrderedChain Class Reference</h1>A list of ordered vertices, partially delimiting 2 different surfaces. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="chain_8h-source.html">chain.h</a>></code> +<p> +<a href="classNLPACS_1_1COrderedChain-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>const std::vector< <a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a> > & </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a0">getVertices</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the vertices of the chain.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a1">isForward</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns true if the chain should be accessed forward within the parent <a class="el" href="classNLPACS_1_1CChain.html">CChain</a> (see _Forward.).</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="types__nl_8h.html#a7">uint16</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a2">getParentId</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the parent chain Id of this ordered chain.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="types__nl_8h.html#a7">uint16</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a3">getIndexInParent</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the index of the ochain within the parent chain.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a4">getLength</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the length of the chain.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>const <a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a> & </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a5">operator[]</a> (<a class="el" href="types__nl_8h.html#a13">uint</a> n) const</td></tr> +<tr><td nowrap align=right valign=top>const <a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a> & </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a6">getMin</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the min vector of the chain.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>const <a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a> & </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a7">getMax</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the max vector of the chain.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a8">translate</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &translation)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a9">pack</a> (const <a class="el" href="classNLPACS_1_1COrderedChain3f.html">COrderedChain3f</a> &chain)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a10">computeMinMax</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a11">traverse</a> (<a class="el" href="types__nl_8h.html#a12">sint</a> <a class="el" href="ytable_8cpp.html#a132">from</a>, <a class="el" href="types__nl_8h.html#a12">sint</a> to, bool forward, std::vector< <a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a> > &path) const</td></tr> +<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a12">distance</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &position) const</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#a13">serial</a> (<a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &f)</td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>std::vector< <a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a> > </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#n0">_Vertices</a></td></tr> +<tr><td> </td><td><font size=-1><em>The vertices of the chain, ordered following x growth.</em> <a href="#n0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#n1">_Forward</a></td></tr> +<tr><td> </td><td><font size=-1><em>Set if the chain should be read forward within the parent <a class="el" href="classNLPACS_1_1CChain.html">CChain</a> (for sequential access to vertices.).</em> <a href="#n1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="types__nl_8h.html#a7">uint16</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#n2">_ParentId</a></td></tr> +<tr><td> </td><td><font size=-1><em>The parent chain Id.</em> <a href="#n2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="types__nl_8h.html#a7">uint16</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#n3">_IndexInParent</a></td></tr> +<tr><td> </td><td><font size=-1><em>The index of the ochain within the parent chain.</em> <a href="#n3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#n4">_Length</a></td></tr> +<tr><td> </td><td><font size=-1><em>The length of the chain.</em> <a href="#n4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#n5">_Min</a></td></tr> +<tr><td> </td><td><font size=-1><em>The min and max vertices of the chain.</em> <a href="#n5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#n6">_Max</a></td></tr> +<tr><td> </td><td><font size=-1><em>The min and max vertices of the chain.</em> <a href="#n6">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Friends</h2></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#l0">CChain</a></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classNLPACS_1_1COrderedChain.html#l1">CRetrievableSurface</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A list of ordered vertices, partially delimiting 2 different surfaces. +<p> +In the vertex list, we consider the following order v1 < v2 iff v1.x < v2.x || v1.x == v2.x && v1.y < v2.y The vertices composing the chain are only 2 coordinates (x, y) wide, packed on 16 bits each (which is 4 bytes per vertex.) This is the packed form of the <a class="el" href="classNLPACS_1_1COrderedChain3f.html">COrderedChain3f</a>. (4 bytes per vertex.) <dl compact><dt><b> +Author: </b><dd> +Benjamin Legros , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00107">107</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a10" doxytag="NLPACS::COrderedChain::computeMinMax"></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 NLPACS::COrderedChain::computeMinMax </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00178">178</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +References <a class="el" href="chain_8h-source.html#l00129">_Max</a>, <a class="el" href="chain_8h-source.html#l00129">_Min</a>, <a class="el" href="chain_8h-source.html#l00114">_Vertices</a>, and <a class="el" href="types__nl_8h-source.html#l00198">uint</a>. </td> + </tr> +</table> +<a name="a12" doxytag="NLPACS::COrderedChain::distance"></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"> float NLPACS::COrderedChain::distance </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>position</em> </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> + +<p> +Definition at line <a class="el" href="chain_8cpp-source.html#l00115">115</a> of file <a class="el" href="chain_8cpp-source.html">chain.cpp</a>. +<p> +References <a class="el" href="chain_8h-source.html#l00114">_Vertices</a>, <a class="el" href="opcode__register_8cpp-source.html#l00036">NLAISCRIPT::l</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00232">len</a>, and <a class="el" href="types__nl_8h-source.html#l00198">uint</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLPACS::COrderedChain::getIndexInParent"></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="types__nl_8h.html#a7">uint16</a> NLPACS::COrderedChain::getIndexInParent </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<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the index of the ochain within the parent chain. +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00142">142</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +References <a class="el" href="chain_8h-source.html#l00123">_IndexInParent</a>, and <a class="el" href="types__nl_8h-source.html#l00191">uint16</a>. </td> + </tr> +</table> +<a name="a4" doxytag="NLPACS::COrderedChain::getLength"></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"> float NLPACS::COrderedChain::getLength </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<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the length of the chain. +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00145">145</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +References <a class="el" href="chain_8h-source.html#l00126">_Length</a>. </td> + </tr> +</table> +<a name="a7" doxytag="NLPACS::COrderedChain::getMax"></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"> const <a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a>& NLPACS::COrderedChain::getMax </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<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the max vector of the chain. +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00154">154</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +References <a class="el" href="chain_8h-source.html#l00129">_Max</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLPACS::COrderedChain::getMin"></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"> const <a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a>& NLPACS::COrderedChain::getMin </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<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the min vector of the chain. +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00151">151</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +References <a class="el" href="chain_8h-source.html#l00129">_Min</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLPACS::COrderedChain::getParentId"></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="types__nl_8h.html#a7">uint16</a> NLPACS::COrderedChain::getParentId </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<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the parent chain Id of this ordered chain. +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00139">139</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +References <a class="el" href="chain_8h-source.html#l00120">_ParentId</a>, and <a class="el" href="types__nl_8h-source.html#l00191">uint16</a>. </td> + </tr> +</table> +<a name="a0" doxytag="NLPACS::COrderedChain::getVertices"></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"> const std::vector<<a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a>>& NLPACS::COrderedChain::getVertices </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<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the vertices of the chain. +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00133">133</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +References <a class="el" href="chain_8h-source.html#l00114">_Vertices</a>. +<p> +Referenced by <a class="el" href="local__retriever_8cpp-source.html#l00850">NLPACS::CLocalRetriever::insurePosition</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLPACS::COrderedChain::isForward"></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"> bool NLPACS::COrderedChain::isForward </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<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns true if the chain should be accessed forward within the parent <a class="el" href="classNLPACS_1_1CChain.html">CChain</a> (see _Forward.). +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00136">136</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +References <a class="el" href="chain_8h-source.html#l00117">_Forward</a>. +<p> +Referenced by <a class="el" href="local__retriever_8cpp-source.html#l00850">NLPACS::CLocalRetriever::insurePosition</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLPACS::COrderedChain::operator[]"></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"> const <a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a>& NLPACS::COrderedChain::operator[] </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="types__nl_8h.html#a13">uint</a> </td> + <td class="mdname1" valign="top" nowrap> <em>n</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00148">148</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +References <a class="el" href="chain_8h-source.html#l00114">_Vertices</a>, and <a class="el" href="types__nl_8h-source.html#l00198">uint</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLPACS::COrderedChain::pack"></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 NLPACS::COrderedChain::pack </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLPACS_1_1COrderedChain3f.html">COrderedChain3f</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>chain</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00161">161</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +References <a class="el" href="chain_8h-source.html#l00117">_Forward</a>, <a class="el" href="chain_8h-source.html#l00123">_IndexInParent</a>, <a class="el" href="chain_8h-source.html#l00129">_Max</a>, <a class="el" href="chain_8h-source.html#l00129">_Min</a>, <a class="el" href="chain_8h-source.html#l00120">_ParentId</a>, <a class="el" href="chain_8h-source.html#l00114">_Vertices</a>, and <a class="el" href="types__nl_8h-source.html#l00198">uint</a>. </td> + </tr> +</table> +<a name="a13" doxytag="NLPACS::COrderedChain::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 NLPACS::COrderedChain::serial </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1IStream.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></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="chain_8cpp-source.html#l00158">158</a> of file <a class="el" href="chain_8cpp-source.html">chain.cpp</a>. +<p> +References <a class="el" href="chain_8h-source.html#l00117">_Forward</a>, <a class="el" href="chain_8h-source.html#l00123">_IndexInParent</a>, <a class="el" href="chain_8h-source.html#l00126">_Length</a>, <a class="el" href="chain_8h-source.html#l00129">_Max</a>, <a class="el" href="chain_8h-source.html#l00129">_Min</a>, <a class="el" href="chain_8h-source.html#l00120">_ParentId</a>, <a class="el" href="chain_8h-source.html#l00114">_Vertices</a>, <a class="el" href="types__nl_8h-source.html#l00197">sint</a>, and <a class="el" href="types__nl_8h-source.html#l00198">uint</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLPACS::COrderedChain::translate"></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 NLPACS::COrderedChain::translate </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>translation</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> + +<p> +Definition at line <a class="el" href="chain_8cpp-source.html#l00083">83</a> of file <a class="el" href="chain_8cpp-source.html">chain.cpp</a>. +<p> +References <a class="el" href="chain_8h-source.html#l00114">_Vertices</a>, and <a class="el" href="types__nl_8h-source.html#l00198">uint</a>. </td> + </tr> +</table> +<a name="a11" doxytag="NLPACS::COrderedChain::traverse"></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 NLPACS::COrderedChain::traverse </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="types__nl_8h.html#a12">sint</a> </td> + <td class="mdname" nowrap> <em>from</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="types__nl_8h.html#a12">sint</a> </td> + <td class="mdname" nowrap> <em>to</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>forward</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>std::vector< <a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a> > & </td> + <td class="mdname" nowrap> <em>path</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> const</td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<hr><h2>Friends And Related Function Documentation</h2> +<a name="l0" doxytag="NLPACS::COrderedChain::CChain"></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"> friend class CChain<code> [friend]</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="chain_8h-source.html#l00110">110</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. </td> + </tr> +</table> +<a name="l1" doxytag="NLPACS::COrderedChain::CRetrievableSurface"></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"> friend class CRetrievableSurface<code> [friend]</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="chain_8h-source.html#l00111">111</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="n1" doxytag="NLPACS::COrderedChain::_Forward"></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"> bool NLPACS::COrderedChain::_Forward<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set if the chain should be read forward within the parent <a class="el" href="classNLPACS_1_1CChain.html">CChain</a> (for sequential access to vertices.). +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00117">117</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +Referenced by <a class="el" href="chain_8h-source.html#l00136">isForward</a>, <a class="el" href="chain_8h-source.html#l00161">pack</a>, and <a class="el" href="chain_8cpp-source.html#l00158">serial</a>. </td> + </tr> +</table> +<a name="n3" doxytag="NLPACS::COrderedChain::_IndexInParent"></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="types__nl_8h.html#a7">uint16</a> NLPACS::COrderedChain::_IndexInParent<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The index of the ochain within the parent chain. +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00123">123</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +Referenced by <a class="el" href="chain_8h-source.html#l00142">getIndexInParent</a>, <a class="el" href="chain_8h-source.html#l00161">pack</a>, and <a class="el" href="chain_8cpp-source.html#l00158">serial</a>. </td> + </tr> +</table> +<a name="n4" doxytag="NLPACS::COrderedChain::_Length"></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"> float NLPACS::COrderedChain::_Length<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The length of the chain. +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00126">126</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +Referenced by <a class="el" href="chain_8h-source.html#l00145">getLength</a>, and <a class="el" href="chain_8cpp-source.html#l00158">serial</a>. </td> + </tr> +</table> +<a name="n6" doxytag="NLPACS::COrderedChain::_Max"></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="classNLPACS_1_1CVector2s.html">CVector2s</a> NLPACS::COrderedChain::_Max<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The min and max vertices of the chain. +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00129">129</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +Referenced by <a class="el" href="chain_8h-source.html#l00178">computeMinMax</a>, <a class="el" href="chain_8h-source.html#l00154">getMax</a>, <a class="el" href="chain_8h-source.html#l00161">pack</a>, and <a class="el" href="chain_8cpp-source.html#l00158">serial</a>. </td> + </tr> +</table> +<a name="n5" doxytag="NLPACS::COrderedChain::_Min"></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="classNLPACS_1_1CVector2s.html">CVector2s</a> NLPACS::COrderedChain::_Min<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The min and max vertices of the chain. +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00129">129</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +Referenced by <a class="el" href="chain_8h-source.html#l00178">computeMinMax</a>, <a class="el" href="chain_8h-source.html#l00151">getMin</a>, <a class="el" href="chain_8h-source.html#l00161">pack</a>, and <a class="el" href="chain_8cpp-source.html#l00158">serial</a>. </td> + </tr> +</table> +<a name="n2" doxytag="NLPACS::COrderedChain::_ParentId"></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="types__nl_8h.html#a7">uint16</a> NLPACS::COrderedChain::_ParentId<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The parent chain Id. +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00120">120</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +Referenced by <a class="el" href="chain_8h-source.html#l00139">getParentId</a>, <a class="el" href="chain_8h-source.html#l00161">pack</a>, and <a class="el" href="chain_8cpp-source.html#l00158">serial</a>. </td> + </tr> +</table> +<a name="n0" doxytag="NLPACS::COrderedChain::_Vertices"></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"> std::vector<<a class="el" href="classNLPACS_1_1CVector2s.html">CVector2s</a>> NLPACS::COrderedChain::_Vertices<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The vertices of the chain, ordered following x growth. +<p> + +<p> +Definition at line <a class="el" href="chain_8h-source.html#l00114">114</a> of file <a class="el" href="chain_8h-source.html">chain.h</a>. +<p> +Referenced by <a class="el" href="chain_8h-source.html#l00178">computeMinMax</a>, <a class="el" href="chain_8cpp-source.html#l00115">distance</a>, <a class="el" href="chain_8h-source.html#l00133">getVertices</a>, <a class="el" href="chain_8h-source.html#l00148">operator[]</a>, <a class="el" href="chain_8h-source.html#l00161">pack</a>, <a class="el" href="chain_8cpp-source.html#l00158">serial</a>, and <a class="el" href="chain_8cpp-source.html#l00083">translate</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="chain_8h-source.html">chain.h</a><li><a class="el" href="chain_8cpp-source.html">chain.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> |