VTK  9.4.20251007
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
16
17#ifndef vtkUniformGrid_h
18#define vtkUniformGrid_h
19
20#include "vtkCommonDataModelModule.h" // For export macro
21#include "vtkDeprecation.h" // For VTK_DEPRECATED
22#include "vtkImageData.h"
23
24VTK_ABI_NAMESPACE_BEGIN
25class vtkEmptyCell;
27class vtkAMRBox;
28
29class VTKCOMMONDATAMODEL_EXPORT vtkUniformGrid : public vtkImageData
30{
31public:
33
38 void PrintSelf(ostream& os, vtkIndent indent) override;
40
45 void CopyStructure(vtkDataSet* ds) override;
46
50 int GetDataObjectType() override { return VTK_UNIFORM_GRID; }
51
53
56 void Initialize() override;
58
62 VTK_DEPRECATED_IN_9_3_0("Use GetDataDescription() instead.")
63 int GetGridDescription() { return this->GetDataDescription(); }
64
71 int Initialize(const vtkAMRBox* def, double* origin, double* spacing);
79 int Initialize(const vtkAMRBox* def, double* origin, double* spacing, int nGhosts);
80
88 int Initialize(const vtkAMRBox* def, double* origin, double* spacing, const int nGhosts[3]);
97 int Initialize(const vtkAMRBox* def, double* origin, double* spacing, int nGhostsI, int nGhostsJ,
98 int nGhostsK);
99
101
103
109
110protected:
112 ~vtkUniformGrid() override;
113
117 void ComputeScalarRange() override;
118
119private:
120 vtkUniformGrid(const vtkUniformGrid&) = delete;
121 void operator=(const vtkUniformGrid&) = delete;
122};
123
124VTK_ABI_NAMESPACE_END
125#endif
Encloses a rectangular region of voxel like cells.
Definition vtkAMRBox.h:29
an empty cell used as a place-holder during processing
friend class vtkUniformGrid
virtual int GetDataDescription()
Get the data description of the image data.
a simple class to control print indentation
Definition vtkIndent.h:29
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
virtual vtkImageData * NewImageDataCopy()
int GetGridDescription()
Returns the data description of this uniform grid instance.
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 * GetData(vtkInformationVector *v, int i=0)
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...
static vtkUniformGrid * New()
Construct an empty uniform grid.
void PrintSelf(ostream &os, vtkIndent indent) override
Construct an empty uniform grid.
static vtkUniformGrid * GetData(vtkInformation *info)
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
#define VTK_DEPRECATED_IN_9_3_0(reason)
#define VTK_UNIFORM_GRID
Definition vtkType.h:75
#define VTK_NEWINSTANCE