Interface class from which all plugins have to be created. More...

#include <OpenFlipper/BasePlugin/BaseInterface.hh>

Inheritance diagram for BaseInterface:

Signals
Renderer control
virtual void	setRenderer (unsigned int _viewer, QString _rendererName)
	Set a renderer for the given viewer.
virtual void	getCurrentRenderer (unsigned int _viewer, QString &_rendererName)
	Get the current renderer for the given viewer.

Public Member Functions
virtual	~BaseInterface ()
	Destructor.

Private Slots
virtual void	exit ()
virtual void	noguiSupported ()
Initialization

virtual void	initializePlugin ()
	Initialize Plugin.
virtual void	pluginsInitialized ()
	Initialize Plugin step 2.

Object/View updates

virtual void	slotObjectUpdated (int _identifier)
	An object has been updated by another plugin.
virtual void	slotObjectUpdated (int _identifier, const UpdateType &_type)
	An object has been updated by another plugin.
virtual void	slotAllCleared ()
	Called if the whole scene is cleared.
virtual void	slotObjectSelectionChanged (int _identifier)
	The active object has changed.
virtual void	slotVisibilityChanged (int _identifier)
	An object has been shown or hidden.
virtual void	slotObjectPropertiesChanged (int _identifier)
	Object properties have been changed.
virtual void	slotViewChanged ()
	View has changed.
virtual void	slotSceneDrawn ()
	triggered after a scene has been drawn
virtual void	slotDrawModeChanged (int _viewerId)
	A viewer changed its draw mode.
virtual void	updateView ()
	Update current view in Main Application.
virtual void	updatedObject (int _objectId)
	An object has been changed or added by this plugin.
virtual void	updatedObject (int _identifier, const UpdateType &_type)
	An object has been changed or added by this plugin.
virtual void	nodeVisibilityChanged (int _identifier)
	A scenegraph node has been shown or hidden.

Plugin identification
virtual void	setSlotDescription (QString _slotName, QString _slotDescription, QStringList _parameters, QStringList _descriptions)
	Set a description for a public slot.
virtual QString	name ()=0
	Return a name for the plugin.
virtual QString	description ()=0
	Return a description of what the plugin is doing.
virtual QString	version ()
	Return a version string for your plugin.

Detailed Description

Interface class from which all plugins have to be created.

You have to implement at least name and description for your plugin. All other functions and signals are optional. If you want to implement or use them just add them to your plugin header. A detailed description of this interface can be found in the Base Interface .

See Plugin Programming for a tutorial on plugin programming.

Also see Dataflow diagrams for a detailed overview of OpenFlipper's data flow and interface function calls.

Definition at line 70 of file BaseInterface.hh.

Member Function Documentation

virtual QString BaseInterface::description ( )

pure virtual

Return a description of what the plugin is doing.

This function has to return a basic description of the plugin

virtual void BaseInterface::exit ( )

inlineprivatevirtualslot

This function is called when the application exits or when your plugin is about to be unloaded. Here you can clean up your plugin, delete local variables...

Definition at line 314 of file BaseInterface.hh.

virtual void BaseInterface::getCurrentRenderer	(	unsigned int	_viewer,
		QString &	_rendererName
	)

inlinevirtualsignal

Get the current renderer for the given viewer.

Parameters

_viewer	Id of the viewer to set the renderer for
_rendererName	Name of the renderer that is currently active

Definition at line 305 of file BaseInterface.hh.

virtual void BaseInterface::initializePlugin ( )

inlineprivatevirtualslot

Initialize Plugin.

This slot is called if the plugin is loaded and has to be initialized. All initialization stuff in this slot has to stay inside the plugin, no external signals are allowed here (and will be ignored). Don't create any objects via PluginFunctions here. Use the pluginsInitialized() slot for external initialization. After execution of this slot your plugin should be fully functional. Only gui elements may be uninitialized and should be created in pluginsInitialized().

Definition at line 88 of file BaseInterface.hh.

virtual QString BaseInterface::name ( )

