|
MeshLib C++ Docs
|
|
MeshLib C++ Docs
|
#include <MRStatePlugin.h>
Inheritance diagram for MR::StateBasePlugin:Public Member Functions | |
| MRVIEWER_API | StateBasePlugin (std::string name, StatePluginTabs tab=StatePluginTabs::Other) |
| virtual | ~StateBasePlugin ()=default |
| virtual MRVIEWER_API void | drawDialog (ImGuiContext *ctx) |
| virtual bool | action () override |
| returns true if state of item changed | |
| virtual bool | isActive () const override |
| for state items returns true if activated | |
| virtual bool | blocking () const override |
| true if this item is blocking (only one blocking item can be active at once) | |
| virtual MRVIEWER_API void | shutdown () override |
| This function is called before shutdown. | |
| MRVIEWER_API bool | isEnabled () const |
| virtual MRVIEWER_API bool | enable (bool on) |
| virtual MRVIEWER_API bool | dialogIsOpen () const |
| virtual const std::string & | uiName () const override |
| MRVIEWER_API void | setUIName (std::string name) |
set plugin name that will be used for dialog in ImGuiBeginWindow_ | |
| MRVIEWER_API StatePluginTabs | getTab () const |
| virtual MRVIEWER_API std::string | getTooltip () const |
| virtual std::string | sortString () const |
| returns special string for sorting plugins in menu (plugin name by default) | |
| MRVIEWER_API bool | checkStringMask (const std::string &mask) const |
| check if search mask satisfies for this plugin | |
| Public Member Functions inherited from MR::ViewerPlugin | |
| virtual | ~ViewerPlugin () |
| virtual void | init (Viewer *_viewer) |
| This function is called when the viewer is initialized (no mesh will be loaded at this stage) | |
| Public Member Functions inherited from MR::RibbonMenuItem | |
| MR_DELETE_MOVE (RibbonMenuItem) | |
| MRVIEWER_API | RibbonMenuItem (std::string name) |
| virtual | ~RibbonMenuItem ()=default |
| const std::string & | name () const |
| void | setRibbonItemType (RibbonItemType type) |
| virtual RibbonItemType | type () const |
| type of this item, base RibbonMenuItem can be only button | |
| MRVIEWER_API void | setDropItemsFromItemList (const MenuItemsList &itemsList) |
| virtual const DropItemsList & | dropItems () const |
| virtual std::string | getDynamicTooltip () const |
| return not-empty string with tooltip that shall replace the static tooltip from json | |
| Public Member Functions inherited from MR::ISceneStateCheck | |
| virtual | ~ISceneStateCheck ()=default |
| virtual std::string | isAvailable (const std::vector< std::shared_ptr< const Object > > &) const |
| return empty string if all requirements are satisfied, otherwise return first unsatisfied requirement | |
| Public Member Functions inherited from MR::IPluginUpdate | |
| virtual | ~IPluginUpdate ()=default |
| virtual void | preDrawUpdate () |
| called each frame in before drawDialog | |
| Public Member Functions inherited from MR::ISceneSelectionChange | |
| virtual | ~ISceneSelectionChange ()=default |
| virtual void | updateSelection (const std::vector< std::shared_ptr< const Object > > &) |
Static Public Member Functions | |
| static MRVIEWER_API const char * | UINameSuffix () |
| static MRVIEWER_API const char * | getTabName (StatePluginTabs tab) |
Public Attributes | |
| std::string | plugin_name |
Protected Member Functions | |
| virtual MRVIEWER_API bool | ImGuiBeginWindow_ (ImGui::CustomStatePluginWindowParameters params) |
| virtual MRVIEWER_API bool | onEnable_ () |
| virtual MRVIEWER_API bool | onDisable_ () |
| Protected Member Functions inherited from MR::IPluginUpdate | |
| virtual void | onPluginEnable_ () |
| called when plugin started | |
| virtual void | onPluginDisable_ () |
| called when plugin stops | |
| virtual bool | shouldClose_ () const |
| called each frame, return true to close plugin | |
Protected Attributes | |
| bool | isEnabled_ {false} |
| bool | dialogIsOpen_ {false} |
| bool | dialogIsCollapsed_ { false } |
| StatePluginTabs | tab_ {StatePluginTabs::Other} |
| Protected Attributes inherited from MR::ViewerPlugin | |
| Viewer * | viewer = &getViewerInstance() |
| Pointer to the main Viewer class. | |
| Protected Attributes inherited from MR::RibbonMenuItem | |
| RibbonItemType | type_ { RibbonItemType::Button } |
| DropItemsList | dropList_ |
Additional Inherited Members | |
| Public Types inherited from MR::RibbonMenuItem | |
| using | DropItemsList = std::vector<std::shared_ptr<RibbonMenuItem>> |
1.11.0 