CGAL 6.2 - 2D Arrangements: CGAL::Arr_face_index_map< Arrangement_ > Class Template Reference

CGAL 6.2 - 2D Arrangements

Loading...
Searching...
No Matches
List of all members
CGAL::Arr_face_index_map< Arrangement_ > Class Template Reference
Reference Manual

`#include <CGAL/Arr_face_index_map.h>`

## Inherits from

Arrangement_::Observer.

## Definition

template<typename Arrangement_>
class CGAL::Arr_face_index_map< Arrangement_ >

`Arr_face_index_map` maintains a mapping of face handles of an attached arrangement object to indices (of type `unsigned int`).

This class template is a model of the concept `ReadablePropertyMap`. A mapping between face handles and indices enables convenient usage of property-map classes supplied by `boost`. For example, the property-map class templates `boost::vector_property_map`, which is based on `std::vector`, and `boost::iterator_property_map`, which can be used to implement a property map based on a native C++ array, require the user to supply a mapping such as `Arr_face_index_map`.

As new faces might be inserted into the attached arrangement, and existing faces might be removed, the notification mechanism is used to dynamically maintain the mapping of face handles to indices.

Is model of
  `DefaultConstructible`
  `CopyConstructible`
  `Assignable`
  `ReadablePropertyMap`

See also
  `Arr_vertex_index_map<Arrangement>`

Examples
  Arrangement_on_surface_2/bgl_dual_adapter.cpp.

## Types
typedef Arrangement_ | Arrangement_2
| the type of the attached arrangement.
typedef Arrangement_2::Base_aos | Base_aos
typedef boost::readable_property_map_tag | category
typedef unsigned int | value_type
typedef unsigned int | reference
typedef Face_handle | key_type
typedef Base_aos::Face_handle | Face_handle
| The face handle type.
typedef Unique_hash_map< Face_handle, value_type > | Index_map
| The type of mapping of faces to indices.

## Creation
| Arr_face_index_map ()
| constructs a map that is unattached to any arrangement instance.
| Arr_face_index_map (Base_aos &arr)
| constructs a map and attaches it to the given arrangement `arr`.