Joystick.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: Widgets
File: SunDial
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/INIInterface.h>
#include <NDEVR/Vector.h>
#include <NDEVR/RGBColor.h>
#include <QWidget>
class QPropertyAnimation;
class QPainterPath;
namespace NDEVR
{
    class Button;
    struct PopupInfo;
 
    /**--------------------------------------------------------------------------------------------------
    \brief Settings that define how a Joystick will behave.
    **/
    class JoystickSettings : public INIInterface
    {
    public:
        JoystickSettings();
        enum SensitivityMode
        {
              e_linear
            , e_exponential
            , e_sinusoidal
        };
        fltp04 deadzone = 0.05f;
        SensitivityMode sensitivity_mode = SensitivityMode::e_exponential;
        fltp04 sensitivity = 1.0f;
        bool uses_buttons = false;
        bool uses_knob = true;
        bool operator==(const JoystickSettings& settings) const
        {
            return settings.deadzone == deadzone
                && settings.sensitivity_mode == sensitivity_mode
                && settings.sensitivity == sensitivity
                && settings.uses_buttons == uses_buttons
                && settings.uses_knob == uses_knob;
        }
        void resetToDefaults();
        void getINI(INIFactory& factory) override;
    };
 
    /**--------------------------------------------------------------------------------------------------
    \brief A joystick that allows the user to move around, reporting the vector of the stick, relative
        to the center of the joystick.
    **/
    class NDEVR_WIDGETS_API Joystick : public QWidget
    {
        Q_OBJECT
        Q_PROPERTY(float snap_back_percent READ snapBackPercent WRITE setSnapBackPercent)
    public:
        
        explicit Joystick(QWidget* parent = nullptr);
        Vector<2, fltp04> centerPoint() const;
        Vector<2, fltp04> knobLocation() const;
        fltp04 knobRadius() const;
        fltp04 outerRadius() const;
        QSize sizeHint() const override;
        void setKnobColor(RGBColor inner, RGBColor outer);
        void setBackgroundColor(RGBColor inner, RGBColor outer);
        float snapBackPercent() const { return m_snap_back_percent; }
        void setSnapBackPercent(float snap_percent);
        virtual void mousePressEvent(QMouseEvent* ev) override;
        virtual void mouseMoveEvent(QMouseEvent* ev) override;
        virtual void mouseReleaseEvent(QMouseEvent* ev) override;
        void addButton(Button* button);
        bool event(QEvent* event) override;
        void setDeadzone(fltp08 deadzone);
        void setJoystickSettingsName(const String& name);
        const JoystickSettings& settings() const { return m_settings; }
        void setValue(const Vector<2, fltp04>& location);
        bool isDragging() const;
        void setSettings(const JoystickSettings& mode);
        void setDrawDeadzone(bool draw_deadzone);
        void setDrawSensitivity(bool draw_sense);
        QRect arrowRect(const Vector<2, sint04>& location, const Vector<2, fltp04>& center_point, fltp04 radius) const;
    signals:
        void joystickLocationChangedSignal(const Vector<2, fltp04>& location);
        void joystickButtonPressedSignal(const Vector<2, fltp04>& location);
        void joystickButtonReleasedSignal(const Vector<2, fltp04>& location);
    private:
        void showSettings(const PopupInfo& info);
        void updateButton(uint04 button);
        void updateButtons();
        Vector<2, fltp04> convertLocationToSignal(Vector<2, fltp04> mouse_location);
        void resizeEvent(QResizeEvent* event) override;
        void paintEvent(QPaintEvent* paint_event) override;
    private:
        JoystickSettings m_settings;
        Button* m_settings_button;
        Vector<2, fltp04> m_location;
        fltp04 m_inner_radius;
        RGBColor m_outer_color;
        RGBColor m_inner_color;
        Buffer<Button*> m_custom_buttons;
        RGBColor m_knob_inner_color;
        RGBColor m_knob_outer_color;
        Vector<2, fltp04> m_joystick_draw_location;
        fltp04 m_snap_back_percent = 0.0f;
        QPropertyAnimation* m_joystick_release_animation;
        fltp04 m_knob_radius;
        bool m_dragging;
        bool m_is_pressing;
        bool m_draw_deadzone;
        bool m_draw_sensitivity;
    };
}