cgal/BGL/doc_tex/BGL_ref/ConnectedPlanarGeometricGra...

61 lines
2.5 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{ccRefConcept}{ConnectedPlanarGeometricGraph}
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
%% \ccHtmlIndexC[concept]{} %% add further index entries
\ccDefinition
The concept \ccRefName\ describes the requirements and constrians of a \ccc{Boost Graph} commonly found in geometric data structures.
This graph is {\em Geometric} meaning that its vertices embeed geometric points (in any geometric dimension) and its edges are {\em implicitely assumed} to be straight line segments (even if a concrete model embeeds a different type of curve).
This graph is {\em Planar} meaning that it \textit{can} be drawn without crossing edges. The planarity requirement is only topological: there is no requirement that the straight line segments implicitely connecting the vertices do not intersect.
The graph is {\em Connected} meaning that any vertex is connected to any other vertex via some path (a sequence of adjacent vertices).
\ccRefines
\ccc{BidirectionalGraph}
\ccc{AdjacencyGraph}
\ccc{EdgeAndVertexListGraph}
\ccTypes
\ccNestedType{TSM}{The type of the surface to simplify}{}
\ccGlue
\ccTypedef{typename Surface_geometric_traits<TSM>::FT FT ;}{The FieldType that represents the collapse cost}
\ccGlue
\ccTypedef{typename Surface_geometric_traits<TSM>::Point Point ;}{The Point type of the surface vertex}
\ccCreation
\ccCreationVariable{g} %% choose variable name
\ccOperations
\ccMethod{boost::get(boost::vertex_point_t(),g,voptional<FT> cost() const;}{The cached cost.}
\ccGlue
\ccMethod{boost::optional<Point> placement() const;}{The cached placement.}
\ccHasModels
\ccRefIdfierPage{CGAL::Triangulated_surface_mesh::Simplification::Edge_collapse::Full_collapse_data<TSM>}.
\end{ccRefConcept}
% +------------------------------------------------------------------------+
%%RefPage: end of main body, begin of footer
% EOF
% +------------------------------------------------------------------------+