AABB tree: more on documentation.

AABB_tree/doc_tex/AABB_tree/PkgDescription.tex

@@ -1,6 +1,6 @@
 \begin{ccPkgDescription}{AABB tree \label{Pkg:AABB_tree}}
 %\ccPkgHowToCiteCgal{cgal:}
-\ccPkgSummary{The AABB tree component is a component for efficient intersection detection and projection between, e.g., 3D line queries and sets of 3D triangles or 3D plane queries and sets of 3D segments.}
+\ccPkgSummary{The AABB tree component is devoted to the efficient intersection detection and projection between, e.g., 3D line queries and sets of 3D triangles or 3D plane queries and sets of 3D segments.}
 
 \ccPkgIntroducedInCGAL{3.5}
 \ccPkgLicense{\ccLicenseQPL}

AABB_tree/doc_tex/AABB_tree/main.tex

@@ -1,7 +1,7 @@
 \ccUserChapter{AABB tree\label{AABB_tree}}
 \label{user_chapter_AABB_tree}
 
-\ccChapterAuthor{Pierre Alliez, Laurent Rineau, Jane Tournois, Camille Wormser and Mariette Yvinec}
+\ccChapterAuthor{Pierre Alliez, Laurent Rineau, Stephane Tayeb, Camille Wormser and Mariette Yvinec}
 
 \input{AABB_tree/PkgDescription}
 \minitoc

AABB_tree/doc_tex/AABB_tree_ref/AABBGeomTraits.tex

@@ -29,21 +29,6 @@ ThatConcept
 \ccTypes
 
 
-\ccNestedType{Ray_3}{Ray type.}
-\ccGlue
-\ccNestedType{Line_3}{Line type.}
-\ccGlue
-\ccNestedType{Point_3}{Point type.}
-\ccGlue
-\ccNestedType{Plane_3}{Plane type.}
-\ccGlue
-\ccNestedType{Sphere_3}{Sphere type.}
-\ccGlue
-\ccNestedType{Segment_3}{Segment type.}
-\ccGlue
-\ccNestedType{Triangle_3}{Triangle type. This type should match 
-the type \ccc{TrianglePrimitive::Triangle_3}.}
-\ccGlue
 \ccNestedType{Bbox_3}{Bounding box type.}
 
 \ccNestedType{Do_intersect_3} 

AABB_tree/doc_tex/AABB_tree_ref/AABBPrimitive.tex

@@ -21,14 +21,6 @@
   
 The concept \ccRefName\ describes the requirements for the primitives stored in the AABB data structure. The concept encapsulates a type for the geometric primitives and an identifier type by which those primitives are referred to. The concept \ccRefName\ also refines the concepts DefaultConstructible and Assignable.
 
-\ccConstructor{AABBPrimitive(Handle h);}
-{Constructs a primitive whose geometric primitive is the one h points to.}
-
-% \ccGeneralizes
-
-% ThisConcept \\
-% ThatConcept
-
 \ccTypes
 
 \ccNestedType{Data_type}{The geometric primitive type.}

AABB_tree/doc_tex/AABB_tree_ref/AABBTraits.tex

@@ -33,7 +33,7 @@ The concept \ccRefName\ provides the geometric primitive types and methods for t
 \ccGlue
 \ccNestedType{Bounding_box}{Bounding box type.}
 \ccGlue
-\ccNestedType{Intersection_type}{Typically a point or a \ccc{CGAL::Object} or a container of those.}
+\ccNestedType{Intersection_type}{Type of intersection.}
 
 The following types are required for projection queries.
 
@@ -41,7 +41,7 @@ The following types are required for projection queries.
 \ccGlue
 \ccNestedType{Projection_query}{Type for which projection queries are issued, typically a point.}
 \ccGlue
-\ccNestedType{Projection_return}{Return type of projection queries, typically a point with additional information such as handle.}
+\ccNestedType{Projection_type}{Type of projection.}
 	
 
 \ccCreation
@@ -53,11 +53,12 @@ The following types are required for projection queries.
 
 During the construction of the \ccc{AABB_tree}, the primitives are sorted according to some comparison functions related to the $x$, $y$ or $z$ coordinate axis.
 
-\ccMethod{bool x_less_than(const Primitive & pr1, const Primitive & pr2);}{}
-\ccGlue
-\ccMethod{bool y_less_than(const Primitive & pr1, const Primitive & pr2);}{}
-\ccGlue
-\ccMethod{bool z_less_than(const Primitive & pr1, const Primitive & pr2);}{}
+% TODO: replace by sort function (way much faster as we do not have to sort many times)
+%\ccMethod{bool x_less_than(const Primitive & pr1, const Primitive & pr2);}{}
+%\ccGlue
+%\ccMethod{bool y_less_than(const Primitive & pr1, const Primitive & pr2);}{}
+%\ccGlue
+%\ccMethod{bool z_less_than(const Primitive & pr1, const Primitive & pr2);}{}
 
 
 \ccMethod{Bounding_box compute_bbox(const_primitive_iterator p_begin, const_primitive_iterator p_end);}
@@ -72,6 +73,7 @@ for which the class \ccc{AABB_tree<Traits>} may receive a query.
 \ccMethod{bool do_intersect(const Query & q, const Primitive::Data_type pr);}
 {Returns true if the query intersects the primitive, false otherwise.}
 \ccGlue	
+% TODO: replace return by pair<bool,Intersection_type>
 \ccMethod{bool intersection(const Query & q, 
 const Primitive::Data_type pr, Intersection_type & intersection);}
 {Returns true if the query intersects the primitive, and false otherwise. In the positive, stores the intersection in the last parameter. }
@@ -86,7 +88,8 @@ The following members are required only if projection queries are issued.
                                 const Projection_return & hint);}
 {Returns a sphere centered at \ccc{center} and passing through \ccc{hint}.}
 
-\ccMethod{ bool intersect(const Sphere & sphere, 
+% TODO: replace return by pair<bool,Intersection_type>
+\ccMethod{ bool intersection(const Sphere & sphere, 
                           const Primitive::Data_type p, 
                           const Projection_return  & pr);}
 {Returns true if the primitive is intersecting the ball defined as the interior of the sphere, and false otherwise. In the positive, the point of the primitive closest to the center of the sphere is stored in the last parameter.}

AABB_tree/doc_tex/AABB_tree_ref/AABBTrianglePrimitive.tex

@@ -43,7 +43,7 @@ the triangle type \ccc{GeomTraits::Triangle_3} provided by the geometric traits.
 
 \ccOperations
 
-\ccMethod{Triangle_3 triangle();}
+\ccMethod{Triangle_3 data();}
 {Builds a triangle from the geometric primitive.}
 
 % \ccHasModels

AABB_tree/doc_tex/AABB_tree_ref/intro.tex

@@ -1,6 +1,5 @@
 \ccRefChapter{AABB tree}
-\ccChapterAuthor{Pierre Alliez, Laurent Rineau, 
-Jane Tournois, Camille Wormser and Mariette Yvinec} 
+\ccChapterAuthor{Pierre Alliez, Laurent Rineau, Stephane Tayeb, Camille Wormser and Mariette Yvinec} 
 
 \section{Classified Reference Pages}