VTK  9.2.6
vtkCompositeDataSet.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkCompositeDataSet.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=========================================================================*/
36#ifndef vtkCompositeDataSet_h
37#define vtkCompositeDataSet_h
38
39#include "vtkCommonDataModelModule.h" // For export macro
40#include "vtkDataObject.h"
41
42#include <vector> // For GetDataSets
43
45class vtkCompositeDataSetInternals;
46class vtkDataSet;
47class vtkInformation;
50
51class VTKCOMMONDATAMODEL_EXPORT vtkCompositeDataSet : public vtkDataObject
52{
53public:
55 void PrintSelf(ostream& os, vtkIndent indent) override;
56
61
66 int GetDataObjectType() override { return VTK_COMPOSITE_DATA_SET; }
67
73 virtual void CopyStructure(vtkCompositeDataSet* input);
74
81 virtual void SetDataSet(vtkCompositeDataIterator* iter, vtkDataObject* dataObj) = 0;
82
90
99 virtual vtkDataObject* GetDataSet(unsigned int flatIndex);
100
105 unsigned long GetActualMemorySize() override;
106
108
114
118 void Initialize() override;
119
121
124 void ShallowCopy(vtkDataObject* src) override;
125 void DeepCopy(vtkDataObject* src) override;
127
134 virtual void RecursiveShallowCopy(vtkDataObject* src) = 0;
135
142
149
153 vtkIdType GetNumberOfElements(int type) override;
154
164 void GetBounds(double bounds[6]);
165
170
179
190 template <class DataSetT = vtkDataSet>
191 static std::vector<DataSetT*> GetDataSets(vtkDataObject* dobj, bool preserveNull = false);
192
193protected:
196
197private:
199 void operator=(const vtkCompositeDataSet&) = delete;
200};
201
202#include "vtkCompositeDataSet.txx" // for template implementations
203
204#endif
superclass for composite data iterators
abstract superclass for composite (multi-block or AMR) datasets
~vtkCompositeDataSet() override
virtual vtkDataObject * GetDataSet(unsigned int flatIndex)
Returns the dataset located at the position pointed by the flatIndex.
virtual vtkIdType GetNumberOfCells()
Returns the total number of cells of all blocks.
virtual void SetDataSet(vtkCompositeDataIterator *iter, vtkDataObject *dataObj)=0
Sets the data set at the location pointed by the iterator.
void GetBounds(double bounds[6])
Return the geometric bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).
static vtkCompositeDataSet * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
vtkIdType GetNumberOfElements(int type) override
Get the number of elements for a specific attribute type (POINT, CELL, etc.).
virtual vtkIdType GetNumberOfPoints()
Returns the total number of points of all blocks.
static vtkCompositeDataSet * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
virtual void CopyStructure(vtkCompositeDataSet *input)
Copies the tree structure from the input.
void DeepCopy(vtkDataObject *src) override
Shallow and Deep copy.
int GetDataObjectType() override
Return class name of data type (see vtkType.h for definitions).
virtual vtkDataObject * GetDataSet(vtkCompositeDataIterator *iter)=0
Returns the dataset located at the position pointed by the iterator.
virtual void RecursiveShallowCopy(vtkDataObject *src)=0
For historical reasons, vtkCompositeDataSet::ShallowCopy simply pass pointers to the leaf non-composi...
void Initialize() override
Restore data object to initial state,.
unsigned long GetActualMemorySize() override
Return the actual size of the data in kibibytes (1024 bytes).
static std::vector< DataSetT * > GetDataSets(vtkDataObject *dobj, bool preserveNull=false)
Extract datasets from the given data object.
static vtkInformationStringKey * NAME()
Key used to put node name in the meta-data associated with a node.
void ShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual vtkCompositeDataIterator * NewIterator()=0
Return a new iterator (the iterator has to be deleted by user).
static vtkInformationIntegerKey * CURRENT_PROCESS_CAN_LOAD_BLOCK()
Key used to indicate that the current process can load the data in the node.
general representation of visualization data
Definition: vtkDataObject.h:66
abstract class to specify dataset behavior
Definition: vtkDataSet.h:63
a simple class to control print indentation
Definition: vtkIndent.h:40
Key for integer values in vtkInformation.
Key for string values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
int vtkIdType
Definition: vtkType.h:332
#define VTK_COMPOSITE_DATA_SET
Definition: vtkType.h:88
#define VTK_NEWINSTANCE