Skip to content

Commit

Permalink
Add missing kernel functor overloads + cleaning (#8660)
Browse files Browse the repository at this point in the history
## Release Management

* Affected package(s): `Kernel_23`
* Issue(s) solved (if any): -
* Feature/Small Feature (if any): -
* License and copyright ownership: no change
  • Loading branch information
sloriot authored Dec 23, 2024
2 parents b145d1c + de214f4 commit 0799b97
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 9 deletions.
11 changes: 11 additions & 0 deletions Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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);

/// @}

Expand Down
51 changes: 42 additions & 9 deletions Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h
Original file line number Diff line number Diff line change
Expand Up @@ -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`
*/
Expand All @@ -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`
Expand All @@ -101,9 +104,12 @@ class Direction_2 {
\cgalHasModels{CGAL::Direction_3<Kernel>}
\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 {
Expand All @@ -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`
Expand All @@ -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`
Expand Down Expand Up @@ -185,15 +201,19 @@ 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`
\sa `Kernel::ConstructOppositeLine_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`
Expand Down Expand Up @@ -222,6 +242,7 @@ class Line_2 {
\cgalHasModels{CGAL::Line_3<Kernel>}
\cgalHasModelsEnd
\sa `Kernel::AreParallel_3`
\sa `Kernel::ComputeSquaredDistance_3`
\sa `Kernel::ConstructDirection_3`
\sa `Kernel::ConstructLine_3`
Expand All @@ -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`
Expand Down Expand Up @@ -299,18 +321,23 @@ class Object_3 {
\cgalHasModels{CGAL::Plane_3<Kernel>}
\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`
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -496,6 +525,7 @@ class Ray_2 {
\cgalHasModels{CGAL::Ray_3<Kernel>}
\cgalHasModelsEnd
\sa `Kernel::AreParallel_3`
\sa `Kernel::ComputeSquaredDistance_3`
\sa `Kernel::ConstructDirection_3`
\sa `Kernel::ConstructLine_3`
Expand Down Expand Up @@ -562,6 +592,7 @@ class Segment_2 {
\cgalHasModels{CGAL::Segment_3<Kernel>}
\cgalHasModelsEnd
\sa `Kernel::AreParallel_3`
\sa `Kernel::ComputeSquaredDistance_3`
\sa `Kernel::ComputeSquaredLength_3`
\sa `Kernel::ConstructDirection_3`
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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`
Expand Down

0 comments on commit 0799b97

Please sign in to comment.