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

* AABB tree documentation doesn't talk about metafunctions anymore

This commit is contained in:
Philipp Möller 2011-11-16 17:46:28 +00:00
parent 60b309246a
commit b516d75bd5
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
AABB_tree/doc_tex/AABB_tree_ref/AABBGeomTraits.tex
View File

@ -33,11 +33,11 @@ Provides the operators:
where \ccc{Type_1} and \ccc{Type_2} are relevant types
among \ccc{Ray_3}, \ccc{Segment_3}, \ccc{Line_3}, \ccc{Triangle_3}, \ccc{Plane_3} and \ccc{Bbox_3}. Relevant herein means that a line primitive (ray, segment, line) is tested against a planar or solid primitive (plane, triangle, box), and a solid primitive is tested against another solid primitive (box against box). The operator returns \ccc{true} iff \ccc{type_1} and \ccc{type_2} have a non empty intersection.}
\ccNestedType{Intersect_3}{A functor object to construct the intersection between two geometric objects. \\
\ccNestedType{Intersect_3}{A functor to construct the intersection between two geometric objects. \\
Provides the nested type: \\
\ccc{Result<A, B>}; where \ccc{Result<A, B>::Type} is the return type of the \ccc{operator()(A, B)} \\
and the operator: \\
\ccc{Result<A, B>::Type operator()(const A& a, const B& b);} \\ where \ccc{A} and \ccc{B} are any relevant types among \ccc{Ray_3}, \ccc{Segment_3}, \ccc{Line_3}, \ccc{Triangle_3}, \ccc{Plane_3} and \ccc{Bbox_3}. Relevant herein means that a line primitive (ray, segment, line) is tested against a planar or solid primitive (plane, triangle, box).
\ccc{Result<A, B>::Type operator()(const A& a, const B& b);} \\ where \ccc{A} and \ccc{B} are any relevant types among \ccc{Ray_3}, \ccc{Segment_3}, \ccc{Line_3}, \ccc{Triangle_3}, \ccc{Plane_3} and \ccc{Bbox_3}. Relevant herein means that a line primitive (ray, segment, line) is tested against a planar or solid primitive (plane, triangle, box). A model of \ccc{Kernel::Intersect_3} fulfills those requirements.
}
\ccNestedType{Construct_sphere_3}{A functor object to construct the sphere centered at one point and passing through another one. Provides the operator:

4
AABB_tree/doc_tex/AABB_tree_ref/AABBTraits.tex
View File

@ -40,8 +40,8 @@ The concept \ccRefName\ provides the geometric primitive types and methods for t
\ccTypedef{typedef std::pair<Object, Primitive::Id> Object_and_primitive_id;}{}
\end{ccDeprecated}
\ccNestedType{Intersection_and_primitive_id<Query>}{An unary metafunction to aquire the
return type of intersections with an object of type \ccStyle{Query} through the member typedef \ccStyle{Type}.}
\ccNestedType{Intersection_and_primitive_id<Query>}{A nested type to aquire the
a pair of the return type of intersections with an object of type \ccStyle{Query} and a \ccStyle{Primitive::Id} through the member typedef \ccStyle{Type}.}
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:

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

@ -40,8 +40,8 @@ Class \ccRefName\ is a static data structure for efficient intersection and dist
\ccTypedef{typedef std::pair<CGAL::Object, Primitive::Id> Object_and_primitive_id;}{}
\end{ccDeprecated}
\ccGlue
\ccNestedType{Intersection_and_primitive_id<Query>}{An unary metafunction to aquire the
return type of intersections with an object of type \ccStyle{Query} through the member typedef \ccStyle{Type}.}
\ccNestedType{Intersection_and_primitive_id<Query>}{A nested type to aquire the
return type of intersections with an object of type \ccStyle{Query} through the member typedef \ccStyle{Type} equal to \ccStyle{std::pair< >}}
\ccCreation