DistanceSortProxyModel.h

/***************************************************************************
 *   Copyright (C) 2026 by Stefan Kebekus                                  *
 *   stefan.kebekus@gmail.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 3 of the License, 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.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QGeoCoordinate>
 
#include "ui/NameFilterProxyModel.h"
 
namespace Ui {

 
class DistanceSortProxyModel : public NameFilterProxyModel
{
    Q_OBJECT
    QML_ELEMENT
 
public:
    explicit DistanceSortProxyModel(QObject* parent = nullptr);
 
    // Default destructor
    ~DistanceSortProxyModel() override = default;
 
 
    //
    // Properties
    //

    Q_PROPERTY(QGeoCoordinate referenceCoordinate READ referenceCoordinate WRITE setReferenceCoordinate NOTIFY referenceCoordinateChanged)
 
    
    Q_PROPERTY(QString coordinateRoleName READ coordinateRoleName WRITE setCoordinateRoleName NOTIFY coordinateRoleNameChanged)

    Q_PROPERTY(double resortDistance READ resortDistance WRITE setResortDistance NOTIFY resortDistanceChanged)
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] QGeoCoordinate referenceCoordinate() const { return m_referenceCoordinate; }

    [[nodiscard]] QString coordinateRoleName() const { return m_coordinateRoleName; }

    [[nodiscard]] double resortDistance() const { return m_resortDistance; }
 
 
    //
    // Setter Methods
    //

    void setReferenceCoordinate(const QGeoCoordinate& newReferenceCoordinate);

    void setCoordinateRoleName(const QString& newCoordinateRoleName);

    void setResortDistance(double newResortDistance);
 
 
    //
    // Methods
    //

    void setSourceModel(QAbstractItemModel* newSourceModel) override;
 
signals:
    void referenceCoordinateChanged();

    void coordinateRoleNameChanged();

    void resortDistanceChanged();
 
protected:
    [[nodiscard]] bool lessThan(const QModelIndex& sourceLeft, const QModelIndex& sourceRight) const override;
 
private:
    Q_DISABLE_COPY_MOVE(DistanceSortProxyModel)
 
    // Distance from the reference coordinate to the coordinate of a source
    // row. Infinite if the row has no valid coordinate.
    [[nodiscard]] double distance(const QModelIndex& sourceIndex) const;
 
    QGeoCoordinate m_referenceCoordinate;
 
    // Reference coordinate that the current order is based on
    QGeoCoordinate m_sortReference;
 
    QString m_coordinateRoleName {QStringLiteral("center")};
 
    // Role matching m_coordinateRoleName in the current source model, or -1
    int m_coordinateRole {-1};
 
    double m_resortDistance {1000.0};
};
 
} // namespace Ui