ViewerExtension.h

Go to the documentation of this file.

/*****************************************************************************
* $CAMITK_LICENCE_BEGIN$
*
* CamiTK - Computer Assisted Medical Intervention ToolKit
* (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
*
* Visit http://camitk.imag.fr for more information
*
* This file is part of CamiTK.
*
* CamiTK is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* CamiTK is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU Lesser General Public License version 3 for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
*
* $CAMITK_LICENCE_END$
****************************************************************************/
 
#ifndef VIEWER_EXTENSION_H
#define VIEWER_EXTENSION_H
 
#include "CamiTKAPI.h"
 
// -- QT stuff
#include <QRegularExpression>
#include <QTranslator>
 
namespace camitk {
class Viewer;

#define registerDefaultViewer(className)                        setManagedMetaObject(&className::staticMetaObject); \
                                                                registerViewer(new className(QString(#className).replace(QRegularExpression("([^A-Z\\s])([A-Z])"),"\\1 \\2").replace(QRegularExpression("([A-Z]+)([A-Z][a-z])"),"\\1 \\2")));

#define registerNewViewer(className, instanceName)              setManagedMetaObject(&className::staticMetaObject); \
                                                                registerViewer(new className(QString(instanceName)))

class CAMITK_API ViewerExtension : public QObject {
 
protected:
    ViewerExtension();
 
public:
    ~ViewerExtension() override;

    virtual QString getName() const = 0;

    virtual QString getDescription() const = 0;

    virtual void init() = 0;

    const ViewerList& getViewers();

    void setLocation(const QString loc);

    QString getLocation() const;

    void initResources();

    QString getViewerClassName() const;

    Viewer* getNewInstance(QString name);
 
protected:
    bool registerViewer(Viewer*);

    ViewerList viewers;

    void setManagedMetaObject(const QMetaObject*);
 
private:
    QString dynamicLibraryFileName;

    QTranslator* translator;

    const QMetaObject* managedMetaObject;
};
 
}
// -------------------- declare the interface for QPluginLoader --------------------
Q_DECLARE_INTERFACE(camitk::ViewerExtension, "TIMC-IMAG. Viewer Extension/2.1")    //TODO use variable from CMake?
 
#endif //VIEWER_EXTENSION_H