ecvPluginInterface.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
// Qt
#include <QIcon>
#include <QList>
#include <QObject>
#include <QPair>
#include <QString>
 
// Qt version
#include <qglobal.h>
 
class ccExternalFactory;
class ccCommandLineInterface;
 
enum CC_PLUGIN_TYPE {
    ECV_STD_PLUGIN = 1,
    ECV_PCL_ALGORITHM_PLUGIN = 2,
    ECV_IO_FILTER_PLUGIN = 4,
};
 
 
class ccPluginInterface {
public:
    // Contact represents a person and is used for authors and maintainer lists
    struct Contact {
        QString name;
        QString email;
    };
 
    typedef QList<Contact> ContactList;
 
    // Reference represents a journal article or online post about the plugin
    // where the user can find more information.
    struct Reference {
        QString article;
        QString url;
    };
 
    using ReferenceList = QList<Reference>;
 
public:
    virtual ~ccPluginInterface() = default;
 
    virtual CC_PLUGIN_TYPE getType() const = 0;
 
    virtual bool isCore() const = 0;
 
    virtual QString getName() const = 0;
 
    virtual QString getDescription() const = 0;
 
 
    virtual QIcon getIcon() const { return QIcon(); }
 
    virtual ReferenceList getReferences() const { return ReferenceList{}; }
 
    virtual ContactList getAuthors() const { return ContactList{}; }
 
    virtual ContactList getMaintainers() const { return ContactList{}; }
 
 
    virtual bool start() { return true; }
 
 
    virtual void stop() {}
 
 
    virtual ccExternalFactory* getCustomObjectsFactory() const {
        return nullptr;
    }
 
 
    virtual void registerCommands(ccCommandLineInterface* cmd) {
        Q_UNUSED(cmd);
    }
 
protected:
    friend class ccPluginManager;
 
    virtual void setIID(const QString& iid) = 0;
 
    virtual const QString& IID() const = 0;
};
 
Q_DECLARE_METATYPE(const ccPluginInterface*);
 
Q_DECLARE_INTERFACE(ccPluginInterface,
                    "edf.rd.cloudviewer.ccPluginInterface/3.2")