vtkStaticCellLinksTemplate.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 vtkStaticCellLinksTemplate_h
#define vtkStaticCellLinksTemplate_h
 
#include "vtkABINamespace.h"
#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_5_0
 
#include <memory> // For shared_ptr
#include <vector> // For vector
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDataSet;
class vtkPolyData;
class vtkUnstructuredGrid;
class vtkExplicitStructuredGrid;
class vtkCellArray;
VTK_ABI_NAMESPACE_END
 
#include "vtkAbstractCellLinks.h"
 
VTK_ABI_NAMESPACE_BEGIN
template <typename TIds>
class vtkStaticCellLinksTemplate
{
public:
 
  vtkStaticCellLinksTemplate();
  ~vtkStaticCellLinksTemplate();
 
  void Initialize();
 
  void BuildLinks(vtkDataSet* ds);
 
  void BuildLinks(vtkPolyData* pd);
 
  void BuildLinks(vtkUnstructuredGrid* ugrid);
 
  void BuildLinks(vtkExplicitStructuredGrid* esgrid);
 
 
  VTK_DEPRECATED_IN_9_5_0("Use BuildLinksFromMultipleArrays instead.")
  void SerialBuildLinksFromMultipleArrays(
    vtkIdType numPts, vtkIdType numCells, std::vector<vtkCellArray*> cellArrays)
  {
    this->BuildLinksFromMultipleArrays(numPts, numCells, cellArrays);
  }
  VTK_DEPRECATED_IN_9_5_0("Use BuildLinks instead.")
  void SerialBuildLinks(vtkIdType numPts, vtkIdType numCells, vtkCellArray* cellArray)
  {
    this->BuildLinksFromMultipleArrays(numPts, numCells, { cellArray });
  }
  VTK_DEPRECATED_IN_9_5_0("Use BuildLinksFromMultipleArrays instead.")
  void ThreadedBuildLinksFromMultipleArrays(
    vtkIdType numPts, vtkIdType numCells, std::vector<vtkCellArray*> cellArrays)
  {
    this->BuildLinksFromMultipleArrays(numPts, numCells, cellArrays);
  }
  VTK_DEPRECATED_IN_9_5_0("Use BuildLinks instead.")
  void ThreadedBuildLinks(vtkIdType numPts, vtkIdType numCells, vtkCellArray* cellArray)
  {
    this->BuildLinksFromMultipleArrays(numPts, numCells, { cellArray });
  }
  void BuildLinksFromMultipleArrays(
    vtkIdType numPts, vtkIdType numCells, std::vector<vtkCellArray*> cellArrays);
  void BuildLinks(vtkIdType numPts, vtkIdType numCells, vtkCellArray* cellArray)
  {
    this->BuildLinksFromMultipleArrays(numPts, numCells, { cellArray });
  }
 
 
  TIds GetNumberOfCells(vtkIdType ptId) { return (this->Offsets[ptId + 1] - this->Offsets[ptId]); }
  vtkIdType GetNcells(vtkIdType ptId) VTK_FUTURE_CONST
  {
    return (this->Offsets[ptId + 1] - this->Offsets[ptId]);
  }
 
  template <typename TGivenIds>
  bool MatchesCell(TGivenIds npts, const TGivenIds* pts);
 
  TIds* GetCells(vtkIdType ptId) { return (this->Links + this->Offsets[ptId]); }
 
  void GetCells(vtkIdType npts, const vtkIdType* pts, vtkIdList* cells);
 
  TIds GetLinksSize() { return this->LinksSize; }
 
  TIds GetOffset(vtkIdType ptId) { return this->Offsets[ptId]; }
 
 
  unsigned long GetActualMemorySize();
  VTK_DEPRECATED_IN_9_5_0("Use DeepCopy(vtkStaticCellLinksTemplate instead.")
  void DeepCopy(vtkAbstractCellLinks*) {}
  void DeepCopy(vtkStaticCellLinksTemplate* src);
  void ShallowCopy(vtkStaticCellLinksTemplate* src);
  void SelectCells(vtkIdType minMaxDegree[2], unsigned char* cellSelection);
 
 
  VTK_DEPRECATED_IN_9_5_0("No longer used.")
  void SetSequentialProcessing(vtkTypeBool seq) { this->SequentialProcessing = seq; }
  VTK_DEPRECATED_IN_9_5_0("No longer used.")
  vtkTypeBool GetSequentialProcessing() { return this->SequentialProcessing; }
 
protected:
  // The various templated data members
  TIds LinksSize;
  TIds NumPts;
  TIds NumCells;
 
  // These point to the core data structures
 
  std::shared_ptr<TIds> LinkSharedPtr;    // contiguous runs of cell ids
  TIds* Links;                            // Pointer to the links array
  std::shared_ptr<TIds> OffsetsSharedPtr; // offsets for each point into the links array
  TIds* Offsets;                          // Pointer to the offsets array
 
  // Support for execution
  int Type;
  // VTK_DEPRECATED_IN_9_5_0("No longer used.")
  vtkTypeBool SequentialProcessing;
 
private:
  vtkStaticCellLinksTemplate(const vtkStaticCellLinksTemplate&) = delete;
  void operator=(const vtkStaticCellLinksTemplate&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#include "vtkStaticCellLinksTemplate.txx"
 
#endif
// VTK-HeaderTest-Exclude: vtkStaticCellLinksTemplate.h