vtkExtractStructuredGridHelper.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 vtkExtractStructuredGridHelper_h
#define vtkExtractStructuredGridHelper_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
 
// Forward declarations
VTK_ABI_NAMESPACE_BEGIN
class vtkCellData;
class vtkPointData;
class vtkPoints;
VTK_ABI_NAMESPACE_END
 
namespace vtk
{
namespace detail
{
VTK_ABI_NAMESPACE_BEGIN
 
struct vtkIndexMap;
 
VTK_ABI_NAMESPACE_END
} // END namespace detail
} // END namespace vtk
 
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONDATAMODEL_EXPORT vtkExtractStructuredGridHelper : public vtkObject
{
public:
  static vtkExtractStructuredGridHelper* New();
  vtkTypeMacro(vtkExtractStructuredGridHelper, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  // Get & Set Macros
  vtkGetVector6Macro(OutputWholeExtent, int);

  void Initialize(int voi[6], int wholeExt[6], int sampleRate[3], bool includeBoundary);

  bool IsValid() const;

  int GetSize(int dim);

  int GetMappedIndex(int dim, int outIdx);

  int GetMappedIndexFromExtentValue(int dim, int outExtVal);

  int GetMappedExtentValue(int dim, int outExtVal);

  int GetMappedExtentValueFromIndex(int dim, int outIdx);

  void ComputeBeginAndEnd(int inExt[6], int voi[6], int begin[3], int end[3]);

  void CopyPointsAndPointData(int inExt[6], int outExt[6], vtkPointData* pd, vtkPoints* inpnts,
    vtkPointData* outPD, vtkPoints* outpnts);

  void CopyCellData(int inExt[6], int outExt[6], vtkCellData* cd, vtkCellData* outCD);

  static void GetPartitionedVOI(const int globalVOI[6], const int partitionedExtent[6],
    const int sampleRate[3], bool includeBoundary, int partitionedVOI[6]);
  static void GetPartitionedOutputExtent(const int globalVOI[6], const int partitionedVOI[6],
    const int outputWholeExtent[6], const int sampleRate[3], bool includeBoundary,
    int partitionedOutputExtent[6]);
 
protected:
  vtkExtractStructuredGridHelper();
  ~vtkExtractStructuredGridHelper() override;
 
  // Input parameters -- used to reinitialize when data changes.
  int VOI[6];
  int InputWholeExtent[6];
  int SampleRate[3];
  bool IncludeBoundary;
 
  int OutputWholeExtent[6];
  vtk::detail::vtkIndexMap* IndexMap;

  void Invalidate();
 
private:
  vtkExtractStructuredGridHelper(const vtkExtractStructuredGridHelper&) = delete;
  void operator=(const vtkExtractStructuredGridHelper&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif /* VTKEXTRACTSTRUCTUREDGRIDHELPER_H_ */