vtkSelectPolyData.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 vtkSelectPolyData_h
#define vtkSelectPolyData_h
 
#include "vtkFiltersModelingModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"
 
#define VTK_INSIDE_SMALLEST_REGION 0
#define VTK_INSIDE_LARGEST_REGION 1
#define VTK_INSIDE_CLOSEST_POINT_REGION 2
 
#define VTK_GREEDY_EDGE_SEARCH 0
#define VTK_DIJKSTRA_EDGE_SEARCH 1
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCharArray;
class vtkPoints;
class vtkIdList;
 
class VTKFILTERSMODELING_EXPORT vtkSelectPolyData : public vtkPolyDataAlgorithm
{
public:
  static vtkSelectPolyData* New();
 
  vtkTypeMacro(vtkSelectPolyData, vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkSetMacro(GenerateSelectionScalars, vtkTypeBool);
  vtkGetMacro(GenerateSelectionScalars, vtkTypeBool);
  vtkBooleanMacro(GenerateSelectionScalars, vtkTypeBool);
 
 
  vtkSetStringMacro(SelectionScalarsArrayName);
  vtkGetStringMacro(SelectionScalarsArrayName);
 
 
  vtkSetMacro(InsideOut, vtkTypeBool);
  vtkGetMacro(InsideOut, vtkTypeBool);
  vtkBooleanMacro(InsideOut, vtkTypeBool);
 
 
  vtkSetClampMacro(EdgeSearchMode, int, VTK_GREEDY_EDGE_SEARCH, VTK_DIJKSTRA_EDGE_SEARCH);
  vtkGetMacro(EdgeSearchMode, int);
  void SetEdgeSearchModeToGreedy() { this->SetEdgeSearchMode(VTK_GREEDY_EDGE_SEARCH); }
  void SetEdgeSearchModeToDijkstra() { this->SetEdgeSearchMode(VTK_DIJKSTRA_EDGE_SEARCH); }
  const char* GetEdgeSearchModeAsString();
 
 
  virtual void SetLoop(vtkPoints*);
  vtkGetObjectMacro(Loop, vtkPoints);
 
 
  vtkSetVector3Macro(ClosestPoint, double);
  vtkGetVector3Macro(ClosestPoint, double);
 
 
  vtkSetClampMacro(SelectionMode, int, VTK_INSIDE_SMALLEST_REGION, VTK_INSIDE_CLOSEST_POINT_REGION);
  vtkGetMacro(SelectionMode, int);
  void SetSelectionModeToSmallestRegion() { this->SetSelectionMode(VTK_INSIDE_SMALLEST_REGION); }
  void SetSelectionModeToLargestRegion() { this->SetSelectionMode(VTK_INSIDE_LARGEST_REGION); }
  void SetSelectionModeToClosestPointRegion()
  {
    this->SetSelectionMode(VTK_INSIDE_CLOSEST_POINT_REGION);
  }
  const char* GetSelectionModeAsString();
 
 
  vtkSetMacro(GenerateUnselectedOutput, vtkTypeBool);
  vtkGetMacro(GenerateUnselectedOutput, vtkTypeBool);
  vtkBooleanMacro(GenerateUnselectedOutput, vtkTypeBool);
 
  vtkPolyData* GetUnselectedOutput();
 
  vtkAlgorithmOutput* GetUnselectedOutputPort();
 
  vtkPolyData* GetSelectionEdges();
 
  // Overload GetMTime() because we depend on Loop
  vtkMTimeType GetMTime() override;
 
protected:
  vtkSelectPolyData();
  ~vtkSelectPolyData() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  // Compute point list that forms a continuous loop overy the mesh,
  void GreedyEdgeSearch(vtkPolyData* mesh, vtkIdList* edgeIds);
  void DijkstraEdgeSearch(vtkPolyData* mesh, vtkIdList* edgeIds);
 
  // Returns maximum front cell ID
  vtkIdType ComputeTopologicalDistance(
    vtkPolyData* mesh, vtkIdList* edgeIds, vtkIntArray* pointMarks, vtkIntArray* cellMarks);
 
  // Get closest cell to a position that is not at the boundary
  vtkIdType GetClosestCellId(vtkPolyData* mesh, vtkIntArray* pointMarks);
 
  // Starting from maxFrontCell, without crossing the boundary, set all cell and point marks to -1.
  void FillMarksInRegion(vtkPolyData* mesh, vtkIdList* edgePointIds, vtkIntArray* pointMarks,
    vtkIntArray* cellMarks, vtkIdType cellIdInSelectedRegion);
 
  void SetClippedResultToOutput(vtkPointData* originalPointData, vtkCellData* originalCellData,
    vtkPolyData* mesh, vtkIntArray* cellMarks, vtkPolyData* output);
 
  void SetSelectionScalarsToOutput(vtkPointData* originalPointData, vtkCellData* originalCellData,
    vtkPolyData* mesh, vtkIdList* edgeIds, vtkIntArray* pointMarks, vtkPolyData* output);
 
  vtkTypeBool GenerateSelectionScalars;
  char* SelectionScalarsArrayName;
  vtkTypeBool InsideOut;
  int EdgeSearchMode;
  vtkPoints* Loop;
  int SelectionMode;
  double ClosestPoint[3];
  vtkTypeBool GenerateUnselectedOutput;
 
private:
  static void GetPointNeighbors(vtkPolyData* mesh, vtkIdType ptId, vtkIdList* nei);
 
  // Helper function to check if the edge between pointId1 and pointId2 is present in the
  // edgePointIds (as direct neighbors).
  static bool IsBoundaryEdge(vtkIdType pointId1, vtkIdType pointId2, vtkIdList* edgePointIds);
 
  vtkSelectPolyData(const vtkSelectPolyData&) = delete;
  void operator=(const vtkSelectPolyData&) = delete;
};
 
inline const char* vtkSelectPolyData::GetSelectionModeAsString()
{
  if (this->SelectionMode == VTK_INSIDE_SMALLEST_REGION)
  {
    return "InsideSmallestRegion";
  }
  else if (this->SelectionMode == VTK_INSIDE_LARGEST_REGION)
  {
    return "InsideLargestRegion";
  }
  else
  {
    return "InsideClosestPointRegion";
  }
}
 
inline const char* vtkSelectPolyData::GetEdgeSearchModeAsString()
{
  if (this->EdgeSearchMode == VTK_GREEDY_EDGE_SEARCH)
  {
    return "GreedyEdgeSearch";
  }
  else if (this->EdgeSearchMode == VTK_DIJKSTRA_EDGE_SEARCH)
  {
    return "DijkstraEdgeSearch";
  }
  else
  {
    // This should never occur
    return "Invalid";
  }
}
 
VTK_ABI_NAMESPACE_END
#endif