BasePclModule.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 <QObject>
#include <QString>
 
// CV_DB_LIB
#include <ecvHObject.h>
 
// ECV_PLUGINS
#include <ecvPluginInterface.h>
 
class QAction;
class ccPointCloud;
class ecvMainAppInterface;
 
struct PclModuleDescription {
public:
    QString m_module_name;
    QString m_entry_name;
    QString m_status_tip;
    QIcon m_icon;
 
    PclModuleDescription()
        : m_module_name("PCLModule"),
          m_entry_name("module"),
          m_status_tip("Compute something with PCL"),
          m_icon(QIcon(QString::fromUtf8(":/toolbar/pcl.png"))) {}
 
    PclModuleDescription(QString filterName,
                         QString entryName,
                         QString statusTip,
                         QString icon)
        : m_module_name(filterName),
          m_entry_name(entryName),
          m_status_tip(statusTip),
          m_icon(QIcon(icon)) {}
};
 
 
class BasePclModule : public QObject {
    Q_OBJECT
 
public:
    BasePclModule(PclModuleDescription desc = PclModuleDescription(),
                  ccPluginInterface* parent_plugin = 0);
 
    QAction* getAction();
 
 
    virtual QString getErrorMessage(int errorCode);
 
 
    QString getStatusTip() const;
 
    QString getModuleName() const;
 
 
    QString getEntryName() const;
 
    QIcon getIcon() const;
 
    void setShowProgressBar(bool status) { m_show_progress = status; }
 
 
    std::vector<std::string> getSelectedAvailableScalarFields();
 
 
    ccPointCloud* getSelectedEntityAsCCPointCloud() const;
 
 
    ccHObject* getSelectedEntityAsCCHObject() const;
 
    ccHObject::Container getSelectedThatHaveMetaData(const QString key) const;
 
    void getAllEntitiesOfType(CV_CLASS_ENUM type,
                              ccHObject::Container& entities);
 
 
    void getAllEntitiesThatHaveMetaData(QString key,
                                        ccHObject::Container& entities);
 
    void getSelectedEntitiesThatAreCCPointCloud(ccHObject::Container& entities);
 
    void getSelectedEntitiesThatAre(CV_CLASS_ENUM kind,
                                    ccHObject::Container& entities);
 
    int hasSelectedRGB();
 
    int hasSelectedScalarField();
 
    int hasSelectedScalarField(std::string field_name);
 
    int isFirstSelectedCcPointCloud();
 
 
    virtual void updateSelectedEntities(
            const ccHObject::Container& selectedEntities);
 
 
    virtual int compute() = 0;
 
    void setMainAppInterface(ecvMainAppInterface* app) { m_app = app; }
 
    ecvMainAppInterface* getMainAppInterface() { return m_app; }
 
    ccPluginInterface* getParentPlugin() const { return m_parent_plugin; }
 
protected slots:
 
 
    // DGM: useless as dialogs are always modal
    // virtual int dialogAccepted();
 
 
    int performAction();
 
signals:
 
    void entityHasChanged(ccHObject*);
 
    void newEntity(ccHObject*);
 
    void newErrorMessage(QString);
 
protected:
 
    virtual int checkSelected();
 
 
    virtual int openInputDialog() { return 1; }
 
 
    virtual int openOutputDialog() { return 1; }
 
 
    virtual void getParametersFromDialog() {}
 
 
    virtual int checkParameters() { return 1; }
 
 
    virtual int start();
 
 
    virtual void initAction();
 
 
    void throwError(int errCode);
 
 
    // DGM: dirty! library has no access to GUI (see MVC architecture)
    // virtual void updateUi();
 
    QAction* m_action;
 
 
    // DGM: dirty! library has no access to GUI (see MVC architecture)
    // MainWindow * m_q_parent;
 
 
    ccHObject::Container m_selected;
 
 
    // DGM: dirty! some siblings must define the same variable with a different
    // type! QFileDialog * m_dialog;
 
 
    PclModuleDescription m_desc;
 
    ecvMainAppInterface* m_app;
 
    ccPluginInterface* m_parent_plugin;
 
    bool m_show_progress;
};