MeshLib C++ Docs
Loading...
Searching...
No Matches
MRRibbonMenu.h
Go to the documentation of this file.
1#pragma once
2#include "ImGuiMenu.h"
3#include "MRRibbonMenuItem.h"
7#include "MRAsyncTimer.h"
8#include "MRRibbonSchema.h"
9#include "MRToolbar.h"
10#include "MRMesh/MRSignal.h"
12#include <type_traits>
13#include <array>
14
15namespace MR
16{
17
18class Object;
19
26
39
40// Class to control and render ribbon-style menu
41// stores menu items,
42// menu structure is provided by `menuItemsStructure.json` file (parsed on init)
43class MRVIEWER_CLASS RibbonMenu : public ImGuiMenu
44{
45 struct CustomContextMenuCheckbox
46 {
47 using Setter = std::function<void( std::shared_ptr<Object> object, ViewportId id, bool checked )>;
48 using Getter = std::function<bool( std::shared_ptr<Object> object, ViewportId id )>;
49 Setter setter;
50 Getter getter;
51 // display a checkBox when only these types of objects are selected
52 // by default, it is always hidden
53 SelectedTypesMask selectedMask = SelectedTypesMask( -1 );
54 };
55
56public:
57 // returns RibonMenu from ViewerInstance()
58 MRVIEWER_API static std::shared_ptr<RibbonMenu> instance();
59
60 // adds a custom checkBox to the context menu
61 // it is applied to the selected objects
62 MRVIEWER_API void setCustomContextCheckbox(
63 const std::string& name,
64 CustomContextMenuCheckbox customContextMenuCheckbox );
65
66 MRVIEWER_API virtual void init( MR::Viewer* _viewer ) override;
67
68 MRVIEWER_API virtual void shutdown() override;
69
71 MRVIEWER_API void openToolbarCustomize();
72
73 MRVIEWER_API virtual void load_font( int font_size = 13 ) override;
74
75 MRVIEWER_API virtual std::filesystem::path getMenuFontPath() const override;
76
77 // set top panel pinned and unpinned
78 MRVIEWER_API virtual void pinTopPanel( bool on );
79 MRVIEWER_API bool isTopPannelPinned() const;
80 // this functions allow you to get top panel height (before scaling)
81 int getTopPanelOpenedHeight() const { return topPanelOpenedHeight_; }
82 int getTopPanelHiddenHeight() const { return topPanelHiddenHeight_; }
83 int getTopPanelCurrentHeight() const { return currentTopPanelHeight_; }
84 // set maximum wait time (in seconds) before top panel is closed after mouse leaves it (only when not pinned)
85 // minimum value is 0 seconds, panel will close immediately after mouse leaves it
86 void setTopPanelMaxOpenedTimer( float sec ) { openedMaxSecs_ = std::max( 0.0f, sec ); }
87
89 MRVIEWER_API virtual void setQuickAccessListVersion( int version );
91 MRVIEWER_API virtual void readQuickAccessList( const Json::Value& root );
92
94 MRVIEWER_API void resetQuickAccessList();
95
97 Vector2i getSceneSize() { return Vector2i( int( sceneSize_.x ), int( sceneSize_.y ) ); };
98
100 MRVIEWER_API void setSceneSize( const Vector2i& size );
101
103 bool hasActiveBlockingItem() const { return bool( activeBlockingItem_.item ); }
105 bool hasAnyActiveItem() const { return bool( activeBlockingItem_.item ) || !activeNonBlockingItems_.empty(); }
106
108 MRVIEWER_API void updateItemStatus( const std::string& itemName );
109
111 int getActiveTabIndex() const { return activeTabIndex_; }
112
113
115 RibbonFontManager& getFontManager() { return fontManager_; };
116
118 RibbonButtonDrawer& getRibbonButtonDrawer() { return buttonDrawer_; }
119
121 Toolbar& getToolbar() { return toolbar_; }
122
124 RibbonNotifier& getRibbonNotifier() { return notifier_; };
125
126 void setActiveListPos( const ImVec2& pos ) { activeListPos_ = pos; }
127
129 void showActiveList() { activeListPressed_ = true; };
130
133 MRVIEWER_API virtual void pushNotification( const RibbonNotification& notification );
134
136 MRVIEWER_API static void cloneTree( const std::vector<std::shared_ptr<Object>>& selectedObjects );
138 MRVIEWER_API static void cloneSelectedPart( const std::shared_ptr<Object>& object );
139
140 using TabChangedSignal = boost::signals2::signal<void( int prevTabId, int newTabId )>;
143
145 bool getAutoCloseBlockingPlugins() const { return autoCloseBlockingPlugins_; }
147 void setAutoCloseBlockingPlugins( bool value ) { autoCloseBlockingPlugins_ = value; }
148
150 const RibbonMenuUIConfig& getMenuUIConfig() const { return menuUIConfig_; }
151 MRVIEWER_API virtual void setMenuUIConfig( const RibbonMenuUIConfig& newConfig );
152
153 // ======== selected objects options drawing
154 bool drawGroupUngroupButton( const std::vector<std::shared_ptr<Object>>& selected );
155 bool drawSelectSubtreeButton( const std::vector<std::shared_ptr<Object>>& selected );
156 bool drawCloneButton( const std::vector<std::shared_ptr<Object>>& selected );
157 bool drawCustomCheckBox( const std::vector<std::shared_ptr<Object>>& selected, SelectedTypesMask selectedMask );
158 bool drawCloneSelectionButton( const std::vector<std::shared_ptr<Object>>& selected );
159 bool drawMergeSubtreeButton( const std::vector<std::shared_ptr<Object>>& selected );
160protected:
161 // draw single item
162 MRVIEWER_API virtual void drawBigButtonItem_( const MenuItemInfo& item );
163 // draw set of small text buttons
164 MRVIEWER_API virtual void drawSmallButtonsSet_( const std::vector<std::string>& group, int setFrontIndex, int setLength,
165 bool withText );
166
167 // Configuration of ribbon group
169 {
170 int numBig{ 0 };
171 int numSmallText{ 0 };
172 int numSmall{ 0 };
173 };
174 using DrawTabConfig = std::vector<DrawGroupConfig>;
175 // draw group of items
176 MRVIEWER_API virtual DrawTabConfig setupItemsGroupConfig_( const std::vector<std::string>& groupsInTab, const std::string& tabName, bool centerItems );
177 MRVIEWER_API virtual void setupItemsGroup_( const std::vector<std::string>& groupsInTab, const std::string& tabName, bool centerItems );
178 MRVIEWER_API virtual void drawItemsGroup_( const std::string& tabName, const std::string& groupName,
179 DrawGroupConfig config );
180 // ribbon menu item pressed
181 // requiremetnsHint - text that is showed if tool is unavailable (if empty then tool is available)
182 // returns true if item was actually activated or deactivated with press action
183 MRVIEWER_API virtual bool itemPressed_( const std::shared_ptr<RibbonMenuItem>& item, const std::string& requiremetnsHint = {} );
184
186 MRVIEWER_API virtual std::string getRequirements_( const std::shared_ptr<RibbonMenuItem>& item ) const;
187
188 MRVIEWER_API virtual void drawActiveBlockingDialog_();
189 MRVIEWER_API virtual void drawActiveNonBlockingDialogs_();
190
191 MRVIEWER_API virtual void postResize_( int width, int height ) override;
192 MRVIEWER_API virtual void postRescale_( float x, float y ) override;
193
195 {
196 std::shared_ptr<RibbonMenuItem> item;
197 // this flag is needed to correctly fix position of UI dialog (temporary, while plugin dialogs are floating in viewport)
198 bool dialogPositionFixed{ false };
199 };
201 std::vector<DialogItemPtr> activeNonBlockingItems_;
202 MRVIEWER_API virtual void drawItemDialog_( DialogItemPtr& itemPtr );
203
204 // Draw ribbon top panel
205 MRVIEWER_API virtual void drawTopPanel_( bool drawTabs = true, bool centerItems = false );
206 // Draw scene list window with content
207 MRVIEWER_API virtual void drawRibbonSceneList_();
208 // Draw vertical line at the right border of scene to enable resize of scene list
209 // returns size of scene window
210 MRVIEWER_API virtual Vector2f drawRibbonSceneResizeLine_();
211 // Draw viewport id and projection type for all viewporrts
212 MRVIEWER_API virtual void drawRibbonViewportsLabels_();
213
214 MRVIEWER_API virtual void drawRibbonSceneInformation_( const std::vector<std::shared_ptr<Object>>& selected );
215
216 MRVIEWER_API virtual bool drawCollapsingHeaderTransform_() override;
217 MRVIEWER_API virtual bool drawTransformContextMenu_( const std::shared_ptr<Object>& selected ) override;
218
219 MRVIEWER_API virtual void addRibbonItemShortcut_( const std::string& itemName, const ShortcutKey& key, ShortcutCategory category );
220
221 MRVIEWER_API virtual void setupShortcuts_() override;
222
223 MRVIEWER_API virtual void drawShortcutsWindow_() override;
224 // reads files with panel description
225 MRVIEWER_API virtual void readMenuItemsStructure_();
226
227 std::vector<std::shared_ptr<const Object>> prevFrameSelectedObjectsCache_;
228
229 MRVIEWER_API virtual bool drawCollapsingHeader_( const char* label, ImGuiTreeNodeFlags flags = 0 ) override;
230
231 MRVIEWER_API virtual void highlightBlocking_();
232
233 // draw scene list buttons
234 MRVIEWER_API virtual void drawSceneListButtons_();
235
236 // updates viewport sizes with respect to ribbon top and left panels
237 MRVIEWER_API virtual void fixViewportsSize_( int w, int h );
238
239 // need to be called if you override windows pipeline and use ActiveListPlugin
240 MRVIEWER_API void drawActiveList_();
241
242 // call this to draw RibbonNotifier with respect of scene size and ribbon top panel
243 MRVIEWER_API virtual void drawNotifications_();
244
245 // this function changes internal sizes of topPanel when it is enabled or disabled
246 MRVIEWER_API virtual void updateTopPanelSize_( bool drawTabs );
247
249private:
250 void changeTab_( int newTab );
251
252 void drawSearchButton_();
253 void drawCollapseButton_();
254 void drawHelpButton_();
255
256 void sortObjectsRecursive_( std::shared_ptr<Object> object );
257
258 // part of top panel
259 void drawHeaderQuickAccess_();
260 void drawHeaderPannel_();
261 void drawActiveListButton_( float btnSize );
262
263 ImVec2 activeListPos_{ 0,0 };
264 bool activeListPressed_{ false };
265
266 void beginTopPanel_();
267 void endTopPanel_();
268 void drawTopPanelOpened_( bool drawTabs, bool centerItems );
269
270 std::string transformClipboardText_;
271
272 int currentTopPanelHeight_ = 113;
273 int topPanelOpenedHeight_ = 113;
274 int topPanelHiddenHeight_ = 33;
275
276 ImVec2 sceneSize_{ 310, 0 };
277 float informationHeight_{ 0.f };
278 float transformHeight_{ 0.f };
279
280 RibbonMenuUIConfig menuUIConfig_;
281
282 // how long blocking window will blink in seconds
283 float blockingHighlightTimer_{ 0.0f };
284
285 // current scroll position of tabs panel
286 float tabPanelScroll_{ 0.0f };
287
288 bool autoCloseBlockingPlugins_{ true };
289
290 enum class CollapseState
291 {
292 Closed,
293 Opened,
294 Pinned
295 } collapseState_{ CollapseState::Pinned };
296 // seconds to stay opened if not pinned
297 float openedMaxSecs_{ 2.0f };
298 float openedTimer_{ openedMaxSecs_ };
299
300 int activeTabIndex_{ 0 };
301 RibbonFontManager fontManager_;
302 RibbonButtonDrawer buttonDrawer_;
303
304 std::unordered_map<std::string, CustomContextMenuCheckbox> customCheckBox_;
305
306 Toolbar toolbar_;
307 RibbonNotifier notifier_;
308#ifndef __EMSCRIPTEN__
309 AsyncRequest asyncRequest_;
310#endif // !__EMSCRIPTEN__
311};
312
313// Checks if RibbonMenu is available, if it is - forwards notification to RibbonNotifier. Otherwise - calls showModal() function
314MRVIEWER_API void pushNotification( const RibbonNotification& notification );
315
316}
Definition ImGuiMenu.h:55
class for drawing ribbon menu buttons
Definition MRRibbonButtonDrawer.h:48
Definition MRRibbonFontManager.h:11
Definition MRRibbonMenuSearch.h:17
Definition MRRibbonMenu.h:44
bool hasAnyActiveItem() const
returns true if any plugin is now active
Definition MRRibbonMenu.h:105
virtual MRVIEWER_API void drawSceneListButtons_()
int getTopPanelOpenedHeight() const
Definition MRRibbonMenu.h:81
void setTopPanelMaxOpenedTimer(float sec)
Definition MRRibbonMenu.h:86
void showActiveList()
set active plugins list showed
Definition MRRibbonMenu.h:129
void setActiveListPos(const ImVec2 &pos)
Definition MRRibbonMenu.h:126
bool drawCloneSelectionButton(const std::vector< std::shared_ptr< Object > > &selected)
bool drawGroupUngroupButton(const std::vector< std::shared_ptr< Object > > &selected)
virtual MRVIEWER_API void setupShortcuts_() override
virtual MRVIEWER_API void setMenuUIConfig(const RibbonMenuUIConfig &newConfig)
virtual MRVIEWER_API void addRibbonItemShortcut_(const std::string &itemName, const ShortcutKey &key, ShortcutCategory category)
virtual MRVIEWER_API void drawActiveNonBlockingDialogs_()
DialogItemPtr activeBlockingItem_
Definition MRRibbonMenu.h:200
virtual MRVIEWER_API void shutdown() override
virtual MRVIEWER_API void drawShortcutsWindow_() override
virtual MRVIEWER_API void drawSmallButtonsSet_(const std::vector< std::string > &group, int setFrontIndex, int setLength, bool withText)
virtual MRVIEWER_API DrawTabConfig setupItemsGroupConfig_(const std::vector< std::string > &groupsInTab, const std::string &tabName, bool centerItems)
virtual MRVIEWER_API std::string getRequirements_(const std::shared_ptr< RibbonMenuItem > &item) const
returns requirements line for given tool, empty line means that tool is available
bool hasActiveBlockingItem() const
returns true if any blocking plugin is now active
Definition MRRibbonMenu.h:103
MRVIEWER_API bool isTopPannelPinned() const
static MRVIEWER_API std::shared_ptr< RibbonMenu > instance()
virtual MRVIEWER_API bool drawCollapsingHeader_(const char *label, ImGuiTreeNodeFlags flags=0) override
virtual MRVIEWER_API void highlightBlocking_()
bool getAutoCloseBlockingPlugins() const
returns flag defining if closing plugin on opening another one is enabled
Definition MRRibbonMenu.h:145
int getTopPanelHiddenHeight() const
Definition MRRibbonMenu.h:82
virtual MRVIEWER_API void drawActiveBlockingDialog_()
virtual MRVIEWER_API void readMenuItemsStructure_()
Vector2i getSceneSize()
get Scene List window size
Definition MRRibbonMenu.h:97
virtual MRVIEWER_API void drawNotifications_()
virtual MRVIEWER_API bool drawCollapsingHeaderTransform_() override
virtual MRVIEWER_API void drawBigButtonItem_(const MenuItemInfo &item)
MRVIEWER_API void drawActiveList_()
virtual MRVIEWER_API void drawRibbonSceneInformation_(const std::vector< std::shared_ptr< Object > > &selected)
virtual MRVIEWER_API void init(MR::Viewer *_viewer) override
static MRVIEWER_API void cloneTree(const std::vector< std::shared_ptr< Object > > &selectedObjects)
clones given objects with sub-objects (except for ancillary and unrecognized children) and undo
virtual MRVIEWER_API void drawItemDialog_(DialogItemPtr &itemPtr)
std::vector< std::shared_ptr< const Object > > prevFrameSelectedObjectsCache_
Definition MRRibbonMenu.h:227
virtual MRVIEWER_API void postResize_(int width, int height) override
virtual MRVIEWER_API void setQuickAccessListVersion(int version)
set quick access menu item list version
virtual MRVIEWER_API bool itemPressed_(const std::shared_ptr< RibbonMenuItem > &item, const std::string &requiremetnsHint={})
virtual MRVIEWER_API Vector2f drawRibbonSceneResizeLine_()
virtual MRVIEWER_API void load_font(int font_size=13) override
MRVIEWER_API void resetQuickAccessList()
reset quick access menu items list to default
virtual MRVIEWER_API void drawItemsGroup_(const std::string &tabName, const std::string &groupName, DrawGroupConfig config)
void setAutoCloseBlockingPlugins(bool value)
sets flag defining if closing plugin on opening another one is enabled or not
Definition MRRibbonMenu.h:147
virtual MRVIEWER_API void setupItemsGroup_(const std::vector< std::string > &groupsInTab, const std::string &tabName, bool centerItems)
RibbonFontManager & getFontManager()
get access to Ribbon font manager
Definition MRRibbonMenu.h:115
RibbonNotifier & getRibbonNotifier()
get access to Ribbon notifier
Definition MRRibbonMenu.h:124
static MRVIEWER_API void cloneSelectedPart(const std::shared_ptr< Object > &object)
clones selected part of given object as separate object (faces, points)
virtual MRVIEWER_API void drawTopPanel_(bool drawTabs=true, bool centerItems=false)
virtual MRVIEWER_API void pinTopPanel(bool on)
bool drawSelectSubtreeButton(const std::vector< std::shared_ptr< Object > > &selected)
bool drawCloneButton(const std::vector< std::shared_ptr< Object > > &selected)
virtual MRVIEWER_API std::filesystem::path getMenuFontPath() const override
virtual MRVIEWER_API void readQuickAccessList(const Json::Value &root)
read quick access menu items list from json
RibbonMenuSearch searcher_
Definition MRRibbonMenu.h:248
bool drawCustomCheckBox(const std::vector< std::shared_ptr< Object > > &selected, SelectedTypesMask selectedMask)
Toolbar & getToolbar()
get access to Ribbon Toolbar
Definition MRRibbonMenu.h:121
std::vector< DialogItemPtr > activeNonBlockingItems_
Definition MRRibbonMenu.h:201
boost::signals2::signal< void(int prevTabId, int newTabId)> TabChangedSignal
Definition MRRibbonMenu.h:140
std::vector< DrawGroupConfig > DrawTabConfig
Definition MRRibbonMenu.h:174
virtual MRVIEWER_API void postRescale_(float x, float y) override
virtual MRVIEWER_API void updateTopPanelSize_(bool drawTabs)
bool drawMergeSubtreeButton(const std::vector< std::shared_ptr< Object > > &selected)
RibbonButtonDrawer & getRibbonButtonDrawer()
get access to Ribbon button drawer
Definition MRRibbonMenu.h:118
int getTopPanelCurrentHeight() const
Definition MRRibbonMenu.h:83
MRVIEWER_API void setCustomContextCheckbox(const std::string &name, CustomContextMenuCheckbox customContextMenuCheckbox)
virtual MRVIEWER_API void drawRibbonSceneList_()
const RibbonMenuUIConfig & getMenuUIConfig() const
returns current menu ui configuration (find more in RibbonMenuUIConfig comments)
Definition MRRibbonMenu.h:150
virtual MRVIEWER_API void fixViewportsSize_(int w, int h)
MRVIEWER_API void openToolbarCustomize()
open Toolbar Customize modal popup
virtual MRVIEWER_API bool drawTransformContextMenu_(const std::shared_ptr< Object > &selected) override
virtual MRVIEWER_API void pushNotification(const RibbonNotification &notification)
int getActiveTabIndex() const
returns index of active tab in RibbonSchemaHolder::schema().tabsOrder
Definition MRRibbonMenu.h:111
virtual MRVIEWER_API void drawRibbonViewportsLabels_()
MRVIEWER_API void updateItemStatus(const std::string &itemName)
updates status of item if it was changed outside of menu
TabChangedSignal tabChangedSignal
this signal is called when active tab changes
Definition MRRibbonMenu.h:142
MRVIEWER_API void setSceneSize(const Vector2i &size)
set Scene List window size
Definition MRRibbonNotification.h:64
class to draw toolbar and toolbar customize windows
Definition MRToolbar.h:17
Definition MRViewer.h:78
Definition MRViewportId.h:16
@ None
special value not to limit path in one slice
Definition MRVoxelPath.h:33
SelectedTypesMask
Definition ImGuiMenu.h:34
RibbonTopPanelLayoutMode
Definition MRRibbonMenu.h:21
@ RibbonWithTabs
both ribbon toolbar and tabs
@ RibbonNoTabs
show only icons from the first tab, without tabs panel
MRVIEWER_API void pushNotification(const RibbonNotification &notification)
ShortcutCategory
Definition MRShortcutManager.h:28
Definition MRRibbonSchema.h:24
Definition MRRibbonMenu.h:28
RibbonTopPanelLayoutMode topLayout
how to show top panel
Definition MRRibbonMenu.h:29
bool drawNotifications
if false - no notifications are drawn on screen
Definition MRRibbonMenu.h:35
bool centerRibbonItems
if true - items on selected tab will be centered to have equal spacing from left and right (ignored t...
Definition MRRibbonMenu.h:30
bool operator==(const RibbonMenuUIConfig &) const =default
bool drawToolbar
if false - toolbar will be hidden (ignored if top panel is hidden)
Definition MRRibbonMenu.h:33
bool drawViewportTags
if false - window with viewport label and id will be hidden
Definition MRRibbonMenu.h:34
bool drawScenePanel
if false - panel with scene tree, information and transform will be hidden
Definition MRRibbonMenu.h:32
Definition MRRibbonMenu.h:195
std::shared_ptr< RibbonMenuItem > item
Definition MRRibbonMenu.h:196
Definition MRRibbonMenu.h:169
Definition MRRibbonNotification.h:38
Definition MRShortcutManager.h:13