vtkGenericClip.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 vtkGenericClip_h
#define vtkGenericClip_h
 
#include "vtkFiltersGenericModule.h" // For export macro
#include "vtkUnstructuredGridAlgorithm.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkImplicitFunction;
 
class vtkPointData;
class vtkCellData;
class vtkIncrementalPointLocator;
 
class VTKFILTERSGENERIC_EXPORT vtkGenericClip : public vtkUnstructuredGridAlgorithm
{
public:
  vtkTypeMacro(vtkGenericClip, vtkUnstructuredGridAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkGenericClip* New();


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


  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();
  virtual int GetNumberOfOutputs();


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

  void CreateDefaultLocator();

  vtkMTimeType GetMTime() override;


  vtkGetStringMacro(InputScalarsSelection);
  void SelectInputScalars(const char* fieldName) { this->SetInputScalarsSelection(fieldName); }
 
protected:
  vtkGenericClip(vtkImplicitFunction* cf = nullptr);
  ~vtkGenericClip() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int FillInputPortInformation(int, vtkInformation*) override;
 
  vtkImplicitFunction* ClipFunction;
 
  vtkIncrementalPointLocator* Locator;
  vtkTypeBool InsideOut;
  double Value;
  vtkTypeBool GenerateClipScalars;
 
  vtkTypeBool GenerateClippedOutput;
  double MergeTolerance;
 
  char* InputScalarsSelection;
  vtkSetStringMacro(InputScalarsSelection);
 
  // Used internal by vtkGenericAdaptorCell::Clip()
  vtkPointData* InternalPD;
  vtkPointData* SecondaryPD;
  vtkCellData* SecondaryCD;
 
private:
  vtkGenericClip(const vtkGenericClip&) = delete;
  void operator=(const vtkGenericClip&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif