Developer Documentation
RulerPlugin Class Reference
Inheritance diagram for RulerPlugin:
BaseInterface MouseInterface PickingInterface ToolbarInterface LoadSaveInterface OptionsInterface

Public Slots

void slotPickModeChanged (const std::string &_mode)
 
void slotMouseEvent (QMouseEvent *_event)
 
void slotViewChanged ()
 
QString version ()
 

Signals

void addToolbar (QToolBar *_toolbar)
 
void addPickMode (const std::string &_mode)
 
void updateView ()
 
void setPickModeMouseTracking (const std::string &_mode, bool _mouseTracking)
 
- Signals inherited from BaseInterface
virtual void updateView ()
 Update current view in Main Application. More...
 
virtual void setSlotDescription (QString _slotName, QString _slotDescription, QStringList _parameters, QStringList _descriptions)
 Set a description for a public slot. More...
 
virtual void setRenderer (unsigned int _viewer, QString _rendererName)
 Set a renderer for the given viewer. More...
 
- Signals inherited from PickingInterface
virtual void addPickMode (const std::string &_mode)
 Add a new picking mode to the examiner. More...
 
- Signals inherited from ToolbarInterface
virtual void addToolbar (QToolBar *_toolbar)
 Adds a Toolbar to the main widget. More...
 
- Signals inherited from LoadSaveInterface
virtual void save (int _id, QString _filename)
 Save object to a file. More...
 
virtual void load (QString _filename, DataType _type, int &_id)
 Load object from file with a specific DataType. More...
 

Public Member Functions

bool initializeOptionsWidget (QWidget *&_widget)
 Initialize the Options Widget. More...
 
QString name ()
 Return a name for the plugin. More...
 
QString description ()
 Return a description of what the plugin is doing. More...
 

Private Slots

void initializePlugin ()
 
void pluginsInitialized ()
 
void slotChangePickMode ()
 
void slotAllCleared ()
 
void objectDeleted (int _id)
 
void applyOptions ()
 
- Private Slots inherited from BaseInterface
virtual void exit ()
 
virtual QString version ()
 Return a version string for your plugin. More...
 

Private Member Functions

void reset ()
 
void enableDragMode (const int _point)
 
void disableDragMode ()
 
bool dragModeActive ()
 
- Private Member Functions inherited from BaseInterface
virtual void noguiSupported ()
 
virtual ~BaseInterface ()
 Destructor.
 
virtual void blockScenegraphUpdates (bool _block)
 Tell the core to prevent scenegraph updates. More...
 
virtual void updatedObject (int _objectId)
 An object has been changed or added by this plugin. More...
 
virtual void updatedObject (int _identifier, const UpdateType &_type)
 An object has been changed or added by this plugin. More...
 
virtual void nodeVisibilityChanged (int _identifier)
 A scenegraph node has been shown or hidden. More...
 
virtual void getCurrentRenderer (unsigned int _viewer, QString &_rendererName)
 Get the current renderer for the given viewer. More...
 
- Private Member Functions inherited from MouseInterface
virtual ~MouseInterface ()
 Destructor.
 
- Private Member Functions inherited from PickingInterface
virtual void addHiddenPickMode (const std::string &_mode)
 Add a new picking mode to the examiner which will be invisible. More...
 
virtual void setPickModeCursor (const std::string &_mode, QCursor _cursor)
 Set the cursor of the given PickMode. More...
 
virtual void setPickModeMouseTracking (const std::string &_mode, bool _mouseTracking)
 Set mouse tracking for the given PickMode. More...
 
virtual void setPickModeToolbar (const std::string &_mode, QToolBar *_toolbar)
 Set the additional toolbar of the given PickMode. More...
 
virtual void removePickModeToolbar (const std::string &_mode)
 Removes the additional toolbar of the given PickMode. More...
 
virtual ~PickingInterface ()
 Destructor.
 
- Private Member Functions inherited from ToolbarInterface
virtual ~ToolbarInterface ()
 Destructor.
 
virtual void removeToolbar (QToolBar *_toolbar)
 Remove a Toolbar from the main widget. More...
 
virtual void getToolBar (QString _name, QToolBar *&_toolbar)
 Get a pointer to a Toolbar of the given name or 0 if it does not exist. More...
 
- Private Member Functions inherited from LoadSaveInterface
virtual ~LoadSaveInterface ()
 Destructor.
 
virtual void addEmptyObject (DataType _type, int &_id)
 
virtual void copyObject (int _oldId, int &_newId)
 
virtual void emptyObjectAdded (int _id)
 DEPRECATED HERE (Moved to Type Interface)! Emit this signal if an empty object has been created. More...
 
virtual void deleteObject (int _id)
 Delete an object
This signal can be called from any thread.
. More...
 
virtual void deleteAllObjects ()
 Delete all Objects. More...
 
virtual void getAllFileFilters (QStringList &_filters)
 Get all file filters that are registered. More...
 
- Private Member Functions inherited from OptionsInterface
virtual ~OptionsInterface ()
 Destructor.
 
virtual void applyOptions ()=0
 Apply changes to options. More...
 

Private Attributes

QAction * buttonAction_
 
const std::string pickModeName_
 
int lineDrag_
 
bool dblClickCheck_
 
ptr::shared_ptr< RulercurrentRuler_
 
RulerOptionsoptionsWidget_
 
const QString textSizeSettingName_
 

Detailed Description

Definition at line 68 of file RulerPlugin.hh.

Member Function Documentation

QString RulerPlugin::description ( )
inlinevirtual

Return a description of what the plugin is doing.

This function has to return a basic description of the plugin

Implements BaseInterface.

Definition at line 107 of file RulerPlugin.hh.

bool RulerPlugin::initializeOptionsWidget ( QWidget *&  _widget)
virtual

Initialize the Options Widget.

Initialize the options widget (create a widget and return a pointer to it )

Example :
_widget = new QWidget();

In the widget you can add anything you want.

use the slot applyOptions() to save the values of options currently entered in your widget.

Parameters
_widgetPointer to the new Widget
Returns
Return true if a widget has been created

Implements OptionsInterface.

Definition at line 267 of file RulerPlugin.cc.

QString RulerPlugin::name ( )
inlinevirtual

Return a name for the plugin.

This Function has to return the name of the plugin.

Implements BaseInterface.

Definition at line 106 of file RulerPlugin.hh.


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