VTK  9.2.6
vtkDataObjectTree.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkDataObjectTree.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
35
36#ifndef vtkDataObjectTree_h
37#define vtkDataObjectTree_h
38
39#include "vtkCommonDataModelModule.h" // For export macro
40#include "vtkCompositeDataSet.h"
41
45class vtkInformation;
47class vtkDataObject;
48
49class VTKCOMMONDATAMODEL_EXPORT vtkDataObjectTree : public vtkCompositeDataSet
50{
51public:
53 void PrintSelf(ostream& os, vtkIndent indent) override;
54
59
68
74 void CopyStructure(vtkCompositeDataSet* input) override;
75
82 void SetDataSet(vtkCompositeDataIterator* iter, vtkDataObject* dataObj) override;
83
88
89 // Needed because, otherwise vtkCompositeData::GetDataSet(unsigned int flatIndex) is hidden.
98
108
116
121 unsigned long GetActualMemorySize() override;
122
126 void Initialize() override;
127
129
132 void ShallowCopy(vtkDataObject* src) override;
133 void DeepCopy(vtkDataObject* src) override;
136
143
150
152
158
162 int GetDataObjectType() override { return VTK_DATA_OBJECT_TREE; }
163
164protected:
167
171 void SetNumberOfChildren(unsigned int num);
172
176 unsigned int GetNumberOfChildren();
177
182 void SetChild(unsigned int index, vtkDataObject*);
183
187 void RemoveChild(unsigned int index);
188
192 vtkDataObject* GetChild(unsigned int index);
193
199 vtkInformation* GetChildMetaData(unsigned int index);
200
204 void SetChildMetaData(unsigned int index, vtkInformation* info);
205
210 int HasChildMetaData(unsigned int index);
211
219
220 // The internal datastructure. Subclasses need not access this directly.
222
224
225private:
226 vtkDataObjectTree(const vtkDataObjectTree&) = delete;
227 void operator=(const vtkDataObjectTree&) = delete;
228};
229
230#endif
superclass for composite data iterators
virtual vtkDataObject * GetDataSet(vtkCompositeDataIterator *iter)=0
Returns the dataset located at the position pointed by the iterator.
superclass for composite data iterators
void SetChildMetaData(unsigned int index, vtkInformation *info)
Sets the meta-data at a given index.
static vtkDataObjectTree * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
vtkCompositeDataIterator * NewIterator() override
Return a new iterator (the iterator has to be deleted by user).
void RecursiveShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
void SetDataSet(vtkCompositeDataIterator *iter, vtkDataObject *dataObj) override
Sets the data set at the location pointed by the iterator.
vtkDataObject * GetChild(unsigned int index)
Returns a child dataset at a given index.
friend class vtkDataObjectTreeIterator
vtkIdType GetNumberOfCells() override
Returns the total number of cells of all blocks.
vtkDataObjectTreeInternals * Internals
virtual vtkDataObjectTreeIterator * NewTreeIterator()
Return a new iterator (the iterator has to be deleted by user).
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void Initialize() override
Restore data object to initial state,.
virtual vtkDataObjectTree * CreateForCopyStructure(vtkDataObjectTree *other)
When copying structure from another vtkDataObjectTree, this method gets called for create a new non-l...
void DeepCopy(vtkDataObject *src) override
Shallow and Deep copy.
unsigned long GetActualMemorySize() override
Return the actual size of the data in kibibytes (1024 bytes).
void SetChild(unsigned int index, vtkDataObject *)
Set child dataset at a given index.
virtual int HasMetaData(vtkCompositeDataIterator *iter)
Returns if any meta-data associated with the position pointed by the iterator.
vtkDataObject * GetDataSet(vtkCompositeDataIterator *iter) override
Returns the dataset located at the position pointed by the iterator.
unsigned int GetNumberOfChildren()
Get the number of children.
virtual vtkInformation * GetMetaData(vtkCompositeDataIterator *iter)
Returns the meta-data associated with the position pointed by the iterator.
vtkIdType GetNumberOfPoints() override
Returns the total number of points of all blocks.
void SetDataSetFrom(vtkDataObjectTreeIterator *iter, vtkDataObject *dataObj)
Sets the data at the location provided by a vtkDataObjectTreeIterator.
void SetNumberOfChildren(unsigned int num)
Set the number of children.
void CopyStructure(vtkCompositeDataSet *input) override
Copies the tree structure from the input.
int HasChildMetaData(unsigned int index)
Returns if meta-data information is available for the given child index.
~vtkDataObjectTree() override
static vtkDataObjectTree * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
int GetDataObjectType() override
Overridden to return VTK_DATA_OBJECT_TREE.
void RemoveChild(unsigned int index)
Remove the child at a given index.
vtkInformation * GetChildMetaData(unsigned int index)
Returns the meta-data at a given index.
void ShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
general representation of visualization data
a simple class to control print indentation
Definition vtkIndent.h:40
Key for string values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
#define VTK_DATA_OBJECT_TREE
Definition vtkType.h:118
int vtkIdType
Definition vtkType.h:332
#define VTK_NEWINSTANCE