songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

AABB tree (ref manual): added headings

This commit is contained in:
Pierre Alliez 2009-04-30 13:45:11 +00:00
parent b30d94df7c
commit 2c7033c74a
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
AABB_tree/doc_tex/AABB_tree_ref/AABB_tree.tex
View File

@ -38,7 +38,6 @@ The template parameter \ccc{Traits} stands for a traits class which must be a mo
\ccGlue \ccGlue
\ccTypedef{Point_and_primitive} \ccTypedef{Point_and_primitive}
{A pair composed of a Point and a Primitive.} {A pair composed of a Point and a Primitive.}
\ccGlue
%\ccNestedType{AABB}{some nested types} %\ccNestedType{AABB}{some nested types}
@ -63,18 +62,9 @@ The template parameter \ccc{Traits} stands for a traits class which must be a mo
\ccMethod{void clear(void);} \ccMethod{void clear(void);}
{Clears the current tree. } {Clears the current tree. }
\ccMethod{void construct_search_tree();}
{ Constructs the internal search KD-tree used to accelerate the projection queries. The points in the search tree are taken from the primitives by calling the function \ccc{point_on} from the primitive.}
\ccMethod{template <class ConstPointIterator>
void construct_search_tree(ConstPointIterator begin,
ConstPointIterator beyond);}
{ Constructs the internal search KD-tree used to accelerate the projection queries from a specified point set. }
% INTERSECTION TESTS % INTERSECTION TESTS
\ccHeading{Intersection Tests} \ccHeading{Intersection Tests}
\ccMethod{ template <class Query> \ccMethod{ template <class Query>
bool do_intersect(const Query & q);} bool do_intersect(const Query & q);}
{ Returns \ccc{true} iff the query intersects the primitives. Type \ccc{Query} has to be a type for which \ccc{do_intersect} predicates have been defined in \ccc{Traits}.} { Returns \ccc{true} iff the query intersects the primitives. Type \ccc{Query} has to be a type for which \ccc{do_intersect} predicates have been defined in \ccc{Traits}.}
@ -135,6 +125,16 @@ squared_distance(const Point& query,
const Point & hint);} const Point & hint);}
{Returns the squared distance between the query point and all input primitives. See \ccc{closest_point} function for the \ccc{hint} parameter. } {Returns the squared distance between the query point and all input primitives. See \ccc{closest_point} function for the \ccc{hint} parameter. }
\ccHeading{Accelerating the projection queries}
\ccMethod{void construct_search_tree();}
{ Constructs the internal search KD-tree used to accelerate the projection queries. The points in the search tree are taken from the primitives by calling the function \ccc{point_on} from the primitive.}
\ccMethod{template <class ConstPointIterator>
void construct_search_tree(ConstPointIterator begin,
ConstPointIterator beyond);}
{ Constructs the internal search KD-tree used to accelerate the projection queries from a specified point set. }
\ccSeeAlso \ccSeeAlso
\ccc{AABBTraits}, \\ \ccc{AABBTraits}, \\