vtkHyperTreeGridGenerateFields.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 vtkHyperTreeGridGenerateFields_h
#define vtkHyperTreeGridGenerateFields_h

#include "vtkFiltersHyperTreeModule.h" // For export macro
#include "vtkHyperTreeGridAlgorithm.h"
#include "vtkHyperTreeGridGenerateFieldStrategy.h" // For vtkHyperTreeGridGenerateFieldStrategy

#include <unordered_map>

VTK_ABI_NAMESPACE_BEGIN
class vtkCellData;
class vtkHyperTreeGrid;
class vtkHyperTreeGridNonOrientedGeometryCursor;

class VTKFILTERSHYPERTREE_EXPORT vtkHyperTreeGridGenerateFields : public vtkHyperTreeGridAlgorithm
{
public:
  static vtkHyperTreeGridGenerateFields* New();
  vtkTypeMacro(vtkHyperTreeGridGenerateFields, vtkHyperTreeGridAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual bool GetComputeCellSizeArray() VTK_FUTURE_CONST;
  virtual void SetComputeCellSizeArray(bool enable);
  vtkBooleanMacro(ComputeCellSizeArray, bool);


  virtual std::string GetCellSizeArrayName() VTK_FUTURE_CONST;
  virtual void SetCellSizeArrayName(std::string name);


  virtual bool GetComputeValidCellArray() VTK_FUTURE_CONST;
  virtual void SetComputeValidCellArray(bool enable);
  vtkBooleanMacro(ComputeValidCellArray, bool);


  virtual std::string GetValidCellArrayName() VTK_FUTURE_CONST;
  virtual void SetValidCellArrayName(std::string name);


  virtual bool GetComputeCellCenterArray() VTK_FUTURE_CONST;
  virtual void SetComputeCellCenterArray(bool enable);
  vtkBooleanMacro(ComputeCellCenterArray, bool);


  virtual std::string GetCellCenterArrayName() VTK_FUTURE_CONST;
  virtual void SetCellCenterArrayName(std::string name);


  virtual bool GetComputeTotalVisibleVolumeArray() VTK_FUTURE_CONST;
  virtual void SetComputeTotalVisibleVolumeArray(bool enable);
  vtkBooleanMacro(ComputeTotalVisibleVolumeArray, bool);


  virtual std::string GetTotalVisibleVolumeArrayName() VTK_FUTURE_CONST;
  virtual void SetTotalVisibleVolumeArrayName(std::string name);

protected:
  vtkHyperTreeGridGenerateFields();
  ~vtkHyperTreeGridGenerateFields() override = default;

  int ProcessTrees(vtkHyperTreeGrid*, vtkDataObject*) override;

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

  void ProcessFields(
    vtkHyperTreeGrid* outputHTG, vtkHyperTreeGrid* input, vtkDataObject::AttributeTypes type);

  void InitializeFields();

  void ProcessNode(vtkHyperTreeGridNonOrientedGeometryCursor* cursor,
    vtkDataObject::AttributeTypes type, vtkCellData* outputCellData);

  // Cell Data and field data names
  std::string CellSizeArrayName = "CellSize";
  std::string ValidCellArrayName = "ValidCell";
  std::string CellCenterArrayName = "CellCenter";
  std::string TotalVisibleVolumeArrayName = "TotalVisibleVolume";

  // Cell Data and field data switches
  bool ComputeCellSizeArray = true;
  bool ComputeValidCellArray = true;
  bool ComputeCellCenterArray = true;
  bool ComputeTotalVisibleVolumeArray = true;

  std::unordered_map<std::string, vtkHyperTreeGridGenerateFieldStrategy::Field> Fields;
};

VTK_ABI_NAMESPACE_END
#endif