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

added documentation

This commit is contained in:
Nico Kruithof 2006-03-03 14:50:25 +00:00
parent b7d5c7a617
commit d984d97c32
7 changed files with 42 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Skin_surface_3/doc_tex/Skin_surface_3_ref/MarchingTetrahedraObserver_3.tex
View File

@ -30,6 +30,10 @@
\ccTypes
\ccThree{Triangulation_cell}{handle to the Cell type of
the triangulation}{}
\ccThreeToTwo
\ccNestedType{Triangulation_cell_handle;}{handle to the Cell type of
the triangulation}
\ccNestedType{Polyhedron_vertex_handle;}{handle to the Vertex type of
@ -43,7 +47,7 @@
\ccCreationVariable{observer}
\ccConstructor{MarchingTetrahedraObserver_3();}{}
\ccGlue
\ccConstructor{MarchingTetrahedraObserver_3( const
MarchingTetrahedraObserver_3& traits2);}{ copy constructor.}
@ -60,7 +64,7 @@
\ccHasModels
\ccRefIdfierPage{CGAL::Marching_tetrahedra_observer_default_3< MarchingTetrahedraTraits_3 >}
\ccRefIdfierPage{CGAL::Marching_tetrahedra_observer_default_3<MarchingTetrahedraTraits_3>}
\ccRefIdfierPage{CGAL::Marching_tetrahedra_observer_skin_surface_3< MarchingTetrahedraTraits_3 >}
\end{ccRefConcept}

6
Skin_surface_3/doc_tex/Skin_surface_3_ref/MarchingTetrahedraTraits_3.tex
View File

@ -29,14 +29,14 @@ triangulation.
%\ccNestedType{Converter;}{Function object that can convert points defined by
% the \ccc{triangulation} to points defined by the \ccc{HDS}}
\ccNestedType{Cell_handle;}{handle to the Cell type of the triangulation}
\ccNestedType{Triangulation;}{The type of the triangulation}
\ccNestedType{Halfedge_DS;}{The type of the halfedge data structure}
\ccNestedType{Cell_handle;}{handle to the Cell type of the triangulation}
%\ccNestedType{HDS_rt;}{}
%\ccGlue
% \ccGlue
\ccNestedType{HDS_point;}{the point type defined by the kernel of the
polyhedron}
% \ccNestedType{HDS_RT;}{the number type defined by the kernel of the polyhedron}
\ccCreation
\ccCreationVariable{traits}

15
Skin_surface_3/doc_tex/Skin_surface_3_ref/Marching_tetrahedra_observer_default_3.tex
View File

@ -13,20 +13,22 @@
\begin{ccRefClass}{Marching_tetrahedra_observer_default_3<MarchingTetrahedraTraits_3>}
A default implementation of the concept
\ccc{MarchingTetrahedraObserver_3} that defines the necessary
functions.
The class \ccRefName\ provides a default implementation for the
concept \ccc{MarchingTetrahedraObserver_3} with empty bodies.
\ccDefinition
\ccInclude{CGAL/Marching_tetrahedra_observer_skin_surface_3.h}
\ccInclude{CGAL/Marching_tetrahedra_observer_default_3.h}
\ccIsModel
\ccRefConceptPage{MarchingTetrahedraObserver_3}
\ccThree{typedef MarchingTetrahedraTraits_3 Traitsxxx;}{xxx}{}
\ccThreeToTwo
\ccTypes
NGHK: CHECK OTHER TYPES
%NGHK: CHECK OTHER TYPES
\ccTypedef{typedef MarchingTetrahedraTraits_3 Traits;}{}
\ccGlue
\ccTypedef{typedef typename Traits::Triangulation Triangulation;}{}
@ -44,7 +46,8 @@ NGHK: CHECK OTHER TYPES
\ccConstructor{Marching_tetrahedra_observer_default_3();}{}
\ccThree{void}{typedef }{}
\ccThreeToTwo
\ccOperations
\ccMethod{void after_vertex_insertion(Triangulation_cell_handle ch,
int i, int j, Polyhedron_vertex_handle vh);}{Empty function.}

10
Skin_surface_3/doc_tex/Skin_surface_3_ref/Marching_tetrahedra_observer_skin_surface_3.tex
View File

@ -27,6 +27,9 @@
\ccRefConceptPage{MarchingTetrahedraObserver_3}
\ccThree{typedef MarchingTetrahedraTraits_3 Traitsxxx;}{xxx}{}
\ccThreeToTwo
\ccTypes
\ccTypedef{typedef MarchingTetrahedraTraits_3 Traits;}{}
\ccGlue
@ -44,11 +47,16 @@
\ccConstructor{Marching_tetrahedra_observer_3();}{}
\ccThree{void}{typedef }{}
\ccThreeToTwo
\ccOperations
%
\ccMethod{void after_vertex_insertion(Triangulation_cell_handle ch,
int i, int j, Polyhedron_vertex_handle vh);}{Empty method.}
%
\ccMethod{void after_facet_insertion(Triangulation_cell_handle ch,
Polyhedron_facet_handle fh);}{Empty method.}
Polyhedron_facet_handle fh);}{sets a pointer to the cells handle in
the facet handle}
\end{ccRefClass}

