From bb2cd839a70818a7891d050d28ac39e6ec56bf0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Mon, 16 Dec 2024 17:43:42 +0100 Subject: [PATCH 1/2] Add missing overloads --- .../doc/Kernel_23/Concepts/FunctionObjectConcepts.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h b/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h index 7057cf95ccda..f367f26df4c4 100644 --- a/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h +++ b/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h @@ -8124,6 +8124,12 @@ class HasOnBoundedSide_3 { bool operator()(const Kernel::Iso_cuboid_3&c, const Kernel::Point_3&p); + /*! + returns true iff `p` lies on the bounded side of `c`. + */ + bool operator()(const Kernel::Circle_3& c, + const Kernel::Point_3& p); + /*! returns true iff the line segment `ab` is inside the union of the bounded sides of `s1` and `s2`. @@ -8386,6 +8392,11 @@ class HasOnUnboundedSide_3 { bool operator()(const Kernel::Iso_cuboid_3&c, const Kernel::Point_3&p); + /*! + returns true iff `p` lies on the unbounded side of `c`. + */ + bool operator()(const Kernel::Circle_3&c, + const Kernel::Point_3&p); /// @} From de214f488cc92980b63e6b789723fdd6a70326dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Mon, 16 Dec 2024 17:44:06 +0100 Subject: [PATCH 2/2] Add / Fix \sa links to functors for CGAL kernel objects --- .../doc/Kernel_23/Concepts/GeomObjects.h | 51 +++++++++++++++---- 1 file changed, 42 insertions(+), 9 deletions(-) diff --git a/Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h b/Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h index 57ad06016b8e..e85d5b723bcb 100644 --- a/Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h +++ b/Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h @@ -56,6 +56,8 @@ class Circle_2 { \sa `Kernel::ConstructPlane_3` \sa `Kernel::Equal_3` \sa `Kernel::HasOn_3` + \sa `Kernel::HasOnBoundedSide_3` + \sa `Kernel::HasOnUnboundedSide_3` \sa `Kernel::IsDegenerate_3` */ @@ -81,6 +83,7 @@ class Circle_3 { \sa `Kernel::ConstructDirection_2` \sa `Kernel::ConstructOppositeDirection_2` \sa `Kernel::ConstructPerpendicularDirection_2` + \sa `Kernel::ConstructRay_2` \sa `Kernel::CounterclockwiseInBetween_2` \sa `Kernel::Equal_2` @@ -101,9 +104,12 @@ class Direction_2 { \cgalHasModels{CGAL::Direction_3} \cgalHasModelsEnd + \sa `Kernel::ConstructCircle_3` \sa `Kernel::ConstructDirection_3` \sa `Kernel::ConstructOppositeDirection_3` - \sa `Kernel::Equal_2` + \sa `Kernel::ConstructPlane_3` + \sa `Kernel::ConstructRay_3` + \sa `Kernel::Equal_3` */ class Direction_3 { @@ -125,9 +131,17 @@ A type representing isocuboids in three dimensions. \sa `Kernel::BoundedSide_3` \sa `Kernel::ComputeVolume_3` +\sa `Kernel::ComputeXmax_3` +\sa `Kernel::ComputeXmin_3` +\sa `Kernel::ComputeYmax_3` +\sa `Kernel::ComputeYmin_3` +\sa `Kernel::ComputeZmax_3` +\sa `Kernel::ComputeZmin_3` \sa `Kernel::ConstructIsoCuboid_3` +\sa `Kernel::ConstructMaxVertex_3` +\sa `Kernel::ConstructMinVertex_3` \sa `Kernel::ConstructVertex_3` -\sa `Kernel::Equal_2` +\sa `Kernel::Equal_3` \sa `Kernel::HasOnBoundary_3` \sa `Kernel::HasOnBoundedSide_3` \sa `Kernel::HasOnUnboundedSide_3` @@ -151,13 +165,15 @@ class IsoCuboid_3 { \cgalHasModelsEnd \sa `Kernel::ConstructIsoRectangle_2` - \sa `Kernel::ComputeXmin_2` \sa `Kernel::ComputeXmax_2` - \sa `Kernel::ComputeYmin_2` + \sa `Kernel::ComputeXmin_2` \sa `Kernel::ComputeYmax_2` + \sa `Kernel::ComputeYmin_2` \sa `Kernel::BoundedSide_2` \sa `Kernel::ComputeArea_2` \sa `Kernel::ConstructIsoRectangle_2` + \sa `Kernel::ConstructMaxVertex_2` + \sa `Kernel::ConstructMinVertex_2` \sa `Kernel::ConstructVertex_2` \sa `Kernel::DoIntersect_2` \sa `Kernel::Equal_2` @@ -185,8 +201,11 @@ class IsoRectangle_2 { \cgalHasModelsEnd \sa `Kernel::CompareXAtY_2` - \sa `Kernel::ComputeSquaredDistance_2` \sa `Kernel::CompareYAtX_2` + \sa `Kernel::ComputeA_2` + \sa `Kernel::ComputeB_2` + \sa `Kernel::ComputeC_2` + \sa `Kernel::ComputeSquaredDistance_2` \sa `Kernel::ConstructBisector_2` \sa `Kernel::ConstructDirection_2` \sa `Kernel::ConstructLine_2` @@ -194,6 +213,7 @@ class IsoRectangle_2 { \sa `Kernel::ConstructPerpendicularLine_2` \sa `Kernel::ConstructPointOn_2` \sa `Kernel::ConstructProjectedPoint_2` + \sa `Kernel::ConstructRay_2` \sa `Kernel::DoIntersect_2` \sa `Kernel::Equal_2` \sa `Kernel::HasOnNegativeSide_2` @@ -222,6 +242,7 @@ class Line_2 { \cgalHasModels{CGAL::Line_3} \cgalHasModelsEnd + \sa `Kernel::AreParallel_3` \sa `Kernel::ComputeSquaredDistance_3` \sa `Kernel::ConstructDirection_3` \sa `Kernel::ConstructLine_3` @@ -230,6 +251,7 @@ class Line_2 { \sa `Kernel::ConstructPlane_3` \sa `Kernel::ConstructPointOn_3` \sa `Kernel::ConstructProjectedPoint_3` + \sa `Kernel::ConstructRay_3` \sa `Kernel::DoIntersect_3` \sa `Kernel::Equal_3` \sa `Kernel::HasOn_3` @@ -299,18 +321,23 @@ class Object_3 { \cgalHasModels{CGAL::Plane_3} \cgalHasModelsEnd + \sa `Kernel::AreParallel_3` \sa `Kernel::ComputeSquaredDistance_3` \sa `Kernel::ConstructBaseVector_3` \sa `Kernel::ConstructBisector_3` + \sa `Kernel::ConstructCircle_3` \sa `Kernel::ConstructLiftedPoint_3` \sa `Kernel::ConstructOppositePlane_3` \sa `Kernel::ConstructOrthogonalVector_3` + \sa `Kernel::ConstructProjectedXYPoint_2` \sa `Kernel::ConstructPerpendicularLine_3` \sa `Kernel::ConstructPerpendicularPlane_3` \sa `Kernel::ConstructPlane_3` \sa `Kernel::ConstructPointOn_3` \sa `Kernel::ConstructProjectedPoint_3` \sa `Kernel::ConstructProjectedXYPoint_2` + \sa `Kernel::ConstructRadicalPlane_3` + \sa `Kernel::ConstructSupportingPlane_3` \sa `Kernel::DoIntersect_3` \sa `Kernel::Equal_3` \sa `Kernel::HasOnNegativeSide_3` @@ -365,6 +392,7 @@ class Plane_3 { \sa `Kernel::ConstructPoint_2` \sa `Kernel::ConstructProjectedPoint_2` \sa `Kernel::ConstructProjectedXYPoint_2` + \sa `Kernel::ConstructRay_2` \sa `Kernel::ConstructTranslatedPoint_2` \sa `Kernel::DoIntersect_2` \sa `Kernel::Equal_2` @@ -425,6 +453,7 @@ class Point_2 { \sa `Kernel::ConstructPointOn_3` \sa `Kernel::ConstructPoint_3` \sa `Kernel::ConstructProjectedPoint_3` + \sa `Kernel::ConstructRay_3` \sa `Kernel::ConstructTranslatedPoint_3` \sa `Kernel::CoplanarOrientation_3` \sa `Kernel::CoplanarSideOfBoundedCircle_3` @@ -496,6 +525,7 @@ class Ray_2 { \cgalHasModels{CGAL::Ray_3} \cgalHasModelsEnd + \sa `Kernel::AreParallel_3` \sa `Kernel::ComputeSquaredDistance_3` \sa `Kernel::ConstructDirection_3` \sa `Kernel::ConstructLine_3` @@ -562,6 +592,7 @@ class Segment_2 { \cgalHasModels{CGAL::Segment_3} \cgalHasModelsEnd + \sa `Kernel::AreParallel_3` \sa `Kernel::ComputeSquaredDistance_3` \sa `Kernel::ComputeSquaredLength_3` \sa `Kernel::ConstructDirection_3` @@ -600,7 +631,7 @@ class Segment_3 { \sa `Kernel::ConstructOppositeSphere_3` \sa `Kernel::ConstructRadicalPlane_3` \sa `Kernel::ConstructSphere_3` - \sa `Kernel::Equal_2` + \sa `Kernel::Equal_3` \sa `Kernel::HasOnBoundary_3` \sa `Kernel::HasOnBoundedSide_3` \sa `Kernel::HasOnNegativeSide_3` @@ -631,7 +662,7 @@ class Sphere_3 { \sa `Kernel::ConstructCentroid_3` \sa `Kernel::ConstructTetrahedron_3` \sa `Kernel::ConstructVertex_3` - \sa `Kernel::Equal_2` + \sa `Kernel::Equal_3` \sa `Kernel::HasOnBoundary_3` \sa `Kernel::HasOnBoundedSide_3` \sa `Kernel::HasOnNegativeSide_3` @@ -735,6 +766,7 @@ class Triangle_3 { \sa `Kernel::ConstructDividedVector_2` \sa `Kernel::ConstructSumOfVectors_2` \sa `Kernel::ConstructDifferenceOfVectors_2` + \sa `Kernel::ConstructRay_2` \sa `Kernel::ConstructVector_2` \sa `Kernel::Equal_2` \sa `Kernel::Orientation_2` @@ -764,13 +796,14 @@ A type representing vectors in three dimensions. \sa `Kernel::ComputeY_3` \sa `Kernel::ComputeZ_3` \sa `Kernel::ConstructCrossProductVector_3` +\sa `Kernel::ConstructDifferenceOfVectors_3` \sa `Kernel::ConstructDirection_3` +\sa `Kernel::ConstructDividedVector_3` \sa `Kernel::ConstructOppositeVector_3` \sa `Kernel::ConstructOrthogonalVector_3` +\sa `Kernel::ConstructRay_3` \sa `Kernel::ConstructScaledVector_3` -\sa `Kernel::ConstructDividedVector_3` \sa `Kernel::ConstructSumOfVectors_3` -\sa `Kernel::ConstructDifferenceOfVectors_3` \sa `Kernel::ConstructVector_3` \sa `Kernel::Equal_3` \sa `Kernel::Orientation_3`