WindowManager.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: WindowManager
Included in API: True
Author(s): Tyler Parke
 *--------------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/DesignObjectDialog.h>
#include <NDEVR/QCustomDockWidget.h>
#include <NDEVR/PopupManager.h>
#include <NDEVR/FileFormat.h>
#include <QPointer>
namespace NDEVR
{
    class ContainerWidgetBase;
    struct FileRequest;
    class QTModelManager;
    class AutoModelFileDialog;
    class FileChooserDialog;
    class AsciiModelFileDialog;
    class SettingsDialog;
    class AboutDialog;
    class InitialSetupDialog;
    class LogManagerDialog;
    struct ExportRequest;
    class QTDesignObject;
    class Keypad;
    class WidgetInit;
    class DockInit;
 
    /**--------------------------------------------------------------------------------------------
    class: WindowManager
 
    \brief Manages all windows and logic surrounding dialogs and views for displaying and managing any environment
        within the application
 
    Author: Tyler Parke
 
    Date: 2023-01-16
    *--------------------------------------------------------------------------------------------**/
    class NDEVR_API WindowManager : public PopupManager
    {
        Q_OBJECT
    public:
        WindowManager(QTModelManager* manager);
        virtual ~WindowManager();
        /**
        \brief Returns the primary window for the application
         */
        virtual QWidget* mainWindow() const = 0;
 
        /**
        \brief Creates a new project and shows any relevant information based on show_settings parameter
        \param[in] show_settings - if true, properties dialog for the project will be shown to user after creation
        \param[in] popup_origin - The origin where any animations should occur
         */
        void createNewProject(bool show_settings, const PopupInfo& popup_origin = PopupInfo());
 
        /**
        \brief Called when application should check to see if the project has been modified since last save
 
        Author: Tyler Parke
 
        Date: 2023-01-16
         */
        virtual void updateModified() = 0;
        /**
        \brief Resets the entire display to original initial state, before a project was loaded
 
        Author: Tyler Parke
 
        Date: 2023-01-16
         */
        virtual void clearAll() = 0;
 
        /**
        \brief Called when the user deletes objects. If specified, will prompt if user is sure, and then deletes
            all objects
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        \param[in] ids - The ids of objects the user is deleting
         */
        virtual void userDeleteObjects(const Buffer<UUID>& ids);
 
        /**
        \brief Called when the user exports. Will prompt user to select a location and format to save the file, 
            then prompt the user for any additional export settings, if required
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        \param[in] request - The settings for deletion
        \param[in] show_recents - Whether or not export should show recent settings
         */
        virtual void exportFile(ExportRequest request);
 
        /**
        \brief Called when the user has selected a file format and default data to export.
            Will prompt the user for any additional export settings, if required, then export data
 
        Author: Tyler Parke
 
        Date: 2023-01-16
        \param[in] model - The ids of the default model objects to export
        \param[in] files - The requested exports
        \param[in] popup_origin - The origin where any animations should occur
         */
        virtual void exportFiles(Buffer<UUID> model, const Buffer<FileRequest>& files, const PopupInfo& popup_origin);
 
 
        virtual void saveImage(const String& image_id, const File& default_file, PopupInfo info);
        /**
        \brief Called when the user has selected the project to save and we want to allow them to rename the file
            Will prompt the user for any additional export settings, if required, then export data
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        \param[in] popup_origin - The origin where any animations should occur
         */
        virtual void saveProjectAs(const PopupInfo& popup_origin = PopupInfo());
 
        /**
        \brief Called when the user has requested to choose a project file to open. Will prompt user to select 
            project file, then open it
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        \param[in] popup_origin - The origin where any animations should occur
         */
        virtual void userOpenProject(PopupInfo popup_origin = PopupInfo());
 
        /**
        \brief Called when the user has requested to import a file. Will prompt user to select
            import a file, then prompt the user for any additional import settings, if required, then import data
        \param[in] popup_origin - The origin where any animations should occur
         */
        virtual void userImportFile(PopupInfo popup_origin = PopupInfo());
        /**
        \brief Called when the user has requested to import a file. Will prompt user to select
            import a file, then prompt the user for any additional import settings, if required, then import data
        \param[in] popup_origin - The origin where any animations should occur
        \param[in] formats - The available import formats. If empty, all supported formats will be used
         */
        virtual void userImportFile(PopupInfo popup_origin, const Buffer<FileFormat>& formats);
        /**
        \brief Called when the user has requested to import and has selected a file. Will prompt the user for 
            any additional import settings, if required, then import data
        \param[in] files - The file requests used to define what data to import
        \param[in] popup_origin - The origin where any animations should occur
         */
        virtual void importUserFiles(const Buffer<FileRequest>& files, PopupInfo popup_origin = PopupInfo());
        virtual void openUserFiles(const Buffer<FileRequest>& files, PopupInfo popup_origin = PopupInfo());
        virtual void showImportDialogIfNeeded(const Buffer<FileRequest>& file, PopupInfo popup_origin);
        /**
        \brief Called when we want to show the dialog for editing a specific object using application default editing
            dialogs. This can be called for creating new objects, editing existing objects, etc based on the 
            provided settings
        \param[in] settings - The information used to generate the editing dialog
         */
        virtual void showModelProperties(const ShowPropertiesSettings& settings);
 
