vtkAngularPeriodicFilter.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 vtkAngularPeriodicFilter_h
#define vtkAngularPeriodicFilter_h
 
#include "vtkFiltersParallelModule.h" // For export macro
#include "vtkPeriodicFilter.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDataSetAttributes;
class vtkMultiPieceDataSet;
class vtkPointSet;
 
#define VTK_ROTATION_MODE_DIRECT_ANGLE 0 // Use user-provided angle
#define VTK_ROTATION_MODE_ARRAY_VALUE 1  // Use array from input data as angle
 
class VTKFILTERSPARALLEL_EXPORT vtkAngularPeriodicFilter : public vtkPeriodicFilter
{
public:
  static vtkAngularPeriodicFilter* New();
  vtkTypeMacro(vtkAngularPeriodicFilter, vtkPeriodicFilter);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkSetMacro(ComputeRotationsOnTheFly, bool);
  vtkGetMacro(ComputeRotationsOnTheFly, bool);
  vtkBooleanMacro(ComputeRotationsOnTheFly, bool);
 
 
  vtkSetClampMacro(
    RotationMode, int, VTK_ROTATION_MODE_DIRECT_ANGLE, VTK_ROTATION_MODE_ARRAY_VALUE);
  vtkGetMacro(RotationMode, int);
  void SetRotationModeToDirectAngle() { this->SetRotationMode(VTK_ROTATION_MODE_DIRECT_ANGLE); }
  void SetRotationModeToArrayValue() { this->SetRotationMode(VTK_ROTATION_MODE_ARRAY_VALUE); }
 
 
  vtkSetMacro(RotationAngle, double);
  vtkGetMacro(RotationAngle, double);
 
 
  vtkSetStringMacro(RotationArrayName);
  vtkGetStringMacro(RotationArrayName);
 
 
  vtkSetClampMacro(RotationAxis, int, 0, 2);
  vtkGetMacro(RotationAxis, int);
  void SetRotationAxisToX();
  void SetRotationAxisToY();
  void SetRotationAxisToZ();
 
 
  vtkSetVector3Macro(Center, double);
  vtkGetVector3Macro(Center, double);
 
protected:
  vtkAngularPeriodicFilter();
  ~vtkAngularPeriodicFilter() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  vtkDataArray* TransformDataArray(
    vtkDataArray* inputArray, double angle, bool useCenter = true, bool normalize = false);
 
  void AppendPeriodicPiece(
    double angle, vtkIdType iPiece, vtkDataObject* inputNode, vtkMultiPieceDataSet* multiPiece);
 
  void SetPeriodNumber(
    vtkCompositeDataIterator* loc, vtkCompositeDataSet* output, int nbPeriod) override;
 
  void ComputePeriodicMesh(vtkPointSet* dataset, vtkPointSet* rotatedDataset, double angle);
 
  void ComputeAngularPeriodicData(
    vtkDataSetAttributes* data, vtkDataSetAttributes* rotatedData, double angle);
 
  void CreatePeriodicDataSet(vtkCompositeDataIterator* loc, vtkCompositeDataSet* output,
    vtkCompositeDataSet* input) override;
 
  virtual void GeneratePieceName(vtkCompositeDataSet* input, vtkCompositeDataIterator* inputLoc,
    vtkMultiPieceDataSet* output, vtkIdType outputId);
 
private:
  vtkAngularPeriodicFilter(const vtkAngularPeriodicFilter&) = delete;
  void operator=(const vtkAngularPeriodicFilter&) = delete;
 
  bool ComputeRotationsOnTheFly;
 
  int RotationMode;
  char*
    RotationArrayName; // user-provided array name to use as angle, for ROTATION_MODE_ARRAY_VALUE
 
  // Transform parameters
  double RotationAngle;
  int RotationAxis; // Axis to rotate around, 0 for X, 1 for Y, 2 for Z
  double Center[3]; // Center of rotation
};
 
VTK_ABI_NAMESPACE_END
#endif