vtkCellAttribute.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 vtkCellAttribute_h
#define vtkCellAttribute_h

#include "vtkCommonDataModelModule.h" // for export
#include "vtkObject.h"
#include "vtkScalarsToColors.h" // for colormap
#include "vtkSmartPointer.h"    // for maps
#include "vtkStringToken.h"     // for vtkStringToken::Hash

#include <unordered_map>

VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractArray;
class vtkCellAttribute;
class vtkCellGrid;
class vtkDataSetAttributes;

class VTKCOMMONDATAMODEL_EXPORT vtkCellAttribute : public vtkObject
{
public:
  using ArraysForCellType = std::unordered_map<vtkStringToken, vtkSmartPointer<vtkAbstractArray>>;

  struct CellTypeInfo
  {
    // The array-group name holding shared degree-of-freedom (DOF)
    // data if the attribute is shared. This is invalid for
    // discontinuous attributes
    vtkStringToken DOFSharing;
    vtkStringToken FunctionSpace;
    vtkStringToken Basis;
    int Order;
    ArraysForCellType ArraysByRole;

    template <typename ArrayType>
    ArrayType* GetArrayForRoleAs(vtkStringToken role) const
    {
      auto it = this->ArraysByRole.find(role);
      if (it == this->ArraysByRole.end())
      {
        return nullptr;
      }
      return ArrayType::SafeDownCast(it->second);
    }

    bool operator!=(const CellTypeInfo& other) const;

    CellTypeInfo() = default;
    CellTypeInfo(const CellTypeInfo& other) = default;
    CellTypeInfo& operator=(const CellTypeInfo& other) = default;
  };

  using Arrays = std::unordered_map<vtkStringToken, CellTypeInfo>;

  vtkTypeMacro(vtkCellAttribute, vtkObject);
  static vtkCellAttribute* New();
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual vtkStringToken GetName() const { return this->Name; }

  vtkGetMacro(Id, int);
  vtkSetMacro(Id, int);

  virtual vtkStringToken GetSpace() const { return this->Space; }

  virtual int GetNumberOfComponents() const { return this->NumberOfComponents; }

  virtual bool Initialize(vtkStringToken name, vtkStringToken space, int numberOfComponents);

  virtual vtkStringToken::Hash GetHash() const;

  virtual CellTypeInfo GetCellTypeInfo(vtkStringToken cellType) const;

  vtkAbstractArray* GetArrayForCellTypeAndRole(
    vtkStringToken cellType, vtkStringToken arrayRole) const;

  virtual bool SetCellTypeInfo(vtkStringToken cellType, const CellTypeInfo& cellTypeInfo);

  vtkScalarsToColors* GetColormap() const { return this->Colormap; }
  bool SetColormap(vtkScalarsToColors* colormap);

  virtual void ShallowCopy(vtkCellAttribute* other, bool copyArrays = true);
  virtual void DeepCopy(vtkCellAttribute* other,
    const std::map<vtkAbstractArray*, vtkAbstractArray*>& arrayRewrites = {});

  static bool DecodeSpace(
    const std::string& space, std::string& base, double& exp, int& halfspace, bool quiet = false);

  static std::string EncodeSpace(const std::string& base, unsigned int, int halfspace = 0);

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

  vtkStringToken Name;
  vtkStringToken Space;
  int NumberOfComponents = 1;
  Arrays AllArrays;
  int Id = -1;
  vtkSmartPointer<vtkScalarsToColors> Colormap;

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

VTK_ABI_NAMESPACE_END
#endif