songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix documentation of functor `ConstructLiftedPoint_3`

This commit is contained in:
Mael Rouxel-Labbé 2019-08-28 09:47:43 +02:00
parent 424c4e5533
commit 37aed3d31a
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h
View File

@ -4701,8 +4701,8 @@ public:
\cgalRefines `AdaptableFunctor` (with two arguments) \cgalRefines `AdaptableFunctor` (with two arguments)
\sa `CGAL::Plane_3<Kernel>` \sa `CGAL::Plane_3<Kernel>`
\sa `ConstructProjectedXYPoint_2`
*/ */
class ConstructLiftedPoint_3 { class ConstructLiftedPoint_3 {
public: public:
@ -4712,8 +4712,10 @@ public:
/// @{ /// @{
/*! /*!
returns a point `q` on plane `h`, such that the projection of returns the image point of the projection of `p`
this point onto the \f$ xy\f$-plane is `p`. under an affine transformation which maps the \f$ xy\f$-plane onto `h`.
This affine transformation must be the inverse of the affine transformation used
in `ConstructProjectedXYPoint_2`.
*/ */
Kernel::Point_3 operator()(const Kernel::Plane_3& h, Kernel::Point_3 operator()(const Kernel::Plane_3& h,
const Kernel::Point_2& p); const Kernel::Point_2& p);
@ -5999,8 +6001,8 @@ public:
\cgalRefines `AdaptableFunctor` (with two arguments) \cgalRefines `AdaptableFunctor` (with two arguments)
\sa `CGAL::Plane_3<Kernel>` \sa `CGAL::Plane_3<Kernel>`
\sa `ConstructLiftedPoint_3`
*/ */
class ConstructProjectedXYPoint_2 { class ConstructProjectedXYPoint_2 {
public: public:
@ -6012,7 +6014,9 @@ public:
/*! /*!
returns the image point of the projection of `p` under an affine returns the image point of the projection of `p` under an affine
transformation, which maps `h` onto the \f$ xy\f$-plane, with the transformation, which maps `h` onto the \f$ xy\f$-plane, with the
\f$ z\f$-coordinate removed. \f$ z\f$-coordinate removed.
This affine transformation must be the inverse of the affine transformation used
in `ConstructLiftedPoint_3`.
*/ */
Kernel::Point_2 operator()(const Kernel::Plane_3& h, Kernel::Point_2 operator()(const Kernel::Plane_3& h,
const Kernel::Point_3& p); const Kernel::Point_3& p);