VTK  9.2.6
vtkSelector.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSelector.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
23 #ifndef vtkSelector_h
24 #define vtkSelector_h
25 
26 #include "vtkFiltersExtractionModule.h" // For export macro
27 #include "vtkObject.h"
28 #include "vtkSmartPointer.h" // For vtkSmartPointer
29 
30 #include <set> // for std::set
31 
33 class vtkDataObject;
34 class vtkSelectionNode;
35 class vtkSignedCharArray;
36 class vtkTable;
37 class vtkDataObjectTree;
38 class vtkUniformGridAMR;
39 
40 class VTKFILTERSEXTRACTION_EXPORT vtkSelector : public vtkObject
41 {
42 public:
43  vtkTypeMacro(vtkSelector, vtkObject);
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
55  virtual void Initialize(vtkSelectionNode* node);
56 
60  virtual void Finalize() {}
61 
71  virtual void Execute(vtkDataObject* input, vtkDataObject* output);
72 
74 
78  vtkSetMacro(InsidednessArrayName, std::string);
79  vtkGetMacro(InsidednessArrayName, std::string);
81 protected:
82  vtkSelector();
83  ~vtkSelector() override;
84 
85  // Contains the selection criteria.
86  vtkSelectionNode* Node = nullptr;
87 
88  // Name of the insidedness array added to the output when the selection criteria is
89  // evaluated by this operator.
91 
107  virtual bool ComputeSelectedElements(
108  vtkDataObject* input, vtkSignedCharArray* insidednessArray) = 0;
109 
111  {
114  INHERIT
115  };
116 
124  virtual SelectionMode GetAMRBlockSelection(unsigned int level, unsigned int index);
125 
136  virtual SelectionMode GetBlockSelection(
137  unsigned int compositeIndex, bool isDataObjectTree = true);
138 
143  vtkSmartPointer<vtkSignedCharArray> CreateInsidednessArray(vtkIdType numElems);
144 
149  vtkSmartPointer<vtkSignedCharArray> ComputeCellsContainingSelectedPoints(
150  vtkDataObject* data, vtkSignedCharArray* selectedPoints);
151 
159  void ExpandToConnectedElements(vtkDataObject* output);
160 
161 private:
162  vtkSelector(const vtkSelector&) = delete;
163  void operator=(const vtkSelector&) = delete;
164 
165  void ProcessBlock(vtkDataObject* inputBlock, vtkDataObject* outputBlock, bool forceFalse);
166  void ProcessAMR(vtkUniformGridAMR* input, vtkCompositeDataSet* output);
167  void ProcessDataObjectTree(vtkDataObjectTree* input, vtkDataObjectTree* output,
168  SelectionMode inheritedSelectionMode, unsigned int compositeIndex = 0);
169  void ProcessSelectors(vtkCompositeDataSet* input);
170 
171  std::set<unsigned int> SubsetCompositeIds;
172 };
173 
174 #endif
a node in a vtkSelection the defines the selection criteria.
abstract base class for most VTK objects
Definition: vtkObject.h:62
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
provides implementation for most abstract methods in the superclass vtkCompositeDataSet ...
std::string InsidednessArrayName
Definition: vtkSelector.h:90
int vtkIdType
Definition: vtkType.h:332
abstract superclass for composite (multi-block or AMR) datasets
a simple class to control print indentation
Definition: vtkIndent.h:39
dynamic, self-adjusting array of signed char
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:73
virtual void Finalize()
Does any cleanup of objects created in Initialize.
Definition: vtkSelector.h:60
general representation of visualization data
Definition: vtkDataObject.h:65
a concrete implementation of vtkCompositeDataSet