VTK  9.0.2
vtkDataSet.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkDataSet.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 =========================================================================*/
40 #ifndef vtkDataSet_h
41 #define vtkDataSet_h
42 
43 #include "vtkCommonDataModelModule.h" // For export macro
44 #include "vtkDataObject.h"
45 
46 class vtkCell;
47 class vtkCellData;
48 class vtkCellIterator;
49 class vtkCellTypes;
50 class vtkGenericCell;
51 class vtkIdList;
52 class vtkPointData;
54 class vtkCallbackCommand;
55 
56 class VTKCOMMONDATAMODEL_EXPORT vtkDataSet : public vtkDataObject
57 {
58 public:
59  vtkTypeMacro(vtkDataSet, vtkDataObject);
60  void PrintSelf(ostream& os, vtkIndent indent) override;
61 
68  virtual void CopyStructure(vtkDataSet* ds) = 0;
69 
75  virtual void CopyAttributes(vtkDataSet* ds);
76 
82 
87  virtual vtkIdType GetNumberOfCells() = 0;
88 
93  virtual double* GetPoint(vtkIdType ptId) VTK_SIZEHINT(3) = 0;
94 
101  virtual void GetPoint(vtkIdType id, double x[3]);
102 
108 
113  virtual vtkCell* GetCell(vtkIdType cellId) = 0;
114  virtual vtkCell* GetCell(int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
115  {
116  vtkErrorMacro("ijk indices are only valid with structured data!");
117  return nullptr;
118  }
119 
121 
129  virtual void GetCell(vtkIdType cellId, vtkGenericCell* cell) = 0;
130 
142  virtual void GetCellBounds(vtkIdType cellId, double bounds[6]);
143 
149  virtual int GetCellType(vtkIdType cellId) = 0;
150 
160  virtual void GetCellTypes(vtkCellTypes* types);
161 
167  virtual void GetCellPoints(vtkIdType cellId, vtkIdList* ptIds) = 0;
168 
174  virtual void GetPointCells(vtkIdType ptId, vtkIdList* cellIds) = 0;
175 
183  virtual void GetCellNeighbors(vtkIdType cellId, vtkIdList* ptIds, vtkIdList* cellIds);
184 
186 
193  vtkIdType FindPoint(double x, double y, double z)
194  {
195  double xyz[3];
196  xyz[0] = x;
197  xyz[1] = y;
198  xyz[2] = z;
199  return this->FindPoint(xyz);
200  }
201  virtual vtkIdType FindPoint(double x[3]) = 0;
203 
215  virtual vtkIdType FindCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2, int& subId,
216  double pcoords[3], double* weights) = 0;
217 
225  virtual vtkIdType FindCell(double x[3], vtkCell* cell, vtkGenericCell* gencell, vtkIdType cellId,
226  double tol2, int& subId, double pcoords[3], double* weights) = 0;
227 
236  virtual vtkCell* FindAndGetCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2,
237  int& subId, double pcoords[3], double* weights);
238 
243  vtkMTimeType GetMTime() override;
244 
249  vtkCellData* GetCellData() { return this->CellData; }
250 
255  vtkPointData* GetPointData() { return this->PointData; }
256 
261  virtual void Squeeze();
262 
267  virtual void ComputeBounds();
268 
274  double* GetBounds() VTK_SIZEHINT(6);
275 
282  void GetBounds(double bounds[6]);
283 
288  double* GetCenter() VTK_SIZEHINT(3);
289 
295  void GetCenter(double center[3]);
296 
302  double GetLength();
303 
308  void Initialize() override;
309 
320  virtual void GetScalarRange(double range[2]);
321 
331  double* GetScalarRange() VTK_SIZEHINT(2);
332 
338  virtual int GetMaxCellSize() = 0;
339 
348  unsigned long GetActualMemorySize() override;
349 
353  int GetDataObjectType() override { return VTK_DATA_SET; }
354 
356 
359  void ShallowCopy(vtkDataObject* src) override;
360  void DeepCopy(vtkDataObject* src) override;
362 
364  {
365  DATA_OBJECT_FIELD = 0,
366  POINT_DATA_FIELD = 1,
367  CELL_DATA_FIELD = 2
368  };
369 
379 
381 
386  virtual void GenerateGhostArray(int zeroExt[6]) { this->GenerateGhostArray(zeroExt, false); }
387  virtual void GenerateGhostArray(int zeroExt[6], bool cellOnly);
389 
391 
395  static vtkDataSet* GetData(vtkInformationVector* v, int i = 0);
397 
405 
410 
426  virtual bool HasAnyBlankCells() { return 0; }
432  virtual bool HasAnyBlankPoints() { return 0; }
433 
443 
448 
458 
463 
464 protected:
465  // Constructor with default bounds (0,1, 0,1, 0,1).
467  ~vtkDataSet() override;
468 
473  virtual void ComputeScalarRange();
474 
479  bool IsAnyBitSet(vtkUnsignedCharArray* a, int bitFlag);
480 
481  vtkCellData* CellData; // Scalars, vectors, etc. associated w/ each cell
482  vtkPointData* PointData; // Scalars, vectors, etc. associated w/ each point
483  vtkCallbackCommand* DataObserver; // Observes changes to cell/point data
484  vtkTimeStamp ComputeTime; // Time at which bounds, center, etc. computed
485  double Bounds[6]; // (xmin,xmax, ymin,ymax, zmin,zmax) geometric bounds
486  double Center[3];
487 
488  // Cached scalar range
489  double ScalarRange[2];
490 
491  // Time at which scalar range is computed
493 
495 
504 
505 private:
506  void InternalDataSetCopy(vtkDataSet* src);
511  static void OnDataModified(
512  vtkObject* source, unsigned long eid, void* clientdata, void* calldata);
513 
514  friend class vtkImageAlgorithmToDataSetFriendship;
515 
516 private:
517  vtkDataSet(const vtkDataSet&) = delete;
518  void operator=(const vtkDataSet&) = delete;
519 };
520 
521 inline void vtkDataSet::GetPoint(vtkIdType id, double x[3])
522 {
523  double* pt = this->GetPoint(id);
524  x[0] = pt[0];
525  x[1] = pt[1];
526  x[2] = pt[2];
527 }
528 
529 #endif
void GetPoint(const int i, const int j, const int k, double pnt[3])
supports function callbacks
represent and manipulate cell attribute data
Definition: vtkCellData.h:33
Efficient cell iterator for vtkDataSet topologies.
object provides direct access to cells in vtkCellArray and type information
Definition: vtkCellTypes.h:48
abstract class to specify cell behavior
Definition: vtkCell.h:57
general representation of visualization data
Definition: vtkDataObject.h:60
abstract class to specify dataset behavior
Definition: vtkDataSet.h:57
vtkFieldData * GetAttributesAsFieldData(int type) override
Returns the attributes of the data object as a vtkFieldData.
void ShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
virtual bool HasAnyBlankPoints()
Returns 1 if there are any blanking points 0 otherwise.
Definition: vtkDataSet.h:432
vtkUnsignedCharArray * GetPointGhostArray()
Gets the array that defines the ghost type of each point.
vtkMTimeType GetMTime() override
Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE.
vtkUnsignedCharArray * GetCellGhostArray()
Get the array that defines the ghost type of each cell.
vtkIdType GetNumberOfElements(int type) override
Get the number of elements for a specific attribute type (POINT, CELL, etc.).
bool HasAnyGhostCells()
Returns 1 if there are any ghost cells 0 otherwise.
static vtkDataSet * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
virtual vtkIdType FindCell(double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
Locate cell based on global coordinate x and tolerance squared.
virtual vtkCell * FindAndGetCell(double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
Locate the cell that contains a point and return the cell.
bool HasAnyGhostPoints()
Returns 1 if there are any ghost points 0 otherwise.
virtual void ComputeBounds()
Compute the data bounding box from data points.
vtkTimeStamp ComputeTime
Definition: vtkDataSet.h:484
virtual void CopyAttributes(vtkDataSet *ds)
Copy the attributes associated with the specified dataset to this instance of vtkDataSet.
virtual void GetPointCells(vtkIdType ptId, vtkIdList *cellIds)=0
Topological inquiry to get cells using point.
vtkUnsignedCharArray * PointGhostArray
These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using G...
Definition: vtkDataSet.h:499
vtkTimeStamp ScalarRangeComputeTime
Definition: vtkDataSet.h:492
virtual void GetCellBounds(vtkIdType cellId, double bounds[6])
Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells.
virtual vtkIdType FindCell(double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
This is a version of the above method that can be used with multithreaded applications.
virtual vtkIdType GetNumberOfPoints()=0
Determine the number of points composing the dataset.
bool CellGhostArrayCached
Definition: vtkDataSet.h:502
double * GetBounds()
Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,...
virtual void GetCell(vtkIdType cellId, vtkGenericCell *cell)=0
Get cell with cellId such that: 0 <= cellId < NumberOfCells.
virtual vtkCell * GetCell(vtkIdType cellId)=0
Get cell with cellId such that: 0 <= cellId < NumberOfCells.
virtual vtkIdType GetNumberOfCells()=0
Determine the number of cells composing the dataset.
static vtkDataSet * GetData(vtkInformationVector *v, int i=0)
virtual bool HasAnyBlankCells()
Returns 1 if there are any blanking cells 0 otherwise.
Definition: vtkDataSet.h:426
bool IsAnyBitSet(vtkUnsignedCharArray *a, int bitFlag)
Helper function that tests if any of the values in 'a' have bitFlag set.
bool PointGhostArrayCached
Definition: vtkDataSet.h:501
virtual void GenerateGhostArray(int zeroExt[6])
Normally called by pipeline executives or algorithms only.
Definition: vtkDataSet.h:386
vtkPointData * PointData
Definition: vtkDataSet.h:482
virtual void ComputeScalarRange()
Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (Scal...
virtual void GetCellTypes(vtkCellTypes *types)
Get a list of types of cells in a dataset.
virtual vtkCell * GetCell(int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
Definition: vtkDataSet.h:114
vtkUnsignedCharArray * CellGhostArray
Definition: vtkDataSet.h:500
virtual void CopyStructure(vtkDataSet *ds)=0
Copy the geometric and topological structure of an object.
vtkPointData * GetPointData()
Return a pointer to this dataset's point data.
Definition: vtkDataSet.h:255
vtkCellData * CellData
Definition: vtkDataSet.h:481
virtual int GetCellType(vtkIdType cellId)=0
Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.
virtual void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds)=0
Topological inquiry to get points defining cell.
vtkCallbackCommand * DataObserver
Definition: vtkDataSet.h:483
vtkCellData * GetCellData()
Return a pointer to this dataset's cell data.
Definition: vtkDataSet.h:249
void DeepCopy(vtkDataObject *src) override
virtual vtkCellIterator * NewCellIterator()
Return an iterator that traverses the cells in this data set.
void UpdateCellGhostArrayCache()
Updates the pointer to the cell ghost array.
vtkUnsignedCharArray * AllocateCellGhostArray()
Allocate ghost array for cells.
void SetCellOrderAndRationalWeights(vtkIdType cellId, vtkGenericCell *cell)
vtkIdType FindPoint(double x, double y, double z)
Locate the closest point to the global coordinate x.
Definition: vtkDataSet.h:193
virtual void Squeeze()
Reclaim any extra memory used to store data.
void UpdatePointGhostArrayCache()
Updates the pointer to the point ghost array.
~vtkDataSet() override
virtual void GetCellNeighbors(vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
Topological inquiry to get all cells using list of points exclusive of cell specified (e....
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void GenerateGhostArray(int zeroExt[6], bool cellOnly)
virtual double * GetPoint(vtkIdType ptId)=0
Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.
int CheckAttributes()
This method checks to see if the cell and point attributes match the geometry.
virtual vtkIdType FindPoint(double x[3])=0
vtkUnsignedCharArray * AllocatePointGhostArray()
Allocate ghost array for points.
represent and manipulate fields of data
Definition: vtkFieldData.h:54
provides thread-safe access to cells
list of point or cell ids
Definition: vtkIdList.h:31
a simple class to control print indentation
Definition: vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition: vtkObject.h:63
represent and manipulate point attribute data
Definition: vtkPointData.h:32
record modification and/or execution time
Definition: vtkTimeStamp.h:33
dynamic, self-adjusting array of unsigned char
@ info
Definition: vtkX3D.h:382
@ range
Definition: vtkX3D.h:244
@ center
Definition: vtkX3D.h:236
@ type
Definition: vtkX3D.h:522
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
int vtkIdType
Definition: vtkType.h:338
#define VTK_DATA_SET
Definition: vtkType.h:93
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:293
#define VTK_SIZEHINT(...)
#define VTK_NEWINSTANCE