KiCad PCB EDA Suite
No Matches
Go to the documentation of this file.
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-2024 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
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 *
22 * or you may search the 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 */
27#ifndef __SCH_PAINTER_H
28#define __SCH_PAINTER_H
30#include <sch_render_settings.h>
31#include <sch_symbol.h>
33#include <gal/painter.h>
36class SCH_PIN;
37class LIB_SYMBOL;
38class SCH_SYMBOL;
39class SCH_FIELD;
41class SCH_LABEL;
42class SCH_TEXT;
43class SCH_TEXTBOX;
44class SCH_TABLE;
48class SCH_SHEET;
49class SCH_SHEET_PIN;
50class SCH_SHAPE;
51class SCH_MARKER;
53class SCH_LINE;
55class SCH_BITMAP;
56class SCHEMATIC;
58namespace KIGFX
60class GAL;
61class SCH_PAINTER;
67class SCH_PAINTER : public PAINTER
70 SCH_PAINTER( GAL* aGal );
73 virtual bool Draw( const VIEW_ITEM*, int ) override;
76 virtual SCH_RENDER_SETTINGS* GetSettings() override { return &m_schSettings; }
78 void SetSchematic( SCHEMATIC* aSchematic ) { m_schematic = aSchematic; }
81 void drawItemBoundingBox( const EDA_ITEM* aItem );
82 void draw( const EDA_ITEM*, int, bool aDimmed );
83 void draw( const SCH_PIN* aPin, int aLayer, bool aDimmed );
84 void draw( const LIB_SYMBOL* aSymbol, int, bool aDrawFields = true, int aUnit = 0,
85 int aBodyStyle = 0, bool aDimmed = false );
86 void draw( const SCH_SYMBOL* aSymbol, int aLayer );
87 void draw( const SCH_SHAPE* aShape, int aLayer, bool aDimmed );
88 void draw( const SCH_JUNCTION* aJct, int aLayer );
89 void draw( const SCH_FIELD* aField, int aLayer, bool aDimmed );
90 void draw( const SCH_TEXTBOX* aTextBox, int aLayer, bool aDimmed );
91 void draw( const SCH_TEXT* aText, int aLayer, bool aDimmed );
92 void draw( const SCH_TABLE* aTable, int aLayer, bool aDimmed );
93 void draw( const SCH_LABEL* aLabel, int aLayer );
94 void draw( const SCH_DIRECTIVE_LABEL* aLabel, int aLayer );
95 void draw( const SCH_HIERLABEL* aLabel, int aLayer );
96 void draw( const SCH_GLOBALLABEL* aLabel, int aLayer );
97 void draw( const SCH_SHEET* aSheet, int aLayer );
98 void draw( const SCH_NO_CONNECT* aNC, int aLayer );
99 void draw( const SCH_MARKER* aMarker, int aLayer );
100 void draw( const SCH_BITMAP* aBitmap, int aLayer );
101 void draw( const SCH_LINE* aLine, int aLayer );
102 void draw( const SCH_BUS_ENTRY_BASE* aEntry, int aLayer );
104 void drawPinDanglingIndicator( const VECTOR2I& aPos, const COLOR4D& aColor,
105 bool aDrawingShadows, bool aBrightened );
106 void drawDanglingIndicator( const VECTOR2I& aPos, const COLOR4D& aColor, int aWidth,
107 bool aDangling, bool aDrawingShadows, bool aBrightened );
109 int internalPinDecoSize( const SCH_PIN &aPin );
110 int externalPinDecoSize( const SCH_PIN &aPin );
112 // Indicates the item is drawn on a non-cached layer in OpenGL
113 bool nonCached( const EDA_ITEM* aItem );
115 bool isUnitAndConversionShown( const SCH_ITEM* aItem ) const;
117 float getShadowWidth( bool aForHighlight ) const;
118 COLOR4D getRenderColor( const SCH_ITEM* aItem, int aLayer, bool aDrawingShadows,
119 bool aDimmed = false ) const;
120 KIFONT::FONT* getFont( const EDA_TEXT* aText ) const;
121 float getLineWidth( const SCH_ITEM* aItem, bool aDrawingShadows ) const;
122 float getTextThickness( const SCH_ITEM* aItem ) const;
124 int getOperatingPointTextSize() const;
126 bool setDeviceColors( const SCH_ITEM* aItem, int aLayer, bool aDimmed );
128 void triLine( const VECTOR2D &a, const VECTOR2D &b, const VECTOR2D &c );
129 void strokeText( const wxString& aText, const VECTOR2D& aPosition,
130 const TEXT_ATTRIBUTES& aAttrs, const KIFONT::METRICS& aFontMetrics );
131 void bitmapText( const wxString& aText, const VECTOR2D& aPosition,
132 const TEXT_ATTRIBUTES& aAttrs );
133 void knockoutText( const wxString& aText, const VECTOR2D& aPosition,
134 const TEXT_ATTRIBUTES& aAttrs, const KIFONT::METRICS& aFontMetrics );
135 void boxText( const wxString& aText, const VECTOR2D& aPosition,
136 const TEXT_ATTRIBUTES& aAttrs, const KIFONT::METRICS& aFontMetrics );
138 wxString expandLibItemTextVars( const wxString& aSourceText, const SCH_SYMBOL* aSymbolContext );
141 static std::vector<KICAD_T> g_ScaledSelectionTypes;
148}; // namespace KIGFX
151#endif // __SCH_PAINTER_H
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:88
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:83
FONT is an abstract base class for both outline and stroke fonts.
Definition: font.h:131
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
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 schematic-specific items.
Definition: sch_painter.h:68
void knockoutText(const wxString &aText, const VECTOR2D &aPosition, const TEXT_ATTRIBUTES &aAttrs, const KIFONT::METRICS &aFontMetrics)
float getLineWidth(const SCH_ITEM *aItem, bool aDrawingShadows) const
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:76
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.
bool setDeviceColors(const SCH_ITEM *aItem, int aLayer, bool aDimmed)
COLOR4D getRenderColor(const SCH_ITEM *aItem, int aLayer, bool aDrawingShadows, bool aDimmed=false) const
float getTextThickness(const SCH_ITEM *aItem) const
void strokeText(const wxString &aText, const VECTOR2D &aPosition, const TEXT_ATTRIBUTES &aAttrs, const KIFONT::METRICS &aFontMetrics)
float getShadowWidth(bool aForHighlight) const
int externalPinDecoSize(const SCH_PIN &aPin)
void boxText(const wxString &aText, const VECTOR2D &aPosition, const TEXT_ATTRIBUTES &aAttrs, const KIFONT::METRICS &aFontMetrics)
KIFONT::FONT * getFont(const EDA_TEXT *aText) const
void draw(const EDA_ITEM *, int, bool aDimmed)
wxString expandLibItemTextVars(const wxString &aSourceText, const SCH_SYMBOL *aSymbolContext)
static std::vector< KICAD_T > g_ScaledSelectionTypes
Definition: sch_painter.h:141
SCHEMATIC * m_schematic
Definition: sch_painter.h:145
int getOperatingPointTextSize() const
void triLine(const VECTOR2D &a, const VECTOR2D &b, const VECTOR2D &c)
void SetSchematic(SCHEMATIC *aSchematic)
Definition: sch_painter.h:78
Definition: sch_painter.h:144
void bitmapText(const wxString &aText, const VECTOR2D &aPosition, const TEXT_ATTRIBUTES &aAttrs)
void drawPinDanglingIndicator(const VECTOR2I &aPos, const COLOR4D &aColor, bool aDrawingShadows, bool aBrightened)
bool nonCached(const EDA_ITEM *aItem)
void drawDanglingIndicator(const VECTOR2I &aPos, const COLOR4D &aColor, int aWidth, bool aDangling, bool aDrawingShadows, bool aBrightened)
void drawItemBoundingBox(const EDA_ITEM *aItem)
int internalPinDecoSize(const SCH_PIN &aPin)
bool isUnitAndConversionShown(const SCH_ITEM *aItem) const
An abstract base class for deriving all objects that can be added to a VIEW.
Definition: view_item.h:84
Define a library symbol object.
Definition: lib_symbol.h:77
Holds all the data relating to one schematic.
Definition: schematic.h:75
Object to handle a bitmap image that can be inserted in a schematic.
Definition: sch_bitmap.h:41
Base class for a bus or wire entry.
Definition: sch_bus_entry.h:38
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:51
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:174
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:41
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:66
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:57
Schematic symbol object.
Definition: sch_symbol.h:105
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:247