facetagseditor.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-08-08
 * Description : Faces tags editor allowing easy manipulation of face tags
 *
 * Copyright (C) 2010-2011 by Aditya Bhatt <adityabhatt1991 at gmail dot com>
 * Copyright (C) 2010-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * 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_FACE_TAGS_EDITOR_H
#define DIGIKAM_FACE_TAGS_EDITOR_H
 
// Qt includes
 
#include <QFlags>
#include <QMap>
#include <QList>
#include <QRect>
#include <QString>
#include <QVariant>
 
// Local includes
 
#include "facetagsiface.h"
#include "digikam_export.h"
#include "facetags.h"
 
namespace Digikam
{
 
class ItemTagPair;
class ItemInfo;
 
class DIGIKAM_DATABASE_EXPORT FaceTagsEditor
{
public:
 
    FaceTagsEditor();
    virtual ~FaceTagsEditor();
 
    // --- Read from database -----------------------------------------------------------------------------------------
 
    int                  numberOfFaces(qlonglong imageid)                                       const;
 
    int                  faceCountForPersonInImage(qlonglong imageid, int tagId)                const;
 
    QList<FaceTagsIface> databaseFaces(qlonglong imageid)                                       const;
 
    QList<FaceTagsIface> unconfirmedFaceTagsIfaces(qlonglong imageid)                           const;
 
    QList<FaceTagsIface> unconfirmedNameFaceTagsIfaces(qlonglong imageid)                       const;
 
    QList<FaceTagsIface> databaseFacesForTraining(qlonglong imageid)                            const;
    QList<FaceTagsIface> confirmedFaceTagsIfaces(qlonglong imageid)                             const;
    QList<FaceTagsIface> ignoredFaceTagsIfaces(qlonglong imageid)                               const;
 
    QList<QRect>         getTagRects(qlonglong imageid)                                         const;
 
    // --- Add / Confirm ---
 
    void          add(const FaceTagsIface& face, bool trainFace = true);
    FaceTagsIface add(qlonglong imageid, int tagId, const TagRegion& region, bool trainFace = true);
    FaceTagsIface addManually(const FaceTagsIface& face);
 
    FaceTagsIface changeSuggestedName(const FaceTagsIface& previousEntry, int unconfirmedNameTagId);
 
    QMap<QString, QString> getSuggestedNames(qlonglong id)                                      const;
 
    FaceTagsIface confirmName(const FaceTagsIface& face, int tagId = -1,
                              const TagRegion& confirmedRegion = TagRegion());
 
    static FaceTagsIface confirmedEntry(const FaceTagsIface& face, int tagId = -1,
                                        const TagRegion& confirmedRegion = TagRegion());
 
    static FaceTagsIface unconfirmedEntry(qlonglong imageId, int tagId, const TagRegion& region);
    static FaceTagsIface unknownPersonEntry(qlonglong imageId, const TagRegion& region);
 
    // --- Remove entries ---
 
    void                removeFace(const FaceTagsIface& face, bool touchTags = true);
    void                removeFaces(const QList<FaceTagsIface>& faces);
 
    void                removeAllFaces(qlonglong imageid);
 
    void                removeFace(qlonglong imageid, const QRect& rect);
 
    // --- Edit entry ---
 
    FaceTagsIface        changeRegion(const FaceTagsIface& face, const TagRegion& newRegion);
 
    FaceTagsIface        changeTag(const FaceTagsIface& face, int newTagId, ItemInfo& info);
 
    // --- Utilities ---
 
    QList<FaceTagsIface> databaseFaces(qlonglong imageId, FaceTagsIface::TypeFlags flags)       const;
    QList<ItemTagPair>  faceItemTagPairs(qlonglong imageid, FaceTagsIface::TypeFlags flags)     const;
 
protected:
 
    void addFaceAndTag(ItemTagPair& pair, const FaceTagsIface& face, const QStringList& properties, bool addTag);
    void removeFaceAndTag(ItemTagPair& pair, const FaceTagsIface& face, bool touchTags);
 
    virtual void addNormalTag(qlonglong imageid, int tagId);
    virtual void removeNormalTag(qlonglong imageid, int tagId);
    virtual void removeNormalTags(qlonglong imageid, const QList<int>& tagId);
 
private:
 
    Q_DISABLE_COPY(FaceTagsEditor)
};
 
} // namespace Digikam
 
#endif // DIGIKAM_FACE_TAGS_EDITOR_H