From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/classNLLIGO_1_1CZoneTemplate.html | 536 +++++++++++++++++++++ 1 file changed, 536 insertions(+) create mode 100644 docs/doxygen/nel/classNLLIGO_1_1CZoneTemplate.html (limited to 'docs/doxygen/nel/classNLLIGO_1_1CZoneTemplate.html') diff --git a/docs/doxygen/nel/classNLLIGO_1_1CZoneTemplate.html b/docs/doxygen/nel/classNLLIGO_1_1CZoneTemplate.html new file mode 100644 index 00000000..38eb68f4 --- /dev/null +++ b/docs/doxygen/nel/classNLLIGO_1_1CZoneTemplate.html @@ -0,0 +1,536 @@ + + + + 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 +

NLLIGO::CZoneTemplate Class Reference

Ligo zone template. +More... +

+#include <zone_template.h> +

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

Public Methods
bool build (const std::vector< NLMISC::CVector > &vertices, const std::vector< std::pair< uint, uint > > &indexes, const CLigoConfig &config, CLigoError &errors)
Build method. More...

void serial (NLMISC::IStream &s)
Serialisation. More...

const std::vector< CZoneEdge > & getEdges () const
Get the vertex array of the template. More...

void getMask (std::vector< bool > &mask, uint &width, uint &height)
Get the mask of the template. More...

Static Private Methods
void snap (float &value, float snap)
Round a value on the snap resolution. More...

bool snapOnGrid (float &value, float resolution, float snap)
Snap a value on the grid. More...

bool isSnapedOnGrid (float value, float resolution, float snap)
Return true if this value is snapped. More...

sint32 getSnappedIndex (float value, float resolution, float snap)
Return the interger index of a snappable value. More...

Private Attributes
std::vector< CZoneEdge > _Edges
Vertex array. More...

+

Detailed Description

+Ligo zone template. +

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

+Date:: +2001

+ +

+Definition at line 49 of file zone_template.h.

Member Function Documentation

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool NLLIGO::CZoneTemplate::build ( const std::vector< NLMISC::CVector > & vertices,
const std::vector< std::pair< uint, uint > > & indexes,
const CLigoConfig & config,
CLigoError & errors
)
+
+ + + + + +
+ + + +
+Build method. +
+Build the zone template with a vertex list and an edge list.
+Parameters:
+ + + + + +
vertices +is the vertex array
indexes +is the edge array
config +is the current lingo config file
errors +is the error structure
+
+Returns:
+true if the build success, else return false
+
+Definition at line 107 of file zone_template.cpp. +
+References _Edges, getSnappedIndex, isSnapedOnGrid, nlassert, NLMISC::Pi, sint32, NLLIGO::SnappedXFlag, NLLIGO::SnappedYFlag, uint, x, and y.
+

+ + + + +
+ + + + + + + + + +
const std::vector<CZoneEdge>& NLLIGO::CZoneTemplate::getEdges ( ) const [inline]
+
+ + + + + +
+ + + +
+Get the vertex array of the template. +
+ +
+Definition at line 68 of file zone_template.h. +
+References _Edges.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
void NLLIGO::CZoneTemplate::getMask ( std::vector< bool > & mask,
uint & width,
uint & height
)
+
+ + + + + +
+ + + +
+Get the mask of the template. +
+ +
+Definition at line 667 of file zone_template.cpp. +
+References _Edges, height, nlassert, sint32, uint, uint32, width, x, and y.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
sint32 NLLIGO::CZoneTemplate::getSnappedIndex ( float value,
float resolution,
float snap
) [inline, static, private]
+
+ + + + + +
+ + + +
+Return the interger index of a snappable value. +
+ +
+Definition at line 93 of file zone_template.cpp. +
+References nlverify, sint32, snap, and snapOnGrid. +
+Referenced by build.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
bool NLLIGO::CZoneTemplate::isSnapedOnGrid ( float value,
float resolution,
float snap
) [inline, static, private]
+
+ + + + + +
+ + + +
+Return true if this value is snapped. +
+ +
+Definition at line 84 of file zone_template.cpp. +
+References snap, and snapOnGrid. +
+Referenced by build.
+

+ + + + +
+ + + + + + + + + + +
void NLLIGO::CZoneTemplate::serial ( NLMISC::IStream & s )
+
+ + + + + +
+ + + +
+Serialisation. +
+ +
+Definition at line 644 of file zone_template.cpp. +
+References _Edges, s, NLMISC::IStream::serialCheck, NLMISC::IStream::serialCont, NLMISC::IStream::xmlPop, and NLMISC::IStream::xmlPush.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLLIGO::CZoneTemplate::snap ( float & value,
float snap
) [inline, static, private]
+
+ + + + + +
+ + + +
+Round a value on the snap resolution. +
+ +
+Definition at line 44 of file zone_template.cpp. +
+References snap. +
+Referenced by getSnappedIndex, isSnapedOnGrid, snap, and snapOnGrid.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
bool NLLIGO::CZoneTemplate::snapOnGrid ( float & value,
float resolution,
float snap
) [inline, static, private]
+
+ + + + + +
+ + + +
+Snap a value on the grid. +
+ +
+Definition at line 52 of file zone_template.cpp. +
+References nlassert, and snap. +
+Referenced by getSnappedIndex, and isSnapedOnGrid.
+

Member Data Documentation

+ + + + +
+ + +
std::vector<CZoneEdge> NLLIGO::CZoneTemplate::_Edges [private] +
+
+ + + + + +
+ + + +
+Vertex array. +
+ +
+Definition at line 88 of file zone_template.h. +
+Referenced by build, getEdges, getMask, and serial.
+

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

+ + + +
+

+ + -- cgit v1.2.1