1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkRange.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
#ifndef vtkRange_h
#define vtkRange_h
#include "vtkMeta.h"
#include "vtkRangeIterableTraits.h"
#include <iterator>
#include <type_traits>
#include <utility>
namespace vtk
{
VTK_ABI_NAMESPACE_BEGIN
/**
* Generate an iterable STL proxy object for a VTK container.
*
* Currently supports:
*
* - vtkCollection and subclasses (`#include <vtkCollectionRange.h>`):
* - ItemType is the (non-pointer) result type of GetNextItem() if this method
* exists on the collection type, otherwise vtkObject is used.
* - Iterators fulfill the STL InputIterator concept with some exceptions:
* - Const iterators/references are mutable, since vtkObjects are generally
* unusable when const.
* - Value/pointer/reference types are just ItemType*, since:
* - Plain ItemType wouldn't be usable (vtkObjects cannot be
* copied/assigned)
* - ItemType*& references aren't generally desired.
* - ItemType& references are unconventional for vtkObjects.
* - ItemType** pointers are unruly.
*
* - vtkCompositeDataSet (`#include <vtkCompositeDataSetRange.h>`)
* - vtk::CompositeDataSetOptions: None, SkipEmptyNodes.
* - Ex. vtk::Range(compDS, vtk::CompositeDataSetOptions::SkipEmptyNodes);
* - Reverse iteration is not supported. Use vtkCompositeDataIterator directly
* instead for this.
* - Dereferencing the iterator yields a vtk::CompositeDataSetNodeReference
* that provides additional API to get the node's flat index, data object,
* and metadata. See that class's documentation for more information.
*
* - vtkDataObjectTree (`#include <vtkDataObjectTreeRange.h>`)
* - vtk::DataObjectTreeOptions:
* None, SkipEmptyNodes, VisitOnlyLeaves, TraverseSubTree.
* - Ex. vtk::Range(dObjTree, vtk::DataObjectTreeOptions::TraverseSubTree |
* vtk::DataObjectTreeOptions::SkipEmptyNodes);
* - Reverse iteration is not supported. Use vtkDataObjectTreeIterator
* directly instead for this.
* - Dereferencing the iterator yields a vtk::CompositeDataSetNodeReference
* that provides additional API to get the node's flat index, data object,
* and metadata. See that class's documentation for more information.
*
* Usage:
*
* ```
* for (auto item : vtk::Range(myCollection))
* {
* // Use item.
* }
*
* // or:
*
* using Opts = vtk::vtkDataObjectTreeOptions;
* auto range = vtk::Range(dataObjTree,
* Opts::TraverseSubTree | Opts::VisitOnlyLeaves);
* some_algo(range.begin(), range.end());
*
* ```
*/
template <typename IterablePtr, typename... Options>
auto Range(IterablePtr iterable, Options&&... opts) ->
typename detail::IterableTraits<typename detail::StripPointers<IterablePtr>::type>::RangeType
{
using Iterable = typename detail::StripPointers<IterablePtr>::type;
using RangeType = typename detail::IterableTraits<Iterable>::RangeType;
return RangeType{ iterable, std::forward<Options>(opts)... };
}
VTK_ABI_NAMESPACE_END
} // end namespace vtk
#endif // vtkRange_h
// VTK-HeaderTest-Exclude: vtkRange.h
|
