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