vtkClipClosedSurface.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 vtkClipClosedSurface_h
#define vtkClipClosedSurface_h

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

VTK_ABI_NAMESPACE_BEGIN
class vtkPlaneCollection;
class vtkUnsignedCharArray;
class vtkDoubleArray;
class vtkIdTypeArray;
class vtkCellArray;
class vtkPointData;
class vtkCellData;
class vtkPolygon;
class vtkIdList;
class vtkCCSEdgeLocator;

enum
{
  VTK_CCS_SCALAR_MODE_NONE = 0,
  VTK_CCS_SCALAR_MODE_COLORS = 1,
  VTK_CCS_SCALAR_MODE_LABELS = 2
};

class VTKFILTERSGENERAL_EXPORT vtkClipClosedSurface : public vtkPolyDataAlgorithm
{
public:

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


  virtual void SetClippingPlanes(vtkPlaneCollection* planes);
  vtkGetObjectMacro(ClippingPlanes, vtkPlaneCollection);


  vtkSetMacro(Tolerance, double);
  vtkGetMacro(Tolerance, double);


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


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


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


  vtkSetClampMacro(ScalarMode, int, VTK_CCS_SCALAR_MODE_NONE, VTK_CCS_SCALAR_MODE_LABELS);
  void SetScalarModeToNone() { this->SetScalarMode(VTK_CCS_SCALAR_MODE_NONE); }
  void SetScalarModeToColors() { this->SetScalarMode(VTK_CCS_SCALAR_MODE_COLORS); }
  void SetScalarModeToLabels() { this->SetScalarMode(VTK_CCS_SCALAR_MODE_LABELS); }
  vtkGetMacro(ScalarMode, int);
  const char* GetScalarModeAsString();


  vtkSetVector3Macro(BaseColor, double);
  vtkGetVector3Macro(BaseColor, double);


  vtkSetVector3Macro(ClipColor, double);
  vtkGetVector3Macro(ClipColor, double);


  vtkSetMacro(ActivePlaneId, int);
  vtkGetMacro(ActivePlaneId, int);


  vtkSetVector3Macro(ActivePlaneColor, double);
  vtkGetVector3Macro(ActivePlaneColor, double);


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


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


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

  vtkPolyData* GetClipFaceOutput();

protected:
  vtkClipClosedSurface();
  ~vtkClipClosedSurface() override;

  vtkPlaneCollection* ClippingPlanes;

  double Tolerance;

  vtkTypeBool PassPointData;
  vtkTypeBool GenerateOutline;
  vtkTypeBool GenerateFaces;
  int ActivePlaneId;
  int ScalarMode;
  double BaseColor[3];
  double ClipColor[3];
  double ActivePlaneColor[3];
  vtkTypeBool InsideOut = false;
  vtkTypeBool GenerateClipFaceOutput = false;

  vtkTypeBool TriangulationErrorDisplay;

  vtkIdList* IdList;

  int ComputePipelineMTime(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector, int requestFromOutputPort, vtkMTimeType* mtime) override;

  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  void ClipLines(vtkPoints* points, vtkDoubleArray* pointScalars, vtkPointData* pointData,
    vtkCCSEdgeLocator* edgeLocator, vtkCellArray* inputCells, vtkCellArray* outputLines,
    vtkCellData* inCellData, vtkCellData* outLineData);

  void ClipAndContourPolys(vtkPoints* points, vtkDoubleArray* pointScalars, vtkPointData* pointData,
    vtkCCSEdgeLocator* edgeLocator, int triangulate, vtkCellArray* inputCells,
    vtkCellArray* outputPolys, vtkCellArray* outputLines, vtkCellData* inCellData,
    vtkCellData* outPolyData, vtkCellData* outLineData);

  static int InterpolateEdge(vtkPoints* points, vtkPointData* pointData,
    vtkCCSEdgeLocator* edgeLocator, double tol, vtkIdType i0, vtkIdType i1, double v0, double v1,
    vtkIdType& i);

  int TriangulatePolygon(vtkIdList* polygon, vtkPoints* points, vtkCellArray* triangles);

  void TriangulateContours(vtkPolyData* data, vtkIdType firstLine, vtkIdType numLines,
    vtkCellArray* outputPolys, const double normal[3]);

  static void BreakPolylines(vtkCellArray* inputLines, vtkCellArray* outputLines,
    vtkUnsignedCharArray* inputScalars, vtkIdType firstLineScalar,
    vtkUnsignedCharArray* outputScalars, const unsigned char color[3]);

  static void CopyPolygons(vtkCellArray* inputPolys, vtkCellArray* outputPolys,
    vtkUnsignedCharArray* inputScalars, vtkIdType firstPolyScalar,
    vtkUnsignedCharArray* outputScalars, const unsigned char color[3]);

  static void BreakTriangleStrips(vtkCellArray* inputStrips, vtkCellArray* outputPolys,
    vtkUnsignedCharArray* inputScalars, vtkIdType firstStripScalar,
    vtkUnsignedCharArray* outputScalars, const unsigned char color[3]);

  static void SqueezeOutputPoints(
    vtkPolyData* output, vtkPoints* points, vtkPointData* pointData, int outputPointDataType);

  static void CreateColorValues(const double color1[3], const double color2[3],
    const double color3[3], unsigned char colors[3][3]);

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

VTK_ABI_NAMESPACE_END
#endif