vtkCellGridSampleQuery.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 vtkCellGridSampleQuery_h
#define vtkCellGridSampleQuery_h

#include "vtkCellGrid.h" // For API
#include "vtkCellGridQuery.h"
#include "vtkFiltersCellGridModule.h" // For export macro
#include "vtkIdTypeArray.h"           // For API
#include "vtkSmartPointer.h"          // For API
#include "vtkStringToken.h"           // For API
#include "vtkTable.h"                 // For API

VTK_ABI_NAMESPACE_BEGIN

class vtkCellAttribute;
class vtkCellGrid;
class vtkDataArray;
class vtkIdTypeArray;
class vtkTable;
class vtkTypeUInt32Array;

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


  vtkSetMacro(IncludeSourceCellInfo, bool);
  vtkGetMacro(IncludeSourceCellInfo, bool);
  vtkBooleanMacro(IncludeSourceCellInfo, bool);


  vtkSetMacro(IncludeSourceCellSite, bool);
  vtkGetMacro(IncludeSourceCellSite, bool);
  vtkBooleanMacro(IncludeSourceCellSite, bool);

  using OutputAllocations = std::unordered_map<vtkStringToken, vtkIdType>;

  enum PassType : int
  {
    CountOutputs = 0,   
    GenerateOutputs = 1 
  };

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

  bool IsAnotherPassRequired() override { return this->Pass < PassType::GenerateOutputs; }


  vtkSetSmartPointerMacro(Input, vtkCellGrid);
  vtkGetSmartPointerMacro(Input, vtkCellGrid);


  vtkSetSmartPointerMacro(Output, vtkTable);
  vtkGetSmartPointerMacro(Output, vtkTable);

  void AddOutputSamples(vtkStringToken inputCellType, vtkIdType numberOfOutputs);

  vtkIdType GetSampleOffset(vtkStringToken inputCellType);

  vtkDataArray* GetOutputAttributeColumn(vtkCellAttribute* inputAttribute);

  vtkIdTypeArray* GetSourceCellIdColumn() { return this->SourceCellId; }

  vtkDataArray* GetSourceCellSiteColumn() { return this->SourceCellSite; }

  OutputAllocations& GetOutputAllocations() { return this->OutputOffsets; }
  const OutputAllocations& GetOutputAllocations() const { return this->OutputOffsets; }


  vtkSetMacro(MaximumParametricDimension, int);
  vtkGetMacro(MaximumParametricDimension, int);

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

private:
  vtkSmartPointer<vtkCellGrid> Input;
  vtkSmartPointer<vtkTable> Output;

  bool IncludeSourceCellInfo{ false };
  bool IncludeSourceCellSite{ false };
  int MaximumParametricDimension{ 0 };

  OutputAllocations OutputOffsets;
  std::unordered_map<vtkCellAttribute*, vtkDataArray*> AttributeMap;
  vtkSmartPointer<vtkTypeUInt32Array> SourceCellType;
  vtkSmartPointer<vtkIdTypeArray> SourceCellId;
  vtkSmartPointer<vtkDataArray> SourceCellSite;

  vtkCellGridSampleQuery(const vtkCellGridSampleQuery&) = delete;
  void operator=(const vtkCellGridSampleQuery&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif // vtkCellGridSampleQuery_h