vtk3DLinearGridPlaneCutter.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 vtk3DLinearGridPlaneCutter_h
#define vtk3DLinearGridPlaneCutter_h

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

VTK_ABI_NAMESPACE_BEGIN
class vtkPlane;
class vtkUnstructuredGrid;
class vtkPolyData;

class VTKFILTERSCORE_EXPORT VTK_MARSHALAUTO vtk3DLinearGridPlaneCutter
  : public vtkDataObjectAlgorithm
{
public:

  static vtk3DLinearGridPlaneCutter* New();
  vtkTypeMacro(vtk3DLinearGridPlaneCutter, vtkDataObjectAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual void SetPlane(vtkPlane*);
  vtkGetObjectMacro(Plane, vtkPlane);


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


  VTK_DEPRECATED_IN_9_7_0("No longer needed, points are always merged")
  vtkSetMacro(MergePoints, vtkTypeBool);
  VTK_DEPRECATED_IN_9_7_0("No longer needed, points are always merged")
  vtkGetMacro(MergePoints, vtkTypeBool);
  VTK_DEPRECATED_IN_9_7_0("No longer needed, points are always merged")
  virtual void SetMergePointsOn();
  VTK_DEPRECATED_IN_9_7_0("No longer needed, points are always merged")
  virtual void SetMergePointsOff();


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


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


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

  vtkMTimeType GetMTime() override;


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


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

  int GetNumberOfThreadsUsed() { return this->NumberOfThreadsUsed; }

  bool GetLargeIds() { return this->LargeIds; }

  static bool CanFullyProcessDataObject(vtkDataObject* object);

protected:
  vtk3DLinearGridPlaneCutter();
  ~vtk3DLinearGridPlaneCutter() override;

  vtkPlane* Plane;
  vtkTypeBool MergePoints;
  bool InterpolateAttributes;
  bool ComputeNormals;
  vtkTypeBool GenerateCutScalars;
  int OutputPointsPrecision;
  vtkTypeBool GenerateTriangles;
  bool SequentialProcessing;
  int NumberOfThreadsUsed;
  bool LargeIds; // indicate whether integral ids are large(==true) or not

  // Process the data: input unstructured grid and output polydata
  int ProcessPiece(vtkUnstructuredGrid* input, vtkPlane* plane, vtkPolyData* output);

  int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int FillInputPortInformation(int port, vtkInformation* info) override;

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

VTK_ABI_NAMESPACE_END
#endif