VTK  9.1.0
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=========================================================================*/
42#ifndef vtkDataObjectTree_h
43#define vtkDataObjectTree_h
44
45#include "vtkCommonDataModelModule.h" // For export macro
46#include "vtkCompositeDataSet.h"
47
51class vtkInformation;
53class vtkDataObject;
54
55class VTKCOMMONDATAMODEL_EXPORT vtkDataObjectTree : public vtkCompositeDataSet
56{
57public:
59 void PrintSelf(ostream& os, vtkIndent indent) override;
60
65
74
80 void CopyStructure(vtkCompositeDataSet* input) override;
81
88 void SetDataSet(vtkCompositeDataIterator* iter, vtkDataObject* dataObj) override;
89
94
102
112
120
125 unsigned long GetActualMemorySize() override;
126
130 void Initialize() override;
131
133
136 void ShallowCopy(vtkDataObject* src) override;
137 void DeepCopy(vtkDataObject* src) override;
140
147
154
156
162
166 int GetDataObjectType() override { return VTK_DATA_OBJECT_TREE; }
167
168protected:
171
175 void SetNumberOfChildren(unsigned int num);
176
180 unsigned int GetNumberOfChildren();
181
186 void SetChild(unsigned int index, vtkDataObject*);
187
191 void RemoveChild(unsigned int index);
192
197
204
209
214 int HasChildMetaData(unsigned int index);
215
223
224 // The internal datastructure. Subclasses need not access this directly.
226
228
229private:
230 vtkDataObjectTree(const vtkDataObjectTree&) = delete;
231 void operator=(const vtkDataObjectTree&) = delete;
232};
233
234#endif
superclass for composite data iterators
abstract superclass for composite (multi-block or AMR) datasets
superclass for composite data iterators
provides implementation for most abstract methods in the superclass vtkCompositeDataSet
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.
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 positiong 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
Definition: vtkDataObject.h:69
a simple class to control print indentation
Definition: vtkIndent.h:43
Key for string values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
@ info
Definition: vtkX3D.h:382
@ index
Definition: vtkX3D.h:252
#define VTK_DATA_OBJECT_TREE
Definition: vtkType.h:118
int vtkIdType
Definition: vtkType.h:332
#define VTK_NEWINSTANCE