vtkExtractSelection.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 vtkExtractSelection_h
#define vtkExtractSelection_h

#include "vtkDataObjectAlgorithm.h"
#include "vtkFiltersExtractionModule.h" // For export macro

#include "vtkSelectionNode.h" // for vtkSelectionNode::SelectionContent
#include "vtkSmartPointer.h"  // for smart pointer

VTK_ABI_NAMESPACE_BEGIN
class vtkUnsignedCharArray;
class vtkSignedCharArray;
class vtkSelection;
class vtkSelectionNode;
class vtkSelector;
class vtkUnstructuredGrid;
class vtkTable;

class VTKFILTERSEXTRACTION_EXPORT vtkExtractSelection : public vtkDataObjectAlgorithm
{
public:
  static vtkExtractSelection* New();
  vtkTypeMacro(vtkExtractSelection, vtkDataObjectAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetSelectionConnection(vtkAlgorithmOutput* algOutput)
  {
    this->SetInputConnection(1, algOutput);
  }


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


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

protected:
  vtkExtractSelection();
  ~vtkExtractSelection() override;

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

  // Gets the attribute association of the selection.  Currently we support ROW, POINT, and CELL.
  // If the selection types are mismatched the boolean parameter will be set to false, otherwise
  // it will be true after the function returns.
  vtkDataObject::AttributeTypes GetAttributeTypeOfSelection(vtkSelection* sel, bool& sane);

  virtual vtkSmartPointer<vtkSelector> NewSelectionOperator(
    vtkSelectionNode::SelectionContent type);

  enum class EvaluationResult
  {
    INVALID,
    NONE,
    MIXED,
    ALL
  };
  EvaluationResult EvaluateSelection(vtkDataObject* dataObject,
    vtkDataObject::AttributeTypes association, vtkSelection* selection,
    std::map<std::string, vtkSmartPointer<vtkSelector>>& selectors);

  vtkSmartPointer<vtkUnsignedCharArray> EvaluateColorArrayInSelection(
    vtkDataObject* dataObject, vtkDataObject::AttributeTypes association, vtkSelection* selection);

  void AddColorArrayOnObject(vtkDataObject* dataObject, vtkUnsignedCharArray* colorArray);

  vtkSmartPointer<vtkDataObject> ExtractElements(vtkDataObject* inputBlock,
    vtkDataObject::AttributeTypes elementType, EvaluationResult evaluationResult,
    vtkDataObject* outputBlock);

  int FillInputPortInformation(int port, vtkInformation* info) override;

  void ExtractSelectedCells(vtkDataSet* input, vtkUnstructuredGrid* output,
    vtkSignedCharArray* cellInside, bool extractAll);
  void ExtractSelectedPoints(vtkDataSet* input, vtkUnstructuredGrid* output,
    vtkSignedCharArray* pointInside, bool extractAll);
  void ExtractSelectedRows(
    vtkTable* input, vtkTable* output, vtkSignedCharArray* rowsInside, bool extractAll);

  bool PreserveTopology = false;

private:
  vtkExtractSelection(const vtkExtractSelection&) = delete;
  void operator=(const vtkExtractSelection&) = delete;

  bool HyperTreeGridToUnstructuredGrid = false;
};

VTK_ABI_NAMESPACE_END
#endif