MR::StateBasePlugin Class Reference

#include <MRViewer/MRStatePlugin.h>

Inheritance diagram for MR::StateBasePlugin:

Public Member Functions
	StateBasePlugin (std::string name, StatePluginTabs tab=StatePluginTabs::Other)
virtual	~StateBasePlugin ()=default
virtual 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 void	shutdown () override
	This function is called before shutdown.
bool	isEnabled () const
virtual bool	enable (bool on)
virtual bool	dialogIsOpen () const
virtual const std::string &	uiName () const override
void	setUIName (std::string name)
	set plugin name that will be used for dialog in ImGuiBeginWindow_
StatePluginTabs	getTab () const
virtual std::string	getTooltip () const
virtual std::string	sortString () const
	returns special string for sorting plugins in menu (plugin name by default)
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)
	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
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 const char *	UINameSuffix ()
static const char *	getTabName (StatePluginTabs tab)

Public Attributes
std::string	plugin_name

Protected Member Functions
virtual bool	ImGuiBeginWindow_ (ImGui::CustomStatePluginWindowParameters params)
virtual bool	onEnable_ ()
virtual 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>>

---

The documentation for this class was generated from the following file:

• MRViewer/MRStatePlugin.h