imstkAbstractVTKViewer.h

/*
** This file is part of the Interactive Medical Simulation Toolkit (iMSTK)
** iMSTK is distributed under the Apache License, Version 2.0.
** See accompanying NOTICE for details.
*/

#pragma once

#include "imstkViewer.h"

#include <vtkSmartPointer.h>

class vtkRenderWindow;
class vtkCallbackCommand;
class vtkInteractorStyle;

namespace imstk
{
class VTKRenderer;

class AbstractVTKViewer : public Viewer
{
public:
    enum class VTKLoggerMode
    {
        SHOW,
        MUTE,
        WRITE
    };

protected:
    AbstractVTKViewer(std::string name);
public:
    ~AbstractVTKViewer() override = default;

    Renderer::Mode getRenderingMode() const override;

    vtkSmartPointer<vtkRenderWindow> getVtkRenderWindow() const { return m_vtkRenderWindow; }

    void setSize(const int width, const int height) override;

    void setWindowTitle(const std::string& title) override;

    void setUseVsync(const bool useVsync) override;

    virtual void setBackgroundColors(const Color color1, const Color color2 = Color(0.0, 0.0, 0.0),
                                     const bool gradientBackground = false) override;

    void processEvents() override;

    void setVtkLoggerMode(VTKLoggerMode loggerMode);

    std::shared_ptr<VTKRenderer> getActiveVtkRenderer() const;

protected:
    bool initModule() override;

    void uninitModule() override;

    vtkSmartPointer<vtkRenderWindow>    m_vtkRenderWindow;
    vtkSmartPointer<vtkInteractorStyle> m_vtkInteractorStyle;
    vtkSmartPointer<vtkCallbackCommand> exitCallback;
    bool m_useVsync = false;
};
} // namespace imstk