From d9756dd97173ac93347bc9d90a1e86a4dc532f86 Mon Sep 17 00:00:00 2001 From: Sven Oesau Date: Fri, 2 Feb 2024 13:55:37 +0100 Subject: [PATCH] added missing include adding image to doc --- Orthtree/doc/Orthtree/Orthtree.txt | 8 ++++++-- Orthtree/include/CGAL/Orthtree.h | 2 +- Orthtree/include/CGAL/Orthtree/Traversals.h | 1 + 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/Orthtree/doc/Orthtree/Orthtree.txt b/Orthtree/doc/Orthtree/Orthtree.txt index 15c2a3e3505..f18a92ccf43 100644 --- a/Orthtree/doc/Orthtree/Orthtree.txt +++ b/Orthtree/doc/Orthtree/Orthtree.txt @@ -26,10 +26,9 @@ with custom contents and split predicates, and iterated on with various traversal methods. Orthants can be orthotopes and not only hypercubes. \cgalFigureBegin{Orthtree_fig, orthtree.png} -Building an %orthtree in 3D (%octree) from a point cloud. +Building an %orthtree in 3D (%octree) from a point cloud (top) and a mesh (bottom). \cgalFigureEnd - \section Section_Orthtree_Building Building A common purpose for an orthtree is to subdivide a collection of points, @@ -119,6 +118,11 @@ set as the orthtree's map type, so a map does not need to be provided. \cgalExample{Orthtree/orthtree_build.cpp} +\section Section_Orthtree_Properties Properties +The Orthtree uses a mechanism to attach properties to nodes at run-time which follows \ref sectionSurfaceMesh_properties "Surface mesh properties". Each property is identified by a string and its key type and stored in a consecutive block of memory. Contrary to surface mesh the removal of properties is not supported. + +Several properties are provided by default and used to maintain the data structure. The property \c "contents" keeps the data for each node. "parents" and "children" maintain the relation between nodes. "coordinates" and "depth" contain absolute positions of nodes. + \section Section_Orthtree_Traversal Traversal \note For simplicity, the rest of the user manual will only use diff --git a/Orthtree/include/CGAL/Orthtree.h b/Orthtree/include/CGAL/Orthtree.h index 60fc8e30852..9e4f62fc9d4 100644 --- a/Orthtree/include/CGAL/Orthtree.h +++ b/Orthtree/include/CGAL/Orthtree.h @@ -311,7 +311,7 @@ public: than `bucket_size`, it is not split. \warning This convenience method is only appropriate for trees with traits classes where - `Node_data` is a model of `RandomAccessRange`. + `Node_data` is a model of `Range`. `RandomAccessRange` is suggested for performance. \param max_depth deepest a tree is allowed to be (nodes at this depth will not be split). \param bucket_size maximum number of items a node is allowed to contain. diff --git a/Orthtree/include/CGAL/Orthtree/Traversals.h b/Orthtree/include/CGAL/Orthtree/Traversals.h index f2a8ad6af37..e9876c6448f 100644 --- a/Orthtree/include/CGAL/Orthtree/Traversals.h +++ b/Orthtree/include/CGAL/Orthtree/Traversals.h @@ -14,6 +14,7 @@ #include +#include #include #include #include