ModelCommandsWidget.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: ModelCommandsWidget
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#if NDEVR_VIEWPORT
#include <NDEVR/SoftwareService.h>
#include <NDEVR/SnapsEditorWidget.h>
#include <NDEVR/QTModelManager.h>
#include <NDEVR/MouseController.h>
#include <NDEVR/SelectionController.h>
#include <NDEVR/ModelEditController.h>
#include <QWidget>
class QVBoxLayout;
namespace NDEVR
{
    class Ribbon;
    class Button;
    class RibbonGroup;
    class QTResourceListener;
    class RibbonSubGroup;
    class QCustomStackedWidget;
    class ModelOffsetCommandWidget;
    class VertexOffsetWidget;
    /**--------------------------------------------------------------------------------------------------
    \brief Can be used to add functionality to the ModelCammandsWidget by showing a unique widget
        when the action is undertaken.
    **/
    class QtModelFunction : public ModelFunction, public SoftwareService
    {
    public:
        virtual QWidget* editWidget() = 0;
        virtual bool shouldShowInterface() const override { return true; }
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A widget for interfacing with ModelEditController to allow the user to edit or modify objects
        in the 3D environment.
    **/
    class NDEVR_API ModelCommandsWidget : public QWidget, public SoftwareServiceManager
    {
        Q_OBJECT
    public:
        ModelCommandsWidget(QTModelManager* manager, QWidget *parent = nullptr);
        virtual ~ModelCommandsWidget();
        void setupCommandModeRibbon(RibbonGroup* group);
#if NDEVR_GRIPS
        void setupGripModeRibbon(RibbonGroup* group);
#endif
        void setControl(ModelEditController::ModelEditMode mode);
        void setControl(UUID mode);
        void setControlEnabled(bool is_enabled);
        void removeControl(bool keep_existing);
        void updateCheckedButtons();
    protected:
        void refreshUI(bool force);
        void updateSelectionMode(bool force);
        void init();
        void refreshButtonEnabled();
        void refreshMaskWidgets();
        void setupForOffsetCommand();
        void setupForVertexOffsetCommand();
    signals:
        void controlModeSet(ModelEditController::ModelEditMode mode);
        void requestVisibleSignal(bool visible);
    protected slots:
        void onSelectedSlot(Buffer<UUID> ids, bool is_selected);
    private:
        Buffer<DynamicPointer<MouseController>> m_mouse_controllers;
        SnapsEditorWidget* m_snaps_widget;
        QTModelManager* m_manager;
        Buffer<uint04> m_key_draw_action_indices;
        Ribbon* m_draw_type_ribbon;
        ModelEditController::ModelEditMode m_last_command_mode;
        SubSelectionMode m_last_selection_mode;
        Buffer<RibbonSubGroup*> m_inverted_sections;
        RibbonSubGroup* m_selection_sections = nullptr;
        RibbonSubGroup* m_mask_sections = nullptr;
        Buffer<Button*> m_mask_buttons;
        QTResourceListener* m_enabled_listener;
        Buffer<Buffer<Button*>> m_command_mode_buttons;
        Buffer<Buffer<Button*>> m_grip_mode_buttons;
        Buffer<Dictionary<UUID, Button*>> m_command_function_buttons;
        Buffer<Button*> m_selection_mode_buttons;
        UUID m_controller_id;
        QTimer* m_mask_highlight_timer;
        uint04 m_mask_highlight_request;
        QCustomStackedWidget* m_stacked_widget;
        ModelOffsetCommandWidget* m_offset_command_widget;
        VertexOffsetWidget* m_vertex_offset_command_widget;
        QCustomLabel* m_hint_label;
        bool m_is_enabled;
        bool m_last_inverted;
        bool m_is_dirty;
    };
}
#endif