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

some more BGL/Surface_mesh equivalences; change chapter title

This commit is contained in:
Andreas Fabri 2014-11-07 17:39:24 +01:00
parent 95aa725b00
commit c7f439d1a5
2 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Surface_mesh/doc/Surface_mesh/PackageDescription.txt
View File

@ -1,22 +1,22 @@
/// \defgroup PkgSurface_mesh Polyhedral Surface Mesh Reference
/// \defgroup PkgSurface_mesh Surface Mesh Reference
/*!
\addtogroup PkgSurface_mesh
\cgalPkgDescriptionBegin{Polyhedral Surface Mesh,PkgSurfaceMeshSummary}
\cgalPkgDescriptionBegin{Surface Mesh,PkgSurfaceMeshSummary}
\cgalPkgPicture{Surface_mesh_teaser.png}
\cgalPkgSummaryBegin
\cgalPkgAuthor{Mario Botsch, Daniel Sieger, Philipp Moeller, and Andreas Fabri}
\cgalPkgDesc{The polyhedral surface mesh class provided by this package is a data structure
\cgalPkgDesc{The surface mesh class provided by this package is a data structure
that can be used as halfedge data structure or polyhedral surface. It is
an alternative to the packages \ref PkgHDSSummary and \ref PkgPolyhedronSummary.
The main differences are that it is indexed based and not pointer based,
and that the mechanism for adding information to vertices, halfedges,
and that the mechanism for adding information to vertices, halfedges, edges,
and faces is much simpler and can be used at runtime and not at compile time.}
\cgalPkgManuals{Chapter_3D_Surface_mesh,PkgSurface_mesh}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{4.5}
\cgalPkgSince{4.6}
\cgalPkgBib{cgal:bsmf-sm}
\cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgShortInfoEnd

8
Surface_mesh/doc/Surface_mesh/Surface_mesh.txt
View File

@ -230,6 +230,8 @@ for example
| BGL | %Surface_mesh | Remark |
| :---- | :---- | :--- |
| `boost::graph_traits<G>::%vertex_descriptor` | `Surface_mesh::Vertex_index` | |
| `boost::graph_traits<G>::%edge_descriptor` | `Surface_mesh::Edge_index` | |
| `vertices(const G& g)` | `sm.vertices()` | |
| `edges(const G& g)` | `sm.edges()` | |
| `vd = source(ed,g)` | `vd = sm.source(ed)` | |
| na | `n = sm.number_of_vertices()` | counts non-deleted vertices and has no BGL equivalent |
@ -242,12 +244,16 @@ The class `Surface_mesh` is also a model of the concept `MutableFaceGraph` defin
in the package \ref PkgBGLSummary. This and similar concepts like `HalfedgeGraph`
refine the graph concepts of the BGL by introducing the notion of halfedges and faces,
as well as cycles of halfedges around faces and around vertices.
Again, there are similar types and functions:
Again, there are similar types and functions, for example:
| BGL | %Surface_mesh |
| :---- | :---- |
| `boost::graph_traits<G>::%halfedge_descriptor` | `Surface_mesh::Halfedge_index` |
| `boost::graph_traits<G>::%face_descriptor` | `Surface_mesh::Face_index` | |
| `halfedges(const G& g)` | `sm.halfedges()` | |
| `faces(const G& g)` | `sm.faces()` | |
| `hd = next(hd, g)` | `hd = sm.next(hd)` |
| `hd = prev(hd, g)` | `hd = sm.prev(hd)` |
| `hd = opposite(hd,g)` | `hd = sm.opposite(hd)` |
| `hd = halfedge(vd,g)` | `hd = sm.halfedge(vd)` |
| etc. | |