Horizon
canvas.hpp
1 #pragma once
2 #include "common/common.hpp"
3 #include "common/text.hpp"
4 #include "layer_display.hpp"
5 #include "selectables.hpp"
6 #include "target.hpp"
7 #include "triangle.hpp"
8 #include "object_ref.hpp"
9 #include "fragment_cache.hpp"
10 #include "util/placement.hpp"
11 #include "util/text_data.hpp"
12 #include "color_palette.hpp"
13 #include <array>
14 #include <set>
15 #include <unordered_map>
16 #include <deque>
17 #include <list>
18 #include "picture.hpp"
19 #include "pool/unit.hpp"
20 #include "util/vector_pair.hpp"
21 #include "text_renderer.hpp"
22 
23 namespace horizon {
24 class Canvas {
25  friend Selectables;
26  friend class SelectionFilter;
27  friend class CanvasAnnotation;
28  friend CanvasTextRenderer;
29 
30 public:
31  Canvas();
32  virtual ~Canvas()
33  {
34  }
35  virtual void clear();
36  enum class SymbolMode { SHEET, EDIT, EDIT_PREVIEW };
37  void update(const class Symbol &sym, const Placement &transform = Placement(), SymbolMode mode = SymbolMode::EDIT);
38  void update(const class Sheet &sheet);
39  void update(const class Padstack &padstack, bool edit = true);
40  void update(const class Package &pkg, bool edit = true);
41  enum class PanelMode { INCLUDE, SKIP };
42  void update(const class Board &brd, PanelMode mode = PanelMode::INCLUDE);
43  void update(const class Frame &fr, bool edit = true);
44  void update(const class Decal &dec, bool edit = true);
45  void update(const class BlockSymbol &sym, bool edit = true);
46 
47  ObjectRef add_line(const std::deque<Coordi> &pts, int64_t width, ColorP color, int layer);
48  ObjectRef add_arc(const Coordi &from, const Coordi &to, const Coordi &center, int64_t width, ColorP color,
49  int layer);
50  void remove_obj(const ObjectRef &r);
51  void hide_obj(const ObjectRef &r);
52  void show_obj(const ObjectRef &r);
53  void set_flags(const ObjectRef &r, uint8_t mask_set, uint8_t mask_clear);
54  void set_flags_all(uint8_t mask_set, uint8_t mask_clear);
55 
56  void reset_color2();
57  void set_color2(const ObjectRef &r, uint8_t color);
58 
59  void show_all_obj();
60 
61  virtual void update_markers()
62  {
63  }
64 
65  const LayerDisplay &get_layer_display(int index) const;
66  void set_layer_display(int index, const LayerDisplay &ld);
67  void set_layer_color(int layer, const Color &color);
68 
69  bool layer_is_visible(int layer) const;
70  bool layer_is_visible(LayerRange layer) const;
71 
72  bool show_all_junctions_in_schematic = false;
73  bool show_text_in_tracks = false;
74  bool show_text_in_vias = false;
75 
76  bool add_pad_bbox_targets = false;
77 
78  virtual bool get_flip_view() const
79  {
80  return false;
81  };
82 
83  virtual float get_view_angle() const
84  {
85  return 0;
86  }
87 
88  std::pair<Coordf, Coordf> get_bbox(bool visible_only = true) const;
89 
90  static const int first_overlay_layer = 30000;
91 
92 protected:
93  std::map<int, vector_pair<Triangle, TriangleInfo>> triangles;
94  std::list<CanvasPicture> pictures;
95  void add_triangle(int layer, const Coordf &p0, const Coordf &p1, const Coordf &p2, ColorP co, uint8_t flg = 0,
96  uint8_t color2 = 0);
97 
98  using ObjectRefIdx = std::map<int, std::pair<size_t, size_t>>;
99  std::unordered_map<ObjectRef, ObjectRefIdx> object_refs;
100  void begin_group(int layer);
101  void end_group();
102  std::vector<ObjectRef> object_refs_current;
103  std::vector<ObjectRefIdx *> object_ref_idx;
104  void object_ref_push(const ObjectRef &ref);
105  template <typename... Args> void object_ref_push(Args... args)
106  {
107  object_ref_push(ObjectRef(args...));
108  }
109  void object_ref_pop();
110 
111  void render(const class Symbol &sym, SymbolMode mode = SymbolMode::SHEET, bool smashed = false,
112  ColorP co = ColorP::FROM_LAYER);
113  void render(const class Junction &junc, bool interactive = true, ObjectType mode = ObjectType::INVALID);
114  void render(const class SchematicJunction &junc);
115  void render(const class Line &line, bool interactive = true, ColorP co = ColorP::FROM_LAYER);
116  void render(const class SymbolPin &pin, SymbolMode mode = SymbolMode::EDIT, ColorP co = ColorP::FROM_LAYER);
117  void render(const class Arc &arc, bool interactive = true, ColorP co = ColorP::FROM_LAYER);
118  void render(const class Sheet &sheet);
119  void render(const class SchematicSymbol &sym);
120  void render(const class LineNet &line);
121  void render(const class NetLabel &label);
122  void render(const class BusLabel &label);
123  void render(const class Warning &warn);
124  void render(const class PowerSymbol &sym);
125  void render(const class BusRipper &ripper);
126  void render(const class Text &text, bool interactive = true, ColorP co = ColorP::FROM_LAYER);
127  void render(const class Padstack &padstack, bool interactive = true);
128  void render(const class Polygon &polygon, bool interactive = true, ColorP co = ColorP::FROM_LAYER);
129  void render(const class Shape &shape, bool interactive = true);
130  void render(const class Hole &hole, bool interactive = true);
131  void render(const class Package &package, bool interactive = true, bool smashed = false,
132  bool omit_silkscreen = false, bool omit_outline = false, bool on_panel = false);
133  void render_pad_overlay(const class Pad &pad, bool interactive);
134  void render(const class Pad &pad);
135  enum class OutlineMode { INCLUDE, OMIT };
136  void render(const class Board &brd, bool interactive = true, PanelMode mode = PanelMode::INCLUDE,
137  OutlineMode outline_mode = OutlineMode::INCLUDE);
138  void render(const class BoardPackage &pkg, bool interactive = true);
139  void render(const class BoardHole &hole, bool interactive = true);
140  void render(const class Track &track, bool interactive = true);
141  void render(const class Via &via, bool interactive = true);
142  void render(const class Dimension &dim);
143  void render(const class Frame &frame, bool on_sheet = false);
144  void render(const class ConnectionLine &line);
145  void render(const class BoardPanel &panel);
146  void render(const class Picture &pic, bool interactive = true);
147  void render(const class Decal &decal, bool interactive = true);
148  void render(const class BoardDecal &decal);
149  void render(const class BlockSymbol &sym, bool on_sheet = false);
150  void render(const class BlockSymbolPort &port, bool interactive = true);
151  void render(const class SchematicBlockSymbol &sym);
152  void render(const class SchematicNetTie &tie);
153  void render(const class BoardNetTie &tie, bool interactive = true);
154 
155  bool needs_push = true;
156  virtual void request_push() = 0;
157  virtual void push() = 0;
158 
159  void set_lod_size(float size);
160 
161  void draw_line(const Coord<float> &a, const Coord<float> &b, ColorP color = ColorP::FROM_LAYER, int layer = 10000,
162  bool tr = true, uint64_t width = 0);
163  void draw_cross(const Coord<float> &o, float size, ColorP color = ColorP::FROM_LAYER, int layer = 10000,
164  bool tr = true, uint64_t width = 0);
165  void draw_plus(const Coord<float> &o, float size, ColorP color = ColorP::FROM_LAYER, int layer = 10000,
166  bool tr = true, uint64_t width = 0);
167  void draw_box(const Coord<float> &o, float size, ColorP color = ColorP::FROM_LAYER, int layer = 10000,
168  bool tr = true, uint64_t width = 0);
169  void draw_circle(const Coord<float> &center, float radius, ColorP color = ColorP::FROM_LAYER, int layer = 10000);
170  void draw_arc0(const Coord<float> &center, float radius0, float a0, float a1, ColorP color, int layer,
171  uint64_t width);
172  void draw_arc(const Coordf &from, const Coordf &to, const Coordf &center, ColorP color, int layer, uint64_t width);
173 
174 
175  std::pair<Coordf, Coordf> draw_text(const Coordf &p, float size, const std::string &rtext, int angle,
176  TextOrigin origin, ColorP color, int layer, const TextRenderer::Options &opts);
177 
178  virtual void draw_bitmap_text(const Coordf &p, float scale, const std::string &rtext, int angle, ColorP color,
179  int layer)
180  {
181  }
182 
183  virtual std::pair<Coordf, Coordf> measure_bitmap_text(const std::string &text) const
184  {
185  return {{0, 0}, {0, 0}};
186  }
187 
188  enum class TextBoxMode { FULL, LOWER, UPPER };
189 
190  virtual void draw_bitmap_text_box(const Placement &q, float width, float height, const std::string &s, ColorP color,
191  int layer, TextBoxMode mode)
192  {
193  }
194 
195  void draw_error(const Coordf &center, float scale, const std::string &text, bool tr = true);
196  std::tuple<Coordf, Coordf, Coordi> draw_flag(const Coordf &position, const std::string &txt, int64_t size,
197  Orientation orientation, ColorP color = ColorP::FROM_LAYER);
198  void draw_lock(const Coordf &center, float size, ColorP color = ColorP::FROM_LAYER, int layer = 10000,
199  bool tr = true);
200 
201  virtual bool img_layer_is_visible(int layer) const
202  {
203  return true;
204  }
205  virtual void img_net(const class Net *net)
206  {
207  }
208  virtual void img_polygon(const Polygon &poly, bool tr = true)
209  {
210  }
211  virtual void img_padstack(const Padstack &ps)
212  {
213  }
214  virtual void img_set_padstack(bool v)
215  {
216  }
217  virtual void img_line(const Coordi &p0, const Coordi &p1, const uint64_t width, int layer = 10000, bool tr = true);
218  virtual void img_arc(const Coordi &from, const Coordi &to, const Coordi &center, const uint64_t width, int layer);
219  virtual void img_hole(const Hole &hole)
220  {
221  }
222  virtual void img_text(const Text *text)
223  {
224  }
225  virtual void img_patch_type(PatchType type)
226  {
227  }
228  virtual void img_draw_text(const Coordf &p, float size, const std::string &rtext, int angle, bool flip,
229  TextOrigin origin, int layer = 10000, uint64_t width = 0,
230  TextData::Font font = TextData::Font::SIMPLEX, bool center = false, bool mirror = false)
231  {
232  }
233  bool img_mode = false;
234  bool img_auto_line = false;
235 
236  Placement transform;
237  void transform_save();
238  void transform_restore();
239  std::vector<Placement> transforms;
240 
241  Selectables selectables;
242  std::vector<Target> targets;
243  Target target_current;
244 
245  const class LayerProvider *layer_provider = nullptr;
246  std::map<int, Color> layer_colors;
247  Color get_layer_color(int layer) const;
248  int work_layer = 0;
249  std::map<int, LayerDisplay> layer_display;
250 
251  TriangleInfo::Type triangle_type_current = TriangleInfo::Type::NONE;
252 
253  std::map<std::pair<LayerRange, bool>, int> overlay_layers; // layer, ignore_flip -> overlay layer
254  int overlay_layer_current = first_overlay_layer;
255  int get_overlay_layer(const LayerRange &layer, bool ignore_flip = false);
256  bool is_overlay_layer(int overlay_layer, int layer) const;
257 
258  FragmentCache fragment_cache;
259 
260 private:
261  uint8_t lod_current = 0;
262 
263  int group_layer = 0;
264  vector_pair<Triangle, TriangleInfo> *group_tris = nullptr;
265  size_t group_size = 0;
266 
267  void draw_direction(Pin::Direction dir, ColorP color);
268 
269  CanvasTextRenderer text_renderer;
270 };
271 } // namespace horizon
Graphical arc.
Definition: arc.hpp:17
Definition: block_symbol.hpp:20
Definition: block_symbol.hpp:51
Definition: board_decal.hpp:11
Definition: board_hole.hpp:12
Definition: board_net_tie.hpp:9
Definition: board_package.hpp:13
Definition: board_panel.hpp:7
Definition: board.hpp:47
Makes a Bus available on the schematic.
Definition: bus_label.hpp:16
Make a Bus member's Net available on the schematic.
Definition: bus_ripper.hpp:15
Definition: annotation.hpp:7
Definition: text_renderer.hpp:5
Definition: canvas.hpp:24
Definition: common.hpp:278
Definition: connection_line.hpp:12
Definition: decal.hpp:16
Definition: dimension.hpp:9
Definition: fragment_cache.hpp:7
Definition: frame.hpp:18
A hole with diameter and position, that's it.
Definition: hole.hpp:15
A Junction is a point in 2D-Space.
Definition: junction.hpp:20
Definition: layer_display.hpp:5
Definition: layer_provider.hpp:7
Definition: layer_range.hpp:7
LineNet is similar to Line, except it denotes electrical connection.
Definition: line_net.hpp:17
Graphical line.
Definition: line.hpp:16
Displays the junction's Net name it is attached to.
Definition: net_label.hpp:16
Definition: net.hpp:11
Definition: object_ref.hpp:7
Definition: package.hpp:29
Definition: pad.hpp:12
Definition: padstack.hpp:19
Definition: picture.hpp:10
Definition: placement.hpp:8
Polygon used in Padstack, Package and Board for specifying filled Regions.
Definition: polygon.hpp:25
GND symbols and the like.
Definition: power_symbol.hpp:16
Definition: schematic_block_symbol.hpp:12
Definition: schematic_junction.hpp:6
Definition: schematic_net_tie.hpp:10
Definition: schematic_symbol.hpp:15
Definition: selectables.hpp:67
Definition: selection_filter.hpp:6
For commonly used Pad shapes.
Definition: shape.hpp:15
Definition: sheet.hpp:42
Definition: symbol.hpp:20
Definition: symbol.hpp:72
Definition: target.hpp:7
Used wherever a user-editable text is needed.
Definition: text.hpp:15
Definition: track.hpp:14
Definition: via.hpp:12
Definition: warning.hpp:6
Definition: vector_pair.hpp:8
defer< flip, Fn > flip
Definition: meta.hpp:1089
meta::size_t< L::size()> size
An integral constant wrapper that is the size of the meta::list L.
Definition: meta.hpp:1696
std::integral_constant< decltype(T::type::value - 1), T::type::value - 1 > dec
An integral constant wrapper around the result of decrementing the wrapped integer T::type::value.
Definition: meta.hpp:190
Definition: text_renderer.hpp:10