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 "common/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 
56  void expand(bool careful = false);
57  void expand_packages();
58  void expand_decals();
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_airwires(bool fast = false, const std::set<UUID> &nets = {});
65  void disconnect_package(BoardPackage *pkg);
66 
67  void smash_package(BoardPackage *pkg);
68  void copy_package_silkscreen_texts(BoardPackage *dest, const BoardPackage *src);
69  void unsmash_package(BoardPackage *pkg);
70  void smash_package_silkscreen_graphics(BoardPackage *pkg);
71  void smash_package_outline(BoardPackage &pkg);
72  void smash_panel_outline(BoardPanel &panel);
73 
74  Junction *get_junction(const UUID &uu) override;
75  Polygon *get_polygon(const UUID &uu) override;
76  const std::map<int, Layer> &get_layers() const override;
77  void set_n_inner_layers(unsigned int n);
78  unsigned int get_n_inner_layers() const;
79  void update_plane(Plane *plane, const class CanvasPatch *ca = nullptr,
80  const class CanvasPads *ca_pads = nullptr); // when ca is given, patches will be read from it
81  void update_planes();
82  std::vector<KeepoutContour> get_keepout_contours() const;
83  std::pair<Coordi, Coordi> get_bbox() const;
84  void update_pdf_export_settings(PDFExportSettings &settings);
85  std::map<const BoardPackage *, PnPRow> get_PnP(const PnPExportSettings &settings) const;
86 
87 
88  UUID uuid;
89  Block *block;
90  std::string name;
91  std::map<UUID, Polygon> polygons;
92  std::map<UUID, BoardHole> holes;
93  std::map<UUID, BoardPackage> packages;
94  std::map<UUID, Junction> junctions;
95  std::map<UUID, Track> tracks;
96  std::map<UUID, Via> vias;
97  std::map<UUID, Text> texts;
98  std::map<UUID, Line> lines;
99  std::map<UUID, Arc> arcs;
100  std::map<UUID, Plane> planes;
101  std::map<UUID, Keepout> keepouts;
102  std::map<UUID, Dimension> dimensions;
103  std::map<UUID, ConnectionLine> connection_lines;
104  std::map<UUID, IncludedBoard> included_boards;
105  std::map<UUID, BoardPanel> board_panels;
106  std::map<UUID, Picture> pictures;
107  std::map<UUID, BoardDecal> decals;
108 
109  std::vector<Warning> warnings;
110 
111  BoardRules rules;
112  FabOutputSettings fab_output_settings;
113 
114  std::map<UUID, std::list<Airwire>> airwires;
115 
116  class StackupLayer {
117  public:
118  StackupLayer(int l, const json &j);
119  StackupLayer(int l);
120  json serialize() const;
121  int layer;
122  uint64_t thickness = 0.035_mm;
123  uint64_t substrate_thickness = .1_mm;
124  };
125  std::map<int, StackupLayer> stackup;
126 
127  BoardColors colors;
128  PDFExportSettings pdf_export_settings;
129  STEPExportSettings step_export_settings;
130  PnPExportSettings pnp_export_settings;
131 
132  FileVersion version;
133 
134  enum ExpandFlags {
135  EXPAND_ALL = 0xff,
136  EXPAND_PROPAGATE_NETS = (1 << 0),
137  EXPAND_AIRWIRES = (1 << 1),
138  EXPAND_PACKAGES = (1 << 2)
139  };
140 
141  ExpandFlags expand_flags = EXPAND_ALL;
142  std::set<UUID> packages_expand;
143  std::set<UUID> airwires_expand;
144 
145  json serialize() const;
146  void save_pictures(const std::string &dir) const;
147  void load_pictures(const std::string &dir);
148 
149 private:
150  unsigned int n_inner_layers = 0;
151  ClipperLib::Paths get_thermals(class Plane *plane, const class CanvasPads *ca) const;
152  void flip_package_layer(int &layer) const;
153  Board(const Board &brd, CopyMode copy_mode);
154 };
155 } // namespace horizon
horizon::CanvasPads
Definition: canvas_pads.hpp:7
horizon::Polygon
Polygon used in Padstack, Package and Board for specifying filled Regions.
Definition: polygon.hpp:27
horizon::BoardPanel
Definition: board_panel.hpp:7
horizon::BoardColors
Definition: board.hpp:35
horizon::BoardRules
Definition: board_rules.hpp:22
horizon::CanvasPatch
Definition: canvas_patch.hpp:6
horizon::Board
Definition: board.hpp:42
horizon::shallow_copy_t
Definition: common.hpp:270
horizon::ViaPadstackProvider
Definition: via_padstack_provider.hpp:13
horizon::Color
Definition: common.hpp:220
horizon::FileVersion
Definition: file_version.hpp:8
horizon::Block
A block is one level of hierarchy in the netlist.
Definition: block.hpp:25
horizon::LayerProvider
Definition: layer_provider.hpp:7
horizon::BoardPackage
Definition: board_package.hpp:15
horizon::Board::StackupLayer
Definition: board.hpp:116
horizon::STEPExportSettings
Definition: step_export_settings.hpp:10
horizon::IPool
Definition: ipool.hpp:12
horizon::FabOutputSettings
Definition: fab_output_settings.hpp:10
horizon::Junction
A Junction is a point in 2D-Space.
Definition: junction.hpp:22
nlohmann::basic_json
a class to store JSON values
Definition: json.hpp:166
horizon::UUID
This class encapsulates a UUID and allows it to be uses as a value type.
Definition: uuid.hpp:16
nlohmann::json
basic_json<> json
default JSON class
Definition: json_fwd.hpp:61
horizon::PnPExportSettings
Definition: pnp_export_settings.hpp:11
horizon::ObjectProvider
Interface for classes that store objects identified by UUID (e.g. Line or Junction)
Definition: object_provider.hpp:10
horizon::Plane
Definition: plane.hpp:39
horizon::PDFExportSettings
Definition: pdf_export_settings.hpp:9
libzip::uint64_t
zip_uint64_t uint64_t
zip_uint64_t_t typedef.
Definition: zip.hpp:108