vtkCellGridRenderRequest.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 vtkCellGridRenderRequest_h
#define vtkCellGridRenderRequest_h
#include "vtkCellGridQuery.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkStringToken.h"         // for ivars

#include <memory>        // for unique_ptr
#include <unordered_map> // for this->State

VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkCellGridMapper;
class vtkRenderer;
class vtkWindow;

class VTKRENDERINGCORE_EXPORT vtkCellGridRenderRequest : public vtkCellGridQuery
{
public:
  class VTKRENDERINGCORE_EXPORT BaseState
  {
  public:
    BaseState() = default;
    virtual ~BaseState() = default; // Force class to be polymorphic.
  };

  enum RenderableGeometry : unsigned char
  {
    VERTICES = 1,
    EDGES = 2,
    FACES = 4,
    VOLUMES = 8,
    SURFACE_WITH_EDGES = EDGES | FACES,
    ALL = VERTICES | EDGES | FACES | VOLUMES
  };

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

  virtual void SetMapper(vtkCellGridMapper* mapper);
  vtkGetObjectMacro(Mapper, vtkCellGridMapper);

  virtual void SetActor(vtkActor* actor);
  vtkGetObjectMacro(Actor, vtkActor);

  virtual void SetRenderer(vtkRenderer* renderer);
  vtkGetObjectMacro(Renderer, vtkRenderer);

  virtual void SetWindow(vtkWindow* window);
  vtkGetObjectMacro(Window, vtkWindow);

  vtkGetMacro(ShapesToDraw, char);
  vtkSetClampMacro(ShapesToDraw, char, 1, 9);

  bool Initialize() override;
  bool Finalize() override;

  vtkGetMacro(IsReleasingResources, bool);
  vtkSetMacro(IsReleasingResources, bool);

  template <typename StateType>
  StateType* GetState(vtkStringToken cellType, bool create = true)
  {
    auto it = this->State.find(cellType);
    if (it != this->State.end())
    {
      return static_cast<StateType*>(it->second.get());
    }

    if (create)
    {
      it = this->State.insert(std::make_pair(cellType, std::unique_ptr<BaseState>(new StateType)))
             .first;
      return static_cast<StateType*>(it->second.get());
    }

    return nullptr;
  }

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

  vtkCellGridMapper* Mapper{ nullptr };
  vtkActor* Actor{ nullptr };
  vtkRenderer* Renderer{ nullptr };
  vtkWindow* Window{ nullptr };
  bool IsReleasingResources{ false };
  char ShapesToDraw{ RenderableGeometry::ALL };
  std::unordered_map<vtkStringToken, std::unique_ptr<BaseState>> State;

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

VTK_ABI_NAMESPACE_END
#endif // vtkCellGridRenderRequest_h