Developer Documentation
TypeSkeletonPlugin Class Reference
Inheritance diagram for TypeSkeletonPlugin:
BaseInterface LoadSaveInterface LoggingInterface TypeInterface ContextMenuInterface

Public Slots

QString version ()
 

Signals

void log (Logtype _type, QString _message)
 
void log (QString _message)
 
void emptyObjectAdded (int _id)
 
void addContextMenuItem (QAction *_action, ContextMenuType _type)
 
void addContextMenuItem (QAction *_action, DataType _objectType, ContextMenuType _type)
 
- 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 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...
 
- Signals inherited from LoggingInterface
virtual void log (Logtype _type, QString _message)=0
 
virtual void log (QString _message)=0
 
- Signals inherited from TypeInterface
virtual void emptyObjectAdded (int _id)
 Emit this signal if an empty object has been created. More...
 
- Signals inherited from ContextMenuInterface
virtual void addContextMenuItem (QAction *_action, ContextMenuType _type)
 Add an entry for a context Menu. More...
 

Public Member Functions

QString name ()
 Return a name for the plugin. More...
 
QString description ()
 Return a description of what the plugin is doing. More...
 
bool registerType ()
 
int addEmpty ()
 Create an empty object. More...
 
DataType supportedType ()
 Return your supported object type( e.g. DATA_TRIANGLE_MESH ) More...
 
void generateBackup (int _id, QString _name, UpdateType _type)
 This slot should be implemented in a TypePlugin to generate type specific backups. More...
 

Private Slots

void pluginsInitialized ()
 Second initialization phase. More...
 
void noguiSupported ()
 
- Private Slots inherited from BaseInterface
virtual void exit ()
 
virtual QString version ()
 Return a version string for your plugin. More...
 
- Private Slots inherited from TypeInterface

Private Member Functions

void slotUpdateContextMenu (int _objectId)
 
void slotShowIndices ()
 
void slotShowCoordFrames ()
 
void slotShowMotionPath ()
 
- 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 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 LoggingInterface
virtual ~LoggingInterface ()
 Destructor.
 
- Private Member Functions inherited from TypeInterface
virtual ~TypeInterface ()
 Destructor.
 
- Private Member Functions inherited from ContextMenuInterface
virtual ~ContextMenuInterface ()
 Destructor.
 
virtual void addContextMenuItem (QAction *_action, DataType _objectType, ContextMenuType _type)
 Add an entry for a context Menu. More...
 
virtual void hideContextMenu ()
 hide the main context menu
 

Private Attributes

QAction * showIndicesAction_
 
QAction * showCoordFramesAction_
 
QAction * showMotionAction_
 

Detailed Description

Definition at line 60 of file TypeSkeleton.hh.

Member Function Documentation

◆ addEmpty()

int TypeSkeletonPlugin::addEmpty ( )
virtual

Create an empty object.

When this slot is called you have to create an object of your supported type.

Returns
Id of the new Object

Implements TypeInterface.

Definition at line 188 of file TypeSkeleton.cc.

◆ description()

QString TypeSkeletonPlugin::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 105 of file TypeSkeleton.hh.

◆ generateBackup()

void TypeSkeletonPlugin::generateBackup ( int  _id,
QString  _name,
UpdateType  _type 
)
virtual

This slot should be implemented in a TypePlugin to generate type specific backups.

Parameters
_idId of the added object
_namename of the backup
_typethe type of backup that needs to be done

Reimplemented from TypeInterface.

Definition at line 224 of file TypeSkeleton.cc.

◆ name()

QString TypeSkeletonPlugin::name ( )
inlinevirtual

Return a name for the plugin.

This Function has to return the name of the plugin.

Implements BaseInterface.

Definition at line 104 of file TypeSkeleton.hh.

◆ pluginsInitialized

void TypeSkeletonPlugin::pluginsInitialized ( )
privateslot

Second initialization phase.

Definition at line 64 of file TypeSkeleton.cc.

◆ slotUpdateContextMenu()

void TypeSkeletonPlugin::slotUpdateContextMenu ( int  _objectId)
privatevirtual

When the main application requests a context menu, this slot is called before showing the window. If an object is picked the id will be given in this call so you can change the contents of your menu depending on the given object.

Parameters
_objectIdid of the object

Reimplemented from ContextMenuInterface.

Definition at line 104 of file TypeSkeleton.cc.

◆ supportedType()

DataType TypeSkeletonPlugin::supportedType ( )
inlinevirtual

Return your supported object type( e.g. DATA_TRIANGLE_MESH )

The function is used from addEmpty in the core to check if your plugin can create an object of a given dataType. If so, your addEmpty function will be invoked to create it.

Implements TypeInterface.

Definition at line 116 of file TypeSkeleton.hh.


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