Updating the AABB-tree to work in both 2D and 3D

AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h → AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits_3.h

@@ -3,8 +3,8 @@
 \ingroup PkgAABBTreeConcepts
 \cgalConcept
 
-The concept `AABBGeomTraits` defines the requirements for the first template parameter of the class
-`CGAL::AABB_traits<AABBGeomTraits, AABBPrimitive>`. It provides predicates and constructors to detect
+The concept `AABBGeomTraits_3` defines the requirements for the first template parameter of the class
+`CGAL::AABB_traits<AABBGeomTraits_3, AABBPrimitive>`. It provides predicates and constructors to detect
 and compute intersections between query objects and the primitives stored in the AABB tree.
 In addition, it contains predicates and constructors to compute distances between a point query
 and the primitives stored in the AABB tree.
@@ -15,13 +15,13 @@ and the primitives stored in the AABB tree.
 \cgalHasModelsBare{All models of the concept `Kernel`}
 \cgalHasModelsEnd
 
-\sa `CGAL::AABB_traits<AABBGeomTraits,AABBPrimitive>`
+\sa `CGAL::AABB_traits<AABBGeomTraits_3,AABBPrimitive>`
 \sa `CGAL::AABB_tree<AABBTraits>`
 \sa `AABBPrimitive`
 
 */
 
-class AABBGeomTraits {
+class AABBGeomTraits_3 {
 public:
 
 /// \name Types
@@ -199,5 +199,5 @@ Equal_3 equal_3_object();
 
 /// @}
 
-}; /* end AABBGeomTraits */
+}; /* end AABBGeomTraits_3 */
 

AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionGeomTraits.h → AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionGeomTraits_3.h

@@ -2,7 +2,7 @@
 \ingroup PkgAABBTreeConcepts
 \cgalConcept
 
-The concept `AABBRayIntersectionGeomTraits` is a refinement of the
+The concept `AABBRayIntersectionGeomTraits_3` is a refinement of the
 concept `AABBGeomTraits`. In addition to the types required by
 `AABBGeomTraits` it also requires types and functors necessary to
 define the Intersection_distance functor.
@@ -18,49 +18,51 @@ define the Intersection_distance functor.
 \sa `AABBPrimitive`
 
 */
