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 "vtkDeprecation.h"       // For VTK_DEPRECATED_IN_9_2_0
#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);
 
  void InsertCell(vtkIdType id, unsigned char type, vtkIdType loc);
 
  vtkIdType InsertNextCell(unsigned char type, vtkIdType loc);
 
  VTK_DEPRECATED_IN_9_2_0("Please use version without cellLocations.")
  void SetCellTypes(
    vtkIdType ncells, vtkUnsignedCharArray* cellTypes, vtkIdTypeArray* cellLocations);
 
  void SetCellTypes(vtkIdType ncells, vtkUnsignedCharArray* cellTypes);
 
  VTK_DEPRECATED_IN_9_2_0("Please use version without cellLocations.")
  void SetCellTypes(vtkIdType ncells, vtkUnsignedCharArray* cellTypes, vtkIntArray* cellLocations);
 
  VTK_DEPRECATED_IN_9_2_0("The Location API will disappear.")
  vtkIdType GetCellLocation(vtkIdType cellId) { return this->LocationArray->GetValue(cellId); }
 
  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, -1); }
 
  unsigned char GetCellType(vtkIdType cellId) { return this->TypeArray->GetValue(cellId); }
 
  void Squeeze();
 
  void Reset();
 
  unsigned long GetActualMemorySize();
 
  void DeepCopy(vtkCellTypes* src);
 
  static const char* GetClassNameFromTypeId(int typeId);
 
  static int GetTypeIdFromClassName(const char* classname);
 
  static int IsLinear(unsigned char type);
 
  static int GetDimension(unsigned char type);
 
 
  vtkUnsignedCharArray* GetCellTypesArray() { return this->TypeArray; }
  vtkIdTypeArray* GetCellLocationsArray() { return this->LocationArray; }
 
protected:
  vtkCellTypes();
  ~vtkCellTypes() override = default;
 
  vtkSmartPointer<vtkUnsignedCharArray> TypeArray; // pointer to types array
 
  // DEPRECATION_IN_9_2_0 Note for whoever is in deprecation duties:
  // The attribute LocationArray needs to be deleted, and any code in this class that would fail
  // compiling because of its removal deleted as well.
  vtkSmartPointer<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 ((type <= 20) || (type == VTK_CONVEX_POINT_SET) || (type == VTK_POLYHEDRON));
}
 
VTK_ABI_NAMESPACE_END
#endif