cgal/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt

69 lines
2.4 KiB
Plaintext

/// \defgroup PkgLinearCellComplex Linear Cell Complex Reference
/// \defgroup PkgLinearCellComplexConcepts Concepts
/// \ingroup PkgLinearCellComplex
/// \defgroup PkgLinearCellComplexClasses Classes
/// \ingroup PkgLinearCellComplex
/*! Basic constructions.
\code
#include <CGAL/Linear_cell_complex_constructors.h>
\endcode
*/
/// \defgroup PkgLinearCellComplexConstructions Constructions for Linear Cell Complex
/// \ingroup PkgLinearCellComplex
/*! High-level operations.
\code
#include <CGAL/Linear_cell_complex_operations.h>
\endcode
*/
/// \defgroup PkgLinearCellComplexOperations Operations for Linear Cell Complex
/// \ingroup PkgLinearCellComplex
/*!
\addtogroup PkgLinearCellComplex
\cgalPkgDescriptionBegin{Linear Cell Complex,PkgLinearCellComplexSummary}
\cgalPkgPicture{logo-lcc-small.png}
\cgalPkgSummaryBegin
\cgalPkgAuthor{Guillaume Damiand}
\cgalPkgDesc{This package implements linear cell complexes, objects in <I>d</I>-dimension with linear geometry. The combinatorial part of objects is described by a combinatorial map, representing all the cells of the object plus the incidence and adjacency relations between cells. Geometry is added to combinatorial maps simply by associating a point to each vertex of the map. Taking a 2D combinatorial map, and using 3D points, gives a linear cell complex equivalent to a <I>Polyhedron_3</I>.}
\cgalPkgManuals{Chapter_Linear_Cell_Complex,PkgLinearCellComplex}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{4.0}
\cgalPkgDependsOn{\ref PkgCombinatorialMapsSummary}
\cgalPkgBib{cgal:d-lcc-12}
\cgalPkgLicense{\ref licensesLGPL "LGPL"}
\cgalPkgDemo{3D Linear Cell Complex,linear_cell_complex_3.zip}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
\cgalClassifedRefPages
## Concepts ##
- `LinearCellComplexTraits`
- `LinearCellComplexItems`
- `CellAttributeWithPoint`
## Classes ##
- `CGAL::Linear_cell_complex<d,d2,LCCTraits,Items,Alloc>`
- `CGAL::Linear_cell_complex_min_items<d>`
- `CGAL::Linear_cell_complex_traits<d,K>`
- `CGAL::Cell_attribute_with_point<LCC,Info_,Tag,OnMerge,OnSplit>`
## Global Functions ##
### Constructions for Linear cell complex ###
- `CGAL::import_from_plane_graph<LCC>`
- `CGAL::import_from_triangulation_3<LCC,Triangulation>`
- `CGAL::import_from_polyhedron_3<LCC,Polyhedron>`
### Operations for Linear cell complex ###
- `CGAL::compute_normal_of_cell_0<LCC>`
- `CGAL::compute_normal_of_cell_2<LCC>`
*/