KiCad PCB EDA Suite
Loading...
Searching...
No Matches
graphics_abstraction_layer.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) 2012 Torsten Hueter, torstenhtr <at> gmx.de
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * Graphics Abstraction Layer (GAL) - base class
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, see <https://www.gnu.org/licenses/>.
21 */
22
23#ifndef GRAPHICSABSTRACTIONLAYER_H_
24#define GRAPHICSABSTRACTIONLAYER_H_
25
26#include <deque>
27#include <stack>
28#include <limits>
29
30#include <math/matrix3x3.h>
31
32#include <gal/gal.h>
33#include <gal/color4d.h>
34#include <gal/cursors.h>
35#include <gal/definitions.h>
37#include <font/stroke_font.h>
38#include <geometry/eda_angle.h>
39#include <pgm_base.h>
41
43class SHAPE_POLY_SET;
44class BITMAP_BASE;
45
46namespace KIGFX
47{
58class GAL_API GAL : GAL_DISPLAY_OPTIONS_OBSERVER
59{
60 // These friend declarations allow us to hide routines that should not be called. The
61 // corresponding RAII objects must be used instead.
62 friend class GAL_CONTEXT_LOCKER;
63 friend class GAL_UPDATE_CONTEXT;
64 friend class GAL_DRAWING_CONTEXT;
65
66public:
67 // Constructor / Destructor
68 GAL( GAL_DISPLAY_OPTIONS& aOptions );
69 virtual ~GAL();
70
72 virtual bool IsInitialized() const { return true; }
73
75 virtual bool IsVisible() const { return true; }
76
78 virtual bool IsCairoEngine() { return false; }
79
81 virtual bool IsOpenGlEngine() { return false; }
82
83 // ---------------
84 // Drawing methods
85 // ---------------
86
95 virtual void DrawLine( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint ) {};
96
106 virtual void DrawSegment( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint,
107 double aWidth ){};
108
115 virtual void DrawSegmentChain( const std::vector<VECTOR2D>& aPointList, double aWidth ){};
116 virtual void DrawSegmentChain( const SHAPE_LINE_CHAIN& aLineChain, double aWidth ){};
117
123 virtual void DrawPolyline( const std::deque<VECTOR2D>& aPointList ) {};
124 virtual void DrawPolyline( const std::vector<VECTOR2D>& aPointList ) {};
125 virtual void DrawPolyline( const VECTOR2D aPointList[], int aListSize ) {};
126 virtual void DrawPolyline( const SHAPE_LINE_CHAIN& aLineChain ) {};
127
133 virtual void DrawPolylines( const std::vector<std::vector<VECTOR2D>>& aPointLists ){};
134
141 virtual void DrawCircle( const VECTOR2D& aCenterPoint, double aRadius ) {};
142
150 virtual void DrawHoleWall( const VECTOR2D& aCenterPoint, double aHoleRadius,
151 double aWallWidth ) {};
152
161 virtual void DrawArc( const VECTOR2D& aCenterPoint, double aRadius,
162 const EDA_ANGLE& aStartAngle, const EDA_ANGLE& aAngle ){};
163
184 virtual void DrawArcSegment( const VECTOR2D& aCenterPoint, double aRadius,
185 const EDA_ANGLE& aStartAngle, const EDA_ANGLE& aAngle,
186 double aWidth, double aMaxError ){};
187
196 virtual void DrawEllipse( const VECTOR2D& aCenterPoint, double aMajorRadius, double aMinorRadius,
197 const EDA_ANGLE& aRotation );
198
209 virtual void DrawEllipseArc( const VECTOR2D& aCenterPoint, double aMajorRadius, double aMinorRadius,
210 const EDA_ANGLE& aRotation, const EDA_ANGLE& aStartAngle, const EDA_ANGLE& aEndAngle );
211
218 virtual void DrawRectangle( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint ) {};
219
220 void DrawRectangle( const BOX2I& aRect )
221 {
222 DrawRectangle( aRect.GetOrigin(), aRect.GetEnd() );
223 }
224
228 virtual void DrawGlyph( const KIFONT::GLYPH& aGlyph, int aNth = 0, int aTotal = 1 ) {};
229
233 virtual void DrawGlyphs( const std::vector<std::unique_ptr<KIFONT::GLYPH>>& aGlyphs )
234 {
235 COLOR4D fillColor = GetFillColor();
236 COLOR4D strokeColor = GetStrokeColor();
237
238 for( size_t i = 0; i < aGlyphs.size(); i++ )
239 {
240 if( aGlyphs[i]->IsHover() )
241 {
244 }
245
246 DrawGlyph( *aGlyphs[i], i, aGlyphs.size() );
247
248 if( aGlyphs[i]->IsHover() )
249 {
250 SetFillColor( fillColor );
251 SetStrokeColor( strokeColor );
252 }
253 }
254 }
255
256
262 virtual void DrawPolygon( const std::deque<VECTOR2D>& aPointList ) {};
263 virtual void DrawPolygon( const VECTOR2D aPointList[], int aListSize ) {};
264 virtual void DrawPolygon( const SHAPE_POLY_SET& aPolySet,
265 bool aStrokeTriangulation = false ) {};
266 virtual void DrawPolygon( const SHAPE_LINE_CHAIN& aPolySet ) {};
267
279 virtual void DrawCurve( const VECTOR2D& startPoint, const VECTOR2D& controlPointA,
280 const VECTOR2D& controlPointB, const VECTOR2D& endPoint,
281 double aFilterValue = 0.0 ) {};
282
286 virtual void DrawBitmap( const BITMAP_BASE& aBitmap, double alphaBlend = 1.0 ) {};
287
288 // --------------
289 // Screen methods
290 // --------------
291
293 virtual void ResizeScreen( int aWidth, int aHeight ) {};
294
296 virtual bool Show( bool aShow ) { return true; };
297
300 {
301 return m_screenSize;
302 }
303
305 virtual int GetSwapInterval() const { return 0; };
306
308 virtual void Flush() {};
309
310 void SetClearColor( const COLOR4D& aColor )
311 {
312 m_clearColor = aColor;
313 }
314
315 const COLOR4D& GetClearColor( ) const
316 {
317 return m_clearColor;
318 }
319
325 virtual void ClearScreen() {};
326
327 // -----------------
328 // Attribute setting
329 // -----------------
330
336 virtual void SetIsFill( bool aIsFillEnabled )
337 {
338 m_isFillEnabled = aIsFillEnabled;
339 }
340
346 inline bool GetIsFill() const
347 {
348 return m_isFillEnabled;
349 }
350
356 virtual void SetIsStroke( bool aIsStrokeEnabled )
357 {
358 m_isStrokeEnabled = aIsStrokeEnabled;
359 }
360
366 inline bool GetIsStroke() const
367 {
368 return m_isStrokeEnabled;
369 }
370
376 virtual void SetFillColor( const COLOR4D& aColor )
377 {
378 m_fillColor = aColor;
379 }
380
386 inline const COLOR4D& GetFillColor() const
387 {
388 return m_fillColor;
389 }
390
396 virtual void SetStrokeColor( const COLOR4D& aColor )
397 {
398 m_strokeColor = aColor;
399 }
400
401 virtual void SetHoverColor( const COLOR4D& aColor )
402 {
403 m_hoverColor = aColor;
404 }
405
411 inline const COLOR4D& GetStrokeColor() const
412 {
413 return m_strokeColor;
414 }
415
421 virtual void SetLineWidth( float aLineWidth )
422 {
423 m_lineWidth = aLineWidth;
424 }
425
431 virtual void SetMinLineWidth( float aLineWidth )
432 {
433 m_minLineWidth = aLineWidth;
434 }
435
441 inline float GetLineWidth() const
442 {
443 return m_lineWidth;
444 }
445
451 inline float GetMinLineWidth() const
452 {
453 return m_minLineWidth;
454 }
455
464 virtual void SetLayerDepth( double aLayerDepth )
465 {
466 wxCHECK_MSG( aLayerDepth <= m_depthRange.y, /*void*/,
467 wxT( "SetLayerDepth: below minimum" ) );
468 wxCHECK_MSG( aLayerDepth >= m_depthRange.x, /*void*/,
469 wxT( "SetLayerDepth: above maximum" ) );
470
471 m_layerDepth = aLayerDepth;
472 }
473
481 inline void AdvanceDepth()
482 {
484 }
485
486 // ----
487 // Text
488 // ----
489
498 virtual void BitmapText( const wxString& aText, const VECTOR2I& aPosition,
499 const EDA_ANGLE& aAngle );
500
507 void ResetTextAttributes();
508
509 void SetGlyphSize( const VECTOR2I aSize ) { m_attributes.m_Size = aSize; }
510 const VECTOR2I& GetGlyphSize() const { return m_attributes.m_Size; }
511
512 inline void SetFontBold( const bool aBold ) { m_attributes.m_Bold = aBold; }
513 inline bool IsFontBold() const { return m_attributes.m_Bold; }
514
515 inline void SetFontItalic( bool aItalic ) { m_attributes.m_Italic = aItalic; }
516 inline bool IsFontItalic() const { return m_attributes.m_Italic; }
517
518 inline void SetFontUnderlined( bool aUnderlined ) { m_attributes.m_Underlined = aUnderlined; }
519 inline bool IsFontUnderlined() const { return m_attributes.m_Underlined; }
520
521 void SetTextMirrored( const bool aMirrored ) { m_attributes.m_Mirrored = aMirrored; }
522 bool IsTextMirrored() const { return m_attributes.m_Mirrored; }
523
524 void SetHorizontalJustify( const GR_TEXT_H_ALIGN_T aHorizontalJustify )
525 {
526 m_attributes.m_Halign = aHorizontalJustify;
527 }
528
530
531 void SetVerticalJustify( const GR_TEXT_V_ALIGN_T aVerticalJustify )
532 {
533 m_attributes.m_Valign = aVerticalJustify;
534 }
535
537
538
539 // --------------
540 // Transformation
541 // --------------
542
548 virtual void Transform( const MATRIX3x3D& aTransformation ) {};
549
555 virtual void Rotate( double aAngle ) {};
556
562 virtual void Translate( const VECTOR2D& aTranslation ) {};
563
569 virtual void Scale( const VECTOR2D& aScale ) {};
570
572 virtual void Save() {};
573
575 virtual void Restore() {};
576
577 // --------------------------------------------
578 // Group methods
579 // ---------------------------------------------
580
589 virtual int BeginGroup() { return 0; };
590
592 virtual void EndGroup() {};
593
599 virtual void DrawGroup( int aGroupNumber ) {};
600
607 virtual void ChangeGroupColor( int aGroupNumber, const COLOR4D& aNewColor ) {};
608
615 virtual void ChangeGroupDepth( int aGroupNumber, int aDepth ) {};
616
622 virtual void DeleteGroup( int aGroupNumber ) {};
623
627 virtual void ClearCache() {};
628
629 // --------------------------------------------------------
630 // Handling the world <-> screen transformation
631 // --------------------------------------------------------
632
634 virtual void ComputeWorldScreenMatrix();
635
642 {
643 return m_worldScreenMatrix;
644 }
645
652 {
653 return m_screenWorldMatrix;
654 }
655
661 inline void SetWorldScreenMatrix( const MATRIX3x3D& aMatrix )
662 {
663 m_worldScreenMatrix = aMatrix;
664 }
665
669 BOX2D GetVisibleWorldExtents() const;
670
678 void SetWorldUnitLength( double aWorldUnitLength ) { m_worldUnitLength = aWorldUnitLength; }
679
680 void SetScreenSize( const VECTOR2I& aSize ) { m_screenSize = aSize; }
681
688 void SetScreenDPI( double aScreenDPI ) { m_screenDPI = aScreenDPI; }
689 double GetScreenDPI() const { return m_screenDPI; }
690
696 void SetLookAtPoint( const VECTOR2D& aPoint ) { m_lookAtPoint = aPoint; }
697 const VECTOR2D& GetLookAtPoint() const { return m_lookAtPoint; }
698
699 void SetZoomFactor( double aZoomFactor ) { m_zoomFactor = aZoomFactor; }
700 double GetZoomFactor() const { return m_zoomFactor; }
701
705 void SetRotation( double aRotation ) { m_rotation = aRotation; }
706 double GetRotation() const { return m_rotation; }
707
716 void SetDepthRange( const VECTOR2D& aDepthRange ) { m_depthRange = aDepthRange; }
717 double GetMinDepth() const { return m_depthRange.x; }
718 double GetMaxDepth() const { return m_depthRange.y; }
719
725 double GetWorldScale() const { return m_worldScale; }
726
733 inline void SetFlip( bool xAxis, bool yAxis )
734 {
735 m_globalFlipX = xAxis;
736 m_globalFlipY = yAxis;
737 }
738
739 bool IsFlippedX() const { return m_globalFlipX; }
740 bool IsFlippedY() const { return m_globalFlipY; }
741
742 // ---------------------------
743 // Buffer manipulation methods
744 // ---------------------------
745
751 virtual void SetTarget( RENDER_TARGET aTarget ) {};
752
758 virtual RENDER_TARGET GetTarget() const { return TARGET_CACHED; };
759
765 virtual void ClearTarget( RENDER_TARGET aTarget ) {};
766
772 virtual bool HasTarget( RENDER_TARGET aTarget )
773 {
774 return true;
775 };
776
788 virtual void SetNegativeDrawMode( bool aSetting ) {};
789
797 virtual void StartDiffLayer() {};
798
804 virtual void EndDiffLayer() {};
805
814 virtual void StartNegativesLayer(){};
815
820 virtual void EndNegativesLayer(){};
821
822 // -------------
823 // Grid methods
824 // -------------
825
831 void SetGridVisibility( bool aVisibility ) { m_gridVisibility = aVisibility; }
832
833 bool GetGridVisibility() const { return m_gridVisibility; }
834
835 bool GetGridSnapping() const
836 {
837 return m_options.m_gridSnapping == KIGFX::GRID_SNAPPING::ALWAYS ||
839 }
840
846 inline void SetGridOrigin( const VECTOR2D& aGridOrigin )
847 {
848 m_gridOrigin = aGridOrigin;
849
850 if( m_gridSize.x == 0.0 || m_gridSize.y == 0.0 )
851 {
852 m_gridOffset = VECTOR2D( 0.0, 0.0);
853 }
854 else
855 {
856 m_gridOffset = VECTOR2D( (long) m_gridOrigin.x % (long) m_gridSize.x,
857 (long) m_gridOrigin.y % (long) m_gridSize.y );
858 }
859 }
860
861 inline const VECTOR2D& GetGridOrigin() const
862 {
863 return m_gridOrigin;
864 }
865
871 inline void SetGridSize( const VECTOR2D& aGridSize )
872 {
873 m_gridSize = aGridSize;
874
875 // Avoid stupid grid size values: a grid size should be >= 1 in internal units
876 m_gridSize.x = std::max( 1.0, m_gridSize.x );
877 m_gridSize.y = std::max( 1.0, m_gridSize.y );
878
879 m_gridOffset = VECTOR2D( (long) m_gridOrigin.x % (long) m_gridSize.x,
880 (long) m_gridOrigin.y % (long) m_gridSize.y );
881 }
882
888 inline const VECTOR2D& GetGridSize() const
889 {
890 return m_gridSize;
891 }
892
899 {
900 VECTOR2D gridScreenSize( m_gridSize );
901 gridScreenSize.x = std::max( 100.0, gridScreenSize.x );
902 gridScreenSize.y = std::max( 100.0, gridScreenSize.y );
903
904 double gridThreshold = computeMinGridSpacing() / m_worldScale;
905
907 gridThreshold *= 2.0;
908
909 // If we cannot display the grid density, scale down by a tick size and
910 // try again. Eventually, we get some representation of the grid
911 while( std::min( gridScreenSize.x, gridScreenSize.y ) <= gridThreshold )
912 {
913 gridScreenSize = gridScreenSize * static_cast<double>( m_gridTick );
914 }
915
916 return gridScreenSize;
917 }
918
924 inline void SetGridColor( const COLOR4D& aGridColor )
925 {
926 m_gridColor = aGridColor;
927 }
928
934 inline void SetAxesColor( const COLOR4D& aAxesColor )
935 {
936 m_axesColor = aAxesColor;
937 }
938
942 inline void SetAxesEnabled( bool aAxesEnabled )
943 {
944 m_axesEnabled = aAxesEnabled;
945 }
946
952 inline void SetCoarseGrid( int aInterval )
953 {
954 m_gridTick = aInterval;
955 }
956
962 inline float GetGridLineWidth() const
963 {
964 return m_gridLineWidth;
965 }
966
968 virtual void DrawGrid() {};
969
976 VECTOR2D GetGridPoint( const VECTOR2D& aPoint ) const;
977
984 inline VECTOR2D ToWorld( const VECTOR2D& aPoint ) const
985 {
986 return VECTOR2D( m_screenWorldMatrix * aPoint );
987 }
988
995 inline VECTOR2D ToScreen( const VECTOR2D& aPoint ) const
996 {
997 return VECTOR2D( m_worldScreenMatrix * aPoint );
998 }
999
1006 virtual bool SetNativeCursorStyle( KICURSOR aCursor, bool aHiDPI );
1007
1013 inline void SetCursorEnabled( bool aCursorEnabled )
1014 {
1015 m_isCursorEnabled = aCursorEnabled;
1016 }
1017
1023 bool IsCursorEnabled() const
1024 {
1026 }
1027
1033 inline void SetCursorColor( const COLOR4D& aCursorColor )
1034 {
1035 m_cursorColor = aCursorColor;
1036 }
1037
1043 virtual void DrawCursor( const VECTOR2D& aCursorPosition ) {};
1044
1045 virtual void EnableDepthTest( bool aEnabled = false ) {};
1046
1051 virtual bool IsContextLocked()
1052 {
1053 return false;
1054 }
1055
1056
1058 virtual void LockContext( int aClientCookie ) {}
1059
1060 virtual void UnlockContext( int aClientCookie ) {}
1061
1066
1069 virtual void BeginDrawing() {};
1070
1073 virtual void EndDrawing() {};
1074protected:
1075
1078 virtual void beginUpdate() {}
1079
1081 virtual void endUpdate() {}
1082
1083
1084
1086 inline void computeWorldScale()
1087 {
1089
1090 PGM_BASE* pgm = PgmOrNull();
1091
1092 if( pgm && pgm->GetCommonSettings() )
1094 }
1095
1101 double computeMinGridSpacing() const;
1102
1104 static const int MIN_DEPTH;
1105 static const int MAX_DEPTH;
1106
1108 static const int GRID_DEPTH;
1109
1113 COLOR4D getCursorColor() const;
1114
1115 // ---------------
1116 // Settings observer interface
1117 // ---------------
1121 void OnGalDisplayOptionsChanged( const GAL_DISPLAY_OPTIONS& aOptions ) override;
1122
1131 virtual bool updatedGalDisplayOptions( const GAL_DISPLAY_OPTIONS& aOptions );
1132
1136 template <typename T>
1137 void normalize( T &a, T &b )
1138 {
1139 if( a > b )
1140 {
1141 T tmp = a;
1142 a = b;
1143 b = tmp;
1144 }
1145 }
1146
1149
1150 std::stack<double> m_depthStack;
1152
1156
1158 double m_rotation;
1162
1165
1168
1171
1176
1179
1180 // Grid settings
1193
1194 // Cursor settings
1200
1202
1203private:
1204
1205 inline double getLayerDepth() const
1206 {
1207 return m_layerDepth;
1208 }
1209
1211
1212 friend class GAL_SCOPED_ATTRS;
1213};
1214
1215
1217{
1218public:
1220 m_gal( aGal )
1221 {
1222 m_cookie = rand();
1223 m_gal->LockContext( m_cookie );
1224 }
1225
1227 {
1228 m_gal->UnlockContext( m_cookie );
1229 }
1230
1231protected:
1234};
1235
1236
1238{
1239public:
1241 GAL_CONTEXT_LOCKER( aGal )
1242 {
1243 m_gal->beginUpdate();
1244 }
1245
1247 {
1248 m_gal->endUpdate();
1249 }
1250};
1251
1252
1254{
1255public:
1257 GAL_CONTEXT_LOCKER( aGal )
1258 {
1259 m_gal->BeginDrawing();
1260 }
1261
1262 ~GAL_DRAWING_CONTEXT() noexcept( false )
1263 {
1264 m_gal->EndDrawing();
1265 }
1266};
1267
1268
1273{
1274public:
1276 {
1283
1284 // It is not clear to me that GAL needs to save text attributes.
1285 // Only BitmapText uses it, and maybe that should be passed in
1286 // explicitly (like for Draw) - every caller of BitmapText sets
1287 // the text attributes anyway.
1288 // TEXT_ATTRS = 64,
1289
1290 // Convenience flags
1294
1296 };
1297
1303 GAL_SCOPED_ATTRS( KIGFX::GAL& aGal, int aFlags )
1304 : m_gal( aGal ), m_flags( aFlags )
1305 {
1306 // Save what we need to restore later.
1307 // These are all so cheap to copy, it's likely not worth if'ing
1308 m_strokeWidth = aGal.GetLineWidth();
1310 m_isStroke = aGal.GetIsStroke();
1311 m_fillColor = aGal.GetFillColor();
1312 m_isFill = aGal.GetIsFill();
1313 m_layerDepth = aGal.getLayerDepth();
1314 }
1315
1317 {
1318 // Restore the attributes that were saved
1319 // based on the flags that were set.
1320
1321 if( m_flags & STROKE_WIDTH )
1322 m_gal.SetLineWidth( m_strokeWidth );
1323
1324 if( m_flags & STROKE_COLOR )
1325 m_gal.SetStrokeColor( m_strokeColor );
1326
1327 if( m_flags & IS_STROKE )
1328 m_gal.SetIsStroke( m_isStroke );
1329
1330 if( m_flags & FILL_COLOR )
1331 m_gal.SetFillColor( m_fillColor );
1332
1333 if( m_flags & IS_FILL )
1334 m_gal.SetIsFill( m_isFill );
1335
1336 if( m_flags & LAYER_DEPTH )
1337 m_gal.SetLayerDepth( m_layerDepth );
1338 }
1339
1340private:
1343
1347
1350
1352};
1353
1354
1355}; // namespace KIGFX
1356
1357#endif /* GRAPHICSABSTRACTIONLAYER_H_ */
BOX2< VECTOR2I > BOX2I
Definition box2.h:918
BOX2< VECTOR2D > BOX2D
Definition box2.h:919
This class handle bitmap images in KiCad.
Definition bitmap_base.h:45
constexpr const Vec GetEnd() const
Definition box2.h:208
constexpr const Vec & GetOrigin() const
Definition box2.h:206
APPEARANCE m_Appearance
GAL(GAL_DISPLAY_OPTIONS &aOptions)
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:101
GAL_SCOPED_ATTRS(KIGFX::GAL &aGal, int aFlags)
Instantiate a GAL_SCOPED_ATTRS object, saving the current attributes of the GAL.
Abstract interface for drawing on a 2D-surface.
const VECTOR2D & GetGridOrigin() const
virtual void ResizeScreen(int aWidth, int aHeight)
Resize the canvas.
virtual void DrawPolygon(const std::deque< VECTOR2D > &aPointList)
Draw a polygon.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
float GetGridLineWidth() const
Get the grid line width.
virtual bool Show(bool aShow)
Show/hide the GAL canvas.
virtual void SetLayerDepth(double aLayerDepth)
Set the depth of the layer (position on the z-axis)
double GetScreenDPI() const
const MATRIX3x3D & GetWorldScreenMatrix() const
Get the world <-> screen transformation matrix.
bool IsCursorEnabled() const
Return information about cursor visibility.
virtual void SetIsFill(bool aIsFillEnabled)
Enable/disable fill.
friend class GAL_DRAWING_CONTEXT
COLOR4D m_hoverColor
Color for hovered (active) links.
friend class GAL_CONTEXT_LOCKER
virtual void EndDrawing()
End the drawing, needs to be called for every new frame.
virtual void StartDiffLayer()
Begins rendering of a differential layer.
bool m_isCursorEnabled
Is the cursor enabled?
virtual void DrawGlyph(const KIFONT::GLYPH &aGlyph, int aNth=0, int aTotal=1)
Draw a polygon representing a font glyph.
virtual void EndDiffLayer()
Ends rendering of a differential layer.
virtual void Rotate(double aAngle)
Rotate the context.
virtual void DrawRectangle(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
Draw a rectangle.
MATRIX3x3D m_worldScreenMatrix
World transformation.
VECTOR2D GetVisibleGridSize() const
Return the visible grid size in x and y directions.
double m_layerDepth
The actual layer depth.
void SetVerticalJustify(const GR_TEXT_V_ALIGN_T aVerticalJustify)
bool GetIsFill() const
Get the fill status.
void AdvanceDepth()
Change the current depth to deeper, so it is possible to draw objects right beneath other.
const COLOR4D & GetFillColor() const
Get the fill color.
void SetFontBold(const bool aBold)
MATRIX3x3D m_screenWorldMatrix
Screen transformation.
void SetFontUnderlined(bool aUnderlined)
void SetHorizontalJustify(const GR_TEXT_H_ALIGN_T aHorizontalJustify)
virtual RENDER_TARGET GetTarget() const
Get the currently used target for rendering.
double GetMaxDepth() const
bool m_axesEnabled
Should the axes be drawn.
void SetRotation(double aRotation)
Get/set the rotation angle (in radians).
float m_gridLineWidth
Line width of the grid.
void SetFlip(bool xAxis, bool yAxis)
Sets flipping of the screen.
VECTOR2I m_screenSize
Screen size in screen (wx logical) coordinates.
virtual void Flush()
Force all remaining objects to be drawn.
virtual int GetSwapInterval() const
Return the swap interval. -1 for adaptive, 0 for disabled/unknown.
virtual void DeleteGroup(int aGroupNumber)
Delete the group from the memory.
std::stack< double > m_depthStack
Stored depth values.
GR_TEXT_H_ALIGN_T GetHorizontalJustify() const
void normalize(T &a, T &b)
Ensure that the first element is smaller than the second.
VECTOR2D m_depthRange
Range of the depth.
double GetZoomFactor() const
virtual void SetFillColor(const COLOR4D &aColor)
Set the fill color.
void OnGalDisplayOptionsChanged(const GAL_DISPLAY_OPTIONS &aOptions) override
Handler for observer settings changes.
double m_zoomFactor
The zoom factor.
virtual void Translate(const VECTOR2D &aTranslation)
Translate the context.
VECTOR2D ToScreen(const VECTOR2D &aPoint) const
Compute the point position in screen coordinates from given world coordinates.
void SetCursorEnabled(bool aCursorEnabled)
Enable/disable cursor.
void SetAxesEnabled(bool aAxesEnabled)
Enable drawing the axes.
virtual void DrawPolylines(const std::vector< std::vector< VECTOR2D > > &aPointLists)
Draw multiple polylines.
virtual bool HasTarget(RENDER_TARGET aTarget)
Return true if the target exists.
GRID_STYLE m_gridStyle
Grid display style.
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
COLOR4D m_cursorColor
Cursor color.
COLOR4D m_axesColor
Color of the axes.
int m_gridMinSpacing
Minimum screen size of the grid (pixels) below which the grid is not drawn.
void SetGridSize(const VECTOR2D &aGridSize)
Set the grid size.
const VECTOR2D & GetLookAtPoint() const
double GetRotation() const
const MATRIX3x3D & GetScreenWorldMatrix() const
Get the screen <-> world transformation matrix.
bool IsFontUnderlined() const
virtual void DrawCircle(const VECTOR2D &aCenterPoint, double aRadius)
Draw a circle using world coordinates.
virtual void Restore()
Restore the context.
float m_lineWidth
The line width.
virtual void DrawHoleWall(const VECTOR2D &aCenterPoint, double aHoleRadius, double aWallWidth)
Draw a hole wall ring.
const COLOR4D & GetStrokeColor() const
Get the stroke color.
virtual void ClearTarget(RENDER_TARGET aTarget)
Clear the target for rendering.
void SetZoomFactor(double aZoomFactor)
virtual void BeginDrawing()
Start/end drawing functions, draw calls can be only made in between the calls to BeginDrawing()/EndDr...
void computeWorldScale()
Compute the scaling factor for the world->screen matrix.
virtual bool IsOpenGlEngine()
Return true if the GAL engine is a OpenGL based type.
virtual int BeginGroup()
Begin a group.
TEXT_ATTRIBUTES m_attributes
static const int MIN_DEPTH
Possible depth range.
const VECTOR2D & GetGridSize() const
Return the grid size.
virtual void DrawPolygon(const VECTOR2D aPointList[], int aListSize)
virtual void SetLineWidth(float aLineWidth)
Set the line width.
double m_rotation
Rotation transformation (radians)
VECTOR2D m_gridSize
The grid size.
virtual void DrawPolygon(const SHAPE_POLY_SET &aPolySet, bool aStrokeTriangulation=false)
COLOR4D getCursorColor() const
Get the actual cursor color to draw.
virtual void ChangeGroupDepth(int aGroupNumber, int aDepth)
Change the depth (Z-axis position) of the group.
virtual void SetHoverColor(const COLOR4D &aColor)
COLOR4D m_fillColor
The fill color.
virtual void EndNegativesLayer()
Ends rendering of a negatives layer and draws it to the main layer.
void DrawRectangle(const BOX2I &aRect)
double m_worldUnitLength
The unit length of the world coordinates [inch].
virtual void StartNegativesLayer()
Begins rendering in a new layer that will be copied to the main layer in EndNegativesLayer().
void SetTextMirrored(const bool aMirrored)
virtual void DrawPolyline(const std::deque< VECTOR2D > &aPointList)
Draw a polyline.
void SetCoarseGrid(int aInterval)
Draw every tick line wider.
virtual bool updatedGalDisplayOptions(const GAL_DISPLAY_OPTIONS &aOptions)
Handle updating display options.
void SetAxesColor(const COLOR4D &aAxesColor)
Set the axes color.
virtual void SetStrokeColor(const COLOR4D &aColor)
Set the stroke color.
virtual void ChangeGroupColor(int aGroupNumber, const COLOR4D &aNewColor)
Change the color used to draw the group.
virtual void DrawArcSegment(const VECTOR2D &aCenterPoint, double aRadius, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle, double aWidth, double aMaxError)
Draw an arc segment.
virtual bool IsContextLocked()
Checks the state of the context lock.
VECTOR2D m_cursorPosition
Current cursor position (world coordinates)
VECTOR2D m_gridOffset
The grid offset to compensate cursor position.
virtual void SetIsStroke(bool aIsStrokeEnabled)
Enable/disable stroked outlines.
virtual void beginUpdate()
Enable item update mode.
virtual void DrawGroup(int aGroupNumber)
Draw the stored group.
double getLayerDepth() const
const VECTOR2I & GetGlyphSize() const
int m_gridTick
Every tick line gets the double width.
double m_worldScale
The scale factor world->screen.
void SetLookAtPoint(const VECTOR2D &aPoint)
Get/set the Point in world space to look at.
virtual void DrawPolygon(const SHAPE_LINE_CHAIN &aPolySet)
bool GetGridVisibility() const
void SetGridOrigin(const VECTOR2D &aGridOrigin)
Set the origin point for the grid.
virtual bool IsCairoEngine()
Return true if the GAL engine is a Cairo based type.
virtual void ClearScreen()
Clear the screen.
virtual void DrawLine(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
Draw a line.
VECTOR2D m_gridOrigin
The grid origin.
virtual void endUpdate()
Disable item update mode.
void SetWorldUnitLength(double aWorldUnitLength)
Set the unit length.
virtual void DrawPolyline(const std::vector< VECTOR2D > &aPointList)
virtual void SetMinLineWidth(float aLineWidth)
Set the minimum line width in pixels.
KICURSOR m_currentNativeCursor
Current cursor.
bool m_globalFlipY
Flag for Y axis flipping.
virtual void UnlockContext(int aClientCookie)
void SetClearColor(const COLOR4D &aColor)
void SetScreenSize(const VECTOR2I &aSize)
const COLOR4D & GetClearColor() const
virtual void DrawSegmentChain(const SHAPE_LINE_CHAIN &aLineChain, double aWidth)
static const int GRID_DEPTH
Depth level on which the grid is drawn.
virtual bool IsInitialized() const
Return the initialization status for the canvas.
float GetMinLineWidth() const
Get the minimum line width in pixels.
void SetGlyphSize(const VECTOR2I aSize)
virtual void DrawGlyphs(const std::vector< std::unique_ptr< KIFONT::GLYPH > > &aGlyphs)
Draw polygons representing font glyphs.
virtual void Scale(const VECTOR2D &aScale)
Scale the context.
virtual void DrawCurve(const VECTOR2D &startPoint, const VECTOR2D &controlPointA, const VECTOR2D &controlPointB, const VECTOR2D &endPoint, double aFilterValue=0.0)
Draw a cubic bezier spline.
bool m_isFillEnabled
Is filling of graphic objects enabled ?
float m_minLineWidth
Minimum line width in pixels.
virtual void EndGroup()
End the group.
virtual void DrawArc(const VECTOR2D &aCenterPoint, double aRadius, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle)
Draw an arc.
virtual void Transform(const MATRIX3x3D &aTransformation)
Transform the context.
virtual void SetNegativeDrawMode(bool aSetting)
Set negative draw mode in the renderer.
COLOR4D m_gridColor
Color of the grid.
VECTOR2D ToWorld(const VECTOR2D &aPoint) const
Compute the point position in world coordinates from given screen coordinates.
COLOR4D m_strokeColor
The color of the outlines.
double computeMinGridSpacing() const
Compute minimum grid spacing from the grid settings.
void SetFontItalic(bool aItalic)
bool m_isStrokeEnabled
Are the outlines stroked ?
virtual void DrawBitmap(const BITMAP_BASE &aBitmap, double alphaBlend=1.0)
Draw a bitmap image.
GAL_DISPLAY_OPTIONS & m_options
bool m_gridVisibility
Should the grid be shown.
double GetMinDepth() const
virtual void ClearCache()
Delete all data created during caching of graphic items.
virtual void SetTarget(RENDER_TARGET aTarget)
Set the target for rendering.
virtual void DrawSegment(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint, double aWidth)
Draw a rounded segment.
double m_screenDPI
The dots per inch of the screen.
virtual void DrawPolyline(const SHAPE_LINE_CHAIN &aLineChain)
const VECTOR2I & GetScreenPixelSize() const
Return GAL canvas size in pixels.
friend class GAL_UPDATE_CONTEXT
void SetGridVisibility(bool aVisibility)
Set the visibility setting of the grid.
float GetLineWidth() const
Get the line width.
virtual void Save()
Save the context.
bool m_globalFlipX
Flag for X axis flipping.
virtual void LockContext(int aClientCookie)
Use GAL_CONTEXT_LOCKER RAII object unless you know what you're doing.
virtual void DrawSegmentChain(const std::vector< VECTOR2D > &aPointList, double aWidth)
Draw a chain of rounded segments.
void SetWorldScreenMatrix(const MATRIX3x3D &aMatrix)
Set the world <-> screen transformation matrix.
GR_TEXT_V_ALIGN_T GetVerticalJustify() const
bool GetIsStroke() const
Get the stroke status.
KIGFX::CROSS_HAIR_MODE m_crossHairMode
Crosshair drawing mode.
virtual void DrawCursor(const VECTOR2D &aCursorPosition)
Draw the cursor.
void SetDepthRange(const VECTOR2D &aDepthRange)
Set the range of the layer depth.
double GetWorldScale() const
Get the world scale.
VECTOR2D m_lookAtPoint
Point to be looked at in world space.
GAL(GAL_DISPLAY_OPTIONS &aOptions)
virtual bool IsVisible() const
Return true if the GAL canvas is visible on the screen.
void SetScreenDPI(double aScreenDPI)
Set the dots per inch of the screen.
virtual void DrawPolyline(const VECTOR2D aPointList[], int aListSize)
virtual void EnableDepthTest(bool aEnabled=false)
bool m_forceDisplayCursor
Always show cursor.
static const int MAX_DEPTH
Container for data for KiCad programs.
Definition pgm_base.h:102
virtual COMMON_SETTINGS * GetCommonSettings() const
Definition pgm_base.cpp:528
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
Represent a set of closed polygons.
KICURSOR
Definition cursors.h:40
#define GAL_API
Definition gal.h:27
MATRIX3x3< double > MATRIX3x3D
Definition matrix3x3.h:469
The Cairo implementation of the graphics abstraction layer.
Definition eda_group.h:29
GRID_STYLE
Type definition of the grid style.
@ SMALL_CROSS
Use small cross instead of dots for the grid.
RENDER_TARGET
RENDER_TARGET: Possible rendering targets.
Definition definitions.h:32
@ TARGET_CACHED
Main rendering target (cached)
Definition definitions.h:33
PGM_BASE * PgmOrNull()
Return a reference that can be nullptr when running a shared lib from a script, not from a kicad app.
see class PGM_BASE
GR_TEXT_H_ALIGN_T
This is API surface mapped to common.types.HorizontalAlignment.
GR_TEXT_V_ALIGN_T
This is API surface mapped to common.types.VertialAlignment.
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:683
VECTOR2< double > VECTOR2D
Definition vector2d.h:682