FrameOfReference.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/
 
#ifndef FRAMEOFREFERENCE_H
#define FRAMEOFREFERENCE_H
 
// -- Core stuff
#include "CamiTKAPI.h"
#include "InterfacePersistence.h"
#include "AnatomicalOrientation.h"
 
#include <QString>
#include <QUuid>
#include <QColor>
#include <QPair>
 
namespace camitk {
 
class TransformationManager;

using Unit = QString;

class CAMITK_API FrameOfReference: public InterfacePersistence {
 
private:

    friend TransformationManager;

    FrameOfReference();

    explicit FrameOfReference(QString name, QString description = "");

    FrameOfReference(QUuid uuid, QString name, QString description, int numberOfDimensions, const AnatomicalOrientation& ao, std::vector<Unit>& units);

    explicit FrameOfReference(const FrameOfReference&);

    bool resetUuid(QUuid newId);
 
public:
    const AnatomicalOrientation& getAnatomicalOrientation() const;

    AnatomicalOrientation& getAnatomicalOrientation();

    void setAnatomicalOrientation(const AnatomicalOrientation& anatomicalOrientation);

    void setAnatomicalOrientation(QString threeLetterCode);

    int getNumberOfDimensions() const;

    void setNumberOfDimensions(int numberOfDimensions);

    Unit getUnit(int dimension);

    void setUnit(int dimension, Unit u);

    QString getName() const;

    void setName(QString name);

    QString getDescription() const;

    void setDescription(QString desc);

    const QColor& getColor();

    void setColor(const QColor& color);

    QString getAnatomicalOrientationLabel(int axis, bool minDirection) const;

    bool operator==(const FrameOfReference& b) const;

    bool operator!=(const FrameOfReference& b) const;


    QVariant toVariant() const override;

    void fromVariant(const QVariant& variant) override;

    bool setUuid(QUuid newId) override;

    QUuid getUuid() const override;

    int getIndex();
 
 
private:
    AnatomicalOrientation anatomicalOrientation;

    std::vector<Unit> units = {"mm", "mm", "mm", "s", ""};

    int numberOfDimensions = 3;

    QUuid uuid;

    int index;

    QString name;

    QString description;

    QColor color;
 
    // init color and index (only when required, i.e. in getIndex()/getColor() and not during initialization)
    void init();

    static QPair<QColor, int> getNextColorAndIndex();
};
 
// -------------------- getAnatomicalOrientation --------------------
inline const AnatomicalOrientation& FrameOfReference::getAnatomicalOrientation() const {
    return anatomicalOrientation;
};
 
inline AnatomicalOrientation& FrameOfReference::getAnatomicalOrientation() {
    return anatomicalOrientation;
};
 
// -------------------- setAnatomicalOrientation --------------------
inline void FrameOfReference::setAnatomicalOrientation(const AnatomicalOrientation& anatomicalOrientation) {
    this->anatomicalOrientation = anatomicalOrientation;
}
 
// -------------------- setAnatomicalOrientation --------------------
inline void FrameOfReference::setAnatomicalOrientation(QString threeLetterCode) {
    anatomicalOrientation.setOrientation(threeLetterCode);
}
 
// -------------------- getNumberOfDimensions --------------------
inline int FrameOfReference::getNumberOfDimensions() const {
    return numberOfDimensions;
}
 
// -------------------- getName --------------------
inline QString FrameOfReference::getName() const {
    return name;
}
 
// -------------------- setName --------------------
inline void FrameOfReference::setName(QString name) {
    this->name = name;
}
 
// -------------------- getDescription --------------------
inline QString FrameOfReference::getDescription() const {
    return description;
}
 
// -------------------- setDescription --------------------
inline void FrameOfReference::setDescription(QString desc) {
    description = desc;
}
 
// -------------------- getAnatomicalOrientationLabel --------------------
inline QString FrameOfReference::getAnatomicalOrientationLabel(int axis, bool minDirection) const {
    return anatomicalOrientation.getLabel(axis, minDirection);
}
 
// -------------------- operator== --------------------
inline bool FrameOfReference::operator==(const FrameOfReference& b) const {
    return this->getUuid() == b.getUuid();
}
 
// -------------------- operator!= --------------------
inline bool FrameOfReference::operator!=(const FrameOfReference& b) const {
    return this->getUuid() != b.getUuid();
}
 
// -------------------- getUuid --------------------
inline QUuid FrameOfReference::getUuid() const {
    return uuid;
}
 
}
 
#endif // FRAMEOFREFERENCE_H