cgal/Envelope_3/doc/Envelope_3/PackageDescription.txt

50 lines
1.8 KiB
Plaintext

/// \defgroup PkgEnvelope3 3D Envelopes Reference
/// \defgroup PkgEnvelope3Concepts Concepts
/// \ingroup PkgEnvelope3
/*!
\addtogroup PkgEnvelope3
\todo check generated documentation
\cgalPkgDescriptionBegin{3D Envelopes,PkgEnvelope3Summary}
\cgalPkgPicture{Envelope_3/fig/Envelope_3.png}
\cgalPkgSummaryBegin
\cgalPkgAuthors{Dan Halperin, Michal Meyerovitch, Ron Wein, and Baruch Zukerman}
\cgalPkgDesc{This package consits of functions that compute the lower (or upper) envelope of a set of arbitrary surfaces in 3D. The output is represented as an 2D envelope diagram, namely a planar subdivision such that the identity of the surfaces that induce the envelope over each diagram cell is unique.}
\cgalPkgManuals{Chapter_Envelopes_of_Surfaces_in_3D,PkgEnvelope3}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{3.3}
\cgalPkgDependsOn{\ref PkgArrangement2Summary}
\cgalPkgBib{cgal:mwz-e3}
\cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{3D Envelopes,envelope_3.zip,L1 Voronoi Diagram,l1_voronoi_diagram_2.zip}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
This package consists of functions that compute the lower (or upper)
envelope of a set of arbitrary surfaces in 3D. The output is
represented as an 2D envelope diagram - a planar subdivision such
that the identity of the surfaces that induce the envelope over each
diagram cell is unique.
\cgalClassifedRefPages
## Functions ##
- `CGAL::lower_envelope_3`
- `CGAL::upper_envelope_3`
- `CGAL::lower_envelope_xy_monotone_3`
- `CGAL::upper_envelope_xy_monotone_3`
## Concepts ##
- `EnvelopeTraits_3`
## Classes ##
- `CGAL::Envelope_diagram_2<EnvTraits>`
- `CGAL::Env_triangle_traits_3<Kernel>`
- `CGAL::Env_sphere_traits_3<ConicTraits>`
- `CGAL::Env_plane_traits_3<Kernel>`
- `CGAL::Env_surface_data_traits_3<Traits,XyData,SData,Cnv>`
*/