VTK  9.0.1
vtkPeriodicFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPeriodicFiler.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 
35 #ifndef vtkPeriodicFilter_h
36 #define vtkPeriodicFilter_h
37 
38 #include "vtkFiltersParallelModule.h" // For export macro
40 
41 #include <set> // For block selection
42 #include <vector> // For pieces number
43 
48 
49 #define VTK_ITERATION_MODE_DIRECT_NB 0 // Generate a user-provided number of periods
50 #define VTK_ITERATION_MODE_MAX 1 // Generate a maximum of periods, i.e. a full period.
51 
52 class VTKFILTERSPARALLEL_EXPORT vtkPeriodicFilter : public vtkMultiBlockDataSetAlgorithm
53 {
54 public:
56  void PrintSelf(ostream& os, vtkIndent indent) override;
57 
59 
64  vtkSetClampMacro(IterationMode, int, VTK_ITERATION_MODE_DIRECT_NB, VTK_ITERATION_MODE_MAX);
65  vtkGetMacro(IterationMode, int);
66  void SetIterationModeToDirectNb() { this->SetIterationMode(VTK_ITERATION_MODE_DIRECT_NB); }
67  void SetIterationModeToMax() { this->SetIterationMode(VTK_ITERATION_MODE_MAX); }
69 
71 
75  vtkSetMacro(NumberOfPeriods, int);
76  vtkGetMacro(NumberOfPeriods, int);
78 
87  virtual void AddIndex(unsigned int index);
88 
92  virtual void RemoveIndex(unsigned int index);
93 
97  virtual void RemoveAllIndices();
98 
99 protected:
101  ~vtkPeriodicFilter() override;
102 
103  // see algorithm for more info
104  int FillInputPortInformation(int port, vtkInformation* info) override;
105 
107 
111  virtual void CreatePeriodicDataSet(
113 
117  virtual void SetPeriodNumber(
118  vtkCompositeDataIterator* loc, vtkCompositeDataSet* output, int nbPeriod) = 0;
119 
120  std::vector<int> PeriodNumbers; // Periods numbers by leaf
122 
123 private:
124  vtkPeriodicFilter(const vtkPeriodicFilter&) = delete;
125  void operator=(const vtkPeriodicFilter&) = delete;
126 
127  int IterationMode;
128  int NumberOfPeriods; // User provided number of periods
129 
130  std::set<vtkIdType> Indices; // Selected indices
131 };
132 
133 #endif
vtkPeriodicFilter::PeriodNumbers
std::vector< int > PeriodNumbers
Definition: vtkPeriodicFilter.h:120
vtkMultiPieceDataSet
composite dataset to encapsulates pieces of dataset.
Definition: vtkMultiPieceDataSet.h:40
vtkPeriodicFilter
A filter to produce mapped periodic multiblock dataset from a single block.
Definition: vtkPeriodicFilter.h:52
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkCompositeDataSet
abstract superclass for composite (multi-block or AMR) datasets
Definition: vtkCompositeDataSet.h:45
vtkMultiBlockDataSetAlgorithm::RequestData
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
Definition: vtkMultiBlockDataSetAlgorithm.h:89
vtkX3D::port
@ port
Definition: vtkX3D.h:453
VTK_ITERATION_MODE_DIRECT_NB
#define VTK_ITERATION_MODE_DIRECT_NB
Definition: vtkPeriodicFilter.h:49
vtkCompositeDataIterator
superclass for composite data iterators
Definition: vtkCompositeDataIterator.h:35
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkPeriodicFilter::SetIterationModeToMax
void SetIterationModeToMax()
Definition: vtkPeriodicFilter.h:67
vtkPeriodicFilter::SetIterationModeToDirectNb
void SetIterationModeToDirectNb()
Definition: vtkPeriodicFilter.h:66
vtkMultiBlockDataSetAlgorithm.h
vtkMultiBlockDataSetAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:73
vtkX3D::info
@ info
Definition: vtkX3D.h:382
VTK_ITERATION_MODE_MAX
#define VTK_ITERATION_MODE_MAX
Definition: vtkPeriodicFilter.h:50
vtkMultiBlockDataSetAlgorithm::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkDataObjectTreeIterator
superclass for composite data iterators
Definition: vtkDataObjectTreeIterator.h:36
vtkPeriodicFilter::ReducePeriodNumbers
bool ReducePeriodNumbers
Definition: vtkPeriodicFilter.h:121
vtkX3D::index
@ index
Definition: vtkX3D.h:252
vtkMultiBlockDataSetAlgorithm
Superclass for algorithms that produce only vtkMultiBlockDataSet as output.
Definition: vtkMultiBlockDataSetAlgorithm.h:32