RobWorkProject  24.5.15-
Public Member Functions | Protected Member Functions | List of all members
TreeView Class Reference

The TreeView plugin display the kinematic structure of a workcell in a treeview fashion and enables the user to select and do simple manipulation of frames, devices, drawables and so on. More...

#include <TreeView.hpp>

Inherits RobWorkStudioPlugin.

Public Member Functions

 TreeView ()
 constructor
 
virtual ~TreeView ()
 destructor
 
virtual void open (rw::models::WorkCell *workcell)
 called when a workcell is opened More...
 
virtual void close ()
 called when a workcell is being closed. More...
 
void workcellChangedListener (int val)
 Update the view - this method can be called from other threads. More...
 
void frameSelectedListener (rw::kinematics::Frame *frame)
 Select a specific frame. More...
 
void stateChangedListener (const rw::kinematics::State &state)
 Listen for updates to the state (for instance attaching/detaching of frames). More...
 
- Public Member Functions inherited from RobWorkStudioPlugin
 RobWorkStudioPlugin (const QString &name, const QIcon &icon)
 constructor of the plugin interface 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

void initialize ()
 is called when RobWorkStudio instance is valid. Can be used to initialize values in the plugin that depend on RobWorkStudio More...
 
- 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...
 

Detailed Description

The TreeView plugin display the kinematic structure of a workcell in a treeview fashion and enables the user to select and do simple manipulation of frames, devices, drawables and so on.

Member Function Documentation

◆ close()

virtual void close ( )
virtual

called when a workcell is being closed.

Reimplemented from RobWorkStudioPlugin.

◆ frameSelectedListener()

void frameSelectedListener ( rw::kinematics::Frame frame)

Select a specific frame.

Parameters
frame[in] the frame.
Note
This is not currently used.

◆ initialize()

void initialize ( )
protectedvirtual

is called when RobWorkStudio instance is valid. Can be used to initialize values in the plugin that depend on RobWorkStudio

Note
DO NOT fire any events under initialization since the order of which plugins are initialized is unknown. Therefore undefined behavior might occour. Instead wait until open is called for the first time.

Reimplemented from RobWorkStudioPlugin.

◆ open()

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

called when a workcell is opened

Parameters
workcell[in] that has been loaded

Reimplemented from RobWorkStudioPlugin.

◆ stateChangedListener()

void stateChangedListener ( const rw::kinematics::State state)

Listen for updates to the state (for instance attaching/detaching of frames).

Parameters
state[in] the state.

◆ workcellChangedListener()

void workcellChangedListener ( int  val)

Update the view - this method can be called from other threads.

Parameters
val[in] not currently used.

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