UiComponent.h

Go to the documentation of this file.

/*
 *  UiComponent.h
 *
 *  Created on: 10/02/2021
 *  Author: Alexander Kuester
 *  Copyright (c) 2021, OpenTwin
 */
 
#pragma once
 
// OpenTwin header
#include "OTCore/Flags.h"
#include "OTCore/ServiceBase.h"         // Base class
#include "OTGui/GuiTypes.h"
#include "OTGui/PropertyGridCfg.h"
#include "OTGui/StyledTextBuilder.h"
#include "OTServiceFoundation/FoundationAPIExport.h"
#include "OTServiceFoundation/MenuButtonDescription.h"
 
// C++ header
#include <list>
#include <map>
#include <string>
 
namespace ot {
    
    class ApplicationBase;
    
    namespace components {
 
        class OT_SERVICEFOUNDATION_API_EXPORT UiComponent : public ServiceBase {
        public:
 
            enum entitySelectionType {
                FACE,
                EDGE,
                SHAPE,
                TRANSFORM
            };
 
            enum entitySelectionAction {
                PORT,
                REMOVE_FACE,
                BOOLEAN_ADD,
                BOOLEAN_SUBTRACT,
                BOOLEAN_INTERSECT,
                TRANSFORM_SHAPES,
                CHAMFER_EDGE,
                BLEND_EDGE
            };
 
            UiComponent(
                const std::string &         _name,
                const std::string &         _type,
                const std::string &         _url,
                serviceID_t                 _id,
                ApplicationBase *           _application
            );
 
            virtual ~UiComponent();
 
            // #####################################################################################################################
 
            // Element creation
 
            void addMenuPage(
                const std::string &         _pageName
            );
 
            void addMenuGroup(
                const std::string &         _pageName,
                const std::string &         _groupName
            );
 
            void addMenuSubGroup(
                const std::string &         _pageName,
                const std::string &         _groupName,
                const std::string &         _subgroupName
            );
            
            void addMenuButton(
                const std::string &         _pageName,
                const std::string &         _groupName,
                const std::string &         _buttonName,
                const std::string &         _text,
                const LockTypeFlags &       _lockTypes,
                const std::string &         _iconName,
                const std::string &         _iconFolder = std::string("Default"),
                const std::string &         _keySequence = std::string("")
            );
 
            void addMenuButton(
                ot::MenuButtonDescription&  _menuButtonDescription,
                const LockTypeFlags&        _lockTypes,
                const std::string &         _iconName,
                const std::string &         _iconFolder = std::string("Default"),
                const std::string &         _keySequence = std::string("")
            );
 
 
            void addMenuButton(
                const std::string &         _pageName,
                const std::string &         _groupName,
                const std::string &         _subgroupName,
                const std::string &         _buttonName,
                const std::string &         _text,
                const LockTypeFlags&        _lockTypes,
                const std::string &         _iconName,
                const std::string &         _iconFolder = std::string("Default"),
                const std::string &         _keySequence = std::string("")
            );
 
            void addMenuCheckbox(
                const std::string &         _pageName,
                const std::string &         _groupName,
                const std::string &         _checkboxName,
                const std::string &         _checkboxText,
                bool                        _isChecked,
                const LockTypeFlags&        _lockTypes
            );
 
            void addMenuCheckbox(
                const std::string &         _pageName,
                const std::string &         _groupName,
                const std::string &         _subgroupName,
                const std::string &         _checkboxName,
                const std::string &         _checkboxText,
                bool                        _isChecked,
                const LockTypeFlags&        _lockTypes
            );
 
            void addMenuLineEdit(
                const std::string &         _pageName,
                const std::string &         _groupName,
                const std::string &         _lineEditName,
                const std::string &         _labelText,
                const std::string &         _initialText,
                const LockTypeFlags&    _lockTypes
            );
 
            void addMenuLineEdit(
                const std::string &         _pageName,
                const std::string &         _groupName,
                const std::string &         _subgroupName,
                const std::string &         _lineEditName,
                const std::string &         _labelText,
                const std::string &         _initialText,
                const LockTypeFlags&    _lockTypes
            );
 
            void activateMenuPage(
                const std::string &         _pageName
            );
 
