vtkDataAssembly.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 vtkDataAssembly_h
#define vtkDataAssembly_h

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

#include <map>    // for std::map
#include <memory> // for std::unique_ptr
#include <string> // for std::string
#include <vector> // for std::vector

VTK_ABI_NAMESPACE_BEGIN
class vtkDataAssemblyVisitor;

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

  void Initialize();


  bool InitializeFromXML(const char* xmlcontents);


  std::string SerializeToXML(vtkIndent indent) const;

  static int GetRootNode() { return 0; }


  void SetRootNodeName(const char* name)
  {
    this->SetNodeName(vtkDataAssembly::GetRootNode(), name);
  }
  const char* GetRootNodeName() const { return this->GetNodeName(vtkDataAssembly::GetRootNode()); }

  int AddNode(const char* name, int parent = 0);

  std::vector<int> AddNodes(const std::vector<std::string>& names, int parent = 0);

  int AddSubtree(int parent, vtkDataAssembly* other, int otherParent = 0);

  bool RemoveNode(int id);


  void SetNodeName(int id, const char* name);
  const char* GetNodeName(int id) const;

  std::string GetNodePath(int id) const;

  int GetFirstNodeByPath(const char* path) const;

  int FindOrCreateNodeAtPath(const char* path, int parent = 0);

  bool AddDataSetIndex(int id, unsigned int dataset_index);

  bool AddDataSetIndices(int id, const std::vector<unsigned int>& dataset_indices);

  bool AddDataSetIndexRange(int id, unsigned int index_start, int count);

  bool RemoveDataSetIndex(int id, unsigned int dataset_index);

  bool RemoveAllDataSetIndices(int id, bool traverse_subtree = true);

  enum TraversalOrder
  {
    DepthFirst = 0,
    BreadthFirst
  };

  int FindFirstNodeWithName(
    const char* name, int traversal_order = vtkDataAssembly::TraversalOrder::DepthFirst) const;

  std::vector<int> FindNodesWithName(
    const char* name, int sort_order = vtkDataAssembly::TraversalOrder::DepthFirst) const;

  std::vector<int> GetChildNodes(int parent, bool traverse_subtree = true,
    int traversal_order = vtkDataAssembly::TraversalOrder::DepthFirst) const;

  int GetNumberOfChildren(int parent) const;

  int GetChild(int parent, int index) const;

  int GetChild(int parent, const char* name) const;

  int GetChildIndex(int parent, int child) const;

  int GetParent(int id) const;

  bool HasAttribute(int id, const char* name) const;


  void SetAttribute(int id, const char* name, const char* value);
  void SetAttribute(int id, const char* name, int value);
  void SetAttribute(int id, const char* name, unsigned int value);
#if VTK_ID_TYPE_IMPL != VTK_INT
  void SetAttribute(int id, const char* name, vtkIdType value);
#endif


  bool GetAttribute(int id, const char* name, const char*& value) const;
  bool GetAttribute(int id, const char* name, int& value) const;
  bool GetAttribute(int id, const char* name, unsigned int& value) const;
#if VTK_ID_TYPE_IMPL != VTK_INT
  bool GetAttribute(int id, const char* name, vtkIdType& value) const;
#endif


  const char* GetAttributeOrDefault(int id, const char* name, const char* default_value) const;
  int GetAttributeOrDefault(int id, const char* name, int default_value) const;
  unsigned int GetAttributeOrDefault(int id, const char* name, unsigned int default_value) const;
#if VTK_ID_TYPE_IMPL != VTK_INT
  vtkIdType GetAttributeOrDefault(int id, const char* name, vtkIdType default_value) const;
#endif


  void Visit(vtkDataAssemblyVisitor* visitor,
    int traversal_order = vtkDataAssembly::TraversalOrder::DepthFirst) const
  {
    this->Visit(0, visitor, traversal_order);
  }
  void Visit(int id, vtkDataAssemblyVisitor* visitor,
    int traversal_order = vtkDataAssembly::TraversalOrder::DepthFirst) const;


  std::vector<unsigned int> GetDataSetIndices(int id, bool traverse_subtree = true,
    int traversal_order = vtkDataAssembly::TraversalOrder::DepthFirst) const;
  std::vector<unsigned int> GetDataSetIndices(const std::vector<int>& ids,
    bool traverse_subtree = true,
    int traversal_order = vtkDataAssembly::TraversalOrder::DepthFirst) const;

  std::vector<int> SelectNodes(const std::vector<std::string>& path_queries,
    int traversal_order = vtkDataAssembly::TraversalOrder::DepthFirst) const;

  bool RemapDataSetIndices(
    const std::map<unsigned int, unsigned int>& mapping, bool remove_unmapped);

  void SubsetCopy(vtkDataAssembly* other, const std::vector<int>& selected_branches);

  void DeepCopy(vtkDataAssembly* other);

  static bool IsNodeNameValid(const char* name);

  static std::string MakeValidNodeName(const char* name);

  static bool IsNodeNameReserved(const char* name);

protected:
  vtkDataAssembly();
  ~vtkDataAssembly() override;

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

  class vtkInternals;
  std::unique_ptr<vtkInternals> Internals;
};

VTK_ABI_NAMESPACE_END
#endif