KiCad PCB EDA Suite
sch_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) 2019-2020 CERN
5  * Copyright (C) 2020-2021 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * @author Tomasz Wlostowski <tomasz.wlostowski@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 __SCH_PAINTER_H
28 #define __SCH_PAINTER_H
29 
30 #include <sch_symbol.h>
31 
32 #include <painter.h>
33 
34 
35 class LIB_RECTANGLE;
36 class LIB_PIN;
37 class LIB_CIRCLE;
38 class LIB_ITEM;
39 class LIB_SYMBOL;
40 class LIB_POLYLINE;
41 class LIB_ARC;
42 class LIB_FIELD;
43 class LIB_TEXT;
44 class LIB_BEZIER;
45 class SCH_SYMBOL;
46 class SCH_FIELD;
47 class SCH_JUNCTION;
48 class SCH_LABEL;
49 class SCH_TEXT;
50 class SCH_HIERLABEL;
51 class SCH_GLOBALLABEL;
52 class SCH_SHEET;
53 class SCH_SHEET_PIN;
54 class SCH_MARKER;
55 class SCH_NO_CONNECT;
56 class SCH_LINE;
57 class SCH_BUS_ENTRY_BASE;
58 class SCH_BITMAP;
59 class SCHEMATIC;
60 
61 namespace KIGFX
62 {
63 class GAL;
64 class SCH_PAINTER;
65 
66 
71 {
72 public:
73  friend class SCH_PAINTER;
74 
76 
77  void LoadColors( const COLOR_SETTINGS* aSettings ) override;
78 
80  virtual COLOR4D GetColor( const VIEW_ITEM* aItem, int aLayer ) const override;
81 
82  bool IsBackgroundDark() const override
83  {
85 
86  return luma < 0.5;
87  }
88 
89  const COLOR4D& GetBackgroundColor() override
90  {
92  }
93 
94  void SetBackgroundColor( const COLOR4D& aColor ) override
95  {
97  }
98 
100  {
101  return (float) m_defaultPenWidth / 3.0F;
102  }
103 
104  const COLOR4D& GetGridColor() override { return m_layerColors[ LAYER_SCHEMATIC_GRID ]; }
105 
107 
108  int m_ShowUnit; // Show all units if 0
109  int m_ShowConvert; // Show all conversions if 0
110 
117 
119 
120  double m_TextOffsetRatio; // Proportion of font size to offset text above/below
121  // wires, buses, etc.
122 
127 };
128 
129 
133 class SCH_PAINTER : public PAINTER
134 {
135 public:
136  SCH_PAINTER( GAL* aGal );
137 
139  virtual bool Draw( const VIEW_ITEM*, int ) override;
140 
142  virtual SCH_RENDER_SETTINGS* GetSettings() override
143  {
144  return &m_schSettings;
145  }
146 
147  void SetSchematic( SCHEMATIC* aSchematic )
148  {
149  m_schematic = aSchematic;
150  }
151 
152 private:
153  void draw( const LIB_RECTANGLE* aRect, int aLayer );
154  void draw( LIB_PIN* aPin, int aLayer );
155  void draw( const LIB_CIRCLE* aCircle, int aLayer );
156  void draw( const LIB_SYMBOL* aSymbol, int, bool aDrawFields = true, int aUnit = 0,
157  int aConvert = 0 );
158  void draw( const LIB_ARC* aArc, int aLayer );
159  void draw( const LIB_POLYLINE* aLine, int aLayer );
160  void draw( const LIB_FIELD* aField, int aLayer );
161  void draw( const LIB_TEXT* aText, int aLayer );
162  void draw( const LIB_BEZIER* aCurve, int aLayer );
163  void draw( SCH_SYMBOL* aSymbol, int aLayer );
164  void draw( const SCH_JUNCTION* aJct, int aLayer );
165  void draw( const SCH_FIELD* aField, int aLayer );
166  void draw( const SCH_TEXT* aText, int aLayer );
167  void draw( SCH_HIERLABEL* aLabel, int aLayer );
168  void draw( SCH_GLOBALLABEL* aLabel, int aLayer );
169  void draw( const SCH_SHEET* aSheet, int aLayer );
170  void draw( const SCH_NO_CONNECT* aNC, int aLayer );
171  void draw( const SCH_MARKER* aMarker, int aLayer );
172  void draw( const SCH_BITMAP* aBitmap, int aLayer );
173  void draw( const SCH_LINE* aLine, int aLayer );
174  void draw( const SCH_BUS_ENTRY_BASE* aEntry, int aLayer );
175 
176  void drawPinDanglingSymbol( const VECTOR2I& aPos, bool aDrawingShadows );
177  void drawDanglingSymbol( const wxPoint& aPos, int aWidth, bool aDrawingShadows );
178 
179  int internalPinDecoSize( const LIB_PIN &aPin );
180  int externalPinDecoSize( const LIB_PIN &aPin );
181 
182  bool isUnitAndConversionShown( const LIB_ITEM* aItem ) const;
183 
184  float getShadowWidth() const;
185  COLOR4D getRenderColor( const EDA_ITEM* aItem, int aLayer, bool aDrawingShadows ) const;
186  float getLineWidth( const LIB_ITEM* aItem, bool aDrawingShadows ) const;
187  float getLineWidth( const SCH_ITEM* aItem, bool aDrawingShadows ) const;
188  float getTextThickness( const SCH_TEXT* aItem, bool aDrawingShadows ) const;
189  float getTextThickness( const SCH_FIELD* aItem, bool aDrawingShadows ) const;
190  float getTextThickness( const LIB_FIELD* aItem, bool aDrawingShadows ) const;
191  float getTextThickness( const LIB_TEXT* aItem, bool aDrawingShadows ) const;
192 
193  bool setDeviceColors( const LIB_ITEM* aItem, int aLayer );
194  void fillIfSelection( int aLayer );
195 
196  void triLine ( const VECTOR2D &a, const VECTOR2D &b, const VECTOR2D &c );
197  void strokeText( const wxString& aText, const VECTOR2D& aPosition, double aRotationAngle );
198 
200 
202 };
203 
204 }; // namespace KIGFX
205 
206 
207 #endif // __SCH_PAINTER_H
virtual bool Draw(const VIEW_ITEM *, int) override
Takes an instance of VIEW_ITEM and passes it to a function that knows how to draw the item.
SCH_PAINTER(GAL *aGal)
void draw(const LIB_RECTANGLE *aRect, int aLayer)
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
SCHEMATIC * m_schematic
Definition: sch_painter.h:201
void drawDanglingSymbol(const wxPoint &aPos, int aWidth, bool aDrawingShadows)
double GetBrightness() const
Returns the brightness value of the color ranged from 0.0 to 1.0.
Definition: color4d.h:327
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:194
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
Holds all the data relating to one schematic.
Definition: schematic.h:59
void drawPinDanglingSymbol(const VECTOR2I &aPos, bool aDrawingShadows)
COLOR4D m_layerColors[LAYER_ID_COUNT]
Define a symbol library graphical text item.
Definition: lib_text.h:39
Field object used in symbol libraries.
Definition: lib_field.h:59
float getTextThickness(const SCH_TEXT *aItem, bool aDrawingShadows) const
bool setDeviceColors(const LIB_ITEM *aItem, int aLayer)
bool isUnitAndConversionShown(const LIB_ITEM *aItem) const
void SetBackgroundColor(const COLOR4D &aColor) override
Set the background color.
Definition: sch_painter.h:94
const COLOR4D & GetGridColor() override
Return current grid color settings.
Definition: sch_painter.h:104
virtual 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...
An abstract base class for deriving all objects that can be added to a VIEW.
Definition: view_item.h:81
Define a library symbol object.
Definition: lib_symbol.h:96
float getShadowWidth() const
void fillIfSelection(int aLayer)
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
Base class for a bus or wire entry.
Definition: sch_bus_entry.h:42
Contains all the knowledge about how to draw graphical object onto any particular output device.
Definition: painter.h:57
const COLOR4D & GetCursorColor() override
Return current cursor color settings.
Definition: sch_painter.h:106
Contains methods for drawing schematic-specific items.
Definition: sch_painter.h:133
float GetDanglineSymbolThickness() const
Definition: sch_painter.h:99
void strokeText(const wxString &aText, const VECTOR2D &aPosition, double aRotationAngle)
void triLine(const VECTOR2D &a, const VECTOR2D &b, const VECTOR2D &c)
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
Object to handle a bitmap image that can be inserted in a schematic.
Definition: sch_bitmap.h:40
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54
virtual SCH_RENDER_SETTINGS * GetSettings() override
Return a pointer to current settings that are going to be used when drawing items.
Definition: sch_painter.h:142
int externalPinDecoSize(const LIB_PIN &aPin)
void LoadColors(const COLOR_SETTINGS *aSettings) override
Definition: sch_painter.cpp:93
const COLOR4D & GetBackgroundColor() override
Return current background color settings.
Definition: sch_painter.h:89
Schematic symbol object.
Definition: sch_symbol.h:78
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
int internalPinDecoSize(const LIB_PIN &aPin)
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
bool IsBackgroundDark() const override
Definition: sch_painter.h:82
COLOR4D getRenderColor(const EDA_ITEM *aItem, int aLayer, bool aDrawingShadows) const
Store schematic specific render settings.
Definition: sch_painter.h:70
Color settings are a bit different than most of the settings objects in that there can be more than o...
float getLineWidth(const LIB_ITEM *aItem, bool aDrawingShadows) const
void SetSchematic(SCHEMATIC *aSchematic)
Definition: sch_painter.h:147
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197
SCH_RENDER_SETTINGS m_schSettings
Definition: sch_painter.h:199
Abstract interface for drawing on a 2D-surface.
Define a bezier curve graphic body item.
Definition: lib_bezier.h:34
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103