vtkCellGridSidesQuery.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 vtkCellGridSidesQuery_h
#define vtkCellGridSidesQuery_h

#include "vtkCellGridQuery.h"

#include "vtkStringToken.h" // For API.

#include <functional>
#include <map>
#include <set>
#include <unordered_map>
#include <vector>

VTK_ABI_NAMESPACE_BEGIN

class vtkCellGridSidesCache;
class vtkIdTypeArray;

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

  enum SideFlags : int
  {
    // Individual bits
    VerticesOfEdges = 0x01,    
    VerticesOfSurfaces = 0x02, 
    EdgesOfSurfaces = 0x04,    
    VerticesOfVolumes = 0x08,  
    EdgesOfVolumes = 0x10,     
    SurfacesOfVolumes = 0x20,  

    // Useful (but not exhaustive) combinations
    SurfacesOfInputs = 0x20,   
    EdgesOfInputs = 0x14,      
    VerticesOfInputs = 0x0b,   
    AllSides = 0x3f,           
    NextLowestDimension = 0x25 
  };

  enum PassWork : int
  {
    HashSides = 0,
    Summarize = 1,
    GenerateSideSets = 2
  };

  enum SummaryStrategy
  {
    Winding,
    AnyOccurrence,
    Boundary
  };

  enum SelectionMode
  {
    Input, 
    Output 
  };

  struct SideSetArray
  {
    vtkStringToken CellType;
    vtkStringToken SideShape;
    vtkSmartPointer<vtkIdTypeArray> Sides;
  };

  vtkSetMacro(PreserveRenderableInputs, vtkTypeBool);
  vtkGetMacro(PreserveRenderableInputs, vtkTypeBool);
  vtkBooleanMacro(PreserveRenderableInputs, vtkTypeBool);

  vtkSetMacro(OmitSidesForRenderableInputs, vtkTypeBool);
  vtkGetMacro(OmitSidesForRenderableInputs, vtkTypeBool);
  vtkBooleanMacro(OmitSidesForRenderableInputs, vtkTypeBool);

  vtkSetMacro(OutputDimensionControl, int);
  vtkGetMacro(OutputDimensionControl, int);
  vtkBooleanMacro(OutputDimensionControl, int);

  vtkSetEnumMacro(Strategy, SummaryStrategy);
  vtkGetEnumMacro(Strategy, SummaryStrategy);
  void SetStrategyToWinding() { this->SetStrategy(SummaryStrategy::Winding); }
  void SetStrategyToAnyOccurrence() { this->SetStrategy(SummaryStrategy::AnyOccurrence); }
  void SetStrategyToBoundary() { this->SetStrategy(SummaryStrategy::Boundary); }
  virtual void SetStrategy(int strategy)
  {
    this->SetStrategy(static_cast<SummaryStrategy>(strategy));
  }

  vtkSetEnumMacro(SelectionType, SelectionMode);
  vtkGetEnumMacro(SelectionType, SelectionMode);
  virtual void SetSelectionType(int selnType)
  {
    this->SetSelectionType(static_cast<SelectionMode>(selnType));
  }

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

  std::unordered_map<vtkStringToken,
    std::unordered_map<vtkStringToken, std::unordered_map<vtkIdType, std::set<int>>>>&
  GetSides()
  {
    return this->Sides;
  }

  std::vector<SideSetArray> GetSideSetArrays(vtkStringToken cellType);

  static vtkStringToken SelectionModeToLabel(SelectionMode mode);
  static SelectionMode SelectionModeFromLabel(vtkStringToken token);

  static vtkStringToken SummaryStrategyToLabel(SummaryStrategy strategy);
  static SummaryStrategy SummaryStrategyFromLabel(vtkStringToken token);

  vtkGetObjectMacro(SideCache, vtkCellGridSidesCache);
  virtual void SetSideCache(vtkCellGridSidesCache* cache);

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

  vtkTypeBool PreserveRenderableInputs{ false };
  vtkTypeBool OmitSidesForRenderableInputs{ false };
  int OutputDimensionControl{ SideFlags::SurfacesOfInputs };
  SelectionMode SelectionType{ SelectionMode::Input };
  SummaryStrategy Strategy{ SummaryStrategy::Boundary };
  vtkCellGridSidesCache* SideCache{ nullptr };
  bool TemporarySideCache{ false };
  std::unordered_map<vtkStringToken,
    std::unordered_map<vtkStringToken, std::unordered_map<vtkIdType, std::set<int>>>>
    Sides;

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

VTK_ABI_NAMESPACE_END
#endif // vtkCellGridSidesQuery_h