WindowInstance.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: WindowInstance
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#if NDEVR_VIEWPORT
#include <NDEVR/KeyController.h>
#include <NDEVR/Pointer.h>
#include <functional>
namespace NDEVR
{
    class GraphicsUpdateArguments;
    class MouseEvent;
    class KeyEvent;
    class Camera;
    class MouseController;
    class DesignObjectLookup;
 
    /**--------------------------------------------------------------------------------------------------
    \brief Contains core information about a Viewport.
    **/
    class NDEVR_DESIGN_API WindowInstance
    {
    public:
        WindowInstance();
        WindowInstance(UUID camera, DesignObjectLookup* lookup);
 
        MouseController& getMouseController();
        KeyController& getKeyController();
        void setLookup(DesignObjectLookup* lookup) { m_lookup = lookup; }
        virtual Vector<2, uint04> pixelSize() const { return (m_device_pixel_ratio * m_size.as<2, fltp08>()).as<2, uint04>(); };
        virtual Vector<2, uint04> logicalSize() const { return m_size; };
        virtual fltp08 referenceSize() { return m_reference_size; }
        virtual fltp08  referencePixelSize() { return m_device_pixel_ratio * m_reference_size;}
        virtual void setSize(const Vector<2, uint04>& size);
        virtual void setReferenceSize(fltp08 size);
        void addResizeEvent(const std::function<void(Vector<2, uint04>)>& resize_event) { m_resize_events.add(resize_event); };
        void addMouseEvent(const std::function<void(MouseEvent)>& mouse_event) { m_mouse_events.add(mouse_event); }
        void addKeyboardEvent(const std::function<void(KeyEvent)>& key_event) { m_key_events.add(key_event); };
        virtual bool visible() const { return true; }
        virtual bool shouldExit() const { return false; }
        virtual void* getSurface() = 0;
        virtual void updateInstance() {};
        Time getSurfaceUpdateTime() const { return m_surface_update_time; }
        virtual uint04 getGrabImageSize() { return 0; }
        virtual void finishFrame(GraphicsUpdateArguments&) {};
        virtual void setCamera(const UUID& camera);
        virtual ConstPointer<Camera> getCamera() const;
        virtual DynamicPointer<Camera> getCamera();
        const void* lockptr() const { return this; }
        void createEvent(const MouseEvent& event);
        void createEvent(const KeyEvent& event);
        void createResizeEvent(const Vector<2, uint04>& event);
        void setDevicePixelRatio(const fltp08 ratio) { m_device_pixel_ratio = ratio; };
        fltp08 devicePixelRatio() const { return m_device_pixel_ratio; }
        const UUID& cameraID() const { return m_camera; }
    protected:
        Buffer<std::function<void(Vector<2, uint04>)>> m_resize_events;
        Buffer<std::function<void(MouseEvent)>> m_mouse_events;
        Buffer<std::function<void(KeyEvent)>> m_key_events;
        fltp08 m_device_pixel_ratio;
 
        Vector<2, uint04> m_size;
        fltp08 m_reference_size;
        Time m_surface_update_time;
        UUID m_camera;
        DesignObjectLookup* m_lookup;
    };
}
#endif