ecvCommandLineInterface.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
 
#include "CVPluginAPI.h"
 
// qCC_db
#include <ecvPointCloud.h>
 
// qCC_io
#include <FileIOFilter.h>
 
// Qt
#include <QSharedPointer>
#include <QString>
#include <QStringList>
 
// System
#include <vector>
 
class ccGenericMesh;
class ecvProgressDialog;
 
class QDialog;
 
enum class CL_ENTITY_TYPE { GROUP, CLOUD, MESH };
 
struct CVPLUGIN_LIB_API CLEntityDesc {
    QString basename;
    QString path;
    int indexInFile;
 
    CLEntityDesc(const QString& name);
    CLEntityDesc(const QString& filename, int _indexInFile);
    CLEntityDesc(const QString& _basename,
                 const QString& _path,
                 int _indexInFile = -1);
 
    virtual ~CLEntityDesc() = default;
 
    virtual ccHObject* getEntity() = 0;
    virtual const ccHObject* getEntity() const = 0;
    virtual CL_ENTITY_TYPE getCLEntityType() const = 0;
};
 
struct CVPLUGIN_LIB_API CLGroupDesc : CLEntityDesc {
    ccHObject* groupEntity;
 
    CLGroupDesc(ccHObject* group,
                const QString& basename,
                const QString& path = QString());
 
    ~CLGroupDesc() override = default;
 
    ccHObject* getEntity() override;
    const ccHObject* getEntity() const override;
    CL_ENTITY_TYPE getCLEntityType() const override;
};
 
struct CVPLUGIN_LIB_API CLCloudDesc : CLEntityDesc {
    ccPointCloud* pc;
 
    CLCloudDesc();
 
    CLCloudDesc(ccPointCloud* cloud,
                const QString& filename = QString(),
                int index = -1);
 
    CLCloudDesc(ccPointCloud* cloud,
                const QString& basename,
                const QString& path,
                int index = -1);
 
    ~CLCloudDesc() override = default;
 
    ccHObject* getEntity() override;
    const ccHObject* getEntity() const override;
    CL_ENTITY_TYPE getCLEntityType() const override;
};
 
struct CVPLUGIN_LIB_API CLMeshDesc : CLEntityDesc {
    ccGenericMesh* mesh;
 
    CLMeshDesc();
 
    CLMeshDesc(ccGenericMesh* _mesh,
               const QString& filename = QString(),
               int index = -1);
 
    CLMeshDesc(ccGenericMesh* _mesh,
               const QString& basename,
               const QString& path,
               int index = -1);
 
    ~CLMeshDesc() override = default;
 
    ccHObject* getEntity() override;
    const ccHObject* getEntity() const override;
    CL_ENTITY_TYPE getCLEntityType() const override;
};
 
class CVPLUGIN_LIB_API ccCommandLineInterface {
public:  // constructor
    ccCommandLineInterface();
 
    virtual ~ccCommandLineInterface() = default;
 
    enum class ExportOption {
        NoOptions = 0x0,
        ForceCloud = 0x1,
        ForceMesh = 0x2,
        ForceHierarchy = 0x4,
        ForceNoTimestamp = 0x8
    };
    Q_DECLARE_FLAGS(ExportOptions, ExportOption)
 
public:  // commands
    struct CVPLUGIN_LIB_API Command {
        using Shared = QSharedPointer<Command>;
 
        Command(const QString& name, const QString& keyword);
 
        virtual ~Command() = default;
 
        virtual bool process(ccCommandLineInterface& cmd) = 0;
 
        QString m_name;
        QString m_keyword;
    };
 
    static bool IsCommand(const QString& token, const char* command);
 
public:  // virtual methods
 
    virtual bool registerCommand(Command::Shared command) = 0;
 
    virtual QString getExportFilename(const CLEntityDesc& entityDesc,
                                      QString extension = QString(),
                                      QString suffix = QString(),
                                      QString* baseOutputFilename = nullptr,
                                      bool forceNoTimestamp = false) const = 0;
 
 
    virtual QString exportEntity(CLEntityDesc& entityDesc,
                                 const QString& suffix = QString(),
                                 QString* outputFilename = nullptr,
                                 ccCommandLineInterface::ExportOptions options =
                                         ExportOption::NoOptions) = 0;
 
 
    virtual bool saveClouds(QString suffix = QString(),
                            bool allAtOnce = false,
                            const QString* allAtOnceFileName = nullptr) = 0;
 
 
    virtual bool saveMeshes(QString suffix = QString(),
                            bool allAtOnce = false,
                            const QString* allAtOnceFileName = nullptr) = 0;
 
    virtual void removeClouds(bool onlyLast = false) = 0;
 
    virtual void removeMeshes(bool onlyLast = false) = 0;
 
    virtual QStringList& arguments() = 0;
    virtual const QStringList& arguments() const = 0;
 
    virtual ecvProgressDialog* progressDialog();
    virtual QDialog* widgetParent();
 
public:  // file I/O
    // Extended file loading parameters
    struct CVPLUGIN_LIB_API CLLoadParameters
        : public FileIOFilter::LoadParameters {
        CLLoadParameters();
 
        bool m_coordinatesShiftEnabled;
        CCVector3d m_coordinatesShift;
    };
 
    virtual CLLoadParameters& fileLoadingParams();
 
    struct GlobalShiftOptions {
        enum Mode {
            NO_GLOBAL_SHIFT,
            AUTO_GLOBAL_SHIFT,
            FIRST_GLOBAL_SHIFT,
            CUSTOM_GLOBAL_SHIFT
        };
 
        Mode mode = NO_GLOBAL_SHIFT;
        CCVector3d customGlobalShift;
    };
 
 
    virtual bool importFile(
            QString filename,
            const GlobalShiftOptions& globalShiftOptions,
            FileIOFilter::Shared filter = FileIOFilter::Shared(nullptr)) = 0;
 
    virtual QString cloudExportFormat() const = 0;
    virtual QString cloudExportExt() const = 0;
 
    virtual QString meshExportFormat() const = 0;
    virtual QString meshExportExt() const = 0;
 
    virtual QString hierarchyExportFormat() const = 0;
    virtual QString hierarchyExportExt() const = 0;
 
    virtual void setCloudExportFormat(QString format, QString ext) = 0;
    virtual void setMeshExportFormat(QString format, QString ext) = 0;
    virtual void setHierarchyExportFormat(QString format, QString ext) = 0;
 
public:  // logging
    // logging
    virtual void print(const QString& message) const = 0;
    virtual void warning(const QString& message) const = 0;
    virtual bool error(
            const QString& message) const = 0;  // must always return false!
 
public:  // access to data
    virtual std::vector<CLCloudDesc>& clouds();
    virtual const std::vector<CLCloudDesc>& clouds() const;
 
    virtual std::vector<CLMeshDesc>& meshes();
    virtual const std::vector<CLMeshDesc>& meshes() const;
 
 
    void toggleSilentMode(bool state);
    bool silentMode() const;
 
    void toggleAutoSaveMode(bool state);
    bool autoSaveMode() const;
 
    void toggleAddTimestamp(bool state);
    bool addTimestamp() const;
 
    void setNumericalPrecision(int p);
    int numericalPrecision() const;
 
public:  // Global shift management
    bool nextCommandIsGlobalShift() const;
 
 
    bool processGlobalShiftCommand(GlobalShiftOptions& options);
 
protected:  // members
    std::vector<CLCloudDesc> m_clouds;
 
    std::vector<CLMeshDesc> m_meshes;
 
    bool m_silentMode;
 
    bool m_autoSaveMode;
 
    bool m_addTimestamp;
 
    int m_precision;
 
    CLLoadParameters m_loadingParameters;
};