diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h index 3abb0cf153b..01dc1a22922 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h @@ -28,7 +28,7 @@ public: /// @{ /*! -3D point type. +Point type. */ typedef unspecified_type Point; @@ -68,7 +68,7 @@ returns the corresponding identifier. This identifier is only used as a referenc Id id(); /*! -returns a 3D point located on the geometric object represented by the primitive. This function is used to sort the primitives during the AABB tree construction as well as to construct the search KD-tree internal to the AABB tree used to accelerate distance queries. +returns a point located on the geometric object represented by the primitive. This function is used to sort the primitives during the AABB tree construction as well as to construct the search KD-tree internal to the AABB tree used to accelerate distance queries. */ Point_reference reference_point(); diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitiveWithSharedData.h b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitiveWithSharedData.h index 416cc785468..284c90b6038 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitiveWithSharedData.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitiveWithSharedData.h @@ -34,7 +34,7 @@ public: /// \name Types /// @{ /*! -3D point type. +Point type. */ typedef unspecified_type Point; @@ -78,7 +78,7 @@ returns the corresponding identifier. This identifier is only used as a referenc Id id(); /*! -returns a 3D point located on the geometric object represented by the primitive. This function is used to sort the primitives during the AABB tree construction as well as to construct the search KD-tree internal to the AABB tree used to accelerate distance queries. +returns a point located on the geometric object represented by the primitive. This function is used to sort the primitives during the AABB tree construction as well as to construct the search KD-tree internal to the AABB tree used to accelerate distance queries. */ Point_reference reference_point(const Shared_data& data); diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h b/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h index 8fd9ef2458e..3e2f56869bd 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h @@ -44,7 +44,7 @@ Bounding box type. typedef unspecified_type Bounding_box; /*! -3D Point and Primitive Id type +Point and Primitive Id type */ typedef std::pair Point_and_primitive_id; diff --git a/AABB_tree/include/CGAL/AABB_traits_2.h b/AABB_tree/include/CGAL/AABB_traits_2.h index 480c00aa4f0..6cc94837f83 100644 --- a/AABB_tree/include/CGAL/AABB_traits_2.h +++ b/AABB_tree/include/CGAL/AABB_traits_2.h @@ -128,7 +128,7 @@ template< typename AABBTraits> class AABB_tree; -/// This traits class handles any type of 3D geometric +/// This traits class handles any type of 2D geometric /// primitives provided that the proper intersection tests and /// constructions are implemented. It handles points, rays, lines and /// segments as query types for intersection detection and @@ -165,8 +165,8 @@ class AABB_traits_2 #endif { typedef typename CGAL::Object Object; -public: typedef GeomTraits Geom_traits; +public: typedef AABB_traits_2 AT; // AABBTraits concept types @@ -200,7 +200,6 @@ public: /// point type /// typedef typename GeomTraits::Point_2 Point; - typedef typename GeomTraits::Point_2 Point_2; /// additional types for the search tree, required by the RangeSearchTraits concept /// \bug This is not documented for now in the AABBTraits concept. diff --git a/AABB_tree/include/CGAL/AABB_tree.h b/AABB_tree/include/CGAL/AABB_tree.h index 25ad05d354d..c63fdf38679 100644 --- a/AABB_tree/include/CGAL/AABB_tree.h +++ b/AABB_tree/include/CGAL/AABB_tree.h @@ -41,9 +41,9 @@ namespace CGAL { /** * Static data structure for efficient - * intersection and distance computations in 3D. It builds a + * intersection and distance computations in 2D and 3D. It builds a * hierarchy of axis-aligned bounding boxes (an AABB tree) from a set - * of 3D geometric objects, and can receive intersection and distance + * of geometric objects, and can receive intersection and distance * queries, provided that the corresponding predicates are * implemented in the traits class AABBTraits. * An instance of the class `AABBTraits` is internally stored. @@ -74,8 +74,7 @@ namespace CGAL { /// Number type returned by the distance queries. typedef typename AABBTraits::FT FT; - - /// Type of 3D point. + /// Type of point. typedef typename AABBTraits::Point Point; /// Type of input primitive. @@ -86,7 +85,7 @@ namespace CGAL { typedef typename Primitives::size_type size_type; /// Type of bounding box. typedef typename AABBTraits::Bounding_box Bounding_box; - /// 3D Point and Primitive Id type + /// Point and Primitive Id type typedef typename AABBTraits::Point_and_primitive_id Point_and_primitive_id; /// \deprecated typedef typename AABBTraits::Object_and_primitive_id Object_and_primitive_id; diff --git a/AABB_tree/include/CGAL/AABB_triangle_primitive_2.h b/AABB_tree/include/CGAL/AABB_triangle_primitive_2.h index 393d8517cff..a371ca96196 100644 --- a/AABB_tree/include/CGAL/AABB_triangle_primitive_2.h +++ b/AABB_tree/include/CGAL/AABB_triangle_primitive_2.h @@ -51,7 +51,7 @@ namespace internal { /*! * \ingroup PkgAABBTreeRef - * Primitive type that uses as identifier an iterator with a 3D triangle as `value_type`. + * Primitive type that uses as identifier an iterator with a 2D triangle 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. * diff --git a/AABB_tree/package_info/AABB_tree/description.txt b/AABB_tree/package_info/AABB_tree/description.txt index 0f6f1e2664c..4defc25a858 100644 --- a/AABB_tree/package_info/AABB_tree/description.txt +++ b/AABB_tree/package_info/AABB_tree/description.txt @@ -1 +1 @@ -Data structure for efficient intersection and distance queries over sets of 3D geometric primitives. +Data structure for efficient intersection and distance queries over sets of 2D and 3D geometric primitives. diff --git a/AABB_tree/package_info/AABB_tree/long_description.txt b/AABB_tree/package_info/AABB_tree/long_description.txt index ad49fc371b0..73985b7a90f 100644 --- a/AABB_tree/package_info/AABB_tree/long_description.txt +++ b/AABB_tree/package_info/AABB_tree/long_description.txt @@ -1 +1 @@ -This component implements a hierarchy of axis-aligned bounding boxes (a AABB tree) for efficient intersection and distance computations between 3D queries and sets of input 3D geometric objects. +This component implements a hierarchy of axis-aligned bounding boxes (a AABB tree) for efficient intersection and distance computations between 2D/3D queries and sets of input 2D/3D geometric objects.