MR::StateBasePlugin Class Reference

#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
virtual bool	isActive () const override
virtual bool	blocking () const override
virtual MRVIEWER_API void	shutdown () override
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)
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 > > &)

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_ ()
virtual void	onPluginDisable_ ()
virtual bool	shouldClose_ () const

Protected Attributes
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_

Additional Inherited Members
Public Types inherited from MR::RibbonMenuItem
using	DropItemsList = std::vector<std::shared_ptr<RibbonMenuItem>>

Constructor & Destructor Documentation

StateBasePlugin()

MRVIEWER_API MR::StateBasePlugin::StateBasePlugin	(	std::string	name,
		StatePluginTabs	tab = StatePluginTabs::Other )

~StateBasePlugin()

virtual MR::StateBasePlugin::~StateBasePlugin ( )

virtualdefault

Member Function Documentation

action()

virtual bool MR::StateBasePlugin::action ( )

inlineoverridevirtual

Implements MR::RibbonMenuItem.

blocking()

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

inlineoverridevirtual

Reimplemented from MR::RibbonMenuItem.

Reimplemented in MR::MoveObjectByMouse, and MR::SelectObjectByClick.

checkStringMask()

MRVIEWER_API bool MR::StateBasePlugin::checkStringMask

(

const std::string &

mask

)

const

dialogIsOpen()

virtual MRVIEWER_API bool MR::StateBasePlugin::dialogIsOpen ( ) const

virtual

drawDialog()

virtual MRVIEWER_API void MR::StateBasePlugin::drawDialog ( ImGuiContext * ctx )

virtual

Reimplemented in MR::MoveObjectByMouse, and MR::SelectObjectByClick.

enable()

virtual MRVIEWER_API bool MR::StateBasePlugin::enable ( bool on )

virtual

Reimplemented in MR::StateListenerPlugin< Connectables >, MR::StateListenerPlugin< DragStartListener, DragListener, DragEndListener, PostDrawListener >, and MR::StateListenerPlugin< MouseDownListener, MouseUpListener, MouseMoveListener >.

getTab()

MRVIEWER_API StatePluginTabs MR::StateBasePlugin::getTab

(

)

const

getTabName()

static MRVIEWER_API const char * MR::StateBasePlugin::getTabName ( StatePluginTabs tab )

static

getTooltip()

virtual MRVIEWER_API std::string MR::StateBasePlugin::getTooltip ( ) const

virtual

ImGuiBeginWindow_()

virtual MRVIEWER_API bool MR::StateBasePlugin::ImGuiBeginWindow_ ( ImGui::CustomStatePluginWindowParameters params )

protectedvirtual

isActive()

virtual bool MR::StateBasePlugin::isActive ( ) const

inlineoverridevirtual

Reimplemented from MR::RibbonMenuItem.

isEnabled()

MRVIEWER_API bool MR::StateBasePlugin::isEnabled

(

)

const

onDisable_()

virtual MRVIEWER_API bool MR::StateBasePlugin::onDisable_ ( )

protectedvirtual

Reimplemented in MR::MoveObjectByMouse.

onEnable_()

virtual MRVIEWER_API bool MR::StateBasePlugin::onEnable_ ( )

protectedvirtual

setUIName()

MRVIEWER_API void MR::StateBasePlugin::setUIName

(

std::string

name

)

shutdown()

virtual MRVIEWER_API void MR::StateBasePlugin::shutdown ( )

overridevirtual

Reimplemented from MR::ViewerPlugin.

sortString()

virtual std::string MR::StateBasePlugin::sortString ( ) const

inlinevirtual

uiName()

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

inlineoverridevirtual

Reimplemented from MR::RibbonMenuItem.

UINameSuffix()

static MRVIEWER_API const char * MR::StateBasePlugin::UINameSuffix ( )

static

Member Data Documentation

dialogIsCollapsed_

bool MR::StateBasePlugin::dialogIsCollapsed_ { false }

protected

dialogIsOpen_

bool MR::StateBasePlugin::dialogIsOpen_ {false}

protected

isEnabled_

bool MR::StateBasePlugin::isEnabled_ {false}

protected

plugin_name

std::string MR::StateBasePlugin::plugin_name

tab_

StatePluginTabs MR::StateBasePlugin::tab_ {StatePluginTabs::Other}

protected

---

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

• MRStatePlugin.h