doc fix 2D/3D

This commit is contained in:
Sven Oesau 2024-03-22 16:56:26 +01:00
parent 12fab6bb09
commit 4c48945048
8 changed files with 14 additions and 16 deletions

View File

@ -28,7 +28,7 @@ public:
/// @{ /// @{
/*! /*!
3D point type. Point type.
*/ */
typedef unspecified_type Point; typedef unspecified_type Point;
@ -68,7 +68,7 @@ returns the corresponding identifier. This identifier is only used as a referenc
Id id(); 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(); Point_reference reference_point();

View File

@ -34,7 +34,7 @@ public:
/// \name Types /// \name Types
/// @{ /// @{
/*! /*!
3D point type. Point type.
*/ */
typedef unspecified_type Point; typedef unspecified_type Point;
@ -78,7 +78,7 @@ returns the corresponding identifier. This identifier is only used as a referenc
Id id(); 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); Point_reference reference_point(const Shared_data& data);

View File

@ -44,7 +44,7 @@ Bounding box type.
typedef unspecified_type Bounding_box; typedef unspecified_type Bounding_box;
/*! /*!
3D Point and Primitive Id type Point and Primitive Id type
*/ */
typedef std::pair<Point, Primitive::Id> Point_and_primitive_id; typedef std::pair<Point, Primitive::Id> Point_and_primitive_id;

View File

@ -128,7 +128,7 @@ template< typename AABBTraits>
class AABB_tree; 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 /// primitives provided that the proper intersection tests and
/// constructions are implemented. It handles points, rays, lines and /// constructions are implemented. It handles points, rays, lines and
/// segments as query types for intersection detection and /// segments as query types for intersection detection and
@ -165,8 +165,8 @@ class AABB_traits_2
#endif #endif
{ {
typedef typename CGAL::Object Object; typedef typename CGAL::Object Object;
public:
typedef GeomTraits Geom_traits; typedef GeomTraits Geom_traits;
public:
typedef AABB_traits_2<GeomTraits, AABBPrimitive, BboxMap> AT; typedef AABB_traits_2<GeomTraits, AABBPrimitive, BboxMap> AT;
// AABBTraits concept types // AABBTraits concept types
@ -200,7 +200,6 @@ public:
/// point type /// point type
/// </summary> /// </summary>
typedef typename GeomTraits::Point_2 Point; typedef typename GeomTraits::Point_2 Point;
typedef typename GeomTraits::Point_2 Point_2;
/// additional types for the search tree, required by the RangeSearchTraits concept /// additional types for the search tree, required by the RangeSearchTraits concept
/// \bug This is not documented for now in the AABBTraits concept. /// \bug This is not documented for now in the AABBTraits concept.

View File

@ -41,9 +41,9 @@ namespace CGAL {
/** /**
* Static data structure for efficient * 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 * 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 * queries, provided that the corresponding predicates are
* implemented in the traits class AABBTraits. * implemented in the traits class AABBTraits.
* An instance of the class `AABBTraits` is internally stored. * An instance of the class `AABBTraits` is internally stored.
@ -74,8 +74,7 @@ namespace CGAL {
/// Number type returned by the distance queries. /// Number type returned by the distance queries.
typedef typename AABBTraits::FT FT; typedef typename AABBTraits::FT FT;
/// Type of point.
/// Type of 3D point.
typedef typename AABBTraits::Point Point; typedef typename AABBTraits::Point Point;
/// Type of input primitive. /// Type of input primitive.
@ -86,7 +85,7 @@ namespace CGAL {
typedef typename Primitives::size_type size_type; typedef typename Primitives::size_type size_type;
/// Type of bounding box. /// Type of bounding box.
typedef typename AABBTraits::Bounding_box 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; typedef typename AABBTraits::Point_and_primitive_id Point_and_primitive_id;
/// \deprecated /// \deprecated
typedef typename AABBTraits::Object_and_primitive_id Object_and_primitive_id; typedef typename AABBTraits::Object_and_primitive_id Object_and_primitive_id;

View File

@ -51,7 +51,7 @@ namespace internal {
/*! /*!
* \ingroup PkgAABBTreeRef * \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 * The iterator from which the primitive is built should not be invalided
* while the AABB tree holding the primitive is in use. * while the AABB tree holding the primitive is in use.
* *

View File

@ -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.

View File

@ -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.