From d68feab779b3072d4e07bc7f19f1131da79a22c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20M=C3=B6ller?= Date: Tue, 21 Aug 2012 08:31:18 +0000 Subject: [PATCH] Document a namespace for convex_decomposition_3. Shrink and place some images. --- .../Convex_decomposition_3.txt | 14 ++- .../include/CGAL/convex_decomposition_3.h | 1 + Documentation/doxyassist.xml | 95 ++++++++++++++----- 3 files changed, 83 insertions(+), 27 deletions(-) diff --git a/Convex_decomposition_3/doc/Convex_decomposition_3/Convex_decomposition_3.txt b/Convex_decomposition_3/doc/Convex_decomposition_3/Convex_decomposition_3.txt index 7fe034b66ca..909cb699a90 100644 --- a/Convex_decomposition_3/doc/Convex_decomposition_3/Convex_decomposition_3.txt +++ b/Convex_decomposition_3/doc/Convex_decomposition_3/Convex_decomposition_3.txt @@ -27,9 +27,15 @@ optimal \cite c-cpplb-84. \image latex two_cubes "" width=0.245 \image latex two_cubes_cylindrical "" width=0.25 \image latex two_cubes_vertical "" width=0.27 -\image html two_cubes.gif "" -\image html /two_cubes_cylindrical.gif "" -\image html /two_cubes_vertical.gif "" + +\htmlonly +
+decomposition example     +decomposition after first step    +final decomposition +
+\endhtmlonly +
Vertical decomposition based on the insertion of vertical facets (viewed from the top). Left: Non-convex polyhedron. Middle: @@ -75,7 +81,7 @@ selected facets. These additional facets are therefore redundant, i.e., their insertion alters the representation of the polyhedron, but not the polyhedron itself. -When `convex_decomposition_3` resolved all reflex edges, the +When `::convex_decomposition_3` resolved all reflex edges, the selected sub-volumes have become convex. Each of them is represented by a separate volume item and can therefore be traversed separately \ref subsectionNef_3ShellExploration. Another possibility diff --git a/Convex_decomposition_3/include/CGAL/convex_decomposition_3.h b/Convex_decomposition_3/include/CGAL/convex_decomposition_3.h index 6691278cef9..2a73f5e6305 100644 --- a/Convex_decomposition_3/include/CGAL/convex_decomposition_3.h +++ b/Convex_decomposition_3/include/CGAL/convex_decomposition_3.h @@ -36,6 +36,7 @@ */ +/// The CGAL namespace. namespace CGAL { /*! diff --git a/Documentation/doxyassist.xml b/Documentation/doxyassist.xml index 52aa33bd1fc..0ec531660f3 100644 --- a/Documentation/doxyassist.xml +++ b/Documentation/doxyassist.xml @@ -11,7 +11,6 @@ namespace for the XML file to be processed properly. --> - CGAL @@ -94,9 +93,6 @@ namespace for the XML file to be processed properly. --> ./tags/Algebraic_foundations.tag ../Algebraic_foundations/doc/Algebraic_foundations/fig ../Algebraic_foundations/examples - - ./tags/Manual.tag=../../CGAL.CGAL/html - @@ -133,8 +129,8 @@ namespace for the XML file to be processed properly. --> ./tags/Convex_hull_3.tag ../Convex_hull_3/examples ../Convex_hull_3/doc/Convex_hull_3/fig - - ./tags/Convex_hull_2.tag=../../CGAL.CGAL.Convex_hull_2/html + + ./tags/Convex_hull_2.tag=../../CGAL.CGAL.Convex_hull_2/html @@ -159,7 +155,7 @@ namespace for the XML file to be processed properly. --> ../Straight_skeleton_2/examples ../Straight_skeleton_2/doc/Straight_skeleton_2/fig - ./tags/HalfedgeDS.tag=../../CGAL.CGAL.HalfedgeDS/html + ./tags/HalfedgeDS.tag=../../CGAL.CGAL.HalfedgeDS/html @@ -182,11 +178,20 @@ namespace for the XML file to be processed properly. --> ../Convex_decomposition_3/doc/Convex_decomposition_3 ../Convex_decomposition_3/include + ../Convex_decomposition_3/include ./tags/Convex_decomposition_3.tag ../Convex_decomposition_3/examples ../Convex_decomposition_3/doc/Convex_decomposition_3/fig false true + + ./tags/Nef_3.tag=../../CGAL.CGAL.Nef_3/html + + + ../Convex_decomposition_3/doc/Convex_decomposition_3/fig/two_cubes.gif + ../Convex_decomposition_3/doc/Convex_decomposition_3/fig/two_cubes_cylindrical.gif + ../Convex_decomposition_3/doc/Convex_decomposition_3/fig/two_cubes_vertical.gif + @@ -242,7 +247,7 @@ namespace for the XML file to be processed properly. --> ./tags/Minkowski_sum_2.tag ../Minkowski_sum_2/examples ../Minkowski_sum_2/doc/Minkowski_sum_2/fig - + ./tags/Polygon.tag=../../CGAL.CGAL.Polygon/html @@ -256,7 +261,8 @@ namespace for the XML file to be processed properly. --> ./tags/Minkowski_sum_3.tag ../Minkowski_sum_3/examples ../Minkowski_sum_3/doc/Minkowski_sum_3/fig - + + ./tags/Nef_3.tag=../../CGAL.CGAL.Nef_3/html @@ -269,7 +275,8 @@ namespace for the XML file to be processed properly. --> ./tags/Generator.tag ../Generator/examples ../Generator/doc/Generator/fig - + + ./tags/STL_Extension.tag=../../CGAL.CGAL.STL_Extension/html @@ -281,7 +288,7 @@ namespace for the XML file to be processed properly. --> ../Geomview/doc/Geomview/ ./tags/Geomview.tag ../Geomview/demo - + @@ -293,7 +300,26 @@ namespace for the XML file to be processed properly. --> ../Spatial_searching/doc/Spatial_searching/ ./tags/Spatial_searching.tag ../Spatial_searching/examples - + + + + + + + Segment_Delaunay_graph_2 + ../Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2 + + ../Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/ + ../Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/ + ./tags/Segment_Delaunay_graph_2.tag + ../Segment_Delaunay_graph_2/examples + ../Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/fig + + ./tags/Algebraic_foundations.tag=../../CGAL.CGAL.Algebraic_foundations/html + ./tags/TDS_2.tag=../../CGAL.CGAL.TDS_2/html + ./tags/Apollonius_graph_2.tag=../../CGAL.CGAL.Apollonius_graph_2/html + ./tags/Apollonius_graph_2.tag=../../CGAL.CGAL.Apollonius_graph_2/html + ./tags/Voronoi_diagram_2.tag=../../CGAL.CGAL.Voronoi_diagram_2/html @@ -306,7 +332,7 @@ namespace for the XML file to be processed properly. --> ./tags/Box_intersection_d.tag ../Box_intersection_d/examples ../Box_intersection_d/doc/Box_intersection_d/fig - + @@ -320,7 +346,7 @@ namespace for the XML file to be processed properly. --> ./tags/GraphicsView.tag ../GraphicsView/examples ../GraphicsView/doc/GraphicsView/fig - + @@ -334,7 +360,7 @@ namespace for the XML file to be processed properly. --> ./tags/Miscellany.tag ../Profiling_tools/examples ../Miscellany/doc/Miscellany/fig - + @@ -346,13 +372,13 @@ namespace for the XML file to be processed properly. --> ../Polytope_distance_d/doc/Polytope_distance_d/ ../Polytope_distance_d/doc/Polytope_distance_d/ ./tags/Polytope_distance_d.tag - + ../Polytope_distance_d/examples ../Width_3/examples ../Matrix_search/examples ../Polytope_distance_d/doc/Polytope_distance_d/fig - + @@ -364,7 +390,7 @@ namespace for the XML file to be processed properly. --> ../Bounding_volumes/doc/Bounding_volumes/ ../Bounding_volumes/doc/Bounding_volumes/ ./tags/Bounding_volumes.tag - + ../Min_quadrilateral_2/examples ../Min_circle_2/examples ../Min_ellipse_2/examples @@ -476,6 +502,10 @@ namespace for the XML file to be processed properly. --> ../Apollonius_graph_2/doc/Apollonius_graph_2/fig/apollonius-interior.gif ../Apollonius_graph_2/doc/Apollonius_graph_2/fig/apollonius-both_vertices.gif + + ./tags/Voronoi_diagram_2.tag=../../CGAL.CGAL.Voronoi_diagram_2/html + ./tags/TDS_2.tag=../../CGAL.CGAL.TDS_2/html + @@ -503,6 +533,25 @@ namespace for the XML file to be processed properly. --> + + Nef_S2 + ../Nef_S2/doc + + ../Nef_S2/doc/Nef_S2/ + ../Nef_S2/doc/Nef_S2/ + ./tags/Nef_S2.tag + ../Nef_S2/doc/Nef_S2/fig + + ../Nef_S2/examples + ../Nef_S2/demo + + + ../Nef_S2/doc/Nef_S2/fig/halfspace.gif + ../Nef_S2/doc/Nef_S2/fig/complex.gif + + + + Nef_3 ../Nef_3/doc @@ -511,16 +560,12 @@ namespace for the XML file to be processed properly. --> ../Nef_3/doc/Nef_3/ ./tags/Nef_3.tag ../Nef_3/doc/Nef_3/fig - + ../Nef_3/examples ../Nef_3/demo - - - - @@ -562,6 +607,7 @@ namespace for the XML file to be processed properly. --> ../HalfedgeDS/doc/HalfedgeDS/fig ../Interval_skip_list/doc/Interval_skip_list/fig ../Nef_2/doc/Nef_2/fig + ../Nef_2/doc/Nef_S2/fig ../Nef_3/doc/Nef_3/fig ../Mesh_2/doc/Mesh_2/fig ../Mesh_3/doc/Mesh_3/fig @@ -578,6 +624,7 @@ namespace for the XML file to be processed properly. --> ../Skin_surface_3/doc/Skin_surface_3/fig ../Snap_rounding_2/doc/Snap_rounding_2/fig ../Spatial_searching/doc/Spatial_searching/fig + ../Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/fig ../Straight_skeleton_2/doc/Straight_skeleton_2/fig @@ -601,6 +648,7 @@ namespace for the XML file to be processed properly. --> ./tags/HalfedgeDS.tag=../../CGAL.CGAL.HalfedgeDS/html ./tags/Interval_skip_list.tag=../../CGAL.CGAL.Interval_skip_list/html ./tags/Nef_2.tag=../../CGAL.CGAL.Nef_2/html + ./tags/Nef_S2.tag=../../CGAL.CGAL.Nef_S2/html ./tags/Nef_3.tag=../../CGAL.CGAL.Nef_3/html ./tags/Mesh_2.tag=../../CGAL.CGAL.Mesh_2/html ./tags/Mesh_3.tag=../../CGAL.CGAL.Mesh_3/html @@ -617,6 +665,7 @@ namespace for the XML file to be processed properly. --> ./tags/Skin_surface_3.tag=../../CGAL.CGAL.Skin_surface_3/html ./tags/Snap_rounding_2.tag=../../CGAL.CGAL.Snap_rounding_2/html ./tags/Spatial_searching.tag=../../CGAL.CGAL.Spatial_searching/html + ./tags/Segment_Delaunay_graph_2.tag=../../CGAL.CGAL.Segment_Delaunay_graph_2/html ./tags/Straight_skeleton_2.tag=../../CGAL.CGAL.Straight_skeleton_2/html true