vtkDataObjectTree.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 vtkDataObjectTree_h
#define vtkDataObjectTree_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkCompositeDataSet.h"
#include "vtkDeprecation.h"   // For VTK_DEPRECATED_IN_9_3_0
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCompositeDataIterator;
class vtkDataObjectTreeIterator;
class vtkDataObjectTreeInternals;
class vtkInformation;
class vtkInformationStringKey;
class vtkDataObject;
 
class VTKCOMMONDATAMODEL_EXPORT VTK_MARSHALAUTO vtkDataObjectTree : public vtkCompositeDataSet
{
public:
  vtkTypeMacro(vtkDataObjectTree, vtkCompositeDataSet);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  VTK_NEWINSTANCE virtual vtkDataObjectTreeIterator* NewTreeIterator();

  VTK_NEWINSTANCE vtkCompositeDataIterator* NewIterator() override;

  void CopyStructure(vtkCompositeDataSet* input) override;

  void SetDataSet(vtkCompositeDataIterator* iter, vtkDataObject* dataObj) override;

  void SetDataSetFrom(vtkDataObjectTreeIterator* iter, vtkDataObject* dataObj);
 
  // Needed because, otherwise vtkCompositeData::GetDataSet(unsigned int flatIndex) is hidden.
  using Superclass::GetDataSet;
  vtkDataObject* GetDataSet(vtkCompositeDataIterator* iter) override;

  virtual vtkInformation* GetMetaData(vtkCompositeDataIterator* iter);

  virtual vtkTypeBool HasMetaData(vtkCompositeDataIterator* iter);

  unsigned long GetActualMemorySize() override;

  void Initialize() override;


  void CompositeShallowCopy(vtkCompositeDataSet* src) override;
  void ShallowCopy(vtkDataObject* src) override;
  void DeepCopy(vtkDataObject* src) override;

  VTK_DEPRECATED_IN_9_3_0("Please use ShallowCopy instead.")
  void RecursiveShallowCopy(vtkDataObject* src) override;

  vtkIdType GetNumberOfPoints() override;

  vtkIdType GetNumberOfCells() override;

  unsigned int GetNumberOfChildren();

  vtkDataObject* GetChild(unsigned int index);

  vtkInformation* GetChildMetaData(unsigned int index);

  vtkTypeBool HasChildMetaData(unsigned int index);


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

  int GetDataObjectType() override { return VTK_DATA_OBJECT_TREE; }
 
protected:
  vtkDataObjectTree();
  ~vtkDataObjectTree() override;

  void SetNumberOfChildren(unsigned int num);

  void SetChild(unsigned int index, vtkDataObject*);

  void RemoveChild(unsigned int index);

  void SetChildMetaData(unsigned int index, vtkInformation* info);

  virtual vtkDataObjectTree* CreateForCopyStructure(vtkDataObjectTree* other);
 
  // The internal datastructure. Subclasses need not access this directly.
  vtkDataObjectTreeInternals* Internals;
 
  friend class vtkDataObjectTreeIterator;
 
private:
  vtkDataObjectTree(const vtkDataObjectTree&) = delete;
  void operator=(const vtkDataObjectTree&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif