vtkAbstractCellArray.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 vtkAbstractCellArray_h
#define vtkAbstractCellArray_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkNew.h"                   // for vtkNew
#include "vtkObject.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

#include <initializer_list> // for std::initializer_list

VTK_ABI_NAMESPACE_BEGIN

class vtkDataArray;
class vtkIdList;

class VTKCOMMONDATAMODEL_EXPORT VTK_MARSHALAUTO vtkAbstractCellArray : public vtkObject
{
public:
  vtkTypeMacro(vtkAbstractCellArray, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void Initialize() = 0;

  virtual vtkIdType GetNumberOfCells() const = 0;

  virtual vtkIdType GetNumberOfOffsets() const = 0;

  virtual vtkIdType GetOffset(vtkIdType cellId) = 0;

  virtual vtkIdType GetNumberOfConnectivityIds() const = 0;

  virtual bool IsStorageShareable() const = 0;

  virtual vtkIdType IsHomogeneous() const = 0;

  void GetCellAtId(vtkIdType cellId, vtkIdType& cellSize, vtkIdType const*& cellPoints)
    VTK_SIZEHINT(cellPoints, cellSize) VTK_EXPECTS(0 <= cellId && cellId < GetNumberOfCells());

  virtual void GetCellAtId(
    vtkIdType cellId, vtkIdType& cellSize, vtkIdType const*& cellPoints, vtkIdList* ptIds)
    VTK_SIZEHINT(cellPoints, cellSize) VTK_EXPECTS(0 <= cellId && cellId < GetNumberOfCells()) = 0;

  virtual void GetCellAtId(vtkIdType cellId, vtkIdList* pts)
    VTK_EXPECTS(0 <= cellId && cellId < GetNumberOfCells()) = 0;

  virtual void GetCellAtId(vtkIdType cellId, vtkIdType& cellSize, vtkIdType* cellPoints)
    VTK_SIZEHINT(cellPoints, cellSize) VTK_EXPECTS(0 <= cellId && cellId < GetNumberOfCells()) = 0;

  virtual vtkIdType GetCellSize(vtkIdType cellId) const = 0;

  virtual int GetMaxCellSize() = 0;

  virtual void DeepCopy(vtkAbstractCellArray* ca) = 0;

  virtual void ShallowCopy(vtkAbstractCellArray* ca) = 0;

protected:
  vtkAbstractCellArray();
  ~vtkAbstractCellArray() override;

  vtkNew<vtkIdList> TempCell;

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

VTK_ABI_NAMESPACE_END
#endif // vtkAbstractCellArray_h