CGAL users discussion list

[Andreas Fabri <>]

Wesley Smith wrote:
> Hi,
> I've just started using CGAL and am having a hard time navigating the
> documentation and code.  I'm just trying to do some simple things
> right now.  I have a Voronoi_diagram_2 and am doing the following:
>
> Edge_iterator edge_iter = voronoi->edges_begin();
>
> I can't seem to find any documentation or code that describes what
> Edge_iterator points to or what kinds of functions it has available.
> Any pointers are greatly appreciated.
>
> thanks,
> wes


It would be good to understand what can go wrong through navigation.
So let me trace a path from the table of contents of the entire manual
to the documentation of the Halfedge type.

If this is counterintuitive please let us know, as user feedback
is helpful.


From the main manual page
http://www.cgal.org/Manual/3.3/doc_html/cgal_manual/contents.html

when clicking on "IX Voronoi Diagrams"  you get here:
http://www.cgal.org/Manual/3.3/doc_html/cgal_manual/contents.html#part_IX
where you can read:

33   2D Voronoi Diagram Adaptor                 User Manual             
Reference Manual

When clicking on "Reference Manual" you get here:
http://www.cgal.org/Manual/3.3/doc_html/cgal_manual/Voronoi_diagram_2_ref/Chapter_intro.html

When clicking on  "CGAL::Voronoi_diagram_2<DG,AT,AP>" you get here:
http://www.cgal.org/Manual/3.3/doc_html/cgal_manual/Voronoi_diagram_2_ref/Class_Voronoi_diagram_2.html#Cross_link_anchor_1039

where the method you use is documented:

  Halfedge_iterator       vd.halfedges_begin ()          Starts at an 
arbitrary Voronoi halfedge.

and where the type is explained as follows:

  Voronoi_diagram_2<DG,AT,AP>::Halfedge_iterator
        A type for an iterator over Voronoi halfedges. Halfedges are oriented 
and come in pairs. Its value type is Halfedge.


When clicking on "Halfedge" you get here, where you can see what you can do 
with a half edge:

http://www.cgal.org/Manual/3.3/doc_html/cgal_manual/Voronoi_diagram_2_ref/Class_Voronoi_diagram_2-DG-AT-AP---Halfedge.html#Cross_link_anchor_1040



So where did you get lost, and why couldn't you find it yourself ?


Best regards,

andreas