        /**
        \brief Prompts the user to save changes, if required, then closes everything returning to application initial
            state with no project loaded
        \param[in] popup_origin - The origin where any animations should occur
         */
        virtual void closeAll(const PopupInfo& popup_origin = PopupInfo());
 
        /**
        \brief Adds a widget to be docked in the default location when a project has been loaded. If a project is
            loaded, dialog will be added and docked immidiately
        \param[in] widget - The widget to be docked
         */
        virtual void addCustomDockWidget(DockInit* widget);
 
        /**
        \brief Removes a widget that was added with addCustomDockWidget. If widget is not present, function does
            nothing
        \param[in] widget - The widget to be removed
         */
        virtual void removeCustomDockWidget(DockInit* widget);
 
        /**
        \brief Shows the main screen and puts it in front of any windows
         */
        virtual void showMainScreen();
 
        /**
        \brief Adds a dialog to the logic such that, should a settings dialog be created, the dialog will be added to
            the menu. Provided function will be called if the user decides to reset the settings to default
        \param[in] menu - The menu to be added to the settings dialog
        \param[in] reset_to_defaults - The function to be called if the user decides to reset the settings to default
         */
        virtual void addSettingsMenu(WidgetInit* menu, std::function<void()> reset_to_defaults);
        virtual void removeSettingsMenu(WidgetInit* menu);
        virtual void addInitialSetupSettingsMenu(WidgetInit* menu, bool always_show = false);
        virtual void removeInitialSetupSettingsMenu(WidgetInit* menu);
        /**
        \brief Prompts the user to confirm an exit and save changes if required. If confirmed, exit() will be
            called
        \param[in] exit_function - The function to be called should the user elect to exit
        \param[in] popup_origin - The origin where any animations should occur
         */
        virtual void requestExit(const PopupInfo& popup_origin = PopupInfo());
 
        /**
        \brief Prompts the user to confirm an exit and save changes if required. If confirmed, exit() will be
            called
        \param[in] event - The exit event
        \param[in] popup_origin - The origin where any animations should occur
         */
        virtual void requestExit(QCloseEvent* event, const PopupInfo& popup_origin = PopupInfo());
 
        /**
        \brief Prompts the user to confirm an exit and save changes if required. If confirmed, exit_function will be
            called and should contain the actual exit routine, typically including the call to exit()
 
        Author: Tyler Parke
 
        Date: 2023-01-16
        \param[in] exit_function - The function to be called should the user elect to exit
        \param[in] popup_origin - The origin where any animations should occur
         */
        virtual void requestExitWithFunction(std::function<void()> exit_function, const PopupInfo& popup_origin = PopupInfo());
 
        /**
        \brief Saves user settings and exits the application, relaunching if requested
        \param[in] relaunch - Whether or not to re-open the application after closing it
         */
        virtual void exit(bool relaunch = false, const String& relaunch_options = "--relaunch");
 
        /**
        \brief Returns the default file chooser dialog used for user selection of files for import or export
        \returns The default fileChooser used for selecting a file within the application
         */
        virtual FileChooserDialog* fileChooser();
 
        /**
        \brief Returns the about dialog, which details information about the application, and instruction manuals,
            if available
        \returns A dialog detailing information about the application, and instruction manuals, if available
         */
        virtual DockWidget<AboutDialog>* aboutDialog();
 
        /**
        \brief Returns the settings dialog for allowing the user to adjust application specific objects
        \returns A dialog allowing the user to modify settings
         */
        virtual DockWidget<SettingsDialog>* settingsDialog();
 
        /**
        \brief Returns the dialog for viewing all application logs related to the session and project
        \returns A dialog allowing the user to view logs
         */
        virtual DockWidget<LogManagerDialog>* logView();
 
        /**
        \brief Returns the dialog adjusting used for adjust the import settings of a given ascii file request.
        \returns A dialog for managing import options
         */
        virtual DockWidget<AsciiModelFileDialog>* asciiImporterWindow();
 
