vtkStructuredCellArray.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 vtkStructuredCellArray_h
#define vtkStructuredCellArray_h

#include "vtkAbstractCellArray.h"
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkSmartPointer.h"          // For vtkSmartPointer

VTK_ABI_NAMESPACE_BEGIN

template <typename T, int ArrayType>
class vtkImplicitArray;

class VTKCOMMONDATAMODEL_EXPORT vtkStructuredCellArray : public vtkAbstractCellArray
{
public:
  static vtkStructuredCellArray* New();
  vtkTypeMacro(vtkStructuredCellArray, vtkAbstractCellArray);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Initialize() override;

  vtkIdType GetNumberOfCells() const override;

  vtkIdType GetNumberOfOffsets() const override;

  vtkIdType GetOffset(vtkIdType cellId) override;

  vtkIdType GetNumberOfConnectivityIds() const override;

  void SetData(VTK_FUTURE_CONST int extent[6], bool usePixelVoxelOrientation);

  bool IsStorageShareable() const override { return false; }

  vtkIdType IsHomogeneous() const override;

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

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

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

  void GetCellAtId(int ijk[3], vtkIdList* ptIds);

  void GetCellAtId(int ijk[3], vtkIdType& cellSize, vtkIdType* cellPoints);

  vtkIdType GetCellSize(vtkIdType cellId) const override;

  int GetMaxCellSize() override;

  void DeepCopy(vtkAbstractCellArray* ca) override;

  void ShallowCopy(vtkAbstractCellArray* ca) override;

protected:
  vtkStructuredCellArray();
  ~vtkStructuredCellArray() override;

  struct vtkStructuredCellBackend;
  template <int DataDescription, bool UsePixelVoxelOrientation>
  struct vtkStructuredTCellBackend;
  vtkSmartPointer<vtkImplicitArray<vtkStructuredCellBackend, vtkArrayTypes::VTK_IMPLICIT_ARRAY>>
    Connectivity;

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

VTK_ABI_NAMESPACE_END
#endif // vtkStructuredCellArray_h