VTK  9.0.1
vtkConvertSelection.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkConvertSelection.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 =========================================================================*/
15 /*----------------------------------------------------------------------------
16  Copyright (c) Sandia Corporation
17  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
18 ----------------------------------------------------------------------------*/
42 #ifndef vtkConvertSelection_h
43 #define vtkConvertSelection_h
44 
45 #include "vtkFiltersExtractionModule.h" // For export macro
46 #include "vtkSelectionAlgorithm.h"
47 
49 class vtkGraph;
50 class vtkIdTypeArray;
51 class vtkSelection;
52 class vtkSelectionNode;
53 class vtkStringArray;
54 class vtkTable;
56 
57 class VTKFILTERSEXTRACTION_EXPORT vtkConvertSelection : public vtkSelectionAlgorithm
58 {
59 public:
62  void PrintSelf(ostream& os, vtkIndent indent) override;
63 
68 
70 
78  vtkSetMacro(InputFieldType, int);
79  vtkGetMacro(InputFieldType, int);
81 
83 
87  vtkSetMacro(OutputType, int);
88  vtkGetMacro(OutputType, int);
90 
92 
95  virtual void SetArrayName(const char*);
96  virtual const char* GetArrayName();
98 
100 
104  vtkGetObjectMacro(ArrayNames, vtkStringArray);
106 
108 
111  void AddArrayName(const char*);
114 
116 
120  vtkSetMacro(MatchAnyValues, bool);
121  vtkGetMacro(MatchAnyValues, bool);
122  vtkBooleanMacro(MatchAnyValues, bool);
124 
126 
130  vtkSetMacro(AllowMissingArray, bool);
131  vtkGetMacro(AllowMissingArray, bool);
132  vtkBooleanMacro(AllowMissingArray, bool);
134 
136 
141  vtkGetObjectMacro(SelectionExtractor, vtkExtractSelection);
143 
145 
154  vtkSelection* input, vtkDataObject* data, const char* arrayName);
156  vtkSelection* input, vtkDataObject* data, vtkStringArray* arrayNames);
158 
163  static void GetSelectedItems(
164  vtkSelection* input, vtkDataObject* data, int fieldType, vtkIdTypeArray* indices);
165 
167 
172  static void GetSelectedEdges(vtkSelection* input, vtkGraph* data, vtkIdTypeArray* indices);
174  static void GetSelectedCells(vtkSelection* input, vtkDataSet* data, vtkIdTypeArray* indices);
175  static void GetSelectedRows(vtkSelection* input, vtkTable* data, vtkIdTypeArray* indices);
177 
183  vtkStringArray* arrayNames = nullptr, int inputFieldType = -1, bool allowMissingArray = false);
184 
185 protected:
188 
190 
192 
194 
197 
199 
200  int SelectTableFromTable(vtkTable* selTable, vtkTable* dataTable, vtkIdTypeArray* indices);
201 
203 
205 
212 
213 private:
214  vtkConvertSelection(const vtkConvertSelection&) = delete;
215  void operator=(const vtkConvertSelection&) = delete;
216 };
217 
218 #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 void GetSelectedRows(vtkSelection *input, vtkTable *data, vtkIdTypeArray *indices)
int ConvertCompositeDataSet(vtkSelection *input, vtkCompositeDataSet *data, vtkSelection *output)
static vtkSelection * ToGlobalIdSelection(vtkSelection *input, vtkDataObject *data)
static vtkSelection * ToPedigreeIdSelection(vtkSelection *input, vtkDataObject *data)
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)
vtkExtractSelection * SelectionExtractor
static vtkSelection * ToValueSelection(vtkSelection *input, vtkDataObject *data, vtkStringArray *arrayNames)
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)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
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)
int Convert(vtkSelection *input, vtkDataObject *data, vtkSelection *output)
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
int ConvertFromQueryNodeCompositeDataSet(vtkSelectionNode *input, vtkCompositeDataSet *data, vtkSelection *output)
vtkStringArray * ArrayNames
virtual const char * GetArrayName()
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:60
abstract class to specify dataset behavior
Definition: vtkDataSet.h:57
extract a subset from a vtkDataSet.
Base class for graph data types.
Definition: vtkGraph.h:290
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition: vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Superclass for algorithms that produce only Selection as output.
A node in a selection tree.
data object that represents a "selection" in VTK.
Definition: vtkSelection.h:58
a vtkAbstractArray subclass for strings
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:63
@ info
Definition: vtkX3D.h:382
@ port
Definition: vtkX3D.h:453
@ type
Definition: vtkX3D.h:522
@ data
Definition: vtkX3D.h:321