vtkPVGeometryFilter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPVGeometryFilter_h
#define vtkPVGeometryFilter_h
 
#include "vtkDataObjectAlgorithm.h"
#include "vtkPVVTKExtensionsFiltersRenderingModule.h" // needed for export macro
#include "vtkParaViewDeprecation.h"                   // for PARAVIEW_DEPRECATED_IN_5_11_0
 
class vtkCallbackCommand;
class vtkCellGrid;
class vtkDataSet;
class vtkExplicitStructuredGrid;
class vtkFeatureEdges;
class vtkGenericDataSet;
class vtkGenericGeometryFilter;
class vtkGeometryFilter;
class vtkHyperTreeGrid;
class vtkImageData;
class vtkUniformGrid;
class vtkInformationIntegerVectorKey;
class vtkInformationVector;
class vtkMultiProcessController;
class vtkOutlineSource;
class vtkPolyData;
class vtkRecoverGeometryWireframe;
class vtkRectilinearGrid;
class vtkStructuredGrid;
class vtkUnstructuredGridBase;
class vtkUnstructuredGridGeometryFilter;
class vtkAMRBox;
class vtkOverlappingAMR;
 
class VTKPVVTKEXTENSIONSFILTERSRENDERING_EXPORT vtkPVGeometryFilter : public vtkDataObjectAlgorithm
{
public:
  static vtkPVGeometryFilter* New();
  vtkTypeMacro(vtkPVGeometryFilter, vtkDataObjectAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkGetMacro(OutlineFlag, int);
 
 
  vtkSetMacro(UseOutline, int);
  vtkGetMacro(UseOutline, int);
 
 
  vtkSetMacro(GenerateFeatureEdges, bool);
  vtkGetMacro(GenerateFeatureEdges, bool);
 
 
  vtkSetMacro(BlockColorsDistinctValues, int);
  vtkGetMacro(BlockColorsDistinctValues, int);
 
 
  PARAVIEW_DEPRECATED_IN_5_11_0(
    "Removed; the backing implementation has done nothing since VTK 9.1.0")
  void SetUseStrips(int) {}
  PARAVIEW_DEPRECATED_IN_5_11_0(
    "Removed; the backing implementation has done nothing since VTK 9.1.0")
  virtual int GetUseStrips() VTK_FUTURE_CONST { return false; }
  PARAVIEW_DEPRECATED_IN_5_11_0(
    "Removed; the backing implementation has done nothing since VTK 9.1.0")
  virtual void UseStripsOn() {}
  PARAVIEW_DEPRECATED_IN_5_11_0(
    "Removed; the backing implementation has done nothing since VTK 9.1.0")
  virtual void UseStripsOff() {}
 
  // Description:
  // Makes set use strips call modified after it changes the setting.
  PARAVIEW_DEPRECATED_IN_5_11_0(
    "Removed; the backing implementation has done nothing since VTK 9.1.0")
  void SetForceUseStrips(int) {}
  PARAVIEW_DEPRECATED_IN_5_11_0(
    "Removed; the backing implementation has done nothing since VTK 9.1.0")
  virtual int GetForceUseStrips() VTK_FUTURE_CONST { return false; }
  PARAVIEW_DEPRECATED_IN_5_11_0(
    "Removed; the backing implementation has done nothing since VTK 9.1.0")
  virtual void ForceUseStripsOn() {}
  PARAVIEW_DEPRECATED_IN_5_11_0(
    "Removed; the backing implementation has done nothing since VTK 9.1.0")
  virtual void ForceUseStripsOff() {}
 
 
  vtkSetMacro(GenerateCellNormals, int);
  vtkGetMacro(GenerateCellNormals, int);
  vtkBooleanMacro(GenerateCellNormals, int);
 
 
  vtkSetMacro(Triangulate, int);
  vtkGetMacro(Triangulate, int);
  vtkBooleanMacro(Triangulate, int);
 
 
  virtual void SetNonlinearSubdivisionLevel(int);
  vtkGetMacro(NonlinearSubdivisionLevel, int);
 
 
  virtual void SetMatchBoundariesIgnoringCellOrder(int);
  vtkGetMacro(MatchBoundariesIgnoringCellOrder, int);
 
 
  virtual void SetController(vtkMultiProcessController*);
  vtkGetObjectMacro(Controller, vtkMultiProcessController);
 
 
  void SetPassThroughCellIds(int);
  vtkGetMacro(PassThroughCellIds, int);
  vtkBooleanMacro(PassThroughCellIds, int);
 
 
  void SetPassThroughPointIds(int);
  vtkGetMacro(PassThroughPointIds, int);
  vtkBooleanMacro(PassThroughPointIds, int);
 
 
  vtkSetMacro(GenerateProcessIds, bool);
  vtkGetMacro(GenerateProcessIds, bool);
  vtkBooleanMacro(GenerateProcessIds, bool);
 
 
  vtkSetMacro(HideInternalAMRFaces, bool);
  vtkGetMacro(HideInternalAMRFaces, bool);
  vtkBooleanMacro(HideInternalAMRFaces, bool);
 
 
  vtkSetMacro(UseNonOverlappingAMRMetaDataForOutlines, bool);
  vtkGetMacro(UseNonOverlappingAMRMetaDataForOutlines, bool);
  vtkBooleanMacro(UseNonOverlappingAMRMetaDataForOutlines, bool);
 
  // These keys are put in the output composite-data metadata for multipieces
  // since this filter merges multipieces together.
  static vtkInformationIntegerVectorKey* POINT_OFFSETS();
  static vtkInformationIntegerVectorKey* VERTS_OFFSETS();
  static vtkInformationIntegerVectorKey* LINES_OFFSETS();
  static vtkInformationIntegerVectorKey* POLYS_OFFSETS();
  static vtkInformationIntegerVectorKey* STRIPS_OFFSETS();
 
protected:
  vtkPVGeometryFilter();
  ~vtkPVGeometryFilter() override;
 
 
  int RequestDataObject(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  virtual int RequestAMRData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector);
  virtual int RequestDataObjectTree(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector);
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  // Create a default executive.
  vtkExecutive* CreateDefaultExecutive() override;
 
  void ExecuteAMRBlock(vtkUniformGrid* input, vtkPolyData* output, const bool extractface[6]);
 
  void ExecuteAMRBlockOutline(
    const double bounds[6], vtkPolyData* output, const bool extractface[6]);
 
  void ExecuteBlock(vtkDataObject* input, vtkPolyData* output, int doCommunicate, int updatePiece,
    int updateNumPieces, int updateGhosts, const int* wholeExtent);
 
  void DataSetExecute(vtkDataSet* input, vtkPolyData* output, int doCommunicate);
  void GenericDataSetExecute(vtkGenericDataSet* input, vtkPolyData* output, int doCommunicate);
 
  void ImageDataExecute(
    vtkImageData* input, vtkPolyData* output, int doCommunicate, int updatePiece, const int* ext);
 
  void StructuredGridExecute(vtkStructuredGrid* input, vtkPolyData* output, int updatePiece,
    int updateNumPieces, int updateGhosts, const int* wholeExtent);
 
  void RectilinearGridExecute(vtkRectilinearGrid* input, vtkPolyData* output, int updatePiece,
    int updateNumPieces, int updateGhosts, const int* wholeExtent);
 
  void UnstructuredGridExecute(
    vtkUnstructuredGridBase* input, vtkPolyData* output, int doCommunicate);
 
  void PolyDataExecute(vtkPolyData* input, vtkPolyData* output, int doCommunicate);
 
  void HyperTreeGridExecute(vtkHyperTreeGrid* input, vtkPolyData* output, int doCommunicate);
 
  void ExplicitStructuredGridExecute(
    vtkExplicitStructuredGrid* input, vtkPolyData* out, int doCommunicate, const int* wholeExtent);
 
  void CellGridExecute(vtkCellGrid* input, vtkPolyData* output, int doCommunicate);
 
  void CleanupOutputData(vtkPolyData* output, int doCommunicate);
 
  void ExecuteCellNormals(vtkPolyData* output, int doCommunicate);
 
  int OutlineFlag;
  int UseOutline;
  int BlockColorsDistinctValues;
  int GenerateCellNormals;
  int Triangulate;
  int NonlinearSubdivisionLevel;
  int MatchBoundariesIgnoringCellOrder = 0;
 
  vtkMultiProcessController* Controller;
  vtkOutlineSource* OutlineSource;
  vtkGeometryFilter* GeometryFilter;
  vtkGenericGeometryFilter* GenericGeometryFilter;
  vtkUnstructuredGridGeometryFilter* UnstructuredGridGeometryFilter;
  vtkRecoverGeometryWireframe* RecoverWireframeFilter;
  vtkFeatureEdges* FeatureEdgesFilter;
 
  int CheckAttributes(vtkDataObject* input);
 
  // Callback for recording progress of internal filters.
  void HandleGeometryFilterProgress(vtkObject* caller, unsigned long, void*);
 
  int FillInputPortInformation(int, vtkInformation*) override;
 
  void ReportReferences(vtkGarbageCollector*) override;
 
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  bool GenerateProcessIds;
  int PassThroughCellIds;
  int PassThroughPointIds;
  bool HideInternalAMRFaces;
  bool UseNonOverlappingAMRMetaDataForOutlines;
  bool GenerateFeatureEdges;
 
private:
  vtkPVGeometryFilter(const vtkPVGeometryFilter&) = delete;
  void operator=(const vtkPVGeometryFilter&) = delete;
 
  void AddCompositeIndex(vtkPolyData* pd, unsigned int index);
 
  void AddBlockColors(vtkDataObject* pd, unsigned int index);
  void AddHierarchicalIndex(vtkPolyData* pd, unsigned int level, unsigned int index);
  class BoundsReductionOperation;
};
 
#endif