VTK  9.3.0
vtkConvertSelection.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
3 // SPDX-License-Identifier: BSD-3-Clause
24 #ifndef vtkConvertSelection_h
25 #define vtkConvertSelection_h
26 
27 #include "vtkFiltersExtractionModule.h" // For export macro
28 #include "vtkSelectionAlgorithm.h"
29 
30 VTK_ABI_NAMESPACE_BEGIN
32 class vtkGraph;
33 class vtkIdTypeArray;
34 class vtkSelection;
35 class vtkSelectionNode;
36 class vtkStringArray;
37 class vtkTable;
39 
40 class VTKFILTERSEXTRACTION_EXPORT vtkConvertSelection : public vtkSelectionAlgorithm
41 {
42 public:
45  void PrintSelf(ostream& os, vtkIndent indent) override;
46 
51 
53 
61  vtkSetMacro(InputFieldType, int);
62  vtkGetMacro(InputFieldType, int);
64 
66 
70  vtkSetMacro(OutputType, int);
71  vtkGetMacro(OutputType, int);
73 
75 
78  virtual void SetArrayName(const char*);
79  virtual const char* GetArrayName();
81 
83 
86  virtual void SetArrayNames(vtkStringArray*);
87  vtkGetObjectMacro(ArrayNames, vtkStringArray);
89 
91 
94  void AddArrayName(const char*);
97 
99 
103  vtkSetMacro(MatchAnyValues, bool);
104  vtkGetMacro(MatchAnyValues, bool);
105  vtkBooleanMacro(MatchAnyValues, bool);
107 
109 
113  vtkSetMacro(AllowMissingArray, bool);
114  vtkGetMacro(AllowMissingArray, bool);
115  vtkBooleanMacro(AllowMissingArray, bool);
117 
119 
124  vtkGetObjectMacro(SelectionExtractor, vtkExtractSelection);
126 
128 
137  vtkSelection* input, vtkDataObject* data, const char* arrayName);
139  vtkSelection* input, vtkDataObject* data, vtkStringArray* arrayNames);
141 
146  static void GetSelectedItems(
147  vtkSelection* input, vtkDataObject* data, int fieldType, vtkIdTypeArray* indices);
148 
150 
155  static void GetSelectedEdges(vtkSelection* input, vtkGraph* data, vtkIdTypeArray* indices);
157  static void GetSelectedCells(vtkSelection* input, vtkDataSet* data, vtkIdTypeArray* indices);
158  static void GetSelectedRows(vtkSelection* input, vtkTable* data, vtkIdTypeArray* indices);
160 
166  vtkStringArray* arrayNames = nullptr, int inputFieldType = -1, bool allowMissingArray = false);
167 
168 protected:
171 
173 
175 
177 
180 
182 
183  int SelectTableFromTable(vtkTable* selTable, vtkTable* dataTable, vtkIdTypeArray* indices);
184 
186 
188 
195 
196 private:
197  vtkConvertSelection(const vtkConvertSelection&) = delete;
198  void operator=(const vtkConvertSelection&) = delete;
199 };
200 
201 VTK_ABI_NAMESPACE_END
202 #endif
Proxy object to connect input/output ports.
abstract superclass for composite (multi-block or AMR) datasets
Convert a selection from one type to another.
static vtkSelection * ToValueSelection(vtkSelection *input, vtkDataObject *data, const char *arrayName)
Static methods for easily converting between selection types.
static void GetSelectedRows(vtkSelection *input, vtkTable *data, vtkIdTypeArray *indices)
Static methods for easily obtaining selected items from a data object.
int ConvertCompositeDataSet(vtkSelection *input, vtkCompositeDataSet *data, vtkSelection *output)
static vtkSelection * ToGlobalIdSelection(vtkSelection *input, vtkDataObject *data)
Static methods for easily converting between selection types.
static vtkSelection * ToPedigreeIdSelection(vtkSelection *input, vtkDataObject *data)
Static methods for easily converting between selection types.
void AddArrayName(const char *)
Convenience methods used by UI.
static vtkSelection * ToIndexSelection(vtkSelection *input, vtkDataObject *data)
Static methods for easily converting between selection types.
static void GetSelectedItems(vtkSelection *input, vtkDataObject *data, int fieldType, vtkIdTypeArray *indices)
Static generic method for obtaining selected items from a data object.
static vtkConvertSelection * New()
static void GetSelectedEdges(vtkSelection *input, vtkGraph *data, vtkIdTypeArray *indices)
Static methods for easily obtaining selected items from a data object.
vtkExtractSelection * SelectionExtractor
static vtkSelection * ToValueSelection(vtkSelection *input, vtkDataObject *data, vtkStringArray *arrayNames)
Static methods for easily converting between selection types.
int ConvertToIndexSelection(vtkSelectionNode *input, vtkDataSet *data, vtkSelectionNode *output)
int SelectTableFromTable(vtkTable *selTable, vtkTable *dataTable, vtkIdTypeArray *indices)
static void GetSelectedCells(vtkSelection *input, vtkDataSet *data, vtkIdTypeArray *indices)
Static methods for easily obtaining selected items from a data object.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void ClearArrayNames()
Convenience methods used by UI.
void SetDataObjectConnection(vtkAlgorithmOutput *in)
A convenience method for setting the second input (i.e.
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
virtual void SetArrayName(const char *)
The output array name for value or threshold selections.
static void GetSelectedVertices(vtkSelection *input, vtkGraph *data, vtkIdTypeArray *indices)
Static methods for easily obtaining selected items from a data object.
static void GetSelectedPoints(vtkSelection *input, vtkDataSet *data, vtkIdTypeArray *indices)
Static methods for easily obtaining selected items from a data object.
int Convert(vtkSelection *input, vtkDataObject *data, vtkSelection *output)
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
int ConvertFromQueryAndBlockSelectionNodeCompositeDataSet(vtkSelectionNode *input, vtkCompositeDataSet *data, vtkSelection *output)
vtkStringArray * ArrayNames
virtual const char * GetArrayName()
The output array name for value or threshold selections.
static vtkSelection * ToSelectionType(vtkSelection *input, vtkDataObject *data, int type, vtkStringArray *arrayNames=nullptr, int inputFieldType=-1, bool allowMissingArray=false)
A generic static method for converting selection types.
virtual void SetArrayNames(vtkStringArray *)
The output array names for value selection.
~vtkConvertSelection() override
int ConvertToBlockSelection(vtkSelection *input, vtkCompositeDataSet *data, vtkSelection *output)
virtual void SetSelectionExtractor(vtkExtractSelection *)
Set/get a selection extractor used in some conversions to obtain IDs.
general representation of visualization data
Definition: vtkDataObject.h:55
abstract class to specify dataset behavior
Definition: vtkDataSet.h:53
extract a subset from a vtkDataSet.
Base class for graph data types.
Definition: vtkGraph.h:281
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition: vtkIndent.h:29
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Superclass for algorithms that produce only Selection as output.
a node in a vtkSelection the defines the selection criteria.
data object that represents a "selection" in VTK.
Definition: vtkSelection.h:50
a vtkAbstractArray subclass for strings
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:59
@ info
Definition: vtkX3D.h:376
@ port
Definition: vtkX3D.h:447
@ type
Definition: vtkX3D.h:516
@ data
Definition: vtkX3D.h:315