Corrections of documentation (based on small feature review)

This commit is contained in:
Simon Giraudot 2016-04-11 17:24:33 +02:00
parent e922a1c858
commit 83290fda5d
3 changed files with 24 additions and 14 deletions

View File

@ -3,9 +3,8 @@
\cgalConcept
A PLY interpreter describes how to process a PLY input based on its
headers informations. More specifically, it must specify what
properties are expected for each point and where to store them once
read.
headers informations. More specifically, it must specify the
properties expected for each point and where to store them once read.
\cgalHasModel `CGAL::Ply_interpreter_points_and_normals_3`
@ -15,18 +14,29 @@ class PlyInterpreter
public:
/*!
Check if expected properties are found in the PLY hreader.
Check if expected properties are found in the PLY reader. If this
function returns false, then `read_ply_custom_points()` will not
read anything from the input stream.
Note that although the PLY header specifies the order in which the
tag attributes should appear in the file, the attributes in the
`Ply_reader` are only identified by their type and tag, not by
their position in the header.
\param reader Ply_reader to which the interpreter is expected to
be applied
\return true if the provided reader match the requirements of the
interpreter.
\return true if the provided reader matches the requirements of
the interpreter, false otherwise.
*/
bool is_applicable (Ply_reader& reader);
/*!
Assign read properties to appropriate containers or classes.
Assign read properties to appropriate containers or classes. Note
that in a PLY input, one point occupies exactly one line (with all
properties separated by white spaces): this method aims at
processing one point along with its potential attributes.
\param reader Ply_reader used to read PLY input
*/

View File

@ -105,12 +105,12 @@ in pairs and accessed through property maps.
\subsection Point_set_processing_3Example_ply Example of custom PLY reader
PLY files are designed to embed any number of additional properties:
more specifically, point sets may contain normal vectors, visibility
vectors, RGB colors, intensity, etc. As it is not possible to provide
dedicated functions to every possible combination of PLY properties,
\cgal provides a simple way to write custom PLY readers so that the
user can adapt its programs to its PLY input.
PLY files are designed to embed an arbitrary number of additional
attributes. More specifically, point sets may contain normal vectors,
visibility vectors, RGB colors, intensity, etc. As it is not possible
to provide dedicated functions to every possible combination of PLY
properties, \cgal provides a simple way to write custom PLY readers so
that the user can adapt its programs to its PLY input.
The function `read_ply_custom_points()` uses the concept `PlyInterpreter`
to read specific properties defined by the user. \cgal provides, for this

View File

@ -72,7 +72,7 @@ public:
int main(int argc, char*argv[])
{
const char* fname = (argc>1)?argv[1]:"data/colors.ply";
const char* fname = (argc>1) ? argv[1] : "data/colors.ply";
// Reads a .ply point set file with normal vectors and colors
std::vector<Pwn> points; // store points with normals