-class AABBRayIntersectionGeomTraits {
+class AABBRayIntersectionGeomTraits_3 {
 public:
   /*!
-    Type of a 3D ray.
+    Type of a ray.
   */
-  typedef unspecified_type Ray_3;
+  typedef unspecified_type Ray;
 
   /*!
-    Type of a 3D vector.
+    Type of a vector.
   */
-  typedef unspecified_type Vector_3;
+  typedef unspecified_type Vector;
 
   /*!
     A functor object to construct the source point of a ray. Provides the operator:
-    `Point_3 operator()(const Ray_3&);`
+    `Point operator()(const Ray&);`
    */
-  typedef unspecified_type Construct_source_3;
+  typedef unspecified_type Construct_source;
 
   /*!
    */
-  Construct_source_3 construct_source_3_object();
+  Construct_source construct_source_object();
 
   /*!
+    @todo update me
     A model of `CartesianConstIterator3`.
    */
-  typedef unspecified_type Cartesian_const_iterator_3;
+  typedef unspecified_type Cartesian_const_iterator;
 
   /*!
+    @todo update me
     A model of `ConstructCartesianConstIterator3`.
    */
-  typedef unspecified_type  Construct_cartesian_const_iterator_3;
+  typedef unspecified_type  Construct_cartesian_const_iterator;
 
   /*!
    */
-  Construct_source_3 construct_cartesian_const_iterator_3_object();
+  Construct_source construct_cartesian_const_iterator_object();
 
   /*!
     A functor object to construct a vector giving the direction of a ray. Provides the operator:
-    `Vector_3 operator()(const Ray_3&);`
+    `Vector operator()(const Ray&);`
    */
-  typedef unspecified_type Construct_vector_3;
+  typedef unspecified_type Construct_vector;
 
   /*!
    */
-  Construct_source_3 construct_vector_3_object();
+  Construct_source construct_vector_object();
 };

AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h

@@ -9,7 +9,7 @@ The concept `AABBTraits` provides the geometric primitive types and methods for
 \cgalHasModels{CGAL::AABB_traits<AABBGeomTraits,AABBPrimitive>}
 \cgalHasModelsEnd
 
-\cgalRefines{SearchGeomTraits_3}
+\cgalRefines{SearchTraits}
 
 \sa `CGAL::AABB_traits<AABBGeomTraits,AABBPrimitive>`
 \sa `CGAL::AABB_tree<AABBTraits>`
@@ -30,7 +30,7 @@ typedef unspecified_type FT;
 /*!
 Type of a 3D point.
 */
-typedef unspecified_type Point_3;
+typedef unspecified_type Point;
 
 /*!
 Type of primitive.
@@ -43,19 +43,10 @@ Bounding box type.
 */
 typedef unspecified_type Bounding_box;
 
-  /*!
-  enum required for axis selection
-  */
-  enum Axis {
-    CGAL_X_AXIS,
-    CGAL_Y_AXIS,
-    CGAL_Z_AXIS
-  };
-
 /*!
 3D Point and Primitive Id type
 */
-typedef std::pair<Point_3, Primitive::Id> Point_and_primitive_id;
+typedef std::pair<Point, Primitive::Id> Point_and_primitive_id;
 
 /*!
 \deprecated
@@ -145,21 +136,21 @@ typedef unspecified_type Compare_distance;
 
 /*!
 A functor object to compute closest point from the query on a primitive. Provides the operator:
-`Point_3 operator()(const Query& query, const Primitive& primitive, const Point_3 & closest);` which returns the closest point to `query`, among `closest` and all points of the primitive.
+`Point operator()(const Query& query, const Primitive& primitive, const Point & closest);` which returns the closest point to `query`, among `closest` and all points of the primitive.
 */
 typedef unspecified_type Closest_point;
 
 /*!
 A functor object to compute the squared distance between two points. Provides the operator:
-`FT operator()(const Point& query, const Point_3 & p);` which returns the squared distance between `p` and `q`.
+`FT operator()(const Point& query, const Point & p);` which returns the squared distance between `p` and `q`.
 */
 typedef unspecified_type Squared_distance;
 
 /*!
 A functor object to compare two points. Provides the operator:
-`bool operator()(const Point_3& p, const Point_3& q);}` which returns `true` if `p` is equal to `q`.
+`bool operator()(const Point& p, const Point& q);}` which returns `true` if `p` is equal to `q`.
 */
-typedef unspecified_type Equal_3;
+typedef unspecified_type Equal;
 /// @}
 
 /// \name Operations
@@ -203,7 +194,7 @@ Squared_distance squared_distance_object();
 /*!
 returns the equal functor.
 */
-Equal_3 equal_3_object();
+Equal equal_object();
 
 /// @}
 

AABB_tree/doc/AABB_tree/PackageDescription.txt

@@ -5,12 +5,12 @@
 
 /*!
 \addtogroup PkgAABBTreeRef
-\cgalPkgDescriptionBegin{3D Fast Intersection and Distance Computation,PkgAABBTree}
+\cgalPkgDescriptionBegin{Fast Intersection and Distance Computation,PkgAABBTree}
 \cgalPkgPicture{aabb-teaser-thumb.png}
 \cgalPkgSummaryBegin
 \cgalPkgAuthors{Pierre Alliez, Stéphane Tayeb, and Camille Wormser}
 \cgalPkgDesc{The AABB (axis-aligned bounding box) tree component offers a static data structure and algorithms to perform efficient intersection and distance queries on sets of finite 3D geometric objects.}
-\cgalPkgManuals{Chapter_3D_Fast_Intersection_and_Distance_Computation,PkgAABBTreeRef}
+\cgalPkgManuals{Chapter_Fast_Intersection_and_Distance_Computation,PkgAABBTreeRef}
 \cgalPkgSummaryEnd
 \cgalPkgShortInfoBegin
 \cgalPkgSince{3.5}
@@ -25,18 +25,23 @@
 \cgalCRPSection{Concepts}
 - `AABBPrimitive`
 - `AABBPrimitiveWithSharedData`
-- `AABBGeomTraits`
+- `AABBGeomTraits_2`
+- `AABBGeomTraits_3`
 - `AABBTraits`
-- `AABBRayIntersectionGeomTraits`
+- `AABBRayIntersectionGeomTraits_2`
+- `AABBRayIntersectionGeomTraits_3`
 - `AABBRayIntersectionTraits`
 
 \cgalCRPSection{Classes}
-- `CGAL::AABB_traits<GeomTraits,Primitive>`
+- `CGAL::AABB_traits_2<GeomTraits,Primitive>`
+- `CGAL::AABB_traits_3<GeomTraits,Primitive>`
 - `CGAL::AABB_tree<AT>`
 
 \cgalCRPSection{Primitives}
-- `CGAL::AABB_triangle_primitive<GeomTraits, Iterator, CacheDatum>`
-- `CGAL::AABB_segment_primitive<GeomTraits, Iterator, CacheDatum>`
+- `CGAL::AABB_triangle_primitive_2<GeomTraits, Iterator, CacheDatum>`
+- `CGAL::AABB_segment_primitive_2<GeomTraits, Iterator, CacheDatum>`
+- `CGAL::AABB_triangle_primitive_3<GeomTraits, Iterator, CacheDatum>`
+- `CGAL::AABB_segment_primitive_3<GeomTraits, Iterator, CacheDatum>`
 - `CGAL::AABB_primitive<Id,ObjectPropertyMap,PointPropertyMap,ExternalPropertyMaps,CacheDatum>`
 - `CGAL::AABB_halfedge_graph_segment_primitive<HalfedgeGraph,Vpm,OneHalfedgeGraphPerTree,CacheDatum>`
 - `CGAL::AABB_face_graph_triangle_primitive<FaceGraph,Vpm,OneFaceGraphPerTree,CacheDatum>`

AABB_tree/doc/AABB_tree/aabb_tree.txt

@@ -3,7 +3,7 @@ namespace CGAL {
 /*!
 
 \mainpage User Manual
-\anchor Chapter_3D_Fast_Intersection_and_Distance_Computation
+\anchor Chapter_Fast_Intersection_and_Distance_Computation
 \cgalAutoToc
 
 \authors Pierre Alliez, Stephane Tayeb, and Camille Wormser

AABB_tree/include/CGAL/AABB_segment_primitive.h

@@ -1,4 +1,4 @@
-// Copyright (c) 2012 INRIA Sophia-Antipolis (France).
+// Copyright (c) 2024 INRIA Sophia-Antipolis (France).
 // All rights reserved.
 //
 // This file is part of CGAL (www.cgal.org).
@@ -11,91 +11,28 @@
 // Author(s)     : Sebastien Loriot
 //
 
-
 #ifndef CGAL_AABB_SEGMENT_PRIMITIVE_H_
 #define CGAL_AABB_SEGMENT_PRIMITIVE_H_
 
 #include <CGAL/license/AABB_tree.h>
 
-#include <CGAL/disable_warnings.h>
-
-#include <CGAL/AABB_primitive.h>
-#include <iterator>
+#define CGAL_DEPRECATED_HEADER "<CGAL/AABB_segment_primitive.h>"
+#define CGAL_REPLACEMENT_HEADER "<CGAL/AABB_segment_primitive_3.h>"
+#include <CGAL/Installation/internal/deprecation_warning.h>
 
-namespace CGAL {
+#ifndef CGAL_NO_DEPRECATED_CODE
 
-namespace internal {
-  template <class GeomTraits, class Iterator>
-  struct Source_of_segment_3_iterator_property_map{
-    //classical typedefs
-    typedef Iterator key_type;
-    typedef typename GeomTraits::Point_3 value_type;
-    // typedef decltype(
-    //   std::declval<typename GeomTraits::Construct_source_3>()(
-    //     std::declval<typename GeomTraits::Segment_3>())) reference;
-    typedef decltype(
-      typename GeomTraits::Construct_source_3()(
-        *std::declval<key_type&>())) reference;
-    typedef boost::readable_property_map_tag category;
-    typedef Source_of_segment_3_iterator_property_map<GeomTraits, Iterator> Self;
+#include <CGAL/AABB_segment_primitive_3.h>
 
-    inline friend reference
-    get(Self, key_type it)
-    {
-      return typename GeomTraits::Construct_source_3()( *it );
-    }
-  };
-}//namespace internal
+namespace CGAL{
 
-
-/*!
- * \ingroup PkgAABBTreeRef
- * Primitive type that uses as identifier an iterator with a 3D segment as `value_type`.
- * The iterator from which the primitive is built should not be invalided
- * while the AABB tree holding the primitive is in use.
- *
- * \cgalModels{AABBPrimitive}
- *
- * \tparam GeomTraits is a traits class providing the nested type `Point_3` and `Segment_3`.
- *         It also provides the functor `Construct_source_3` that has an operator taking a `Segment_3`
- *         and returning its source as a type convertible to `Point_3`.
- * \tparam Iterator is a model of `ForwardIterator` with its value type convertible to `GeomTraits::Segment_3`
- * \tparam CacheDatum is either `CGAL::Tag_true` or `CGAL::Tag_false`. In the former case,
- *           the datum is stored in the primitive, while in the latter it is
- *           constructed on the fly to reduce the memory footprint.
- *           The default is `CGAL::Tag_false` (datum is not stored).
- *
- * \sa `AABBPrimitive`
- * \sa `AABB_primitive<Id,ObjectPropertyMap,PointPropertyMapPolyhedron,ExternalPropertyMaps,CacheDatum>`
- * \sa `AABB_triangle_primitive<Iterator,CacheDatum>`
- * \sa `AABB_halfedge_graph_segment_primitive<HalfedgeGraph,OneHalfedgeGraphPerTree,CacheDatum>`
- * \sa `AABB_face_graph_triangle_primitive<FaceGraph,OneFaceGraphPerTree,CacheDatum>`
- */
 template < class GeomTraits,
            class Iterator,
            class CacheDatum=Tag_false>
-class AABB_segment_primitive
-#ifndef DOXYGEN_RUNNING
-  : public AABB_primitive<  Iterator,
-                            Input_iterator_property_map<Iterator>,
-                            internal::Source_of_segment_3_iterator_property_map<GeomTraits, Iterator>,
-                            Tag_false,
-                            CacheDatum >
-#endif
-{
-  typedef AABB_primitive< Iterator,
-                          Input_iterator_property_map<Iterator>,
-                          internal::Source_of_segment_3_iterator_property_map<GeomTraits, Iterator>,
-                          Tag_false,
-                          CacheDatum > Base;
-public:
-  ///constructor from an iterator
-  AABB_segment_primitive(Iterator it) : Base(it){}
-};
-
-}  // end namespace CGAL
+using  AABB_segment_primitive = AABB_segment_primitive_3<GeomTraits, Iterator, CacheDatum>;
 
-#include <CGAL/enable_warnings.h>
+} // CGAL namespace
 
-#endif // CGAL_AABB_SEGMENT_PRIMITIVE_H_
+#endif  // CGAL_NO_DEPRECATED_CODE
 
+#endif //CGAL_AABB_SEGMENT_PRIMITIVE_H_