cgal/BGL/doc_tex/BGL_ref/VertexPointPropertyConstMap...

67 lines
2.0 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}{VertexPointPropertyConstMap}
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
%% \ccHtmlIndexC[concept]{} %% add further index entries
\ccDefinition
The concept \ccRefName\ describes the requirements of a \ccc{PropertyMap}
providing read-only access to the geometric embedding of a graph vertex
(given as the \ccc{CGAL::Vertex_point_property}).
\ccRefines
\ccc{PropertyMap}
\ccTypes
\ccTypedef{boost::readable_property_map_tag category;}
{Indicates that this property is read-only.}
\ccNestedType{value_type;}
{The point type which represent the embeeding of a vertex.}
\ccTypedef{value_type const& reference;}
{The result type of the map operator.}
\ccNestedType{key_type;}
{The type of \ccc{vertex-descriptor} whose embedding is accessed.}
\ccCreation
\ccCreationVariable{pm} %% choose variable name
\ccOperations
\ccMethod
{reference operator[]( key_type const& edge ) const;}
{Returns the geometric embedding of the vertex \ccc{v}.}
\ccHasModels
\ccRefIdfierPage{CGAL::Polyhedron_vertex_point_const_map<Traits> }\\
\ccSeeAlso
\ccRefIdfierPage{CGAL::Vertex_point_property}
\end{ccRefConcept}
% +------------------------------------------------------------------------+
%%RefPage: end of main body, begin of footer
% EOF
% +------------------------------------------------------------------------+