vtkDataTabulator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkDataTabulator_h
#define vtkDataTabulator_h

#include "vtkDataObjectAlgorithm.h"
#include "vtkPVVTKExtensionsFiltersRenderingModule.h" // needed for export macro
#include "vtkSmartPointer.h"                          // for ivars
#include "vtkSplitColumnComponents.h"                 // for vtkSplitColumnComponents enums

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

class vtkInformationIntegerKey;
class vtkPartitionedDataSet;

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

  void AddSelector(const char* selector);
  void ClearSelectors();


  vtkSetStringMacro(ActiveAssemblyForSelectors);
  vtkGetStringMacro(ActiveAssemblyForSelectors);


  vtkSetMacro(GenerateCellConnectivity, bool);
  vtkGetMacro(GenerateCellConnectivity, bool);


  vtkSetMacro(FieldAssociation, int);
  vtkGetMacro(FieldAssociation, int);


  vtkSetMacro(SplitComponents, int);
  vtkGetMacro(SplitComponents, int);


  vtkSetClampMacro(SplitComponentsNamingMode, int, vtkSplitColumnComponents::NUMBERS_WITH_PARENS,
    vtkSplitColumnComponents::NAMES_WITH_UNDERSCORES);
  vtkGetMacro(SplitComponentsNamingMode, int);


  vtkSetMacro(GenerateOriginalIds, bool);
  vtkGetMacro(GenerateOriginalIds, bool);

  static vtkInformationIntegerKey* COMPOSITE_INDEX();


  static vtkInformationIntegerKey* HIERARCHICAL_LEVEL();
  static vtkInformationIntegerKey* HIERARCHICAL_INDEX();

  static bool HasInputCompositeIds(vtkPartitionedDataSet* ptd);

protected:
  vtkDataTabulator();
  ~vtkDataTabulator() override;

  int FillOutputPortInformation(int port, vtkInformation* info) override;
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  vtkSmartPointer<vtkDataObject> Transform(vtkDataObject* data);

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

  int FieldAssociation;
  bool GenerateCellConnectivity;
  bool GenerateOriginalIds;
  int SplitComponents;
  int SplitComponentsNamingMode;
  std::set<std::string> Selectors;
  char* ActiveAssemblyForSelectors;
};

#endif