vtkDataAssemblyUtilities.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 vtkDataAssemblyUtilities_h
#define vtkDataAssemblyUtilities_h

#include "vtkCommonDataModelModule.h" // for export macros
#include "vtkObject.h"
#include "vtkSmartPointer.h" // for vtkSmartPointer

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

VTK_ABI_NAMESPACE_BEGIN
class vtkCompositeDataSet;
class vtkDataAssembly;
class vtkDataObject;
class vtkMultiBlockDataSet;
class vtkPartitionedDataSetCollection;
class vtkUniformGridAMR;

class VTKCOMMONDATAMODEL_EXPORT vtkDataAssemblyUtilities : public vtkObject
{
public:
  static vtkDataAssemblyUtilities* New();
  vtkTypeMacro(vtkDataAssemblyUtilities, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static const char* HierarchyName() { return "Hierarchy"; }

  static const char* CategoryHierarchyName() { return "vtk_category"; };

  static const char* CategoryHierarchy() { return "hierarchy"; };

  static const char* CategoryTransformedHierarchy() { return "xformed_hierarchy"; };

  static vtkSmartPointer<vtkDataAssembly> GetDataAssembly(
    const char* name, vtkCompositeDataSet* cd);

  static bool GenerateHierarchy(vtkCompositeDataSet* input, vtkDataAssembly* hierarchy,
    vtkPartitionedDataSetCollection* output = nullptr);


  static vtkSmartPointer<vtkCompositeDataSet> GenerateCompositeDataSetFromHierarchy(
    vtkPartitionedDataSetCollection* input, vtkDataAssembly* hierarchy);
  static vtkSmartPointer<vtkCompositeDataSet> GenerateCompositeDataSetFromHierarchy(
    vtkPartitionedDataSetCollection* input);


  static bool HasCompatibilityHierarchy(vtkPartitionedDataSetCollection* input);
  static bool IsCompatibilityHierarchy(vtkDataAssembly* hierarchy);

  static std::vector<unsigned int> GetSelectedCompositeIds(
    const std::vector<std::string>& selectors, vtkDataAssembly* hierarchyOrAssembly,
    vtkPartitionedDataSetCollection* data = nullptr, bool leaf_nodes_only = false);


  static std::string GetSelectorForCompositeId(unsigned int id, vtkDataAssembly* hierarchy);
  static std::vector<std::string> GetSelectorsForCompositeIds(
    const std::vector<unsigned int>& ids, vtkDataAssembly* hierarchy);
  static std::vector<std::string> GetSelectorsForCompositeIds(
    const std::vector<unsigned int>& ids, vtkDataAssembly* hierarchy, vtkDataAssembly* assembly);
  static std::vector<unsigned int> GetSelectorsCompositeIdsForCompositeIds(
    const std::vector<unsigned int>& ids, vtkDataAssembly* hierarchy);

protected:
  vtkDataAssemblyUtilities();
  ~vtkDataAssemblyUtilities() override;

  static bool GenerateHierarchyInternal(
    vtkUniformGridAMR* input, vtkDataAssembly* hierarchy, vtkPartitionedDataSetCollection* output);
  static bool GenerateHierarchyInternal(vtkMultiBlockDataSet* input, vtkDataAssembly* hierarchy,
    vtkPartitionedDataSetCollection* output);
  static bool GenerateHierarchyInternal(vtkPartitionedDataSetCollection* input,
    vtkDataAssembly* hierarchy, vtkPartitionedDataSetCollection* output);

private:
  vtkDataAssemblyUtilities(const vtkDataAssemblyUtilities&) = delete;
  void operator=(const vtkDataAssemblyUtilities&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif