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
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkCellGridAlgorithm
* @brief Superclass for algorithms that produce only polydata as output
*
*
* vtkCellGridAlgorithm is a convenience class to make writing algorithms
* easier. It is also designed to help transition old algorithms to the new
* pipeline architecture. There are some assumptions and defaults made by this
* class you should be aware of. This class defaults such that your filter
* will have one input port and one output port. If that is not the case
* simply change it with SetNumberOfInputPorts etc. See this class
* constructor for the default. This class also provides a FillInputPortInfo
* method that by default says that all inputs will be PolyData. If that
* isn't the case then please override this method in your subclass.
*/
#ifndef vtkCellGridAlgorithm_h
#define vtkCellGridAlgorithm_h
#include "vtkAlgorithm.h"
#include "vtkCellGrid.h" // makes things a bit easier
#include "vtkCommonExecutionModelModule.h" // For export macro
VTK_ABI_NAMESPACE_BEGIN
class vtkDataSet;
class vtkCellAttribute;
class vtkCellGrid;
class VTKCOMMONEXECUTIONMODEL_EXPORT vtkCellGridAlgorithm : public vtkAlgorithm
{
public:
static vtkCellGridAlgorithm* New();
vtkTypeMacro(vtkCellGridAlgorithm, vtkAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@{
/**
* Get the output data object for a port on this algorithm.
*/
vtkCellGrid* GetOutput();
vtkCellGrid* GetOutput(int);
virtual void SetOutput(vtkDataObject* d);
///@}
/**
* see vtkAlgorithm for details
*/
vtkTypeBool ProcessRequest(
vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
// this method is not recommended for use, but lots of old style filters
// use it
vtkDataObject* GetInput();
vtkDataObject* GetInput(int port);
vtkCellGrid* GetPolyDataInput(int port);
///@{
/**
* Assign a data object as input. Note that this method does not
* establish a pipeline connection. Use SetInputConnection() to
* setup a pipeline connection.
*/
void SetInputData(vtkDataObject*);
void SetInputData(int, vtkDataObject*);
///@}
///@{
/**
* Assign a data object as input. Note that this method does not
* establish a pipeline connection. Use AddInputConnection() to
* setup a pipeline connection.
*/
void AddInputData(vtkDataObject*);
void AddInputData(int, vtkDataObject*);
///@}
// clang-format off
///@{
/**
* Set an input cell-attribute that this algorithm will process.
* Specifically the \a idx-th cell-attribute for this algorithm
* (starting from 0) will be taken from the cell-grid at the given
* \a port and \a connection and must have the given \a name.
*
* Note that SetInputAttributeToProcess() simply invokes
* SetInputArrayToProcess() with a cell-centered array-name;
* the same information keys are used to mark input attributes
* as input arrays. This means that you may use ParaView's
* existing ArrayListDomain to call SetInputArrayToProcess
* with cell-grid algorithms to indicate cell-attributes rather
* than vtkAbstractArrays on vtkCellData.
*/
virtual void SetInputAttributeToProcess(int idx, int port, int connection, const char* name);
/**
* Fetch a vtkCellAttribute that matches a cell-centered array
* specified by calling SetInputAttributeToProcess().
* (Note that SetInputAttributeToProcess() simply invokes
* SetInputArrayToProcess() with a cell-centered array-name).
*
* If you call a variant that accepts an \a association, it
* will always be set to FIELD_ASSOCIATION_CELLS upon success.
*/
vtkCellAttribute* GetInputCellAttributeToProcess(int idx, int connection, vtkInformationVector** inputVector);
vtkCellAttribute* GetInputCellAttributeToProcess(int idx, int connection, vtkInformationVector** inputVector, int& association);
vtkCellAttribute* GetInputCellAttributeToProcess(int idx, vtkCellGrid* input);
vtkCellAttribute* GetInputCellAttributeToProcess(int idx, vtkCellGrid* input, int& association);
///@}
// clang-format on
protected:
vtkCellGridAlgorithm();
~vtkCellGridAlgorithm() override;
// convenience method
virtual int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
/**
* This is called by the superclass.
* This is the method you should override.
*/
virtual int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
/**
* This is called by the superclass.
* This is the method you should override.
*/
virtual int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
virtual int RequestUpdateTime(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
// see algorithm for more info
int FillOutputPortInformation(int port, vtkInformation* info) override;
int FillInputPortInformation(int port, vtkInformation* info) override;
private:
vtkCellGridAlgorithm(const vtkCellGridAlgorithm&) = delete;
void operator=(const vtkCellGridAlgorithm&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|
