mirror of https://github.com/CGAL/cgal
AABB tree (ref manual): added headings
This commit is contained in:
parent
b30d94df7c
commit
2c7033c74a
|
|
@ -38,12 +38,11 @@ The template parameter \ccc{Traits} stands for a traits class which must be a mo
|
|||
\ccGlue
|
||||
\ccTypedef{Point_and_primitive}
|
||||
{A pair composed of a Point and a Primitive.}
|
||||
\ccGlue
|
||||
|
||||
%\ccNestedType{AABB}{some nested types}
|
||||
|
||||
\ccCreation
|
||||
\ccCreationVariable{tree} %% variable name
|
||||
\ccCreationVariable{tree} %% variable name
|
||||
|
||||
\ccConstructor{AABB_tree();}{Default constructor.}
|
||||
\ccConstructor{template < class ConstPrimitiveIterator>
|
||||
|
|
@ -63,18 +62,9 @@ The template parameter \ccc{Traits} stands for a traits class which must be a mo
|
|||
\ccMethod{void clear(void);}
|
||||
{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
|
||||
\ccHeading{Intersection Tests}
|
||||
|
||||
|
||||
\ccMethod{ template <class Query>
|
||||
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}.}
|
||||
|
|
@ -135,6 +125,16 @@ squared_distance(const Point& query,
|
|||
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. }
|
||||
|
||||
\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
|
||||
|
||||
\ccc{AABBTraits}, \\
|
||||
|
|
|
|||
Loading…
Reference in New Issue