VTK  9.0.20210621
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 
121  virtual vtkCell* GetCell(vtkIdType cellId) = 0;
122  virtual vtkCell* GetCell(int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
123  {
124  vtkErrorMacro("ijk indices are only valid with structured data!");
125  return nullptr;
126  }
127 
129 
137  virtual void GetCell(vtkIdType cellId, vtkGenericCell* cell) = 0;
138 
150  virtual void GetCellBounds(vtkIdType cellId, double bounds[6]);
151 
157  virtual int GetCellType(vtkIdType cellId) = 0;
158 
168  virtual void GetCellTypes(vtkCellTypes* types);
169 
175  virtual void GetCellPoints(vtkIdType cellId, vtkIdList* ptIds) = 0;
176 
182  virtual void GetPointCells(vtkIdType ptId, vtkIdList* cellIds) = 0;
183 
191  virtual void GetCellNeighbors(vtkIdType cellId, vtkIdList* ptIds, vtkIdList* cellIds);
192 
194 
201  vtkIdType FindPoint(double x, double y, double z)
202  {
203  double xyz[3];
204  xyz[0] = x;
205  xyz[1] = y;
206  xyz[2] = z;
207  return this->FindPoint(xyz);
208  }
209  virtual vtkIdType FindPoint(double x[3]) = 0;
211 
223  virtual vtkIdType FindCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2, int& subId,
224  double pcoords[3], double* weights) = 0;
225 
233  virtual vtkIdType FindCell(double x[3], vtkCell* cell, vtkGenericCell* gencell, vtkIdType cellId,
234  double tol2, int& subId, double pcoords[3], double* weights) = 0;
235 
244  virtual vtkCell* FindAndGetCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2,
245  int& subId, double pcoords[3], double* weights);
246 
251  vtkMTimeType GetMTime() override;
252 
257  vtkCellData* GetCellData() { return this->CellData; }
258 
263  vtkPointData* GetPointData() { return this->PointData; }
264 
269  virtual void Squeeze();
270 
275  virtual void ComputeBounds();
276 
282  double* GetBounds() VTK_SIZEHINT(6);
283 
290  void GetBounds(double bounds[6]);
291 
296  double* GetCenter() VTK_SIZEHINT(3);
297 
303  void GetCenter(double center[3]);
304 
310  double GetLength();
311 
316  void Initialize() override;
317 
328  virtual void GetScalarRange(double range[2]);
329 
339  double* GetScalarRange() VTK_SIZEHINT(2);
340 
346  virtual int GetMaxCellSize() = 0;
347 
356  unsigned long GetActualMemorySize() override;
357 
361  int GetDataObjectType() override { return VTK_DATA_SET; }
362 
364 
367  void ShallowCopy(vtkDataObject* src) override;
368  void DeepCopy(vtkDataObject* src) override;
370 
372  {
373  DATA_OBJECT_FIELD = 0,
374  POINT_DATA_FIELD = 1,
375  CELL_DATA_FIELD = 2
376  };
377 
387 
389 
394  virtual void GenerateGhostArray(int zeroExt[6]) { this->GenerateGhostArray(zeroExt, false); }
395  virtual void GenerateGhostArray(int zeroExt[6], bool cellOnly);
397 
399 
403  static vtkDataSet* GetData(vtkInformationVector* v, int i = 0);
405 
413 
418 
434  virtual bool HasAnyBlankCells() { return false; }
440  virtual bool HasAnyBlankPoints() { return false; }
441 
451 
456 
466 
471 
472 protected:
473  // Constructor with default bounds (0,1, 0,1, 0,1).
475  ~vtkDataSet() override;
476 
481  virtual void ComputeScalarRange();
482 
487  bool IsAnyBitSet(vtkUnsignedCharArray* a, int bitFlag);
488 
489  vtkCellData* CellData; // Scalars, vectors, etc. associated w/ each cell
490  vtkPointData* PointData; // Scalars, vectors, etc. associated w/ each point
491  vtkCallbackCommand* DataObserver; // Observes changes to cell/point data
492  vtkTimeStamp ComputeTime; // Time at which bounds, center, etc. computed
493  double Bounds[6]; // (xmin,xmax, ymin,ymax, zmin,zmax) geometric bounds
494  double Center[3];
495 
496  // Cached scalar range
497  double ScalarRange[2];
498 
499  // Time at which scalar range is computed
501 
503 
512 
513 private:
514  void InternalDataSetCopy(vtkDataSet* src);
519  static void OnDataModified(
520  vtkObject* source, unsigned long eid, void* clientdata, void* calldata);
521 
522  friend class vtkImageAlgorithmToDataSetFriendship;
523 
524 private:
525  vtkDataSet(const vtkDataSet&) = delete;
526  void operator=(const vtkDataSet&) = delete;
527 };
528 
529 inline void vtkDataSet::GetPoint(vtkIdType id, double x[3])
530 {
531  double* pt = this->GetPoint(id);
532  x[0] = pt[0];
533  x[1] = pt[1];
534  x[2] = pt[2];
535 }
536 
537 #endif
vtkDataSet::IsAnyBitSet
bool IsAnyBitSet(vtkUnsignedCharArray *a, int bitFlag)
Helper function that tests if any of the values in 'a' have bitFlag set.
vtkDataSet::ComputeScalarRange
virtual void ComputeScalarRange()
Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (Scal...
vtkDataSet::UpdateCellGhostArrayCache
void UpdateCellGhostArrayCache()
Updates the pointer to the cell ghost array.
vtkDataSet::GetNumberOfPoints
virtual vtkIdType GetNumberOfPoints()=0
Determine the number of points composing the dataset.
vtkDataSet::PointGhostArrayCached
bool PointGhostArrayCached
These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using G...
Definition: vtkDataSet.h:509
vtkDataSet::PointGhostArray
vtkUnsignedCharArray * PointGhostArray
These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using G...
Definition: vtkDataSet.h:507
vtkDataSet::CellData
vtkCellData * CellData
Definition: vtkDataSet.h:489
vtkDataSet::GetData
static vtkDataSet * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
vtkCellTypes
object provides direct access to cells in vtkCellArray and type information
Definition: vtkCellTypes.h:48
vtkDataSet::ShallowCopy
void ShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
vtkDataSet::GetAttributesAsFieldData
vtkFieldData * GetAttributesAsFieldData(int type) override
Returns the attributes of the data object as a vtkFieldData.
vtkDataSet::DataObserver
vtkCallbackCommand * DataObserver
Definition: vtkDataSet.h:491
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:33
vtkDataSet::ScalarRangeComputeTime
vtkTimeStamp ScalarRangeComputeTime
Definition: vtkDataSet.h:500
vtkDataSet::GetCellGhostArray
vtkUnsignedCharArray * GetCellGhostArray()
Get the array that defines the ghost type of each cell.
vtkX3D::type
@ type
Definition: vtkX3D.h:522
vtkIdType
int vtkIdType
Definition: vtkType.h:332
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:36
vtkDataSet::CopyAttributes
virtual void CopyAttributes(vtkDataSet *ds)
Copy the attributes associated with the specified dataset to this instance of vtkDataSet.
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:33
vtkDataSet::~vtkDataSet
~vtkDataSet() override
vtkUnsignedCharArray
dynamic, self-adjusting array of unsigned char
Definition: vtkUnsignedCharArray.h:36
vtkDataSet::CellGhostArrayCached
bool CellGhostArrayCached
These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using G...
Definition: vtkDataSet.h:510
vtkDataSet::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkX3D::range
@ range
Definition: vtkX3D.h:244
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:63
vtkDataSet::GetData
static vtkDataSet * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
vtkX3D::center
@ center
Definition: vtkX3D.h:236
vtkDataSet::FieldDataType
FieldDataType
Definition: vtkDataSet.h:372
vtkDataSet::FindCell
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.
vtkDataSet::FindCell
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.
GetPoint
void GetPoint(const int i, const int j, const int k, double pnt[3])
vtkFieldData
represent and manipulate fields of data
Definition: vtkFieldData.h:55
VTK_DATA_SET
#define VTK_DATA_SET
Definition: vtkType.h:85
vtkDataSet::vtkDataSet
vtkDataSet()
vtkDataSet::ComputeBounds
virtual void ComputeBounds()
Compute the data bounding box from data points.
vtkDataSet::GetCellData
vtkCellData * GetCellData()
Return a pointer to this dataset's cell data.
Definition: vtkDataSet.h:257
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:48
vtkDataSet::HasAnyGhostCells
bool HasAnyGhostCells()
Returns 1 if there are any ghost cells 0 otherwise.
vtkDataSet::FindPoint
vtkIdType FindPoint(double x, double y, double z)
Locate the closest point to the global coordinate x.
Definition: vtkDataSet.h:201
vtkDataSet::SetCellOrderAndRationalWeights
void SetCellOrderAndRationalWeights(vtkIdType cellId, vtkGenericCell *cell)
vtkDataSet::GetCellNeighbors
virtual void GetCellNeighbors(vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
Topological inquiry to get all cells using list of points exclusive of cell specified (e....
vtkDataSet::AllocatePointGhostArray
vtkUnsignedCharArray * AllocatePointGhostArray()
Allocate ghost array for points.
vtkDataSet::GetMTime
vtkMTimeType GetMTime() override
Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE.
vtkCell
abstract class to specify cell behavior
Definition: vtkCell.h:58
vtkBlockSortHelper::GetBounds
void GetBounds(T a, double bds[6])
Definition: vtkBlockSortHelper.h:37
vtkDataSet::GetPointData
vtkPointData * GetPointData()
Return a pointer to this dataset's point data.
Definition: vtkDataSet.h:263
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:33
vtkDataSet::GetPointCells
virtual void GetPointCells(vtkIdType ptId, vtkIdList *cellIds)=0
Topological inquiry to get cells using point.
vtkDataSet::Squeeze
virtual void Squeeze()
Reclaim any extra memory used to store data.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:31
vtkDataSet::HasAnyBlankCells
virtual bool HasAnyBlankCells()
Returns 1 if there are any blanking cells 0 otherwise.
Definition: vtkDataSet.h:434
vtkDataSet::UpdatePointGhostArrayCache
void UpdatePointGhostArrayCache()
Updates the pointer to the point ghost array.
vtkDataSet::HasAnyBlankPoints
virtual bool HasAnyBlankPoints()
Returns 1 if there are any blanking points 0 otherwise.
Definition: vtkDataSet.h:440
vtkDataSet::CheckAttributes
int CheckAttributes()
This method checks to see if the cell and point attributes match the geometry.
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:57
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:74
vtkDataSet::GetCellPoints
virtual void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds)=0
Topological inquiry to get points defining cell.
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkDataSet::GetPoint
virtual double * GetPoint(vtkIdType ptId)=0
Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.
vtkDataSet::AllocateCellGhostArray
vtkUnsignedCharArray * AllocateCellGhostArray()
Allocate ghost array for cells.
vtkDataSet::NewCellIterator
virtual vtkCellIterator * NewCellIterator()
Return an iterator that traverses the cells in this data set.
vtkDataSet::PointData
vtkPointData * PointData
Definition: vtkDataSet.h:490
vtkDataObject.h
vtkDataSet::GetCellTypes
virtual void GetCellTypes(vtkCellTypes *types)
Get a list of types of cells in a dataset.
vtkDataSet::FindPoint
virtual vtkIdType FindPoint(double x[3])=0
Locate the closest point to the global coordinate x.
vtkDataSet::CopyStructure
virtual void CopyStructure(vtkDataSet *ds)=0
Copy the geometric and topological structure of an object.
vtkCallbackCommand
supports function callbacks
Definition: vtkCallbackCommand.h:45
vtkGenericCell
provides thread-safe access to cells
Definition: vtkGenericCell.h:37
vtkDataSet::HasAnyGhostPoints
bool HasAnyGhostPoints()
Returns 1 if there are any ghost points 0 otherwise.
vtkDataSet::GetBounds
double * GetBounds()
Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,...
vtkDataSet::GetNumberOfElements
vtkIdType GetNumberOfElements(int type) override
Get the number of elements for a specific attribute type (POINT, CELL, etc.).
vtkDataSet::GetPointGhostArray
vtkUnsignedCharArray * GetPointGhostArray()
Gets the array that defines the ghost type of each point.
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:959
vtkDataSet::GetNumberOfCells
virtual vtkIdType GetNumberOfCells()=0
Determine the number of cells composing the dataset.
VTK_NEWINSTANCE
#define VTK_NEWINSTANCE
Definition: vtkWrappingHints.h:44
vtkCellIterator
Efficient cell iterator for vtkDataSet topologies.
Definition: vtkCellIterator.h:78
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:60
vtkDataSet::GetCellType
virtual int GetCellType(vtkIdType cellId)=0
Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.
vtkDataSet::GetCellBounds
virtual void GetCellBounds(vtkIdType cellId, double bounds[6])
Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells.
vtkDataSet::CellGhostArray
vtkUnsignedCharArray * CellGhostArray
These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using G...
Definition: vtkDataSet.h:508
vtkDataSet::ComputeTime
vtkTimeStamp ComputeTime
Definition: vtkDataSet.h:492
vtkDataSet::FindAndGetCell
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.
vtkDataSet::DeepCopy
void DeepCopy(vtkDataObject *src) override
Shallow and Deep copy.
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287