cgal/Orthtree/doc/Orthtree/PackageDescription.txt

69 lines
2.0 KiB
Plaintext

/// \defgroup PkgOrthtreeRef Quadtrees, Octrees and Orthtrees Reference
Quadtree, Octree and Orthtree Reference
/// \defgroup PkgOrthtreeConcepts Concepts
/// \ingroup PkgOrthtreeRef
/// \defgroup PkgOrthtreeTraits Traits
/// \ingroup PkgOrthtreeRef
/// \defgroup PkgOrthtreeSplitPredicates Split Predicates
/// \ingroup PkgOrthtreeRef
/// \defgroup PkgOrthtreeTraversal Traversal
/// \ingroup PkgOrthtreeRef
/*!
\addtogroup PkgOrthtreeRef
\cgalPkgDescriptionBegin{Quadtrees\, Octrees\, and Orthtrees,PkgOrthtree}
\cgalPkgPicture{octree_thumbnail.png}
\cgalPkgSummaryBegin
\cgalPkgAuthors{Jackson Campolattaro, Simon Giraudot, Cédric Portaneri, Tong Zhao, and Pierre Alliez}
\cgalPkgDesc{The Orthtree package provides a data structure that subdivides space, with specializations for 2D (Quadtree) and 3D (Octree), along with a collection of algorithms for operating on these structures.}
\cgalPkgManuals{Chapter_Orthtree,PkgOrthtreeRef}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{5.3}
\cgalPkgBib{cgal:cpz-o}
\cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
\cgalClassifedRefPages
\cgalCRPSection{Concepts}
- `OrthtreeTraits`
- `OrthtreeTraitsWithData`
- `OrthtreeTraversal`
- `CollectionPartitioningOrthtreeTraits`
\cgalCRPSection{Classes}
- `CGAL::Quadtree<GeomTraits, PointRange, PointMap>`
- `CGAL::Octree<GeomTraits, PointRange, PointMap>`
- `CGAL::Orthtree<GeomTraits, PointRange, PointMap>`
\cgalCRPSection{Traits}
- `CGAL::Orthtree_traits<GeomTraits, dimension>`
- `CGAL::Orthtree_traits_point<GeomTraits, PointRange, PointMap, dimension>`
- `CGAL::Orthtree_traits_base<GeomTraits>`
- `CGAL::Orthtree_traits_face_graph<TriangleMesh, VertexPointMap>`
\cgalCRPSection{Split Predicates}
- `CGAL::Orthtrees::Maximum_contained_elements`
- `CGAL::Orthtrees::Maximum_depth`
- `CGAL::Orthtrees::Maximum_depth_and_maximum_contained_elements`
\cgalCRPSection{%Traversal}
- `CGAL::Orthtrees::Preorder_traversal`
- `CGAL::Orthtrees::Postorder_traversal`
- `CGAL::Orthtrees::Leaves_traversal`
- `CGAL::Orthtrees::Level_traversal`
*/