diff --git a/Surface_mesher/doc_tex/Surface_mesher_ref/ImplicitFunction.tex b/Surface_mesher/doc_tex/Surface_mesher_ref/ImplicitFunction.tex index a474625a04e..92da9e09689 100644 --- a/Surface_mesher/doc_tex/Surface_mesher_ref/ImplicitFunction.tex +++ b/Surface_mesher/doc_tex/Surface_mesher_ref/ImplicitFunction.tex @@ -37,7 +37,7 @@ whose \ccc{operator()} computes the values of a function any pointer to a function of type \ccc{FT (*)(FT, FT, FT)}. \ccSeeAlso -\ccc{Implicit_surface_3},\\ +\ccc{Implicit_surface_3},\\ \ccc{make_surface_mesh} diff --git a/Surface_mesher/doc_tex/Surface_mesher_ref/ImplicitSurfaceTraits_3.tex b/Surface_mesher/doc_tex/Surface_mesher_ref/ImplicitSurfaceTraits_3.tex index be8d83c32d9..847bf066c49 100644 --- a/Surface_mesher/doc_tex/Surface_mesher_ref/ImplicitSurfaceTraits_3.tex +++ b/Surface_mesher/doc_tex/Surface_mesher_ref/ImplicitSurfaceTraits_3.tex @@ -19,16 +19,16 @@ \ccDefinition The concept \ccRefName\ describes the requirements of the traits class to -be plugged as \ccc{Traits} in \ccc{Implicit_surface_3< Traits, Func>}. +be plugged as \ccc{Traits} in \ccc{Implicit_surface_3< Traits, Function>}. The concept provides the types, predicates and constructors objects that are used in the the partial specialisation of the surface mesher traits generator~: -\ccc{Surface_mesh_traits_generator_3 >}. +\ccc{Surface_mesh_traits_generator_3 >}. -TO BE COMPLETED BE LAURENT +TODO: TO BE COMPLETED BE LAURENT %\ccGeneralizes @@ -62,7 +62,7 @@ Any CGAL Kernel. \ccSeeAlso -\ccc{Implicit_surface_3},\\ +\ccc{Implicit_surface_3},\\ \ccc{make_surface_mesh} diff --git a/Surface_mesher/doc_tex/Surface_mesher_ref/Implicit_surface_3.tex b/Surface_mesher/doc_tex/Surface_mesher_ref/Implicit_surface_3.tex index e86356533e0..5944e836c8c 100644 --- a/Surface_mesher/doc_tex/Surface_mesher_ref/Implicit_surface_3.tex +++ b/Surface_mesher/doc_tex/Surface_mesher_ref/Implicit_surface_3.tex @@ -11,7 +11,7 @@ % +------------------------------------------------------------------------+ -\begin{ccRefClass}{Implicit_surface_3} +\begin{ccRefClass}{Implicit_surface_3} %% \ccHtmlCrossLink{} %% add further rules for cross referencing links %% \ccHtmlIndexC[class]{} %% add further index entries @@ -25,7 +25,7 @@ set of a function \begin{math}f : \R^3 \longrightarrow \R\end{math}. The library provides a partial specialization of the surface mesher traits generator~: -\ccc{Surface_mesh_traits_generator_3 >} +\ccc{Surface_mesh_traits_generator_3 >} that provides a model of \ccc{SurfaceMeshTraits_3} for this type of surfaces. @@ -38,18 +38,31 @@ the types, predicates and constructors objects provided in \ccc{Traits} are used in the partial specialisation -\ccc{Surface_mesh_traits_generator_3 >} +\ccc{Surface_mesh_traits_generator_3 >} to generate the model of \ccc{SurfaceMeshTraits_3}. -The template parameter \ccc{Func} stands for a model +The template parameter \ccc{Function} stands for a model of the concept \ccc{ImplicitFunction}. -The number type \ccc{Func::FT} has to match +The number type \ccc{Function::FT} has to match the type \ccc{Traits::FT}. -TODO : NEED TO DOCUMENT CONSTRUCTOR! - \ccInclude{CGAL/Implicit_surface_3.h} +\ccCreation +\ccCreationVariable{surface} + +\ccConstructor{ +Implicit_surface_3(Function f, + const Sphere_3 bounding_sphere, + const FT error_bound);} +{\ccc{f} is the object of type \ccc{Function} that represents the implicit + surface.\\ + \ccc{bounding_sphere} is a bounding sphere of the implicit surface.\\ + \ccc{error_bound} is a bound that is used if the partial specialisation + \ccc{Surface_mesh_traits_generator_3 >} + to compute intersection points between the implicit surface and some + segments.} + \ccSeeAlso \ccc{make_surface_mesh},\\ \ccc{Surface_mesh_traits_generator_3},\\ diff --git a/Surface_mesher/doc_tex/Surface_mesher_ref/Surface_mesh_traits_generator_3.tex b/Surface_mesher/doc_tex/Surface_mesher_ref/Surface_mesh_traits_generator_3.tex index 9aa8b5ae2ea..c1efea01f6f 100644 --- a/Surface_mesher/doc_tex/Surface_mesher_ref/Surface_mesh_traits_generator_3.tex +++ b/Surface_mesher/doc_tex/Surface_mesher_ref/Surface_mesh_traits_generator_3.tex @@ -35,7 +35,7 @@ of the traits generator \ccRefName exists. Currently, the library provides partial specializations of the traits generator -for implicit surfaces (\ccc{Implicit_surface_3 }) and +for implicit surfaces (\ccc{Implicit_surface_3 }) and grey level images (\ccc{Gray_level_image_3 }). diff --git a/Surface_mesher/doc_tex/Surface_mesher_ref/intro.tex b/Surface_mesher/doc_tex/Surface_mesher_ref/intro.tex index 51bd34c6441..8b8217d1597 100644 --- a/Surface_mesher/doc_tex/Surface_mesher_ref/intro.tex +++ b/Surface_mesher/doc_tex/Surface_mesher_ref/intro.tex @@ -50,7 +50,7 @@ of the output mesh while avoiding an over-refinement of the mesh. \ccRefIdfierPage{CGAL::Surface_mesh_cell_base_3} \\ \ccRefIdfierPage{CGAL::Surface_mesh_default_criteria_3} \\ \ccRefIdfierPage{CGAL::Surface_mesh_traits_generator_3} \\ -\ccRefIdfierPage{CGAL::Implicit_surface_3} \\ +\ccRefIdfierPage{CGAL::Implicit_surface_3} \\ \ccRefIdfierPage{CGAL::Gray_level_image_3} \subsection*{Tag classes} diff --git a/Surface_mesher/doc_tex/Surface_mesher_ref/make_surface_mesh.tex b/Surface_mesher/doc_tex/Surface_mesher_ref/make_surface_mesh.tex index 601fdc1c3f2..9d9772a2c66 100644 --- a/Surface_mesher/doc_tex/Surface_mesher_ref/make_surface_mesh.tex +++ b/Surface_mesher/doc_tex/Surface_mesher_ref/make_surface_mesh.tex @@ -98,7 +98,7 @@ of the traits generator \ccc{Surface_mesh_traits_generator_3} is provided. Currently, the library provides partial specializations of \ccc{Surface_mesher_traits_generator_3} -for implicit surfaces (\ccc{Implicit_surface_3 }) and +for implicit surfaces (\ccc{Implicit_surface_3 }) and grey level images (\ccc{Gray_level_image_3 }).