MR::ViewerSettingsPlugin Class Reference

#include <MRViewerSettingsPlugin.h>

Inheritance diagram for MR::ViewerSettingsPlugin:

Classes
class	ExternalSettings

Public Types
enum class	TabType {   Quick , Application , Control , Viewport ,   MeasurementUnits , Features , Count }
Public Types inherited from MR::StateListenerPlugin< Connectables >
using	PluginParent = StateListenerPlugin<Connectables...>
using	MultiListenerBase = MultiListener<Connectables...>
Public Types inherited from MR::RibbonMenuItem
using	DropItemsList = std::vector<std::shared_ptr<RibbonMenuItem>>

Public Member Functions
	ViewerSettingsPlugin ()
virtual const std::string &	uiName () const override
virtual void	drawDialog (float menuScaling, ImGuiContext *ctx) override
virtual bool	blocking () const override
MRVIEWER_API void	updateThemes ()
MRVIEWER_API void	addComboSettings (const TabType tab, std::shared_ptr< ExternalSettings > settings)
	add external settings with UI combo box
MRVIEWER_API void	delComboSettings (const TabType tab, const ExternalSettings *settings)
	delete external settings with UI combo box
MRVIEWER_API void	setActiveTab (TabType tab)
	changes active tab
Public Member Functions inherited from MR::StateListenerPlugin< Connectables >
virtual	~StateListenerPlugin ()=default
virtual bool	enable (bool on) override final
MRVIEWER_API	StateBasePlugin (std::string name, StatePluginTabs tab=StatePluginTabs::Other)
Public Member Functions inherited from MR::StateBasePlugin
MRVIEWER_API	StateBasePlugin (std::string name, StatePluginTabs tab=StatePluginTabs::Other)
virtual	~StateBasePlugin ()=default
virtual bool	action () override
virtual bool	isActive () const override
virtual MRVIEWER_API void	shutdown () override
MRVIEWER_API bool	isEnabled () const
virtual MRVIEWER_API bool	dialogIsOpen () const
MRVIEWER_API void	setUINameDeferred (std::string name)
MRVIEWER_API StatePluginTabs	getTab () const
virtual MRVIEWER_API std::string	getTooltip () const
virtual std::string	sortString () const
MRVIEWER_API bool	checkStringMask (const std::string &mask) const
Public Member Functions inherited from MR::ViewerPlugin
virtual	~ViewerPlugin ()
virtual void	init (Viewer *_viewer)
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
MRVIEWER_API void	setDropItemsFromItemList (const MenuItemsList &itemsList)
virtual const DropItemsList &	dropItems () const
virtual std::string	getDynamicTooltip () const
Public Member Functions inherited from MR::ISceneStateCheck
virtual	~ISceneStateCheck ()=default
virtual std::string	isAvailable (const std::vector< std::shared_ptr< const Object > > &) const
Public Member Functions inherited from MR::IPluginUpdate
virtual	~IPluginUpdate ()=default
virtual void	preDrawUpdate ()
Public Member Functions inherited from MR::ISceneSelectionChange
virtual	~ISceneSelectionChange ()=default
virtual void	updateSelection (const std::vector< std::shared_ptr< const Object > > &)
Public Member Functions inherited from MR::MultiListener< Connectables... >
virtual	~MultiListener ()=default
virtual void	connect (Viewer *viewer, int group=0, boost::signals2::connect_position pos=boost::signals2::connect_position::at_back)
virtual void	disconnect ()

Static Public Member Functions
static MRVIEWER_API ViewerSettingsPlugin *	instance ()
Static Public Member Functions inherited from MR::StateBasePlugin
static MRVIEWER_API const char *	UINameSuffix ()
static MRVIEWER_API const char *	getTabName (StatePluginTabs tab)

Additional Inherited Members
Public Attributes inherited from MR::StateBasePlugin
std::string	plugin_name
Protected Member Functions inherited from MR::StateBasePlugin
virtual MRVIEWER_API bool	ImGuiBeginWindow_ (ImGui::CustomStatePluginWindowParameters params)
Protected Member Functions inherited from MR::IPluginUpdate
virtual void	onPluginEnable_ ()
virtual void	onPluginDisable_ ()
virtual bool	shouldClose_ () const
Protected Attributes inherited from MR::StateBasePlugin
bool	isEnabled_ {false}
bool	dialogIsOpen_ {false}
bool	dialogIsCollapsed_ { false }
StatePluginTabs	tab_ {StatePluginTabs::Other}
Protected Attributes inherited from MR::ViewerPlugin
Viewer *	viewer = &getViewerInstance()
Protected Attributes inherited from MR::RibbonMenuItem
RibbonItemType	type_ { RibbonItemType::Button }
DropItemsList	dropList_

Member Enumeration Documentation

TabType

enum class MR::ViewerSettingsPlugin::TabType

strong

Enumerator
Quick
Application
Control
Viewport
MeasurementUnits
Features
Count

Constructor & Destructor Documentation

ViewerSettingsPlugin()

MR::ViewerSettingsPlugin::ViewerSettingsPlugin

(

)

Member Function Documentation

addComboSettings()

MRVIEWER_API void MR::ViewerSettingsPlugin::addComboSettings	(	const TabType	tab,
		std::shared_ptr< ExternalSettings >	settings )

add external settings with UI combo box

blocking()

virtual bool MR::ViewerSettingsPlugin::blocking ( ) const

inlineoverridevirtual

Reimplemented from MR::StateBasePlugin.

delComboSettings()

MRVIEWER_API void MR::ViewerSettingsPlugin::delComboSettings	(	const TabType	tab,
		const ExternalSettings *	settings )

delete external settings with UI combo box

drawDialog()

virtual void MR::ViewerSettingsPlugin::drawDialog ( float menuScaling, ImGuiContext * ctx )

overridevirtual

Reimplemented from MR::StateBasePlugin.

instance()

static MRVIEWER_API ViewerSettingsPlugin * MR::ViewerSettingsPlugin::instance ( )

static

returns instance of this plugin if it is registered nullptr otherwise

setActiveTab()

MRVIEWER_API void MR::ViewerSettingsPlugin::setActiveTab

(

TabType

tab

)

changes active tab

uiName()

virtual const std::string & MR::ViewerSettingsPlugin::uiName ( ) const

overridevirtual

Reimplemented from MR::StateBasePlugin.

updateThemes()

MRVIEWER_API void MR::ViewerSettingsPlugin::updateThemes

(

)

---

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

• MRViewerSettingsPlugin.h