From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- .../nel/classNLPACS_1_1UGlobalRetriever.html | 890 +++++++++++++++++++++ 1 file changed, 890 insertions(+) create mode 100644 docs/doxygen/nel/classNLPACS_1_1UGlobalRetriever.html (limited to 'docs/doxygen/nel/classNLPACS_1_1UGlobalRetriever.html') 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 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +

Home

nevrax.com

+ + + + +

+ + + + + + + + + + +

+ + +

+ Nevrax.org

+ + + + + + + +

	News
	Mailing-list
	Documentation
	CVS
	Bugs
	License

+ + +

+ + + + + + +

Documentation

+ + +Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages Search +

NLPACS::UGlobalRetriever Class Reference

A class that allows to retrieve surface in a large amount of zones (referred as instances.). +More... +

+#include <u_global_retriever.h> +

Inheritance diagram for NLPACS::UGlobalRetriever: +

+ + + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods
virtual bool	testRaytrace (const NLMISC::CVectorD &v0, const NLMISC::CVectorD &v1)=0
	Make a raytrace test. For the time, always return false. More...
virtual const NLMISC::CAABBox &	getBBox () const=0
	Return the bounding box of the global retriever. More...
virtual float	getMeanHeight (const UGlobalPosition &pos) const=0
	Return the average height for a global position. More...
virtual sint32	getIdentifier (const std::string &id) const=0
	Return the retriever id from the string id. More...
virtual const std::string &	getIdentifier (const UGlobalPosition &pos) const=0
	Returns a human readable identifier of the global position. More...
virtual bool	buildInstance (const std::string &id, const NLMISC::CVectorD &position, sint32 &instanceId)=0
	Builds an instance of retriever, and link it on the ground (or wherever). More...
virtual void	removeInstance (sint32 instanceId)=0
	Removes an instance of retriever (perform all unlinks necessary). More...
virtual uint32	getMaterial (const UGlobalPosition &pos) const=0
	Returns the material corresponding to the global position. More...
virtual UGlobalPosition	retrievePosition (const NLMISC::CVector &estimated) const=0
	Retrieves the position of an estimated point in the global retriever. More...
virtual UGlobalPosition	retrievePosition (const NLMISC::CVectorD &estimated) const=0
	Retrieves the position of an estimated point in the global retriever (double instead.). More...
virtual UGlobalPosition	retrievePosition (const NLMISC::CVector &estimated, float threshold) const=0
	Retrieves the position of an estimated point in the global retriever. More...
virtual UGlobalPosition	retrievePosition (const NLMISC::CVectorD &estimated, double threshold) const=0
	Retrieves the position of an estimated point in the global retriever (double instead.) with a snapping threshold. More...
virtual bool	isInterior (const UGlobalPosition &pos) const=0
	Tests if the global position is a interior position. More...
virtual bool	isWaterPosition (const UGlobalPosition &pos, float &waterHeight) const=0
	Tests if the global position is immerged. More...
virtual float	distanceToBorder (const UGlobalPosition &pos) const=0
virtual void	getBorders (const UGlobalPosition &pos, std::vector< NLMISC::CLine > &edges)=0
virtual NLMISC::CVector	getGlobalPosition (const UGlobalPosition &global) const=0
	Converts a global position object into a 'human-readable' CVector. More...
virtual NLMISC::CVectorD	getDoubleGlobalPosition (const UGlobalPosition &global) const=0
	Converts a global position object into a 'human-readable' CVector (double instead.). More...
Static Public Methods
UGlobalRetriever *	createGlobalRetriever (const char globalRetriever, const URetrieverBank retrieverBank)
	Create a global retriever. More...
void	deleteGlobalRetriever (UGlobalRetriever *retriever)
	Delete a global retriever. More...

Detailed Description

+A class that allows to retrieve surface in a large amount of zones (referred as instances.). +

+Author:: +Cyril 'Hulud' Corvazier , Nevrax France

+Date:: +2001

+ +

+Definition at line 53 of file u_global_retriever.h.

Member Function Documentation

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLPACS::UGlobalRetriever::buildInstance ( const std::string & id,
const NLMISC::CVectorD & position,
sint32 & instanceId
) [pure virtual]
+
+ + + + + +
+ + + +
+Builds an instance of retriever, and link it on the ground (or wherever). +
+
+Parameters:
+ + + +
id +a valid retriever id to be instanciated
a +valid position where the retriever should be instanciated
+
+Returns:
+false if failed
+
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
NLPACS::UGlobalRetriever * NLPACS::UGlobalRetriever::createGlobalRetriever ( const char * globalRetriever,
const URetrieverBank * retrieverBank
) [static]
+
+ + + + + +
+ + + +
+Create a global retriever. +
+
+Parameters:
+ + + +
globalRetriver +is the global retriver path file name. This method use the CPath to find the file.
retriverBank +is the global retriver bank associated to the global retriever.
+
+Returns:
+the pointer on the global retriver or NULL if the file is not found.
+
+Definition at line 2051 of file global_retriever.cpp. +
+References file.
+

