mirror of https://github.com/CGAL/cgal
Misc doc fixes
This commit is contained in:
Mael Rouxel-Labbé
parent
a91b750dd5
commit
1d85d190c6
|
|
@ -24,57 +24,40 @@ Supported file formats are listed on the \link IOStreamSupportedFileFormats foll
|
|||
\section IOstreamSupportedFormats Importing and Exporting Data
|
||||
|
||||
CGAL algorithms work on different types of data structures, such as \ref Chapter_Point_Set_3 "point sets",
|
||||
\ref PolygonSoups "polygon soups" or \ref PMPDef "polygon meshes".
|
||||
\ref PolygonSoups "polygon soups", or \ref PMPDef "polygon meshes".
|
||||
|
||||
\subsection IOstreamPolygonMeshIO Polygon Mesh IO
|
||||
Basically, a Polygon Mesh is a 3D structure that refines the concept of `FaceGraph`
|
||||
with some other restrictions. A more precise definition can be found \ref PMPDef "here".
|
||||
\subsection IOstreamPointSetIO Point Set IO
|
||||
The CGAL::Point_set_3 is a vector based data structure that contains
|
||||
a default property (named point) for the coordinates of the points,
|
||||
and is able to work with dynamic properties.
|
||||
|
||||
<table class="iotable">
|
||||
<tr>
|
||||
<th colspan="1"></th>
|
||||
<th colspan="1">\ref IOStreamOFF "OFF"</th>
|
||||
<th colspan="1">\ref IOStreamSTL "STL"</th>
|
||||
<th colspan="2">\ref IOStreamVTK "VTP"</th>
|
||||
<th colspan="1">\ref IOStreamOBJ "OBJ"</th>
|
||||
<th colspan="1">\ref IOStreamGocad "GOCAD"</th>
|
||||
<th colspan="1">\ref IOStreamWRL "WRL"</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">BINARY</th>
|
||||
<th colspan="1">ASCII</th>
|
||||
<th colspan="1">ASCII</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Export</td>
|
||||
<td>`write_OFF()`</td>
|
||||
<td>`write_STL()`</td>
|
||||
<td>`write_VTP()`</td>
|
||||
<td>`write_VTP()`</td>
|
||||
<td>`write_OBJ()`</td>
|
||||
<td>`write_GOCAD()`</td>
|
||||
<td>`write_WRL()`</td>
|
||||
<td>Input</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Import</td>
|
||||
<td>`read_OFF()`</td>
|
||||
<td>`read_STL()`</td>
|
||||
<td>`read_VTP()`</td>
|
||||
<td>`read_VTP()`</td>
|
||||
<td>`read_OBJ()`</td>
|
||||
<td>`read_GOCAD()`</td>
|
||||
<td>n/a</td>
|
||||
<td>Output</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>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
The table above only lists the functions that work with any Polygon Mesh.
|
||||
More functions are available for more specific classes, and they can be found
|
||||
\link IOStreamSupportedFileFormats here\endlink.
|
||||
|
||||
\subsection IOstreamPolygonSoupIO Polygon Soup IO
|
||||
A polygon soup is a set of polygons with no global combinatorial information,
|
||||
stored in a two containers: one storing the points, and the other one storing
|
||||
|
|
@ -96,52 +79,70 @@ their indices per face (i.e a vector of 3 integers represent a triangle face).
|
|||
<th colspan="1">ASCII / BINARY</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Export</td>
|
||||
<td>write_OFF()</td>
|
||||
<td>write_STL()</td>
|
||||
<td> - </td>
|
||||
<td>write_PLY()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Import</td>
|
||||
<td>Input</td>
|
||||
<td>read_OFF()</td>
|
||||
<td>read_STL()</td>
|
||||
<td>read_OBJ()</td>
|
||||
<td>read_PLY()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Output</td>
|
||||
<td>write_OFF()</td>
|
||||
<td>write_STL()</td>
|
||||
<td> - </td>
|
||||
<td>write_PLY()</td>
|
||||
</tr>
|
||||
</table>
|
||||
\subsection IOstreamPointSetIO Point Set IO
|
||||
The CGAL::Point_set_3 is a vector based data structure that contains
|
||||
a default property (named point) for the coordinates of the points,
|
||||
and is able to work with dynamic properties.
|
||||
|
||||
\subsection IOstreamPolygonMeshIO Polygon Mesh IO
|
||||
A Polygon Mesh is a 3D structure that refines the concept of `FaceGraph`
|
||||
with some other restrictions. A more precise definition can be found \ref PMPDef "here".
|
||||
|
||||
<table class="iotable">
|
||||
<tr>
|
||||
<th colspan="1"></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>
|
||||
<th colspan="1">\ref IOStreamSTL "STL"</th>
|
||||
<th colspan="2">\ref IOStreamVTK "VTP"</th>
|
||||
<th colspan="1">\ref IOStreamOBJ "OBJ"</th>
|
||||
<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>Export</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>Input</td>
|
||||
<td>`read_OFF()`</td>
|
||||
<td>`read_STL()`</td>
|
||||
<td>`read_VTP()`</td>
|
||||
<td>`read_VTP()`</td>
|
||||
<td>`read_OBJ()`</td>
|
||||
<td>`read_GOCAD()`</td>
|
||||
<td> - </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Import</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>Output</td>
|
||||
<td>`write_OFF()`</td>
|
||||
<td>`write_STL()`</td>
|
||||
<td>`write_VTP()`</td>
|
||||
<td>`write_VTP()`</td>
|
||||
<td>`write_OBJ()`</td>
|
||||
<td>`write_GOCAD()`</td>
|
||||
<td>`write_WRL()`</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
The table above only lists the functions that work with any Polygon Mesh.
|
||||
More functions are available for more specific classes, and they can be found
|
||||
\link IOStreamSupportedFileFormats here\endlink.
|
||||
|
||||
\subsection IOstreamWKT Simple 2D Geometry IO
|
||||
|
||||
`WKT` stands for <em>Well Known Text</em> and it is a text markup language for representing
|
||||
|
|
@ -163,23 +164,21 @@ here is a table to summarize the most useful functions :
|
|||
<th colspan="1">Polylines</th>
|
||||
<th colspan="1">Polygons</th>
|
||||
<th colspan="1">Everything</th>
|
||||
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Import</td>
|
||||
<td>Input</td>
|
||||
<td>read_multi_point_WKT()</td>
|
||||
<td>read_multi_linestring_WKT()</td>
|
||||
<td>read_multi_polygon_WKT()</td>
|
||||
<td>read_WKT()</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Export</td>
|
||||
<td>Output</td>
|
||||
<td>write_multi_point_WKT()</td>
|
||||
<td>write_multi_linestring_WKT()</td>
|
||||
<td>write_multi_polygon_WKT()</td>
|
||||
<td>n/a</td>
|
||||
</tr>
|
||||
<tr>
|
||||
</table>
|
||||
|
||||
\subsection IOstreamOtherIO Other Data Structures
|
||||
|
|
@ -216,7 +215,7 @@ which might look as follows:
|
|||
\section IOstreamIO IO Streams
|
||||
|
||||
All classes in the \cgal kernel provide input and output operators for
|
||||
IO streams. Classes external to \cgal are also supported, by means of `oformat()`
|
||||
%IO streams. Classes external to \cgal are also supported, by means of `oformat()`
|
||||
(Section \ref seciofornoncgaltypes "IO for Non CGAL Types").
|
||||
The basic task of such an operator is to produce a
|
||||
representation of an object that can be written as a sequence of
|
||||
|
|
|
|||
|
|
@ -61,12 +61,12 @@ the printing mode.
|
|||
- `CGAL::oformat()`
|
||||
|
||||
\cgalCRPSection{File I/O Functions}
|
||||
- \link StlIoFuncs I/O on STL files (`CGAL::write_STL()`and `CGAL::read_STL()`)\endlink
|
||||
- \link PlyIoFuncs I/O on PLY files (`CGAL::write_PLY()`and `CGAL::read_PLY()`)\endlink
|
||||
- \link ObjIoFuncs I/O on OBJ files (`CGAL::write_OBJ()`and `CGAL::read_OBJ()`)\endlink
|
||||
- \link OffIoFuncs I/O on OFF files (`CGAL::write_OFF()`and `CGAL::read_OFF()`)\endlink
|
||||
- \link GocadIoFuncs I/O on GOCAD files (`CGAL::write_GOCAD()`and `CGAL::read_GOCAD()`)\endlink
|
||||
- \link VtpIoFuncs I/O on VTP files (`CGAL::write_VTP()`and `CGAL::read_VTP()`)\endlink
|
||||
- \link StlIoFuncs I/O for STL files (`CGAL::write_STL()`and `CGAL::read_STL()`)\endlink
|
||||
- \link PlyIoFuncs I/O for PLY files (`CGAL::write_PLY()`and `CGAL::read_PLY()`)\endlink
|
||||
- \link ObjIoFuncs I/O for OBJ files (`CGAL::write_OBJ()`and `CGAL::read_OBJ()`)\endlink
|
||||
- \link OffIoFuncs I/O for OFF files (`CGAL::write_OFF()`and `CGAL::read_OFF()`)\endlink
|
||||
- \link GocadIoFuncs I/O for GOCAD files (`CGAL::write_GOCAD()`and `CGAL::read_GOCAD()`)\endlink
|
||||
- \link VtpIoFuncs I/O for VTP files (`CGAL::write_VTP()`and `CGAL::read_VTP()`)\endlink
|
||||
- `GCAL::read_polygon_soup()`
|
||||
- `GCAL::write_polygon_soup()`
|
||||
- `GCAL::read_WKT()`
|
||||
|
|
|
|||
|
|
@ -34,6 +34,7 @@
|
|||
namespace CGAL {
|
||||
namespace internal{
|
||||
namespace IO{
|
||||
|
||||
template<typename PolygonMesh,
|
||||
typename K,
|
||||
typename NamedParameters = Named_function_parameters<bool, internal_np::all_default_t> >
|
||||
|
|
|
|||
Loading…
Reference in New Issue