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 <[email protected]>
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_PIN;
36 class LIB_SHAPE;
37 class LIB_ITEM;
38 class LIB_SYMBOL;
39 class LIB_FIELD;
40 class LIB_TEXT;
41 class SCH_SYMBOL;
42 class SCH_FIELD;
43 class SCH_JUNCTION;
44 class SCH_LABEL;
45 class SCH_TEXT;
46 class SCH_HIERLABEL;
47 class SCH_GLOBALLABEL;
48 class SCH_SHEET;
49 class SCH_SHEET_PIN;
50 class SCH_MARKER;
51 class SCH_NO_CONNECT;
52 class SCH_LINE;
53 class SCH_BUS_ENTRY_BASE;
54 class SCH_BITMAP;
55 class SCHEMATIC;
56 
57 namespace KIGFX
58 {
59 class GAL;
60 class SCH_PAINTER;
61 
62 
67 {
68 public:
69  friend class SCH_PAINTER;
70 
72 
73  void LoadColors( const COLOR_SETTINGS* aSettings ) override;
74 
76  virtual COLOR4D GetColor( const VIEW_ITEM* aItem, int aLayer ) const override;
77 
78  bool IsBackgroundDark() const override
79  {
81 
82  return luma < 0.5;
83  }
84 
85  const COLOR4D& GetBackgroundColor() override
86  {
88  }
89 
90  void SetBackgroundColor( const COLOR4D& aColor ) override
91  {
93  }
94 
96  {
97  return (float) m_defaultPenWidth / 3.0F;
98  }
99 
100  const COLOR4D& GetGridColor() override { return m_layerColors[ LAYER_SCHEMATIC_GRID ]; }
101 
103 
105 
106  int m_ShowUnit; // Show all units if 0
107  int m_ShowConvert; // Show all conversions if 0
108 
115 
117 
118  double m_LabelSizeRatio; // Proportion of font size to label box
119  double m_TextOffsetRatio; // Proportion of font size to offset text above/below
120  // wires, buses, etc.
121 
124 };
125 
126 
130 class SCH_PAINTER : public PAINTER
131 {
132 public:
133  SCH_PAINTER( GAL* aGal );
134 
136  virtual bool Draw( const VIEW_ITEM*, int ) override;
137 
139  virtual SCH_RENDER_SETTINGS* GetSettings() override
140  {
141  return &m_schSettings;
142  }
143 
144  void SetSchematic( SCHEMATIC* aSchematic )
145  {
146  m_schematic = aSchematic;
147  }
148 
149 private:
150  void draw( LIB_PIN* aPin, int aLayer );
151  void draw( const LIB_SHAPE* aCircle, int aLayer );
152  void draw( const LIB_SYMBOL* aSymbol, int, bool aDrawFields = true, int aUnit = 0,
153  int aConvert = 0 );
154  void draw( const LIB_FIELD* aField, int aLayer );
155  void draw( const LIB_TEXT* aText, int aLayer );
156  void draw( SCH_SYMBOL* aSymbol, int aLayer );
157  void draw( const SCH_JUNCTION* aJct, int aLayer );
158  void draw( const SCH_FIELD* aField, int aLayer );
159  void draw( const SCH_TEXT* aText, int aLayer );
160  void draw( SCH_HIERLABEL* aLabel, int aLayer );
161  void draw( SCH_GLOBALLABEL* aLabel, int aLayer );
162  void draw( const SCH_SHEET* aSheet, int aLayer );
163  void draw( const SCH_NO_CONNECT* aNC, int aLayer );
164  void draw( const SCH_MARKER* aMarker, int aLayer );
165  void draw( const SCH_BITMAP* aBitmap, int aLayer );
166  void draw( const SCH_LINE* aLine, int aLayer );
167  void draw( const SCH_BUS_ENTRY_BASE* aEntry, int aLayer );
168 
169  void drawPinDanglingSymbol( const VECTOR2I& aPos, const COLOR4D& aColor,
170  bool aDrawingShadows );
171  void drawDanglingSymbol( const wxPoint& aPos, const COLOR4D& aColor, int aWidth,
172  bool aDrawingShadows );
173 
174  int internalPinDecoSize( const LIB_PIN &aPin );
175  int externalPinDecoSize( const LIB_PIN &aPin );
176 
177  bool isUnitAndConversionShown( const LIB_ITEM* aItem ) const;
178 
179  float getShadowWidth() const;
180  COLOR4D getRenderColor( const EDA_ITEM* aItem, int aLayer, bool aDrawingShadows ) const;
181  float getLineWidth( const LIB_ITEM* aItem, bool aDrawingShadows ) const;
182  float getLineWidth( const SCH_ITEM* aItem, bool aDrawingShadows ) const;
183  float getTextThickness( const SCH_TEXT* aItem, bool aDrawingShadows ) const;
184  float getTextThickness( const SCH_FIELD* aItem, bool aDrawingShadows ) const;
185  float getTextThickness( const LIB_FIELD* aItem, bool aDrawingShadows ) const;
186  float getTextThickness( const LIB_TEXT* aItem, bool aDrawingShadows ) const;
187 
188  bool setDeviceColors( const LIB_ITEM* aItem, int aLayer );
189 
190  void triLine ( const VECTOR2D &a, const VECTOR2D &b, const VECTOR2D &c );
191  void strokeText( const wxString& aText, const VECTOR2D& aPosition, double aRotationAngle );
192  void boxText( const wxString& aText, const VECTOR2D& aPosition, double aAngle );
193 
194 private:
196 
198 };
199 
200 }; // namespace KIGFX
201 
202 
203 #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)
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:197
double GetBrightness() const
Returns the brightness value of the color ranged from 0.0 to 1.0.
Definition: color4d.h:343
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:243
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
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:90
const COLOR4D & GetGridColor() override
Return current grid color settings.
Definition: sch_painter.h:100
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:76
Define a library symbol object.
Definition: lib_symbol.h:96
float getShadowWidth() const
void boxText(const wxString &aText, const VECTOR2D &aPosition, double aAngle)
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
void drawDanglingSymbol(const wxPoint &aPos, const COLOR4D &aColor, int aWidth, bool aDrawingShadows)
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:102
Contains methods for drawing schematic-specific items.
Definition: sch_painter.h:130
float GetDanglineSymbolThickness() const
Definition: sch_painter.h:95
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
void draw(LIB_PIN *aPin, int aLayer)
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:139
int externalPinDecoSize(const LIB_PIN &aPin)
void LoadColors(const COLOR_SETTINGS *aSettings) override
Definition: sch_painter.cpp:90
const COLOR4D & GetBackgroundColor() override
Return current background color settings.
Definition: sch_painter.h:85
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:99
bool IsBackgroundDark() const override
Definition: sch_painter.h:78
COLOR4D getRenderColor(const EDA_ITEM *aItem, int aLayer, bool aDrawingShadows) const
Store schematic specific render settings.
Definition: sch_painter.h:66
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:144
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182
SCH_RENDER_SETTINGS m_schSettings
Definition: sch_painter.h:195
void drawPinDanglingSymbol(const VECTOR2I &aPos, const COLOR4D &aColor, bool aDrawingShadows)
Abstract interface for drawing on a 2D-surface.
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103