songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Re-add doc of STL functions (from BGL/doc to BGL/include)

This commit is contained in:
Mael Rouxel-Labbé 2020-05-22 18:55:59 +02:00
parent c3041d6368
commit 8a7753d05c
1 changed files with 52 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
BGL/include/CGAL/boost/graph/IO/STL.h
View File

@ -61,6 +61,17 @@ public:
} // namespace internal } // namespace internal
} // namespace IO } // namespace IO
/*!
\ingroup PkgBGLIOFct
reads the graph `g` from data in the STL format.
\sa Overloads of this function for specific models of the concept `FaceGraph`.
\pre The data must represent a 2-manifold
\see \ref IOStreamSTL
*/
template <typename FaceGraph, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS> template <typename FaceGraph, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
bool read_STL(std::istream& in, bool read_STL(std::istream& in,
FaceGraph& g, FaceGraph& g,
@ -74,6 +85,17 @@ bool read_STL(std::istream& in,
return builder(g, np); return builder(g, np);
} }
/*!
\ingroup PkgBGLIOFct
reads the graph `g` from the file `fname` in the STL format.
\sa Overloads of this function for specific models of the concept `FaceGraph`.
\pre The data must represent a 2-manifold
\see \ref IOStreamSTL
*/
template <typename FaceGraph, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS> template <typename FaceGraph, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
bool read_STL(const char* fname, FaceGraph& g, const CGAL_BGL_NP_CLASS& np, bool read_STL(const char* fname, FaceGraph& g, const CGAL_BGL_NP_CLASS& np,
bool verbose = true) bool verbose = true)
@ -100,6 +122,21 @@ bool read_STL(const std::string& fname, FaceGraph& g) { return read_STL(fname, g
//////////////////////////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////////////////////////
/// Write /// Write
/*!
\ingroup PkgBGLIOFct
writes the graph `g` in the stream `out` in the STL format.
\cgalNamedParamsBegin
\cgalParamBegin{vertex_point_map} the property map with the points associated to the vertices of `g`.
If this parameter is omitted, an internal property map for
`CGAL::vertex_point_t` should be available in `FaceGraph`\cgalParamEnd
\cgalNamedParamsEnd
\pre The graph must contain only triangle faces.
\see \ref IOStreamSTL
*/
template <typename FaceGraph, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS> template <typename FaceGraph, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
bool write_STL(std::ostream& out, bool write_STL(std::ostream& out,
const FaceGraph& g, const FaceGraph& g,
@ -172,6 +209,21 @@ bool write_STL(std::ostream& out,
return out.good(); return out.good();
} }
/*!
\ingroup PkgBGLIOFct
writes the graph `g` in the STL format into a file named `fname`.
\cgalNamedParamsBegin
\cgalParamBegin{vertex_point_map} the property map with the points associated to the vertices of `g`.
If this parameter is omitted, an internal property map for
`CGAL::vertex_point_t` should be available in `FaceGraph`\cgalParamEnd
\cgalNamedParamsEnd
\sa Overloads of this function for specific models of the concept `FaceGraph`.
\see \ref IOStreamSTL
*/
template <typename FaceGraph, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS> template <typename FaceGraph, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
bool write_STL(const char* fname, const FaceGraph& g, const CGAL_BGL_NP_CLASS& np) bool write_STL(const char* fname, const FaceGraph& g, const CGAL_BGL_NP_CLASS& np)
{ {