From 38b7c42bd6cc99cb55251db15da9c0c21cf8ab3a Mon Sep 17 00:00:00 2001 From: Sylvain Pion Date: Thu, 3 Aug 2006 09:40:42 +0000 Subject: [PATCH] Document new Iso_rectangle/Iso_cuboid constructor. --- Kernel_23/doc_tex/Kernel_23_ref/Iso_cuboid_3.tex | 7 +++++++ Kernel_23/doc_tex/Kernel_23_ref/Iso_rectangle_2.tex | 9 +++++++++ .../Kernel_23_ref/Kernel_ConstructIsoCuboid_3.tex | 8 ++++++++ .../Kernel_23_ref/Kernel_ConstructIsoRectangle_2.tex | 8 ++++++++ 4 files changed, 32 insertions(+) diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Iso_cuboid_3.tex b/Kernel_23/doc_tex/Kernel_23_ref/Iso_cuboid_3.tex index 0a7459d8ed8..29bdc320472 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Iso_cuboid_3.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Iso_cuboid_3.tex @@ -29,6 +29,13 @@ the user. opposite vertices $p$ and $q$. Note that the object is brought in the canonical form.} +\ccConstructor{Iso_cuboid_3(const Point_3 &p, + const Point_3 &q, int);} + {introduces an iso-oriented cuboid \ccVar\ with diagonal + opposite vertices $p$ and $q$. The \ccc{int} argument value + is only used to distinguish the two overloaded functions. + \ccPrecond{$p.x()<=q.x()$, $p.y()<=q.y()$ and $p.z()<=q.z()$.}} + \ccConstructor{Iso_cuboid_3(const Point_3 &left, const Point_3 &right, const Point_3 &bottom, diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Iso_rectangle_2.tex b/Kernel_23/doc_tex/Kernel_23_ref/Iso_rectangle_2.tex index 3f00641f833..608f4307725 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Iso_rectangle_2.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Iso_rectangle_2.tex @@ -30,6 +30,15 @@ the user. opposite vertices $p$ and $q$. Note that the object is brought in the canonical form.} +\ccConstructor{Iso_rectangle_2(const Point_2 &p, + const Point_2 &q, + int);} + {introduces an iso-oriented rectangle \ccVar\ with diagonal + opposite vertices $p$ and $q$. The \ccc{int} argument value + is only used to distinguish the two overloaded functions. + \ccPrecond{$p.x()<=q.x()$ and $p.y()<=q.y()$.}} + + \ccConstructor{Iso_rectangle_2(const Point_2 &left, const Point_2 &right, const Point_2 &bottom, diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructIsoCuboid_3.tex b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructIsoCuboid_3.tex index 18a0415793e..dda0afc2b63 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructIsoCuboid_3.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructIsoCuboid_3.tex @@ -9,6 +9,14 @@ A model for this must provide: opposite vertices $p$ and $q$ such that $p$ is the lexicographically smallest point in the cuboid.} +\ccMemberFunction{Kernel::Iso_cuboid_3 operator()(const Kernel::Point_3 &p, + const Kernel::Point_3 &q, + int);} + {introduces an iso-oriented cuboid with diagonal + opposite vertices $p$ and $q$. The \ccc{int} argument value is + only used to distinguish the two overloaded functions. + \ccPrecond{$p.x()<=q.x()$, $p.y()<=q.y()$ and $p.z()<=q.z()$.}} + \ccMemberFunction{Kernel::Iso_cuboid_3 operator()(const Kernel::Point_3 &left, const Kernel::Point_3 &right, diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructIsoRectangle_2.tex b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructIsoRectangle_2.tex index 0057f6df6af..bba99187eb3 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructIsoRectangle_2.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructIsoRectangle_2.tex @@ -9,6 +9,14 @@ A model for this must provide: opposite vertices $p$ and $q$ such that $p$ is the lexicographically smallest point in the rectangle.} +\ccMemberFunction{Kernel::Iso_rectangle_2 operator()(const Kernel::Point_2 &p, + const Kernel::Point_2 &q, + int);} + {introduces an iso-oriented rectangle with diagonal + opposite vertices $p$ and $q$. The \ccc{int} argument value is + only used to distinguish the two overloaded functions. + \ccPrecond{$p.x()<=q.x()$ and $p.y()<=q.y()$.}} + \ccMemberFunction{Kernel::Iso_rectangle_2 operator()(const Kernel::Point_2 &left, const Kernel::Point_2 &right,