vtkDGRenderResponder.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 vtkDGRenderResponder_h
#define vtkDGRenderResponder_h

#include "vtkCellGridRenderRequest.h"

#include "vtkCellGridResponder.h"    // For API.
#include "vtkDGCell.h"               // For API.
#include "vtkDrawTexturedElements.h" // For CacheEntry.
#include "vtkInformation.h"          // For CacheEntry.
#include "vtkOpenGLHardwareSelector.h"
#include "vtkRenderingCellGridModule.h" // For Export macro

#include <string>
#include <vector>

VTK_ABI_NAMESPACE_BEGIN

class vtkCellMetadata;
class vtkDGCell;
class vtkDGRenderResponders;
class vtkCellAttributeInformation;

class VTKRENDERINGCELLGRID_EXPORT vtkDGRenderResponder
  : public vtkCellGridResponder<vtkCellGridRenderRequest>
{
public:
  static vtkDGRenderResponder* New();
  vtkTypeMacro(vtkDGRenderResponder, vtkCellGridResponder<vtkCellGridRenderRequest>);

  bool Query(vtkCellGridRenderRequest* request, vtkCellMetadata* metadata,
    vtkCellGridResponders* caches) override;

  void AddMod(const std::string& className);
  void AddMods(const std::vector<std::string>& classNames);
  void RemoveMod(const std::string& className);
  void RemoveAllMods();

  void ResetModsToDefault();

  enum class ScalarVisualizationOverrideType : int
  {
    NONE,
    R,
    S,
    T,
    L2_NORM_R_S,
    L2_NORM_S_T,
    L2_NORM_T_R,
  };

  static void SetScalarVisualizationOverrideType(ScalarVisualizationOverrideType type)
  {
    ScalarVisualizationOverride = type;
  }

  static void SetVisualizeTessellation(bool value) { VisualizeTessellation = value; }

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

  bool DrawCells(vtkCellGridRenderRequest* request, vtkCellMetadata* metadata);
  bool ReleaseResources(vtkCellGridRenderRequest* request, vtkCellMetadata* metadata);

  bool DrawShapes(vtkCellGridRenderRequest* request, vtkDGCell* metadata,
    const vtkDGCell::Source& cellSource, int cellTypeIdx, std::size_t specIdx);
  // std::pair<GLenum, std::vector<GLubyte>> ShapeToPrimitiveInfo(int shapeId);

  struct CacheEntry
  {
    vtkSmartPointer<vtkDGCell> CellType;
    const vtkDGCell::Source* CellSource;
    vtkSmartPointer<vtkCellAttribute> Shape;
    vtkSmartPointer<vtkCellAttribute> Color;
    vtkNew<vtkInformation> LastRenderPassInfo;

    mutable std::unique_ptr<vtkDrawTexturedElements> RenderHelper;
    mutable vtkMTimeType ShapeTime;
    mutable vtkMTimeType ColorTime;
    mutable vtkMTimeType GridTime;
    mutable vtkMTimeType PropertyTime;
    mutable vtkMTimeType MapperTime;
    mutable vtkMTimeType RenderPassStageTime{ 0 };
    mutable bool UsesTessellationShaders;
    mutable bool UsesGeometryShaders;

    std::vector<std::string> ModNames;

    bool IsUpToDate(vtkRenderer* renderer, vtkActor* actor, vtkMapper* mapper,
      vtkDGRenderResponder* responder) const;

    void PrepareHelper(vtkRenderer* renderer, vtkActor* actor, vtkMapper* mapper) const;

    bool operator<(const CacheEntry& other) const;
  };

  std::set<CacheEntry> Helpers;
  static vtkDrawTexturedElements::ElementShape PrimitiveFromShape(vtkDGCell::Shape shape);
  static vtkDrawTexturedElements::PatchShape PatchPrimitiveFromShape(vtkDGCell::Shape shape);

  std::vector<std::string> ModNames;
  std::set<std::string> ModNamesUnique;
  static std::vector<std::string> DefaultModNames;

  static ScalarVisualizationOverrideType ScalarVisualizationOverride;

  static bool VisualizeTessellation;

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

VTK_ABI_NAMESPACE_END
#endif // vtkDGRenderResponder_h
// VTK-HeaderTest-Exclude: vtkDGRenderResponder.h