added docu for Curves in 3d

This commit is contained in:
Eric Berberich 2007-03-27 12:18:30 +00:00
parent e601179bc6
commit d839efafcd
2 changed files with 44 additions and 0 deletions

View File

@ -0,0 +1,12 @@
\begin{ccRefConcept}{QuadricalKernel_3::Curve_3}
Concept for space curves in 3D that describes the spatial intersection curve
of two quadrics.
\ccRefines
CopyConstructible, Assignable, DefaultConstructible
\ccHasModels
\ccc{CGAL::Curve_3<QuadricalKernel_3>}
\end{ccRefConcept}

View File

@ -0,0 +1,32 @@
\begin{ccRefClass}{Curve_3<QuadricalKernel_3>}
%\ccInclude{CGAL/Curve_3.h}
\ccIsModel
\ccc{QuadricalKernel_3::Curve_3}
\ccCreation
\ccCreationVariable{sc}
\ccThree{Curve_point_3}{ca.is_x_monotone()}{}
\ccThreeToTwo
\ccConstructor{Curve_3(const QuadricalKernel_3::Quadric_3& q1,
const QuadricalKernel_3::Quadric_3& q2)}
{
Constructs the space curve that is defined by the intersection of \ccc{q1} and \ccc{q2}.}
\ccAccessFunctions
\ccThree{QuadricalKernel_3::Curve_point_3}{arc.is_x_monotone()}{}
\ccThreeToTwo
\ccMethod{template < class OutputIterator > OutputIterator defining_surfaces(OutputIterator oi);}{}
\ccMethod{QuadricalKernel_3::Bbox_3 bbox();}{}
\ccFunction{bool operator==(const Curve_3<QuadricalKernel_3> &p,
const Curve_3<QuadricalKernel_3> &q);}{}
\end{ccRefClass}