vtkClipDataSet.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 vtkClipDataSet_h
#define vtkClipDataSet_h

#include "vtkFiltersGeneralModule.h" // For export macro
#include "vtkUnstructuredGridAlgorithm.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkCallbackCommand;
class vtkCellArray;
class vtkCellData;
class vtkImplicitFunction;
class vtkIncrementalPointLocator;
class vtkUnsignedCharArray;

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

  static vtkClipDataSet* New();


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


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


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


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


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


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


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

  vtkUnstructuredGrid* GetClippedOutput();


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

  void CreateDefaultLocator();

  vtkMTimeType GetMTime() override;


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


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

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

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

  vtkIncrementalPointLocator* Locator;
  vtkTypeBool InsideOut;
  double Value;
  vtkTypeBool GenerateClipScalars;

  vtkTypeBool GenerateClippedOutput;
  double MergeTolerance;

  // Callback registered with the InternalProgressObserver.
  static void InternalProgressCallbackFunction(vtkObject*, unsigned long, void* clientdata, void*);
  void InternalProgressCallback(vtkAlgorithm* algorithm);
  // The observer to report progress from the internal readers.
  vtkCallbackCommand* InternalProgressObserver;

  // helper functions
  void ClipVolume(vtkDataSet* input, vtkUnstructuredGrid* output);

  int ClipPoints(
    vtkDataSet* input, vtkUnstructuredGrid* output, vtkInformationVector** inputVector);

  bool UseValueAsOffset;
  int OutputPointsPrecision;

  bool StableClipNonLinear = true;

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

  vtkIdType SeparateCellIds(vtkIdType numCells, vtkDataSet* input, std::vector<vtkIdType>& pointMap,
    std::vector<vtkIdType>& clippingCellIds, double clipValue, vtkDataArray* clipScalars,
    std::array<std::vector<vtkIdType>, 2>& intactCellIds);

  void FillIntactCells(vtkDataSet* input, int numOutputs,
    std::array<std::vector<vtkIdType>, 2>& intactCellIds, std::vector<vtkIdType>& pointMap,
    vtkSmartPointer<vtkCellArray> conn[2], vtkCellData* outCD[2], vtkCellData* inCD,
    vtkSmartPointer<vtkUnsignedCharArray> types[2]);
};

VTK_ABI_NAMESPACE_END
#endif