Replace Object

This commit is contained in:
Efi Fogel 2012-02-12 21:47:15 +00:00
parent 26cb83f92c
commit 9a49162575
3 changed files with 61 additions and 0 deletions

2
.gitattributes vendored
View File

@ -453,6 +453,8 @@ Arrangement_on_surface_2/doc_tex/Arrangement_on_surface_2/fig/unb_dcel.gif -text
Arrangement_on_surface_2/doc_tex/Arrangement_on_surface_2/fig/unb_dcel.pdf -text svneol=unset#application/pdf
Arrangement_on_surface_2/doc_tex/Arrangement_on_surface_2_ref/Arr_algebraic_segment_traits.tex -text
Arrangement_on_surface_2/doc_tex/Arrangement_on_surface_2_ref/Arr_halfedge_direction.tex -text
Arrangement_on_surface_2/doc_tex/Arrangement_on_surface_2_ref/Arr_point_location_result.tex -text
Arrangement_on_surface_2/doc_tex/Arrangement_on_surface_2_ref/Arr_point_location_version.tex -text
Arrangement_on_surface_2/doc_tex/Arrangement_on_surface_2_ref/Arr_rational_function_traits.tex -text
Arrangement_on_surface_2/doc_tex/Arrangement_on_surface_2_ref/arr_do_intersect.tex -text
Arrangement_on_surface_2/doc_tex/Arrangement_on_surface_2_ref/arr_zone.tex -text

View File

@ -0,0 +1,33 @@
\ccRefPageBegin
\begin{ccRefClass}{Arr_point_location_result<Arrangement>}
\label{arr_ref:arr_point_location_result}
\ccDefinition
%============
A binary metafunction to determine the return type of a point-location
or vertical ray-shoot query.
The single parameter of the \ccClassTemplateName{} template must be
an instance of the \ccc{Arrangement<Traits,Dcel>} class template.
\ccInclude{CGAL/Arrpoint_location_result.h}
\ccTypes
%=======
\ccNestedType{Type}{the type of a point-location or vertical ray-shoot query return type.}
\ccSeeAlso
\ccRefConceptPage{ArrangementPointLocation_2}\\
\ccRefConceptPage{ArrangementVerticalRayShoot_2}\\
\ccRefIdfierPage{CGAL::Arr_naive_point_location<Arrangement>}\\
\ccRefIdfierPage{CGAL::Arr_walk_along_line_point_location<Arrangement>}\\
\ccRefIdfierPage{CGAL::Arr_landmarks_point_location<Arrangement,Generator>}\\
\ccRefIdfierPage{CGAL::Arr_trapezoid_ric_point_location<Arrangement>}\\
\ccRefIdfierPage{CGAL_ARR_POINT_LOCATION_VERSION}
\end{ccRefClass}
\ccRefPageEnd

View File

@ -0,0 +1,26 @@
\begin{ccRefMacro}{CGAL_ARR_POINT_LOCATION_VERSION}
\ccDefinition
%============
The macro \ccc{CGAL_ARR_POINT_LOCATION_VERSION} can be used to configure
the point-location query API. In particular, it determines which version
of the result type of the point-location and vertical ray-shooting queries
should be used by models of the concepts \ccc{ArrangementPointLocation_2}
and \ccc{ArrangementVerticalRayShoot_2}, and by the free function
\ccc{locate}. The \ccRefName{} should be defined before any \cgal{} header
is included.
\ccc{CGAL_ARR_POINT_LOCATION_VERSION} == 1, the result type is set to be
\ccc{CGAL::Object}.\\
\ccc{CGAL_ARR_POINT_LOCATION_VERSION} == 2, the result type is set to be
\ccc{boost::variant<Vertex_const_handle,Halfedge_const_handle,Face_const_handle>}, where \ccc{Vertex_const_handle}, \ccc{Halfedge_const_handle}, and
\ccc{Face_const_handle} are the corresponding nested types in an
\ccc{Arrangement_2} instance.
\ccSeeAlso
%============
\ccRefConceptPage{ArrangementPointLocation_2}\\
\ccRefConceptPage{ArrangementVerticalRayShoot_2}\\
\ccRefIdfierPage{CGAL::Arr_point_location_result<Arrangement>}
\end{ccRefMacro}