            void addShortcut(
                const std::string &         _keySequence
            );
 
            void createRubberband(
                const std::string &         _note,
                const std::string &         _configurationJson
            );
            
            // #####################################################################################################################
 
            // Control manipulation
 
            void setControlToolTip(
                const std::string &         _controlName,
                const std::string &         _toolTipText
            ) const;
 
            void setControlToolTip(
                const std::string &         _pageName,
                const std::string &         _groupName,
                const std::string &         _controlName,
                const std::string &         _toolTipText
            ) const;
 
            void setControlToolTip(
                const std::string &             _gepaName,
                const std::string &             _groupName,
                const std::string &             _subgroupName,
                const std::string &             _controlName,
                const std::string &             _toolTipText
            ) const;
 
            void setControlsEnabledState(
                const std::list<std::string> &  _enabledControls,
                const std::list<std::string> &  _disabledControls
            ) const;
 
            void setLineEditValues(
                const std::string &             _controlName,
                const std::string &             _text,
                bool                            _errorState = false
            ) const;
 
            void setCheckboxValues(
                const std::string &             _controlName,
                bool                            _checkedState
            ) const;
 
            void lockUI(
                const LockTypeFlags&        _lockTypes
            ) const;
 
            void unlockUI(
                const LockTypeFlags&        _lockTypes
            ) const;
 
            void setProgressInformation(std::string message, bool continuous);
 
            void setProgress(int percentage);
 
            void closeProgressInformation(void);
 
            void switchMenuTab(
                const std::string &             _pageName
            ) const;
 
            void registerForModelEvents(void) const;
 
            void deregisterForModelEvents(void) const;
 
            void addIconSearchPath(const std::string& _iconPath);
 
            void notifyUiSetupCompleted(void);
 
            // #####################################################################################################################
 
            // Information IO
 
            void displayMessage(const std::string& _message) const;
 
            void displayStyledMessage(const StyledTextBuilder& _builder) const;
 
            void displayErrorPrompt(
                const std::string &             _message
            ) const;
 
            void displayWarningPrompt(
                const std::string &             _message
            ) const;
 
            void displayInformationPrompt(
                const std::string &             _message
            ) const;
 
            void addControlNameToList(
                std::list<std::string> &        _list,
                const std::string &             _pageName,
                const std::string &             _groupName,
                const std::string &             _controlName
            );
 
            void addControlNameToList(
                std::list<std::string> &        _list,
                const std::string &             _pageName,
                const std::string &             _groupName,
                const std::string &             _subgroupName,
                const std::string &             _controlName
            );
 
            // #####################################################################################################################
 
            // Element deletion
 
            void removeUIElements(const std::list<std::string> & _itemList);
 
            void removeAllUIElements(void);
 
            // #####################################################################################################################
 
            // View manipulation
 
            void enterEntitySelectionMode(
                UID                                         _visualizationModelUID,
                entitySelectionType                         _selectionType,
                bool                                        _allowMultipleSelection,
                const std::string &                         _filter,
                entitySelectionAction                       _actionType,
                const std::string &                         _message,
                const std::map<std::string, std::string> &  _options,
                ot::serviceID_t                             _serviceToReplyTo
            ) const;
 
            // #####################################################################################################################
 
            void freeze3DView(UID _visualizationModelUID, bool _flag);
            void refreshSelection(UID _visualizationModelUID);
            void refreshAllViews(UID visualizationModelID);
            void sendUpdatedControlState(void);
            void setControlState(const std::string controlName, bool enabled);
 
            bool sendMessage(bool _queue, JsonDocument& _doc, std::string& _response);
 
        protected:
 
            bool controlNameExists(const std::string & _name) const;
            ApplicationBase *                                   m_application;      
            std::list<std::string>                              m_uiElements;       
            std::map<std::string, bool>                         m_uiControlState;
            std::map<std::string, bool>                         m_uiControlStateInUI;
 
        private:
            friend class ApplicationBase;
            void sendSettingsData(const PropertyGridCfg& _config);
 
            UiComponent(const UiComponent &) = delete;
            UiComponent & operator = (const UiComponent &) = delete;
 
        };
 
    }
}