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