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, 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 GRAPHICSABSTRACTIONLAYER_H_
28#define GRAPHICSABSTRACTIONLAYER_H_
29
30#include <deque>
31#include <stack>
32#include <limits>
33
34#include <math/matrix3x3.h>
35
36#include <gal/gal.h>
37#include <gal/color4d.h>
38#include <gal/cursors.h>
39#include <gal/definitions.h>
41#include <font/stroke_font.h>
42#include <geometry/eda_angle.h>
43#include <pgm_base.h>
45
47class SHAPE_POLY_SET;
48class BITMAP_BASE;
49
50namespace KIGFX
51{
62class GAL_API GAL : GAL_DISPLAY_OPTIONS_OBSERVER
63{
64 // These friend declarations allow us to hide routines that should not be called. The
65 // corresponding RAII objects must be used instead.
66 friend class GAL_CONTEXT_LOCKER;
67 friend class GAL_UPDATE_CONTEXT;
68 friend class GAL_DRAWING_CONTEXT;
69
70public:
71 // Constructor / Destructor
72 GAL( GAL_DISPLAY_OPTIONS& aOptions );
73 virtual ~GAL();
74
76 virtual bool IsInitialized() const { return true; }
77
79 virtual bool IsVisible() const { return true; }
80
82 virtual bool IsCairoEngine() { return false; }
83
85 virtual bool IsOpenGlEngine() { return false; }
86
87 // ---------------
88 // Drawing methods
89 // ---------------
90
99 virtual void DrawLine( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint ) {};
100
110 virtual void DrawSegment( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint,
111 double aWidth ){};
112
119 virtual void DrawSegmentChain( const std::vector<VECTOR2D>& aPointList, double aWidth ){};
120 virtual void DrawSegmentChain( const SHAPE_LINE_CHAIN& aLineChain, double aWidth ){};
121
127 virtual void DrawPolyline( const std::deque<VECTOR2D>& aPointList ) {};
128 virtual void DrawPolyline( const std::vector<VECTOR2D>& aPointList ) {};
129 virtual void DrawPolyline( const VECTOR2D aPointList[], int aListSize ) {};
130 virtual void DrawPolyline( const SHAPE_LINE_CHAIN& aLineChain ) {};
131
137 virtual void DrawPolylines( const std::vector<std::vector<VECTOR2D>>& aPointLists ){};
138
145 virtual void DrawCircle( const VECTOR2D& aCenterPoint, double aRadius ) {};
146
154 virtual void DrawHoleWall( const VECTOR2D& aCenterPoint, double aHoleRadius,
155 double aWallWidth ) {};
156
165 virtual void DrawArc( const VECTOR2D& aCenterPoint, double aRadius,
166 const EDA_ANGLE& aStartAngle, const EDA_ANGLE& aAngle ){};
167
188 virtual void DrawArcSegment( const VECTOR2D& aCenterPoint, double aRadius,
189 const EDA_ANGLE& aStartAngle, const EDA_ANGLE& aAngle,
190 double aWidth, double aMaxError ){};
191
198 virtual void DrawRectangle( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint ) {};
199
200 void DrawRectangle( const BOX2I& aRect )
201 {
202 DrawRectangle( aRect.GetOrigin(), aRect.GetEnd() );
203 }
204
208 virtual void DrawGlyph( const KIFONT::GLYPH& aGlyph, int aNth = 0, int aTotal = 1 ) {};
209
213 virtual void DrawGlyphs( const std::vector<std::unique_ptr<KIFONT::GLYPH>>& aGlyphs )
214 {
215 COLOR4D fillColor = GetFillColor();
216 COLOR4D strokeColor = GetStrokeColor();
217
218 for( size_t i = 0; i < aGlyphs.size(); i++ )
219 {
220 if( aGlyphs[i]->IsHover() )
221 {
224 }
225
226 DrawGlyph( *aGlyphs[i], i, aGlyphs.size() );
227
228 if( aGlyphs[i]->IsHover() )
229 {
230 SetFillColor( fillColor );
231 SetStrokeColor( strokeColor );
232 }
233 }
234 }
235
236
242 virtual void DrawPolygon( const std::deque<VECTOR2D>& aPointList ) {};
243 virtual void DrawPolygon( const VECTOR2D aPointList[], int aListSize ) {};
244 virtual void DrawPolygon( const SHAPE_POLY_SET& aPolySet,
245 bool aStrokeTriangulation = false ) {};
246 virtual void DrawPolygon( const SHAPE_LINE_CHAIN& aPolySet ) {};
247
259 virtual void DrawCurve( const VECTOR2D& startPoint, const VECTOR2D& controlPointA,
260 const VECTOR2D& controlPointB, const VECTOR2D& endPoint,
261 double aFilterValue = 0.0 ) {};
262
266 virtual void DrawBitmap( const BITMAP_BASE& aBitmap, double alphaBlend = 1.0 ) {};
267
268 // --------------
269 // Screen methods
270 // --------------
271
273 virtual void ResizeScreen( int aWidth, int aHeight ) {};
274
276 virtual bool Show( bool aShow ) { return true; };
277
280 {
281 return m_screenSize;
282 }
283
285 virtual int GetSwapInterval() const { return 0; };
286
288 virtual void Flush() {};
289
290 void SetClearColor( const COLOR4D& aColor )
291 {
292 m_clearColor = aColor;
293 }
294
295 const COLOR4D& GetClearColor( ) const
296 {
297 return m_clearColor;
298 }
299
305 virtual void ClearScreen() {};
306
307 // -----------------
308 // Attribute setting
309 // -----------------
310
316 virtual void SetIsFill( bool aIsFillEnabled )
317 {
318 m_isFillEnabled = aIsFillEnabled;
319 }
320
326 inline bool GetIsFill() const
327 {
328 return m_isFillEnabled;
329 }
330
336 virtual void SetIsStroke( bool aIsStrokeEnabled )
337 {
338 m_isStrokeEnabled = aIsStrokeEnabled;
339 }
340
346 inline bool GetIsStroke() const
347 {
348 return m_isStrokeEnabled;
349 }
350
356 virtual void SetFillColor( const COLOR4D& aColor )
357 {
358 m_fillColor = aColor;
359 }
360
366 inline const COLOR4D& GetFillColor() const
367 {
368 return m_fillColor;
369 }
370
376 virtual void SetStrokeColor( const COLOR4D& aColor )
377 {
378 m_strokeColor = aColor;
379 }
380
381 virtual void SetHoverColor( const COLOR4D& aColor )
382 {
383 m_hoverColor = aColor;
384 }
385
391 inline const COLOR4D& GetStrokeColor() const
392 {
393 return m_strokeColor;
394 }
395
401 virtual void SetLineWidth( float aLineWidth )
402 {
403 m_lineWidth = aLineWidth;
404 }
405
411 virtual void SetMinLineWidth( float aLineWidth )
412 {
413 m_minLineWidth = aLineWidth;
414 }
415
421 inline float GetLineWidth() const
422 {
423 return m_lineWidth;
424 }
425
431 inline float GetMinLineWidth() const
432 {
433 return m_minLineWidth;
434 }
435
444 virtual void SetLayerDepth( double aLayerDepth )
445 {
446 wxCHECK_MSG( aLayerDepth <= m_depthRange.y, /*void*/,
447 wxT( "SetLayerDepth: below minimum" ) );
448 wxCHECK_MSG( aLayerDepth >= m_depthRange.x, /*void*/,
449 wxT( "SetLayerDepth: above maximum" ) );
450
451 m_layerDepth = aLayerDepth;
452 }
453
461 inline void AdvanceDepth()
462 {
464 }
465
466 // ----
467 // Text
468 // ----
469
478 virtual void BitmapText( const wxString& aText, const VECTOR2I& aPosition,
479 const EDA_ANGLE& aAngle );
480
487 void ResetTextAttributes();
488
489 void SetGlyphSize( const VECTOR2I aSize ) { m_attributes.m_Size = aSize; }
490 const VECTOR2I& GetGlyphSize() const { return m_attributes.m_Size; }
491
492 inline void SetFontBold( const bool aBold ) { m_attributes.m_Bold = aBold; }
493 inline bool IsFontBold() const { return m_attributes.m_Bold; }
494
495 inline void SetFontItalic( bool aItalic ) { m_attributes.m_Italic = aItalic; }
496 inline bool IsFontItalic() const { return m_attributes.m_Italic; }
497
498 inline void SetFontUnderlined( bool aUnderlined ) { m_attributes.m_Underlined = aUnderlined; }
499 inline bool IsFontUnderlined() const { return m_attributes.m_Underlined; }
500
501 void SetTextMirrored( const bool aMirrored ) { m_attributes.m_Mirrored = aMirrored; }
502 bool IsTextMirrored() const { return m_attributes.m_Mirrored; }
503
504 void SetHorizontalJustify( const GR_TEXT_H_ALIGN_T aHorizontalJustify )
505 {
506 m_attributes.m_Halign = aHorizontalJustify;
507 }
508
510
511 void SetVerticalJustify( const GR_TEXT_V_ALIGN_T aVerticalJustify )
512 {
513 m_attributes.m_Valign = aVerticalJustify;
514 }
515
517
518
519 // --------------
520 // Transformation
521 // --------------
522
528 virtual void Transform( const MATRIX3x3D& aTransformation ) {};
529
535 virtual void Rotate( double aAngle ) {};
536
542 virtual void Translate( const VECTOR2D& aTranslation ) {};
543
549 virtual void Scale( const VECTOR2D& aScale ) {};
550
552 virtual void Save() {};
553
555 virtual void Restore() {};
556
557 // --------------------------------------------
558 // Group methods
559 // ---------------------------------------------
560
569 virtual int BeginGroup() { return 0; };
570
572 virtual void EndGroup() {};
573
579 virtual void DrawGroup( int aGroupNumber ) {};
580
587 virtual void ChangeGroupColor( int aGroupNumber, const COLOR4D& aNewColor ) {};
588
595 virtual void ChangeGroupDepth( int aGroupNumber, int aDepth ) {};
596
602 virtual void DeleteGroup( int aGroupNumber ) {};
603
607 virtual void ClearCache() {};
608
609 // --------------------------------------------------------
610 // Handling the world <-> screen transformation
611 // --------------------------------------------------------
612
614 virtual void ComputeWorldScreenMatrix();
615
622 {
623 return m_worldScreenMatrix;
624 }
625
632 {
633 return m_screenWorldMatrix;
634 }
635
641 inline void SetWorldScreenMatrix( const MATRIX3x3D& aMatrix )
642 {
643 m_worldScreenMatrix = aMatrix;
644 }
645
649 BOX2D GetVisibleWorldExtents() const;
650
658 void SetWorldUnitLength( double aWorldUnitLength ) { m_worldUnitLength = aWorldUnitLength; }
659
660 void SetScreenSize( const VECTOR2I& aSize ) { m_screenSize = aSize; }
661
668 void SetScreenDPI( double aScreenDPI ) { m_screenDPI = aScreenDPI; }
669 double GetScreenDPI() const { return m_screenDPI; }
670
676 void SetLookAtPoint( const VECTOR2D& aPoint ) { m_lookAtPoint = aPoint; }
677 const VECTOR2D& GetLookAtPoint() const { return m_lookAtPoint; }
678
679 void SetZoomFactor( double aZoomFactor ) { m_zoomFactor = aZoomFactor; }
680 double GetZoomFactor() const { return m_zoomFactor; }
681
685 void SetRotation( double aRotation ) { m_rotation = aRotation; }
686 double GetRotation() const { return m_rotation; }
687
696 void SetDepthRange( const VECTOR2D& aDepthRange ) { m_depthRange = aDepthRange; }
697 double GetMinDepth() const { return m_depthRange.x; }
698 double GetMaxDepth() const { return m_depthRange.y; }
699
705 double GetWorldScale() const { return m_worldScale; }
706
713 inline void SetFlip( bool xAxis, bool yAxis )
714 {
715 m_globalFlipX = xAxis;
716 m_globalFlipY = yAxis;
717 }
718
719 bool IsFlippedX() const { return m_globalFlipX; }
720 bool IsFlippedY() const { return m_globalFlipY; }
721
722 // ---------------------------
723 // Buffer manipulation methods
724 // ---------------------------
725
731 virtual void SetTarget( RENDER_TARGET aTarget ) {};
732
738 virtual RENDER_TARGET GetTarget() const { return TARGET_CACHED; };
739
745 virtual void ClearTarget( RENDER_TARGET aTarget ) {};
746
752 virtual bool HasTarget( RENDER_TARGET aTarget )
753 {
754 return true;
755 };
756
768 virtual void SetNegativeDrawMode( bool aSetting ) {};
769
777 virtual void StartDiffLayer() {};
778
784 virtual void EndDiffLayer() {};
785
794 virtual void StartNegativesLayer(){};
795
800 virtual void EndNegativesLayer(){};
801
802 // -------------
803 // Grid methods
804 // -------------
805
811 void SetGridVisibility( bool aVisibility ) { m_gridVisibility = aVisibility; }
812
813 bool GetGridVisibility() const { return m_gridVisibility; }
814
815 bool GetGridSnapping() const
816 {
817 return m_options.m_gridSnapping == KIGFX::GRID_SNAPPING::ALWAYS ||
819 }
820
826 inline void SetGridOrigin( const VECTOR2D& aGridOrigin )
827 {
828 m_gridOrigin = aGridOrigin;
829
830 if( m_gridSize.x == 0.0 || m_gridSize.y == 0.0 )
831 {
832 m_gridOffset = VECTOR2D( 0.0, 0.0);
833 }
834 else
835 {
836 m_gridOffset = VECTOR2D( (long) m_gridOrigin.x % (long) m_gridSize.x,
837 (long) m_gridOrigin.y % (long) m_gridSize.y );
838 }
839 }
840
841 inline const VECTOR2D& GetGridOrigin() const
842 {
843 return m_gridOrigin;
844 }
845
851 inline void SetGridSize( const VECTOR2D& aGridSize )
852 {
853 m_gridSize = aGridSize;
854
855 // Avoid stupid grid size values: a grid size should be >= 1 in internal units
856 m_gridSize.x = std::max( 1.0, m_gridSize.x );
857 m_gridSize.y = std::max( 1.0, m_gridSize.y );
858
859 m_gridOffset = VECTOR2D( (long) m_gridOrigin.x % (long) m_gridSize.x,
860 (long) m_gridOrigin.y % (long) m_gridSize.y );
861 }
862
868 inline const VECTOR2D& GetGridSize() const
869 {
870 return m_gridSize;
871 }
872
879 {
880 VECTOR2D gridScreenSize( m_gridSize );
881 gridScreenSize.x = std::max( 100.0, gridScreenSize.x );
882 gridScreenSize.y = std::max( 100.0, gridScreenSize.y );
883
884 double gridThreshold = computeMinGridSpacing() / m_worldScale;
885
887 gridThreshold *= 2.0;
888
889 // If we cannot display the grid density, scale down by a tick size and
890 // try again. Eventually, we get some representation of the grid
891 while( std::min( gridScreenSize.x, gridScreenSize.y ) <= gridThreshold )
892 {
893 gridScreenSize = gridScreenSize * static_cast<double>( m_gridTick );
894 }
895
896 return gridScreenSize;
897 }
898
904 inline void SetGridColor( const COLOR4D& aGridColor )
905 {
906 m_gridColor = aGridColor;
907 }
908
914 inline void SetAxesColor( const COLOR4D& aAxesColor )
915 {
916 m_axesColor = aAxesColor;
917 }
918
922 inline void SetAxesEnabled( bool aAxesEnabled )
923 {
924 m_axesEnabled = aAxesEnabled;
925 }
926
932 inline void SetCoarseGrid( int aInterval )
933 {
934 m_gridTick = aInterval;
935 }
936
942 inline float GetGridLineWidth() const
943 {
944 return m_gridLineWidth;
945 }
946
948 virtual void DrawGrid() {};
949
956 VECTOR2D GetGridPoint( const VECTOR2D& aPoint ) const;
957
964 inline VECTOR2D ToWorld( const VECTOR2D& aPoint ) const
965 {
966 return VECTOR2D( m_screenWorldMatrix * aPoint );
967 }
968
975 inline VECTOR2D ToScreen( const VECTOR2D& aPoint ) const
976 {
977 return VECTOR2D( m_worldScreenMatrix * aPoint );
978 }
979
986 virtual bool SetNativeCursorStyle( KICURSOR aCursor, bool aHiDPI );
987
993 inline void SetCursorEnabled( bool aCursorEnabled )
994 {
995 m_isCursorEnabled = aCursorEnabled;
996 }
997
1003 bool IsCursorEnabled() const
1004 {
1006 }
1007
1013 inline void SetCursorColor( const COLOR4D& aCursorColor )
1014 {
1015 m_cursorColor = aCursorColor;
1016 }
1017
1023 virtual void DrawCursor( const VECTOR2D& aCursorPosition ) {};
1024
1025 virtual void EnableDepthTest( bool aEnabled = false ) {};
1026
1031 virtual bool IsContextLocked()
1032 {
1033 return false;
1034 }
1035
1036
1038 virtual void LockContext( int aClientCookie ) {}
1039
1040 virtual void UnlockContext( int aClientCookie ) {}
1041
1046
1049 virtual void BeginDrawing() {};
1050
1053 virtual void EndDrawing() {};
1054protected:
1055
1058 virtual void beginUpdate() {}
1059
1061 virtual void endUpdate() {}
1062
1063
1064
1066 inline void computeWorldScale()
1067 {
1069
1070 if( Pgm().GetCommonSettings() )
1072 }
1073
1079 double computeMinGridSpacing() const;
1080
1082 static const int MIN_DEPTH;
1083 static const int MAX_DEPTH;
1084
1086 static const int GRID_DEPTH;
1087
1091 COLOR4D getCursorColor() const;
1092
1093 // ---------------
1094 // Settings observer interface
1095 // ---------------
1099 void OnGalDisplayOptionsChanged( const GAL_DISPLAY_OPTIONS& aOptions ) override;
1100
1109 virtual bool updatedGalDisplayOptions( const GAL_DISPLAY_OPTIONS& aOptions );
1110
1114 template <typename T>
1115 void normalize( T &a, T &b )
1116 {
1117 if( a > b )
1118 {
1119 T tmp = a;
1120 a = b;
1121 b = tmp;
1122 }
1123 }
1124
1127
1128 std::stack<double> m_depthStack;
1130
1134
1136 double m_rotation;
1140
1143
1146
1149
1154
1157
1158 // Grid settings
1171
1172 // Cursor settings
1178
1180
1181private:
1182
1183 inline double getLayerDepth() const
1184 {
1185 return m_layerDepth;
1186 }
1187
1189
1190 friend class GAL_SCOPED_ATTRS;
1191};
1192
1193
1195{
1196public:
1198 m_gal( aGal )
1199 {
1200 m_cookie = rand();
1201 m_gal->LockContext( m_cookie );
1202 }
1203
1205 {
1206 m_gal->UnlockContext( m_cookie );
1207 }
1208
1209protected:
1212};
1213
1214
1216{
1217public:
1219 GAL_CONTEXT_LOCKER( aGal )
1220 {
1221 m_gal->beginUpdate();
1222 }
1223
1225 {
1226 m_gal->endUpdate();
1227 }
1228};
1229
1230
1232{
1233public:
1235 GAL_CONTEXT_LOCKER( aGal )
1236 {
1237 m_gal->BeginDrawing();
1238 }
1239
1240 ~GAL_DRAWING_CONTEXT() noexcept( false )
1241 {
1242 m_gal->EndDrawing();
1243 }
1244};
1245
1246
1251{
1252public:
1254 {
1261
1262 // It is not clear to me that GAL needs to save text attributes.
1263 // Only BitmapText uses it, and maybe that should be passed in
1264 // explicitly (like for Draw) - every caller of BitmapText sets
1265 // the text attributes anyway.
1266 // TEXT_ATTRS = 64,
1267
1268 // Convenience flags
1272
1274 };
1275
1281 GAL_SCOPED_ATTRS( KIGFX::GAL& aGal, int aFlags )
1282 : m_gal( aGal ), m_flags( aFlags )
1283 {
1284 // Save what we need to restore later.
1285 // These are all so cheap to copy, it's likely not worth if'ing
1286 m_strokeWidth = aGal.GetLineWidth();
1288 m_isStroke = aGal.GetIsStroke();
1289 m_fillColor = aGal.GetFillColor();
1290 m_isFill = aGal.GetIsFill();
1291 m_layerDepth = aGal.getLayerDepth();
1292 }
1293
1295 {
1296 // Restore the attributes that were saved
1297 // based on the flags that were set.
1298
1299 if( m_flags & STROKE_WIDTH )
1300 m_gal.SetLineWidth( m_strokeWidth );
1301
1302 if( m_flags & STROKE_COLOR )
1303 m_gal.SetStrokeColor( m_strokeColor );
1304
1305 if( m_flags & IS_STROKE )
1306 m_gal.SetIsStroke( m_isStroke );
1307
1308 if( m_flags & FILL_COLOR )
1309 m_gal.SetFillColor( m_fillColor );
1310
1311 if( m_flags & IS_FILL )
1312 m_gal.SetIsFill( m_isFill );
1313
1314 if( m_flags & LAYER_DEPTH )
1315 m_gal.SetLayerDepth( m_layerDepth );
1316 }
1317
1318private:
1321
1325
1328
1330};
1331
1332
1333}; // namespace KIGFX
1334
1335#endif /* GRAPHICSABSTRACTIONLAYER_H_ */
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
BOX2< VECTOR2D > BOX2D
Definition box2.h:923
This class handle bitmap images in KiCad.
Definition bitmap_base.h:49
constexpr const Vec GetEnd() const
Definition box2.h:212
constexpr const Vec & GetOrigin() const
Definition box2.h:210
APPEARANCE m_Appearance
GAL(GAL_DISPLAY_OPTIONS &aOptions)
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:105
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
virtual COMMON_SETTINGS * GetCommonSettings() const
Definition pgm_base.cpp:547
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:44
#define GAL_API
Definition gal.h:28
MATRIX3x3< double > MATRIX3x3D
Definition matrix3x3.h:473
The Cairo implementation of the graphics abstraction layer.
Definition eda_group.h:33
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:36
@ TARGET_CACHED
Main rendering target (cached)
Definition definitions.h:37
PGM_BASE & Pgm()
The global program "get" accessor.
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:695
VECTOR2< double > VECTOR2D
Definition vector2d.h:694