VTK  9.1.0
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 =========================================================================*/
33 #ifndef vtkCompositeDataSet_h
34 #define vtkCompositeDataSet_h
35 
36 #include "vtkCommonDataModelModule.h" // For export macro
37 #include "vtkDataObject.h"
38 
39 #include <vector> // For GetDataSets
40 
42 class vtkCompositeDataSetInternals;
43 class vtkDataSet;
44 class vtkInformation;
47 
48 class VTKCOMMONDATAMODEL_EXPORT vtkCompositeDataSet : public vtkDataObject
49 {
50 public:
52  void PrintSelf(ostream& os, vtkIndent indent) override;
53 
58 
63  int GetDataObjectType() override { return VTK_COMPOSITE_DATA_SET; }
64 
70  virtual void CopyStructure(vtkCompositeDataSet* input);
71 
78  virtual void SetDataSet(vtkCompositeDataIterator* iter, vtkDataObject* dataObj) = 0;
79 
87 
92  unsigned long GetActualMemorySize() override;
93 
95 
101 
105  void Initialize() override;
106 
108 
111  void ShallowCopy(vtkDataObject* src) override;
112  void DeepCopy(vtkDataObject* src) override;
114 
121  virtual void RecursiveShallowCopy(vtkDataObject* src) = 0;
122 
129 
136 
141 
151  void GetBounds(double bounds[6]);
152 
157 
166 
177  template <class DataSetT = vtkDataSet>
178  static std::vector<DataSetT*> GetDataSets(vtkDataObject* dobj, bool preserveNull = false);
179 
180 protected:
183 
184 private:
185  vtkCompositeDataSet(const vtkCompositeDataSet&) = delete;
186  void operator=(const vtkCompositeDataSet&) = delete;
187 };
188 
189 #include "vtkCompositeDataSet.txx" // for template implementations
190 
191 #endif
superclass for composite data iterators
abstract superclass for composite (multi-block or AMR) datasets
~vtkCompositeDataSet() override
static std::vector< DataSetT * > GetDataSets(vtkDataObject *dobj, bool preserveNull=false)
Extract datasets from the given data object.
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 vtkInformationStringKey * NAME()
Key used to put node name in the meta-data associated with a node.
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.
static vtkCompositeDataSet * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
virtual vtkCompositeDataIterator * NewIterator()=0
Return a new iterator (the iterator has to be deleted by user).
virtual void CopyStructure(vtkCompositeDataSet *input)
Copies the tree structure from the input.
virtual vtkDataObject * GetDataSet(vtkCompositeDataIterator *iter)=0
Returns the dataset located at the positiong pointed by the iterator.
void DeepCopy(vtkDataObject *src) override
Shallow and Deep copy.
int GetDataObjectType() override
Return class name of data type (see vtkType.h for definitions).
static vtkInformationIntegerKey * CURRENT_PROCESS_CAN_LOAD_BLOCK()
Key used to indicate that the current process can load the data in the node.
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).
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.
general representation of visualization data
Definition: vtkDataObject.h:60
abstract class to specify dataset behavior
Definition: vtkDataSet.h:57
a simple class to control print indentation
Definition: vtkIndent.h:34
Key for integer values in vtkInformation.
Key for string values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
@ info
Definition: vtkX3D.h:382
@ type
Definition: vtkX3D.h:522
int vtkIdType
Definition: vtkType.h:332
#define VTK_COMPOSITE_DATA_SET
Definition: vtkType.h:88
#define VTK_NEWINSTANCE