vtkPeriodicFilter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkPeriodicFilter_h
#define vtkPeriodicFilter_h
 
#include "vtkFiltersParallelModule.h" // For export macro
#include "vtkMultiBlockDataSetAlgorithm.h"
 
#include <set>    // For block selection
#include <vector> // For pieces number
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCompositeDataIterator;
class vtkCompositeDataSet;
class vtkDataObjectTreeIterator;
class vtkMultiPieceDataSet;
 
#define VTK_ITERATION_MODE_DIRECT_NB 0 // Generate a user-provided number of periods
#define VTK_ITERATION_MODE_MAX 1       // Generate a maximum of periods, i.e. a full period.
 
class VTKFILTERSPARALLEL_EXPORT vtkPeriodicFilter : public vtkMultiBlockDataSetAlgorithm
{
public:
  vtkTypeMacro(vtkPeriodicFilter, vtkMultiBlockDataSetAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkSetClampMacro(IterationMode, int, VTK_ITERATION_MODE_DIRECT_NB, VTK_ITERATION_MODE_MAX);
  vtkGetMacro(IterationMode, int);
  void SetIterationModeToDirectNb() { this->SetIterationMode(VTK_ITERATION_MODE_DIRECT_NB); }
  void SetIterationModeToMax() { this->SetIterationMode(VTK_ITERATION_MODE_MAX); }
 
 
  vtkSetMacro(NumberOfPeriods, int);
  vtkGetMacro(NumberOfPeriods, int);
 
  virtual void AddIndex(unsigned int index);
 
  virtual void RemoveIndex(unsigned int index);
 
  virtual void RemoveAllIndices();
 
protected:
  vtkPeriodicFilter();
  ~vtkPeriodicFilter() override;
 
  // see algorithm for more info
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  virtual void CreatePeriodicDataSet(
    vtkCompositeDataIterator* loc, vtkCompositeDataSet* output, vtkCompositeDataSet* input) = 0;
 
  virtual void SetPeriodNumber(
    vtkCompositeDataIterator* loc, vtkCompositeDataSet* output, int nbPeriod) = 0;
 
  std::vector<int> PeriodNumbers; // Periods numbers by leaf
  bool ReducePeriodNumbers;
 
private:
  vtkPeriodicFilter(const vtkPeriodicFilter&) = delete;
  void operator=(const vtkPeriodicFilter&) = delete;
 
  int IterationMode;
  int NumberOfPeriods; // User provided number of periods
 
  std::set<vtkIdType> Indices; // Selected indices
};
 
VTK_ABI_NAMESPACE_END
#endif