o3de/Gems/EMotionFX/Code/Source/Editor/SelectionProxyModel.h

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */

#pragma once

#if !defined(Q_MOC_RUN)
#include <QtCore/QItemSelectionModel>
#include <AzCore/std/containers/vector.h>
#endif

QT_FORWARD_DECLARE_CLASS(QAbstractProxyModel)

namespace EMotionFX
{
    // This class is a QItemSelectionModel that syncs through proxy models and maintains
    // selection. In Qt we can have a model being filtered/sorted by proxy models. If the
    // selection model is connected to the original model, the view needs a new selection
    // model that understands the filtering. This class does that conversion.
    // NOTE: this class does not support changing proxy models (anywhere in the chain). 
    // The class will have to be recreated with the new proxy model.
    //
    class SelectionProxyModel
        : public QItemSelectionModel
    {
        Q_OBJECT // AUTOMOC

    public:
        SelectionProxyModel(QItemSelectionModel* sourceSelectionModel, QAbstractProxyModel* proxyModel, QObject* parent = nullptr);

        void setCurrentIndex(const QModelIndex &index, QItemSelectionModel::SelectionFlags command) override;
        void select(const QModelIndex &index, QItemSelectionModel::SelectionFlags command) override;
        void select(const QItemSelection &selection, QItemSelectionModel::SelectionFlags command) override;
        void clear() override;
        void reset() override;
        void clearCurrentIndex() override;

    private slots:
        void OnSourceSelectionChanged(const QItemSelection& selected, const QItemSelection& deselected);
        void OnSourceSelectionCurrentChanged(const QModelIndex& current, const QModelIndex& previous);
        void OnProxySelectionChanged(const QItemSelection& selected, const QItemSelection& deselected);
        void OnProxyModelRowsInserted(const QModelIndex& parent, int first, int last);
        
    private:
        QModelIndex mapFromSource(const QModelIndex& sourceIndex);
        QItemSelection mapFromSource(const QItemSelection& sourceSelection);

        QModelIndex mapToSource(const QModelIndex& targetIndex);
        QItemSelection mapToSource(const QItemSelection& targetSelection);

        // Contains the chain of proxy models that leads us to the real model. The outer-most proxy model
        // comes first and is followed by inner proxy models.
        AZStd::vector<QAbstractProxyModel*> m_proxyModels;
        QItemSelectionModel* m_sourceSelectionModel;
    };
} // namespace EMotionFX