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

Deprecating of Object concept, documentation

This commit is contained in:
Philipp Möller 2011-08-25 16:11:47 +00:00
parent a1576670e3
commit a79bcb9e57
10 changed files with 39 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Kernel_23/doc_tex/Kernel_23_ref/Intersection_traits.tex
View File

@ -1,4 +1,4 @@
\begin{ccRefClass}{Intersection_traits<Kernel, A<Kernel>, B<Kernel>}
\begin{ccRefClass}{Intersection_traits<Kernel, A<Kernel>, B<Kernel>>}
\ccInclude{CGAL/Intersection_traits.h}
@ -11,8 +11,12 @@ in the \ccc{intersection} documentation of the corresponding kernel.
For convenience the alias \ccStyle{IT} is provided.
A list of all available specializations can be found in \ccRefIdfierPage{CGAL::intersection}.
\ccTypes
\ccStyle{result_type} The type of the resulting intersection between \ccStyle{A} and \ccStyle{B}.
\end{ccRefClass}
\ccSeeAlso
\ccRefIdfierPage{CGAL::intersection}

5
Kernel_23/doc_tex/Kernel_23_ref/Kernel_Assign_2.tex
View File

@ -1,6 +1,8 @@
\begin{ccRefFunctionObjectConcept}{Kernel::Assign_2}
A model for this must provide:
\begin{ccDeprecated}
{\em Note} : this concept is deprecated since CGAL VERSION HERE and type safe ways should be preferred.
A model for this must provide:
\ccCreationVariable{fo}
\ccMemberFunction{
@ -19,4 +21,5 @@ Returns \ccc{true}, if the assignment was possible.}
\ccRefConceptPage{Kernel::Object_2} \\
\ccRefConceptPage{Kernel::Intersect_2} \\
\end{ccDeprecated}
\end{ccRefFunctionObjectConcept}

4
Kernel_23/doc_tex/Kernel_23_ref/Kernel_Assign_3.tex
View File

@ -1,4 +1,7 @@
\begin{ccRefFunctionObjectConcept}{Kernel::Assign_3}
\begin{ccDeprecated}
{\em Note} : this concept is deprecated since CGAL VERSION HERE and type safe ways should be preferred.
A model for this must provide:
\ccCreationVariable{fo}
@ -19,4 +22,5 @@ Returns \ccc{true}, if the assignment was possible.}
\ccRefConceptPage{Kernel::Object_3} \\
\ccRefConceptPage{Kernel::Intersect_3} \\
\end{ccDeprecated}
\end{ccRefFunctionObjectConcept}

5
Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructObject_2.tex
View File

@ -1,4 +1,7 @@
\begin{ccRefFunctionObjectConcept}{Kernel::ConstructObject_2}
\begin{ccDeprecated}
{\em Note} : this concept is deprecated since CGAL VERSION HERE and type safe ways should be preferred.
A model for this must provide:
\ccCreationVariable{fo}
@ -18,5 +21,5 @@ Object_2 operator()(const T& t);}
\ccRefConceptPage{Kernel::Assign_3} \\
\ccRefConceptPage{Kernel::Object_2} \\
\ccRefConceptPage{Kernel::Object_3} \\
\end{ccDeprecated}
\end{ccRefFunctionObjectConcept}

5
Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructObject_3.tex
View File

@ -1,4 +1,7 @@
\begin{ccRefFunctionObjectConcept}{Kernel::ConstructObject_3}
\begin{ccDeprecated}
{\em Note} : this concept is deprecated since CGAL VERSION HERE and type safe ways should be preferred.
A model for this must provide:
\ccCreationVariable{fo}
@ -18,5 +21,5 @@ Object_3 operator()(const T& t);}
\ccRefConceptPage{Kernel::Assign_3} \\
\ccRefConceptPage{Kernel::Object_2} \\
\ccRefConceptPage{Kernel::Object_3} \\
\end{ccDeprecated}
\end{ccRefFunctionObjectConcept}

15
Kernel_23/doc_tex/Kernel_23_ref/Kernel_Intersect_2.tex
View File

@ -3,20 +3,13 @@ A model for this must provide
\ccCreationVariable{fo}
\ccMemberFunction{Kernel::Object_2 operator()(Type1 obj1, Type2 obj2);}
\ccMemberFunction{Intersection_traits<K, Type1<K>, Type2<K>>::result_type operator()(Type1 obj1, Type2 obj2);}
{computes the \ccHtmlNoLinksFrom{intersection} region of two geometrical objects of type
\ccStyle{Type1} and \ccStyle{Type2}}
for all pairs \ccStyle{Type1} and \ccStyle{Type2}, where
the types \ccStyle{Type1} and \ccStyle{Type2} can be any of the
following:
\begin{itemize}\ccTexHtml{\itemsep0pt\topsep0pt\partopsep0pt\parskip0pt\parsep0pt}{}
\item \ccStyle{Kernel::Line_2}
\item \ccStyle{Kernel::Ray_2}
\item \ccStyle{Kernel::Segment_2}
\item \ccStyle{Kernel::Triangle_2}
\item \ccStyle{Kernel::Iso_rectangle_2}
\end{itemize}
The function is only defined for \ccStyle{Type} and \ccStyle{Type2}
when \ccStyle{Intersection_traits<Kernel, Kernel::Type1,
Kernel::Type2>::result_type} is also defined.
\ccRefines
\ccc{AdaptableFunctor} (with two arguments)

