mirror of https://github.com/CGAL/cgal
88 lines
3.1 KiB
Plaintext
88 lines
3.1 KiB
Plaintext
/// \defgroup PkgPointSet3Ref Reference Manual
|
|
|
|
/*!
|
|
\cgalInclude{CGAL/draw_point_set_3.h}
|
|
*/
|
|
/// \defgroup PkgDrawPointSet3D Draw a 3D Point Set
|
|
/// \ingroup PkgPointSet3Ref
|
|
|
|
/// \defgroup PkgPointSet3IO Input/Output
|
|
/// \ingroup PkgPointSet3Ref
|
|
///
|
|
/// This module offers convenience overloads of input/output
|
|
/// functions available in the \ref PkgPointSetProcessing3 package.
|
|
/// These overloads, available after including `CGAL/Point_set_3/IO.h`,
|
|
/// allow the user to call point set processing algorithms without having
|
|
/// to handle manually property maps and iterators.
|
|
///
|
|
/// Input functions instantiate all the necessary property maps:
|
|
///
|
|
/// - if found in the input, normal vectors are stored in the usual
|
|
/// `CGAL::Point_set_3` property `normal` with template type `Vector`
|
|
///
|
|
/// - for PLY and LAS input, other properties are stored as properties in
|
|
/// the `CGAL::Point_set_3` class with the name and type given by the PLY
|
|
/// header or by the LAS standard.
|
|
///
|
|
/// For a complete documentation of these functions, please refer to the
|
|
/// \ref PkgPointSetProcessing3Ref "Point Set Processing Reference Manual".
|
|
|
|
/// \defgroup PkgPointSet3IOLAS Input/Output (LAS)
|
|
/// I/O Functions for the \ref IOStreamLAS
|
|
/// \ingroup PkgPointSet3IO
|
|
|
|
/// \defgroup PkgPointSet3IOOFF Input/Output (OFF)
|
|
/// I/O Functions for the \ref IOStreamOFF
|
|
/// \ingroup PkgPointSet3IO
|
|
|
|
/// \defgroup PkgPointSet3IOPLY Input/Output (PLY)
|
|
/// I/O Functions for the \ref IOStreamPLY
|
|
/// \ingroup PkgPointSet3IO
|
|
|
|
/// \defgroup PkgPointSet3IOXYZ Input/Output (XYZ)
|
|
/// I/O Functions for the \ref IOStreamXYZ
|
|
/// \ingroup PkgPointSet3IO
|
|
|
|
|
|
/*!
|
|
\addtogroup PkgPointSet3Ref
|
|
|
|
\cgalPkgDescriptionBegin{3D Point Set, PkgPointSet3}
|
|
\cgalPkgPicture{point_set_3.png}
|
|
\cgalPkgSummaryBegin
|
|
\cgalPkgAuthor{Simon Giraudot}
|
|
\cgalPkgDesc{This component provides the user with a flexible 3D point set data structure. The user can define any additional property needed such as normal vectors, colors or labels. \cgal algorithms can be easily applied to this data structure.}
|
|
\cgalPkgManuals{Chapter_Point_Set_3, PkgPointSet3Ref}
|
|
\cgalPkgSummaryEnd
|
|
\cgalPkgShortInfoBegin
|
|
\cgalPkgSince{4.10}
|
|
\cgalPkgBib{cgal:g-ps}
|
|
\cgalPkgLicense{\ref licensesGPL "GPL"}
|
|
\cgalPkgDemo{CGAL Lab,CGALlab.zip}
|
|
\cgalPkgShortInfoEnd
|
|
\cgalPkgDescriptionEnd
|
|
|
|
\cgalClassifedRefPages
|
|
|
|
\cgalCRPSection{Classes}
|
|
- `CGAL::Point_set_3<Point,Vector>`
|
|
|
|
\cgalCRPSection{Visualization}
|
|
- \link PkgDrawPointSet3D `CGAL::draw<PS>()` \endlink
|
|
|
|
\cgalCRPSection{I/O Functions}
|
|
This package offers convenience overloads for the class `CGAL::Point_set_3`
|
|
of the input/output functions available in the \ref PkgPointSetProcessing3 package.
|
|
These overloads, available after including `CGAL/Point_set_3/IO.h`,
|
|
allow the user to call point set processing algorithms without having
|
|
to handle manually property maps and iterators.
|
|
|
|
- `CGAL::IO::read_point_set()`
|
|
- `CGAL::IO::write_point_set()`
|
|
- \link PkgPointSet3IOLAS I/O for `LAS` files \endlink
|
|
- \link PkgPointSet3IOOFF I/O for `OFF` files \endlink
|
|
- \link PkgPointSet3IOPLY I/O for `PLY` files \endlink
|
|
- \link PkgPointSet3IOXYZ I/O for `XYZ` files \endlink
|
|
|
|
*/
|