vtkCleanUnstructuredGrid.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) Kitware, Inc.
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkCleanUnstructuredGrid_h
#define vtkCleanUnstructuredGrid_h
 
#include "vtkFiltersGeneralModule.h" // For export macro
#include "vtkSmartPointer.h"
#include "vtkUnstructuredGridAlgorithm.h"
 
VTK_ABI_NAMESPACE_BEGIN
 
class vtkIncrementalPointLocator;
class vtkDataSet;
 
class VTKFILTERSGENERAL_EXPORT vtkCleanUnstructuredGrid : public vtkUnstructuredGridAlgorithm
{
public:
  static vtkCleanUnstructuredGrid* New();
  vtkTypeMacro(vtkCleanUnstructuredGrid, vtkUnstructuredGridAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


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


  vtkSetClampMacro(Tolerance, double, 0.0, 1.0);
  vtkGetMacro(Tolerance, double);


  vtkSetClampMacro(AbsoluteTolerance, double, 0.0, VTK_DOUBLE_MAX);
  vtkGetMacro(AbsoluteTolerance, double);


  virtual void SetLocator(vtkIncrementalPointLocator* locator);
  virtual vtkIncrementalPointLocator* GetLocator();

  void CreateDefaultLocator(vtkDataSet* input = nullptr);

  void ReleaseLocator() { this->SetLocator(nullptr); }


  vtkSetMacro(OutputPointsPrecision, int);
  vtkGetMacro(OutputPointsPrecision, int);


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


  vtkGetMacro(PointDataWeighingStrategy, int);
  vtkSetClampMacro(PointDataWeighingStrategy, int, FIRST_POINT, NUMBER_OF_WEIGHING_TYPES - 1);
 
  enum DataWeighingType
  {
    FIRST_POINT = 0,
    AVERAGING,
    SPATIAL_DENSITY,
    NUMBER_OF_WEIGHING_TYPES
  };
 
protected:
  vtkCleanUnstructuredGrid();
  ~vtkCleanUnstructuredGrid() override;
 
  bool ToleranceIsAbsolute = false;
  double Tolerance = 0.0;
  double AbsoluteTolerance = 1.0;
  bool RemovePointsWithoutCells = false;
  vtkSmartPointer<vtkIncrementalPointLocator> Locator;
  int OutputPointsPrecision = vtkAlgorithm::DEFAULT_PRECISION;
  int PointDataWeighingStrategy = FIRST_POINT;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
private:
  vtkCleanUnstructuredGrid(const vtkCleanUnstructuredGrid&) = delete;
  void operator=(const vtkCleanUnstructuredGrid&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
// VTK-HeaderTest-Exclude: vtkCleanUnstructuredGrid.h