#include </home/runner/work/hal/hal/plugins/gui_extension_demo/include/gui_extension_demo/plugin_gui_extension_demo.h>

Inheritance diagram for hal::GuiExtensionDemoPlugin:

Collaboration diagram for hal::GuiExtensionDemoPlugin:

Public Member Functions
	GuiExtensionDemoPlugin ()

std::string	get_name () const override

std::string	get_version () const override

std::string	get_description () const override

void	initialize () override

Public Member Functions inherited from hal::BasePluginInterface
	BasePluginInterface ()=default

virtual	~BasePluginInterface ()

virtual std::set< std::string >	get_dependencies () const

template<typename... Args>
void	log (const Args &... args) const

virtual void	on_load ()

virtual void	on_unload ()

virtual void	initialize_logging ()

virtual std::vector< AbstractExtensionInterface * >	get_extensions () const

template<typename T >
T *	get_first_extension () const

void	delete_extension (AbstractExtensionInterface *aeif)

Friends
class	GuiExtensionPythonBase

Additional Inherited Members
Protected Attributes inherited from hal::BasePluginInterface
std::vector< AbstractExtensionInterface * >	m_extensions

Detailed Description

An example plugin that shows how to contribute parameters and context menu entries to the GUI.

Definition at line 89 of file plugin_gui_extension_demo.h.

Constructor & Destructor Documentation

◆ GuiExtensionDemoPlugin()

hal::GuiExtensionDemoPlugin::GuiExtensionDemoPlugin ( )

Definition at line 29 of file plugin_gui_extension_demo.cpp.

References hal::BasePluginInterface::m_extensions.

Member Function Documentation

◆ get_description()

std::string hal::GuiExtensionDemoPlugin::get_description ( ) const

overridevirtual

Get the description of the plugin.

Returns: The description of the plugin.

Reimplemented from hal::BasePluginInterface.

Definition at line 44 of file plugin_gui_extension_demo.cpp.

◆ get_name()

std::string hal::GuiExtensionDemoPlugin::get_name ( ) const

overridevirtual

Get the name of the plugin.

Returns: The name of the plugin.

Implements hal::BasePluginInterface.

Definition at line 34 of file plugin_gui_extension_demo.cpp.

Referenced by hal::PYBIND11_PLUGIN().

◆ get_version()

std::string hal::GuiExtensionDemoPlugin::get_version ( ) const

overridevirtual

Get the version of the plugin.

Returns: The version of the plugin.

Implements hal::BasePluginInterface.

Definition at line 39 of file plugin_gui_extension_demo.cpp.

Referenced by hal::PYBIND11_PLUGIN().

◆ initialize()

void hal::GuiExtensionDemoPlugin::initialize ( )

overridevirtual

Plugins utilize two phase construction. Always populate all members etc in the initialize function which is automatically called by plugin_manager::get_plugin_instance()

Reimplemented from hal::BasePluginInterface.

Definition at line 49 of file plugin_gui_extension_demo.cpp.