+ + + + +
+ + + + + + + + + + +
void NLPACS::UGlobalRetriever::deleteGlobalRetriever ( UGlobalRetriever * retriever ) [static]
+
+ + + + + +
+ + + +
+Delete a global retriever. +
+ +
+Definition at line 2078 of file global_retriever.cpp. +
+References nlassert, and r.
+

+ + + + +
+ + + + + + + + + + +
virtual float NLPACS::UGlobalRetriever::distanceToBorder ( const UGlobalPosition & pos ) const [pure virtual]
+
+ + + + + +
+ + + +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + +
virtual const NLMISC::CAABBox& NLPACS::UGlobalRetriever::getBBox ( ) const [pure virtual]
+
+ + + + + +
+ + + +
+Return the bounding box of the global retriever. +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NLPACS::UGlobalRetriever::getBorders ( const UGlobalPosition & pos,
std::vector< NLMISC::CLine > & edges
) [pure virtual]
+
+ + + + + +
+ + + +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + +
virtual NLMISC::CVectorD NLPACS::UGlobalRetriever::getDoubleGlobalPosition ( const UGlobalPosition & global ) const [pure virtual]
+
+ + + + + +
+ + + +
+Converts a global position object into a 'human-readable' CVector (double instead.). +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + +
virtual NLMISC::CVector NLPACS::UGlobalRetriever::getGlobalPosition ( const UGlobalPosition & global ) const [pure virtual]
+
+ + + + + +
+ + + +
+Converts a global position object into a 'human-readable' CVector. +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + +
virtual const std::string& NLPACS::UGlobalRetriever::getIdentifier ( const UGlobalPosition & pos ) const [pure virtual]
+
+ + + + + +
+ + + +
+Returns a human readable identifier of the global position. +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + +
virtual sint32 NLPACS::UGlobalRetriever::getIdentifier ( const std::string & id ) const [pure virtual]
+
+ + + + + +
+ + + +
+Return the retriever id from the string id. +
+
+Returns:
+a valid retriever id or -1 if failed
+
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + +
virtual uint32 NLPACS::UGlobalRetriever::getMaterial ( const UGlobalPosition & pos ) const [pure virtual]
+
+ + + + + +
+ + + +
+Returns the material corresponding to the global position. +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + +
virtual float NLPACS::UGlobalRetriever::getMeanHeight ( const UGlobalPosition & pos ) const [pure virtual]
+
+ + + + + +
+ + + +
+Return the average height for a global position. +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + +
virtual bool NLPACS::UGlobalRetriever::isInterior ( const UGlobalPosition & pos ) const [pure virtual]
+
+ + + + + +
+ + + +
+Tests if the global position is a interior position. +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLPACS::UGlobalRetriever::isWaterPosition ( const UGlobalPosition & pos,
float & waterHeight
) const [pure virtual]
+
+ + + + + +
+ + + +
+Tests if the global position is immerged. +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + +
virtual void NLPACS::UGlobalRetriever::removeInstance ( sint32 instanceId ) [pure virtual]
+
+ + + + + +
+ + + +
+Removes an instance of retriever (perform all unlinks necessary). +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual UGlobalPosition NLPACS::UGlobalRetriever::retrievePosition ( const NLMISC::CVectorD & estimated,
double threshold
) const [pure virtual]
+
+ + + + + +
+ + + +
+Retrieves the position of an estimated point in the global retriever (double instead.) with a snapping threshold. +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual UGlobalPosition NLPACS::UGlobalRetriever::retrievePosition ( const NLMISC::CVector & estimated,
float threshold
) const [pure virtual]
+
+ + + + + +
+ + + +
+Retrieves the position of an estimated point in the global retriever. +
+Uses a snapping threshold. +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + +
virtual UGlobalPosition NLPACS::UGlobalRetriever::retrievePosition ( const NLMISC::CVectorD & estimated ) const [pure virtual]
+
+ + + + + +
+ + + +
+Retrieves the position of an estimated point in the global retriever (double instead.). +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + +
virtual UGlobalPosition NLPACS::UGlobalRetriever::retrievePosition ( const NLMISC::CVector & estimated ) const [pure virtual]
+
+ + + + + +
+ + + +
+Retrieves the position of an estimated point in the global retriever. +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLPACS::UGlobalRetriever::testRaytrace ( const NLMISC::CVectorD & v0,
const NLMISC::CVectorD & v1
) [pure virtual]
+
+ + + + + +
+ + + +
+Make a raytrace test. For the time, always return false. +
+ +
+Implemented in NLPACS::CGlobalRetriever.
+

The documentation for this class was generated from the following files:

+ + + +
+

+ + -- cgit v1.2.1

NLPACS::UGlobalRetriever Class Reference

Public Methods

Static Public Methods

Detailed Description

Member Function Documentation