pure virtual

Return a name for the plugin.

This Function has to return the name of the plugin.

virtual void BaseInterface::nodeVisibilityChanged ( int _identifier )

inlinevirtualsignal

A scenegraph node has been shown or hidden.

Emit this Signal, if you changed the visibility of a scenegraph node directly (not via object->show/hide). This is required to reset the near and far plane for the viewers to provide an optimal view. Use the id of the object the node is attached to or -1 if it is not connected to an object.

Definition at line 150 of file BaseInterface.hh.

virtual void BaseInterface::noguiSupported ( )

inlineprivatevirtualslot

Using this function you can inform the core that your plugin can run without creating a widget. If your plugin does not implement this function, it will not be loaded in scripting mode without gui. You don't have to do anything in this function.

Definition at line 320 of file BaseInterface.hh.

virtual void BaseInterface::pluginsInitialized ( )

inlineprivatevirtualslot

Initialize Plugin step 2.

This slot is called if all plugins are loaded and the core is ready. Afterwards you can already send signals to other plugins and the core (e.g. adding global textures).

Note: Do not create objects via addEmpty or load objects in this slot, as the rendering system is not ready yet.

Definition at line 96 of file BaseInterface.hh.

virtual void BaseInterface::setRenderer	(	unsigned int	_viewer,
		QString	_rendererName
	)

inlinevirtualsignal

Set a renderer for the given viewer.

Parameters

_viewer	Id of the viewer to set the renderer for
_rendererName	Name of the renderer to be used

Definition at line 298 of file BaseInterface.hh.

virtual void BaseInterface::setSlotDescription	(	QString	_slotName,
		QString	_slotDescription,
		QStringList	_parameters,
		QStringList	_descriptions
	)

inlinevirtualsignal

Set a description for a public slot.

public slots of each plugin are automatically available for scripting.
Use this Signal to add a description for your slot so that everyone knows what it is used for.

Parameters

_slotName	the name of the slot
_slotDescription	a description for the slot
_parameters	list of parameters
_descriptions	list of descriptions for the parameters (_descriptions[i] corresponds to _parameters[i])

Definition at line 282 of file BaseInterface.hh.

virtual void BaseInterface::slotAllCleared ( )

inlineprivatevirtualslot

Called if the whole scene is cleared.

This slot is called if the main application cleared the whole scene. No objects will remain in memory and all destructors of the objects are called before this signal is emitted.

Definition at line 185 of file BaseInterface.hh.

virtual void BaseInterface::slotDrawModeChanged ( int _viewerId )

inlineprivatevirtualslot

A viewer changed its draw mode.

Parameters

_viewerId Id of the viewer that changed its draw mode

Definition at line 239 of file BaseInterface.hh.

virtual void BaseInterface::slotObjectPropertiesChanged ( int _identifier )

inlineprivatevirtualslot

Object properties have been changed.

This slot is called if the object properties (e.g. name ) have changed The id of the object is given as a parameter. If multiple or all objects have changed, the id will be -1.

Definition at line 212 of file BaseInterface.hh.

virtual void BaseInterface::slotObjectSelectionChanged ( int _identifier )

inlineprivatevirtualslot

The active object has changed.

This slot is called by the main application if the current selection of an object has changed.
This means that the selection of source / target objects has changed. Additionally you get the id of the object that has been changed or -1 if all objects have been modified.

Definition at line 194 of file BaseInterface.hh.

virtual void BaseInterface::slotObjectUpdated ( int _identifier )

inlineprivatevirtualslot

An object has been updated by another plugin.

This slot is called by the main application if the number or status of existing objects changed or if an existing object has been changed. This could mean, that objects are added or deleted or that an existing object with the given id has been modified. If you store local information about one of these Objects, you should check if its still valid!
Don't emit BaseInterface::updatedObject(int) in this slot as this causes an endless Loop!! You don't need to call updateView as the core triggers a redraw itself.

Parameters

_identifier Identifier of the updated/new object or -1 if one is deleted.