        /**
        \brief Returns the dialog adjusting used for adjust the import settings of a given file request.
        \returns A dialog for managing import options
         */
        virtual DockWidget<AutoModelFileDialog>* importerWindow();
        /**
        \brief Returns the dialog adjusting the import settings of a given file request. File requests will be completed
            once dialog is accepted or cancelled
        \param[in] requests - The objects to be imported
        \returns A dialog for managing import options
         */
        virtual DockWidget<AutoModelFileDialog>* importerWindow(const Buffer<FileRequest>& requests);
        virtual DockWidget<AsciiModelFileDialog>* asciiImporterWindow(const Buffer<FileRequest>& requests);
        /**
        \brief Returns the dialog adjusting the export settings of a given file request. File requests will be completed
            once dialog is accepted or cancelled
 
 
        Author: Tyler Parke
 
        Date: 2023-01-16
        Paramters:
        \param[in] requests - The objects to be exported
        \returns A dialog for managing export options
         */
        virtual DockWidget<AutoModelFileDialog>* exporterWindow(Buffer<UUID> model, const Buffer<FileRequest>& file);
        virtual DockWidget<AsciiModelFileDialog>* asciiExporterWindow(Buffer<UUID> model, const Buffer<FileRequest>& file);
 
 
        /**
        \brief Creates a new project and shows any relevant information based on WindowOptions
 
        Author: Tyler Parke
 
        Date: 2023-01-17
        \param[in] popup_origin - The origin where any animations should occur
         */
        virtual void onNewProjectSelected(const PopupInfo& popup_origin = PopupInfo());
 
        /**
        \brief Creates a new project and shows any relevant information based on show_settings parameter
 
        Author: Tyler Parke
 
        Date: 2023-01-17
        \param[in] show_settings - if true, properties dialog for the project will be shown to user after creation
        \param[in] popup_origin - The origin where any animations should occur
         */
        virtual void onNewProjectSelected(bool show_settings, const PopupInfo& popup_origin = PopupInfo());
        virtual void createNewProjectNow(bool show_settings, const PopupInfo& popup_origin);
        void initKeypad();
        void simulateKeyPress(int key);
 
        virtual void setMainWindowCallback(const std::function<void(QWidget*)>& main_window_callback);
        virtual void recoverLastData() {};
 
    protected:
        void lockScreenToWindowSize();
        virtual AboutDialog* createAboutDialog();
        virtual SettingsDialog* createSettingsDialog();
        virtual LogManagerDialog* createLogView();
        virtual AutoModelFileDialog* createAutoModelFileDialog(bool is_import);
        virtual AsciiModelFileDialog* createAsciiModelFileDialog(bool is_import);
        virtual FileChooserDialog* createFileChooserDialog();
        virtual DesignObjectDialog* createDesignObjectDialog(const DynamicPointer<QTDesignObject>& object, const ShowPropertiesSettings& settings);
        virtual void hideSplashScreen(const TimeSpan& delay_time, const TimeSpan& fade_time);
        virtual void layoutAll();
        virtual void updateFromWindowOptions();
        virtual void setupExporterWindow(AutoModelFileDialog* window, Buffer<UUID> model, const Buffer<FileRequest, uint04, ObjectAllocator<false>>& file);
        void updateFileDialog(const Buffer<UUID>& model, const Buffer<FileFormat>& formats, String extension, bool show_recents, bool save_dialog);
        void updateFileDialogToProject();
        virtual DropArea defaultDropArea(const QCustomDockWidget* dock_widget) const;
        virtual SectionWidget* defaultDropReference(const QCustomDockWidget* dock_widget = nullptr) const;
        virtual DockWidget<DesignObjectDialog>* setupDesignDock(const ShowPropertiesSettings& settings);
        Buffer<FactoryParameters, uint04, ObjectAllocator<false>> convertRequest(const Buffer<FileRequest, uint04, ObjectAllocator<false>>& requests);
        virtual void addProjectFolderToRecents();
 
        virtual InitialSetupDialog* initialSetupDialog();
    protected slots:
        void initialSetupFinishedSlot();
    signals:
        void onNewProjectSignal();
        void userDataAdded(Buffer<UUID> object);
    protected:
        QPointer<DockWidget<Keypad>> m_key_pad_dock = nullptr;
        Buffer<std::tuple<WidgetInit*, std::function<void()>>> m_settings_dialogs;
        Buffer<std::tuple<WidgetInit*, bool>> m_initial_settings_dialogs;
        Dictionary<UUID, QPointer<DockWidget<DesignObjectDialog>>> m_editor_docks;
        Buffer<DockInit*> m_custom_dock_widgets;
        QTModelManager* m_model_manager = nullptr;
        InitialSetupDialog* m_initial_setup_dialog = nullptr;
        std::function<void(QWidget*)> m_main_window_callback;
 
        DockWidget<AutoModelFileDialog>* m_import_dock = nullptr;
        DockWidget<AutoModelFileDialog>* m_export_dock = nullptr;
        DockWidget<AsciiModelFileDialog>* m_ascii_import_dock = nullptr;
        DockWidget<AsciiModelFileDialog>* m_ascii_export_dock = nullptr;
        FileChooserDialog* m_image_export = nullptr;
        String m_export_image_id;
 
        DockWidget<LogManagerDialog>* m_log_dock = nullptr;
        DockWidget<AboutDialog>* m_about_dock = nullptr;
        DockWidget<SettingsDialog>* m_settings_dock = nullptr;
 
        FileChooserDialog* m_file_chooser = nullptr;
        bool m_is_exiting;
    };
 
    
}