KiCad PCB EDA Suite
Loading...
Searching...
No Matches
zone_settings_bag.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2023 Ethan Chien <[email protected]>
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
19 */
20
21
22#pragma once
23
24#include "board.h"
25#include <memory>
26#include <unordered_map>
27#include <vector>
28#include <zone.h>
29#include <zone_settings.h>
30
31
33{
34public:
35 ZONE_SETTINGS_BAG( BOARD* aBoard );
36 ZONE_SETTINGS_BAG( ZONE* aZone, ZONE_SETTINGS* aSettings );
37
38 ZONE_SETTINGS_BAG() = default;
39
40 std::shared_ptr<ZONE_SETTINGS> GetZoneSettings( ZONE* aZone );
41 unsigned GetZonePriority( ZONE* aZone );
42
43 void SwapPriority( ZONE* aZOne, ZONE* otherZone );
44
50 void SetZonePriority( ZONE* aClone, unsigned aPriority );
51
56 void RemoveZone( ZONE* aOriginalZone );
57
61 void UpdateClonedZones();
62
63 std::vector<ZONE*>& GetClonedZoneList() { return m_clonedZoneList; }
64 std::unordered_map<ZONE*, std::shared_ptr<ZONE>>& GetZonesCloneMap() { return m_zonesCloneMap; }
65
66private:
67 std::unordered_map<ZONE*, std::shared_ptr<ZONE>> m_zonesCloneMap; // original : clone
68 std::unordered_map<ZONE*, std::shared_ptr<ZONE_SETTINGS>> m_zoneSettings; // clone : current settings
69 std::unordered_map<ZONE*, std::pair<unsigned, unsigned>> m_zonePriorities; // clone : initial pri, current pri
70 std::vector<ZONE*> m_clonedZoneList;
71};
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:372
void SetZonePriority(ZONE *aClone, unsigned aPriority)
Update the tracked priority for a cloned zone.
unsigned GetZonePriority(ZONE *aZone)
ZONE_SETTINGS_BAG(BOARD *aBoard)
ZONE_SETTINGS_BAG()=default
std::unordered_map< ZONE *, std::shared_ptr< ZONE > > m_zonesCloneMap
std::unordered_map< ZONE *, std::shared_ptr< ZONE > > & GetZonesCloneMap()
void RemoveZone(ZONE *aOriginalZone)
Remove a zone from the bag (used when marking for deletion)
void UpdateClonedZones()
The cloned list is the working storage.
std::vector< ZONE * > m_clonedZoneList
std::vector< ZONE * > & GetClonedZoneList()
void SwapPriority(ZONE *aZOne, ZONE *otherZone)
std::unordered_map< ZONE *, std::shared_ptr< ZONE_SETTINGS > > m_zoneSettings
std::shared_ptr< ZONE_SETTINGS > GetZoneSettings(ZONE *aZone)
std::unordered_map< ZONE *, std::pair< unsigned, unsigned > > m_zonePriorities
ZONE_SETTINGS handles zones parameters.
Handle a list of polygons defining a copper zone.
Definition zone.h:70
Class ZONE_SETTINGS used to handle zones parameters in dialogs.