RobWorkProject  24.6.21-
Public Member Functions | Protected Member Functions | List of all members
PyPlugin Class Reference

Inherits RobWorkStudioPlugin.

Public Member Functions

 PyPlugin (const QString &name, const QIcon &icon)
 constructor of the plugin interface More...
 
bool initialize (std::string pythonFilePath, std::string pluginName)
 Initialize the Python plugin. More...
 
void open (rw::models::WorkCell *workcell)
 called when a workcell is opened More...
 
void close ()
 called when a workcell is being closed.
 
- Public Member Functions inherited from RobWorkStudioPlugin
 RobWorkStudioPlugin (const QString &name, const QIcon &icon)
 constructor of the plugin interface More...
 
virtual void initialize ()
 is called when RobWorkStudio instance is valid. Can be used to initialize values in the plugin that depend on RobWorkStudio More...
 
virtual QString name () const
 name that describe the plugin instance
 
virtual void setupMenu (QMenu *menu)
 sets up the menu with this plugin More...
 
virtual void setupToolBar (QToolBar *toolbar)
 setsup a toolbar with the actions of this plugin More...
 
virtual void setRobWorkStudio (RobWorkStudio *studio)
 sets the RobWorkStudio instance of the plugin. Normally only done on construction.
 
virtual RobWorkStudiogetRobWorkStudio ()
 returns a handle to the RobWorkStudio instance
 
virtual void setRobWorkInstance (rw::core::RobWork::Ptr robwork)
 Sets the RobWork instance to be used by the plugin. More...
 
virtual rw::core::RobWork::Ptr getRobWorkInstance ()
 Returns RobWork instance used by the plugin.
 
virtual rw::core::Loglog ()
 returns the RobWorkStudio log instance
 
virtual void setLog (rw::core::Log::Ptr log)
 Sets the log to use. More...
 
const rw::kinematics::StategetState ()
 get current state of RobWorkStudio
 
void setState (const rw::kinematics::State &state)
 set current state of RobWorkStudio
 

Protected Member Functions

 ~PyPlugin ()
 simple destructer
 
- Protected Member Functions inherited from RobWorkStudioPlugin
boost::tuple< QWidget *, QAction *, int > getAction (QWidget *widget, const std::string &actionName)
 Find action in widget with name actionName . More...
 
boost::tuple< QWidget *, QMenu *, int > getMenu (QWidget *widget, const std::string &menuName)
 Find menu in widget with name menuName . More...
 
boost::tuple< QMenu *, QAction *, int > getAction (QWidget *widget, const std::string &actionName, const std::string &actionName2)
 Find action, actionName2, in menu, actionName, in a widget. More...
 

Additional Inherited Members

- Public Slots inherited from RobWorkStudioPlugin
void showPlugin ()
 toggles the visibility of the plugin
 
- Protected Attributes inherited from RobWorkStudioPlugin
QAction _showAction
 ! More...
 
QString _name
 ! More...
 
RobWorkStudio_studio
 ! More...
 
rw::core::RobWork::Ptr _robwork
 ! More...
 
rw::core::Log::Ptr _log
 ! More...
 

Constructor & Destructor Documentation

◆ PyPlugin()

PyPlugin ( const QString &  name,
const QIcon &  icon 
)

constructor of the plugin interface

Parameters
name[in] the name of the plugin
icon[in] the icon of the plugin

Member Function Documentation

◆ initialize()

bool initialize ( std::string  pythonFilePath,
std::string  pluginName 
)

Initialize the Python plugin.

Parameters
pythonFilePath[in] Full path to the python file
pluginName[in] the name of the plugin to be used when locating the widget in python
Returns
true if succes otherwise false

◆ open()

void open ( rw::models::WorkCell workcell)
virtual

called when a workcell is opened

Parameters
workcell[in] that has been loaded

Reimplemented from RobWorkStudioPlugin.


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