diff --git a/BGL/include/CGAL/boost/graph/IO/PLY.h b/BGL/include/CGAL/boost/graph/IO/PLY.h index 649e4a93139..565c0e17b44 100644 --- a/BGL/include/CGAL/boost/graph/IO/PLY.h +++ b/BGL/include/CGAL/boost/graph/IO/PLY.h @@ -259,6 +259,15 @@ bool read_PLY(const std::string& fname, must be available in `Graph`.} \cgalParamNEnd + \cgalParamNBegin{vertex_normal_map} + \cgalParamDescription{a property map associating normals to the vertices of `g`} + \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits::%vertex_descriptor` + as key type and `%Vector_3` as value type} + \cgalParamDefault{`boost::get(CGAL::vertex_point, g)`} + \cgalParamExtra{If this parameter is omitted, an internal property map for `CGAL::vertex_point_t` + must be available in `Graph`.} + \cgalParamNEnd + \cgalParamNBegin{vertex_index_map} \cgalParamDescription{a property map associating to each vertex of `graph` a unique index} \cgalParamType{a class model of `WritablePropertyMap` with `boost::graph_traits::%vertex_descriptor` @@ -288,6 +297,10 @@ bool read_PLY(const std::string& fname, \cgalParamNEnd \cgalNamedParamsEnd +\note The point and vector types of the point and normal property map must be `double`or `float` + in order to respect the specification of the PLY file format. + A `Cartesian_converter_property_map` can be used to convert the points and vectors on the fly. + \returns `true` if writing was successful, `false` otherwise. */ template @@ -489,6 +502,15 @@ bool write_PLY(std::ostream& os, const Graph& g, const CGAL_NP_CLASS& np = param must be available in `Graph`.} \cgalParamNEnd + \cgalParamNBegin{vertex_normal_map} + \cgalParamDescription{a property map associating normals to the vertices of `g`} + \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits::%vertex_descriptor` + as key type and `%Vector_3` as value type} + \cgalParamDefault{`boost::get(CGAL::vertex_point, g)`} + \cgalParamExtra{If this parameter is omitted, an internal property map for `CGAL::vertex_point_t` + must be available in `Graph`.} + \cgalParamNEnd + \cgalParamNBegin{vertex_index_map} \cgalParamDescription{a property map associating to each vertex of `graph` a unique index between `0` and `num_vertices(graph) - 1`} \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits::%vertex_descriptor` @@ -518,6 +540,10 @@ bool write_PLY(std::ostream& os, const Graph& g, const CGAL_NP_CLASS& np = param \cgalParamNEnd \cgalNamedParamsEnd +\note The point and vector types of the point and normal property map must be `double`or `float` + in order to respect the specification of the PLY file format. + A `Cartesian_converter_property_map` can be used to convert the points and vectors on the fly. + \returns `true` if writing was successful, `false` otherwise. */ template