mirror of https://github.com/CGAL/cgal
60 lines
2.0 KiB
TeX
60 lines
2.0 KiB
TeX
% +------------------------------------------------------------------------+
|
|
% | Reference manual page: AABB_traits_base.tex
|
|
% +------------------------------------------------------------------------+
|
|
% | 21.02.2009 Author
|
|
% | Package: Package
|
|
% |
|
|
\RCSdef{\RCSAABBtraitsbaseRev}{$Id: header.tex 40270 2007-09-07 15:29:10Z lsaboret $}
|
|
\RCSdefDate{\RCSAABBtraitsbaseDate}{$Date: 2007-09-07 17:29:10 +0200 (Ven, 07 sep 2007) $}
|
|
% |
|
|
\ccRefPageBegin
|
|
%%RefPage: end of header, begin of main body
|
|
% +------------------------------------------------------------------------+
|
|
|
|
|
|
\begin{ccRefClass}{AABB_traits<GeomTraits,Primitive>}
|
|
|
|
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
|
|
%% \ccHtmlIndexC[class]{} %% add further index entries
|
|
|
|
\ccDefinition
|
|
|
|
The class \ccRefName\ is a model of the concept \ccc{AABBTraits}. This traits class handles any type of 3D geometric primitives provided that the proper intersection tests and constructions are implemented.
|
|
|
|
\ccParameters
|
|
The template parameter \ccc{GeomTraits} provides the geometric types as well as the intersection tests and computations required. This type must be a model of the concept \ccc{AABBGeomTraits}.
|
|
|
|
The template parameter \ccc{Primitive} provides the primitives stored in the AABB tree. This parameter must be a model of the concept \ccc{AABBPrimitive}.
|
|
|
|
\ccInclude{AABB_traits.h}
|
|
|
|
\ccTypes
|
|
|
|
\ccTypedef{GeomTraits::Ray_3 Ray_3;}{Ray query type.}
|
|
\ccTypedef{GeomTraits::Line_3 Line_3;}{Line query type.}
|
|
\ccTypedef{GeomTraits::Segment_3 Segment_3;}{Segment query type.}
|
|
|
|
\ccCreation
|
|
\ccCreationVariable{traits} %% choose variable name
|
|
|
|
%\ccConstructor{AABB_traits();}{default constructor.}
|
|
|
|
% \ccOperations
|
|
% \ccMethod{void foo();}{some member functions}
|
|
|
|
\ccSeeAlso
|
|
|
|
\ccc{AABBTraits},\\
|
|
\ccc{AABB_tree<Traits>}, \\
|
|
\ccc{AABBPrimitive},\\
|
|
\ccc{AABBTrianglePrimitive}
|
|
|
|
\end{ccRefClass}
|
|
|
|
% +------------------------------------------------------------------------+
|
|
%%RefPage: end of main body, begin of footer
|
|
\ccRefPageEnd
|
|
% EOF
|
|
% +------------------------------------------------------------------------+
|
|
|