File indexing completed on 2025-01-05 03:56:31

 /* ============================================================
  *
  * This file is a part of digiKam project
  * https://www.digikam.org
  *
  * Date        : 28/08/2021
  * Description : Focus point properties container (relative to original image size)
  *
  * SPDX-FileCopyrightText: 2021-2024 by Gilles Caulier <caulier dot gilles at gmail dot com>
  * SPDX-FileCopyrightText: 2021 by Phuoc Khanh Le <phuockhanhnk94 at gmail dot com>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #ifndef DIGIKAM_FOCUSPOINT_H
 #define DIGIKAM_FOCUSPOINT_H
 
 // Qt includes
 
 #include <QVariant>
 #include <QStringList>
 #include <QRectF>
 #include <QDebug>
 #include <QExplicitlySharedDataPointer>
 
 // Local includes
 
 #include "digikam_export.h"
 #include "metaengine.h"
 
 namespace Digikam
 {
 
 class DIGIKAM_EXPORT FocusPoint
 {
 public:
 
     enum TypePoint
     {
         Inactive        = 0,    ///< The AF-point is not active.
         InFocus         = 1,    ///< The AF-point is in focus.
         Selected        = 2,    ///< The AF-point is selected but not in focus.
         SelectedInFocus = 3     ///< The AF-point is selected and in focus.
     };
 
 public:
 
     /**
      * Focus point container contructors. Position and size are in float and a relative to the original image size.
      * Typically, the area is define as percents of values depending of image size used to extract information from metadata.
      * Like this, focus area can be drawn easily over a resized version of image.
      */
     FocusPoint(float x_position, float y_position, float width, float height, TypePoint type);
     FocusPoint(float x_position, float y_position, float width, float height);
     explicit FocusPoint(const QRectF& rectF);
     FocusPoint(const FocusPoint& other);
     FocusPoint();
     ~FocusPoint();
 
     /**
      * Equivalent to the copy constructor
      */
     FocusPoint& operator=(const FocusPoint& other);
 
     /**
      * Focus point type properties accessor. See TypePoint enum definition for details.
      */
     void      setType(TypePoint type);
     TypePoint getType()                                     const;
     QString   getTypeDescription()                          const;
 
     /**
      * Accessors to relative properties of focus point area.
      */
     void setCenterPosition(float x_position, float y_position);
     void setSize(float width, float height);
     void setRect(const QRectF& rectF);
     QPointF getCenterPosition()                             const;
     QSizeF  getSize()                                       const;
     QRectF  getRect()                                       const;
 
     /**
      * Return the real aera properties in image coordinates depending of the size.
      */
     QRect   getRectBySize(const QSize& size)                const;
 
 private:
 
     class Private;
     QExplicitlySharedDataPointer<Private> d;
 };
 
 /**
  * Boolean Operators over TypePoint type.
  */
 inline FocusPoint::TypePoint operator|(FocusPoint::TypePoint type1, FocusPoint::TypePoint type2)
 {
     return (static_cast<FocusPoint::TypePoint>(static_cast<int>(type1) | static_cast<int>(type2)));
 }
 
 inline FocusPoint::TypePoint operator&(FocusPoint::TypePoint type1, FocusPoint::TypePoint type2)
 {
     return (static_cast<FocusPoint::TypePoint>(static_cast<int>(type1) & static_cast<int>(type2)));
 }
 
 inline FocusPoint::TypePoint& operator|=(FocusPoint::TypePoint& type1, FocusPoint::TypePoint type2)
 {
     return (type1 = type1 | type2);
 }
 
 inline FocusPoint::TypePoint& operator&=(FocusPoint::TypePoint& type1, FocusPoint::TypePoint type2)
 {
     return (type1 = type1 & type2);
 }
 
 //! qDebug() stream operator. Writes property @fp to the debug output in a nicely formatted way.
 DIGIKAM_EXPORT QDebug operator<<(QDebug dbg, const FocusPoint& fp);
 
 } // namespace Digikam
 
 #endif // DIGIKAM_FOCUSPOINT_H