The interface for any plugins that can be made for milxQtMain. More...

#include <milxQtPluginInterface.h>

Inheritance diagram for milxQtPluginInterface:

Public Slots
virtual void	loadExtension ()=0
	Load the extension. [Implement this in your plugin].

virtual void	update ()=0
	Update the plugin. [Implement this in your plugin]. More...

virtual void	preStartTasks ()=0
	Tasks to complete before running or starting the thread. [Implement this].

virtual void	postStartTasks ()=0
	Tasks to complete after running or starting the thread. [Implement this].

Signals
void	resultAvailable (milxQtRenderWindow *)
	Send signal that Resultant render window is available for showing.

void	resultAvailable (milxQtModel *)
	Send signal that Resultant model is available for showing.

void	resultAvailable (milxQtImage *)
	Send signal that Resultant image is available for showing.

void	resultAvailable (vtkPolyDataCollection *, QStringList &)
	Send signal that Resultant collection is available for showing.

void	working (int value)
	Send signal that computation is in progress. Value carries the progress,.

void	done (int value)
	Send signal that computation is done. Value carries the progress,.

Public Member Functions
	milxQtPluginInterface (QObject *theParent=0)
	Default destructor.

virtual QString	name ()=0
	Get the Name of the plugin. [Implement this in your plugin].

void	setFileName (const QString filename)
	Set the Name of the data. [Don't Reimplement this]. More...

void	setConsole (milxQtConsole *con)
	Set console to be used by plugins for output. More...

virtual bool	hasOpenSupport ()=0
	Does the plugin support opening files? [Implement this in your plugin].

virtual QString	openFileSupport ()=0
	Get the file support string for opening (extension wildcard list). [Implement this in your plugin].

virtual QStringList	openExtensions ()=0
	Get a list of supported file format extensions. [Implement this in your plugin].

virtual bool	hasSaveSupport ()=0
	Does the plugin support opening files? [Implement this in your plugin].

virtual QString	saveFileSupport ()=0
	Get the file support string for saving (extension wildcard list). [Implement this in your plugin].

virtual QStringList	saveExtensions ()=0
	Get a list of supported file format extensions. [Implement this in your plugin].

virtual bool	hasCollectionSupport ()=0
	Does the plugin support collections (PolyData collection etc.). [Implement this in your plugin].

virtual void	SetInputCollection (vtkPolyDataCollection *collection, QStringList &filenames)=0
	Pass a collection to internal plugin class. [Implement this in your plugin].

virtual void	open (QString filename)=0
	Open the file using the plugin. [Implement this in your plugin].

virtual void	save (QString filename)=0
	Save the result as a file using the plugin. [Implement this in your plugin].

virtual milxQtRenderWindow *	genericResult ()=0
	Get the generic result, which is a milxQtRenderWindow. The result can then be displayed in milxQtMain etc. [Implement this in your plugin].

virtual milxQtModel *	modelResult ()=0
	Get the model result. The result can then be displayed in milxQtMain etc. [Implement this in your plugin].

virtual milxQtImage *	imageResult ()=0
	Get the image result. The result can then be displayed in milxQtMain etc.[Implement this in your plugin].

virtual QDockWidget *	dockWidget ()=0
	Return the dock widget (if one is provided by plugin). [Implement this in your plugin].

virtual Qt::DockWidgetArea	dockDefaultArea ()=0
	Return the default dock widget area (if one is provided by plugin). [Implement this in your plugin].

virtual bool	isPluginWindow (QWidget *window)=0
	Is the window provided a plugin generated window? In this case a milxQtShapeModel window. [Implement this in your plugin].

bool	isThreaded ()
	Is the plugin threaded? [Don't Reimplement this].

bool	isDockable ()
	Is the plugin a dock window? [Don't Reimplement this].

bool	isConsole ()
	Is the plugin a console dock window? If so, it will be added to the console dock window. [Don't Reimplement this].

bool	isExtension ()
	Is the plugin an extension? [Don't Reimplement this].

QList< QAction * >	addToFileMenu ()
	Actions to add to the file or context menu. [Don't Reimplement this].

QList< QMenu * >	addToMenuBar ()
	Menus to add to the menu bar. [Don't Reimplement this].

Protected Attributes
QString	pluginName

QString	dataName

bool	threaded
	Threaded plugin?

bool	dockable
	Dockable plugin?

bool	consoleWindow
	console window?

bool	extension
	Extension rather than a plugin?

QMutex	mutex

QList< QAction * >	fileMenuEntries

QList< QMenu * >	menuToAdd

milxQtConsole *	console
	console for logging

Detailed Description

The interface for any plugins that can be made for milxQtMain.

Author: Shekhar S. Chandra, 2013

sMILX has three types of Plugins:

A dock window plugin
A full plugin for processing and data manipulation, loading and creation etc.
An extension An extension is a light-weight plugin that provides just a few content menu entries and some extensions to the basic MILX Qt classes like milxQtImage or milxQtModel. Examples of a dock plugin, standard plugin and extension is the milxQtPythonPlugin, milxQtSSMPlugin and milxQtAnimatePlugin classes respectively.

Members marked with [Implement this in your plugin] should be reimplemented in your plugin but maybe empty if not used.

Definition at line 46 of file milxQtPluginInterface.h.

Member Function Documentation

◆ setConsole()

milxQtPluginInterface::setConsole ( milxQtConsole * con )

inline

Set console to be used by plugins for output.

Plugins should not reimplement this member

Definition at line 79 of file milxQtPluginInterface.h.

◆ setFileName()

milxQtPluginInterface::setFileName ( const QString filename )

inline

Set the Name of the data. [Don't Reimplement this].

Plugins should not reimplement this member

Definition at line 69 of file milxQtPluginInterface.h.

◆ update

milxQtPluginInterface::update ( )

pure virtualslot

Update the plugin. [Implement this in your plugin].

This generic call is called after plugin is loaded and is designed to be used to update the plugin internals such as manager displays etc.

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

include/Qt/milxQtPluginInterface.h

Public Slots

Signals

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ setConsole()

◆ setFileName()

◆ update