vtkCellTypes.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 vtkCellTypes_h
#define vtkCellTypes_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"

#include "vtkCellType.h"          // Needed for inline methods
#include "vtkCellTypeUtilities.h" // for backward compatibility
#include "vtkDeprecation.h"       // for deprec macros
#include "vtkIdTypeArray.h"       // Needed for inline methods
#include "vtkSmartPointer.h"      // Needed for internals
#include "vtkUnsignedCharArray.h" // Needed for inline methods

VTK_ABI_NAMESPACE_BEGIN
class vtkIntArray;

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

  int Allocate(vtkIdType sz = 512, vtkIdType ext = 1000);


  VTK_DEPRECATED_IN_9_6_0("Location is not used anymore, use InsertCell(id, type).")
  void InsertCell(vtkIdType id, unsigned char type, vtkIdType);
  void InsertCell(vtkIdType id, unsigned char type);


  VTK_DEPRECATED_IN_9_6_0("Location is not used anymore, use InsertCell(id, type).")
  vtkIdType InsertNextCell(unsigned char type, vtkIdType);
  vtkIdType InsertNextCell(unsigned char type);

  void SetCellTypes(vtkIdType ncells, vtkUnsignedCharArray* cellTypes);

  void DeleteCell(vtkIdType cellId) { this->TypeArray->SetValue(cellId, VTK_EMPTY_CELL); }

  vtkIdType GetNumberOfTypes() { return (this->MaxId + 1); }

  int IsType(unsigned char type);

  vtkIdType InsertNextType(unsigned char type) { return this->InsertNextCell(type); }

  unsigned char GetCellType(vtkIdType cellId) { return this->TypeArray->GetValue(cellId); }

  void Squeeze();

  void Reset();

  unsigned long GetActualMemorySize();

  void DeepCopy(vtkCellTypes* src);

  VTK_DEPRECATED_IN_9_6_0("Use vtkCellTypeUtilities variant instead.")
  static const char* GetClassNameFromTypeId(int typeId);

  VTK_DEPRECATED_IN_9_6_0("Use vtkCellTypeUtilities variant instead.")
  static int GetTypeIdFromClassName(const char* classname);

  VTK_DEPRECATED_IN_9_6_0("Use vtkCellTypeUtilities variant instead.")
  static int IsLinear(unsigned char type);

  VTK_DEPRECATED_IN_9_6_0("Use vtkCellTypeUtilities variant instead.")
  static int GetDimension(unsigned char type);


  vtkUnsignedCharArray* GetCellTypesArray() { return this->TypeArray; }
  VTK_DEPRECATED_IN_9_6_0("Location is not used anymore.")
  vtkIdTypeArray* GetCellLocationsArray() { return this->LocationArray; }

protected:
  vtkCellTypes();
  ~vtkCellTypes() override = default;

  vtkSmartPointer<vtkUnsignedCharArray> TypeArray; // pointer to types array

  // VTK_DEPRECATED_IN_9_6_0
  vtkNew<vtkIdTypeArray> LocationArray; // pointer to array of offsets

  vtkIdType MaxId; // maximum index inserted thus far

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

//----------------------------------------------------------------------------
inline int vtkCellTypes::IsType(unsigned char type)
{
  vtkIdType numTypes = this->GetNumberOfTypes();

  for (vtkIdType i = 0; i < numTypes; i++)
  {
    if (type == this->GetCellType(i))
    {
      return 1;
    }
  }
  return 0;
}

//-----------------------------------------------------------------------------
inline int vtkCellTypes::IsLinear(unsigned char type)
{
  return vtkCellTypeUtilities::IsLinear(type);
}

VTK_ABI_NAMESPACE_END
#endif