imstkViewer.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 "imstkRenderer.h"
#include "imstkModule.h"

#include <unordered_map>

namespace imstk
{
class Camera;
class Entity;
class InteractorStyle;
class KeyboardDeviceClient;
class MouseDeviceClient;
class Scene;
class ScreenCaptureUtility;

struct ViewerConfig
{
    std::string m_windowName = "imstk";

    bool m_hideCurzor = false;
    bool m_hideBorder = true;
    bool m_fullScreen = false;

    int m_renderWinWidth  = 1000;
    int m_renderWinHeight = 800;
};

class Viewer : public Module
{
protected:
    Viewer(std::string name);
public:
    ~Viewer() override = default;

    std::shared_ptr<Scene> getActiveScene() const { return m_activeScene; }

    void setDebugAxesLength(double x, double y, double z);

    virtual void setActiveScene(std::shared_ptr<Scene> scene) = 0;

    virtual void setRenderingMode(const Renderer::Mode mode) = 0;

    virtual void setSize(int, int) { }
    void setSize(Vec2i size) { setSize(size[0], size[1]); }

    virtual const Vec2i getSize() const { return Vec2i::Zero(); }

    virtual Renderer::Mode getRenderingMode() const { return Renderer::Mode::Empty; }

    std::shared_ptr<Renderer> getActiveRenderer() const;

    virtual void setUseVsync(const bool) { }

    virtual void setWindowTitle(const std::string& title) = 0;

    virtual void setInfoLevel(const int level);

    int getInfoLevel() const { return m_infoLevel; }

    virtual const int getInfoLevelCount() const { return 1; }

    std::shared_ptr<ScreenCaptureUtility> getScreenCaptureUtility() const { return m_screenCapturer; }

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

    virtual void processEvents() = 0;

    virtual std::shared_ptr<KeyboardDeviceClient> getKeyboardDevice() const;

    virtual std::shared_ptr<MouseDeviceClient> getMouseDevice() const;

    double getVisualFps() const { return m_visualFps; }

protected:
    void updateFps();

    void updateModule() override;

    std::unordered_map<std::shared_ptr<Scene>, std::shared_ptr<Renderer>> m_rendererMap;

    std::shared_ptr<Scene>  m_activeScene;
    std::shared_ptr<Entity> m_debugEntity;
    std::shared_ptr<Camera> m_debugCamera;
    std::shared_ptr<ScreenCaptureUtility> m_screenCapturer; 

    std::shared_ptr<ViewerConfig> m_config;
    int m_infoLevel = 0;                                            

    std::chrono::high_resolution_clock::time_point m_pre;           
    std::chrono::high_resolution_clock::time_point m_post;          
    std::chrono::high_resolution_clock::time_point m_lastFpsUpdate; 

    double m_visualFps = 0.0;
    double m_lastFps   = 0.0;
};
} // namespace imstk