ecvObject.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
 
// LOCAL
#include "CVTypes.h"
#include "CV_db.h"
#include "ecvColorTypes.h"
#include "ecvSerializableObject.h"
 
// QT
#include <QSharedPointer>
#include <QVariant>
 
class CV_DB_LIB_API ccUniqueIDGenerator {
public:
    static constexpr unsigned InvalidUniqueID = 0xFFFFFFFF;
    static constexpr unsigned MinUniqueID = 0x00000100;
 
    using Shared = QSharedPointer<ccUniqueIDGenerator>;
 
    ccUniqueIDGenerator() : m_lastUniqueID(MinUniqueID) {}
 
    void reset() { m_lastUniqueID = MinUniqueID; }
    unsigned fetchOne() { return ++m_lastUniqueID; }
    unsigned getLast() const { return m_lastUniqueID; }
    void update(unsigned ID) {
        if (ID > m_lastUniqueID) m_lastUniqueID = ID;
    }
 
protected:
    unsigned m_lastUniqueID;
};
 
class CV_DB_LIB_API ccObject : public ccSerializableObject {
public:
 
    ccObject(QString name = QString());
 
    ccObject(const ccObject& object);
 
    static unsigned GetCurrentDBVersion();
    static void SetUniqueIDGenerator(ccUniqueIDGenerator::Shared generator);
    static ccUniqueIDGenerator::Shared GetUniqueIDGenerator();
 
    virtual CV_CLASS_ENUM getClassID() const = 0;
 
    virtual inline QString getName() const { return m_name; }
 
    virtual inline void setName(const QString& name) { m_name = name; }
 
    virtual inline void setRemoveFlag(bool removeFlag) {
        m_removeFlag = removeFlag;
    }
 
    virtual inline bool getRemoveFlag() { return m_removeFlag; }
 
    virtual inline unsigned getUniqueID() const { return m_uniqueID; }
 
 
    virtual void setUniqueID(unsigned ID);
 
 
    virtual inline bool isEnabled() const { return getFlagState(CC_ENABLED); }
 
 
    virtual inline void setEnabled(bool state) {
        setFlagState(CC_ENABLED, state);
    }
 
    virtual inline void toggleActivation() { setEnabled(!isEnabled()); }
 
 
    virtual inline bool isLocked() const { return getFlagState(CC_LOCKED); }
 
 
    virtual inline void setLocked(bool state) {
        setFlagState(CC_LOCKED, state);
    }
 
    // shortcuts
    inline bool isLeaf() const { return (getClassID() & CC_LEAF_BIT) != 0; }
    inline bool isCustom() const { return (getClassID() & CC_CUSTOM_BIT) != 0; }
    inline bool isHierarchy() const {
        return (getClassID() & CC_HIERARCH_BIT) != 0;
    }
 
    inline bool isKindOf(CV_CLASS_ENUM type) const {
        return (getClassID() & type) == type;
    }
    inline bool isA(CV_CLASS_ENUM type) const { return (getClassID() == type); }
 
 
    static unsigned GetNextUniqueID();
 
 
    static unsigned GetLastUniqueID();
 
 
    static CV_CLASS_ENUM ReadClassIDFromFile(QFile& in, short dataVersion);
 
 
    QVariant getMetaData(const QString& key) const;
 
 
    bool removeMetaData(const QString& key);
 
 
    void setMetaData(const QString& key, const QVariant& data);
 
 
    void setMetaData(const QVariantMap& dataset, bool overwrite = false);
 
 
    bool hasMetaData(const QString& key) const;
 
    const QVariantMap& metaData() const { return m_metaData; }
 
    inline void setBaseName(const QString& baseName) { m_baseName = baseName; }
    inline QString getBaseName() const { return m_baseName; }
 
    inline void setFullPath(const QString& fullPaht) { m_filePath = fullPaht; }
    inline QString getFullPath() const { return m_filePath; }
 
protected:
    virtual inline bool getFlagState(CV_OBJECT_FLAG flag) const {
        return (m_flags & flag);
    }
 
 
    virtual void setFlagState(CV_OBJECT_FLAG flag, bool state);
 
    // inherited from ccSerializableObject
    bool toFile(QFile& out, short dataVersion) const override;
    short minimumFileVersion() const override;
 
 
    bool fromFile(QFile& in,
                  short dataVersion,
                  int flags,
                  LoadedIDMap& oldToNewIDMap) override;
 
    QString m_name;
 
    QString m_baseName;
    QString m_filePath;
 
    bool m_removeFlag;
 
    unsigned m_flags;
 
    QVariantMap m_metaData;
 
private:
    unsigned m_uniqueID;
};