mirror of https://github.com/CGAL/cgal
71 lines
2.8 KiB
TeX
71 lines
2.8 KiB
TeX
% +------------------------------------------------------------------------+
|
|
% | Reference manual page: AABBPrimitive.tex
|
|
% +------------------------------------------------------------------------+
|
|
% | 21.02.2009 Author
|
|
% | Package: Package
|
|
% |
|
|
\RCSdef{\RCSAABBPrimitiveRev}{$Id: header.tex 40270 2007-09-07 15:29:10Z lsaboret $}
|
|
\RCSdefDate{\RCSAABBPrimitiveDate}{$Date: 2007-09-07 17:29:10 +0200 (Ven, 07 sep 2007) $}
|
|
% |
|
|
\ccRefPageBegin
|
|
%%RefPage: end of header, begin of main body
|
|
% +------------------------------------------------------------------------+
|
|
|
|
|
|
\begin{ccRefConcept}{AABBPrimitive}
|
|
|
|
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
|
|
%% \ccHtmlIndexC[concept]{} %% add further index entries
|
|
|
|
\ccDefinition
|
|
|
|
The concept \ccRefName\ describes the requirements for the primitives stored in the AABB data structure. The concept encapsulates a type for the input datum (a geometric object) and an identifier type by which those primitives are referred to. The concept \ccRefName\ also refines the concepts DefaultConstructible and Assignable.
|
|
|
|
\ccTypes
|
|
|
|
\ccNestedType{FT}{Field number type.}
|
|
|
|
\ccNestedType{Datum}{Type of input datum.}
|
|
|
|
\ccNestedType{Id}{Type of identifiers by which the input objects are referred to.}
|
|
|
|
|
|
% variable name
|
|
\ccCreationVariable{primitive}
|
|
|
|
\ccOperations
|
|
|
|
\ccMethod{Datum datum();}
|
|
{Returns the datum (geometric object) wrapped inside the Primitive.}
|
|
|
|
\ccMethod{Id id();}
|
|
{Returns the corresponding identifier. This identifier is only used as a reference for the objects in the output of the \ccc{AABB_tree} methods.}
|
|
|
|
\ccMethod{FT xref();}
|
|
{Returns the \ccc{x} reference coordinate of the primitive used for sorting the primitives. It can be the x coordinate of either one vertex of the geometric object, or of its centroid, or any other reference point taken on the object.}
|
|
|
|
\ccMethod{FT yref();}
|
|
{Returns the \ccc{y} reference coordinate of the primitive used for sorting the primitives.}
|
|
|
|
\ccMethod{FT zref();}
|
|
{Returns the \ccc{z} reference coordinate of the primitive used for sorting the primitives.}
|
|
|
|
% \ccHasModels
|
|
% \ccc{AABB_primitive_base<ID>}
|
|
|
|
\ccSeeAlso
|
|
\ccc{AABB_tree<Traits>}
|
|
|
|
\ccExample
|
|
|
|
The \ccc{Primitive} type can be, e.g., a wrapper around a \ccc{Handle}. Assume for instance that the input objects are the triangle faces of a mesh stored as a \ccc{CGAL::Polyhedron}. The \ccc{Datum} would be a \ccc{Triangle_3} and the \ccc{Id} would be a polyhedron \ccc{Face_handle}. Function \ccc{datum()} can return either a \ccc{Triangle_3} constructed on the fly (memory saving) from the id (face handle) or a \ccc{Triangle_3} stored internally (faster but more memory consuming).
|
|
|
|
\end{ccRefConcept}
|
|
|
|
% +------------------------------------------------------------------------+
|
|
%%RefPage: end of main body, begin of footer
|
|
\ccRefPageEnd
|
|
% EOF
|
|
% +------------------------------------------------------------------------+
|
|
|