songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix some I/O doc in Polyhedron

This commit is contained in:
Mael Rouxel-Labbé 2020-07-17 12:22:11 +02:00
parent f416d431ac
commit 91faa22b4a
2 changed files with 12 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Polyhedron/doc/Polyhedron/Polyhedron.txt
View File

@ -298,16 +298,11 @@ surface and its point coordinates. It ignores a possible plane
equation or any user-added attributes, such as color.
The default file format supported in \cgal for output as well as for
input is the %Object File Format, OFF, with file extension <TT>.off</TT>,
which is also understood by Geomview \cgalCite{cgal:p-gmgv16-96}. For OFF
an ASCII and a binary format exist. The format can be selected with
the \cgal modifiers for streams, `set_ascii_mode()` and
`set_binary_mode()` respectively. The modifier `set_pretty_mode()`
can be used to allow for (a few) structuring comments in the
output. Otherwise, the output would be free of comments. The default
for writing is ASCII without comments. Both, ASCII and binary format,
can be read independent of the stream setting. Since this file format
is the default format, iostream operators are provided for it.
input is the \ref IOStreamOFF, with file extension <TT>.off</TT>,
which is also understood by Geomview \cgalCite{cgal:p-gmgv16-96}.
The modifier `set_pretty_mode()` can be used to allow for (a few) structuring comments in the output.
Otherwise, the output would be free of comments. The default for writing is without comments.
Since this file format is the default format, iostream operators are provided for it.
\code{.cpp}
#include <CGAL/IO/Polyhedron_iostream.h>
@ -324,8 +319,8 @@ CGAL::Polyhedron_3<PolyhedronTraits_3>& P);
Additional formats supported for writing are OpenInventor (<TT>.iv</TT>)
\cgalCite{cgal:w-impoo-94}, VRML 1.0 and 2.0 (<TT>.wrl</TT>)
\cgalCite{cgal:bpp-vrml-95}, \cgalCite{cgal:vrmls-97}, \cgalCite{cgal:hw-vrml2h-96}, and Wavefront Advanced
Visualizer object format (<TT>.obj</TT>). Another convenient output
\cgalCite{cgal:bpp-vrml-95}, \cgalCite{cgal:vrmls-97}, \cgalCite{cgal:hw-vrml2h-96},
and \ref IOStreamOBJ (<TT>.obj</TT>). Another convenient output
function writes a polyhedral surface to a Geomview process spawned
from the \cgal program. These output functions are provided as
stream operators, now acting on the stream type of the respective
@ -363,8 +358,7 @@ restrictions on these formats. They must represent a permissible
polyhedral surface, e.g., a 2-manifold and no isolated vertices, see
Section \ref sectionPolyIntro.
For more information, you can see the \ref IOstreamPolygonMeshIO
section.
For more information on generic polygon meshes I/O, see the section \ref IOstreamPolygonMeshIO.
\section PolyhedronExtending Extending Vertices, Halfedges, and Facets

6
Stream_support/doc/Stream_support/IOstream.txt
View File

@ -435,8 +435,10 @@ Free functions are provided for reading and writing several \cgal types using th
- `CGAL::Polygon_with_holes_2`
- random access range of the above types.
You can find more information about WKT \ref PkgStreamSupportRef "here", but
here is a table to summarize the most useful functions :
You can find more information about WKT \ref PkgStreamSupportRef "here".
The following table summarizes the most useful functions. Note that the name deviates
from the standard \cgal I/O functions, for clarity reasons.
<table>
<tr>
<th colspan="1"></th>