mirror of https://github.com/CGAL/cgal
Stream support IO doc improvements (wip)
This commit is contained in:
Mael Rouxel-Labbé
parent
275d73e6c1
commit
3e057e4344
|
|
@ -270,27 +270,48 @@ The file formats supported for `CGAL::Point_set_3` are detailed in the table bel
|
|||
<table class="iotable">
|
||||
<tr>
|
||||
<th colspan="1"></th>
|
||||
<th colspan="1">Generic</th>
|
||||
<th colspan="1">\ref IOStreamOFF "OFF"</th>
|
||||
<th colspan="1">\ref IOStreamXYZ "XYZ"</th>
|
||||
<th colspan="2<td>operator<<(std::ostream&,const CGAL::Point_set_3<Point, Vector>&)</td>">\ref IOStreamPLY "PLY"</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="1"></th>
|
||||
<th colspan="1">ASCII</th>
|
||||
<th colspan="1">ASCII</th>
|
||||
<th colspan="1">ASCII</th> <th colspan="1">BINARY</th>
|
||||
<th colspan="1">\ref IOStreamPLY "PLY"</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Input</td>
|
||||
<td>read_point_set()</td>
|
||||
<td>read_OFF()</td>
|
||||
<td>read_xyz_point_set()</td>
|
||||
<td>operator>>(std::istream&,CGAL::Point_set_3<Point, Vector>&)</td><td>operator>>(std::istream&,CGAL::Point_set_3<Point, Vector>&)</td>
|
||||
<td>read_XYZ()</td>
|
||||
<td>read_PLY()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Output</td>
|
||||
<td>write_point_set()</td>
|
||||
<td>write_OFF()</td>
|
||||
<td>write_xyz_point_set()</td>
|
||||
<td>operator<<(std::ostream&,const CGAL::Point_set_3<Point, Vector>&)</td><td>write_ply_point_set()</td>
|
||||
<td>write_XYZ()</td>
|
||||
<td>write_PLY()</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table class="iotable">
|
||||
<tr>
|
||||
<th colspan="1"></th>
|
||||
<th colspan="1">Generic</th>
|
||||
<th colspan="1">\ref IOStreamOFF "OFF"</th>
|
||||
<th colspan="1">\ref IOStreamXYZ "XYZ"</th>
|
||||
<th colspan="1">\ref IOStreamPLY "PLY"</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Input</td>
|
||||
<td>read_points()</td>
|
||||
<td>read_OFF()</td>
|
||||
<td>read_XYZ()</td>
|
||||
<td>read_PLY()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Output</td>
|
||||
<td>write_points()</td>
|
||||
<td>write_OFF()</td>
|
||||
<td>write_XYZ()</td>
|
||||
<td>write_PLY()</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
|
@ -302,20 +323,15 @@ their indices per face (i.e a vector of 3 integers represent a triangle face).
|
|||
<table class="iotable">
|
||||
<tr>
|
||||
<th colspan="1"></th>
|
||||
<th colspan="1">Generic</th>
|
||||
<th colspan="1">\ref IOStreamOFF "OFF"</th>
|
||||
<th colspan="1">\ref IOStreamSTL "STL"</th>
|
||||
<th colspan="1">\ref IOStreamOBJ "OBJ"</th>
|
||||
<th colspan="1">\ref IOStreamPLY "PLY"</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="1"></th>
|
||||
<th colspan="1">ASCII</th>
|
||||
<th colspan="1">ASCII</th>
|
||||
<th colspan="1">BINARY</th>
|
||||
<th colspan="1">ASCII / BINARY</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Input</td>
|
||||
<td>read_polygon_soup()</td>
|
||||
<td>read_OFF()</td>
|
||||
<td>read_STL()</td>
|
||||
<td>read_OBJ()</td>
|
||||
|
|
@ -323,6 +339,7 @@ their indices per face (i.e a vector of 3 integers represent a triangle face).
|
|||
</tr>
|
||||
<tr>
|
||||
<td>Output</td>
|
||||
<td>write_polygon_soup()</td>
|
||||
<td>write_OFF()</td>
|
||||
<td>write_STL()</td>
|
||||
<td> - </td>
|
||||
|
|
@ -337,6 +354,7 @@ with some additional restrictions; a more precise definition can be found \ref P
|
|||
<table class="iotable">
|
||||
<tr>
|
||||
<th colspan="1"></th>
|
||||
<th colspan="1">Generic</th>
|
||||
<th colspan="1">\ref IOStreamOFF "OFF"</th>
|
||||
<th colspan="1">\ref IOStreamSTL "STL"</th>
|
||||
<th colspan="2">\ref IOStreamVTK "VTP"</th>
|
||||
|
|
@ -344,17 +362,9 @@ with some additional restrictions; a more precise definition can be found \ref P
|
|||
<th colspan="1">\ref IOStreamGocad "GOCAD"</th>
|
||||
<th colspan="1">\ref IOStreamWRL "WRL"</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="1"></th>
|
||||
<th colspan="1">ASCII</th>
|
||||
<th colspan="1">ASCII</th>
|
||||
<th colspan="1">ASCII</th> <th colspan="1">BINARY</th>
|
||||
<th colspan="1">BINARY</th>
|
||||
<th colspan="1">ASCII</th>
|
||||
<th colspan="1">ASCII</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Input</td>
|
||||
<td>`read_polygon_mesh()`</td>
|
||||
<td>`read_OFF()`</td>
|
||||
<td>`read_STL()`</td>
|
||||
<td>`read_VTP()`</td>
|
||||
|
|
@ -365,6 +375,7 @@ with some additional restrictions; a more precise definition can be found \ref P
|
|||
</tr>
|
||||
<tr>
|
||||
<td>Output</td>
|
||||
<td>`write_polygon_mesh()`</td>
|
||||
<td>`write_OFF()`</td>
|
||||
<td>`write_STL()`</td>
|
||||
<td>`write_VTP()`</td>
|
||||
|
|
@ -401,6 +412,7 @@ here is a table to summarize the most useful functions :
|
|||
<th colspan="1">Polygons</th>
|
||||
<th colspan="1">Everything</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Input</td>
|
||||
<td>read_multi_point_WKT()</td>
|
||||
<td>read_multi_linestring_WKT()</td>
|
||||
|
|
@ -414,7 +426,6 @@ here is a table to summarize the most useful functions :
|
|||
<td>write_multi_polygon_WKT()</td>
|
||||
<td>n/a</td>
|
||||
</tr>
|
||||
<tr>
|
||||
</table>
|
||||
|
||||
\subsection IOstreamOtherIO Other Data Structures
|
||||
|
|
|
|||
|
|
@ -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`
|
||||
|
|
|
|||
Loading…
Reference in New Issue