Definition at line 164 of file BaseInterface.hh.

virtual void BaseInterface::slotObjectUpdated	(	int	_identifier,
		const UpdateType &	_type
	)

inlineprivatevirtualslot

An object has been updated by another plugin.

This slot is called by the main application if the number or status of existing objects changed or if an existing object has been changed. This could mean, that objects are added or deleted or that an existing object with the given id has been modified. If you store local information about one of these Objects, you should check if its still valid!
Don't emit BaseInterface::updatedObject(int) in this slot as this causes an endless Loop!! You don't need to call updateView as the core triggers a redraw itself.

Parameters

_identifier	Identifier of the updated/new object or -1 if one is deleted.
_type	the type states which part of the object (topology, selection, ..) had been updated

Definition at line 177 of file BaseInterface.hh.

virtual void BaseInterface::slotSceneDrawn ( )

inlineprivatevirtualslot

triggered after a scene has been drawn

This slot will be triggered every time, the OpenGl draw of one frame is completed. Every time you emit an updateView, a scene redraw will be triggered (except, if the minimal time between two frames is not yet reached). After drawing the scene, the core will call this slot to inform the plugins, that a new view is visible.

You can use this slot, if you need to control special updates in your plugin, that react on the fps.

Definition at line 233 of file BaseInterface.hh.

virtual void BaseInterface::slotViewChanged ( )

inlineprivatevirtualslot

View has changed.

This slot is called when the view in one of the viewers changed ( Viewing direction/viewer position ) !! Be careful to not change the view in this slot !! !! This will of course lead to an endless loop !!

Definition at line 221 of file BaseInterface.hh.

virtual void BaseInterface::slotVisibilityChanged ( int _identifier )

inlineprivatevirtualslot

An object has been shown or hidden.

This slot is called if an object is shown or hidden. The id of the object is given as a parameter. If multiple or all objects have changed, the id will be -1.

Definition at line 203 of file BaseInterface.hh.

virtual void BaseInterface::updatedObject ( int _objectId )

inlinevirtualsignal

An object has been changed or added by this plugin.

Emit this Signal, if you updated any part of an object.
If you changed the element itself (geometry, topology,..) you also have to emit this signal.
Don't emit this Signal in BaseInterface::slotObjectUpdated() as this causes an endless Loop!! Give the id of the new object as parameter or -1 if you updated all objects or deleted an object. For performance reasons try to always give the id and not -1!

Parameters

_objectId Id of the object or -1 if referring to all or deleted objects.

Definition at line 128 of file BaseInterface.hh.

virtual void BaseInterface::updatedObject	(	int	_identifier,
		const UpdateType &	_type
	)

inlinevirtualsignal

An object has been changed or added by this plugin.

Emit this Signal, if you updated any part of an object.
If you changed the element itself (geometry, topology,..) you also have to emit this signal.
Don't emit this Signal in BaseInterface::slotObjectUpdated() as this causes an endless Loop!! Give the id of the new object as parameter or -1 if you updated all objects or deleted an object. For performance reasons try to always give the id and not -1!

Parameters

_identifier	id of the object or -1 if referring to all or deleted objects.
_type	the type states which part of the object (topology, selection, ..) has to be updated

Definition at line 141 of file BaseInterface.hh.

virtual void BaseInterface::updateView ( )

inlinevirtualsignal

Update current view in Main Application.

Emit this Signal if the viewer widget in the main application should update the current view. If you do an updatedObject the core will trigger an update itself and you don't have to care about it.

Definition at line 116 of file BaseInterface.hh.

virtual QString BaseInterface::version ( )

inlinevirtualslot

Return a version string for your plugin.

This function will be used to determine the current version of your plugin. Should have the form x.x.x ( you do not need to give that many subversions )

Returns: The version string of the plugin

Definition at line 268 of file BaseInterface.hh.

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

OpenFlipper/BasePlugin/BaseInterface.hh

Signals

Public Member Functions

Private Slots

Object/View updates

Plugin identification

Detailed Description

Member Function Documentation