MeshLib C++ Docs
Loading...
Searching...
No Matches
MRRibbonSchema.h
Go to the documentation of this file.
1#pragma once
2#include "MRViewerFwd.h"
4#include "MRMesh/MRMeshFwd.h"
5#include "MRMesh/MRphmap.h"
6#include <json/forwards.h>
7#include <filesystem>
8#include <vector>
9#include <string>
10#include <memory>
11
12namespace MR
13{
14
15// needed for big buttons text aligning
16using SplitCaptionInfo = std::vector<std::pair<std::string_view, float>>;
17
23
25{
26 std::shared_ptr<RibbonMenuItem> item;
27 std::string caption;
28 std::string tooltip;
29 std::string icon;
31 std::string helpLink; // link to help page
32};
33
37using MenuItemsList = std::vector<std::string>;
39{
40 std::string name;
41 int priority{ 0 };
42 bool experimental{ false };
43};
44
45// This structure describes UI schema of ribbon menu
65
66// This class holds static ribbon schema,
67// note that schema becomes valid after loading (RibbonSchemaLoader)
68class MRVIEWER_CLASS RibbonSchemaHolder
69{
70public:
71 MRVIEWER_API static RibbonSchema& schema();
72
75 MRVIEWER_API static bool addItem( const std::shared_ptr<RibbonMenuItem>& item );
76
79 MRVIEWER_API static bool delItem( const std::shared_ptr<RibbonMenuItem>& item );
80
83 {
84 int tabIndex{ -1 }; // -1 is default value if item has no tab
85 const MenuItemInfo* item{ nullptr }; // item info to show correct caption
86 };
87
90 {
91 float captionWeight{ 1.f };
92 float captionOrderWeight{ 1.f };
93 float tooltipWeight{ 1.f };
94 float tooltipOrderWeight{ 1.f };
95 };
96
99 {
101 int* captionCount = nullptr;
103 std::vector<SearchResultWeight>* weights = nullptr;
105 RequirementsFunction requirementsFunc = {};
106 };
108 MRVIEWER_API static std::vector<SearchResult> search( const std::string& searchStr, const SearchParams& params );
109
111 MRVIEWER_API static int findItemTab( const std::shared_ptr<RibbonMenuItem>& item );
112
113private:
114 RibbonSchemaHolder() = default;
115};
116
117// Class for loading ribbon schema from structure files (basically called from RibbonMenu, but can be called separately)
118class MRVIEWER_CLASS RibbonSchemaLoader
119{
120public:
122 virtual ~RibbonSchemaLoader() = default;
123
124 // Loads schema from files
125 MRVIEWER_API virtual void loadSchema() const;
126
127 // Reads schema items list from `root` to `list`
128 MRVIEWER_API static void readMenuItemsList( const Json::Value& root, MenuItemsList& list );
129
130 // Recalc items sizes
131 MRVIEWER_API static void recalcItemSizes();
132protected:
133 // finds structure json files in exe directory
134 MRVIEWER_API virtual std::vector<std::filesystem::path> getStructureFiles_( const std::string& fileExtension ) const;
135 // sort structure json files by order
136 MRVIEWER_API void sortFilesByOrder_( std::vector<std::filesystem::path>& files ) const;
137 // appends one menu items json info
138 MRVIEWER_API void readItemsJson_( const std::filesystem::path& path ) const;
139 MRVIEWER_API void readItemsJson_( const Json::Value& root ) const;
140 // appends one ui json info
141 MRVIEWER_API void readUIJson_( const std::filesystem::path& path ) const;
142 MRVIEWER_API void readUIJson_( const Json::Value& root ) const;
143};
144
145
146template<typename T>
148{
149 static_assert( std::is_base_of_v<RibbonMenuItem, T> );
150public:
151 template<typename F>
152 RibbonMenuItemCall( F f, std::function<void(std::shared_ptr<T>)> g ) : g_( std::move( g ) )
153 {
154 const auto& items = RibbonSchemaHolder::schema().items;
155 for ( const auto& item : items )
156 {
157 auto plugin = std::dynamic_pointer_cast< T >( item.second.item );
158 if ( !plugin )
159 continue;
160 f( plugin_ = std::move( plugin ) );
161 break;
162 }
163 }
165 {
166 if ( g_ && plugin_ )
167 g_( plugin_ );
168 }
169private:
170 std::shared_ptr<T> plugin_;
171 std::function<void(std::shared_ptr<T>)> g_;
172};
173
175#define MR_RIBBON_ITEM_CALL(pluginType,f,g) \
176 static MR::RibbonMenuItemCall<pluginType> ribbonMenuItemCall##func##pluginType##_( f, g );
177
178} //namespace MR
Definition MRRibbonSchema.h:148
RibbonMenuItemCall(F f, std::function< void(std::shared_ptr< T >)> g)
Definition MRRibbonSchema.h:152
~RibbonMenuItemCall()
Definition MRRibbonSchema.h:164
Definition MRRibbonSchema.h:69
static MRVIEWER_API RibbonSchema & schema()
static MRVIEWER_API bool delItem(const std::shared_ptr< RibbonMenuItem > &item)
static MRVIEWER_API bool addItem(const std::shared_ptr< RibbonMenuItem > &item)
static MRVIEWER_API int findItemTab(const std::shared_ptr< RibbonMenuItem > &item)
returns item tab index in schema.tabsOrder or -1 if no tab found (e.g. scene fast access panel or hea...
static MRVIEWER_API std::vector< SearchResult > search(const std::string &searchStr, const SearchParams &params)
searches for tools with the most appropriate names (captions) or tooltips
Definition MRRibbonSchema.h:119
virtual ~RibbonSchemaLoader()=default
MRVIEWER_API void sortFilesByOrder_(std::vector< std::filesystem::path > &files) const
static MRVIEWER_API void recalcItemSizes()
virtual MRVIEWER_API std::vector< std::filesystem::path > getStructureFiles_(const std::string &fileExtension) const
MRVIEWER_API void readUIJson_(const std::filesystem::path &path) const
MRVIEWER_API void readItemsJson_(const Json::Value &root) const
MRVIEWER_API void readItemsJson_(const std::filesystem::path &path) const
virtual MRVIEWER_API void loadSchema() const
MRVIEWER_API void readUIJson_(const Json::Value &root) const
static MRVIEWER_API void readMenuItemsList(const Json::Value &root, MenuItemsList &list)
RibbonSchemaLoader()=default
Definition MRCameraOrientationPlugin.h:8
std::vector< std::pair< std::string_view, float > > SplitCaptionInfo
Definition MRRibbonSchema.h:16
std::function< std::string(const std::shared_ptr< RibbonMenuItem > &)> RequirementsFunction
Definition MRViewerFwd.h:76
HashMap< std::string, MenuItemInfo > ItemMap
Definition MRRibbonSchema.h:34
std::vector< std::string > MenuItemsList
Definition MRRibbonMenuItem.h:9
HashMap< std::string, std::vector< std::string > > TabsGroupsMap
Definition MRRibbonSchema.h:35
TabsGroupsMap GroupsItemsMap
Definition MRRibbonSchema.h:36
phmap::flat_hash_map< K, V, Hash, Eq > HashMap
Definition MRMesh/MRMeshFwd.h:528
Definition MRRibbonSchema.h:19
SplitCaptionInfo splitInfo
Definition MRRibbonSchema.h:21
float baseSize
Definition MRRibbonSchema.h:20
Definition MRRibbonSchema.h:25
std::string caption
Definition MRRibbonSchema.h:27
std::string helpLink
Definition MRRibbonSchema.h:31
std::string icon
Definition MRRibbonSchema.h:29
std::shared_ptr< RibbonMenuItem > item
Definition MRRibbonSchema.h:26
std::string tooltip
Definition MRRibbonSchema.h:28
MenuItemCaptionSize captionSize
Definition MRRibbonSchema.h:30
tool search options
Definition MRRibbonSchema.h:99
ancillary struct to hold information for search result order
Definition MRRibbonSchema.h:90
struct to hold information for search result presentation
Definition MRRibbonSchema.h:83
Definition MRRibbonSchema.h:47
MRVIEWER_API void updateCaptions()
updates inner caption for all StateBasePlugins in schema
MRVIEWER_API void eliminateEmptyGroups()
deletes empty groups (and references on them from tabs)
MenuItemsList sceneButtonsList
Definition MRRibbonSchema.h:54
MenuItemsList defaultQuickAccessList
Definition MRRibbonSchema.h:52
TabsGroupsMap tabsMap
Definition MRRibbonSchema.h:49
GroupsItemsMap groupsMap
Definition MRRibbonSchema.h:50
std::vector< RibbonTab > tabsOrder
Definition MRRibbonSchema.h:48
MRVIEWER_API void sortTabsByPriority()
re-order items in tabsOrder according to their priority, the order of items having same priority is p...
ItemMap items
Definition MRRibbonSchema.h:51
MenuItemsList headerQuickAccessList
Definition MRRibbonSchema.h:53
Definition MRRibbonSchema.h:39
bool experimental
Definition MRRibbonSchema.h:42
int priority
Definition MRRibbonSchema.h:41
std::string name
Definition MRRibbonSchema.h:40