milxQtPluginInterface.h

/*=========================================================================
  The Software is copyright (c) Commonwealth Scientific and Industrial Research Organisation (CSIRO)
  ABN 41 687 119 230.
  All rights reserved.

  Licensed under the CSIRO BSD 3-Clause License
  You may not use this file except in compliance with the License.
  You may obtain a copy of the License in the file LICENSE.md or at

  https://stash.csiro.au/projects/SMILI/repos/smili/browse/license.txt

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
=========================================================================*/
#ifndef MILXQTPLUGININTERFACE_H
#define MILXQTPLUGININTERFACE_H

#include <QThread>
#include <QMenu>
#include <QDockWidget>
//VTK
#include <vtkPolyDataCollection.h>

#include "milxQtAliases.h"
#include "milxQtRenderWindow.h"
#include "milxQtImage.h"
#include "milxQtModel.h"

class MILXQT_EXPORT milxQtPluginInterface : public QThread
{
    Q_OBJECT

public:
    milxQtPluginInterface(QObject *theParent = 0) : QThread(theParent) {};
    virtual ~milxQtPluginInterface() {};

    virtual QString name() = 0;
    inline void setFileName(const QString filename)
    {
        dataName = filename;
    }
    inline void setConsole(milxQtConsole *con)
    {
        console = con;
    }

    virtual bool hasOpenSupport() = 0;
    virtual QString openFileSupport() = 0;
    virtual QStringList openExtensions() = 0;
    virtual bool hasSaveSupport() = 0;
    virtual QString saveFileSupport() = 0;
    virtual QStringList saveExtensions() = 0;

    virtual bool hasCollectionSupport() = 0;
    virtual void SetInputCollection(vtkPolyDataCollection* collection, QStringList &filenames) = 0;

    virtual void open(QString filename) = 0;
    virtual void save(QString filename) = 0;

    virtual milxQtRenderWindow* genericResult() = 0;
    virtual milxQtModel* modelResult() = 0;
    virtual milxQtImage* imageResult() = 0;
    virtual QDockWidget* dockWidget() = 0;

    virtual Qt::DockWidgetArea dockDefaultArea() = 0;

    virtual bool isPluginWindow(QWidget *window) = 0;

    inline bool isThreaded()
    {
        return threaded;
    }
    inline bool isDockable()
    {
        return dockable;
    }
    inline bool isConsole()
    {
        return consoleWindow;
    }
    inline bool isExtension()
    {
        return extension;
    }

    inline QList<QAction*> addToFileMenu()
    {
        return fileMenuEntries;
    }
    inline QList<QMenu*> addToMenuBar()
    {
        return menuToAdd;
    }

public slots:
    virtual void loadExtension() = 0;
    virtual void update() = 0;
    virtual void preStartTasks() = 0;
    virtual void postStartTasks() = 0;

signals:
    void resultAvailable(milxQtRenderWindow*);
    void resultAvailable(milxQtModel*);
    void resultAvailable(milxQtImage*);
    void resultAvailable(vtkPolyDataCollection*, QStringList&);

    void working(int value);
    void done(int value);

protected:
    QString pluginName;
    QString dataName;
    bool threaded; 
    bool dockable; 
    bool consoleWindow; 
    bool extension; 

    QMutex mutex;

    QList<QAction*> fileMenuEntries;
    QList<QMenu*> menuToAdd;

    milxQtConsole *console; 

private:

};

class MILXQT_EXPORT milxQtPluginFactory
{
public:
    virtual ~milxQtPluginFactory() {}
    virtual milxQtPluginInterface* newPlugin(QObject *theParent = 0) = 0;
};

Q_DECLARE_INTERFACE(milxQtPluginFactory, "milxQt.Plugins.milxQtPluginFactory/1.0");

#endif // MILXQTPLUGININTERFACE_H