VTK  9.3.20240328
vtkUniformGrid.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
56 #ifndef vtkUniformGrid_h
57 #define vtkUniformGrid_h
58 
59 #include "vtkCommonDataModelModule.h" // For export macro
60 #include "vtkDeprecation.h" // For VTK_DEPRECATED
61 #include "vtkImageData.h"
62 
63 VTK_ABI_NAMESPACE_BEGIN
64 class vtkEmptyCell;
66 class vtkAMRBox;
67 
68 class VTKCOMMONDATAMODEL_EXPORT vtkUniformGrid : public vtkImageData
69 {
70 public:
72 
75  static vtkUniformGrid* New();
76  vtkTypeMacro(vtkUniformGrid, vtkImageData);
77  void PrintSelf(ostream& os, vtkIndent indent) override;
79 
84  void CopyStructure(vtkDataSet* ds) override;
85 
89  int GetDataObjectType() override { return VTK_UNIFORM_GRID; }
90 
92 
95  void Initialize() override;
97 
101  VTK_DEPRECATED_IN_9_3_0("Use GetDataDescription() instead.")
102  int GetGridDescription() { return this->GetDataDescription(); }
103 
110  int Initialize(const vtkAMRBox* def, double* origin, double* spacing);
118  int Initialize(const vtkAMRBox* def, double* origin, double* spacing, int nGhosts);
119 
127  int Initialize(const vtkAMRBox* def, double* origin, double* spacing, const int nGhosts[3]);
136  int Initialize(const vtkAMRBox* def, double* origin, double* spacing, int nGhostsI, int nGhostsJ,
137  int nGhostsK);
138 
140 
142 
148 
149 protected:
151  ~vtkUniformGrid() override;
152 
156  void ComputeScalarRange() override;
157 
158 private:
159  vtkUniformGrid(const vtkUniformGrid&) = delete;
160  void operator=(const vtkUniformGrid&) = delete;
161 };
162 
163 VTK_ABI_NAMESPACE_END
164 #endif
Encloses a rectangular region of voxel like cells.
Definition: vtkAMRBox.h:68
abstract class to specify dataset behavior
Definition: vtkDataSet.h:165
an empty cell used as a place-holder during processing
Definition: vtkEmptyCell.h:22
topologically and geometrically regular array of data
Definition: vtkImageData.h:155
friend class vtkUniformGrid
Definition: vtkImageData.h:788
virtual int GetDataDescription()
Get the data description of the image data.
a simple class to control print indentation
Definition: vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
image data with blanking
int Initialize(const vtkAMRBox *def, double *origin, double *spacing, int nGhostsI, int nGhostsJ, int nGhostsK)
Construct a uniform grid, from the definition in the given box "def", with ghost cell arrays of the t...
void CopyStructure(vtkDataSet *ds) override
Copy the geometric and topological structure of an input image data object.
int GetDataObjectType() override
Return what type of dataset this is.
static vtkUniformGrid * New()
Construct an empty uniform grid.
virtual vtkImageData * NewImageDataCopy()
static vtkUniformGrid * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
~vtkUniformGrid() override
int Initialize(const vtkAMRBox *def, double *origin, double *spacing, int nGhosts)
Initialize from the definition in the given box, with ghost cell arrays nGhosts cells thick in all di...
void ComputeScalarRange() override
Override this method because of blanking.
int Initialize(const vtkAMRBox *def, double *origin, double *spacing, const int nGhosts[3])
Initialize from the definition in the given box, with ghost cell arrays of the thickness given in eac...
void PrintSelf(ostream &os, vtkIndent indent) override
Construct an empty uniform grid.
static vtkUniformGrid * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
void Initialize() override
Standard vtkDataSet API methods.
int Initialize(const vtkAMRBox *def, double *origin, double *spacing)
Initialize with no ghost cell arrays, from the definition in the given box.
dynamic, self-adjusting array of unsigned char
@ info
Definition: vtkX3D.h:376
@ spacing
Definition: vtkX3D.h:481
#define VTK_DEPRECATED_IN_9_3_0(reason)
#define VTK_UNIFORM_GRID
Definition: vtkType.h:75
#define VTK_NEWINSTANCE