KiCad PCB EDA Suite
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 (C) 2016-2017 Kicad Developers, see change_log.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/color4d.h>
37 #include <gal/definitions.h>
38 #include <gal/stroke_font.h>
40 #include <newstroke_font.h>
41 
42 class SHAPE_LINE_CHAIN;
43 class SHAPE_POLY_SET;
44 class BITMAP_BASE;
45 
46 namespace KIGFX
47 {
48 
60 {
61  // These friend declarations allow us to hide routines that should not be called. The
62  // corresponding RAII objects must be used instead.
63  friend class GAL_CONTEXT_LOCKER;
64  friend class GAL_UPDATE_CONTEXT;
65  friend class GAL_DRAWING_CONTEXT;
66 
67 public:
68  // Constructor / Destructor
69  GAL( GAL_DISPLAY_OPTIONS& aOptions );
70  virtual ~GAL();
71 
73  virtual bool IsInitialized() const { return true; }
74 
76  virtual bool IsVisible() const { return true; }
77 
79  virtual bool IsCairoEngine() { return false; }
80 
82  virtual bool IsOpenGlEngine() { return false; }
83 
84  // ---------------
85  // Drawing methods
86  // ---------------
87 
96  virtual void DrawLine( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint ) {};
97 
107  virtual void DrawSegment( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint, double aWidth ) {};
108 
114  virtual void DrawPolyline( const std::deque<VECTOR2D>& aPointList ) {};
115  virtual void DrawPolyline( const VECTOR2D aPointList[], int aListSize ) {};
116  virtual void DrawPolyline( const SHAPE_LINE_CHAIN& aLineChain ) {};
117 
124  virtual void DrawCircle( const VECTOR2D& aCenterPoint, double aRadius ) {};
125 
134  virtual void
135  DrawArc( const VECTOR2D& aCenterPoint, double aRadius, double aStartAngle, double aEndAngle ) {};
136 
153  virtual void
154  DrawArcSegment( const VECTOR2D& aCenterPoint, double aRadius, double aStartAngle,
155  double aEndAngle, double aWidth ) {};
156 
163  virtual void DrawRectangle( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint ) {};
164 
170  virtual void DrawPolygon( const std::deque<VECTOR2D>& aPointList ) {};
171  virtual void DrawPolygon( const VECTOR2D aPointList[], int aListSize ) {};
172  virtual void DrawPolygon( const SHAPE_POLY_SET& aPolySet ) {};
173  virtual void DrawPolygon( const SHAPE_LINE_CHAIN& aPolySet ) {};
174 
186  virtual void DrawCurve( const VECTOR2D& startPoint, const VECTOR2D& controlPointA,
187  const VECTOR2D& controlPointB, const VECTOR2D& endPoint,
188  double aFilterValue = 0.0 ) {};
189 
193  virtual void DrawBitmap( const BITMAP_BASE& aBitmap ) {};
194 
195  // --------------
196  // Screen methods
197  // --------------
198 
200  virtual void ResizeScreen( int aWidth, int aHeight ) {};
201 
203  virtual bool Show( bool aShow ) { return true; };
204 
207  {
208  return screenSize;
209  }
210 
212  virtual void Flush() {};
213 
214  void SetClearColor( const COLOR4D& aColor )
215  {
216  m_clearColor = aColor;
217  }
218 
219  const COLOR4D& GetClearColor( ) const
220  {
221  return m_clearColor;
222  }
223 
228  virtual void ClearScreen() {};
229 
230  // -----------------
231  // Attribute setting
232  // -----------------
233 
239  virtual void SetIsFill( bool aIsFillEnabled )
240  {
241  isFillEnabled = aIsFillEnabled;
242  }
243 
249  virtual void SetIsStroke( bool aIsStrokeEnabled )
250  {
251  isStrokeEnabled = aIsStrokeEnabled;
252  }
253 
259  virtual void SetFillColor( const COLOR4D& aColor )
260  {
261  fillColor = aColor;
262  }
263 
269  inline const COLOR4D& GetFillColor() const
270  {
271  return fillColor;
272  }
273 
279  virtual void SetStrokeColor( const COLOR4D& aColor )
280  {
281  strokeColor = aColor;
282  }
283 
289  inline const COLOR4D& GetStrokeColor() const
290  {
291  return strokeColor;
292  }
293 
299  virtual void SetLineWidth( float aLineWidth )
300  {
301  lineWidth = aLineWidth;
302  }
303 
309  inline float GetLineWidth() const
310  {
311  return lineWidth;
312  }
313 
319  virtual void SetLayerDepth( double aLayerDepth )
320  {
321  assert( aLayerDepth <= depthRange.y );
322  assert( aLayerDepth >= depthRange.x );
323 
324  layerDepth = aLayerDepth;
325  }
326 
327  // ----
328  // Text
329  // ----
330 
331  const STROKE_FONT& GetStrokeFont() const
332  {
333  return strokeFont;
334  }
335 
344  virtual void StrokeText( const wxString& aText, const VECTOR2D& aPosition,
345  double aRotationAngle, int aMarkupFlags = 0 )
346  {
347  strokeFont.Draw( aText, aPosition, aRotationAngle, aMarkupFlags );
348  }
349 
358  virtual void BitmapText( const wxString& aText, const VECTOR2D& aPosition,
359  double aRotationAngle )
360  {
361  // Fallback: use stroke font
362 
363  // Handle flipped view
364  if( globalFlipX )
366 
367  StrokeText( aText, aPosition, aRotationAngle );
368 
369  if( globalFlipX )
371  }
372 
381  VECTOR2D GetTextLineSize( const UTF8& aText, int aMarkupFlags = 0 ) const;
382 
389  {
391  }
392 
398  virtual void SetTextAttributes( const EDA_TEXT* aText );
399 
406  void ResetTextAttributes();
407 
413  inline void SetGlyphSize( const VECTOR2D aGlyphSize )
414  {
415  textProperties.m_glyphSize = aGlyphSize;
416  }
417 
421  const VECTOR2D& GetGlyphSize() const
422  {
424  }
425 
431  inline void SetFontBold( const bool aBold )
432  {
433  textProperties.m_bold = aBold;
434  }
435 
439  inline bool IsFontBold() const
440  {
441  return textProperties.m_bold;
442  }
443 
449  inline void SetFontItalic( const bool aItalic )
450  {
451  textProperties.m_italic = aItalic;
452  }
453 
457  inline bool IsFontItalic() const
458  {
459  return textProperties.m_italic;
460  }
461 
467  inline void SetTextMirrored( const bool aMirrored )
468  {
469  textProperties.m_mirrored = aMirrored;
470  }
471 
475  inline bool IsTextMirrored() const
476  {
477  return textProperties.m_mirrored;
478  }
479 
485  inline void SetHorizontalJustify( const EDA_TEXT_HJUSTIFY_T aHorizontalJustify )
486  {
487  textProperties.m_horizontalJustify = aHorizontalJustify;
488  }
489 
494  {
496  }
497 
503  inline void SetVerticalJustify( const EDA_TEXT_VJUSTIFY_T aVerticalJustify )
504  {
505  textProperties.m_verticalJustify = aVerticalJustify;
506  }
507 
512  {
514  }
515 
516 
517  // --------------
518  // Transformation
519  // --------------
520 
526  virtual void Transform( const MATRIX3x3D& aTransformation ) {};
527 
533  virtual void Rotate( double aAngle ) {};
534 
540  virtual void Translate( const VECTOR2D& aTranslation ) {};
541 
547  virtual void Scale( const VECTOR2D& aScale ) {};
548 
550  virtual void Save() {};
551 
553  virtual void Restore() {};
554 
555  // --------------------------------------------
556  // Group methods
557  // ---------------------------------------------
558 
567  virtual int BeginGroup() { return 0; };
568 
570  virtual void EndGroup() {};
571 
577  virtual void DrawGroup( int aGroupNumber ) {};
578 
585  virtual void ChangeGroupColor( int aGroupNumber, const COLOR4D& aNewColor ) {};
586 
593  virtual void ChangeGroupDepth( int aGroupNumber, int aDepth ) {};
594 
600  virtual void DeleteGroup( int aGroupNumber ) {};
601 
605  virtual void ClearCache() {};
606 
607  // --------------------------------------------------------
608  // Handling the world <-> screen transformation
609  // --------------------------------------------------------
610 
612  virtual void ComputeWorldScreenMatrix();
613 
620  {
621  return worldScreenMatrix;
622  }
623 
630  {
631  return screenWorldMatrix;
632  }
633 
639  inline void SetWorldScreenMatrix( const MATRIX3x3D& aMatrix )
640  {
641  worldScreenMatrix = aMatrix;
642  }
643 
653  inline void SetWorldUnitLength( double aWorldUnitLength )
654  {
655  worldUnitLength = aWorldUnitLength;
656  }
657 
658  inline void SetScreenSize( const VECTOR2I& aSize )
659  {
660  screenSize = aSize;
661  }
662 
671  inline void SetScreenDPI( double aScreenDPI )
672  {
673  screenDPI = aScreenDPI;
674  }
675 
683  inline void SetLookAtPoint( const VECTOR2D& aPoint )
684  {
685  lookAtPoint = aPoint;
686  }
687 
693  inline const VECTOR2D& GetLookAtPoint() const
694  {
695  return lookAtPoint;
696  }
697 
703  inline void SetZoomFactor( double aZoomFactor )
704  {
705  zoomFactor = aZoomFactor;
706  }
707 
713  inline double GetZoomFactor() const
714  {
715  return zoomFactor;
716  }
717 
723  void SetRotation( double aRotation )
724  {
725  rotation = aRotation;
726  }
727 
733  double GetRotation() const
734  {
735  return rotation;
736  }
737 
746  inline void SetDepthRange( const VECTOR2D& aDepthRange )
747  {
748  depthRange = aDepthRange;
749  }
750 
754  inline double GetMinDepth() const
755  {
756  return depthRange.x;
757  }
758 
762  inline double GetMaxDepth() const
763  {
764  return depthRange.y;
765  }
766 
772  inline double GetWorldScale() const
773  {
774  return worldScale;
775  }
776 
783  inline void SetFlip( bool xAxis, bool yAxis )
784  {
785  globalFlipX = xAxis;
786  globalFlipY = yAxis;
787  }
788 
792  bool IsFlippedX() const
793  {
794  return globalFlipX;
795  }
796 
800  bool IsFlippedY() const
801  {
802  return globalFlipY;
803  }
804 
805  // ---------------------------
806  // Buffer manipulation methods
807  // ---------------------------
808 
814  virtual void SetTarget( RENDER_TARGET aTarget ) {};
815 
821  virtual RENDER_TARGET GetTarget() const { return TARGET_CACHED; };
822 
828  virtual void ClearTarget( RENDER_TARGET aTarget ) {};
829 
841  virtual void SetNegativeDrawMode( bool aSetting ) {};
842 
843  // -------------
844  // Grid methods
845  // -------------
846 
852  inline void SetGridVisibility( bool aVisibility )
853  {
854  gridVisibility = aVisibility;
855  }
856 
862  inline void SetGridOrigin( const VECTOR2D& aGridOrigin )
863  {
864  gridOrigin = aGridOrigin;
865 
866  if( gridSize.x == 0.0 || gridSize.y == 0.0 )
867  gridOffset = VECTOR2D(0.0, 0.0);
868  else
869  gridOffset = VECTOR2D( (long) gridOrigin.x % (long) gridSize.x,
870  (long) gridOrigin.y % (long) gridSize.y );
871  }
872 
878  inline void SetGridSize( const VECTOR2D& aGridSize )
879  {
880  gridSize = aGridSize;
881 
882  gridOffset = VECTOR2D( (long) gridOrigin.x % (long) gridSize.x,
883  (long) gridOrigin.y % (long) gridSize.y );
884  }
885 
891  inline const VECTOR2D& GetGridSize() const
892  {
893  return gridSize;
894  }
895 
901  inline void SetGridColor( const COLOR4D& aGridColor )
902  {
903  gridColor = aGridColor;
904  }
905 
911  inline void SetAxesColor( const COLOR4D& aAxesColor )
912  {
913  axesColor = aAxesColor;
914  }
915 
919  inline void SetAxesEnabled( bool aAxesEnabled )
920  {
921  axesEnabled = aAxesEnabled;
922  }
923 
929  inline void SetCoarseGrid( int aInterval )
930  {
931  gridTick = aInterval;
932  }
933 
939  inline float GetGridLineWidth() const
940  {
941  return gridLineWidth;
942  }
943 
945  virtual void DrawGrid() {};
946 
954  VECTOR2D GetGridPoint( const VECTOR2D& aPoint ) const;
955 
962  inline VECTOR2D ToWorld( const VECTOR2D& aPoint ) const
963  {
964  return VECTOR2D( screenWorldMatrix * aPoint );
965  }
966 
973  inline VECTOR2D ToScreen( const VECTOR2D& aPoint ) const
974  {
975  return VECTOR2D( worldScreenMatrix * aPoint );
976  }
977 
983  inline void SetCursorEnabled( bool aCursorEnabled )
984  {
985  isCursorEnabled = aCursorEnabled;
986  }
987 
992  bool IsCursorEnabled() const
993  {
995  }
996 
1002  inline void SetCursorColor( const COLOR4D& aCursorColor )
1003  {
1004  cursorColor = aCursorColor;
1005  }
1006 
1012  virtual void DrawCursor( const VECTOR2D& aCursorPosition ) {};
1013 
1018  inline void AdvanceDepth()
1019  {
1020  layerDepth -= 0.05;
1021  }
1022 
1026  inline void PushDepth()
1027  {
1028  depthStack.push( layerDepth );
1029  }
1030 
1034  inline void PopDepth()
1035  {
1036  layerDepth = depthStack.top();
1037  depthStack.pop();
1038  }
1039 
1040  virtual void EnableDepthTest( bool aEnabled = false ) {};
1041 
1042 protected:
1043 
1046 
1047  std::stack<double> depthStack;
1049 
1051  double screenDPI;
1053 
1054  double zoomFactor;
1055  double rotation;
1058  double worldScale;
1059 
1062 
1063  float lineWidth;
1064 
1067 
1071 
1072  double layerDepth;
1074 
1075  // Grid settings
1084  int gridTick;
1087 
1089  // Cursor settings
1095 
1098 
1100  virtual void lockContext( int aClientCookie ) {}
1101 
1102  virtual void unlockContext( int aClientCookie ) {}
1103 
1106  virtual void beginUpdate() {}
1107 
1109  virtual void endUpdate() {}
1110 
1113  virtual void beginDrawing() {};
1114 
1117  virtual void endDrawing() {};
1118 
1120  inline void computeWorldScale()
1121  {
1123  }
1124 
1130  double computeMinGridSpacing() const;
1131 
1133  static const int MIN_DEPTH;
1134  static const int MAX_DEPTH;
1135 
1137  static const int GRID_DEPTH;
1138 
1142  COLOR4D getCursorColor() const;
1143 
1144  // ---------------
1145  // Settings observer interface
1146  // ---------------
1150  void OnGalDisplayOptionsChanged( const GAL_DISPLAY_OPTIONS& aOptions ) override;
1151 
1161  virtual bool updatedGalDisplayOptions( const GAL_DISPLAY_OPTIONS& aOptions );
1162 
1163 private:
1165  {
1169  bool m_bold;
1170  bool m_italic;
1172  } textProperties;
1173 };
1174 
1175 
1177 {
1178 public:
1180  m_gal( aGal )
1181  {
1182  m_cookie = rand();
1184  }
1185 
1187  {
1189  }
1190 
1191 protected:
1194 };
1195 
1196 
1198 {
1199 public:
1201  GAL_CONTEXT_LOCKER( aGal )
1202  {
1203  m_gal->beginUpdate();
1204  }
1205 
1207  {
1208  m_gal->endUpdate();
1209  }
1210 };
1211 
1212 
1214 {
1215 public:
1217  GAL_CONTEXT_LOCKER( aGal )
1218  {
1219  m_gal->beginDrawing();
1220  }
1221 
1223  {
1224  m_gal->endDrawing();
1225  }
1226 };
1227 
1228 
1229 }; // namespace KIGFX
1230 
1231 #endif /* GRAPHICSABSTRACTIONLAYER_H_ */
const STROKE_FONT & GetStrokeFont() const
static const int GRID_DEPTH
Depth level on which the grid is drawn.
int gridTick
Every tick line gets the double width.
virtual void SetFillColor(const COLOR4D &aColor)
Set the fill color.
UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to...
Definition: utf8.h:73
virtual void DrawGroup(int aGroupNumber)
Draw the stored group.
void SetFontItalic(const bool aItalic)
Set italic property of current font.
double GetMinDepth() const
Returns the minimum depth in the currently used range (the top).
virtual void DrawPolyline(const std::deque< VECTOR2D > &aPointList)
Draw a polyline.
double zoomFactor
The zoom factor.
STROKE_FONT strokeFont
Instance of object that stores information about how to draw texts.
float GetLineWidth() const
Get the line width.
VECTOR2D cursorPosition
Current cursor position (world coordinates)
virtual void DrawRectangle(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
Draw a rectangle.
void SetClearColor(const COLOR4D &aColor)
bool axesEnabled
Should the axes be drawn.
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:44
GRID_STYLE
GRID_STYLE: Type definition of the grid style.
VECTOR2D gridOffset
The grid offset to compensate cursor position.
double layerDepth
The actual layer depth.
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:131
virtual void DeleteGroup(int aGroupNumber)
Delete the group from the memory.
double GetMaxDepth() const
Returns the maximum depth in the currently used range (the bottom).
const MATRIX3x3D & GetScreenWorldMatrix() const
Get the screen <-> world transformation matrix.
virtual void BitmapText(const wxString &aText, const VECTOR2D &aPosition, double aRotationAngle)
Draws a text using a bitmap font.
bool IsTextMirrored() const
Returns true if text should displayed mirrored.
double computeMinGridSpacing() const
compute minimum grid spacing from the grid settings
bool isCursorEnabled
Is the cursor enabled?
void SetCursorEnabled(bool aCursorEnabled)
Enable/disable cursor.
const COLOR4D & GetFillColor() const
Get the fill color.
bool IsFlippedX() const
Return true if flip flag for the X axis is set.
virtual void SetTextAttributes(const EDA_TEXT *aText)
Loads attributes of the given text (bold/italic/underline/mirrored and so on).
int gridMinSpacing
Minimum screen size of the grid (pixels) below which the grid is not drawn.
VECTOR2D ToScreen(const VECTOR2D &aPoint) const
Compute the point position in screen coordinates from given world coordinates.
GRID_STYLE gridStyle
Grid display style.
virtual void DrawArc(const VECTOR2D &aCenterPoint, double aRadius, double aStartAngle, double aEndAngle)
Draw an arc.
GAL_DISPLAY_OPTIONS & options
double rotation
Rotation transformation (radians)
EDA_TEXT_VJUSTIFY_T m_verticalJustify
Vertical justification.
virtual void DrawPolygon(const SHAPE_POLY_SET &aPolySet)
void SetFlip(bool xAxis, bool yAxis)
Sets flipping of the screen.
virtual void DrawBitmap(const BITMAP_BASE &aBitmap)
Draw a bitmap image.
COLOR4D fillColor
The fill color.
VECTOR2D depthRange
Range of the depth.
virtual void endUpdate()
Disables item update mode.
virtual void Transform(const MATRIX3x3D &aTransformation)
Transform the context.
MATRIX3x3D screenWorldMatrix
Screen transformation.
bool globalFlipX
Flag for X axis flipping.
virtual void DrawLine(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
Draw a line.
void SetGridOrigin(const VECTOR2D &aGridOrigin)
Set the origin point for the grid.
virtual void ComputeWorldScreenMatrix()
Compute the world <-> screen transformation matrix.
EDA_TEXT_HJUSTIFY_T GetHorizontalJustify() const
Returns current text horizontal justification setting.
void SetScreenDPI(double aScreenDPI)
Set the dots per inch of the screen.
virtual void SetLayerDepth(double aLayerDepth)
Set the depth of the layer (position on the z-axis)
VECTOR2D lookAtPoint
Point to be looked at in world space.
virtual void SetLineWidth(float aLineWidth)
Set the line width.
virtual void EndGroup()
End the group.
virtual void Rotate(double aAngle)
Rotate the context.
This class handle bitmap images in KiCad.
Definition: bitmap_base.h:51
const VECTOR2D & GetGlyphSize() const
VECTOR2D GetGridPoint(const VECTOR2D &aPoint) const
Function GetGridPoint() For a given point it returns the nearest point belonging to the grid in world...
bool IsFontBold() const
Returns true if current font has 'bold' attribute enabled.
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:109
virtual void ChangeGroupColor(int aGroupNumber, const COLOR4D &aNewColor)
Changes the color used to draw the group.
static const int MIN_DEPTH
Possible depth range.
virtual RENDER_TARGET GetTarget() const
Gets the currently used target for rendering.
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
GAL(GAL_DISPLAY_OPTIONS &aOptions)
void SetFontBold(const bool aBold)
Set bold property of current font.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
const COLOR4D & GetStrokeColor() const
Get the stroke color.
COLOR4D cursorColor
Cursor color.
virtual void DrawSegment(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint, double aWidth)
Draw a rounded segment.
bool fullscreenCursor
Shape of the cursor (fullscreen or small cross)
void OnGalDisplayOptionsChanged(const GAL_DISPLAY_OPTIONS &aOptions) override
Handler for observer settings changes.
void ResetTextAttributes()
Reset text attributes to default styling.
bool isStrokeEnabled
Are the outlines stroked ?
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
virtual void SetIsFill(bool aIsFillEnabled)
Enable/disable fill.
float GetGridLineWidth() const
Get the grid line width.
void PopDepth()
Restores previously stored drawing depth for the depth stack.
SHAPE_POLY_SET.
COLOR4D axesColor
Color of the axes.
virtual int BeginGroup()
Begin a group.
virtual void beginUpdate()
Enables item update mode.
void SetAxesColor(const COLOR4D &aAxesColor)
Set the axes color.
virtual void ClearTarget(RENDER_TARGET aTarget)
Clears the target for rendering.
virtual void unlockContext(int aClientCookie)
void SetScreenSize(const VECTOR2I &aSize)
COLOR4D strokeColor
The color of the outlines.
float gridLineWidth
Line width of the grid.
virtual void DrawGrid()
std::stack< double > depthStack
Stored depth values.
virtual bool IsCairoEngine()
Returns true if the GAL engine is a cairo based type.
double worldUnitLength
The unit length of the world coordinates [inch].
virtual void DrawCursor(const VECTOR2D &aCursorPosition)
Draw the cursor.
virtual void StrokeText(const wxString &aText, const VECTOR2D &aPosition, double aRotationAngle, int aMarkupFlags=0)
Draws a vector type text using preloaded Newstroke font.
double GetZoomFactor() const
Get the zoom factor.
virtual bool IsOpenGlEngine()
Returns true if the GAL engine is a opengl based type.
bool IsFlippedY() const
Return true if flip flag for the Y axis is set.
VECTOR2D gridOrigin
The grid origin.
void SetTextMirrored(const bool aMirrored)
Set a mirrored property of text.
struct KIGFX::GAL::TEXT_PROPERTIES textProperties
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
void SetVerticalJustify(const EDA_TEXT_VJUSTIFY_T aVerticalJustify)
Set the vertical justify for text drawing.
const COLOR4D & GetClearColor() const
MATRIX3x3D worldScreenMatrix
World transformation.
virtual void DrawPolyline(const SHAPE_LINE_CHAIN &aLineChain)
void SetAxesEnabled(bool aAxesEnabled)
Enables drawing the axes.
virtual void ResizeScreen(int aWidth, int aHeight)
Resizes the canvas.
void SetGridSize(const VECTOR2D &aGridSize)
Set the grid size.
virtual void DrawPolygon(const SHAPE_LINE_CHAIN &aPolySet)
void SetWorldUnitLength(double aWorldUnitLength)
Set the unit length.
COLOR4D getCursorColor() const
Gets the actual cursor color to draw.
virtual void Flush()
Force all remaining objects to be drawn.
virtual bool updatedGalDisplayOptions(const GAL_DISPLAY_OPTIONS &aOptions)
Function updatedGalDisplayOptions.
virtual void Scale(const VECTOR2D &aScale)
Scale the context.
bool IsFontItalic() const
Returns true if current font has 'italic' attribute enabled.
EDA_TEXT_VJUSTIFY_T
Definition: eda_text.h:51
float lineWidth
The line width.
bool isFillEnabled
Is filling of graphic objects enabled ?
virtual bool Show(bool aShow)
Shows/hides the GAL canvas.
const VECTOR2D & GetGridSize() const
Returns the grid size.
void computeWorldScale()
Compute the scaling factor for the world->screen matrix.
virtual void ClearScreen()
Clear the screen.
VECTOR2D ToWorld(const VECTOR2D &aPoint) const
Compute the point position in world coordinates from given screen coordinates.
double computeOverbarVerticalPosition() const
Compute the vertical position of an overbar, sometimes used in texts.
const VECTOR2D & GetLookAtPoint() const
Get the look at point.
void SetWorldScreenMatrix(const MATRIX3x3D &aMatrix)
Set the world <-> screen transformation matrix.
virtual void SetStrokeColor(const COLOR4D &aColor)
Set the stroke color.
virtual void DrawPolyline(const VECTOR2D aPointList[], int aListSize)
void SetCoarseGrid(int aInterval)
Draw every tick line wider.
void PushDepth()
Stores current drawing depth on the depth stack.
COLOR4D gridColor
Color of the grid.
bool gridVisibility
Should the grid be shown.
virtual void Restore()
Restore the context.
virtual void DrawPolygon(const std::deque< VECTOR2D > &aPointList)
Draw a polygon.
Main rendering target (cached)
Definition: definitions.h:48
virtual void DrawCircle(const VECTOR2D &aCenterPoint, double aRadius)
Draw a circle using world coordinates.
void SetRotation(double aRotation)
Set the rotation angle.
bool globalFlipY
Flag for Y axis flipping.
EDA_TEXT_VJUSTIFY_T GetVerticalJustify() const
Returns current text vertical justification setting.
SHAPE_LINE_CHAIN.
double worldScale
The scale factor world->screen.
VECTOR2D gridSize
The grid size.
void Draw(const UTF8 &aText, const VECTOR2D &aPosition, double aRotationAngle, int markupFlags)
Draw a string.
VECTOR2I screenSize
Screen size in screen coordinates.
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.
void SetZoomFactor(double aZoomFactor)
Set the zoom factor of the scene.
virtual void ChangeGroupDepth(int aGroupNumber, int aDepth)
Changes the depth (Z-axis position) of the group.
void SetGridVisibility(bool aVisibility)
Sets the visibility setting of the grid.
void SetGlyphSize(const VECTOR2D aGlyphSize)
Set the font glyph size.
virtual void DrawArcSegment(const VECTOR2D &aCenterPoint, double aRadius, double aStartAngle, double aEndAngle, double aWidth)
Draw an arc segment.
void SetLookAtPoint(const VECTOR2D &aPoint)
Set the Point in world space to look at.
virtual void lockContext(int aClientCookie)
Private: use GAL_CONTEXT_LOCKER RAII object.
virtual void Save()
Save the context.
void SetHorizontalJustify(const EDA_TEXT_HJUSTIFY_T aHorizontalJustify)
Set the horizontal justify for text drawing.
RENDER_TARGET
RENDER_TARGET: Possible rendering targets.
Definition: definitions.h:46
const MATRIX3x3D & GetWorldScreenMatrix() const
Get the world <-> screen transformation matrix.
VECTOR2D m_glyphSize
Size of the glyphs.
double GetRotation() const
Get the rotation angle.
double GetWorldScale() const
Get the world scale.
virtual void Translate(const VECTOR2D &aTranslation)
Translate 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.
virtual void SetIsStroke(bool aIsStrokeEnabled)
Enable/disable stroked outlines.
void SetDepthRange(const VECTOR2D &aDepthRange)
Set the range of the layer depth.
bool IsCursorEnabled() const
Returns information about cursor visibility.
void AdvanceDepth()
Changes the current depth to deeper, so it is possible to draw objects right beneath other.
virtual void beginDrawing()
Begin the drawing, needs to be called for every new frame.
virtual void SetNegativeDrawMode(bool aSetting)
Sets negative draw mode in the renderer.
virtual void DrawPolygon(const VECTOR2D aPointList[], int aListSize)
Class STROKE_FONT implements stroke font drawing.
Definition: stroke_font.h:53
bool forceDisplayCursor
Always show cursor.
virtual void ClearCache()
Delete all data created during caching of graphic items.
double GetOverbarVerticalPosition() const
Compute the vertical position of an overbar, sometimes used in texts.
virtual bool IsInitialized() const
Returns the initalization status for the canvas.
virtual void endDrawing()
End the drawing, needs to be called for every new frame.
EDA_TEXT_HJUSTIFY_T m_horizontalJustify
Horizontal justification.
virtual void SetTarget(RENDER_TARGET aTarget)
Sets the target for rendering.
Class GAL is the abstract interface for drawing on a 2D-surface.
double screenDPI
The dots per inch of the screen.
VECTOR2D GetTextLineSize(const UTF8 &aText, int aMarkupFlags=0) const
Compute the X and Y size of a given text.
static const int MAX_DEPTH
virtual void EnableDepthTest(bool aEnabled=false)
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:40