SMILX  1.01
Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
milxQtPythonPlugin Class Reference
Inheritance diagram for milxQtPythonPlugin:
milxQtPluginInterface

Public Slots

void resizeForFloat (bool floating)
 
void addObject (milxQtRenderWindow *rnd)
 
void addObject (milxQtImage *img)
 
void addObject (milxQtModel *mdl)
 
virtual void loadExtension ()
 
virtual void update ()
 
void preStartTasks ()
 
void postStartTasks ()
 
- Public Slots inherited from milxQtPluginInterface
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].
 

Public Member Functions

 milxQtPythonPlugin (QObject *theParent=0)
 
QString name ()
 Get the Name of the plugin. [Implement this in your plugin].
 
bool hasOpenSupport ()
 Does the plugin support opening files? [Implement this in your plugin].
 
QString openFileSupport ()
 Get the file support string for opening (extension wildcard list). [Implement this in your plugin].
 
QStringList openExtensions ()
 Get a list of supported file format extensions. [Implement this in your plugin].
 
bool hasSaveSupport ()
 Does the plugin support opening files? [Implement this in your plugin].
 
QString saveFileSupport ()
 Get the file support string for saving (extension wildcard list). [Implement this in your plugin].
 
QStringList saveExtensions ()
 Get a list of supported file format extensions. [Implement this in your plugin].
 
bool hasCollectionSupport ()
 Does the plugin support collections (PolyData collection etc.). [Implement this in your plugin].
 
void SetInputCollection (vtkPolyDataCollection *collection, QStringList &filenames)
 Pass a collection to internal plugin class. [Implement this in your plugin].
 
void open (QString filename)
 Open the file using the plugin. [Implement this in your plugin].
 
void save (QString filename)
 Save the result as a file using the plugin. [Implement this in your plugin].
 
milxQtRenderWindowgenericResult ()
 Get the generic result, which is a milxQtRenderWindow. The result can then be displayed in milxQtMain etc. [Implement this in your plugin].
 
milxQtModelmodelResult ()
 Get the model result. The result can then be displayed in milxQtMain etc. [Implement this in your plugin].
 
milxQtImageimageResult ()
 Get the image result. The result can then be displayed in milxQtMain etc.[Implement this in your plugin].
 
QDockWidget * dockWidget ()
 Return the dock widget (if one is provided by plugin). [Implement this in your plugin].
 
Qt::DockWidgetArea dockDefaultArea ()
 Return the default dock widget area (if one is provided by plugin). [Implement this in your plugin].
 
bool isPluginWindow (QWidget *window)
 Is the window provided a plugin generated window? In this case a milxQtShapeModel window. [Implement this in your plugin].
 
milxQtPythonConsolepluginWindow (QWidget *window)
 
- Public Member Functions inherited from milxQtPluginInterface
 milxQtPluginInterface (QObject *theParent=0)
 Default destructor.
 
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...
 
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 Member Functions

void run ()
 
void setupPython ()
 
void createConnections ()
 

Protected Attributes

QPointer< milxQtPythonConsolepyConsole
 Python Console widget.
 
QPointer< QDockWidget > dock
 Dock widget.
 
QPointer< milxQtMainMainWindow
 
PythonQtObjectPtr mainContext
 Python Context to Python Intepreter.
 
- Protected Attributes inherited from milxQtPluginInterface
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
 
milxQtConsoleconsole
 console for logging
 

Additional Inherited Members

- Signals inherited from milxQtPluginInterface
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,.
 

Detailed Description

Definition at line 32 of file milxQtPythonPlugin.h.

Constructor & Destructor Documentation

◆ milxQtPythonPlugin()

milxQtPythonPlugin::milxQtPythonPlugin ( QObject *  theParent = 0)

Up cast parent to milxQtMain

Definition at line 22 of file milxQtPythonPlugin.cpp.

Member Function Documentation

◆ pluginWindow()

milxQtPythonConsole * milxQtPythonPlugin::pluginWindow ( QWidget *  window)

Casts window to a milxQtPythonConsole class after performing relevant checks

Definition at line 132 of file milxQtPythonPlugin.cpp.

◆ run()

void milxQtPythonPlugin::run ( )
protected

Execute own thread work here

Definition at line 139 of file milxQtPythonPlugin.cpp.

◆ setupPython()

void milxQtPythonPlugin::setupPython ( )
protected
Todo:
remove this when unified window is accessible from Python

Definition at line 149 of file milxQtPythonPlugin.cpp.


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