vtkCompositeDataProbeFilter.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 vtkCompositeDataProbeFilter_h
#define vtkCompositeDataProbeFilter_h

#include "vtkDeprecation.h"       // For VTK_DEPRECATED_IN_9_7_0
#include "vtkFiltersCoreModule.h" // For export macro
#include "vtkProbeFilter.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

#include <map> // For std::map

VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractCellLocator;
class vtkCompositeDataSet;
class vtkDataSet;
class vtkFindCellStrategy;
template <typename T>
class vtkSmartPointer;

class VTKFILTERSCORE_EXPORT VTK_MARSHALAUTO vtkCompositeDataProbeFilter : public vtkProbeFilter
{
public:
  static vtkCompositeDataProbeFilter* New();
  vtkTypeMacro(vtkCompositeDataProbeFilter, vtkProbeFilter);
  void PrintSelf(ostream& os, vtkIndent indent) override;


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


  void SetCellLocatorMap(const std::map<vtkDataSet*, vtkSmartPointer<vtkAbstractCellLocator>>& map);
  VTK_DEPRECATED_IN_9_7_0("Use SetCellLocatorMap() instead.")
  void SetFindCellStrategyMap(
    const std::map<vtkDataSet*, vtkSmartPointer<vtkFindCellStrategy>>& map);


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

protected:
  vtkCompositeDataProbeFilter();
  ~vtkCompositeDataProbeFilter() override;

  void ReportReferences(vtkGarbageCollector*) override;

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

  int BuildFieldList(vtkCompositeDataSet* source);

  void InitializeOutputArrays(vtkPointData* outPD, vtkIdType numPts) override;

  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  vtkExecutive* CreateDefaultExecutive() override;

  bool PassPartialArrays;

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

  std::map<vtkDataSet*, vtkSmartPointer<vtkAbstractCellLocator>> CellLocatorMap;

  bool UseImplicitArrays = false;
};

VTK_ABI_NAMESPACE_END
#endif