NDEVRMouseManager.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: NDEVR
File: NDEVRMouseManager
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/WidgetOptions.h>
#include <NDEVR/WindowInstance.h>
#include <NDEVR/Thread.h>
#include <NDEVR/TimeSpan.h>
#include <QMouseEvent>
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
#define position pos
#define points touchPoints
#endif
#if NDEVR_SUPPORTS_THREADING
#define RUN_MOUSE_MANAGER_THREADED 1
#else
#define RUN_MOUSE_MANAGER_THREADED 0
#endif
#if NDEVR_VIEWPORT
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Handles converting QEvents into NDEVR MouseEvents and queuing them up appropriately.
    **/
    class NDEVR_API NDEVRMouseManager 
#if NDEVR_SUPPORTS_THREADING
        : public Thread
#endif
    {
    public:
        NDEVRMouseManager();
        void setUseMouseClicks(bool use_mouse_clicks);
        void processMouseEvent();
        void eraseOldestEvent();
        MouseEvent oldestEvent() const;
        static NDEVRMouseManager& defaultInstance();
        void clearEvents(const WindowInstance* instance);
#if RUN_MOUSE_MANAGER_THREADED
        void stopThread() override;
        virtual void run() override;
#endif
        void addTouchEvent(Buffer<Vector<2, fltp04>> location, Vector<2, uint04> size, bool touch_pressed, WindowInstance* instance = nullptr);
        void clearTouchEvent(WindowInstance* instance);
        bool addMouseEvent(QEvent* event, Vector<2, uint04> size, WindowInstance* instance = nullptr);
        void addMouseEvent(MouseEvent& mouse_event);
        const Buffer<MouseEvent>& mouseEvents() const;
        static ApplicationOption<bool> seperate_mouse_thread;
    protected:
        bool m_is_init;
        bool m_use_mouse_clicks;
#if RUN_MOUSE_MANAGER_THREADED
        mutable std::mutex m_critical_section;
#endif
        Buffer<MouseEvent> m_last_mouse_events;
        Vector<2, fltp04> m_last_mouse_press_point;
 
 
        Vector<2, Vector<2, fltp04>> m_last_touch_press_point = Constant<Vector<2, Vector<2, fltp04>>>::Invalid;
 
        fltp08 m_last_touch_scale_factor = Constant<fltp08>::Invalid;
        uint08 m_last_mouse_press_time;
    };
}
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
#undef position
#undef points
#endif
#endif