Renderer.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Graphics
File: Renderer
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "NDEVRGraphics/Headers/DLLInfo.h"
#include "NDEVRGraphics/Headers/GraphicsUpdateArguments.h"
#include "NDEVRGraphics/Headers/GraphicsPipeline.h"
#include "Design/Headers/WindowInstance.h"
#include "Base/Headers/Time.h"
namespace NDEVR
{
    class VulkanSession;
    class Model;
    class ModelPipelineManager;
    class GraphicsUpdater;
    class Image;
    class DesignObjectLookup;
    /**--------------------------------------------------------------------------------------------------
    \brief An object that renders a specific Camera object, typically run on a different thread than the
        main UI thread. Rendering takes place between calls to the GraphicsUpdater. If there is more than
        one QTGraphicsWindow, there may be more than one Renderer running at a time.
    **/
    class NDEVR_GRAPHICS_API Renderer
    {
    public:
        Renderer(const DynamicPointer<GraphicsPipeline>& pipeline, const ConstPointer<Camera>& camera, WindowInstance* instance, ProgressInfo* log);
        virtual ~Renderer();
        void render(bool wait_until_needed, bool force_render = true);
        void renderLoop();
        //void recoverFromDeviceLost(const DynamicPointer<GraphicsDevice>& new_device);
        void setActive(bool is_active);
        void setFPS(fltp08 fps) { m_fps = fps; }
        fltp08 getFPS() const { return m_fps; }
        uint04 multisample() const;
        void run();
        void ensureLastRenderComplete();
        Time getFrameStartTime() const
        {
            return m_args.frame_time;
        }
        void cleanup() {
            m_render_pipeline->cleanup();
        }
        void init(DesignObjectLookup* lookup);
        ProgressInfo* log()
        {
            return m_log;
        }
        void updateSingleThreaded();
        GraphicsUpdater* updater() const { return m_updater; }
        GraphicsUpdateArguments& getArguments() { return m_args; };
        void setWindowInstance(WindowInstance* window);
        void addScene(const UUID& model);
        const DynamicPointer<GraphicsDevice>& device() const;
        void addModel(const UUID& model);
        //void setClearColor(const RGBColor& background);
        void removeModel(const UUID& model);
        void clearModels();
        void setPostRenderFunction(const std::function<void()>& function) { m_post_render_function = function; }
        void setupSurface();
        void requestRedraw();
        void grabImage(Image* image);
        void updateArgs(bool force_render);
        void grabImageNextRender(Image* image);
        DynamicPointer<GraphicsPipeline> pipeline() const { return m_render_pipeline; }
        virtual void setCamera(const ConstPointer<Camera>& camera);
        void setOverrideMaterial(UUID material);
 
        void updatePipeline();
        void pause(TimeSpan span);
        bool isActive() { return m_is_active; }
    private:
        void _render(bool wait_until_needed, bool force_render);
        GraphicsUpdateArguments m_args;
        fltp08 m_fps;
        DynamicPointer<GraphicsPipeline> m_render_pipeline;
        ConstPointer<Camera> m_camera;
        GraphicsUpdater* m_updater = nullptr;
        WindowInstance* m_window = nullptr;
        UUID render_id;
        ProgressInfo* m_log;
        std::function<void()> m_post_render_function;
        bool m_is_active;
        bool m_request_redraw;
        volatile uint08 m_pause_time;
    };
}