tagregion.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-08-26
 * Description : Tag region formatting
 *
 * Copyright (C) 2010-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2011-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program 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 General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_TAG_REGION_H
#define DIGIKAM_TAG_REGION_H
 
// Qt includes
 
#include <QRect>
#include <QString>
#include <QVariant>
#include <QDebug>
 
// Local includes
 
#include "digikam_export.h"
 
class QDebug;
 
namespace Digikam
{
 
class DImg;
 
class DIGIKAM_EXPORT TagRegion
{
 
public:
 
    enum Type
    {
        Invalid,
        Rect
    };
 
public:
 
    TagRegion();
 
    explicit TagRegion(const QString& descriptor);
 
    explicit TagRegion(const QRect& rect);
 
    Type type()                             const;
    bool isValid()                          const;
 
    bool operator==(const TagRegion& other) const;
 
    bool operator!=(const TagRegion& other) const;
 
    QString toXml()                         const;
 
    QRect toRect()                          const;
 
    QVariant toVariant()                    const;
    static TagRegion fromVariant(const QVariant& var);
 
    bool intersects(const TagRegion& other, double fraction = 0);
 
    static QRect mapToOriginalSize(const QSize& fullImageSize, const QSize& reducedImageSize, const QRect& reducedSizeDetail);
    static QRect mapFromOriginalSize(const QSize& fullImageSize, const QSize& reducedImageSize, const QRect& fullSizeDetail);
 
    static QRect mapToOriginalSize(const DImg& reducedSizeImage, const QRect& reducedSizeDetail);
    static QRect mapFromOriginalSize(const DImg& reducedSizeImage, const QRect& fullSizeDetail);
 
    static QRect relativeToAbsolute(const QRectF& region, const QSize& fullSize);
 
    static QRect relativeToAbsolute(const QRectF& region, const DImg& reducedSizeImage);
 
    static QRectF absoluteToRelative(const QRect& region, const QSize& fullSize);
 
    static QSize adjustToOrientation(QRect& region, int orientation, const QSize& fullSize);
 
    static void reverseToOrientation(QRect& region, int orientation, const QSize& fullSize);
 
protected:
 
    QVariant m_value;
    Type     m_type;
};
 
QDebug DIGIKAM_EXPORT operator<<(QDebug dbg, const TagRegion& r);
 
} // namespace Digikam
 
#endif // DIGIKAM_TAG_REGION_H