mirror of https://github.com/CGAL/cgal
74 lines
2.4 KiB
TeX
74 lines
2.4 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}{Polyhedron_vertex_point_property_map<Traits>}
|
|
|
|
%% add template arg's if necessary
|
|
|
|
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
|
|
%% \ccHtmlIndexC[class]{} %% add further index entries
|
|
\ccDefinition
|
|
|
|
The class \ccRefName\ provides a {\sc Bgl}
|
|
\ccAnchor{http://www.boost.org/libs/property_map/LvaluePropertyMap.html}
|
|
{lvalue property map}
|
|
for the {\em internal property} \ccc{vertex_point}
|
|
required by the \ccc{HalfedgeGraph} concept.
|
|
|
|
It provides lvalue access to the point of a \ccc{Polyhedron_3} vertex.
|
|
|
|
The template parameter \ccc{Traits} is the same \ccc{Traits} parameter of
|
|
\ccc{CGAL::Polyhedron_3<Traits>}.
|
|
|
|
\ccInclude{CGAL/boost/graph/Polyhedron_BGL_properties.h}
|
|
|
|
\ccTypes
|
|
\ccTypedef{boost::lvalue_property_map_tag category;}
|
|
{Indicates that this property is mutable (the property is an lvalue).}
|
|
|
|
\ccTypedef{typename Polyhedron::Point_3 value_type;}
|
|
{The type of the property.}
|
|
|
|
\ccTypedef{value_type& reference;}
|
|
{The result type of the map operator.}
|
|
|
|
\ccTypedef{typename boost::graph_traits< Polyhedron_3<Traits> >::vertex_descriptor key_type;}
|
|
{The key type of the property map: A \ccc{Polyhedron_3::Vertex_handle}.}
|
|
|
|
\ccCreation
|
|
\ccCreationVariable{pm} %% choose variable name
|
|
|
|
\ccConstructor{CGAL::Polyhedron_vertex_point_property_map<Traits>(); }
|
|
{Default constructor.}
|
|
|
|
\ccOperations
|
|
|
|
\ccMethod
|
|
{reference operator[]( key_type const& vertex ) const;}
|
|
{Returns \ccc{vertex->point()}.}
|
|
|
|
\ccIsModel
|
|
\ccAnchor{http://www.boost.org/libs/property_map/LvaluePropertyMap.html}{LvaluePropertyMap}
|
|
|
|
\end{ccRefClass}
|
|
|
|
% +------------------------------------------------------------------------+
|
|
%%RefPage: end of main body, begin of footer
|
|
% EOF
|
|
% +------------------------------------------------------------------------+
|
|
|