vtkCellGridEvaluator.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 vtkCellGridEvaluator_h
#define vtkCellGridEvaluator_h

#include "vtkCellAttribute.h" // For Attribute ivar.
#include "vtkCellGridQuery.h"
#include "vtkNew.h"             // For ivars.
#include "vtkStringToken.h"     // For Allocations ivar.
#include "vtkTypeUInt32Array.h" // For ivars.
#include "vtkTypeUInt64Array.h" // For ivars.

#include <array>
#include <unordered_map>
#include <vector>

VTK_ABI_NAMESPACE_BEGIN

class vtkStaticPointLocator;
class vtkPointSet;

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

  enum Phases
  {
    None,
    Classify,
    ClassifyAndInterpolate,
    Interpolate
  };

  struct VTKCOMMONDATAMODEL_EXPORT AllocationsByCellType
  {
    struct ClassifiedPoint
    {
      vtkIdType InputPointId;
      vtkIdType CellId;
      std::array<double, 3> ParametricCoords;
    };

    std::vector<ClassifiedPoint> InputPoints;
    vtkIdType Offset{ 0 };

    vtkIdType GetNumberOfOutputPoints() const
    {
      return static_cast<vtkIdType>(this->InputPoints.size());
    }
  };

  vtkSetObjectMacro(CellAttribute, vtkCellAttribute);
  vtkGetObjectMacro(CellAttribute, vtkCellAttribute);

  vtkGetObjectMacro(InputPoints, vtkDataArray);

  vtkGetObjectMacro(ClassifierCellTypes, vtkTypeUInt32Array);

  vtkGetObjectMacro(ClassifierCellOffsets, vtkTypeUInt64Array);

  vtkGetObjectMacro(ClassifierPointIDs, vtkTypeUInt64Array);

  vtkGetObjectMacro(ClassifierCellIndices, vtkTypeUInt64Array);

  vtkGetObjectMacro(ClassifierPointParameters, vtkDataArray);

  vtkGetObjectMacro(InterpolatedValues, vtkDataArray);

  void ClassifyPoints(vtkDataArray* points);

  void InterpolatePoints(vtkDataArray* points);

  void InterpolateCellParameters(vtkTypeUInt32Array* cellTypes, vtkTypeUInt64Array* cellOffsets,
    vtkTypeUInt64Array* cellIndices, vtkDataArray* pointParameters);

  vtkGetEnumMacro(PhasesToPerform, vtkCellGridEvaluator::Phases);

  bool Initialize() override;
  void StartPass() override;
  bool IsAnotherPassRequired() override;
  bool Finalize() override;

  // Return a point locator that can be used to find input points quickly.
  // vtkStaticPointLocator* GetLocator();
  vtkGetObjectMacro(Locator, vtkStaticPointLocator);

  AllocationsByCellType& GetAllocationsForCellType(vtkStringToken cellType);

protected:
  vtkCellGridEvaluator();
  ~vtkCellGridEvaluator() override;

  vtkSetObjectMacro(InputPoints, vtkDataArray);

  vtkSetObjectMacro(ClassifierCellTypes, vtkTypeUInt32Array);

  vtkSetObjectMacro(ClassifierCellOffsets, vtkTypeUInt64Array);

  vtkSetObjectMacro(ClassifierPointIDs, vtkTypeUInt64Array);

  vtkSetObjectMacro(ClassifierCellIndices, vtkTypeUInt64Array);

  vtkSetObjectMacro(ClassifierPointParameters, vtkDataArray);

  vtkSetObjectMacro(InterpolatedValues, vtkDataArray);

  void AllocateClassificationOutput();
  void AllocatePositionOutput();
  void AllocateInterpolationOutput();

  vtkCellGrid* CellGrid{ nullptr };
  vtkCellAttribute* CellAttribute{ nullptr };
  vtkDataArray* InputPoints{ nullptr };
  vtkTypeUInt32Array* ClassifierCellTypes{ nullptr };
  vtkTypeUInt64Array* ClassifierCellOffsets{ nullptr };
  vtkTypeUInt64Array* ClassifierPointIDs{ nullptr };
  vtkTypeUInt64Array* ClassifierCellIndices{ nullptr };
  vtkDataArray* ClassifierPointParameters{ nullptr };
  vtkDataArray* InterpolatedValues{ nullptr };

  vtkNew<vtkStaticPointLocator> Locator;

  Phases PhasesToPerform{ Phases::None };
  vtkIdType NumberOfOutputPoints{ 0 };
  std::unordered_map<vtkStringToken, AllocationsByCellType> Allocations;

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

VTK_ABI_NAMESPACE_END
#endif // vtkCellGridEvaluator_h