File: vtkConvertSelection.h

package info (click to toggle)
vtk9 9.5.2%2Bdfsg3-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 205,916 kB
  • sloc: cpp: 2,336,565; ansic: 327,116; python: 111,200; yacc: 4,104; java: 3,977; sh: 3,032; xml: 2,771; perl: 2,189; lex: 1,787; makefile: 178; javascript: 165; objc: 153; tcl: 59
file content (196 lines) | stat: -rw-r--r-- 6,289 bytes parent folder | download | duplicates (7)
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
/**
 * @class   vtkConvertSelection
 * @brief   Convert a selection from one type to another
 *
 *
 * vtkConvertSelection converts an input selection from one type to another
 * in the context of a data object being selected. The first input is the
 * selection, while the second input is the data object that the selection
 * relates to.
 *
 * @sa
 * vtkSelection vtkSelectionNode vtkExtractSelection vtkExtractSelectedGraph
 */

#ifndef vtkConvertSelection_h
#define vtkConvertSelection_h

#include "vtkFiltersExtractionModule.h" // For export macro
#include "vtkSelectionAlgorithm.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkCompositeDataSet;
class vtkGraph;
class vtkIdTypeArray;
class vtkSelection;
class vtkSelectionNode;
class vtkStringArray;
class vtkTable;
class vtkExtractSelection;

class VTKFILTERSEXTRACTION_EXPORT vtkConvertSelection : public vtkSelectionAlgorithm
{
public:
  static vtkConvertSelection* New();
  vtkTypeMacro(vtkConvertSelection, vtkSelectionAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  /**
   * A convenience method for setting the second input (i.e. the data object).
   */
  void SetDataObjectConnection(vtkAlgorithmOutput* in);

  ///@{
  /**
   * The input field type.
   * If this is set to a number other than -1, ignores the input selection
   * field type and instead assumes that all selection nodes have the
   * field type specified.
   * This should be one of the constants defined in vtkSelectionNode.h.
   * Default is -1.
   */
  vtkSetMacro(InputFieldType, int);
  vtkGetMacro(InputFieldType, int);
  ///@}

  ///@{
  /**
   * The output selection content type.
   * This should be one of the constants defined in vtkSelectionNode.h.
   */
  vtkSetMacro(OutputType, int);
  vtkGetMacro(OutputType, int);
  ///@}

  ///@{
  /**
   * The output array name for value or threshold selections.
   */
  virtual void SetArrayName(const char*);
  virtual const char* GetArrayName();
  ///@}

  ///@{
  /**
   * The output array names for value selection.
   */
  virtual void SetArrayNames(vtkStringArray*);
  vtkGetObjectMacro(ArrayNames, vtkStringArray);
  ///@}

  ///@{
  /**
   * Convenience methods used by UI
   */
  void AddArrayName(const char*);
  void ClearArrayNames();
  ///@}

  ///@{
  /**
   * When on, creates a separate selection node for each array.
   * Defaults to OFF.
   */
  vtkSetMacro(MatchAnyValues, bool);
  vtkGetMacro(MatchAnyValues, bool);
  vtkBooleanMacro(MatchAnyValues, bool);
  ///@}

  ///@{
  /**
   * When enabled, not finding expected array will not return an error.
   * Defaults to OFF.
   */
  vtkSetMacro(AllowMissingArray, bool);
  vtkGetMacro(AllowMissingArray, bool);
  vtkBooleanMacro(AllowMissingArray, bool);
  ///@}

  ///@{
  /**
   * Set/get a selection extractor used in some conversions to
   * obtain IDs.
   */
  virtual void SetSelectionExtractor(vtkExtractSelection*);
  vtkGetObjectMacro(SelectionExtractor, vtkExtractSelection);
  ///@}

  ///@{
  /**
   * Static methods for easily converting between selection types.
   * NOTE: The returned selection pointer IS reference counted,
   * so be sure to Delete() it when you are done with it.
   */
  static vtkSelection* ToIndexSelection(vtkSelection* input, vtkDataObject* data);
  static vtkSelection* ToGlobalIdSelection(vtkSelection* input, vtkDataObject* data);
  static vtkSelection* ToPedigreeIdSelection(vtkSelection* input, vtkDataObject* data);
  static vtkSelection* ToValueSelection(
    vtkSelection* input, vtkDataObject* data, const char* arrayName);
  static vtkSelection* ToValueSelection(
    vtkSelection* input, vtkDataObject* data, vtkStringArray* arrayNames);
  ///@}

  /**
   * Static generic method for obtaining selected items from a data object.
   * Other static methods (e.g. GetSelectedVertices) call this one.
   */
  static void GetSelectedItems(
    vtkSelection* input, vtkDataObject* data, int fieldType, vtkIdTypeArray* indices);

  ///@{
  /**
   * Static methods for easily obtaining selected items from a data object.
   * The array argument will be filled with the selected items.
   */
  static void GetSelectedVertices(vtkSelection* input, vtkGraph* data, vtkIdTypeArray* indices);
  static void GetSelectedEdges(vtkSelection* input, vtkGraph* data, vtkIdTypeArray* indices);
  static void GetSelectedPoints(vtkSelection* input, vtkDataSet* data, vtkIdTypeArray* indices);
  static void GetSelectedCells(vtkSelection* input, vtkDataSet* data, vtkIdTypeArray* indices);
  static void GetSelectedRows(vtkSelection* input, vtkTable* data, vtkIdTypeArray* indices);
  ///@}

  /**
   * A generic static method for converting selection types.
   * The type should be an integer constant defined in vtkSelectionNode.h.
   */
  static vtkSelection* ToSelectionType(vtkSelection* input, vtkDataObject* data, int type,
    vtkStringArray* arrayNames = nullptr, int inputFieldType = -1, bool allowMissingArray = false);

protected:
  vtkConvertSelection();
  ~vtkConvertSelection() override;

  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  int Convert(vtkSelection* input, vtkDataObject* data, vtkSelection* output);

  int ConvertCompositeDataSet(vtkSelection* input, vtkCompositeDataSet* data, vtkSelection* output);

  int ConvertFromQueryAndBlockSelectionNodeCompositeDataSet(
    vtkSelectionNode* input, vtkCompositeDataSet* data, vtkSelection* output);

  int ConvertToIndexSelection(vtkSelectionNode* input, vtkDataSet* data, vtkSelectionNode* output);

  int SelectTableFromTable(vtkTable* selTable, vtkTable* dataTable, vtkIdTypeArray* indices);

  int ConvertToBlockSelection(vtkSelection* input, vtkCompositeDataSet* data, vtkSelection* output);

  int FillInputPortInformation(int port, vtkInformation* info) override;

  int OutputType;
  int InputFieldType;
  vtkStringArray* ArrayNames;
  bool MatchAnyValues;
  bool AllowMissingArray;
  vtkExtractSelection* SelectionExtractor;

private:
  vtkConvertSelection(const vtkConvertSelection&) = delete;
  void operator=(const vtkConvertSelection&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif