vtkSelector.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 vtkSelector_h
#define vtkSelector_h

#include "vtkDeprecation.h"             // for VTK_DEPRECATED_IN_9_6_0
#include "vtkFiltersExtractionModule.h" // For export macro
#include "vtkObject.h"
#include "vtkSmartPointer.h" // For vtkSmartPointer

#include <set> // for std::set

VTK_ABI_NAMESPACE_BEGIN
class vtkCompositeDataSet;
class vtkDataObject;
class vtkSelectionNode;
class vtkSignedCharArray;
class vtkTable;
class vtkDataObjectTree;
class vtkUniformGridAMR;

class VTKFILTERSEXTRACTION_EXPORT vtkSelector : public vtkObject
{
public:
  vtkTypeMacro(vtkSelector, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void Initialize(vtkSelectionNode* node);

  virtual void Finalize() {}

  virtual void Execute(vtkDataObject* input, vtkDataObject* output);


  vtkSetMacro(InsidednessArrayName, std::string);
  vtkGetMacro(InsidednessArrayName, std::string);
protected:
  vtkSelector();
  ~vtkSelector() override;

  // Contains the selection criteria.
  vtkSelectionNode* Node = nullptr;

  // Name of the insidedness array added to the output when the selection criteria is
  // evaluated by this operator.
  std::string InsidednessArrayName;

  virtual bool ComputeSelectedElements(
    vtkDataObject* input, vtkSignedCharArray* insidednessArray) = 0;

  enum SelectionMode
  {
    INCLUDE,
    EXCLUDE,
    INHERIT
  };

  VTK_DEPRECATED_IN_9_6_0(
    "Deprecated method without effect, use GetBlockSelection(idx, false) instead.")
  virtual SelectionMode GetAMRBlockSelection(
    unsigned int vtkNotUsed(level), unsigned int vtkNotUsed(index))
  {
    return EXCLUDE;
  };

  virtual SelectionMode GetBlockSelection(
    unsigned int compositeIndex, bool isDataObjectTree = true);

  vtkSmartPointer<vtkSignedCharArray> CreateInsidednessArray(vtkIdType numElems);

  vtkSmartPointer<vtkSignedCharArray> ComputeCellsContainingSelectedPoints(
    vtkDataObject* data, vtkSignedCharArray* selectedPoints);

  void ExpandToConnectedElements(vtkDataObject* output);

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

  void ProcessBlock(vtkDataObject* inputBlock, vtkDataObject* outputBlock, bool forceFalse);
  void ProcessAMR(vtkUniformGridAMR* input, vtkDataObjectTree* output);
  void ProcessDataObjectTree(vtkDataObjectTree* input, vtkDataObjectTree* output,
    SelectionMode inheritedSelectionMode, unsigned int compositeIndex = 0);
  void ProcessSelectors(vtkCompositeDataSet* input);

  std::set<unsigned int> SubsetCompositeIds;
};

VTK_ABI_NAMESPACE_END
#endif