mirror of https://github.com/CGAL/cgal
Don't disjoint doc from headers for BGL/IO
This commit is contained in:
Mael Rouxel-Labbé
parent
580a1efd5c
commit
322f1ccaef
|
|
@ -1,25 +0,0 @@
|
|||
namespace CGAL {
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
* \brief writes the triangle meshes contained in `gs` into the 3mf file `file_name`.
|
||||
*
|
||||
* \tparam FaceGraphRange a model of the concepts `RandomAccessContainer`
|
||||
* and `BackInsertionSequence` whose `value type` is
|
||||
* a model of the concepts `FaceListGraph` and `HalfedgeListGraph`
|
||||
* that has only triangle faces.
|
||||
*
|
||||
* \param file_name the name of the 3mf file to write.
|
||||
* \param gs a `FaceGraphRange` that contains the meshes
|
||||
* to write. An internal property map for `CGAL::vertex_point_t`
|
||||
* must be available for each mesh.
|
||||
* \param names will contains the name of each mesh in `file_name`.
|
||||
*
|
||||
* \return `true` if the writing is successful, `false` otherwise.
|
||||
*/
|
||||
template<typename FaceGraphRange>
|
||||
bool write_triangle_meshes_to_3mf(const std::string& file_name,
|
||||
const FaceGraphRange& gs,
|
||||
const std::vector<std::string>& names);
|
||||
} // namespace CGAL
|
||||
|
|
@ -1,105 +0,0 @@
|
|||
namespace CGAL {
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
reads the graph `g` from data in the TS 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 data must represent a 2-manifold
|
||||
|
||||
\attention The graph `g` is not cleared, and the data from the stream is added.
|
||||
|
||||
\see \ref IOStreamGocad
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameter>
|
||||
bool read_GOCAD(std::istream& in,
|
||||
FaceGraph& g,
|
||||
const NamedParameter& np);
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
reads the graph `g` from the file `fname` in the TS 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
|
||||
|
||||
\sa Overloads of this function for specific models of the concept `FaceGraph`.
|
||||
|
||||
\pre The data must represent a 2-manifold
|
||||
|
||||
\see \ref IOStreamGocad
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameter>
|
||||
bool read_GOCAD(const char* fname, FaceGraph& g, const NamedParameter& np);
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
writes the graph `g` in the TS format into `os`. `fname` is the
|
||||
mandatory name that will be assigned to `g` in the file.
|
||||
|
||||
\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
|
||||
|
||||
\see \ref IOStreamGocad
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameter>
|
||||
bool write_GOCAD(std::ostream& os,
|
||||
const char* fname,
|
||||
const FaceGraph& g,
|
||||
const NamedParameter& np);
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
writes the graph `g` in the TS 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 IOStreamGocad
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameter>
|
||||
bool write_GOCAD(const char* fname,
|
||||
const FaceGraph& g,
|
||||
const NamedParameter& np);
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
writes the graph `g` in the TS format into `os`. The name
|
||||
that will be assigned to `g` in the file is `anonymous`.
|
||||
|
||||
\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
|
||||
|
||||
\see \ref IOStreamGocad
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameter>
|
||||
bool write_GOCAD(std::ostream& os, const FaceGraph& g, const NamedParameter& np);
|
||||
} // namespace CGAL
|
||||
|
|
@ -1,100 +0,0 @@
|
|||
namespace CGAL {
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
reads the graph `g` from the stream `in` in the OBJ 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
|
||||
`vertex_normal_map` the property map with the normals associated to the vertices of `g`.
|
||||
|
||||
|
||||
\returns `true` if the resulting mesh is valid.
|
||||
|
||||
\sa Overloads of this function for specific models of the concept `FaceGraph`.
|
||||
|
||||
\pre The data must represent a 2-manifold
|
||||
|
||||
\see \ref IOStreamOBJ
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameter>
|
||||
bool read_OBJ(std::istream& in,
|
||||
FaceGraph& g,
|
||||
const NamedParameter& np);
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
reads the graph `g` from data in the OFF format. Ignores comment lines which start with a hash,
|
||||
and lines with whitespace.
|
||||
|
||||
\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
|
||||
`vertex_normal_map` the property map with the normals associated to the vertices of `g`.
|
||||
|
||||
\returns `true` if the resulting mesh is valid.
|
||||
|
||||
\sa Overloads of this function for specific models of the concept `FaceGraph`.
|
||||
|
||||
\pre The data must represent a 2-manifold
|
||||
|
||||
\see \ref IOStreamOBJ
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameter>
|
||||
bool read_OBJ(const char* fname,
|
||||
FaceGraph& g,
|
||||
const NamedParameter& np);
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
writes the graph `g` in the OBJ 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
|
||||
`vertex_normal_map` the property map with the normals associated to the vertices of `g`.
|
||||
|
||||
\returns `true` if writing was successful.
|
||||
|
||||
\sa Overloads of this function for specific models of the concept `FaceGraph`.
|
||||
|
||||
\see \ref IOStreamOBJ
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameter>
|
||||
bool write_OBJ(std::ostream& os,
|
||||
const FaceGraph& g,
|
||||
const NamedParameter& np);
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
writes the graph `g` in the OFF 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
|
||||
`vertex_normal_map` the property map with the normals associated to the vertices of `g`.
|
||||
|
||||
\returns `true` if writing was successful.
|
||||
|
||||
\sa Overloads of this function for specific models of the concept `FaceGraph`.
|
||||
|
||||
\see \ref IOStreamOBJ
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameter>
|
||||
bool write_OBJ(const char* fname,
|
||||
const FaceGraph& g,
|
||||
const NamedParameter& np);
|
||||
} // namespace CGAL
|
||||
|
|
@ -1,120 +0,0 @@
|
|||
namespace CGAL {
|
||||
|
||||
/* \cgalParamBegin{vertex_normal_map} the property map with the normals associated to the vertices of `g`.\cgalParamEnd
|
||||
|
||||
\cgalParamBegin{vertex_color_map} the property map with the colors associated to the vertices of `g`.\cgalParamEnd
|
||||
|
||||
\cgalParamBegin{vertex_texture_map} the property map with the textures associated to the vertices of `g`.\cgalParamEnd
|
||||
|
||||
\cgalParamBegin{face_color_map} the property map with the colors associated to the faces of `g`.\cgalParamEnd*/
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
reads the graph `g` from data in the OFF format. Ignores comment lines which start with a hash,
|
||||
and lines with whitespace.
|
||||
|
||||
|
||||
\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
|
||||
`vertex_normal_map` the property map with the normals associated to the vertices of `g`.
|
||||
|
||||
`vertex_color_map` the property map with the colors associated to the vertices of `g`.
|
||||
|
||||
`vertex_texture_map` the property map with the textures associated to the vertices of `g`.
|
||||
|
||||
`face_color_map` the property map with the colors associated to the faces of `g`.
|
||||
|
||||
\pre The data must represent a 2-manifold
|
||||
|
||||
\sa Overloads of this function for specific models of the concept `FaceGraph`.
|
||||
|
||||
\see \ref IOStreamOFF
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameters>
|
||||
bool read_OFF(std::istream& in, FaceGraph& g, const NamedParameters& np);
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
reads the graph `g` from `fname`, a file in the OFF format. Ignores comment lines which start with a hash,
|
||||
and lines with whitespace.
|
||||
|
||||
\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
|
||||
|
||||
`vertex_normal_map` the property map with the normals associated to the vertices of `g`.
|
||||
|
||||
`vertex_color_map` the property map with the colors associated to the vertices of `g`.
|
||||
|
||||
`vertex_texture_map` the property map with the textures associated to the vertices of `g`.
|
||||
|
||||
`face_color_map` the property map with the colors associated to the faces of `g`.
|
||||
|
||||
\pre The data must represent a 2-manifold
|
||||
|
||||
\sa Overloads of this function for specific models of the concept `FaceGraph`.
|
||||
|
||||
\see \ref IOStreamOFF
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameters>
|
||||
bool read_OFF(const char* fname, FaceGraph& g, const NamedParameters& np);
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
writes the graph `g` in the OFF 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
|
||||
|
||||
`vertex_normal_map` the property map with the normals associated to the vertices of `g`.
|
||||
|
||||
`vertex_color_map` the property map with the colors associated to the vertices of `g`.
|
||||
|
||||
`vertex_texture_map` the property map with the textures associated to the vertices of `g`.
|
||||
|
||||
`face_color_map` the property map with the colors associated to the faces of `g`.
|
||||
|
||||
\sa Overloads of this function for specific models of the concept `FaceGraph`.
|
||||
|
||||
\see \ref IOStreamOFF
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameters>
|
||||
bool write_OFF(std::ostream& os, const FaceGraph& g, const NamedParameters& np);
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
writes the graph `g` in the file `fname`, in the OFF 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
|
||||
`vertex_normal_map` the property map with the normals associated to the vertices of `g`.
|
||||
|
||||
`vertex_color_map` the property map with the colors associated to the vertices of `g`.
|
||||
|
||||
`vertex_texture_map` the property map with the textures associated to the vertices of `g`.
|
||||
|
||||
`face_color_map` the property map with the colors associated to the faces of `g`.
|
||||
|
||||
\sa Overloads of this function for specific models of the concept `FaceGraph`.
|
||||
|
||||
\see \ref IOStreamOFF
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameters>
|
||||
bool write_OFF(const char* fname, const FaceGraph& g, const NamedParameters& np);
|
||||
|
||||
} // namespace CGAL
|
||||
|
|
@ -1,120 +0,0 @@
|
|||
namespace CGAL {
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
reads the graph `g` from data in the PLY 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
|
||||
\cgalParamBegin{vertex_index_map}
|
||||
is a property map containing for each vertex of `g` a unique index between `0` and `num_vertices(g)-1`.
|
||||
\cgalParamEnd
|
||||
\cgalNamedParamsEnd
|
||||
`face_color_map` the property map with the colors associated to the faces of `g`.
|
||||
`vertex_color_map` the property map with the colors associated to the vertices of `g`.
|
||||
|
||||
\pre The data must represent a 2-manifold
|
||||
|
||||
\sa Overloads of this function for specific models of the concept `FaceGraph`.
|
||||
|
||||
\see \ref IOStreamPLY
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameters>
|
||||
bool read_PLY(std::istream& in, FaceGraph& g, const NamedParameters& np);
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
reads the graph `g` from a file named `fname`, in the PLY 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
|
||||
\cgalParamBegin{vertex_index_map}
|
||||
is a property map containing for each vertex of `g` a unique index between `0` and `num_vertices(g)-1`.
|
||||
\cgalParamEnd
|
||||
\cgalNamedParamsEnd
|
||||
`face_color_map` the property map with the colors associated to the faces of `g`.
|
||||
`vertex_color_map` the property map with the colors associated to the vertices of `g`.
|
||||
|
||||
\pre The data must represent a 2-manifold
|
||||
|
||||
\sa Overloads of this function for specific models of the concept `FaceGraph`.
|
||||
|
||||
\see \ref IOStreamPLY
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameters>
|
||||
bool read_PLY(const char* fname, FaceGraph& g, const NamedParameters& np);
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
Inserts the graph in an output stream in PLY format.
|
||||
|
||||
If provided, the `comments` string is included line by line in
|
||||
the header of the PLY stream (each line will be precedeed by
|
||||
"comment ").
|
||||
|
||||
The `np` is an optional sequence of \ref pmp_namedparameters "Named Parameters" among the ones listed below
|
||||
|
||||
\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
|
||||
\cgalParamBegin{vertex_index_map}
|
||||
is a property map containing for each vertex of `g` a unique index between `0` and `num_vertices(g)-1`.
|
||||
\cgalParamEnd
|
||||
\cgalNamedParamsEnd
|
||||
`face_color_map` the property map with the colors associated to the faces of `g`.
|
||||
`vertex_color_map` the property map with the colors associated to the vertices of `g`.
|
||||
|
||||
\see \ref IOStreamPLY
|
||||
*/
|
||||
template <class FaceGraph, class NamedParameters>
|
||||
bool write_PLY(std::ostream& os,
|
||||
const FaceGraph& g,
|
||||
const std::string& comments,
|
||||
const NamedParameters& np);
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
Inserts the graph in the output file `fname` in PLY format.
|
||||
|
||||
If provided, the `comments` string is included line by line in
|
||||
the header of the PLY stream (each line will be precedeed by
|
||||
"comment ").
|
||||
|
||||
The `np` is an optional sequence of \ref pmp_namedparameters "Named Parameters" among the ones listed below
|
||||
|
||||
\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
|
||||
\cgalParamBegin{vertex_index_map}
|
||||
is a property map containing for each vertex of `g` a unique index between `0` and `num_vertices(g)-1`.
|
||||
\cgalParamEnd
|
||||
\cgalNamedParamsEnd
|
||||
`face_color_map` the property map with the colors associated to the faces of `g`.
|
||||
`vertex_color_map` the property map with the colors associated to the vertices of `g`.
|
||||
|
||||
\see \ref IOStreamPLY
|
||||
*/
|
||||
template <class FaceGraph, class NamedParameters>
|
||||
bool write_PLY(const char* fname,
|
||||
const FaceGraph& g,
|
||||
const std::string& comments,
|
||||
const NamedParameters& np);
|
||||
} // namespace CGAL
|
||||
|
|
@ -1,70 +0,0 @@
|
|||
namespace CGAL {
|
||||
|
||||
|
||||
/*!
|
||||
\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 NamedParameter>
|
||||
bool read_STL(std::istream& in,
|
||||
FaceGraph& g,
|
||||
const NamedParameter& 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 NamedParameter>
|
||||
bool read_STL(const char* fname, FaceGraph& g, const NamedParameter& np);
|
||||
|
||||
|
||||
/*!
|
||||
\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 NamedParameters>
|
||||
bool write_STL(std::ostream& out,
|
||||
const FaceGraph& g,
|
||||
const NamedParameters& np);
|
||||
/*!
|
||||
\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 NamedParameter>
|
||||
bool write_STL(const char* fname, const FaceGraph& g, const NamedParameter& np);
|
||||
} // namespace CGAL
|
||||
|
|
@ -1,91 +0,0 @@
|
|||
|
||||
namespace CGAL {
|
||||
|
||||
|
||||
/*!
|
||||
* \ingroup PkgBGLIOFct
|
||||
*
|
||||
* \brief reads a PolyData in the VTP format into a triangulated surface mesh.
|
||||
*
|
||||
* \tparam FaceGraph a model of `FaceListGraph`.
|
||||
*
|
||||
* \param fname the path to the file that will be read.
|
||||
* \param g the output mesh.
|
||||
* \param np optional sequence of \ref pmp_namedparameters "Named Parameters" among the
|
||||
* ones listed below
|
||||
*
|
||||
* \pre \cgal needs to be configured with the VTK Libraries for this function to be available.
|
||||
* \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 data must represent a 2-manifold
|
||||
* \see \ref IOStreamVTK
|
||||
*/
|
||||
template<typename FaceGraph, typename NamedParameter>
|
||||
bool read_VTP(const char* fname, FaceGraph& g, const NamedParameter& np);
|
||||
|
||||
|
||||
/*! \ingroup PkgBGLIOFct
|
||||
*
|
||||
* \brief writes a triangulated surface mesh in the `PolyData` XML format.
|
||||
*
|
||||
* \tparam FaceGraph a model of `FaceListGraph` with only triangle faces.
|
||||
* \tparam NamedParameters a sequence of \ref pmp_namedparameters "Named Parameters"
|
||||
*
|
||||
* \param os the stream used for writing.
|
||||
* \param g the triangle mesh to be written.
|
||||
* \param np optional sequence of \ref pmp_namedparameters "Named Parameters" among the
|
||||
* ones listed below
|
||||
*
|
||||
* \cgalNamedParamsBegin
|
||||
* \cgalParamBegin{use_binary_mode} a Boolean indicating if the
|
||||
* data should be written in binary (`true`, the default) or in ASCII (`false`).
|
||||
* \cgalParamEnd
|
||||
* \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` must be available in `FaceGraph`.
|
||||
* \cgalParamEnd
|
||||
* \cgalParamBegin{vertex_index_map} the property map with the indices associated to
|
||||
* the vertices of `g`.
|
||||
* \cgalParamEnd
|
||||
* \cgalNamedParamsEnd
|
||||
* \see \ref IOStreamVTK
|
||||
*/
|
||||
template<typename FaceGraph, typename NamedParameter>
|
||||
void write_VTP(std::ostream& os,
|
||||
const FaceGraph& g,
|
||||
const NamedParameter& np);
|
||||
|
||||
/*! \ingroup PkgBGLIOFct
|
||||
*
|
||||
* \brief writes a triangulated surface mesh the file `fname`, in the `PolyData` XML format.
|
||||
*
|
||||
* \tparam FaceGraph a model of `FaceListGraph` with only triangle faces.
|
||||
* \tparam NamedParameters a sequence of \ref pmp_namedparameters "Named Parameters"
|
||||
*
|
||||
* \param fname the name of the output file.
|
||||
* \param g the triangle mesh to be written.
|
||||
* \param np optional sequence of \ref pmp_namedparameters "Named Parameters" among the
|
||||
* ones listed below
|
||||
*
|
||||
* \cgalNamedParamsBegin
|
||||
* \cgalParamBegin{use_binary_mode} a Boolean indicating if the
|
||||
* data should be written in binary (`true`, the default) or in ASCII (`false`).
|
||||
* \cgalParamEnd
|
||||
* \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` must be available in `FaceGraph`.
|
||||
* \cgalParamEnd
|
||||
* \cgalParamBegin{vertex_index_map} the property map with the indices associated to
|
||||
* the vertices of `g`.
|
||||
* \cgalParamEnd
|
||||
* \cgalNamedParamsEnd
|
||||
* \see \ref IOStreamVTK
|
||||
*/
|
||||
template<typename FaceGraph, typename NamedParameter>
|
||||
void write_VTP(const char* fname,
|
||||
const FaceGraph& g,
|
||||
const NamedParameter& np);
|
||||
} // namespace CGAL
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
|
||||
namespace CGAL {
|
||||
|
||||
/*!
|
||||
\ingroup PkgBGLIOFct
|
||||
|
||||
writes the graph `g` in the wrl format (VRML 2.0).
|
||||
|
||||
\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
|
||||
|
||||
\see \ref IOStreamWRL
|
||||
*/
|
||||
template <typename FaceGraph, typename NamedParameters>
|
||||
bool write_WRL(std::ostream& os,
|
||||
const FaceGraph& g,
|
||||
const NamedParameters& np);
|
||||
} // namespace CGAL
|
||||
|
|
@ -1,62 +0,0 @@
|
|||
namespace CGAL{
|
||||
/*!
|
||||
* \ingroup PkgBGLIOFct
|
||||
* \brief reads a polygon mesh from a file.
|
||||
* \tparam FaceGraph a model of `FaceGraph`
|
||||
* \tparam NamedParameters a sequence of \ref pmp_namedparameters "Named Parameters"
|
||||
*
|
||||
* \param fname the name of the file. Its extension must be one of the following :
|
||||
* `.off` (\ref IOStreamOFF "OFF file format") , `.obj` (\ref IOStreamOBJ "OBJ file format"),
|
||||
* `.stl` (\ref IOStreamSTL "STL file format"), `.ply` (\ref IOStreamPLY "PLY file format"),
|
||||
* `.vtp`(\ref IOStreamVTK "VTP file format") or `.ts`(\ref IOStreamGocad "GOCAD file format").
|
||||
* \param g the mesh
|
||||
* \param np optional \ref pmp_namedparameters "Named Parameters" described below
|
||||
*
|
||||
* \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
|
||||
* Other named parameters may be used according to the file extension.
|
||||
* See `PkgBGLIOFct` for an exhaustive list.
|
||||
|
||||
* \return `true` if the reading worked, `false` otherwise.
|
||||
*
|
||||
* \pre The data must represent a 2-manifold
|
||||
* \see \ref IOStreamOFF
|
||||
*
|
||||
*/
|
||||
template <class FaceGraph, typename NamedParameters>
|
||||
bool read_polygon_mesh(const std::string& fname,
|
||||
FaceGraph& g,
|
||||
const NamedParameters& np);
|
||||
|
||||
/*!
|
||||
* \ingroup PkgBGLIOFct
|
||||
* \brief writes a polygon mesh in a file.
|
||||
* \tparam FaceGraph a model of `FaceGraph`
|
||||
* \tparam NamedParameters a sequence of \ref pmp_namedparameters "Named Parameters"
|
||||
*
|
||||
* \param fname the name of the file. Its extension must be one of the following :
|
||||
* `.off` (\ref IOStreamOFF "OFF file format") , `.obj` (\ref IOStreamOBJ "OBJ file format"),
|
||||
* `.stl` (\ref IOStreamSTL "STL file format"), `.ply` (\ref IOStreamPLY "PLY file format"),
|
||||
* `.vtp`(\ref IOStreamVTK "VTP file format") or `.ts`(\ref IOStreamGocad "GOCAD file format").
|
||||
* \param g the mesh
|
||||
* \param np optional \ref pmp_namedparameters "Named Parameters" described below
|
||||
*
|
||||
* \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
|
||||
* Other named parameters may be used according to the file extension.
|
||||
* See `PkgBGLIOFct` for an exhaustive list.
|
||||
* \return `true` if the writing worked, `false` otherwise.
|
||||
*
|
||||
* \see \ref IOStreamOFF
|
||||
*/
|
||||
template <class FaceGraph, typename NamedParameters>
|
||||
bool write_polygon_mesh(const std::string& fname,
|
||||
FaceGraph& g,
|
||||
const NamedParameters& np);
|
||||
}
|
||||
|
|
@ -13,6 +13,7 @@ INPUT += ${CGAL_PACKAGE_INCLUDE_DIR}/CGAL/boost/graph/Euler_operations.h \
|
|||
${CGAL_PACKAGE_INCLUDE_DIR}/CGAL/boost/graph/Dual.h \
|
||||
${CGAL_PACKAGE_INCLUDE_DIR}/CGAL/boost/graph/Seam_mesh.h \
|
||||
${CGAL_PACKAGE_INCLUDE_DIR}/CGAL/boost/graph/io.h \
|
||||
${CGAL_PACKAGE_INCLUDE_DIR}/CGAL/boost/graph/IO/ \
|
||||
${CGAL_PACKAGE_INCLUDE_DIR}/CGAL/boost/graph/partition.h \
|
||||
${CGAL_PACKAGE_INCLUDE_DIR}/CGAL/boost/graph/METIS/partition_graph.h \
|
||||
${CGAL_PACKAGE_INCLUDE_DIR}/CGAL/boost/graph/METIS/partition_dual_graph.h \
|
||||
|
|
|
|||
Loading…
Reference in New Issue