39
Kernel_23/doc_tex/Kernel_23_ref/Kernel_Intersect_3.tex
View File

@ -3,48 +3,19 @@ A model for this must provide
\ccCreationVariable{fo}
\ccMemberFunction{Kernel::Object_3 operator()(Type1 obj1, Type2 obj2);}
\ccMemberFunction{Intersection_traits<K, Type1<K>, Type2<K>>::result_type operator()(Type1 obj1, Type2 obj2);}
{computes the \ccHtmlNoLinksFrom{intersection} region of two geometrical
objects of type \ccStyle{Type1} and \ccStyle{Type2}}
for all pairs \ccStyle{Type1} and \ccStyle{Type2}, where
the types \ccStyle{Type1} and
\ccStyle{Type2} can be any of the following:
\begin{itemize}\ccTexHtml{\itemsep0pt\topsep0pt\partopsep0pt\parskip0pt\parsep0pt}{}
\item \ccStyle{Kernel::Plane_3}
\item \ccStyle{Kernel::Line_3}
\item \ccStyle{Kernel::Ray_3}
\item \ccStyle{Kernel::Segment_3}
\item \ccStyle{Kernel::Triangle_3}
\end{itemize}
\ccMemberFunction{Kernel::Object_3 operator()(Kernel::Sphere_3 s1,
Kernel::Sphere_3 s2);}
{computes the \ccHtmlNoLinksFrom{intersection} of two spheres. The result
can be either a \ccc{Kernel::Point_3}, a \ccc{Kernel::Circle_3}, a
\ccc{Kernel::Sphere_3} or empty.}
\ccMemberFunction{Kernel::Object_3 operator()(Kernel::Plane_3 p,
Kernel::Sphere_3 s);}
{computes the \ccHtmlNoLinksFrom{intersection} of a plane and a sphere. The result
can be either a \ccc{Kernel::Point_3}, a \ccc{Kernel::Circle_3} or empty.}
\ccMemberFunction{Kernel::Object_3 operator()(Kernel::Sphere_3 s,
Kernel::Plane_3 p);}
{computes the \ccHtmlNoLinksFrom{intersection} of a plane and a sphere. The result
can be either a \ccc{Kernel::Point_3}, a \ccc{Kernel::Circle_3} or empty.}
\ccMemberFunction{Kernel::Object_3 operator()(Kernel::Plane_3 pl1,
Kernel::Plane_3 pl2,
Kernel::Plane_3 pl3);}
{computes the \ccHtmlNoLinksFrom{intersection} of three planes. The result
can be either a \ccc{Kernel::Point_3}, a \ccc{Kernel::Line_3}, a
\ccc{Kernel::Plane_3}, or empty.}
The function is only defined for \ccStyle{Type} and \ccStyle{Type2}
when \ccStyle{Intersection_traits<Kernel, Kernel::Type1,
Kernel::Type2>::result_type} is also defined.
\ccRefines
\ccc{AdaptableFunctor} (with two or three arguments)
\ccSeeAlso
\ccRefIdfierPage{CGAL::intersection}\\
\ccRefIdfierPage{CGAL::Intersection_traits<K, A<K>, B<K>>}\\
\end{ccRefFunctionObjectConcept}

5
Kernel_23/doc_tex/Kernel_23_ref/Kernel_Object_2.tex
View File

@ -1,4 +1,7 @@
\begin{ccRefConcept}{Kernel::Object_2}
\begin{ccDeprecated}
{\em Note} : this concept is deprecated since CGAL VERSION HERE and type safe ways should be preferred.
A type representing different types of objects in two dimensions.
\ccRefines
@ -9,5 +12,5 @@ CopyConstructible, Assignable, DefaultConstructible
\ccRefConceptPage{Kernel::Assign_2}\\
\ccRefConceptPage{Kernel::ConstructObject_2} \\
\ccRefConceptPage{Kernel::Intersect_2} \\
\end{ccDeprecated}
\end{ccRefConcept}

4
Kernel_23/doc_tex/Kernel_23_ref/Kernel_Object_3.tex
View File

@ -1,4 +1,7 @@
\begin{ccRefConcept}{Kernel::Object_3}
\begin{ccDeprecated}
{\em Note} : this concept is deprecated since CGAL VERSION HERE and type safe ways should be preferred.
A type representing different types of objects in three dimensions.
\ccRefines
@ -10,4 +13,5 @@ CopyConstructible, Assignable, DefaultConstructible
\ccRefConceptPage{Kernel::ConstructObject_3} \\
\ccRefConceptPage{Kernel::Intersect_3} \\
\end{ccDeprecated}
\end{ccRefConcept}

2
Kernel_23/doc_tex/Kernel_23_ref/intersection.tex
View File

@ -658,7 +658,7 @@ and~\ref{chapter-spherical-kernel}.
\ccSeeAlso
\ccRefIdfierPage{CGAL::do_intersect}, \\
\ccRefIdfierPage{CGAL::Intersection_traits<Kernel, A<Kernel>, B<Kernel>}, \\
\ccRefIdfierPage{CGAL::Intersection_traits< Kernel, A<Kernel>, B<Kernel> >}, \\
\ccAnchor{www.boost.org/doc/libs/release/libs/optional/index.html}{boost::optional}, \\
\ccAnchor{www.boost.org/doc/html/variant.html}{boost::variant}