mirror of https://github.com/CGAL/cgal
173 lines
5.2 KiB
Plaintext
173 lines
5.2 KiB
Plaintext
/// \defgroup PkgSphericalKernel3 3D Spherical Geometry Kernel Reference
|
|
|
|
/// \defgroup PkgSphericalKernel3GeometricConcepts Geometric Concepts
|
|
/// \ingroup PkgSphericalKernel3
|
|
|
|
/// \defgroup PkgSphericalKernel3GeometricClasses Geometric Kernel and Classes
|
|
/// \ingroup PkgSphericalKernel3
|
|
|
|
|
|
/// \defgroup PkgSphericalKernel3GeometricFunctions Geometric Global Functions
|
|
/// \ingroup PkgSphericalKernel3
|
|
|
|
|
|
/// \defgroup PkgSphericalKernel3AlgebraicConcepts Algebraic Concepts
|
|
/// \ingroup PkgSphericalKernel3
|
|
|
|
|
|
/// \defgroup PkgSphericalKernel3AlgebraicClasses Algebraic Kernel and Classes
|
|
/// \ingroup PkgSphericalKernel3
|
|
|
|
/*!
|
|
\addtogroup PkgSphericalKernel3
|
|
\cgalPkgDescriptionBegin{3D Spherical Geometry Kernel,PkgSphericalKernel3Summary}
|
|
\cgalPkgPicture{segment_sphere_intersection_detail.png}
|
|
\cgalPkgSummaryBegin
|
|
\cgalPkgAuthors{Pedro Machado Manhães de Castro, Frédéric Cazals, Sébastien Loriot, and Monique Teillaud}
|
|
\cgalPkgDesc{This package is an extension of the linear \cgal %Kernel. It offers functionalities on spheres, circles, circular arcs and line segments, in the 3D space or restricted on a reference sphere.}
|
|
\cgalPkgManuals{Chapter_3D_Spherical_Geometry_Kernel,PkgSphericalKernel3}
|
|
\cgalPkgSummaryEnd
|
|
\cgalPkgShortInfoBegin
|
|
\cgalPkgSince{3.4}
|
|
\cgalPkgBib{cgal:cclt-sgk3}
|
|
\cgalPkgLicense{\ref licensesGPL "GPL"}
|
|
\cgalPkgShortInfoEnd
|
|
\cgalPkgDescriptionEnd
|
|
|
|
\cgalClassifedRefPages
|
|
|
|
## Geometric Concepts ##
|
|
|
|
- `SphericalKernel`
|
|
|
|
### Object types ###
|
|
|
|
- `SphericalKernel::CircularArc_3`
|
|
- `SphericalKernel::CircularArcPoint_3`
|
|
- `SphericalKernel::LineArc_3`
|
|
|
|
### Functors ###
|
|
|
|
- `SphericalKernel::ConstructPlane_3`
|
|
- `SphericalKernel::ConstructSphere_3`
|
|
- `SphericalKernel::ConstructLine_3`
|
|
- `SphericalKernel::ConstructCircle_3`
|
|
- `SphericalKernel::ConstructCircularArcPoint_3`
|
|
- `SphericalKernel::ConstructLineArc_3`
|
|
- `SphericalKernel::ConstructCircularArc_3`
|
|
- `SphericalKernel::ConstructCircularMinVertex_3`
|
|
- `SphericalKernel::ConstructCircularMaxVertex_3`
|
|
- `SphericalKernel::ConstructCircularSourceVertex_3`
|
|
- `SphericalKernel::ConstructCircularTargetVertex_3`
|
|
- `SphericalKernel::ConstructBbox_3`
|
|
- `SphericalKernel::CompareX_3`
|
|
- `SphericalKernel::CompareY_3`
|
|
- `SphericalKernel::CompareZ_3`
|
|
- `SphericalKernel::CompareXY_3`
|
|
- `SphericalKernel::CompareXYZ_3`
|
|
- `SphericalKernel::CompareTheta_3`
|
|
- `SphericalKernel::CompareThetaZ_3`
|
|
- `SphericalKernel::CompareZAtTheta_3`
|
|
- `SphericalKernel::CompareZToRight_3`
|
|
- `SphericalKernel::Equal_3`
|
|
- `SphericalKernel::HasOn_3`
|
|
- `SphericalKernel::DoOverlap_3`
|
|
- `SphericalKernel::DoIntersect_3`
|
|
- `SphericalKernel::IsThetaMonotone_3`
|
|
- `SphericalKernel::BoundedSide_3`
|
|
- `SphericalKernel::HasOnBoundedSide_3`
|
|
- `SphericalKernel::HasOnUnboundedSide_3`
|
|
- `SphericalKernel::Intersect_3`
|
|
- `SphericalKernel::Split_3`
|
|
- `SphericalKernel::MakeThetaMonotone_3`
|
|
- `SphericalKernel::ComputeCircularX_3`
|
|
- `SphericalKernel::ComputeCircularY_3`
|
|
- `SphericalKernel::ComputeCircularZ_3`
|
|
- `SphericalKernel::ComputeApproximateSquaredLength_3`
|
|
- `SphericalKernel::ComputeApproximateAngle_3`
|
|
- `SphericalKernel::GetEquation`
|
|
|
|
## Geometric Kernels and Classes ##
|
|
|
|
### Kernels ###
|
|
|
|
- `CGAL::Spherical_kernel_3<Kernel,AlgebraicKernelForSpheres>`
|
|
- `CGAL::Exact_spherical_kernel_3`
|
|
|
|
### Points ###
|
|
|
|
- `CGAL::Circular_arc_point_3<SphericalKernel>`
|
|
|
|
### Arcs ###
|
|
|
|
- `CGAL::Line_arc_3<SphericalKernel>`
|
|
- `CGAL::Circular_arc_3<SphericalKernel>`
|
|
|
|
### Constants and Enumerations ###
|
|
|
|
- `CGAL::Circle_type`
|
|
|
|
## Geometric Global Functions ##
|
|
|
|
- \link compare_x_spherical_grp `CGAL::compare_x()` \endlink
|
|
- \link compare_y_spherical_grp `CGAL::compare_y()` \endlink
|
|
- \link compare_z_spherical_grp `CGAL::compare_z()` \endlink
|
|
- \link compare_xy_spherical_grp `CGAL::compare_xy()` \endlink
|
|
- \link compare_xyz_spherical_grp `CGAL::compare_xyz()` \endlink
|
|
- `CGAL::compare_theta()`
|
|
- `CGAL::compare_theta_z()`
|
|
- `CGAL::is_theta_monotone()`
|
|
- `CGAL::classify()`
|
|
- `CGAL::x_extremal_point()`
|
|
- `CGAL::y_extremal_point()`
|
|
- `CGAL::z_extremal_point()`
|
|
- `CGAL::theta_extremal_point()`
|
|
- `CGAL::x_extremal_points()`
|
|
- `CGAL::y_extremal_points()`
|
|
- `CGAL::z_extremal_points()`
|
|
- `CGAL::theta_extremal_points()`
|
|
- \link do_intersect_grp `CGAL::do_intersect()` \endlink
|
|
- \link intersection_grp `CGAL::intersection()` \endlink
|
|
|
|
## Algebraic Concepts ##
|
|
|
|
- `AlgebraicKernelForSpheres`
|
|
|
|
### Functors ###
|
|
|
|
- `AlgebraicKernelForSpheres::ConstructPolynomial_1_3`
|
|
- `AlgebraicKernelForSpheres::ConstructPolynomialForSpheres_2_3`
|
|
- `AlgebraicKernelForSpheres::ConstructPolynomialsForLines_3`
|
|
- `AlgebraicKernelForSpheres::CompareX`
|
|
- `AlgebraicKernelForSpheres::CompareY`
|
|
- `AlgebraicKernelForSpheres::CompareZ`
|
|
- `AlgebraicKernelForSpheres::CompareXY`
|
|
- `AlgebraicKernelForSpheres::CompareXYZ`
|
|
- `AlgebraicKernelForSpheres::SignAt`
|
|
- `AlgebraicKernelForSpheres::XCriticalPoints`
|
|
- `AlgebraicKernelForSpheres::YCriticalPoints`
|
|
- `AlgebraicKernelForSpheres::ZCriticalPoints`
|
|
- `AlgebraicKernelForSpheres::Solve`
|
|
|
|
## Algebraic %Kernel and Classes ##
|
|
|
|
### %Kernel ###
|
|
|
|
- `CGAL::Algebraic_kernel_for_spheres_2_3<RT>`
|
|
|
|
### Polynomials ###
|
|
|
|
- `CGAL::Polynomial_1_3<RT>`
|
|
- `CGAL::Polynomial_for_spheres_2_3<FT>`
|
|
- `CGAL::Polynomials_for_lines_3<FT>`
|
|
|
|
### Roots of Polynomials ###
|
|
|
|
- `CGAL::Sqrt_extension<NT,ROOT>`
|
|
- `CGAL::Root_for_spheres_2_3<RT>`
|
|
- `CGAL::Root_of_traits<RT>`
|
|
|
|
|
|
*/
|
|
|