vtkAbstractCellLinks.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 vtkAbstractCellLinks_h
#define vtkAbstractCellLinks_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDeprecation.h"           // For VTK_DEPRECATED_IN_9_5_0
#include "vtkObject.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDataSet;
class vtkCellArray;
class vtkIdList;
 
class VTKCOMMONDATAMODEL_EXPORT VTK_MARSHALAUTO vtkAbstractCellLinks : public vtkObject
{
public:

  vtkTypeMacro(vtkAbstractCellLinks, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual void SetDataSet(vtkDataSet*);
  vtkGetObjectMacro(DataSet, vtkDataSet);

  virtual void BuildLinks() = 0;

  virtual void Initialize() = 0;

  virtual void Squeeze() = 0;

  virtual void Reset() = 0;

  virtual unsigned long GetActualMemorySize() = 0;

  virtual void DeepCopy(vtkAbstractCellLinks* src) = 0;

  virtual void ShallowCopy(vtkAbstractCellLinks* src) = 0;
 
  // Enums for cell links type. Note that the specialized type is
  // set when users do not use ComputeType() and roll their own type.
  enum CellLinksTypes
  {
    LINKS_NOT_DEFINED = 0,
    CELL_LINKS = 1,
    STATIC_CELL_LINKS_USHORT = 2,
    STATIC_CELL_LINKS_UINT = 3,
    STATIC_CELL_LINKS_IDTYPE = 4,
    STATIC_CELL_LINKS_SPECIALIZED = 5
  };

  static int ComputeType(vtkIdType maxPtId, vtkIdType maxCellId, vtkCellArray* ca);
  static int ComputeType(vtkIdType maxPtId, vtkIdType maxCellId, vtkIdType connectivitySize);

  vtkGetMacro(Type, int);



  virtual void SelectCells(vtkIdType minMaxDegree[2], unsigned char* cellSelection) = 0;


  VTK_DEPRECATED_IN_9_5_0("No longer used.")
  vtkSetMacro(SequentialProcessing, bool);
  VTK_DEPRECATED_IN_9_5_0("No longer used.")
  vtkGetMacro(SequentialProcessing, bool);
  VTK_DEPRECATED_IN_9_5_0("No longer used.")
  virtual void SequentialProcessingOn()
  {
    if (!this->SequentialProcessing)
    {
      this->SequentialProcessing = true;
      this->Modified();
    }
  }
  VTK_DEPRECATED_IN_9_5_0("No longer used.")
  virtual void SequentialProcessingOff()
  {
    if (this->SequentialProcessing)
    {
      this->SequentialProcessing = false;
      this->Modified();
    }
  }



  vtkGetMacro(BuildTime, vtkMTimeType);


  bool UsesGarbageCollector() const override { return true; }
protected:
  vtkAbstractCellLinks();
  ~vtkAbstractCellLinks() override;
 
  vtkDataSet* DataSet;
  // VTK_DEPRECATED_IN_9_5_0("No longer used.")
  bool SequentialProcessing; // control whether to thread or not
  int Type;                  // derived classes set this instance variable when constructed
 
  vtkTimeStamp BuildTime; // time at which links were built
 
  void ReportReferences(vtkGarbageCollector*) override;
 
private:
  vtkAbstractCellLinks(const vtkAbstractCellLinks&) = delete;
  void operator=(const vtkAbstractCellLinks&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif