vtkTree.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
#ifndef vtkTree_h
#define vtkTree_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDirectedAcyclicGraph.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkIdTypeArray;

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

  int GetDataObjectType() VTK_FUTURE_CONST override { return VTK_TREE; }


  vtkGetMacro(Root, vtkIdType);
  vtkSetMacro(Root, vtkIdType);

  vtkIdType GetNumberOfChildren(vtkIdType v) { return this->GetOutDegree(v); }

  vtkIdType GetChild(vtkIdType v, vtkIdType i);

  void GetChildren(vtkIdType v, vtkAdjacentVertexIterator* it) { this->GetAdjacentVertices(v, it); }

  vtkIdType GetParent(vtkIdType v);

  vtkEdgeType GetParentEdge(vtkIdType v);

  vtkIdType GetLevel(vtkIdType v);

  bool IsLeaf(vtkIdType vertex);


  static vtkTree* GetData(vtkInformation* info);
  static vtkTree* GetData(vtkInformationVector* v, int i = 0);

  virtual void ReorderChildren(vtkIdType parent, vtkIdTypeArray* children);

protected:
  vtkTree();
  ~vtkTree() override;

  bool IsStructureValid(vtkGraph* g) override;

  vtkIdType Root;

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

VTK_ABI_NAMESPACE_END
#endif