Viewer.h

#pragma once
 
/* <editor-fold desc="MIT License">
 
Copyright(c) 2018 Robert Osfield
 
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
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.
 
</editor-fold> */
 
#include <vsg/app/CompileManager.h>
#include <vsg/app/Presentation.h>
#include <vsg/app/RecordAndSubmitTask.h>
#include <vsg/app/UpdateOperations.h>
#include <vsg/app/Window.h>
#include <vsg/threading/Barrier.h>
#include <vsg/threading/FrameBlock.h>
 
#include <map>
 
namespace vsg
{
 
    class VSG_DECLSPEC Viewer : public Inherit<Object, Viewer>
    {
    public:
        Viewer();
 
        Viewer(const Viewer&) = delete;
        Viewer& operator=(const Viewer& rhs) = delete;
 
        virtual void addWindow(ref_ptr<Window> window);
 
        Windows& windows() { return _windows; }
        const Windows& windows() const { return _windows; }
 
        clock::time_point& start_point() { return _start_point; }
        const clock::time_point& start_point() const { return _start_point; }
 
        FrameStamp* getFrameStamp() { return _frameStamp; }
        const FrameStamp* getFrameStamp() const { return _frameStamp; }
 
        bool active() const;
 
        virtual void close();
 
        virtual bool pollEvents(bool discardPreviousEvents = true);
 
        UIEvents& getEvents() { return _events; }
 
        const UIEvents& getEvents() const { return _events; }
 
        void addEventHandler(ref_ptr<Visitor> eventHandler) { _eventHandlers.emplace_back(eventHandler); }
 
        void addEventHandlers(EventHandlers&& eventHandlers) { _eventHandlers.splice(_eventHandlers.end(), eventHandlers); }
 
        EventHandlers& getEventHandlers() { return _eventHandlers; }
 
        const EventHandlers& getEventHandlers() const { return _eventHandlers; }
 
        ref_ptr<UpdateOperations> updateOperations;
 
        void addUpdateOperation(ref_ptr<Operation> op, UpdateOperations::RunBehavior runBehavior = UpdateOperations::ONE_TIME)
        {
            updateOperations->add(op, runBehavior);
        }
 
        ref_ptr<CompileManager> compileManager;
 
        virtual bool advanceToNextFrame();
 
        virtual void handleEvents();
 
        virtual void compile(ref_ptr<ResourceHints> hints = {});
 
        virtual bool acquireNextFrame();
 
        virtual VkResult waitForFences(size_t relativeFrameIndex, uint64_t timeout);
 
        // Manage the work to do each frame using RecordAndSubmitTasks. those that need to present results to be wired up to respective Presentation object
        RecordAndSubmitTasks recordAndSubmitTasks;
 
        // Manage the presentation of rendering using Presentation objects
        using Presentations = std::vector<ref_ptr<Presentation>>;
        Presentations presentations;
 
        virtual void assignRecordAndSubmitTaskAndPresentation(CommandGraphs commandGraphs);
 
        ref_ptr<ActivityStatus> status;
        std::list<std::thread> threads;
 
        void setupThreading();
        void stopThreading();
 
        virtual void update();
 
        virtual void recordAndSubmit();
 
        virtual void present();
 
        virtual void deviceWaitIdle() const;
 
    protected:
        virtual ~Viewer();
 
        bool _close = false;
 
        ref_ptr<FrameStamp> _frameStamp;
 
        Windows _windows;
 
        clock::time_point _start_point;
        UIEvents _events;
        EventHandlers _eventHandlers;
 
        bool _threading = false;
        ref_ptr<FrameBlock> _frameBlock;
        ref_ptr<Barrier> _submissionCompleted;
    };
    VSG_type_name(vsg::Viewer);
 
    extern VSG_DECLSPEC void updateViewer(Viewer& viewer, const CompileResult& compileResult);
 
} // namespace vsg