WidgetOptions.h

Go to the documentation of this file.

#pragma once
#include "DLLInfo.h"
#include <NDEVR/ApplicationOptions.h>
#include <NDEVR/Event.h>
class QWidget;
namespace NDEVR
{
    struct PopupInfo;
    class Log;
    /**--------------------------------------------------------------------------------------------------
    struct: WidgetOptions
 
    Stores the options, added to the user settings, that control Widgets and low level UI options in the
    application. All options retained across application restart
 
    Author: Tyler Parke
 
    Date: 2023-01-16
    *-----------------------------------------------------------------------------------------------**/
    class NDEVR_WIDGETS_API WidgetOptions
    {
    public:
        enum WidgetMode
        {
              e_desktop///UI layout, size, and workflow optimized for traditional desktop computers
            , e_tablet//UI layout, size, and workflow optimized for tablets
            , e_mobile///UI layout, size, and workflow optimized for mobile phones
            , e_size
        };
        //Returns whether or not the UI should be optimized for finger presses
        static bool IsTouchOptimized();
        //Returns whether or not the UI should be optimized for work in the field, based off of field_mode and the current widget_mode
        static bool IsFieldMode(); 
        //Sets whether or not the UI in the current widget_mode should be optimized for work in the field, based off of field_mode and the current widget_mode
        static void SetFieldMode(bool field_mode);
        //Based off of things like screen resolution or whether OS is in touch mode
        static WidgetMode DefaultSystemWidgetMode();
        //Grows or shrinks all UI components with the exception of font
        static ApplicationOption<fltp08> ui_scale;
        //Grows or shrinks all font within the UI
        static ApplicationOption<fltp08> font_scale;
        //For animations, the speed multiplier for UI animaitions. 0 = no animations. Higher the number = slower animations
        static ApplicationOption<fltp08> animation_scale;
        //For animations, the scale at which to render the animation 0.0-1.0. Lower = faster animations, Higher = crisper animations
        static Resource<fltp08> animation_quality;
        //Allows the user to manually dock and undock widgets
        static ApplicationOption<bool> global_allow_docking;
        //Whether or not to show the main window full screen (without close/window/minimize buttons) in "field mode". In android shows the top bar
        static ApplicationOption<bool> field_mode_fullscreen;
        //Allows user to window fullscreen views
        static ApplicationOption<bool> allow_windowable_windows;
        //Whether or not each application mode should be in field mode
        static ApplicationOption<Vector<WidgetMode::e_size, bool>> field_mode;
        //The mode of the application
        static ApplicationOption<WidgetMode> widget_mode;
 
        ///////////////////////////////////////////////////
        
        //The default parent widget for all new dialogs
        static Resource<QWidget*> new_window_parent;
        //The function to call when we want to show a widget (Used primarily via QTTools::showDialog)
        static std::function<bool(QWidget* widget, const PopupInfo& start, const PopupInfo& end)> show_widget_function;
        //The function to call when we want to hide a widget (Used primarily via QTTools::showDialog)
        static std::function<void(QWidget* widget, const PopupInfo& info)> hide_widget_function;
 
        static std::function<void(bool relaunch, const PopupInfo& info)> request_exit_function;
        ///The key event sent when the OS sends a key not recognized by the software
        static KeyEvent::KEY unhandled_key;
        ///The default log for all UI events
        static Resource<ProgressInfo*> ui_log;
        //Resets all Viewport Options to defaults
        static void ResetOptionsToDefaults();
        //The category in user settings for all of the above options
        static TranslatedString options_label;
    };
    template class NDEVR_WIDGETS_API StringStream<WidgetOptions::WidgetMode>;
}