vtkPVProbeLineFilter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPVProbeLineFilter_h
#define vtkPVProbeLineFilter_h

#include "vtkNew.h"                                      // needed for internal filters
#include "vtkPVVTKExtensionsFiltersParallelDIY2Module.h" //needed for exports
#include "vtkPolyDataAlgorithm.h"

class vtkLineSource;
class vtkProbeLineFilter;
class vtkGarbageCollector;

class VTKPVVTKEXTENSIONSFILTERSPARALLELDIY2_EXPORT vtkPVProbeLineFilter
  : public vtkPolyDataAlgorithm
{
public:
  static vtkPVProbeLineFilter* New();
  vtkTypeMacro(vtkPVProbeLineFilter, vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetMacro(PassCellArrays, bool);
  vtkBooleanMacro(PassCellArrays, bool);
  vtkGetMacro(PassCellArrays, bool);


  vtkSetMacro(PassPointArrays, bool);
  vtkBooleanMacro(PassPointArrays, bool);
  vtkGetMacro(PassPointArrays, bool);


  vtkSetMacro(PassFieldArrays, bool);
  vtkBooleanMacro(PassFieldArrays, bool);
  vtkGetMacro(PassFieldArrays, bool);


  vtkSetMacro(Tolerance, double);
  vtkGetMacro(Tolerance, double);


  vtkSetMacro(ComputeTolerance, bool);
  vtkBooleanMacro(ComputeTolerance, bool);
  vtkGetMacro(ComputeTolerance, bool);


  vtkSetMacro(PassPartialArrays, bool);
  vtkGetMacro(PassPartialArrays, bool);
  vtkBooleanMacro(PassPartialArrays, bool);


  vtkGetMacro(SamplingPattern, int);
  vtkSetClampMacro(SamplingPattern, int, 0, 2);


  vtkGetMacro(LineResolution, int);
  vtkSetMacro(LineResolution, int);


  vtkGetVector3Macro(Point1, double);
  vtkSetVector3Macro(Point1, double);
  vtkGetVector3Macro(Point2, double);
  vtkSetVector3Macro(Point2, double);

protected:
  vtkPVProbeLineFilter();
  ~vtkPVProbeLineFilter() override = default;

  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int FillInputPortInformation(int, vtkInformation*) override;
  void ReportReferences(vtkGarbageCollector* collector) override;

  int SamplingPattern = 0;
  int LineResolution = 1000;
  bool PassPartialArrays = false;
  bool PassCellArrays = false;
  bool PassPointArrays = false;
  bool PassFieldArrays = false;
  bool ComputeTolerance = true;
  double Tolerance = 1.0;
  double Point1[3] = { 0, 0, 0 };
  double Point2[3] = { 1, 1, 1 };

  vtkNew<vtkLineSource> LineSource;
  vtkNew<vtkProbeLineFilter> Prober;

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

#endif // vtkPVProbeLineFilter_h