vtkCutter.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 vtkCutter_h
#define vtkCutter_h

#include "vtkFiltersCoreModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

#include "vtkContourValues.h" // Needed for inline methods

#define VTK_SORT_BY_VALUE 0
#define VTK_SORT_BY_CELL 1

VTK_ABI_NAMESPACE_BEGIN
class vtkGridSynchronizedTemplates3D;
class vtkImplicitFunction;
class vtkIncrementalPointLocator;
class vtkPlaneCutter;
class vtkRectilinearSynchronizedTemplates;
class vtkSynchronizedTemplates3D;
class vtkSynchronizedTemplatesCutter3D;

class VTKFILTERSCORE_EXPORT VTK_MARSHALAUTO vtkCutter : public vtkPolyDataAlgorithm
{
public:
  vtkTypeMacro(vtkCutter, vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkCutter* New();

  void SetValue(int i, double value) { this->ContourValues->SetValue(i, value); }

  double GetValue(int i) { return this->ContourValues->GetValue(i); }

  double* GetValues() { return this->ContourValues->GetValues(); }

  void GetValues(double* contourValues) { this->ContourValues->GetValues(contourValues); }

  void SetNumberOfContours(int number) { this->ContourValues->SetNumberOfContours(number); }

  vtkIdType GetNumberOfContours() { return this->ContourValues->GetNumberOfContours(); }

  void GenerateValues(int numContours, double range[2])
  {
    this->ContourValues->GenerateValues(numContours, range);
  }

  void GenerateValues(int numContours, double rangeStart, double rangeEnd)
  {
    this->ContourValues->GenerateValues(numContours, rangeStart, rangeEnd);
  }

  vtkMTimeType GetMTime() override;


  virtual void SetCutFunction(vtkImplicitFunction*);
  vtkGetObjectMacro(CutFunction, vtkImplicitFunction);


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


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


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


  vtkSetClampMacro(SortBy, int, VTK_SORT_BY_VALUE, VTK_SORT_BY_CELL);
  vtkGetMacro(SortBy, int);
  void SetSortByToSortByValue() { this->SetSortBy(VTK_SORT_BY_VALUE); }
  void SetSortByToSortByCell() { this->SetSortBy(VTK_SORT_BY_CELL); }
  const char* GetSortByAsString();

  void CreateDefaultLocator();


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

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

  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int FillInputPortInformation(int port, vtkInformation* info) override;
  void UnstructuredGridCutter(vtkDataSet* input, vtkPolyData* output);
  void DataSetCutter(vtkDataSet* input, vtkPolyData* output);
  void StructuredPointsCutter(
    vtkDataSet*, vtkPolyData*, vtkInformation*, vtkInformationVector**, vtkInformationVector*);
  void StructuredGridCutter(vtkDataSet*, vtkPolyData*);
  void RectilinearGridCutter(vtkDataSet*, vtkPolyData*);
  vtkImplicitFunction* CutFunction;
  vtkTypeBool GenerateTriangles;

  vtkNew<vtkSynchronizedTemplates3D> SynchronizedTemplates3D;
  vtkNew<vtkSynchronizedTemplatesCutter3D> SynchronizedTemplatesCutter3D;
  vtkNew<vtkGridSynchronizedTemplates3D> GridSynchronizedTemplates;
  vtkNew<vtkRectilinearSynchronizedTemplates> RectilinearSynchronizedTemplates;
  vtkNew<vtkPlaneCutter> PlaneCutter;

  vtkIncrementalPointLocator* Locator;
  int SortBy;
  vtkNew<vtkContourValues> ContourValues;
  vtkTypeBool GenerateCutScalars;
  int OutputPointsPrecision;

  // Garbage collection method
  void ReportReferences(vtkGarbageCollector*) override;

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

inline const char* vtkCutter::GetSortByAsString()
{
  if (this->SortBy == VTK_SORT_BY_VALUE)
  {
    return "SortByValue";
  }
  else
  {
    return "SortByCell";
  }
}

VTK_ABI_NAMESPACE_END
#endif