mirror of https://github.com/CGAL/cgal
91 lines
3.9 KiB
TeX
91 lines
3.9 KiB
TeX
%% Copyright (c) 2004 SciSoft. All rights reserved.
|
|
%%
|
|
%% This file is part of CGAL (www.cgal.org); you may redistribute it under
|
|
%% the terms of the Q Public License version 1.0.
|
|
%% See the file LICENSE.QPL distributed with CGAL.
|
|
%%
|
|
%% Licensees holding a valid commercial license may use this file in
|
|
%% accordance with the commercial license agreement provided with the software.
|
|
%%
|
|
%% This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
|
|
%% WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
|
|
%%
|
|
%%
|
|
%%
|
|
%% Author(s) : Fernando Cacciola <fernando_cacciola@hotmail.com>
|
|
|
|
|
|
\begin{ccRefClass}{boost::graph_traits< CGAL::Polyhedron_3<Traits> const>}
|
|
|
|
%% add template arg's if necessary
|
|
|
|
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
|
|
%% \ccHtmlIndexC[class]{} %% add further index entries
|
|
\ccDefinition
|
|
|
|
The class \ccRefName\ and corresponding free-function overloads provides the specializations for \ccc{CGAL::Polyhedron_3 const} required to make it a {\em read-only} model of the
|
|
\ccAnchor{http://www.boost.org/libs/graph/doc/graph_concepts.html}{Boost Graph}
|
|
concepts:\\
|
|
\ccAnchor{http://www.boost.org/libs/graph/doc/BidirectionalGraph.html}{BidirectionalGraph}\\
|
|
\ccAnchor{http://www.boost.org/libs/graph/doc/AdjacencyGraph.html}{AdjacencyGraph}\\
|
|
\ccAnchor{http://www.boost.org/libs/graph/doc/EdgeAndVertexListGraph.html}{EdgeAndVertexListGraph}\\
|
|
|
|
\ccInclude{CGAL/boost/graph/Polyhedron_graph_traits.h}
|
|
|
|
\ccTypes
|
|
\ccTypedef{typename CGAL::Polyhedron_3::Vertex_const_handle vertex_descriptor;}
|
|
{The vertex descriptor.}
|
|
|
|
\ccTypedef{typename CGAL::Polyhedron_3::Halfedge_const_handle edge_descriptor;}
|
|
{The edges descriptor.}
|
|
|
|
\ccNestedType{vertex_iterator;}{A \ccc{CGAL::Polyhedron_3::Vertex_const_iterator}
|
|
wrapped to return a \ccc{CGAL::Polyhedron_3::Vertex_const_handle} when dereferenced.}{}
|
|
|
|
\ccNestedType{edge_iterator;}{A \ccc{CGAL::Polyhedron_3::Halfedge_const_iterator}
|
|
wrapped to return a \ccc{CGAL::Polyhedron_3::Halfedge_const_handle} when dereferenced.}{}
|
|
|
|
\ccNestedType{in_edge_iterator;}{An edge iterator which only iterates over
|
|
the incoming \ccc{halfedges} around a vertex.\\It correspons to a
|
|
\ccc{CGAL::Polyhedron_3::Halfedge_around_vertex_const_circulator}
|
|
wrapped to return an \ccc{CGAL::Polyhedron_3::Halfege_const_handle} when dereferenced}{}
|
|
|
|
\ccNestedType{out_edge_iterator;}{An edge iterator which only iterates over
|
|
the outgoing halfedges around a vertex. It correspons to a
|
|
\ccc{CGAL::Polyhedron_3::Halfedge_around_vertex_const_circulator}
|
|
wrapped to return an \ccc{CGAL::Polyhedron_3::Halfege_const_handle} referring to the
|
|
{\em opposite halfege} when dereferenced.}{}
|
|
|
|
\ccTypedef{boost::directed_tag directed_category;}
|
|
{Indicates this is a directed graph.}
|
|
|
|
\ccTypedef{boost::disallow_parallel_edge_tag edge_parallel_category;}
|
|
{Indicates this graph does not support multiedges.}
|
|
|
|
\ccTypedef{boost::bidirectional_graph_tag traversal_category;}
|
|
{Indicates this graph is bidirectional.}
|
|
|
|
\ccTypedef{typename Polyhedron_3::size_type vertices_size_type;}
|
|
{The size tye of the vertex list.}
|
|
|
|
\ccTypedef{typename Polyhedron_3::size_type edges_size_type;}
|
|
{The size tye of the edge list.}
|
|
|
|
\ccTypedef{typename Polyhedron_3::size_type degree_size_type;}
|
|
{The size tye of the adjacency list.}
|
|
|
|
\ccIsModel
|
|
\ccAnchor{http://www.boost.org/libs/graph/doc/BidirectionalGraph.html}{BidirectionalGraph}\\
|
|
\ccAnchor{http://www.boost.org/libs/graph/doc/AdjacencyGraph.html}{AdjacencyGraph}\\
|
|
\ccAnchor{http://www.boost.org/libs/graph/doc/EdgeAndVertexListGraph.html}{EdgeAndVertexListGraph}\\
|
|
|
|
\ccSeeAlso
|
|
|
|
\end{ccRefClass}
|
|
|
|
% +------------------------------------------------------------------------+
|
|
%%RefPage: end of main body, begin of footer
|
|
% EOF
|
|
% +------------------------------------------------------------------------+
|
|
|