mirror of https://github.com/CGAL/cgal
Fixed minor doc issues in Surface_mesh
This commit is contained in:
parent
1ec408f6f3
commit
5ff2a0d315
|
|
@ -51,8 +51,8 @@ main purpose is to guarantee type safety.
|
||||||
They are default constructible, which yields an *invalid* element. New
|
They are default constructible, which yields an *invalid* element. New
|
||||||
elements can be added and removed to the `Surface_mesh` through a
|
elements can be added and removed to the `Surface_mesh` through a
|
||||||
set of low-level functions which do not maintain connectivity. One
|
set of low-level functions which do not maintain connectivity. One
|
||||||
exception is `Surface_mesh::add_face()` which tries to add a new
|
exception is `Surface_mesh::add_face()`, which tries to add a new
|
||||||
face to the mesh (defined by a sequence of vertices), and fails, if the
|
face to the mesh (defined by a sequence of vertices), and fails if the
|
||||||
operation is not topologically valid.
|
operation is not topologically valid.
|
||||||
|
|
||||||
\code
|
\code
|
||||||
|
|
@ -64,11 +64,14 @@ Mesh::Vertex_index w = m.add_vertex(Point(1,0,0));
|
||||||
m.add_face(u, v, w);
|
m.add_face(u, v, w);
|
||||||
\endcode
|
\endcode
|
||||||
|
|
||||||
As `Surface_mesh` is index-based `Vertex_index`, `Face_index`,
|
As `Surface_mesh` is index-based
|
||||||
`Halfedge_index` and `Edge_index`
|
\link Surface_mesh::Vertex_index Vertex_index\endlink,
|
||||||
don't have member functions to access connectivity or properties.
|
\link Surface_mesh::Halfedge_index Halfedge_index\endlink,
|
||||||
The functions of the `Surface_mesh` instance they were
|
\link Surface_mesh::Edge_index Edge_index\endlink, and
|
||||||
created from must be used to obtain that information.
|
\link Surface_mesh::Face_index Face_index\endlink
|
||||||
|
do not have member functions to access connectivity or properties.
|
||||||
|
The functions of the `Surface_mesh` instance from which
|
||||||
|
they were created must be used to obtain this information.
|
||||||
|
|
||||||
\section sectionSurfaceMeshConnectivity Connectivity
|
\section sectionSurfaceMeshConnectivity Connectivity
|
||||||
|
|
||||||
|
|
@ -327,7 +330,7 @@ to access data in temporary vectors of size `num_vertices()`
|
||||||
this function must return a number larger than the largest index of
|
this function must return a number larger than the largest index of
|
||||||
the elements.
|
the elements.
|
||||||
|
|
||||||
Iterators like the `Surface_mesh::Vertex_iterator` only enumerate
|
Iterators such as `Surface_mesh::Vertex_iterator` only enumerate
|
||||||
elements that are not marked as deleted.
|
elements that are not marked as deleted.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1966,7 +1966,6 @@ private: //------------------------------------------------------- private data
|
||||||
/// Inserts the surface mesh in an output stream in Ascii OFF format.
|
/// Inserts the surface mesh in an output stream in Ascii OFF format.
|
||||||
/// Only the \em point property is inserted in the stream.
|
/// Only the \em point property is inserted in the stream.
|
||||||
/// \pre `operator<<(std::ostream&,const P&)` must be defined.
|
/// \pre `operator<<(std::ostream&,const P&)` must be defined.
|
||||||
|
|
||||||
template <typename P>
|
template <typename P>
|
||||||
bool write_off(std::ostream& os, const Surface_mesh<P>& sm) {
|
bool write_off(std::ostream& os, const Surface_mesh<P>& sm) {
|
||||||
typedef Surface_mesh<P> Mesh;
|
typedef Surface_mesh<P> Mesh;
|
||||||
|
|
@ -2015,7 +2014,7 @@ private: //------------------------------------------------------- private data
|
||||||
|
|
||||||
/// \relates Surface_mesh
|
/// \relates Surface_mesh
|
||||||
///
|
///
|
||||||
/// This operator calls `write_off(std::istream& , CGAL::Surface_mesh)`.
|
/// This operator calls `write_off(std::ostream& os, const CGAL::Surface_mesh& sm)`.
|
||||||
template <typename P>
|
template <typename P>
|
||||||
std::ostream& operator<<(std::ostream& os, const Surface_mesh<P>& sm)
|
std::ostream& operator<<(std::ostream& os, const Surface_mesh<P>& sm)
|
||||||
{
|
{
|
||||||
|
|
@ -2158,8 +2157,8 @@ private: //------------------------------------------------------- private data
|
||||||
|
|
||||||
|
|
||||||
/// \relates Surface_mesh
|
/// \relates Surface_mesh
|
||||||
/// This operator calls `read_off(std::istream& , CGAL::Surface_mesh& sm)`.
|
/// This operator calls `read_off(std::istream& is, CGAL::Surface_mesh& sm)`.
|
||||||
/// \attention Up to CGAL 4.10 this operator called `sm.clear()`.
|
/// \attention Up to %CGAL 4.10 this operator called `sm.clear()`.
|
||||||
template <typename P>
|
template <typename P>
|
||||||
std::istream& operator>>(std::istream& is, Surface_mesh<P>& sm)
|
std::istream& operator>>(std::istream& is, Surface_mesh<P>& sm)
|
||||||
{
|
{
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue