1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
|
#ifndef CC_COMMAND_LINE_INTERFACE_HEADER
#define CC_COMMAND_LINE_INTERFACE_HEADER
//qCC_db
#include <ccGenericMesh.h>
#include <ccPointCloud.h>
//qCC_io
#include <FileIOFilter.h>
//Qt
#include <QDir>
#include <QSharedPointer>
#include <QString>
#include <QStringList>
//System
#include <vector>
class ccProgressDialog;
class QDialog;
//! Loaded entity description
struct CLEntityDesc
{
QString basename;
QString path;
int indexInFile;
CLEntityDesc( const QString &name )
: basename( name )
, path( QDir::currentPath() )
, indexInFile( -1 )
{
}
CLEntityDesc(const QString &filename, int _indexInFile)
: indexInFile(_indexInFile)
{
if (filename.isNull())
{
basename = "unknown";
path = QDir::currentPath();
}
else
{
QFileInfo fi(filename);
basename = fi.completeBaseName();
path = fi.path();
}
}
CLEntityDesc(const QString &_basename, const QString &_path, int _indexInFile = -1)
: basename(_basename)
, path(_path)
, indexInFile(_indexInFile)
{
}
virtual ~CLEntityDesc() = default;
virtual ccHObject* getEntity() = 0;
virtual const ccHObject* getEntity() const = 0;
};
//! Loaded group description
struct CLGroupDesc : CLEntityDesc
{
ccHObject* groupEntity;
CLGroupDesc(ccHObject* group,
const QString& basename,
const QString& path = QString())
: CLEntityDesc(basename, path)
, groupEntity(group)
{}
~CLGroupDesc() override = default;
ccHObject* getEntity() override { return groupEntity; }
const ccHObject* getEntity() const override { return groupEntity; }
};
//! Loaded cloud description
struct CLCloudDesc : CLEntityDesc
{
ccPointCloud* pc;
CLCloudDesc()
: CLEntityDesc("Unnamed cloud")
, pc( nullptr )
{}
CLCloudDesc(ccPointCloud* cloud,
const QString& filename = QString(),
int index = -1)
: CLEntityDesc(filename, index)
, pc(cloud)
{}
CLCloudDesc(ccPointCloud* cloud,
const QString& basename,
const QString& path,
int index = -1)
: CLEntityDesc(basename, path, index)
, pc(cloud)
{}
~CLCloudDesc() override = default;
ccHObject* getEntity() override { return static_cast<ccHObject*>(pc); }
const ccHObject* getEntity() const override { return static_cast<ccHObject*>(pc); }
};
//! Loaded mesh description
struct CLMeshDesc : CLEntityDesc
{
ccGenericMesh* mesh;
CLMeshDesc()
: CLEntityDesc("Unnamed mesh")
, mesh( nullptr )
{}
CLMeshDesc( ccGenericMesh* _mesh,
const QString& filename = QString(),
int index = -1)
: CLEntityDesc(filename, index)
, mesh(_mesh)
{}
CLMeshDesc( ccGenericMesh* _mesh,
const QString& basename,
const QString& path,
int index = -1)
: CLEntityDesc(basename, path, index)
, mesh(_mesh)
{}
~CLMeshDesc() override = default;
ccHObject* getEntity() override { return static_cast<ccHObject*>(mesh); }
const ccHObject* getEntity() const override { return static_cast<ccHObject*>(mesh); }
};
//! Command line interface
class ccCommandLineInterface
{
public: //constructor
//! Default constructor
ccCommandLineInterface()
: m_silentMode(false)
, m_autoSaveMode(true)
, m_addTimestamp(true)
, m_precision(12)
{}
virtual ~ccCommandLineInterface() = default;
public: //commands
//! Generic command interface
struct Command
{
//! Shared type
using Shared = QSharedPointer<Command>;
//! Default constructor
Command(const QString& name, const QString& keyword)
: m_name(name)
, m_keyword(keyword)
{}
virtual ~Command() = default;
//! Main process
virtual bool process(ccCommandLineInterface& cmd) = 0;
//! Command name
QString m_name;
//! Command keyword
QString m_keyword;
};
//! Test whether a command line token is a valid command keyword or not
static bool IsCommand(const QString& token, const char* command)
{
return token.startsWith("-") && token.mid(1).toUpper() == QString(command);
}
public: //virtual methods
//! Registers a new command
/** \return success
**/
virtual bool registerCommand(Command::Shared command) = 0;
//! Returns the name of a to-be-exported entity
virtual QString getExportFilename( const CLEntityDesc& entityDesc,
QString extension = QString(),
QString suffix = QString(),
QString* baseOutputFilename = nullptr,
bool forceNoTimestamp = false) const = 0;
//! Exports a cloud or a mesh
/** \return error string (if any)
**/
virtual QString exportEntity( CLEntityDesc& entityDesc,
QString suffix = QString(),
QString* outputFilename = nullptr,
bool forceIsCloud = false,
bool forceNoTimestamp = false) = 0;
//! Saves all clouds
/** \param suffix optional suffix
\param allAtOnce whether to save all clouds in the same file or one cloud per file
\return success
**/
virtual bool saveClouds(QString suffix = QString(), bool allAtOnce = false, const QString* allAtOnceFileName = nullptr) = 0;
//! Saves all meshes
/** \param suffix optional suffix
\param allAtOnce whether to save all meshes in the same file or one mesh per file
\return success
**/
virtual bool saveMeshes(QString suffix = QString(), bool allAtOnce = false, const QString* allAtOnceFileName = nullptr) = 0;
//! Removes all clouds (or only the last one ;)
virtual void removeClouds(bool onlyLast = false) = 0;
//! Removes all meshes (or only the last one ;)
virtual void removeMeshes(bool onlyLast = false) = 0;
//! Returns the list of arguments
virtual QStringList& arguments() = 0;
//! Returns the list of arguments (const version)
virtual const QStringList& arguments() const = 0;
//! Returns a (shared) progress dialog (if any is available)
virtual ccProgressDialog* progressDialog() { return nullptr; }
//! Returns a (widget) parent (if any is available)
virtual QDialog* widgetParent() { return nullptr; }
public: //file I/O
//Extended file loading parameters
struct CLLoadParameters : public FileIOFilter::LoadParameters
{
CLLoadParameters()
: FileIOFilter::LoadParameters()
, m_coordinatesShiftEnabled(false)
, m_coordinatesShift(0, 0, 0)
{
shiftHandlingMode = ccGlobalShiftManager::NO_DIALOG;
alwaysDisplayLoadDialog = false;
autoComputeNormals = false;
coordinatesShiftEnabled = &m_coordinatesShiftEnabled;
coordinatesShift = &m_coordinatesShift;
}
bool m_coordinatesShiftEnabled;
CCVector3d m_coordinatesShift;
};
//! File loading parameters
virtual CLLoadParameters& fileLoadingParams() { return m_loadingParameters; }
//! Loads a file with a specific filter
/** Automatically dispatches the entities between the clouds and meshes sets.
**/
virtual bool importFile(QString filename, FileIOFilter::Shared filter = FileIOFilter::Shared(nullptr)) = 0;
//! Returns the current cloud(s) export format
virtual QString cloudExportFormat() const = 0;
//! Returns the current cloud(s) export extension (warning: can be anything)
virtual QString cloudExportExt() const = 0;
//! Returns the current mesh(es) export format
virtual QString meshExportFormat() const = 0;
//! Returs the current mesh(es) export extension (warning: can be anything)
virtual QString meshExportExt() const = 0;
//! Sets the current cloud(s) export format and extension
virtual void setCloudExportFormat(QString format, QString ext) = 0;
//! Sets the current mesh(es) export format and extension
virtual void setMeshExportFormat(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
//! Currently opened point clouds and their filename
virtual std::vector< CLCloudDesc >& clouds() { return m_clouds; }
//! Currently opened point clouds and their filename (const version)
virtual const std::vector< CLCloudDesc >& clouds() const { return m_clouds; }
//! Currently opened meshes and their filename
virtual std::vector< CLMeshDesc >& meshes() { return m_meshes; }
//! Currently opened meshes and their filename (const version)
virtual const std::vector< CLMeshDesc >& meshes() const { return m_meshes; }
//! Toggles silent mode
/** Must be called BEFORE calling start.
**/
void toggleSilentMode(bool state) { m_silentMode = state; }
//! Returns the silent mode
bool silentMode() const { return m_silentMode; }
//! Sets whether files should be automatically saved (after each process) or not
void toggleAutoSaveMode(bool state) { m_autoSaveMode = state; }
//! Returns whether files should be automatically saved (after each process) or not
bool autoSaveMode() const { return m_autoSaveMode; }
//! Sets whether a timestamp should be automatically added to output files or not
void toggleAddTimestamp(bool state) { m_addTimestamp = state; }
//! Returns whether a timestamp should be automatically added to output files or not
bool addTimestamp() const { return m_addTimestamp; }
//! Sets the numerical precision
void setNumericalPrecision(int p) { m_precision = p; }
//! Returns the numerical precision
int numericalPrecision() const { return m_precision; }
protected: //members
//! Currently opened point clouds and their filename
std::vector< CLCloudDesc > m_clouds;
//! Currently opened meshes and their filename
std::vector< CLMeshDesc > m_meshes;
//! Silent mode
bool m_silentMode;
//! Whether files should be automatically saved (after each process) or not
bool m_autoSaveMode;
//! Whether a timestamp should be automatically added to output files or not
bool m_addTimestamp;
//! Default numerical precision for ASCII output
int m_precision;
//! File loading parameters
CLLoadParameters m_loadingParameters;
};
#endif //CC_COMMAND_LINE_INTERFACE_HEADER
|