6
Skin_surface_3/doc_tex/Skin_surface_3_ref/Marching_tetrahedra_traits_skin_surface_3.tex
View File

@ -36,11 +36,15 @@
\ccTypedef{typedef typename HalfedgeDS::Traits HDS_K;}{}
\ccGlue
\ccTypedef{typedef typename HDS_K::Point_3 HDS_point;}{}
\ccTypedef{typedef HDS_point::R::RT HDS_RT;}{}
\ccCreation
\ccCreationVariable{marching_traits} %% choose variable name
\ccConstructor{Marching_tetrahedra_traits_skin_surface_3(HDS_rt iso_value=0);}{}
\ccConstructor{Marching_tetrahedra_traits_skin_surface_3();}{default constructor with
\ccc{iso_value} zero}
\ccConstructor{Marching_tetrahedra_traits_skin_surface_3(HDS_RT iso_value);}{}
\ccOperations

1
Skin_surface_3/doc_tex/Skin_surface_3_ref/Skin_surface_hyperboloid_3.tex
View File

@ -16,4 +16,5 @@
\begin{ccRefClass}{Skin_surface_hyperboloid_3<Kernel>}
\label{refSkinsurfacehyperboloid}
NGHK: HIER VERDER
\end{ccRefClass}

19
Skin_surface_3/include/CGAL/Marching_tetrahedra_traits_skin_surface_3.h
View File

@ -32,16 +32,13 @@ public:
typedef HalfedgeDS Halfedge_DS;
typedef Converter_ Converter;
typedef typename Triangulation::Vertex_handle Vertex_handle;
typedef typename Triangulation::Edge Edge;
typedef typename Triangulation_3::Cell_handle Cell_handle;
typedef typename Triangulation::Geom_traits::Point_3 Triang_point;
typedef typename HalfedgeDS::Traits HDS_K;
typedef typename HDS_K::Point_3 HDS_point;
typedef typename HDS_point::R::RT HDS_rt;
typedef typename HalfedgeDS::Traits::Point_3 HDS_point;
typedef typename HDS_point::R::RT HDS_RT;
Marching_tetrahedra_traits_skin_surface_3(HDS_rt iso_value=0)
Marching_tetrahedra_traits_skin_surface_3(HDS_RT iso_value=0)
: iso_value(iso_value) {
}
@ -57,16 +54,18 @@ public:
}
private:
typedef typename Triangulation::Geom_traits::Point_3 Triang_point;
// Additional functions, not belonging to the traits concept:
HDS_rt value(const Cell_handle &ch, const HDS_point &p) const {
HDS_RT value(const Cell_handle &ch, const HDS_point &p) const {
return ch->surf->value(p);
}
HDS_rt value(const Cell_handle &ch, const Triang_point &p) const {
HDS_RT value(const Cell_handle &ch, const Triang_point &p) const {
return ch->surf->value(converter(p));
}
Converter converter;
HDS_rt iso_value;
HDS_RT iso_value;
};
CGAL_END_NAMESPACE