From ec96a19052c8e315bb8f4d4aa5b5619b4485202c Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Wed, 7 Sep 2016 15:29:13 +0200 Subject: [PATCH] fix links --- .../Concepts/FunctionObjectConcepts.h | 361 +++++++++--------- Kernel_23/doc/Kernel_23/Concepts/Kernel.h | 13 +- 2 files changed, 192 insertions(+), 182 deletions(-) diff --git a/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h b/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h index 327c04a4166..b922bd28d96 100644 --- a/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h +++ b/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h @@ -8705,6 +8705,189 @@ public: }; /* end Kernel::LessZ_3 */ + +/*! + \ingroup PkgKernel23ConceptsFunctionObjects + \cgalConcept + + \cgalRefines `AdaptableFunctor` (with three arguments) + + \sa `orientation_grp` + +*/ +class Orientation_2 { +public: + + /// \name Operations + /// A model of this concept must provide: + /// @{ + + /*! + returns \ref CGAL::LEFT_TURN, if `r` lies to the left of the oriented + line `l` defined by `p` and `q`, returns \ref CGAL::RIGHT_TURN if `r` + lies to the right of `l`, and returns \ref CGAL::COLLINEAR if `r` lies + on `l`. + */ + Orientation operator()(const Kernel::Point_2&p, + const Kernel::Point_2&q, + const Kernel::Point_2&r); + + /*! + returns \ref CGAL::LEFT_TURN if `u` and `v` form a left turn, + returns \ref CGAL::RIGHT_TURN if `u` and `v` form a right turn, + and returns \ref CGAL::COLLINEAR if `u` and `v` are collinear. + */ + Orientation operator()(const Kernel::Vector_2&u, + const Kernel::Vector_2&v); + + + /// @} + +}; /* end Kernel::Orientation_2 */ + +/*! + \ingroup PkgKernel23ConceptsFunctionObjects + \cgalConcept + + \cgalRefines `AdaptableFunctor` (with four arguments) + + \sa `orientation_grp` + +*/ +class Orientation_3 { +public: + + /// \name Operations + /// A model of this concept must provide: + /// @{ + + /*! + returns \ref CGAL::POSITIVE, if `s` lies on the positive side of the oriented + plane `h` defined by `p`, `q`, and `r`, returns \ref CGAL::NEGATIVE if `s` + lies on the negative side of `h`, and returns \ref CGAL::COPLANAR if `s` lies + on `h`. + */ + Orientation operator()(const Kernel::Point_3&p, + const Kernel::Point_3&q, + const Kernel::Point_3&r, + const Kernel::Point_3&s); + + /*! + returns \ref CGAL::POSITIVE if `u`, `v` and `w` are positively oriented, + returns \ref CGAL::NEGATIVE if `u`, `v` and `w` are negatively oriented, + and returns \ref CGAL::COPLANAR if `u`, `v` and `w` are coplanar. + */ + Orientation operator()(const Kernel::Vector_3&u, + const Kernel::Vector_3&v, + const Kernel::Vector_3&w); + + /*! + returns the orientation of the sphere `s`. + */ + Orientation operator()(const Kernel::Sphere_3&s); + + + /// @} + +}; /* end Kernel::Orientation_3 */ + +/*! + \ingroup PkgKernel23ConceptsFunctionObjects + \cgalConcept + + \cgalRefines `AdaptableFunctor` (with two arguments) + + \sa `CGAL::Circle_2` + \sa `CGAL::Line_2` + \sa `CGAL::Triangle_2` + +*/ +class OrientedSide_2 { +public: + + /// \name Operations + /// A model of this concept must provide: + /// @{ + + + /*! + returns \ref CGAL::ON_ORIENTED_BOUNDARY, + \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, + depending on the position of `p` relative to the oriented circle `c`. + */ + Oriented_side operator()(const Kernel::Circle_2&c, + const Kernel::Point_2&p); + + /*! + returns \ref CGAL::ON_ORIENTED_BOUNDARY, + \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, + depending on the position of `p` relative to the oriented line `l`. + */ + Oriented_side operator()(const Kernel::Line_2&l, + const Kernel::Point_2&p); + + /*! + returns \ref CGAL::ON_ORIENTED_BOUNDARY, + \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, + depending on the position of `p` relative to the oriented triangle `t`. + */ + Oriented_side operator()(const Kernel::Triangle_2&t, + const Kernel::Point_2&p); + + /// @} + +}; /* end Kernel::OrientedSide_2 */ + +/*! + \ingroup PkgKernel23ConceptsFunctionObjects + \cgalConcept + + \cgalRefines `AdaptableFunctor` (with two arguments) + + \sa `CGAL::Plane_3` + \sa `CGAL::Sphere_3` + \sa `CGAL::Tetrahedron_3` + +*/ +class OrientedSide_3 { +public: + + /// \name Operations + /// A model of this concept must provide: + /// @{ + + /*! + returns \ref CGAL::ON_ORIENTED_BOUNDARY, + \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, + depending on the position of `p` relative to the oriented plane `h`. + */ + Oriented_side operator()(const Kernel::Plane_3&h, + const Kernel::Point_3&p); + + /*! + returns \ref CGAL::ON_ORIENTED_BOUNDARY, + \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, + depending on the position of `p` relative to the oriented tetrahedron `t`. + */ + Oriented_side operator()(const Kernel::Tetrahedron_3&t, + const Kernel::Point_3&p); + + /*! + returns \ref CGAL::ON_ORIENTED_BOUNDARY, + \ref CGAL::ON_NEGATIVE_SIDE, or the \ref CGAL::ON_POSITIVE_SIDE, + depending on the position of `p` relative to the oriented sphere `s`. + */ + Oriented_side operator()(const Kernel::Sphere_3& s, + const Kernel::Point_3& p); + + + /// @} + +}; /* end Kernel::OrientedSide_3 */ + + + + /*! \ingroup PkgKernel23ConceptsFunctionObjects \cgalConcept @@ -8916,184 +9099,6 @@ If all the points have a weight equal to 0, then }; -/*! - \ingroup PkgKernel23ConceptsFunctionObjects - \cgalConcept - - \cgalRefines `AdaptableFunctor` (with three arguments) - - \sa `orientation_grp` - -*/ -class Orientation_2 { -public: - - /// \name Operations - /// A model of this concept must provide: - /// @{ - - /*! - returns \ref CGAL::LEFT_TURN, if `r` lies to the left of the oriented - line `l` defined by `p` and `q`, returns \ref CGAL::RIGHT_TURN if `r` - lies to the right of `l`, and returns \ref CGAL::COLLINEAR if `r` lies - on `l`. - */ - Orientation operator()(const Kernel::Point_2&p, - const Kernel::Point_2&q, - const Kernel::Point_2&r); - - /*! - returns \ref CGAL::LEFT_TURN if `u` and `v` form a left turn, - returns \ref CGAL::RIGHT_TURN if `u` and `v` form a right turn, - and returns \ref CGAL::COLLINEAR if `u` and `v` are collinear. - */ - Orientation operator()(const Kernel::Vector_2&u, - const Kernel::Vector_2&v); - - - /// @} - -}; /* end Kernel::Orientation_2 */ - -/*! - \ingroup PkgKernel23ConceptsFunctionObjects - \cgalConcept - - \cgalRefines `AdaptableFunctor` (with four arguments) - - \sa `orientation_grp` - -*/ -class Orientation_3 { -public: - - /// \name Operations - /// A model of this concept must provide: - /// @{ - - /*! - returns \ref CGAL::POSITIVE, if `s` lies on the positive side of the oriented - plane `h` defined by `p`, `q`, and `r`, returns \ref CGAL::NEGATIVE if `s` - lies on the negative side of `h`, and returns \ref CGAL::COPLANAR if `s` lies - on `h`. - */ - Orientation operator()(const Kernel::Point_3&p, - const Kernel::Point_3&q, - const Kernel::Point_3&r, - const Kernel::Point_3&s); - - /*! - returns \ref CGAL::POSITIVE if `u`, `v` and `w` are positively oriented, - returns \ref CGAL::NEGATIVE if `u`, `v` and `w` are negatively oriented, - and returns \ref CGAL::COPLANAR if `u`, `v` and `w` are coplanar. - */ - Orientation operator()(const Kernel::Vector_3&u, - const Kernel::Vector_3&v, - const Kernel::Vector_3&w); - - /*! - returns the orientation of the sphere `s`. - */ - Orientation operator()(const Kernel::Sphere_3&s); - - - /// @} - -}; /* end Kernel::Orientation_3 */ - -/*! - \ingroup PkgKernel23ConceptsFunctionObjects - \cgalConcept - - \cgalRefines `AdaptableFunctor` (with two arguments) - - \sa `CGAL::Circle_2` - \sa `CGAL::Line_2` - \sa `CGAL::Triangle_2` - -*/ -class OrientedSide_2 { -public: - - /// \name Operations - /// A model of this concept must provide: - /// @{ - - - /*! - returns \ref CGAL::ON_ORIENTED_BOUNDARY, - \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, - depending on the position of `p` relative to the oriented circle `c`. - */ - Oriented_side operator()(const Kernel::Circle_2&c, - const Kernel::Point_2&p); - - /*! - returns \ref CGAL::ON_ORIENTED_BOUNDARY, - \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, - depending on the position of `p` relative to the oriented line `l`. - */ - Oriented_side operator()(const Kernel::Line_2&l, - const Kernel::Point_2&p); - - /*! - returns \ref CGAL::ON_ORIENTED_BOUNDARY, - \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, - depending on the position of `p` relative to the oriented triangle `t`. - */ - Oriented_side operator()(const Kernel::Triangle_2&t, - const Kernel::Point_2&p); - - /// @} - -}; /* end Kernel::OrientedSide_2 */ - -/*! - \ingroup PkgKernel23ConceptsFunctionObjects - \cgalConcept - - \cgalRefines `AdaptableFunctor` (with two arguments) - - \sa `CGAL::Plane_3` - \sa `CGAL::Sphere_3` - \sa `CGAL::Tetrahedron_3` - -*/ -class OrientedSide_3 { -public: - - /// \name Operations - /// A model of this concept must provide: - /// @{ - - /*! - returns \ref CGAL::ON_ORIENTED_BOUNDARY, - \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, - depending on the position of `p` relative to the oriented plane `h`. - */ - Oriented_side operator()(const Kernel::Plane_3&h, - const Kernel::Point_3&p); - - /*! - returns \ref CGAL::ON_ORIENTED_BOUNDARY, - \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, - depending on the position of `p` relative to the oriented tetrahedron `t`. - */ - Oriented_side operator()(const Kernel::Tetrahedron_3&t, - const Kernel::Point_3&p); - - /*! - returns \ref CGAL::ON_ORIENTED_BOUNDARY, - \ref CGAL::ON_NEGATIVE_SIDE, or the \ref CGAL::ON_POSITIVE_SIDE, - depending on the position of `p` relative to the oriented sphere `s`. - */ - Oriented_side operator()(const Kernel::Sphere_3& s, - const Kernel::Point_3& p); - - - /// @} - -}; /* end Kernel::OrientedSide_3 */ /*! \ingroup PkgKernel23ConceptsFunctionObjects diff --git a/Kernel_23/doc/Kernel_23/Concepts/Kernel.h b/Kernel_23/doc/Kernel_23/Concepts/Kernel.h index e4281211604..cabc7cea9cf 100644 --- a/Kernel_23/doc/Kernel_23/Concepts/Kernel.h +++ b/Kernel_23/doc/Kernel_23/Concepts/Kernel.h @@ -673,9 +673,9 @@ public: typedef unspecified_type Side_of_bounded_circle_2; /*! - a model of `Kernel::PowerSideOfPowerCircle_2` + a model of `Kernel::PowerSideOfOrientedPowerCircle_2` */ - typedef unspecified_type Power_side_of_power_circle_2; + typedef unspecified_type Power_side_of_oriented_power_circle_2; /*! a model of `Kernel::IsHorizontal_2` @@ -1459,9 +1459,14 @@ public: typedef unspecified_type Side_of_bounded_sphere_3; /*! - a model of `Kernel::PowerSideOfPowerSphere_3` + a model of `Kernel::PowerSideOfOrientedPowerSphere_3` */ - typedef unspecified_type Power_side_of_power_sphere_3; + typedef unspecified_type Power_side_of_oriented_power_sphere_3; + + /*! + a model of `Kernel::PowerSideOfBoundedPowerSphere_3` + */ + typedef unspecified_type Power_side_of_bounded_power_sphere_3; /*! a model of `Kernel::IsDegenerate_3`