KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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-2024 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * @author Tomasz Wlostowski <[email protected]>
8 * @author Maciej Suminski <[email protected]>
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, you may find one here:
22 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
23 * or you may search the http://www.gnu.org website for the version 2 license,
24 * or you may write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26 */
27
28#ifndef PCB_PAINTER_H
29#define PCB_PAINTER_H
30
31#include <frame_type.h>
32#include <gal/painter.h>
33#include <padstack.h> // PAD_DRILL_SHAPE
34#include <pcb_display_options.h>
35#include <math/vector2d.h>
36#include <memory>
38
39
40class EDA_ITEM;
43class BOARD_ITEM;
44class PCB_ARC;
45class BOARD;
46class PCB_VIA;
47class PCB_TRACK;
48class PAD;
49class PCB_SHAPE;
50class PCB_GROUP;
51class FOOTPRINT;
52class ZONE;
54class PCB_TEXT;
55class PCB_TEXTBOX;
56class PCB_TABLE;
58class PCB_TARGET;
59class PCB_MARKER;
60class NET_SETTINGS;
61class NETINFO_LIST;
62class TEXT_ATTRIBUTES;
63
64namespace KIFONT
65{
66class FONT;
67class METRICS;
68}
69
70namespace KIGFX
71{
72class GAL;
73
78{
79public:
80 friend class PCB_PAINTER;
81
83
90 void LoadDisplayOptions( const PCB_DISPLAY_OPTIONS& aOptions );
91
92 void LoadColors( const COLOR_SETTINGS* aSettings ) override;
93
95 COLOR4D GetColor( const VIEW_ITEM* aItem, int aLayer ) const override;
96
98 COLOR4D GetColor( const BOARD_ITEM* aItem, int aLayer ) const;
99
101 COLOR4D GetColor( std::nullptr_t, int aLayer ) const
102 {
103 return GetColor( static_cast<const BOARD_ITEM*>( nullptr ), aLayer );
104 }
105
106 bool GetShowPageLimits() const override;
107
108 inline bool IsBackgroundDark() const override
109 {
111
112 return luma < 0.5;
113 }
114
115 const COLOR4D& GetBackgroundColor() const override { return m_layerColors[ LAYER_PCB_BACKGROUND ]; }
116
117 void SetBackgroundColor( const COLOR4D& aColor ) override
118 {
120 }
121
122 const COLOR4D& GetGridColor() override { return m_layerColors[ LAYER_GRID ]; }
123
124 const COLOR4D& GetCursorColor() override { return m_layerColors[ LAYER_CURSOR ]; }
125
128
129 std::map<wxString, KIGFX::COLOR4D>& GetNetclassColorMap() { return m_netclassColors; }
130
131 std::map<int, KIGFX::COLOR4D>& GetNetColorMap() { return m_netColors; }
132
133 std::set<int>& GetHiddenNets() { return m_hiddenNets; }
134 const std::set<int>& GetHiddenNets() const { return m_hiddenNets; }
135
136public:
139
142
143 PAD* m_PadEditModePad; // Pad currently in Pad Edit Mode (if any)
144
145protected:
147 static const double MAX_FONT_SIZE;
148
151
153 std::map<wxString, KIGFX::COLOR4D> m_netclassColors;
154
156 std::map<int, KIGFX::COLOR4D> m_netColors;
157
159 std::set<int> m_hiddenNets;
160
161 // These opacity overrides multiply with any opacity in the base layer color
167};
168
169
173class PCB_PAINTER : public PAINTER
174{
175public:
176 PCB_PAINTER( GAL* aGal, FRAME_T aFrameType );
177
180 {
181 return &m_pcbSettings;
182 }
183
185 virtual bool Draw( const VIEW_ITEM* aItem, int aLayer ) override;
186
187protected:
189
190 // Drawing functions for various types of PCB-specific items
191 void draw( const PCB_TRACK* aTrack, int aLayer );
192 void draw( const PCB_ARC* aArc, int aLayer );
193 void draw( const PCB_VIA* aVia, int aLayer );
194 void draw( const PAD* aPad, int aLayer );
195 void draw( const PCB_SHAPE* aSegment, int aLayer );
196 void draw( const PCB_REFERENCE_IMAGE* aBitmap, int aLayer );
197 void draw( const PCB_TEXT* aText, int aLayer );
198 void draw( const PCB_TEXTBOX* aText, int aLayer );
199 void draw( const PCB_TABLE* aTable, int aLayer );
200 void draw( const FOOTPRINT* aFootprint, int aLayer );
201 void draw( const PCB_GROUP* aGroup, int aLayer );
202 void draw( const ZONE* aZone, int aLayer );
203 void draw( const PCB_DIMENSION_BASE* aDimension, int aLayer );
204 void draw( const PCB_TARGET* aTarget );
205 void draw( const PCB_MARKER* aMarker, int aLayer );
206
213 int getLineThickness( int aActualThickness ) const;
214
218 virtual PAD_DRILL_SHAPE getDrillShape( const PAD* aPad ) const;
219
223 virtual SHAPE_SEGMENT getPadHoleShape( const PAD* aPad ) const;
224
228 virtual int getViaDrillSize( const PCB_VIA* aVia ) const;
229
230 void strokeText( const wxString& aText, const VECTOR2I& aPosition,
231 const TEXT_ATTRIBUTES& aAttrs, const KIFONT::METRICS& aFontMetrics );
232
233 void renderNetNameForSegment( const SHAPE_SEGMENT& aSeg, const COLOR4D& aColor, const wxString& aNetName ) const;
234
235protected:
238
242};
243} // namespace KIGFX
244
245#endif /* PCB_PAINTER_H */
HIGH_CONTRAST_MODE
Determine how inactive layers should be displayed.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:77
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:282
Color settings are a bit different than most of the settings objects in that there can be more than o...
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:88
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
double GetBrightness() const
Returns the brightness value of the color ranged from 0.0 to 1.0.
Definition: color4d.h:333
Abstract interface for drawing on a 2D-surface.
Contains all the knowledge about how to draw graphical object onto any particular output device.
Definition: painter.h:59
Contains methods for drawing PCB-specific items.
Definition: pcb_painter.h:174
virtual SHAPE_SEGMENT getPadHoleShape(const PAD *aPad) const
Return hole shape for a pad (internal units).
int getLineThickness(int aActualThickness) const
Get the thickness to draw for a line (e.g.
virtual PCB_RENDER_SETTINGS * GetSettings() override
Return a pointer to current settings that are going to be used when drawing items.
Definition: pcb_painter.h:179
void renderNetNameForSegment(const SHAPE_SEGMENT &aSeg, const COLOR4D &aColor, const wxString &aNetName) const
PCB_VIEWERS_SETTINGS_BASE * viewer_settings()
Definition: pcb_painter.cpp:82
void draw(const PCB_TRACK *aTrack, int aLayer)
virtual PAD_DRILL_SHAPE getDrillShape(const PAD *aPad) const
Return drill shape of a pad.
PCB_RENDER_SETTINGS m_pcbSettings
Definition: pcb_painter.h:236
virtual int getViaDrillSize(const PCB_VIA *aVia) const
Return drill diameter for a via (internal units).
void strokeText(const wxString &aText, const VECTOR2I &aPosition, const TEXT_ATTRIBUTES &aAttrs, const KIFONT::METRICS &aFontMetrics)
virtual bool Draw(const VIEW_ITEM *aItem, int aLayer) override
Takes an instance of VIEW_ITEM and passes it to a function that knows how to draw the item.
PCB specific render settings.
Definition: pcb_painter.h:78
void SetNetColorMode(NET_COLOR_MODE aMode)
Definition: pcb_painter.h:127
double m_zoneOpacity
Opacity override for filled zones.
Definition: pcb_painter.h:165
double m_trackOpacity
Opacity override for all tracks.
Definition: pcb_painter.h:162
const std::set< int > & GetHiddenNets() const
Definition: pcb_painter.h:134
double m_imageOpacity
Opacity override for user images.
Definition: pcb_painter.h:166
bool IsBackgroundDark() const override
Definition: pcb_painter.h:108
std::set< int > & GetHiddenNets()
Definition: pcb_painter.h:133
const COLOR4D & GetCursorColor() override
Return current cursor color settings.
Definition: pcb_painter.h:124
double m_viaOpacity
Opacity override for all types of via.
Definition: pcb_painter.h:163
ZONE_DISPLAY_MODE m_ZoneDisplayMode
Definition: pcb_painter.h:140
const COLOR4D & GetBackgroundColor() const override
Return current background color settings.
Definition: pcb_painter.h:115
NET_COLOR_MODE GetNetColorMode() const
Definition: pcb_painter.h:126
void LoadColors(const COLOR_SETTINGS *aSettings) override
double m_padOpacity
Opacity override for SMD pads and PTHs.
Definition: pcb_painter.h:164
const COLOR4D & GetGridColor() override
Return current grid color settings.
Definition: pcb_painter.h:122
COLOR4D GetColor(std::nullptr_t, int aLayer) const
Definition: pcb_painter.h:101
void SetBackgroundColor(const COLOR4D &aColor) override
Set the background color.
Definition: pcb_painter.h:117
COLOR4D GetColor(const VIEW_ITEM *aItem, int aLayer) const override
Returns the color that should be used to draw the specific VIEW_ITEM on the specific layer using curr...
std::set< int > m_hiddenNets
Definition: pcb_painter.h:159
HIGH_CONTRAST_MODE m_ContrastModeDisplay
Definition: pcb_painter.h:141
std::map< int, KIGFX::COLOR4D > m_netColors
Set of net codes that should not have their ratsnest displayed.
Definition: pcb_painter.h:156
std::map< int, KIGFX::COLOR4D > & GetNetColorMap()
Definition: pcb_painter.h:131
NET_COLOR_MODE m_netColorMode
Overrides for specific netclass colors.
Definition: pcb_painter.h:150
std::map< wxString, KIGFX::COLOR4D > & GetNetclassColorMap()
Definition: pcb_painter.h:129
static const double MAX_FONT_SIZE
< Maximum font size for netnames (and other dynamically shown strings)
Definition: pcb_painter.h:147
std::map< wxString, KIGFX::COLOR4D > m_netclassColors
Overrides for specific net colors, stored as netcodes for the ratsnest to access easily.
Definition: pcb_painter.h:153
bool GetShowPageLimits() const override
void LoadDisplayOptions(const PCB_DISPLAY_OPTIONS &aOptions)
Load settings related to display options (high-contrast mode, full or outline modes for vias/pads/tra...
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
COLOR4D m_layerColors[LAYER_ID_COUNT]
An abstract base class for deriving all objects that can be added to a VIEW.
Definition: view_item.h:84
Container for NETINFO_ITEM elements, which are the nets.
Definition: netinfo.h:346
NET_SETTINGS stores various net-related settings in a project context.
Definition: net_settings.h:34
Definition: pad.h:53
Abstract dimension API.
A set of BOARD_ITEMs (i.e., without duplicates).
Definition: pcb_group.h:51
Object to handle a bitmap image that can be inserted in a PCB.
Handle a list of polygons defining a copper zone.
Definition: zone.h:72
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:33
@ LAYER_GRID
Definition: layer_ids.h:209
@ LAYER_PCB_BACKGROUND
PCB background color.
Definition: layer_ids.h:224
@ LAYER_CURSOR
PCB cursor.
Definition: layer_ids.h:225
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:247
PAD_DRILL_SHAPE
The set of pad drill shapes, used with PAD::{Set,Get}DrillShape()
Definition: padstack.h:62