KiCad PCB EDA Suite
pcb_painter.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2013 CERN
5  * Copyright (C) 2016 KiCad Developers, see AUTHORS.txt for contributors.
6  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
7  * @author Maciej Suminski <maciej.suminski@cern.ch>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
27 #ifndef __CLASS_PCB_PAINTER_H
28 #define __CLASS_PCB_PAINTER_H
29 
30 #include <painter.h>
31 
32 #include <memory>
33 
34 
35 class EDA_ITEM;
38 
39 class BOARD_ITEM;
40 class BOARD;
41 class VIA;
42 class TRACK;
43 class D_PAD;
44 class DRAWSEGMENT;
45 class MODULE;
46 class ZONE_CONTAINER;
47 class TEXTE_PCB;
48 class TEXTE_MODULE;
49 class DIMENSION;
50 class PCB_TARGET;
51 class MARKER_PCB;
52 
53 namespace KIGFX
54 {
55 class GAL;
56 
62 {
63 public:
64  friend class PCB_PAINTER;
65 
68  {
69  CL_NONE = 0x00,
70 
71  // Object type
72  CL_PADS = 0x01,
73  CL_VIAS = 0x02,
74  CL_TRACKS = 0x04,
75 
76  // Existence
77  CL_NEW = 0x08,
78  CL_EDITED = 0x10,
79  CL_EXISTING = 0x20
80  };
81 
84  {
88  };
89 
91 
93  void ImportLegacyColors( const COLORS_DESIGN_SETTINGS* aSettings ) override;
94 
101  void LoadDisplayOptions( const PCB_DISPLAY_OPTIONS* aOptions, bool aShowPageLimits );
102 
104  virtual const COLOR4D& GetColor( const VIEW_ITEM* aItem, int aLayer ) const override;
105 
113  inline void SetSketchMode( int aItemLayer, bool aEnabled )
114  {
115  m_sketchMode[aItemLayer] = aEnabled;
116  }
117 
123  inline bool GetSketchMode( int aItemLayer ) const
124  {
125  return m_sketchMode[aItemLayer];
126  }
127 
133  inline void SetSketchModeGraphicItems( bool aEnabled )
134  {
135  m_sketchBoardGfx = aEnabled;
136  }
137 
141  void EnableZoneOutlines( bool aEnabled )
142  {
143  m_zoneOutlines = aEnabled;
144  }
145 
146  inline bool IsBackgroundDark() const override
147  {
149 
150  return luma < 0.5;
151  }
152 
154 
155  void SetBackgroundColor( const COLOR4D& aColor ) override
156  {
158  }
159 
160  const COLOR4D& GetGridColor() override { return m_layerColors[ LAYER_GRID ]; }
161 
162  const COLOR4D& GetCursorColor() override { return m_layerColors[ LAYER_CURSOR ]; }
163 
164  inline bool GetCurvedRatsnestLinesEnabled() const
165  {
166  return m_curvedRatsnestlines;
167  }
168 
169  inline bool GetGlobalRatsnestLinesEnabled() const
170  {
171  return m_globalRatsnestlines;
172  }
173 
174 protected:
177 
180 
183 
186 
189 
192 
195 
198 
201 
204 
207 
209  static const double MAX_FONT_SIZE;
210 
213 
216 
219 };
220 
221 
226 class PCB_PAINTER : public PAINTER
227 {
228 public:
229  PCB_PAINTER( GAL* aGal );
230 
232  virtual void ApplySettings( const RENDER_SETTINGS* aSettings ) override
233  {
234  m_pcbSettings = *static_cast<const PCB_RENDER_SETTINGS*>( aSettings );
235  }
236 
238  virtual PCB_RENDER_SETTINGS* GetSettings() override
239  {
240  return &m_pcbSettings;
241  }
242 
244  virtual bool Draw( const VIEW_ITEM* aItem, int aLayer ) override;
245 
246 protected:
248 
249  // Drawing functions for various types of PCB-specific items
250  void draw( const TRACK* aTrack, int aLayer );
251  void draw( const VIA* aVia, int aLayer );
252  void draw( const D_PAD* aPad, int aLayer );
253  void draw( const DRAWSEGMENT* aSegment, int aLayer );
254  void draw( const TEXTE_PCB* aText, int aLayer );
255  void draw( const TEXTE_MODULE* aText, int aLayer );
256  void draw( const MODULE* aModule, int aLayer );
257  void draw( const ZONE_CONTAINER* aZone, int aLayer );
258  void draw( const DIMENSION* aDimension, int aLayer );
259  void draw( const PCB_TARGET* aTarget );
260  void draw( const MARKER_PCB* aMarker );
261 
269  int getLineThickness( int aActualThickness ) const;
270 
274  virtual int getDrillShape( const D_PAD* aPad ) const;
275 
279  virtual VECTOR2D getDrillSize( const D_PAD* aPad ) const;
280 
284  virtual int getDrillSize( const VIA* aVia ) const;
285 };
286 } // namespace KIGFX
287 
288 #endif /* __CLASS_PAINTER_H */
bool GetGlobalRatsnestLinesEnabled() const
Definition: pcb_painter.h:169
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:57
double GetBrightness() const
Function GetBrightness Returns the brightness value of the color ranged from 0.0 to 1....
Definition: color4d.h:269
const COLOR4D & GetCursorColor() override
Function GetCursorColor Returns current cursor color settings.
Definition: pcb_painter.h:162
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: class_module.h:57
Class RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output ...
Definition: painter.h:56
CLEARANCE_MODE
Flags to control clearance lines visibility
Definition: pcb_painter.h:67
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
COLOR4D m_layerColors[LAYER_ID_COUNT]
Colors for all layers (normal)
Definition: painter.h:265
bool m_sketchMode[GAL_LAYER_ID_END]
Flag determining if items on a given layer should be drawn as an outline or a filled item
Definition: pcb_painter.h:176
virtual const COLOR4D & GetColor(const VIEW_ITEM *aItem, int aLayer) const override
Function GetColor Returns the color that should be used to draw the specific VIEW_ITEM on the specifi...
virtual VECTOR2D getDrillSize(const D_PAD *aPad) const
Return drill size for a pad (internal units).
void EnableZoneOutlines(bool aEnabled)
Turns on/off drawing outline and hatched lines for zones.
Definition: pcb_painter.h:141
bool m_padNumbers
Flag determining if pad numbers should be visible
Definition: pcb_painter.h:188
bool m_sketchBoardGfx
Flag determining if board graphic items should be outlined or stroked
Definition: pcb_painter.h:179
DISPLAY_ZONE_MODE m_displayZone
Option for different display modes for zones
Definition: pcb_painter.h:212
bool m_sketchFpTxtfx
Flag determining if footprint text items should be outlined or stroked
Definition: pcb_painter.h:185
DISPLAY_ZONE_MODE
Determines how zones should be displayed
Definition: pcb_painter.h:83
PCB_RENDER_SETTINGS m_pcbSettings
Definition: pcb_painter.h:247
bool GetSketchMode(int aItemLayer) const
Function GetSketchMode Returns sketch mode setting for a given item layer.
Definition: pcb_painter.h:123
Add new GAL layers here.
COLOR4D m_selectionCandidateColor
Color used for highlighting selection candidates
Definition: pcb_painter.h:218
Class VIEW_ITEM - is an abstract base class for deriving all objects that can be added to a VIEW.
Definition: view_item.h:84
Class PCB_PAINTER Contains methods for drawing PCB-specific items.
Definition: pcb_painter.h:226
void ImportLegacyColors(const COLORS_DESIGN_SETTINGS *aSettings) override
Function ImportLegacyColors Loads a list of color settings for layers.
Definition: pcb_painter.cpp:79
void SetSketchModeGraphicItems(bool aEnabled)
Turns on/off sketch mode for graphic items (DRAWSEGMENTs, texts).
Definition: pcb_painter.h:133
bool m_netNamesOnPads
Flag determining if net names should be visible for pads
Definition: pcb_painter.h:191
Class PCB_RENDER_SETTINGS Stores PCB specific render settings.
Definition: pcb_painter.h:61
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
Class PAINTER contains all the knowledge about how to draw graphical object onto any particular outpu...
Definition: painter.h:313
bool IsBackgroundDark() const override
Definition: pcb_painter.h:146
int getLineThickness(int aActualThickness) const
Function getLineThickness() Get the thickness to draw for a line (e.g.
static const double MAX_FONT_SIZE
Maximum font size for netnames (and other dynamically shown strings)
Definition: pcb_painter.h:209
virtual PCB_RENDER_SETTINGS * GetSettings() override
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
Definition: pcb_painter.h:238
bool GetCurvedRatsnestLinesEnabled() const
Definition: pcb_painter.h:164
void SetBackgroundColor(const COLOR4D &aColor) override
Sets the background color.
Definition: pcb_painter.h:155
bool m_curvedRatsnestlines
Flag determining if ratsnest lines should be drawn curved
Definition: pcb_painter.h:203
bool m_sketchFpGfx
Flag determining if footprint graphic items should be outlined or stroked
Definition: pcb_painter.h:182
void LoadDisplayOptions(const PCB_DISPLAY_OPTIONS *aOptions, bool aShowPageLimits)
Function LoadDisplayOptions Loads settings related to display options (high-contrast mode,...
bool m_netNamesOnTracks
Flag determining if net names should be visible for tracks
Definition: pcb_painter.h:194
virtual void ApplySettings(const RENDER_SETTINGS *aSettings) override
Function ApplySettings Loads colors and display modes settings that are going to be used when drawing...
Definition: pcb_painter.h:232
int m_clearance
Clearance visibility settings
Definition: pcb_painter.h:215
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:161
void SetSketchMode(int aItemLayer, bool aEnabled)
Function SetSketchMode Turns on/off sketch mode for given item layer.
Definition: pcb_painter.h:113
const COLOR4D & GetBackgroundColor() override
Function GetBackgroundColor Returns current background color settings.
Definition: pcb_painter.h:153
const COLOR4D & GetGridColor() override
Function GetGridColor Returns current grid color settings.
Definition: pcb_painter.h:160
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
virtual bool Draw(const VIEW_ITEM *aItem, int aLayer) override
Function Draw Takes an instance of VIEW_ITEM and passes it to a function that know how to draw the it...
PCB_PAINTER(GAL *aGal)
Class COLORS_DESIGN_SETTINGS is a list of color settings for designs in Pcbnew.
bool m_zoneOutlines
Flag determining if zones should have outlines drawn
Definition: pcb_painter.h:200
void draw(const TRACK *aTrack, int aLayer)
Class DIMENSION.
bool m_netNamesOnVias
Flag determining if net names should be visible for vias
Definition: pcb_painter.h:197
Class GAL is the abstract interface for drawing on a 2D-surface.
bool m_globalRatsnestlines
Flag determining if ratsnest lines are shown by default
Definition: pcb_painter.h:206
virtual int getDrillShape(const D_PAD *aPad) const
Return drill shape of a pad.
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39