diff --git a/Circular_kernel_3/doc_tex/Spherical_kernel_3_ref/GeomFunctorsOtherPredicates.tex b/Circular_kernel_3/doc_tex/Spherical_kernel_3_ref/GeomFunctorsOtherPredicates.tex new file mode 100644 index 00000000000..4fc5d58f8c9 --- /dev/null +++ b/Circular_kernel_3/doc_tex/Spherical_kernel_3_ref/GeomFunctorsOtherPredicates.tex @@ -0,0 +1,55 @@ +\begin{ccRefFunctionObjectConcept}{SphericalKernel::HasOn_3} + +\ccCreationVariable{fo} + +An object \ccVar\ of this type must provide: + +\ccMemberFunction{bool + operator()(const Type1 &obj1, const Type2 &obj2);} +{Returns \ccc{true} when \ccc{obj1} contains \ccc{obj2},} + +where \ccc{Type_1} and \ccc{Type_2} can be respectively: + +\begin{itemize} +\item {} + \begin{itemize} + \item {} \ccc{SphericalKernel::Sphere_3}, + \item {} \ccc{SphericalKernel::Plane_3}, + \item {} \ccc{SphericalKernel::Line_3}, + \item {} \ccc{SphericalKernel::Circle_3}, + \item {} \ccc{SphericalKernel::Line_arc_3} or + \item {} \ccc{SphericalKernel::Circular_arc_3} + \end{itemize} +and \ccc{SphericalKernel::Circular_arc_point_3} +\item {} + \begin{itemize} + \item {} \ccc{SphericalKernel::Plane_3} or + \item {} \ccc{SphericalKernel::Sphere_3} + (always returns \ccc{false} in this case) + \end{itemize} +and \ccc{SphericalKernel::Line_3} +\item {} + \begin{itemize} + \item {} \ccc{SphericalKernel::Plane_3} or + \item {} \ccc{SphericalKernel::Sphere_3} + \end{itemize} +and \ccc{SphericalKernel::Circle_3} +\item {} + \begin{itemize} + \item {} \ccc{SphericalKernel::Plane_3}, + \item {} \ccc{SphericalKernel::Line_3} or + \item {} \ccc{SphericalKernel::Sphere_3} + (always returns \ccc{false} in this case) + \end{itemize} +and \ccc{SphericalKernel::Line_arc_3} +\item {} or + \begin{itemize} + \item {} \ccc{SphericalKernel::Plane_3}, + \item {} \ccc{SphericalKernel::Circle_3} or + \item {} \ccc{SphericalKernel::Sphere_3} + \end{itemize} +and \ccc{SphericalKernel::Circular_arc_3}. +\end{itemize} + + +\end{ccRefFunctionObjectConcept} diff --git a/Circular_kernel_3/doc_tex/Spherical_kernel_3_ref/intro.tex b/Circular_kernel_3/doc_tex/Spherical_kernel_3_ref/intro.tex index 8bfb177350f..e26a1c3172f 100644 --- a/Circular_kernel_3/doc_tex/Spherical_kernel_3_ref/intro.tex +++ b/Circular_kernel_3/doc_tex/Spherical_kernel_3_ref/intro.tex @@ -11,7 +11,9 @@ \subsubsection*{Functors} -\ccRefConceptPage{Intersect_3} +\ccRefConceptPage{SphericalKernel::HasOn_3} + +\ccRefConceptPage{SphericalKernel::Intersect_3} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Algebraic Concepts} diff --git a/Circular_kernel_3/doc_tex/Spherical_kernel_3_ref/main.tex b/Circular_kernel_3/doc_tex/Spherical_kernel_3_ref/main.tex index bceb7bc0f25..eb915d775d5 100644 --- a/Circular_kernel_3/doc_tex/Spherical_kernel_3_ref/main.tex +++ b/Circular_kernel_3/doc_tex/Spherical_kernel_3_ref/main.tex @@ -11,6 +11,8 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % geometric functors +\input{Spherical_kernel_3_ref/GeomFunctorsOtherPredicates} + \input{Spherical_kernel_3_ref/Intersect} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%