vtkTableBasedClipDataSet.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) 2000 - 2009, Lawrence Livermore National Security, LLC
// SPDX-License-Identifier: BSD-3-Clause

#ifndef vtkTableBasedClipDataSet_h
#define vtkTableBasedClipDataSet_h

#include "vtkFiltersGeneralModule.h"    // For export macro
#include "vtkIncrementalPointLocator.h" // For vtkIncrementalPointLocator
#include "vtkUnstructuredGridAlgorithm.h"
#include "vtkWeakPointer.h" // Needed for weak pointer to the vtkIncrementalPointLocator

VTK_ABI_NAMESPACE_BEGIN
class vtkCallbackCommand;
class vtkDataArray;
class vtkImplicitFunction;
class vtkPolyData;

class VTKFILTERSGENERAL_EXPORT vtkTableBasedClipDataSet : public vtkUnstructuredGridAlgorithm
{
public:
  vtkTypeMacro(vtkTableBasedClipDataSet, vtkUnstructuredGridAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkTableBasedClipDataSet* New();

  vtkMTimeType GetMTime() override;


  vtkSetMacro(InsideOut, vtkTypeBool);
  vtkGetMacro(InsideOut, vtkTypeBool);
  vtkBooleanMacro(InsideOut, vtkTypeBool);


  vtkSetMacro(Value, double);
  vtkGetMacro(Value, double);


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


  virtual void SetClipFunction(vtkImplicitFunction*);
  vtkGetObjectMacro(ClipFunction, vtkImplicitFunction);


  vtkSetMacro(GenerateClipScalars, vtkTypeBool);
  vtkGetMacro(GenerateClipScalars, vtkTypeBool);
  vtkBooleanMacro(GenerateClipScalars, vtkTypeBool);

  enum PointTypes
  {
    InputPoint = 0,
    EdgePoint = 1,
    CentroidPoint = 2
  };


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

  static const char* GetPointTypesArrayName() { return "vtkClipPointTypes"; }


  vtkSetClampMacro(MergeTolerance, double, 0.0001, 0.25);
  vtkGetMacro(MergeTolerance, double);


  vtkSetMacro(GenerateClippedOutput, vtkTypeBool);
  vtkGetMacro(GenerateClippedOutput, vtkTypeBool);
  vtkBooleanMacro(GenerateClippedOutput, vtkTypeBool);

  vtkUnstructuredGrid* GetClippedOutput();


  vtkSetClampMacro(OutputPointsPrecision, int, SINGLE_PRECISION, DEFAULT_PRECISION);
  vtkGetMacro(OutputPointsPrecision, int);


  vtkSetClampMacro(BatchSize, unsigned int, 1, VTK_INT_MAX);
  vtkGetMacro(BatchSize, unsigned int);


  void SetLocator(vtkIncrementalPointLocator* locator);
  vtkGetObjectMacro(Locator, vtkIncrementalPointLocator);

protected:
  vtkTableBasedClipDataSet(vtkImplicitFunction* cf = nullptr);
  ~vtkTableBasedClipDataSet() override;

  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int FillInputPortInformation(int port, vtkInformation* info) override;

private:
  void ClipDataSet(vtkDataSet* pDataSet, vtkUnstructuredGrid* outputUG);

  void ClipPolyData(
    vtkPolyData* inputGrid, vtkDataArray* scalars, double isoValue, vtkUnstructuredGrid* outputUG);

  template <class TGrid>
  void ClipTDataSet(
    TGrid* inputGrid, vtkDataArray* scalars, double isoValue, vtkUnstructuredGrid* outputUG);

  template <typename TGrid, typename TInputIdType, bool InsideOut>
  vtkSmartPointer<vtkUnstructuredGrid> ClipTDataSet(
    TGrid* input, vtkDataArray* scalars, double isoValue);

  static void InternalProgressCallbackFunction(vtkObject*, unsigned long, void* clientdata, void*);

  void InternalProgressCallback(vtkAlgorithm* algorithm);

protected:
  vtkTypeBool InsideOut;
  vtkTypeBool GenerateClipScalars;
  vtkTypeBool GenerateClippedOutput;
  bool UseValueAsOffset;
  double Value;
  double MergeTolerance;
  vtkCallbackCommand* InternalProgressObserver;
  vtkImplicitFunction* ClipFunction;
  unsigned int BatchSize;

  int OutputPointsPrecision;

  vtkWeakPointer<vtkIncrementalPointLocator> Locator;

private:
  vtkTableBasedClipDataSet(const vtkTableBasedClipDataSet&) = delete;
  void operator=(const vtkTableBasedClipDataSet&) = delete;

  bool GenerateClipPointTypes;
};

VTK_ABI_NAMESPACE_END
#endif