Add documentation for Nef Polyhedron Viewer.

This commit is contained in:
Jasmeet Singh 2019-07-03 15:06:13 -07:00
parent 53bed9f541
commit ff2a498d9e
7 changed files with 27 additions and 0 deletions

View File

@ -425,6 +425,18 @@ the symbolical value, large but finite, for the size of the infimaximal box.
\cgalExample{Nef_3/extended_kernel.cpp}
\subsection Nef_3DrawNefPolyhedron Draw a Nef Polyhedron
A nef polyhedron can be visualised by calling the \link PkgDrawNef3 CGAL::draw<Nef_3>() \endlink function as shown in the following example. This function opens a new window showing the given Nef Polyhedron.
\cgalExample{Nef_3/draw_nef_3.cpp}
This function requires CGAL_Qt5, and is only available if the flag CGAL_USE_BASIC_VIEWER is defined at compile time.
\cgalFigureBegin{fig_draw_nef_polyhedron, draw_nef_3.png}
Result of the run of the draw_nef_3 program. A window shows the nef polyhedron and allows to navigate through the 3D scene.
\cgalFigureEnd
\section Nef_3File File I/O
\anchor sectionNef_3IO

View File

@ -3,6 +3,13 @@
/// \defgroup PkgNef3IOFunctions I/O Functions
/// \ingroup PkgNef3Ref
/*! Draw.
\code
#include <CGAL/draw_nef_3.h>
\endcode
*/
/// \defgroup PkgDrawNef3 Draw a Nef Polyhedron
/// \ingroup PkgNef3Ref
/*!
\addtogroup PkgNef3Ref
@ -64,5 +71,8 @@ a simple OpenGL visualization for debugging and illustrations.
- \link PkgNef3IOFunctions `CGAL::operator<<()` \endlink
- \link PkgNef3IOFunctions `CGAL::operator>>()` \endlink
\cgalCRPSection{Draw a Nef Polyhedron}
- \link PkgDrawNef3 CGAL::draw<Nef3>() \endlink
*/

View File

@ -11,3 +11,4 @@ Number_types
BGL
Surface_mesh
Polygon_mesh_processing
GraphicsView

View File

@ -17,4 +17,5 @@
\example Nef_3/topological_operations.cpp
\example Nef_3/transformation.cpp
\example Nef_3/nef_3_to_surface_mesh.cpp
\example Nef_3/draw_nef_3.cpp
*/

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

View File

@ -7,6 +7,7 @@ Circulator
Distance_2
Distance_3
Filtered_kernel
GraphicsView
HalfedgeDS
Hash_map
Homogeneous_kernel

View File

@ -398,6 +398,8 @@ in the unit rectangle. The tests were done on an Intel i7 @ 2.67GHz.
A 2D periodic triangulation can be visualized by calling the \link PkgDrawPeriodic2Triangulation2 CGAL::draw<P2T2>() \endlink function as shown in the following example. This function opens a new window showing the given Periodic Triangulation. Elements of the periodic triangulation can be viewed in four different modes:
\cgalExample{Periodic_2_triangulation_2/draw_periodic_2_triangulation_2.cpp}
- <B>STORED</B> Display all geometric primitives as they are stored in Triangulation_data_structure_2;
- <B>UNIQUE</B> Display only one representative of each geometric primitive even if the triangulation is computed in multiply sheeted covering space;
- <B>STORED_COVER_DOMAIN</B> Same as STORED but also display all primitives whose intersection with the original domain of the current covering space is non-empty;