diff options
| author | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
|---|---|---|
| committer | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
| commit | 0ea5fc66924303d1bf73ba283a383e2aadee02f2 (patch) | |
| tree | 2568e71a7ccc44ec23b8bb3f0ff97fb6bf2ed709 /docs/doxygen/nel/classNLPACS_1_1UGlobalRetriever.html | |
| download | nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip | |
Initial commit
Diffstat (limited to 'docs/doxygen/nel/classNLPACS_1_1UGlobalRetriever.html')
| -rw-r--r-- | docs/doxygen/nel/classNLPACS_1_1UGlobalRetriever.html | 890 |
1 files changed, 890 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLPACS_1_1UGlobalRetriever.html b/docs/doxygen/nel/classNLPACS_1_1UGlobalRetriever.html new file mode 100644 index 00000000..4ce4a252 --- /dev/null +++ b/docs/doxygen/nel/classNLPACS_1_1UGlobalRetriever.html @@ -0,0 +1,890 @@ +<!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::UGlobalRetriever Class Reference</h1>A class that allows to retrieve surface in a large amount of zones (referred as instances.). +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="u__global__retriever_8h-source.html">u_global_retriever.h</a>></code> +<p> +<p>Inheritance diagram for NLPACS::UGlobalRetriever: +<p><center><img src="classNLPACS_1_1UGlobalRetriever.gif" usemap="#NLPACS::UGlobalRetriever_map" border="0"></center> +<map name="NLPACS::UGlobalRetriever_map"> +<area href="classNLPACS_1_1CGlobalRetriever.html" alt="NLPACS::CGlobalRetriever" shape="rect" coords="0,56,165,80"> +</map> +<a href="classNLPACS_1_1UGlobalRetriever-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>virtual bool </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a0">testRaytrace</a> (const <a class="el" href="classNLMISC_1_1CVectorD.html">NLMISC::CVectorD</a> &v0, const <a class="el" href="classNLMISC_1_1CVectorD.html">NLMISC::CVectorD</a> &v1)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Make a raytrace test. For the time, always return false.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classNLMISC_1_1CAABBox.html">NLMISC::CAABBox</a> & </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a1">getBBox</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the bounding box of the global retriever.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a2">getMeanHeight</a> (const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> &pos) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the average height for a global position.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a10">sint32</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a3">getIdentifier</a> (const std::string &<a class="el" href="driver__opengl__extension__def_8h.html#a356">id</a>) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the retriever id from the string id.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const std::string & </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a4">getIdentifier</a> (const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> &pos) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Returns a human readable identifier of the global position.</em> <a href="#a4">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="classNLPACS_1_1UGlobalRetriever.html#a5">buildInstance</a> (const std::string &<a class="el" href="driver__opengl__extension__def_8h.html#a356">id</a>, const <a class="el" href="classNLMISC_1_1CVectorD.html">NLMISC::CVectorD</a> &position, <a class="el" href="memory__common_8h.html#a10">sint32</a> &instanceId)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Builds an instance of retriever, and link it on the ground (or wherever).</em> <a href="#a5">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="classNLPACS_1_1UGlobalRetriever.html#a6">removeInstance</a> (<a class="el" href="memory__common_8h.html#a10">sint32</a> instanceId)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Removes an instance of retriever (perform all unlinks necessary).</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a7">getMaterial</a> (const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> &pos) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the material corresponding to the global position.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a8">retrievePosition</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &estimated) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Retrieves the position of an estimated point in the global retriever.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a9">retrievePosition</a> (const <a class="el" href="classNLMISC_1_1CVectorD.html">NLMISC::CVectorD</a> &estimated) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Retrieves the position of an estimated point in the global retriever (double instead.).</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a10">retrievePosition</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &estimated, float threshold) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Retrieves the position of an estimated point in the global retriever.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a11">retrievePosition</a> (const <a class="el" href="classNLMISC_1_1CVectorD.html">NLMISC::CVectorD</a> &estimated, double threshold) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Retrieves the position of an estimated point in the global retriever (double instead.) with a snapping threshold.</em> <a href="#a11">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="classNLPACS_1_1UGlobalRetriever.html#a12">isInterior</a> (const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> &pos) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Tests if the global position is a interior position.</em> <a href="#a12">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="classNLPACS_1_1UGlobalRetriever.html#a13">isWaterPosition</a> (const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> &pos, float &waterHeight) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Tests if the global position is immerged.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a14">distanceToBorder</a> (const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> &pos) const=0</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a15">getBorders</a> (const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> &pos, std::vector< <a class="el" href="classNLMISC_1_1CLine.html">NLMISC::CLine</a> > &edges)=0</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a16">getGlobalPosition</a> (const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> &global) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Converts a global position object into a 'human-readable' CVector.</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNLMISC_1_1CVectorD.html">NLMISC::CVectorD</a> </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#a17">getDoubleGlobalPosition</a> (const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> &global) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Converts a global position object into a 'human-readable' CVector (double instead.).</em> <a href="#a17">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>UGlobalRetriever * </td><td valign=bottom><a class="el" href="classNLPACS_1_1UGlobalRetriever.html#d0">createGlobalRetriever</a> (const char *globalRetriever, const <a class="el" href="classNLPACS_1_1URetrieverBank.html">URetrieverBank</a> *retrieverBank)</td></tr> +<tr><td> </td><td><font size=-1><em>Create a global retriever.</em> <a href="#d0">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_1UGlobalRetriever.html#d1">deleteGlobalRetriever</a> (UGlobalRetriever *retriever)</td></tr> +<tr><td> </td><td><font size=-1><em>Delete a global retriever.</em> <a href="#d1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A class that allows to retrieve surface in a large amount of zones (referred as instances.). +<p> +<dl compact><dt><b> +Author: </b><dd> +Cyril 'Hulud' Corvazier , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="u__global__retriever_8h-source.html#l00053">53</a> of file <a class="el" href="u__global__retriever_8h-source.html">u_global_retriever.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a5" doxytag="NLPACS::UGlobalRetriever::buildInstance"></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"> virtual bool NLPACS::UGlobalRetriever::buildInstance </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname" nowrap> <em>id</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const <a class="el" href="classNLMISC_1_1CVectorD.html">NLMISC::CVectorD</a> & </td> + <td class="mdname" nowrap> <em>position</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="memory__common_8h.html#a10">sint32</a> & </td> + <td class="mdname" nowrap> <em>instanceId</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </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> + + </td> + <td> + +<p> +Builds an instance of retriever, and link it on the ground (or wherever). +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>id</em> </td><td> +a valid retriever id to be instanciated </td></tr> +<tr><td valign=top><em>a</em> </td><td> +valid position where the retriever should be instanciated </td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +false if failed </dl> +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z936_6">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="d0" doxytag="NLPACS::UGlobalRetriever::createGlobalRetriever"></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"> NLPACS::UGlobalRetriever * NLPACS::UGlobalRetriever::createGlobalRetriever </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname" nowrap> <em>globalRetriever</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const <a class="el" href="classNLPACS_1_1URetrieverBank.html">URetrieverBank</a> * </td> + <td class="mdname" nowrap> <em>retrieverBank</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create a global retriever. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>globalRetriver</em> </td><td> +is the global retriver path file name. This method use the CPath to find the file. </td></tr> +<tr><td valign=top><em>retriverBank</em> </td><td> +is the global retriver bank associated to the global retriever. </td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +the pointer on the global retriver or NULL if the file is not found. </dl> +<p> +Definition at line <a class="el" href="global__retriever_8cpp-source.html#l02051">2051</a> of file <a class="el" href="global__retriever_8cpp-source.html">global_retriever.cpp</a>. +<p> +References <a class="el" href="cf__lexical_8cpp-source.html#l02654">file</a>. </td> + </tr> +</table> +<a name="d1" doxytag="NLPACS::UGlobalRetriever::deleteGlobalRetriever"></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::UGlobalRetriever::deleteGlobalRetriever </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">UGlobalRetriever * </td> + <td class="mdname1" valign="top" nowrap> <em>retriever</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Delete a global retriever. +<p> + +<p> +Definition at line <a class="el" href="global__retriever_8cpp-source.html#l02078">2078</a> of file <a class="el" href="global__retriever_8cpp-source.html">global_retriever.cpp</a>. +<p> +References <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00689">r</a>. </td> + </tr> +</table> +<a name="a14" doxytag="NLPACS::UGlobalRetriever::distanceToBorder"></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"> virtual float NLPACS::UGlobalRetriever::distanceToBorder </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z937_8">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLPACS::UGlobalRetriever::getBBox"></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"> virtual const <a class="el" href="classNLMISC_1_1CAABBox.html">NLMISC::CAABBox</a>& NLPACS::UGlobalRetriever::getBBox </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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the bounding box of the global retriever. +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z935_0">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a15" doxytag="NLPACS::UGlobalRetriever::getBorders"></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"> virtual void NLPACS::UGlobalRetriever::getBorders </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> & </td> + <td class="mdname" nowrap> <em>pos</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>std::vector< <a class="el" href="classNLMISC_1_1CLine.html">NLMISC::CLine</a> > & </td> + <td class="mdname" nowrap> <em>edges</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </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> + + </td> + <td> + +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z937_9">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a17" doxytag="NLPACS::UGlobalRetriever::getDoubleGlobalPosition"></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"> virtual <a class="el" href="classNLMISC_1_1CVectorD.html">NLMISC::CVectorD</a> NLPACS::UGlobalRetriever::getDoubleGlobalPosition </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>global</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Converts a global position object into a 'human-readable' CVector (double instead.). +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z936_9">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a16" doxytag="NLPACS::UGlobalRetriever::getGlobalPosition"></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"> virtual <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> NLPACS::UGlobalRetriever::getGlobalPosition </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>global</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Converts a global position object into a 'human-readable' CVector. +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z936_8">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a4" doxytag="NLPACS::UGlobalRetriever::getIdentifier"></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"> virtual const std::string& NLPACS::UGlobalRetriever::getIdentifier </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns a human readable identifier of the global position. +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z936_5">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLPACS::UGlobalRetriever::getIdentifier"></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"> virtual <a class="el" href="memory__common_8h.html#a10">sint32</a> NLPACS::UGlobalRetriever::getIdentifier </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>id</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the retriever id from the string id. +<p> +<dl compact><dt><b> +Returns: </b><dd> +a valid retriever id or -1 if failed </dl> +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z936_4">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a7" doxytag="NLPACS::UGlobalRetriever::getMaterial"></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"> virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> NLPACS::UGlobalRetriever::getMaterial </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the material corresponding to the global position. +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z935_6">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLPACS::UGlobalRetriever::getMeanHeight"></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"> virtual float NLPACS::UGlobalRetriever::getMeanHeight </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the average height for a global position. +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z938_5">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a12" doxytag="NLPACS::UGlobalRetriever::isInterior"></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"> virtual bool NLPACS::UGlobalRetriever::isInterior </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Tests if the global position is a interior position. +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z935_7">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a13" doxytag="NLPACS::UGlobalRetriever::isWaterPosition"></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"> virtual bool NLPACS::UGlobalRetriever::isWaterPosition </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> & </td> + <td class="mdname" nowrap> <em>pos</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float & </td> + <td class="mdname" nowrap> <em>waterHeight</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Tests if the global position is immerged. +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z935_8">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLPACS::UGlobalRetriever::removeInstance"></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"> virtual void NLPACS::UGlobalRetriever::removeInstance </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a10">sint32</a> </td> + <td class="mdname1" valign="top" nowrap> <em>instanceId</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Removes an instance of retriever (perform all unlinks necessary). +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z936_7">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a11" doxytag="NLPACS::UGlobalRetriever::retrievePosition"></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"> virtual <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> NLPACS::UGlobalRetriever::retrievePosition </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVectorD.html">NLMISC::CVectorD</a> & </td> + <td class="mdname" nowrap> <em>estimated</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>double </td> + <td class="mdname" nowrap> <em>threshold</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Retrieves the position of an estimated point in the global retriever (double instead.) with a snapping threshold. +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z936_3">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a10" doxytag="NLPACS::UGlobalRetriever::retrievePosition"></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"> virtual <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> NLPACS::UGlobalRetriever::retrievePosition </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="mdname" nowrap> <em>estimated</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>threshold</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Retrieves the position of an estimated point in the global retriever. +<p> +Uses a snapping threshold. +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z936_2">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLPACS::UGlobalRetriever::retrievePosition"></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"> virtual <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> NLPACS::UGlobalRetriever::retrievePosition </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVectorD.html">NLMISC::CVectorD</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>estimated</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Retrieves the position of an estimated point in the global retriever (double instead.). +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z936_1">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLPACS::UGlobalRetriever::retrievePosition"></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"> virtual <a class="el" href="classNLPACS_1_1UGlobalPosition.html">UGlobalPosition</a> NLPACS::UGlobalRetriever::retrievePosition </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>estimated</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Retrieves the position of an estimated point in the global retriever. +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z936_0">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<a name="a0" doxytag="NLPACS::UGlobalRetriever::testRaytrace"></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"> virtual bool NLPACS::UGlobalRetriever::testRaytrace </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVectorD.html">NLMISC::CVectorD</a> & </td> + <td class="mdname" nowrap> <em>v0</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const <a class="el" href="classNLMISC_1_1CVectorD.html">NLMISC::CVectorD</a> & </td> + <td class="mdname" nowrap> <em>v1</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </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> + + </td> + <td> + +<p> +Make a raytrace test. For the time, always return false. +<p> + +<p> +Implemented in <a class="el" href="classNLPACS_1_1CGlobalRetriever.html#z936_10">NLPACS::CGlobalRetriever</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="u__global__retriever_8h-source.html">u_global_retriever.h</a><li><a class="el" href="global__retriever_8cpp-source.html">global_retriever.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> |