From 3e057e43448844690b74d6d15d3a5f272b77c02e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Tue, 23 Jun 2020 19:03:00 +0200 Subject: [PATCH] Stream support IO doc improvements (wip) --- .../doc/Stream_support/IOstream.txt | 67 +++++++++++-------- .../include/CGAL/IO/polygon_soup_io.h | 24 +++---- 2 files changed, 51 insertions(+), 40 deletions(-) diff --git a/Stream_support/doc/Stream_support/IOstream.txt b/Stream_support/doc/Stream_support/IOstream.txt index c54bb305f99..ba340964064 100644 --- a/Stream_support/doc/Stream_support/IOstream.txt +++ b/Stream_support/doc/Stream_support/IOstream.txt @@ -270,27 +270,48 @@ The file formats supported for `CGAL::Point_set_3` are detailed in the table bel + - - - - - - - + + - - + + + - - + + + +
Generic \ref IOStreamOFF "OFF" \ref IOStreamXYZ "XYZ"\ref IOStreamPLY "PLY"
ASCIIASCIIASCII BINARY\ref IOStreamPLY "PLY"
Inputread_point_set() read_OFF()read_xyz_point_set()operator>>(std::istream&,CGAL::Point_set_3&)operator>>(std::istream&,CGAL::Point_set_3&)read_XYZ()read_PLY()
Outputwrite_point_set() write_OFF()write_xyz_point_set()operator<<(std::ostream&,const CGAL::Point_set_3&)write_ply_point_set()write_XYZ()write_PLY()
+ + + + + + + + + + + + + + + + + + + + + +
Generic\ref IOStreamOFF "OFF"\ref IOStreamXYZ "XYZ"\ref IOStreamPLY "PLY"
Inputread_points()read_OFF()read_XYZ()read_PLY()
Outputwrite_points()write_OFF()write_XYZ()write_PLY()
@@ -302,20 +323,15 @@ their indices per face (i.e a vector of 3 integers represent a triangle face). + - - - - - - - + @@ -323,6 +339,7 @@ their indices per face (i.e a vector of 3 integers represent a triangle face). + @@ -337,6 +354,7 @@ with some additional restrictions; a more precise definition can be found \ref P
Generic \ref IOStreamOFF "OFF" \ref IOStreamSTL "STL" \ref IOStreamOBJ "OBJ" \ref IOStreamPLY "PLY"
ASCIIASCIIBINARYASCII / BINARY
Inputread_polygon_soup() read_OFF() read_STL() read_OBJ()
Outputwrite_polygon_soup() write_OFF() write_STL() -
+ @@ -344,17 +362,9 @@ with some additional restrictions; a more precise definition can be found \ref P - - - - - - - - - + @@ -365,6 +375,7 @@ with some additional restrictions; a more precise definition can be found \ref P + @@ -401,6 +412,7 @@ here is a table to summarize the most useful functions : + @@ -414,7 +426,6 @@ here is a table to summarize the most useful functions : -
Generic \ref IOStreamOFF "OFF" \ref IOStreamSTL "STL" \ref IOStreamVTK "VTP"\ref IOStreamGocad "GOCAD" \ref IOStreamWRL "WRL"
ASCIIASCIIASCII BINARYBINARYASCIIASCII
Input`read_polygon_mesh()` `read_OFF()` `read_STL()` `read_VTP()`
Output`write_polygon_mesh()` `write_OFF()` `write_STL()` `write_VTP()`Polygons Everything
Input read_multi_point_WKT() read_multi_linestring_WKT()write_multi_polygon_WKT() n/a
\subsection IOstreamOtherIO Other Data Structures diff --git a/Stream_support/include/CGAL/IO/polygon_soup_io.h b/Stream_support/include/CGAL/IO/polygon_soup_io.h index 22ba98c28e6..da35125408d 100644 --- a/Stream_support/include/CGAL/IO/polygon_soup_io.h +++ b/Stream_support/include/CGAL/IO/polygon_soup_io.h @@ -39,12 +39,12 @@ namespace CGAL { * \brief Reads a polygon soup from a file. * * Supported file formats are 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") - * - `.ts` (\ref IOStreamGocad "GOCAD file format") - * - `.vtp` (\ref IOStreamVTK "VTK file format") + * - \ref IOStreamOFF (`.off`) + * - \ref IOStreamOBJ (`.obj`) + * - \ref IOStreamSTL (`.stl`) + * - \ref IOStreamPLY (`.ply`) + * - \ref IOStreamGocad (`.ts`) + * - \ref IOStreamVTK (`.vtp`) * * \tparam PolygonRange a model of the concept `RandomAccessContainer` * whose value_type is a model of the concept `RandomAccessContainer` @@ -104,12 +104,12 @@ bool read_polygon_soup(const std::string& fname, * \brief Writes the content of `points` and `polygons` in a file. * * Supported file formats are 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") - * - `.ts` (\ref IOStreamGocad "GOCAD file format") - * - `.vtp` (\ref IOStreamVTK "VTK file format") + * - \ref IOStreamOFF (`.off`) + * - \ref IOStreamOBJ (`.obj`) + * - \ref IOStreamSTL (`.stl`) + * - \ref IOStreamPLY (`.ply`) + * - \ref IOStreamGocad (`.ts`) + * - \ref IOStreamVTK (`.vtp`) * * \tparam PolygonRange a model of the concept `RandomAccessContainer` * whose value_type is a model of the concept `RandomAccessContainer`