vtkGenericDataSet.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkGenericDataSet_h
#define vtkGenericDataSet_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDataObject.h"
#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_6_0()

VTK_ABI_NAMESPACE_BEGIN
class vtkCellTypes;
class vtkGenericCellIterator;
class vtkGenericAttributeCollection;
class vtkGenericCellTessellator;
class vtkGenericPointIterator;

class VTKCOMMONDATAMODEL_EXPORT vtkGenericDataSet : public vtkDataObject
{
public:

  vtkTypeMacro(vtkGenericDataSet, vtkDataObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual vtkIdType GetNumberOfPoints() = 0;

  virtual vtkIdType GetNumberOfCells(int dim = -1) = 0;

  vtkIdType GetNumberOfElements(int type) override;

  virtual int GetCellDimension() = 0;


  virtual void GetDistinctCellTypes(vtkCellTypes* types);
  VTK_DEPRECATED_IN_9_6_0("Use GetDistinctCellTypes(vtkCellTypes* types) instead.")
  virtual void GetCellTypes(vtkCellTypes* types) { this->GetDistinctCellTypes(types); }

  VTK_NEWINSTANCE
  virtual vtkGenericCellIterator* NewCellIterator(int dim = -1) = 0;

  VTK_NEWINSTANCE
  virtual vtkGenericCellIterator* NewBoundaryIterator(int dim = -1, int exteriorOnly = 0) = 0;

  VTK_NEWINSTANCE
  virtual vtkGenericPointIterator* NewPointIterator() = 0;

  virtual int FindCell(
    double x[3], vtkGenericCellIterator*& cell, double tol2, int& subId, double pcoords[3]) = 0;

  virtual void FindPoint(double x[3], vtkGenericPointIterator* p) = 0;

  vtkMTimeType GetMTime() override;

  virtual void ComputeBounds() = 0;

  virtual double* GetBounds();

  virtual void GetBounds(double bounds[6]);

  virtual double* GetCenter();

  virtual void GetCenter(double center[3]);

  virtual double GetLength();


  vtkGetObjectMacro(Attributes, vtkGenericAttributeCollection);

  vtkDataSetAttributes* GetAttributes(int type) override
  {
    return this->Superclass::GetAttributes(type);
  }


  virtual void SetTessellator(vtkGenericCellTessellator* tessellator);
  vtkGetObjectMacro(Tessellator, vtkGenericCellTessellator);

  unsigned long GetActualMemorySize() override;

  int GetDataObjectType() VTK_FUTURE_CONST override;

  virtual vtkIdType GetEstimatedSize() = 0;


  static vtkGenericDataSet* GetData(vtkInformation* info);
  static vtkGenericDataSet* GetData(vtkInformationVector* v, int i = 0);

protected:
  vtkGenericDataSet();

  ~vtkGenericDataSet() override;

  vtkGenericAttributeCollection* Attributes;

  // Main helper class to tessellate a higher order cell into linear ones.
  vtkGenericCellTessellator* Tessellator;

  double Bounds[6];         // (xmin,xmax, ymin,ymax, zmin,zmax) geometric bounds
  double Center[3];         // Center of the geometric bounding box
  vtkTimeStamp ComputeTime; // Time at which bounds, center, etc. computed

private:
  vtkGenericDataSet(const vtkGenericDataSet&) = delete;
  void operator=(const vtkGenericDataSet&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif