VTK  9.1.0
vtkUniformGrid.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkUniformGrid.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 =========================================================================*/
23 #ifndef vtkUniformGrid_h
24 #define vtkUniformGrid_h
25 
26 #include "vtkCommonDataModelModule.h" // For export macro
27 #include "vtkImageData.h"
28 
29 class vtkEmptyCell;
30 class vtkStructuredVisibilityConstraint;
32 class vtkAMRBox;
33 
34 class VTKCOMMONDATAMODEL_EXPORT vtkUniformGrid : public vtkImageData
35 {
36 public:
38 
41  static vtkUniformGrid* New();
42  vtkTypeMacro(vtkUniformGrid, vtkImageData);
43  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
50  void CopyStructure(vtkDataSet* ds) override;
51 
55  int GetDataObjectType() override { return VTK_UNIFORM_GRID; }
56 
58 
61  vtkCell* GetCell(int i, int j, int k) override;
62  vtkCell* GetCell(vtkIdType cellId) override;
63  void GetCell(vtkIdType cellId, vtkGenericCell* cell) override;
64  vtkIdType FindCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2, int& subId,
65  double pcoords[3], double* weights) override;
66  vtkIdType FindCell(double x[3], vtkCell* cell, vtkGenericCell* gencell, vtkIdType cellId,
67  double tol2, int& subId, double pcoords[3], double* weights) override;
68  vtkCell* FindAndGetCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2, int& subId,
69  double pcoords[3], double* weights) override;
70  int GetCellType(vtkIdType cellId) override;
71  void GetCellPoints(vtkIdType cellId, vtkIdList* ptIds) override
72  {
74  cellId, ptIds, this->GetDataDescription(), this->GetDimensions());
75  }
76  void GetPointCells(vtkIdType ptId, vtkIdList* cellIds) override
77  {
78  vtkStructuredData::GetPointCells(ptId, cellIds, this->GetDimensions());
79  }
80  void Initialize() override;
81  int GetMaxCellSize() override { return 8; } // voxel is the largest
83 
88 
95  int Initialize(const vtkAMRBox* def, double* origin, double* spacing);
103  int Initialize(const vtkAMRBox* def, double* origin, double* spacing, int nGhosts);
104 
112  int Initialize(const vtkAMRBox* def, double* origin, double* spacing, const int nGhosts[3]);
121  int Initialize(const vtkAMRBox* def, double* origin, double* spacing, int nGhostsI, int nGhostsJ,
122  int nGhostsK);
123 
125 
131  virtual void BlankPoint(vtkIdType ptId);
132  virtual void UnBlankPoint(vtkIdType ptId);
133  virtual void BlankPoint(const int i, const int j, const int k);
134  virtual void UnBlankPoint(const int i, const int j, const int k);
136 
138 
144  virtual void BlankCell(vtkIdType ptId);
145  virtual void UnBlankCell(vtkIdType ptId);
146  virtual void BlankCell(const int i, const int j, const int k);
147  virtual void UnBlankCell(const int i, const int j, const int k);
149 
154  bool HasAnyBlankCells() override;
159  bool HasAnyBlankPoints() override;
160 
166  virtual unsigned char IsPointVisible(vtkIdType pointId);
167 
173  virtual unsigned char IsCellVisible(vtkIdType cellId);
174 
176 
178 
184 
185 protected:
187  ~vtkUniformGrid() override;
188 
192  void GetCellDims(int cellDims[3]);
193 
197  void ComputeScalarRange() override;
198 
200 
201 private:
202  vtkUniformGrid(const vtkUniformGrid&) = delete;
203  void operator=(const vtkUniformGrid&) = delete;
204 
205  vtkEmptyCell* EmptyCell;
206 
207  static unsigned char MASKED_CELL_VALUE;
208 };
209 
210 #endif
Encloses a rectangular region of voxel like cells.
Definition: vtkAMRBox.h:34
abstract class to specify cell behavior
Definition: vtkCell.h:58
abstract class to specify dataset behavior
Definition: vtkDataSet.h:57
an empty cell used as a place-holder during processing
Definition: vtkEmptyCell.h:30
provides thread-safe access to cells
list of point or cell ids
Definition: vtkIdList.h:31
topologically and geometrically regular array of data
Definition: vtkImageData.h:48
friend class vtkUniformGrid
Definition: vtkImageData.h:637
int GetDataDescription()
Definition: vtkImageData.h:631
virtual int * GetDimensions()
Get dimensions of this structured points dataset.
a simple class to control print indentation
Definition: vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
static void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds, int dataDescription, int dim[3])
Get the points defining a cell.
static void GetPointCells(vtkIdType ptId, vtkIdList *cellIds, int dim[3])
Get the cells using a point.
image data with blanking
bool HasAnyBlankCells() override
Returns 1 if there is any visibility constraint on the cells, 0 otherwise.
vtkIdType FindCell(double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
Standard vtkDataSet API methods.
bool HasAnyBlankPoints() override
Returns 1 if there is any visibility constraint on the points, 0 otherwise.
int GetGridDescription()
Returns the data description of this uniform grid instance.
vtkCell * GetCell(int i, int j, int k) override
Standard vtkDataSet API methods.
virtual void UnBlankPoint(vtkIdType ptId)
Methods for supporting blanking of cells.
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...
virtual unsigned char IsCellVisible(vtkIdType cellId)
Return non-zero value if specified cell is visible.
virtual void UnBlankPoint(const int i, const int j, const int k)
Methods for supporting blanking of cells.
virtual unsigned char IsPointVisible(vtkIdType pointId)
Return non-zero value if specified point is visible.
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 void BlankPoint(const int i, const int j, const int k)
Methods for supporting blanking of cells.
virtual vtkImageData * NewImageDataCopy()
static vtkUniformGrid * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
virtual void UnBlankCell(const int i, const int j, const int k)
Methods for supporting blanking of cells.
~vtkUniformGrid() override
void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds) override
Standard vtkDataSet API methods.
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.
vtkCell * GetCell(vtkIdType cellId) override
Standard vtkDataSet API methods.
vtkEmptyCell * GetEmptyCell()
int GetMaxCellSize() override
Standard vtkDataSet API methods.
virtual void UnBlankCell(vtkIdType ptId)
Methods for supporting blanking of cells.
static vtkUniformGrid * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
vtkCell * FindAndGetCell(double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
Standard vtkDataSet API methods.
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.
int GetCellType(vtkIdType cellId) override
Standard vtkDataSet API methods.
void GetPointCells(vtkIdType ptId, vtkIdList *cellIds) override
Standard vtkDataSet API methods.
void GetCell(vtkIdType cellId, vtkGenericCell *cell) override
Standard vtkDataSet API methods.
vtkIdType FindCell(double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
Standard vtkDataSet API methods.
virtual void BlankCell(const int i, const int j, const int k)
Methods for supporting blanking of cells.
void GetCellDims(int cellDims[3])
Returns the cell dimensions for this vtkUniformGrid instance.
virtual void BlankCell(vtkIdType ptId)
Methods for supporting blanking of cells.
virtual void BlankPoint(vtkIdType ptId)
Methods for supporting blanking of cells.
dynamic, self-adjusting array of unsigned char
@ info
Definition: vtkX3D.h:382
@ spacing
Definition: vtkX3D.h:487
#define VTK_UNIFORM_GRID
Definition: vtkType.h:87
int vtkIdType
Definition: vtkType.h:332