kicad/pcbnew/zone_manager/zones_container.h

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2023 Ethan Chien <liangtie.qian@gmail.com>
 * Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */


#ifndef ZONES_CONTAINER_H
#define ZONES_CONTAINER_H
#include "board.h"
#include <memory>
#include <unordered_map>
#include <vector>
#include <zone.h>
#include "zone_management_base.h"
#include "zone_settings.h"

class ZONE_PRIORITY_CONTAINER;
class ZONES_CONTAINER : public ZONE_MANAGEMENT_BASE
{
public:
    ZONES_CONTAINER( BOARD* board );
    ~ZONES_CONTAINER() override;

    std::vector<std::shared_ptr<ZONE_PRIORITY_CONTAINER>> GetZonesPriorityContainers() const
    {
        return m_zonesPriorityContainer;
    }

    std::shared_ptr<ZONE_SETTINGS> GetZoneSettings( ZONE* zone );
    /**
     * @brief Adapter for the zone filler ,zones are actually managed the smart ptr
     *
     * @return std::vector<ZONE*>
     */
    std::vector<ZONE*>& GetClonedZoneList() { return m_clonedZoneList; }
    /**
     * @brief Used for restoring the zones in the board after refilling
     * 
     * @return std::vector<ZONE*>& 
     */
    std::vector<ZONE*>& GetOriginalZoneList() { return m_originalZoneList; }
    /**
     * @brief Flush the zone settings change to the cloned ones
     * 
     */
    void FlushZoneSettingsChange();
    /**
     * @brief Flush the priority change to the cloned ones
     * 
     * @return true if priority changed
     */
    bool FlushPriorityChange();

    void OnUserConfirmChange() override;

private:
    std::unordered_map<ZONE*, std::shared_ptr<ZONE>>          m_zonesCloneMap;
    std::unordered_map<ZONE*, std::shared_ptr<ZONE_SETTINGS>> m_zoneSettings;
    std::vector<std::shared_ptr<ZONE_PRIORITY_CONTAINER>>     m_zonesPriorityContainer;
    std::vector<ZONE*>                                        m_clonedZoneList;
    std::vector<ZONE*>                                        m_originalZoneList;
};

#endif