vtkBoundedVolumeSource.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    vtkBoundedVolumeSource.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkBoundedVolumeSource_h
#define vtkBoundedVolumeSource_h

#include "vtkImageAlgorithm.h"
#include "vtkPVVTKExtensionsPointsModule.h" // for export macro
#include "vtkVector.h"                      // for vtkVector

class vtkBoundingBox;

class VTKPVVTKEXTENSIONSPOINTS_EXPORT vtkBoundedVolumeSource : public vtkImageAlgorithm
{
public:
  static vtkBoundedVolumeSource* New();
  vtkTypeMacro(vtkBoundedVolumeSource, vtkImageAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetVector3Macro(Origin, double);
  vtkGetVector3Macro(Origin, double);


  vtkSetVector3Macro(Scale, double);
  vtkGetVector3Macro(Scale, double);

  enum RefinementModes
  {
    USE_RESOLUTION,
    USE_CELL_SIZE
  };

  vtkSetClampMacro(RefinementMode, int, USE_RESOLUTION, USE_CELL_SIZE);
  vtkGetMacro(RefinementMode, int);


  vtkSetVector3Macro(Resolution, int);
  vtkGetVector3Macro(Resolution, int);


  vtkSetMacro(CellSize, double);
  vtkGetMacro(CellSize, double);


  vtkSetClampMacro(Padding, double, 0, VTK_DOUBLE_MAX);
  vtkGetMacro(Padding, double);


  static bool SetImageParameters(
    vtkImageData* image, const vtkBoundingBox& bbox, const vtkVector3i& resolution);
  static bool SetImageParameters(
    vtkImageData* image, const vtkBoundingBox& bbox, const double cellSize);

protected:
  vtkBoundedVolumeSource();
  ~vtkBoundedVolumeSource() override;

  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  void ExecuteDataWithInformation(vtkDataObject* data, vtkInformation* outInfo) override;

  double Origin[3];
  double Scale[3];
  int RefinementMode;
  int Resolution[3];
  double CellSize;
  double Padding;

private:
  vtkBoundedVolumeSource(const vtkBoundedVolumeSource&) = delete;
  void operator=(const vtkBoundedVolumeSource&) = delete;
};

#endif