Horizon
board.hpp
1 #pragma once
2 #include "block/block.hpp"
3 #include "board_hole.hpp"
4 #include "board_package.hpp"
5 #include "board_rules.hpp"
6 #include "clipper/clipper.hpp"
7 #include "common/dimension.hpp"
8 #include "common/hole.hpp"
9 #include "board_junction.hpp"
10 #include "common/layer_provider.hpp"
11 #include "common/polygon.hpp"
12 #include "common/keepout.hpp"
13 #include "common/pdf_export_settings.hpp"
14 #include "fab_output_settings.hpp"
15 #include "nlohmann/json_fwd.hpp"
16 #include "plane.hpp"
17 #include "track.hpp"
18 #include "util/uuid.hpp"
19 #include "util/warning.hpp"
20 #include "via.hpp"
21 #include "via_padstack_provider.hpp"
22 #include "connection_line.hpp"
23 #include "step_export_settings.hpp"
24 #include "pnp_export_settings.hpp"
25 #include "airwire.hpp"
26 #include "included_board.hpp"
27 #include "board_panel.hpp"
28 #include "common/picture.hpp"
29 #include "board_decal.hpp"
30 #include "util/file_version.hpp"
31 
32 namespace horizon {
33 using json = nlohmann::json;
34 
35 class BoardColors {
36 public:
37  BoardColors();
38  Color solder_mask;
39  Color substrate;
40 };
41 
42 class Board : public ObjectProvider, public LayerProvider {
43 private:
44  // unsigned int update_nets();
45  void propagate_nets();
46  std::map<int, Layer> layers;
47 
48  void delete_dependants();
49  void vacuum_junctions();
50 
51 public:
52  Board(const UUID &uu, const json &, Block &block, IPool &pool, ViaPadstackProvider &vpp);
53  static Board new_from_file(const std::string &filename, Block &block, IPool &pool, ViaPadstackProvider &vpp);
54  Board(const UUID &uu, Block &block);
55  static unsigned int get_app_version();
56 
57  void expand();
58  void expand_some();
59 
60  Board(const Board &brd);
61  Board(shallow_copy_t sh, const Board &brd);
62  void operator=(const Board &brd) = delete;
63  void update_refs();
64  void update_junction_connections();
65  void update_airwires(bool fast, const std::set<UUID> &nets);
66  void disconnect_package(BoardPackage *pkg);
67 
68  void smash_package(BoardPackage *pkg);
69  void copy_package_silkscreen_texts(BoardPackage *dest, const BoardPackage *src);
70  void unsmash_package(BoardPackage *pkg);
71  void smash_package_silkscreen_graphics(BoardPackage *pkg);
72  void smash_package_outline(BoardPackage &pkg);
73  void smash_panel_outline(BoardPanel &panel);
74 
75  Junction *get_junction(const UUID &uu) override;
76  Polygon *get_polygon(const UUID &uu) override;
77  const std::map<int, Layer> &get_layers() const override;
78  void set_n_inner_layers(unsigned int n);
79  unsigned int get_n_inner_layers() const;
80  void update_plane(Plane *plane, const class CanvasPatch *ca = nullptr,
81  const class CanvasPads *ca_pads = nullptr); // when ca is given, patches will be read from it
82  void update_planes();
83  std::vector<KeepoutContour> get_keepout_contours() const;
84  std::pair<Coordi, Coordi> get_bbox() const;
85  void update_pdf_export_settings(PDFExportSettings &settings);
86  std::map<const BoardPackage *, PnPRow> get_PnP(const PnPExportSettings &settings) const;
87 
88 
89  UUID uuid;
90  Block *block;
91  std::string name;
92  std::map<UUID, Polygon> polygons;
93  std::map<UUID, BoardHole> holes;
94  std::map<UUID, BoardPackage> packages;
95  std::map<UUID, BoardJunction> junctions;
96  std::map<UUID, Track> tracks;
97  std::map<UUID, Via> vias;
98  std::map<UUID, Text> texts;
99  std::map<UUID, Line> lines;
100  std::map<UUID, Arc> arcs;
101  std::map<UUID, Plane> planes;
102  std::map<UUID, Keepout> keepouts;
103  std::map<UUID, Dimension> dimensions;
104  std::map<UUID, ConnectionLine> connection_lines;
105  std::map<UUID, IncludedBoard> included_boards;
106  std::map<UUID, BoardPanel> board_panels;
107  std::map<UUID, Picture> pictures;
108  std::map<UUID, BoardDecal> decals;
109 
110  std::vector<Warning> warnings;
111 
112  BoardRules rules;
113  FabOutputSettings fab_output_settings;
114 
115  std::map<UUID, std::list<Airwire>> airwires;
116 
117  class StackupLayer {
118  public:
119  StackupLayer(int l, const json &j);
120  StackupLayer(int l);
121  json serialize() const;
122  int layer;
123  uint64_t thickness = 0.035_mm;
124  uint64_t substrate_thickness = .1_mm;
125  };
126  std::map<int, StackupLayer> stackup;
127 
128  BoardColors colors;
129  PDFExportSettings pdf_export_settings;
130  STEPExportSettings step_export_settings;
131  PnPExportSettings pnp_export_settings;
132 
133  FileVersion version;
134 
135  enum ExpandFlags {
136  EXPAND_NONE = 0,
137  EXPAND_ALL = 0xff,
138  EXPAND_PROPAGATE_NETS = (1 << 0),
139  EXPAND_AIRWIRES = (1 << 1),
140  EXPAND_PACKAGES = (1 << 2),
141  EXPAND_VIAS = (1 << 3),
142  EXPAND_ALL_AIRWIRES = (1 << 4),
143  };
144 
145  ExpandFlags expand_flags = EXPAND_ALL;
146  std::set<UUID> airwires_expand;
147 
148  json serialize() const;
149  void save_pictures(const std::string &dir) const;
150  void load_pictures(const std::string &dir);
151 
152  ItemSet get_pool_items_used() const;
153 
154  void flip_package_layer(int &layer) const;
155  int get_package_layer(bool flip, int layer) const;
156  ParameterSet get_parameters() const;
157 
158 private:
159  unsigned int n_inner_layers = 0;
160  ClipperLib::Paths get_thermals(class Plane *plane, const class CanvasPads *ca) const;
161  void update_all_airwires();
162  void update_airwire(bool fast, const UUID &net);
163 
164  Board(const Board &brd, CopyMode copy_mode);
165  void expand_packages();
166 };
167 
168 inline Board::ExpandFlags operator|(Board::ExpandFlags a, Board::ExpandFlags b)
169 {
170  return static_cast<Board::ExpandFlags>(static_cast<int>(a) | static_cast<int>(b));
171 }
172 
173 inline Board::ExpandFlags operator|=(Board::ExpandFlags &a, Board::ExpandFlags b)
174 {
175  return a = (a | b);
176 }
177 
178 
179 } // namespace horizon
A block is one level of hierarchy in the netlist.
Definition: block.hpp:26
Definition: board.hpp:35
Definition: board_package.hpp:15
Definition: board_panel.hpp:7
Definition: board_rules.hpp:22
Definition: board.hpp:117
Definition: board.hpp:42
Definition: canvas_pads.hpp:7
Definition: canvas_patch.hpp:6
Definition: common.hpp:234
Definition: fab_output_settings.hpp:10
Definition: file_version.hpp:8
Definition: ipool.hpp:12
A Junction is a point in 2D-Space.
Definition: junction.hpp:20
Definition: layer_provider.hpp:7
Interface for classes that store objects identified by UUID (e.g. Line or Junction)
Definition: object_provider.hpp:10
Definition: pdf_export_settings.hpp:9
Definition: plane.hpp:39
Definition: pnp_export_settings.hpp:11
Polygon used in Padstack, Package and Board for specifying filled Regions.
Definition: polygon.hpp:27
Definition: step_export_settings.hpp:10
This class encapsulates a UUID and allows it to be uses as a value type.
Definition: uuid.hpp:16
Definition: via_padstack_provider.hpp:13
a class to store JSON values
Definition: json.hpp:166
zip_uint64_t uint64_t
zip_uint64_t_t typedef.
Definition: zip.hpp:108
basic_json<> json
default JSON class
Definition: json_fwd.hpp:61
Definition: common.hpp:284