CGAL 6.1 - Quadtrees, Octrees, and Orthtrees

Loading...
Searching...
No Matches
List of all members
OrthtreeTraits Concept Reference
Reference Manual » Concepts

## Definition

The concept `OrthtreeTraits` defines the requirements for the template parameter of the `CGAL::Orthtree` class.

Has models
  `CGAL::Orthtree_traits_point<GeomTraits, PointRange, PointMap, dimension>`
  `CGAL::Orthtree_traits_face_graph<PolygonMesh, VPM>`
  `CGAL::Orthtree_traits_base<K, dimension>`

## Types
using | Node_index = unspecified_type
| An integer type for nodes.
using | FT = unspecified_type
| The number type of the Cartesian coordinates of types `Point_d`
using | Point_d = unspecified_type
| Point type.
using | Bbox_d = unspecified_type
| Bounding box type. Must be constructible from a pair of `Point_d` objects.
using | Cartesian_const_iterator_d = unspecified_type
| A random access iterator type to enumerate the Cartesian coordinates of a point of type `Point_d`.
using | Adjacency = unspecified_type
| Specify the adjacency directions.
using | Construct_root_node_bbox = unspecified_type
| Functor with an operator to create the bounding box of the root node.
using | Construct_point_d = unspecified_type
| Functor with an operator to construct a `Point_d` from an initializer list of type `FT`.
constexpr int | dimension
| Dimension.

## Operations
Construct_root_node_bbox | construct_root_node_bbox_object () const
| constructs an object of type `Construct_root_node_bbox`.
Construct_point_d | construct_point_d_object () const
| constructs an object of type `Construct_point_d`.

## Member Typedef Documentation

## ◆ Construct_point_d

using OrthtreeTraits::Construct_point_d = unspecified_type

Functor with an operator to construct a `Point_d` from an initializer list of type `FT`.

Provides the operator: `Point_d operator()(arg1, arg2,...)`

For trees which use a different kernel for the bounding box type, the return type of this functor must match the kernel used by the bounding box type and not that of the contents.

## ◆ Construct_root_node_bbox

using OrthtreeTraits::Construct_root_node_bbox = unspecified_type

Functor with an operator to create the bounding box of the root node.

Provides the operator: `Bbox_d operator()()`

The bounding box must enclose all elements contained by the tree. It may be tight-fitting. The orthtree constructor produces a bounding box surrounding this region. For traits which assign no data to each node, this can be defined to return a fixed region.