Plugin Interfaces

OpenFlipper provides a flexible plugin interface. Plugins can implement various interfaces. Each interface provides special signals/slots or functions to communicate with the core or to react on special events. The most important interface is the BaseInterface. This Interface provides the core functionality for the plugin. E.g. loading the plugin, specifying its name and basic communication regrading object changes or view updates ( See BaseInterface for further details).
Additional functionality is provided by the other interfaces. For user interaction one typically uses the MouseInterface or KeyInterface which will provide events based on mouse or keyboard interaction.
The interface of OpenFlipper can also be used by plugins. The MenubarInterface provides functions to add additional icons to the menubar. Using the ToolboxInterface one can add widgets to the toolbox on the right of the OpenFlipper screen.

Base Interface

This is the Basic plugin Interface. All Plugins have to provide at least this interface. It offers plugin name and some important Signals and slots which will be called by the main application. See BaseInterface for details.

Keyboard Interface

keyInterface.png

You have to provide this interface if you want to get key events in your plugin ( KeyInterface ).

Mouse Interface

mouseInterface.png

This interface is used to deliver mouse events to a plugin ( MouseInterface ).

Load / Save Interface

loadSaveInterface.png

Provides functions to handle mesh files and load / unload geometry objects into the scene graph ( LoadSaveInterface ).

Toolbar Interface

ToolbarInterface.png

Provides a function to add toolbar buttons. ( ToolbarInterface )

Context Menu Interface

ContextMenuInterface.png

Add context menu entries in your plugin. ( ContextMenuInterface )

Menubar Interface

MenubarInterface.png

Provides a function to create an entry in the menubar ( MenuInterface ).

Toolbox Interface

ToolboxInterface.png

Provides functions to create a separate widget in the toolbox on the right ( ToolboxInterface ).

Logging Interface

LoggingInterface.png

This is an Interface for Logging to the included textedit widget. You can log to different levels (LOGOUT,LOGWARN,LOGERR,LOGINFO) ( LoggingInterface ).

Texture Interface

TextureInterface.png

Allows your plugin to provide a texture. ( TextureInterface )

Mouse Picking / Pick Modes

PickingInterface.png

Handle mouse picking in your plugin ( PickingInterface )

RPC Interface

RPCInterface.png

This interface is used to call functions across different plugins ( RPCInterface ).

File Interface

FileInterface.png

Provides functions to read and write custom filetypes ( FileInterface )

View Interface

ViewInterface.png

This interface is used to add additional view widgets ( ViewInterface ).

Script Interface

ScriptInterface.png

For plugins who provide scriptable functions ( ScriptInterface )

Status Bar Interface

StatusbarInterface.png

This interface is used to display messages in the status bar ( StatusbarInterface )

Options Interface

OptionsInterface.png

This Interface is used by plugins which will provide their own options by integrating its own options widget into OpenFlipper's options window. ( OptionsInterface )

Backup Interface

BackupInterface.png

Use this interface to backup data ( BackupInterface )

Use Inifiles to store information

INIInterface.png

Receive an event if an ini file is opened by the application. ( INIInterface )


acg pic Project OpenFlipper, ©  Computer Graphics Group, RWTH Aachen. Documentation generated using doxygen .