KiCad PCB EDA Suite
KIGFX::CAIRO_PRINT_GAL Class Reference

#include <cairo_print.h>

Inheritance diagram for KIGFX::CAIRO_PRINT_GAL:
KIGFX::CAIRO_GAL_BASE KIGFX::GAL_PRINT KIGFX::GAL KIGFX::GAL_DISPLAY_OPTIONS_OBSERVER

Public Member Functions

 CAIRO_PRINT_GAL (GAL_DISPLAY_OPTIONS &aDisplayOptions, std::unique_ptr< CAIRO_PRINT_CTX > aContext)
 
void SetLineWidth (float aLineWidth) override
 Set the line width. More...
 
void ComputeWorldScreenMatrix () override
 Compute the world <-> screen transformation matrix. More...
 
GALGetGAL () override
 
PRINT_CONTEXTGetPrintCtx () const override
 
void SetNativePaperSize (const VECTOR2D &aSize, bool aRotateIfLandscape) override
 
void SetSheetSize (const VECTOR2D &aSize) override
 
virtual bool IsCairoEngine () override
 Returns true if the GAL engine is a cairo based type. More...
 
virtual void DrawLine (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint) override
 Draw a line. More...
 
virtual void DrawSegment (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint, double aWidth) override
 Draw a rounded segment. More...
 
virtual void DrawCircle (const VECTOR2D &aCenterPoint, double aRadius) override
 Draw a circle using world coordinates. More...
 
virtual void DrawArc (const VECTOR2D &aCenterPoint, double aRadius, double aStartAngle, double aEndAngle) override
 Draw an arc. More...
 
virtual void DrawArcSegment (const VECTOR2D &aCenterPoint, double aRadius, double aStartAngle, double aEndAngle, double aWidth) override
 Draw an arc segment. More...
 
virtual void DrawRectangle (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint) override
 Draw a rectangle. More...
 
virtual void DrawPolyline (const std::deque< VECTOR2D > &aPointList) override
 Draw a polyline. More...
 
virtual void DrawPolyline (const VECTOR2D aPointList[], int aListSize) override
 
virtual void DrawPolyline (const SHAPE_LINE_CHAIN &aLineChain) override
 
virtual void DrawPolygon (const std::deque< VECTOR2D > &aPointList) override
 Draw a polygon. More...
 
virtual void DrawPolygon (const VECTOR2D aPointList[], int aListSize) override
 
virtual void DrawPolygon (const SHAPE_POLY_SET &aPolySet) override
 
virtual void DrawPolygon (const SHAPE_LINE_CHAIN &aPolySet) override
 
virtual void DrawCurve (const VECTOR2D &startPoint, const VECTOR2D &controlPointA, const VECTOR2D &controlPointB, const VECTOR2D &endPoint) override
 Draw a cubic bezier spline. More...
 
virtual void DrawBitmap (const BITMAP_BASE &aBitmap) override
 Draw a bitmap image. More...
 
virtual void ResizeScreen (int aWidth, int aHeight) override
 Resizes the canvas. More...
 
virtual void Flush () override
 Force all remaining objects to be drawn. More...
 
virtual void ClearScreen () override
 Clear the screen. More...
 
virtual void SetIsFill (bool aIsFillEnabled) override
 Enable/disable fill. More...
 
virtual void SetIsStroke (bool aIsStrokeEnabled) override
 Enable/disable stroked outlines. More...
 
virtual void SetStrokeColor (const COLOR4D &aColor) override
 Set the stroke color. More...
 
virtual void SetFillColor (const COLOR4D &aColor) override
 Set the fill color. More...
 
virtual void SetLayerDepth (double aLayerDepth) override
 Set the depth of the layer (position on the z-axis) More...
 
virtual void Transform (const MATRIX3x3D &aTransformation) override
 Transform the context. More...
 
virtual void Rotate (double aAngle) override
 Rotate the context. More...
 
virtual void Translate (const VECTOR2D &aTranslation) override
 Translate the context. More...
 
virtual void Scale (const VECTOR2D &aScale) override
 Scale the context. More...
 
virtual void Save () override
 Save the context. More...
 
virtual void Restore () override
 Restore the context. More...
 
virtual int BeginGroup () override
 Begin a group. More...
 
virtual void EndGroup () override
 End the group. More...
 
virtual void DrawGroup (int aGroupNumber) override
 Draw the stored group. More...
 
virtual void ChangeGroupColor (int aGroupNumber, const COLOR4D &aNewColor) override
 Changes the color used to draw the group. More...
 
virtual void ChangeGroupDepth (int aGroupNumber, int aDepth) override
 Changes the depth (Z-axis position) of the group. More...
 
virtual void DeleteGroup (int aGroupNumber) override
 Delete the group from the memory. More...
 
virtual void ClearCache () override
 Delete all data created during caching of graphic items. More...
 
virtual void SetNegativeDrawMode (bool aSetting) override
 Sets negative draw mode in the renderer. More...
 
virtual void DrawCursor (const VECTOR2D &aCursorPosition) override
 Draw the cursor. More...
 
virtual void EnableDepthTest (bool aEnabled=false) override
 
virtual bool IsInitialized () const
 Returns the initalization status for the canvas. More...
 
virtual bool IsVisible () const
 Returns true if the GAL canvas is visible on the screen. More...
 
virtual bool IsOpenGlEngine ()
 Returns true if the GAL engine is a opengl based type. More...
 
virtual bool Show (bool aShow)
 Shows/hides the GAL canvas. More...
 
const VECTOR2IGetScreenPixelSize () const
 Returns GAL canvas size in pixels. More...
 
void SetClearColor (const COLOR4D &aColor)
 
const COLOR4DGetClearColor () const
 
const COLOR4DGetFillColor () const
 Get the fill color. More...
 
const COLOR4DGetStrokeColor () const
 Get the stroke color. More...
 
float GetLineWidth () const
 Get the line width. More...
 
const STROKE_FONTGetStrokeFont () const
 
virtual void StrokeText (const wxString &aText, const VECTOR2D &aPosition, double aRotationAngle)
 Draws a vector type text using preloaded Newstroke font. More...
 
virtual void BitmapText (const wxString &aText, const VECTOR2D &aPosition, double aRotationAngle)
 Draws a text using a bitmap font. More...
 
VECTOR2D GetTextLineSize (const UTF8 &aText) const
 Compute the X and Y size of a given text. More...
 
double GetOverbarVerticalPosition () const
 Compute the vertical position of an overbar, sometimes used in texts. More...
 
virtual void SetTextAttributes (const EDA_TEXT *aText)
 Loads attributes of the given text (bold/italic/underline/mirrored and so on). More...
 
void ResetTextAttributes ()
 Reset text attributes to default styling. More...
 
void SetGlyphSize (const VECTOR2D aGlyphSize)
 Set the font glyph size. More...
 
const VECTOR2DGetGlyphSize () const
 
void SetFontBold (const bool aBold)
 Set bold property of current font. More...
 
bool IsFontBold () const
 Returns true if current font has 'bold' attribute enabled. More...
 
void SetFontItalic (const bool aItalic)
 Set italic property of current font. More...
 
bool IsFontItalic () const
 Returns true if current font has 'italic' attribute enabled. More...
 
void SetTextMirrored (const bool aMirrored)
 Set a mirrored property of text. More...
 
bool IsTextMirrored () const
 Returns true if text should displayed mirrored. More...
 
void SetHorizontalJustify (const EDA_TEXT_HJUSTIFY_T aHorizontalJustify)
 Set the horizontal justify for text drawing. More...
 
EDA_TEXT_HJUSTIFY_T GetHorizontalJustify () const
 Returns current text horizontal justification setting. More...
 
void SetVerticalJustify (const EDA_TEXT_VJUSTIFY_T aVerticalJustify)
 Set the vertical justify for text drawing. More...
 
EDA_TEXT_VJUSTIFY_T GetVerticalJustify () const
 Returns current text vertical justification setting. More...
 
const MATRIX3x3DGetWorldScreenMatrix () const
 Get the world <-> screen transformation matrix. More...
 
const MATRIX3x3DGetScreenWorldMatrix () const
 Get the screen <-> world transformation matrix. More...
 
void SetWorldScreenMatrix (const MATRIX3x3D &aMatrix)
 Set the world <-> screen transformation matrix. More...
 
void SetWorldUnitLength (double aWorldUnitLength)
 Set the unit length. More...
 
void SetScreenSize (const VECTOR2I &aSize)
 
void SetScreenDPI (double aScreenDPI)
 Set the dots per inch of the screen. More...
 
void SetLookAtPoint (const VECTOR2D &aPoint)
 Set the Point in world space to look at. More...
 
const VECTOR2DGetLookAtPoint () const
 Get the look at point. More...
 
void SetZoomFactor (double aZoomFactor)
 Set the zoom factor of the scene. More...
 
double GetZoomFactor () const
 Get the zoom factor. More...
 
void SetRotation (double aRotation)
 Set the rotation angle. More...
 
double GetRotation () const
 Get the rotation angle. More...
 
void SetDepthRange (const VECTOR2D &aDepthRange)
 Set the range of the layer depth. More...
 
double GetMinDepth () const
 Returns the minimum depth in the currently used range (the top). More...
 
double GetMaxDepth () const
 Returns the maximum depth in the currently used range (the bottom). More...
 
double GetWorldScale () const
 Get the world scale. More...
 
void SetFlip (bool xAxis, bool yAxis)
 Sets flipping of the screen. More...
 
bool IsFlippedX () const
 Return true if flip flag for the X axis is set. More...
 
bool IsFlippedY () const
 Return true if flip flag for the Y axis is set. More...
 
virtual void SaveScreen ()
 Save the screen contents. More...
 
virtual void RestoreScreen ()
 Restore the screen contents. More...
 
virtual void SetTarget (RENDER_TARGET aTarget)
 Sets the target for rendering. More...
 
virtual RENDER_TARGET GetTarget () const
 Gets the currently used target for rendering. More...
 
virtual void ClearTarget (RENDER_TARGET aTarget)
 Clears the target for rendering. More...
 
void SetGridVisibility (bool aVisibility)
 Sets the visibility setting of the grid. More...
 
void SetGridOrigin (const VECTOR2D &aGridOrigin)
 Set the origin point for the grid. More...
 
void SetGridSize (const VECTOR2D &aGridSize)
 Set the grid size. More...
 
const VECTOR2DGetGridSize () const
 Returns the grid size. More...
 
void SetGridColor (const COLOR4D &aGridColor)
 Set the grid color. More...
 
void SetAxesColor (const COLOR4D &aAxesColor)
 Set the axes color. More...
 
void SetAxesEnabled (bool aAxesEnabled)
 Enables drawing the axes. More...
 
void SetCoarseGrid (int aInterval)
 Draw every tick line wider. More...
 
float GetGridLineWidth () const
 Get the grid line width. More...
 
virtual void DrawGrid ()
 > More...
 
VECTOR2D GetGridPoint (const VECTOR2D &aPoint) const
 Function GetGridPoint() For a given point it returns the nearest point belonging to the grid in world coordinates. More...
 
VECTOR2D ToWorld (const VECTOR2D &aPoint) const
 Compute the point position in world coordinates from given screen coordinates. More...
 
VECTOR2D ToScreen (const VECTOR2D &aPoint) const
 Compute the point position in screen coordinates from given world coordinates. More...
 
void SetCursorEnabled (bool aCursorEnabled)
 Enable/disable cursor. More...
 
bool IsCursorEnabled () const
 Returns information about cursor visibility. More...
 
void SetCursorColor (const COLOR4D &aCursorColor)
 Set the cursor color. More...
 
void AdvanceDepth ()
 Changes the current depth to deeper, so it is possible to draw objects right beneath other. More...
 
void PushDepth ()
 Stores current drawing depth on the depth stack. More...
 
void PopDepth ()
 Restores previously stored drawing depth for the depth stack. More...
 

Protected Types

enum  GRAPHICS_COMMAND {
  CMD_SET_FILL, CMD_SET_STROKE, CMD_SET_FILLCOLOR, CMD_SET_STROKECOLOR,
  CMD_SET_LINE_WIDTH, CMD_STROKE_PATH, CMD_FILL_PATH, CMD_ROTATE,
  CMD_TRANSLATE, CMD_SCALE, CMD_SAVE, CMD_RESTORE,
  CMD_CALL_GROUP
}
 Definitions for the command recorder. More...
 
typedef GAL super
 Super class definition. More...
 
typedef std::deque< GROUP_ELEMENTGROUP
 A graphic group type definition. More...
 

Protected Member Functions

virtual void beginDrawing () override
 
virtual void endDrawing () override
 
void resetContext ()
 
virtual void drawGridLine (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint) override
 Draw a grid line (usually a simplified line function). More...
 
void flushPath ()
 
void storePath ()
 Store the actual path. More...
 
virtual void blitCursor (wxMemoryDC &clientDC)
 Blits cursor into the current screen. More...
 
void drawPoly (const std::deque< VECTOR2D > &aPointList)
 Drawing polygons & polylines is the same in cairo, so here is the common code. More...
 
void drawPoly (const VECTOR2D aPointList[], int aListSize)
 
void drawPoly (const SHAPE_LINE_CHAIN &aLineChain)
 
unsigned int getNewGroupNumber ()
 Returns a valid key that can be used as a new group number. More...
 
virtual void lockContext (int aClientCookie)
 Private: use GAL_CONTEXT_LOCKER RAII object. More...
 
virtual void unlockContext (int aClientCookie)
 
virtual void beginUpdate ()
 Enables item update mode. More...
 
virtual void endUpdate ()
 Disables item update mode. More...
 
void computeWorldScale ()
 Compute the scaling factor for the world->screen matrix. More...
 
double computeMinGridSpacing () const
 compute minimum grid spacing from the grid settings More...
 
COLOR4D getCursorColor () const
 Gets the actual cursor color to draw. More...
 
void OnGalDisplayOptionsChanged (const GAL_DISPLAY_OPTIONS &aOptions) override
 Handler for observer settings changes. More...
 
virtual bool updatedGalDisplayOptions (const GAL_DISPLAY_OPTIONS &aOptions)
 Function updatedGalDisplayOptions. More...
 

Protected Attributes

bool isGrouping
 Is grouping enabled ? More...
 
bool isElementAdded
 Was an graphic element added ? More...
 
std::map< int, GROUPgroups
 List of graphic groups. More...
 
unsigned int groupCounter
 Counter used for generating keys for groups. More...
 
GROUPcurrentGroup
 Currently used group. More...
 
cairo_matrix_t cairoWorldScreenMatrix
 Cairo world to screen transformation matrix. More...
 
cairo_t * currentContext
 Currently used Cairo context for drawing. More...
 
cairo_t * context
 Cairo image. More...
 
cairo_surface_t * surface
 Cairo surface. More...
 
GAL_DISPLAY_OPTIONSoptions
 
UTIL::LINK observerLink
 
std::stack< double > depthStack
 Stored depth values. More...
 
VECTOR2I screenSize
 Screen size in screen coordinates. More...
 
double worldUnitLength
 The unit length of the world coordinates [inch]. More...
 
double screenDPI
 The dots per inch of the screen. More...
 
VECTOR2D lookAtPoint
 Point to be looked at in world space. More...
 
double zoomFactor
 The zoom factor. More...
 
double rotation
 Rotation transformation (radians) More...
 
MATRIX3x3D worldScreenMatrix
 World transformation. More...
 
MATRIX3x3D screenWorldMatrix
 Screen transformation. More...
 
double worldScale
 The scale factor world->screen. More...
 
bool globalFlipX
 Flag for X axis flipping. More...
 
bool globalFlipY
 Flag for Y axis flipping. More...
 
float lineWidth
 The line width. More...
 
bool isFillEnabled
 Is filling of graphic objects enabled ? More...
 
bool isStrokeEnabled
 Are the outlines stroked ? More...
 
COLOR4D fillColor
 The fill color. More...
 
COLOR4D strokeColor
 The color of the outlines. More...
 
COLOR4D m_clearColor
 
double layerDepth
 The actual layer depth. More...
 
VECTOR2D depthRange
 Range of the depth. More...
 
bool gridVisibility
 Should the grid be shown. More...
 
GRID_STYLE gridStyle
 Grid display style. More...
 
VECTOR2D gridSize
 The grid size. More...
 
VECTOR2D gridOrigin
 The grid origin. More...
 
VECTOR2D gridOffset
 The grid offset to compensate cursor position. More...
 
COLOR4D gridColor
 Color of the grid. More...
 
COLOR4D axesColor
 Color of the axes. More...
 
bool axesEnabled
 Should the axes be drawn. More...
 
int gridTick
 Every tick line gets the double width. More...
 
float gridLineWidth
 Line width of the grid. More...
 
int gridMinSpacing
 Minimum screen size of the grid (pixels) below which the grid is not drawn. More...
 
bool isCursorEnabled
 Is the cursor enabled? More...
 
bool forceDisplayCursor
 Always show cursor. More...
 
COLOR4D cursorColor
 Cursor color. More...
 
bool fullscreenCursor
 Shape of the cursor (fullscreen or small cross) More...
 
VECTOR2D cursorPosition
 Current cursor position (world coordinates) More...
 
STROKE_FONT strokeFont
 Instance of object that stores information about how to draw texts. More...
 

Static Protected Attributes

static const int MAX_CAIRO_ARGUMENTS = 4
 Maximum number of arguments for one command. More...
 
static constexpr cairo_format_t GAL_FORMAT = CAIRO_FORMAT_RGB24
 Format used to store pixels. More...
 
static const int MIN_DEPTH = -1024
 Possible depth range. More...
 
static const int MAX_DEPTH = 1023
 
static const int GRID_DEPTH = MAX_DEPTH - 1
 Depth level on which the grid is drawn. More...
 

Private Member Functions

bool isLandscape () const
 

Returns true if page orientation is landscape

More...
 

Private Attributes

VECTOR2D m_nativePaperSize
 

Printout size

More...
 
bool m_hasNativeLandscapeRotation
 

Flag indicating whether the platform rotates page automatically or GAL needs to handle it in the transformation matrix

More...
 
std::unique_ptr< CAIRO_PRINT_CTXm_printCtx
 

Detailed Description

Definition at line 79 of file cairo_print.h.

Member Typedef Documentation

◆ GROUP

typedef std::deque<GROUP_ELEMENT> KIGFX::CAIRO_GAL_BASE::GROUP
protectedinherited

A graphic group type definition.

Definition at line 268 of file cairo_gal.h.

◆ super

typedef GAL KIGFX::CAIRO_GAL_BASE::super
protectedinherited

Super class definition.

Definition at line 229 of file cairo_gal.h.

Member Enumeration Documentation

◆ GRAPHICS_COMMAND

enum KIGFX::CAIRO_GAL_BASE::GRAPHICS_COMMAND
protectedinherited

Definitions for the command recorder.

Enumerator
CMD_SET_FILL 

Enable/disable filling.

CMD_SET_STROKE 

Enable/disable stroking.

CMD_SET_FILLCOLOR 

Set the fill color.

CMD_SET_STROKECOLOR 

Set the stroke color.

CMD_SET_LINE_WIDTH 

Set the line width.

CMD_STROKE_PATH 

Set the stroke path.

CMD_FILL_PATH 

Set the fill path.

CMD_ROTATE 

Rotate the context.

CMD_TRANSLATE 

Translate the context.

CMD_SCALE 

Scale the context.

CMD_SAVE 

Save the transformation matrix.

CMD_RESTORE 

Restore the transformation matrix.

CMD_CALL_GROUP 

Call a group.

Definition at line 235 of file cairo_gal.h.

236  {
237  CMD_SET_FILL,
243  CMD_FILL_PATH,
244  //CMD_TRANSFORM, ///< Transform the actual context
245  CMD_ROTATE,
246  CMD_TRANSLATE,
247  CMD_SCALE,
248  CMD_SAVE,
249  CMD_RESTORE,
251  };
Rotate the context.
Definition: cairo_gal.h:245
Enable/disable filling.
Definition: cairo_gal.h:237
Save the transformation matrix.
Definition: cairo_gal.h:248
Translate the context.
Definition: cairo_gal.h:246
Enable/disable stroking.
Definition: cairo_gal.h:238
Restore the transformation matrix.
Definition: cairo_gal.h:249

Constructor & Destructor Documentation

◆ CAIRO_PRINT_GAL()

CAIRO_PRINT_GAL::CAIRO_PRINT_GAL ( GAL_DISPLAY_OPTIONS aDisplayOptions,
std::unique_ptr< CAIRO_PRINT_CTX aContext 
)

Definition at line 113 of file cairo_print.cpp.

References KIGFX::CAIRO_GAL_BASE::context, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::GAL::m_clearColor, m_hasNativeLandscapeRotation, m_printCtx, KIGFX::CAIRO_GAL_BASE::resetContext(), KIGFX::GAL::SetScreenDPI(), and KIGFX::CAIRO_GAL_BASE::surface.

115  : CAIRO_GAL_BASE( aDisplayOptions )
116 {
117  m_printCtx = std::move( aContext );
118  context = currentContext = m_printCtx->GetContext();
119  surface = m_printCtx->GetSurface();
120  cairo_reference( context );
121  cairo_surface_reference( surface );
122  m_clearColor = COLOR4D( 1.0, 1.0, 1.0, 1.0 );
124  resetContext();
125  SetScreenDPI( m_printCtx->GetNativeDPI() );
126 }
cairo_surface_t * surface
Cairo surface.
Definition: cairo_gal.h:276
CAIRO_GAL_BASE(GAL_DISPLAY_OPTIONS &aDisplayOptions)
Definition: cairo_gal.cpp:46
void SetScreenDPI(double aScreenDPI)
Set the dots per inch of the screen.
std::unique_ptr< CAIRO_PRINT_CTX > m_printCtx
Definition: cairo_print.h:125
cairo_t * context
Cairo image.
Definition: cairo_gal.h:275
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
bool m_hasNativeLandscapeRotation
Flag indicating whether the platform rotates page automatically or GAL needs to handle it in the tran...
Definition: cairo_print.h:123
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

Member Function Documentation

◆ AdvanceDepth()

void KIGFX::GAL::AdvanceDepth ( )
inlineinherited

Changes the current depth to deeper, so it is possible to draw objects right beneath other.

Definition at line 1020 of file graphics_abstraction_layer.h.

References KIGFX::GAL::layerDepth.

Referenced by KIGFX::VIEW_GROUP::ViewDraw().

1021  {
1022  layerDepth -= 0.05;
1023  }
double layerDepth
The actual layer depth.

◆ beginDrawing()

void CAIRO_GAL_BASE::beginDrawing ( )
overrideprotectedvirtualinherited

Reimplemented from KIGFX::GAL.

Reimplemented in KIGFX::CAIRO_GAL.

Definition at line 79 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::resetContext().

Referenced by KIGFX::CAIRO_GAL::beginDrawing().

80 {
81  resetContext();
82 }

◆ BeginGroup()

int CAIRO_GAL_BASE::BeginGroup ( )
overridevirtualinherited

Begin a group.

A group is a collection of graphic items. Hierarchical groups are possible, attributes and transformations can be used.

Returns
the number of the group.

Reimplemented from KIGFX::GAL.

Reimplemented in KIGFX::CAIRO_GAL.

Definition at line 561 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::CAIRO_GAL_BASE::getNewGroupNumber(), KIGFX::CAIRO_GAL_BASE::groups, KIGFX::CAIRO_GAL_BASE::isGrouping, and KIGFX::CAIRO_GAL_BASE::storePath().

Referenced by KIGFX::CAIRO_GAL::BeginGroup().

562 {
563  // If the grouping is started: the actual path is stored in the group, when
564  // a attribute was changed or when grouping stops with the end group method.
565  storePath();
566 
567  GROUP group;
568  int groupNumber = getNewGroupNumber();
569  groups.insert( std::make_pair( groupNumber, group ) );
570  currentGroup = &groups[groupNumber];
571  isGrouping = true;
572 
573  return groupNumber;
574 }
std::deque< GROUP_ELEMENT > GROUP
A graphic group type definition.
Definition: cairo_gal.h:268
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:271
std::map< int, GROUP > groups
List of graphic groups.
Definition: cairo_gal.h:269
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:266
unsigned int getNewGroupNumber()
Returns a valid key that can be used as a new group number.
Definition: cairo_gal.cpp:929

◆ beginUpdate()

virtual void KIGFX::GAL::beginUpdate ( )
inlineprotectedvirtualinherited

Enables item update mode.

Private: use GAL_UPDATE_CONTEXT RAII object

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1108 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL_UPDATE_CONTEXT::GAL_UPDATE_CONTEXT().

1108 {}

◆ BitmapText()

virtual void KIGFX::GAL::BitmapText ( const wxString &  aText,
const VECTOR2D aPosition,
double  aRotationAngle 
)
inlinevirtualinherited

Draws a text using a bitmap font.

It should be faster than StrokeText(), but can be used only for non-Gerber elements.

Parameters
aTextis the text to be drawn.
aPositionis the text position in world coordinates.
aRotationAngleis the text rotation angle.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 351 of file graphics_abstraction_layer.h.

References KIGFX::GAL::globalFlipX, KIGFX::GAL::TEXT_PROPERTIES::m_mirrored, KIGFX::GAL::StrokeText(), and KIGFX::GAL::textProperties.

Referenced by KIGFX::GERBVIEW_PAINTER::draw(), and KIGFX::PCB_PAINTER::draw().

353  {
354  // Fallback: use stroke font
355 
356  // Handle flipped view
357  if( globalFlipX )
359 
360  StrokeText( aText, aPosition, aRotationAngle );
361 
362  if( globalFlipX )
364  }
bool globalFlipX
Flag for X axis flipping.
virtual void StrokeText(const wxString &aText, const VECTOR2D &aPosition, double aRotationAngle)
Draws a vector type text using preloaded Newstroke font.
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

◆ blitCursor()

void CAIRO_GAL_BASE::blitCursor ( wxMemoryDC &  clientDC)
protectedvirtualinherited

Blits cursor into the current screen.

Definition at line 852 of file cairo_gal.cpp.

References color, KIGFX::GAL::cursorPosition, KIGFX::GAL::fullscreenCursor, KIGFX::GAL::getCursorColor(), KIGFX::GAL::IsCursorEnabled(), and KIGFX::GAL::ToScreen().

Referenced by KIGFX::CAIRO_GAL::endDrawing().

853 {
854  if( !IsCursorEnabled() )
855  return;
856 
857  auto p = ToScreen( cursorPosition );
858 
859  const auto cColor = getCursorColor();
860  const int cursorSize = fullscreenCursor ? 8000 : 80;
861 
862  wxColour color( cColor.r * cColor.a * 255, cColor.g * cColor.a * 255,
863  cColor.b * cColor.a * 255, 255 );
864  clientDC.SetPen( wxPen( color ) );
865  clientDC.DrawLine( p.x - cursorSize / 2, p.y, p.x + cursorSize / 2, p.y );
866  clientDC.DrawLine( p.x, p.y - cursorSize / 2, p.x, p.y + cursorSize / 2 );
867 }
VECTOR2D cursorPosition
Current cursor position (world coordinates)
VECTOR2D ToScreen(const VECTOR2D &aPoint) const
Compute the point position in screen coordinates from given world coordinates.
int color
Definition: DXF_plotter.cpp:62
bool fullscreenCursor
Shape of the cursor (fullscreen or small cross)
COLOR4D getCursorColor() const
Gets the actual cursor color to draw.
bool IsCursorEnabled() const
Returns information about cursor visibility.

◆ ChangeGroupColor()

void CAIRO_GAL_BASE::ChangeGroupColor ( int  aGroupNumber,
const COLOR4D aNewColor 
)
overridevirtualinherited

Changes the color used to draw the group.

Parameters
aGroupNumberis the group number.
aNewColoris the new color.

Reimplemented from KIGFX::GAL.

Definition at line 674 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::CMD_SET_FILLCOLOR, KIGFX::CAIRO_GAL_BASE::CMD_SET_STROKECOLOR, KIGFX::COLOR4D::g, KIGFX::CAIRO_GAL_BASE::groups, KIGFX::COLOR4D::r, and KIGFX::CAIRO_GAL_BASE::storePath().

675 {
676  storePath();
677 
678  for( GROUP::iterator it = groups[aGroupNumber].begin();
679  it != groups[aGroupNumber].end(); ++it )
680  {
681  if( it->command == CMD_SET_FILLCOLOR || it->command == CMD_SET_STROKECOLOR )
682  {
683  it->argument.dblArg[0] = aNewColor.r;
684  it->argument.dblArg[1] = aNewColor.g;
685  it->argument.dblArg[2] = aNewColor.b;
686  it->argument.dblArg[3] = aNewColor.a;
687  }
688  }
689 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
double g
Green component.
Definition: color4d.h:288
double b
Blue component.
Definition: color4d.h:289
double a
Alpha component.
Definition: color4d.h:290
std::map< int, GROUP > groups
List of graphic groups.
Definition: cairo_gal.h:269
double r
Red component.
Definition: color4d.h:287

◆ ChangeGroupDepth()

void CAIRO_GAL_BASE::ChangeGroupDepth ( int  aGroupNumber,
int  aDepth 
)
overridevirtualinherited

Changes the depth (Z-axis position) of the group.

Parameters
aGroupNumberis the group number.
aDepthis the new depth.

Reimplemented from KIGFX::GAL.

Definition at line 692 of file cairo_gal.cpp.

693 {
694  // Cairo does not have any possibilities to change the depth coordinate of stored items,
695  // it depends only on the order of drawing
696 }

◆ ClearCache()

void CAIRO_GAL_BASE::ClearCache ( )
overridevirtualinherited

Delete all data created during caching of graphic items.

Reimplemented from KIGFX::GAL.

Definition at line 719 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::DeleteGroup(), KIGFX::CAIRO_GAL_BASE::groups, and i.

Referenced by KIGFX::CAIRO_GAL_BASE::~CAIRO_GAL_BASE().

720 {
721  for( int i = groups.size() - 1; i >= 0; --i )
722  {
723  DeleteGroup( i );
724  }
725 }
virtual void DeleteGroup(int aGroupNumber) override
Delete the group from the memory.
Definition: cairo_gal.cpp:699
std::map< int, GROUP > groups
List of graphic groups.
Definition: cairo_gal.h:269
size_t i
Definition: json11.cpp:597

◆ ClearScreen()

void CAIRO_GAL_BASE::ClearScreen ( )
overridevirtualinherited

Clear the screen.

Parameters
aColoris the color used for clearing.

Reimplemented from KIGFX::GAL.

Definition at line 351 of file cairo_gal.cpp.

References KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::COLOR4D::g, KIGFX::GAL::m_clearColor, KIGFX::COLOR4D::r, KIGFX::GAL::screenSize, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by KIGFX::CAIRO_GAL_BASE::resetContext().

352 {
353  cairo_set_source_rgb( currentContext, m_clearColor.r, m_clearColor.g, m_clearColor.b );
354  cairo_rectangle( currentContext, 0.0, 0.0, screenSize.x, screenSize.y );
355  cairo_fill( currentContext );
356 }
double g
Green component.
Definition: color4d.h:288
double b
Blue component.
Definition: color4d.h:289
VECTOR2I screenSize
Screen size in screen coordinates.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
double r
Red component.
Definition: color4d.h:287

◆ ClearTarget()

virtual void KIGFX::GAL::ClearTarget ( RENDER_TARGET  aTarget)
inlinevirtualinherited

Clears the target for rendering.

Parameters
aTargetis the target to be cleared.

Reimplemented in KIGFX::CAIRO_GAL, and KIGFX::OPENGL_GAL.

Definition at line 830 of file graphics_abstraction_layer.h.

Referenced by KIGFX::VIEW::ClearTargets().

830 {};

◆ computeMinGridSpacing()

double GAL::computeMinGridSpacing ( ) const
protectedinherited

compute minimum grid spacing from the grid settings

Returns
the minimum spacing to use for drawing the grid

Definition at line 208 of file graphics_abstraction_layer.cpp.

References KIGFX::GAL::gridMinSpacing.

Referenced by KIGFX::OPENGL_GAL::DrawGrid(), and KIGFX::GAL::DrawGrid().

209 {
210  // just return the current value. This could be cleverer and take
211  // into account other settings in future
212  return gridMinSpacing;
213 }
int gridMinSpacing
Minimum screen size of the grid (pixels) below which the grid is not drawn.

◆ computeWorldScale()

void KIGFX::GAL::computeWorldScale ( )
inlineprotectedinherited

Compute the scaling factor for the world->screen matrix.

Definition at line 1122 of file graphics_abstraction_layer.h.

References KIGFX::GAL::screenDPI, KIGFX::GAL::worldScale, KIGFX::GAL::worldUnitLength, and KIGFX::GAL::zoomFactor.

Referenced by KIGFX::GAL::ComputeWorldScreenMatrix(), and KIGFX::GAL::GAL().

1123  {
1125  }
double zoomFactor
The zoom factor.
double worldUnitLength
The unit length of the world coordinates [inch].
double worldScale
The scale factor world->screen.
double screenDPI
The dots per inch of the screen.

◆ ComputeWorldScreenMatrix()

void CAIRO_PRINT_GAL::ComputeWorldScreenMatrix ( )
overridevirtual

Compute the world <-> screen transformation matrix.

Reimplemented from KIGFX::GAL.

Definition at line 137 of file cairo_print.cpp.

References KIGFX::GAL::globalFlipX, KIGFX::GAL::globalFlipY, MATRIX3x3< T >::Inverse(), isLandscape(), KIGFX::GAL::lookAtPoint, m_hasNativeLandscapeRotation, m_nativePaperSize, scale, KIGFX::GAL::screenDPI, KIGFX::GAL::screenWorldMatrix, MATRIX3x3< T >::SetIdentity(), MATRIX3x3< T >::SetRotation(), MATRIX3x3< T >::SetScale(), MATRIX3x3< T >::SetTranslation(), KIGFX::GAL::worldScale, KIGFX::GAL::worldScreenMatrix, KIGFX::GAL::worldUnitLength, VECTOR2< T >::x, VECTOR2< T >::y, and KIGFX::GAL::zoomFactor.

138 {
140  const auto paperSizeIU = VECTOR2D( m_nativePaperSize.y, m_nativePaperSize.x ) /* inches */ / worldUnitLength; /* 1 inch in IU */
141  const auto paperSizeIUTransposed = VECTOR2D( paperSizeIU.y, paperSizeIU.x );
142 
143  MATRIX3x3D scale, translation, flip, rotate, lookat;
144 
145  scale.SetIdentity();
146  translation.SetIdentity();
147  flip.SetIdentity();
148  rotate.SetIdentity();
149  lookat.SetIdentity();
150 
152  {
153  translation.SetTranslation( 0.5 / zoomFactor * paperSizeIUTransposed );
154  }
155  else
156  {
157  if( isLandscape() )
158  {
159  translation.SetTranslation( 0.5 / zoomFactor * paperSizeIU );
160  rotate.SetRotation( 90.0 * M_PI / 180.0 );
161  }
162  else
163  {
164  translation.SetTranslation( 0.5 / zoomFactor * paperSizeIUTransposed );
165  }
166  }
167 
168  scale.SetScale( VECTOR2D( worldScale, worldScale ) );
169  flip.SetScale( VECTOR2D( globalFlipX ? -1.0 : 1.0, globalFlipY ? -1.0 : 1.0 ) );
170  lookat.SetTranslation( -lookAtPoint );
171 
172  worldScreenMatrix = scale * translation * flip * rotate * lookat;
174 }
double zoomFactor
The zoom factor.
void SetRotation(T aAngle)
Set the rotation components of the matrix.
Definition: matrix3x3.h:249
MATRIX3x3 Inverse() const
Determine the inverse of the matrix.
Definition: matrix3x3.h:343
MATRIX3x3D screenWorldMatrix
Screen transformation.
bool globalFlipX
Flag for X axis flipping.
void SetIdentity()
Set the matrix to the identity matrix.
Definition: matrix3x3.h:214
VECTOR2D lookAtPoint
Point to be looked at in world space.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
bool isLandscape() const
Returns true if page orientation is landscape
Definition: cairo_print.h:113
double worldUnitLength
The unit length of the world coordinates [inch].
MATRIX3x3D worldScreenMatrix
World transformation.
const int scale
void SetScale(VECTOR2< T > aScale)
Set the scale components of the matrix.
Definition: matrix3x3.h:261
bool globalFlipY
Flag for Y axis flipping.
double worldScale
The scale factor world->screen.
void SetTranslation(VECTOR2< T > aTranslation)
Set the translation components of the matrix.
Definition: matrix3x3.h:230
VECTOR2D m_nativePaperSize
Printout size
Definition: cairo_print.h:119
bool m_hasNativeLandscapeRotation
Flag indicating whether the platform rotates page automatically or GAL needs to handle it in the tran...
Definition: cairo_print.h:123
double screenDPI
The dots per inch of the screen.

◆ DeleteGroup()

void CAIRO_GAL_BASE::DeleteGroup ( int  aGroupNumber)
overridevirtualinherited

Delete the group from the memory.

Parameters
aGroupNumberis the group number.

Reimplemented from KIGFX::GAL.

Definition at line 699 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::CMD_FILL_PATH, KIGFX::CAIRO_GAL_BASE::CMD_STROKE_PATH, KIGFX::CAIRO_GAL_BASE::groups, and KIGFX::CAIRO_GAL_BASE::storePath().

Referenced by KIGFX::CAIRO_GAL_BASE::ClearCache().

700 {
701  storePath();
702 
703  // Delete the Cairo paths
704  std::deque<GROUP_ELEMENT>::iterator it, end;
705 
706  for( it = groups[aGroupNumber].begin(), end = groups[aGroupNumber].end(); it != end; ++it )
707  {
708  if( it->command == CMD_FILL_PATH || it->command == CMD_STROKE_PATH )
709  {
710  cairo_path_destroy( it->cairoPath );
711  }
712  }
713 
714  // Delete the group
715  groups.erase( aGroupNumber );
716 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
std::map< int, GROUP > groups
List of graphic groups.
Definition: cairo_gal.h:269

◆ DrawArc()

void CAIRO_GAL_BASE::DrawArc ( const VECTOR2D aCenterPoint,
double  aRadius,
double  aStartAngle,
double  aEndAngle 
)
overridevirtualinherited

Draw an arc.

Parameters
aCenterPointis the center point of the arc.
aRadiusis the arc radius.
aStartAngleis the start angle of the arc.
aEndAngleis the end angle of the arc.

Reimplemented from KIGFX::GAL.

Definition at line 154 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::flushPath(), KIGFX::GAL::GetFillColor(), KIGFX::GAL::GetLineWidth(), KIGFX::GAL::GetStrokeColor(), KIGFX::CAIRO_GAL_BASE::isElementAdded, KIGFX::GAL::isFillEnabled, KIGFX::CAIRO_GAL_BASE::SetLineWidth(), KIGFX::CAIRO_GAL_BASE::SetStrokeColor(), SWAP, VECTOR2< T >::x, and VECTOR2< T >::y.

156 {
157  SWAP( aStartAngle, >, aEndAngle );
158 
159  if( isFillEnabled ) // Draw the filled area of the shape, before drawing the outline itself
160  {
161  double pen_size = GetLineWidth();
162  auto fgcolor = GetStrokeColor();
164 
165  SetLineWidth( 0 );
166  cairo_new_sub_path( currentContext );
167  cairo_arc( currentContext, aCenterPoint.x, aCenterPoint.y, aRadius, aStartAngle, aEndAngle );
168  VECTOR2D startPoint( cos( aStartAngle ) * aRadius + aCenterPoint.x,
169  sin( aStartAngle ) * aRadius + aCenterPoint.y );
170  VECTOR2D endPoint( cos( aEndAngle ) * aRadius + aCenterPoint.x,
171  sin( aEndAngle ) * aRadius + aCenterPoint.y );
172 
173  cairo_move_to( currentContext, aCenterPoint.x, aCenterPoint.y );
174  cairo_line_to( currentContext, startPoint.x, startPoint.y );
175  cairo_line_to( currentContext, endPoint.x, endPoint.y );
176  cairo_close_path( currentContext );
177  flushPath();
178  SetLineWidth( pen_size );
179  SetStrokeColor( fgcolor );
180  }
181 
182  cairo_new_sub_path( currentContext );
183  cairo_arc( currentContext, aCenterPoint.x, aCenterPoint.y, aRadius, aStartAngle, aEndAngle );
184  flushPath();
185 
186  isElementAdded = true;
187 }
float GetLineWidth() const
Get the line width.
const COLOR4D & GetFillColor() const
Get the fill color.
const COLOR4D & GetStrokeColor() const
Get the stroke color.
bool isFillEnabled
Is filling of graphic objects enabled ?
virtual void SetStrokeColor(const COLOR4D &aColor) override
Set the stroke color.
Definition: cairo_gal.cpp:389
#define SWAP(varA, condition, varB)
Swap the variables if a condition is met.
Definition: definitions.h:31
virtual void SetLineWidth(float aLineWidth) override
Set the line width.
Definition: cairo_gal.cpp:425
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:267

◆ DrawArcSegment()

void CAIRO_GAL_BASE::DrawArcSegment ( const VECTOR2D aCenterPoint,
double  aRadius,
double  aStartAngle,
double  aEndAngle,
double  aWidth 
)
overridevirtualinherited

Draw an arc segment.

This method differs from DrawArc() in what happens when fill/stroke are on or off. DrawArc() draws a "pie piece" when fill is turned on, and a thick stroke when fill is off. DrawArcSegment() with fill on behaves like DrawArc() with fill off. DrawArcSegment() with fill off draws the outline of what it would have drawn with fill on.

Parameters
aCenterPointis the center point of the arc.
aRadiusis the arc radius.
aStartAngleis the start angle of the arc.
aEndAngleis the end angle of the arc.
aWidthis the thickness of the arc (pen size).

Reimplemented from KIGFX::GAL.

Definition at line 190 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::GAL::fillColor, KIGFX::CAIRO_GAL_BASE::flushPath(), KIGFX::COLOR4D::g, KIGFX::CAIRO_GAL_BASE::isElementAdded, KIGFX::GAL::isFillEnabled, KIGFX::COLOR4D::r, KIGFX::CAIRO_GAL_BASE::SetLineWidth(), KIGFX::GAL::strokeColor, SWAP, VECTOR2< T >::x, and VECTOR2< T >::y.

192 {
193  SWAP( aStartAngle, >, aEndAngle );
194 
195  if( isFillEnabled )
196  {
197  // Filled segments mode
198  SetLineWidth( aWidth );
199  cairo_arc( currentContext, aCenterPoint.x, aCenterPoint.y, aRadius, aStartAngle, aEndAngle );
200  cairo_set_source_rgba( currentContext, fillColor.r, fillColor.g, fillColor.b, fillColor.a );
201  cairo_stroke( currentContext );
202  }
203  else
204  {
205  double width = aWidth / 2.0;
206  VECTOR2D startPoint( cos( aStartAngle ) * aRadius,
207  sin( aStartAngle ) * aRadius );
208  VECTOR2D endPoint( cos( aEndAngle ) * aRadius,
209  sin( aEndAngle ) * aRadius );
210 
211  cairo_save( currentContext );
212 
213  cairo_set_source_rgba( currentContext, strokeColor.r, strokeColor.g, strokeColor.b, strokeColor.a );
214 
215  cairo_translate( currentContext, aCenterPoint.x, aCenterPoint.y );
216 
217  cairo_new_sub_path( currentContext );
218  cairo_arc( currentContext, 0, 0, aRadius - width, aStartAngle, aEndAngle );
219 
220  cairo_new_sub_path( currentContext );
221  cairo_arc( currentContext, 0, 0, aRadius + width, aStartAngle, aEndAngle );
222 
223  cairo_new_sub_path( currentContext );
224  cairo_arc_negative( currentContext, startPoint.x, startPoint.y, width, aStartAngle, aStartAngle + M_PI );
225 
226  cairo_new_sub_path( currentContext );
227  cairo_arc( currentContext, endPoint.x, endPoint.y, width, aEndAngle, aEndAngle + M_PI );
228 
229  cairo_restore( currentContext );
230  flushPath();
231  }
232 
233  isElementAdded = true;
234 }
double g
Green component.
Definition: color4d.h:288
COLOR4D fillColor
The fill color.
double b
Blue component.
Definition: color4d.h:289
double a
Alpha component.
Definition: color4d.h:290
COLOR4D strokeColor
The color of the outlines.
bool isFillEnabled
Is filling of graphic objects enabled ?
#define SWAP(varA, condition, varB)
Swap the variables if a condition is met.
Definition: definitions.h:31
virtual void SetLineWidth(float aLineWidth) override
Set the line width.
Definition: cairo_gal.cpp:425
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
double r
Red component.
Definition: color4d.h:287
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:267

◆ DrawBitmap()

void CAIRO_GAL_BASE::DrawBitmap ( const BITMAP_BASE aBitmap)
overridevirtualinherited

Draw a bitmap image.

Reimplemented from KIGFX::GAL.

Definition at line 281 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::currentContext, BITMAP_BASE::GetPPI(), BITMAP_BASE::GetSizePixels(), KIGFX::CAIRO_GAL_BASE::isElementAdded, scale, and KIGFX::GAL::worldUnitLength.

282 {
283  cairo_save( currentContext );
284 
285  // We have to calculate the pixel size in users units to draw the image.
286  // worldUnitLength is a factor used for converting IU to inches
287  double scale = 1.0 / ( aBitmap.GetPPI() * worldUnitLength );
288  cairo_scale( currentContext, scale, scale );
289 
290  // The position of the bitmap is the bitmap center.
291  // move the draw origin to the top left bitmap corner:
292  int w = aBitmap.GetSizePixels().x;
293  int h = aBitmap.GetSizePixels().y;
294  cairo_translate( currentContext, -w/2, -h/2 );
295 
296  cairo_new_path( currentContext );
297  cairo_surface_t* image = cairo_image_surface_create( CAIRO_FORMAT_ARGB32, w, h );
298  cairo_surface_flush( image );
299 
300  unsigned char* pix_buffer = cairo_image_surface_get_data( image );
301  // The pixel buffer of the initial bitmap:
302  auto bm_pix_buffer = (( BITMAP_BASE&)aBitmap).GetImageData();
303 
304  // Copy the source bitmap to the cairo bitmap buffer.
305  // In cairo bitmap buffer, a ARGB32 bitmap is an ARGB pixel packed into a uint_32
306  // 24 low bits only are used for color, top 8 are transparency.
307  for( int row = 0; row < h; row++ )
308  {
309  for( int col = 0; col < w; col++ )
310  {
311  // Build the RGB24 pixel:
312  uint32_t pixel = bm_pix_buffer->GetRed( col, row ) << 16;
313  pixel += bm_pix_buffer->GetGreen( col, row ) << 8;
314  pixel += bm_pix_buffer->GetBlue( col, row );
315 
316  if( bm_pix_buffer->HasAlpha() )
317  pixel += bm_pix_buffer->GetAlpha( col, row ) << 24;
318  else
319  pixel += ( 0xff << 24 );
320 
321  // Write the pixel to the cairo image buffer:
322  uint32_t* pix_ptr = (uint32_t*) pix_buffer;
323  *pix_ptr = pixel;
324  pix_buffer += 4;
325  }
326  }
327 
328  cairo_surface_mark_dirty( image );
329  cairo_set_source_surface( currentContext, image, 0, 0 );
330  cairo_paint( currentContext );
331  cairo_surface_destroy( image );
332 
333  isElementAdded = true;
334 
335  cairo_restore( currentContext );
336 }
This class handle bitmap images in KiCad.
Definition: bitmap_base.h:46
double worldUnitLength
The unit length of the world coordinates [inch].
const int scale
wxSize GetSizePixels() const
Function GetSizePixels.
Definition: bitmap_base.h:133
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:267
int GetPPI() const
Definition: bitmap_base.h:145

◆ DrawCircle()

void CAIRO_GAL_BASE::DrawCircle ( const VECTOR2D aCenterPoint,
double  aRadius 
)
overridevirtualinherited

Draw a circle using world coordinates.

Parameters
aCenterPointis the center point of the circle.
aRadiusis the radius of the circle.

Reimplemented from KIGFX::GAL.

Definition at line 145 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::flushPath(), KIGFX::CAIRO_GAL_BASE::isElementAdded, VECTOR2< T >::x, and VECTOR2< T >::y.

146 {
147  cairo_new_sub_path( currentContext );
148  cairo_arc( currentContext, aCenterPoint.x, aCenterPoint.y, aRadius, 0.0, 2 * M_PI );
149  flushPath();
150  isElementAdded = true;
151 }
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:267

◆ DrawCursor()

void CAIRO_GAL_BASE::DrawCursor ( const VECTOR2D aCursorPosition)
overridevirtualinherited

Draw the cursor.

Parameters
aCursorPositionis the cursor position in screen coordinates.

Reimplemented from KIGFX::GAL.

Definition at line 734 of file cairo_gal.cpp.

References KIGFX::GAL::cursorPosition.

735 {
736  cursorPosition = aCursorPosition;
737 }
VECTOR2D cursorPosition
Current cursor position (world coordinates)

◆ DrawCurve()

void CAIRO_GAL_BASE::DrawCurve ( const VECTOR2D startPoint,
const VECTOR2D controlPointA,
const VECTOR2D controlPointB,
const VECTOR2D endPoint 
)
overridevirtualinherited

Draw a cubic bezier spline.

Parameters
startPointis the start point of the spline.
controlPointAis the first control point.
controlPointBis the second control point.
endPointis the end point of the spline.

Reimplemented from KIGFX::GAL.

Definition at line 268 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::flushPath(), KIGFX::CAIRO_GAL_BASE::isElementAdded, VECTOR2< T >::x, and VECTOR2< T >::y.

270 {
271  cairo_move_to( currentContext, aStartPoint.x, aStartPoint.y );
272  cairo_curve_to( currentContext, aControlPointA.x, aControlPointA.y, aControlPointB.x,
273  aControlPointB.y, aEndPoint.x, aEndPoint.y );
274  cairo_line_to( currentContext, aEndPoint.x, aEndPoint.y );
275 
276  flushPath();
277  isElementAdded = true;
278 }
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:267

◆ DrawGrid()

void GAL::DrawGrid ( )
virtualinherited

>

Draw the grid

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 216 of file graphics_abstraction_layer.cpp.

References KIGFX::GAL::axesColor, KIGFX::GAL::axesEnabled, KIGFX::GAL::computeMinGridSpacing(), KIGFX::GAL::depthRange, KIGFX::GAL::drawGridLine(), KIGFX::GAL::DrawRectangle(), KIGFX::GAL::GetLineWidth(), KIGFX::GAL::gridColor, KIGFX::GAL::gridLineWidth, KIGFX::GAL::gridOrigin, KIGFX::GAL::gridSize, KIGFX::GAL::gridStyle, KIGFX::GAL::gridTick, KIGFX::GAL::gridVisibility, i, KiROUND(), KIGFX::LINES, max, KIGFX::GAL::screenSize, KIGFX::GAL::screenWorldMatrix, KIGFX::GAL::SetFillColor(), KIGFX::GAL::SetIsFill(), KIGFX::GAL::SetIsStroke(), KIGFX::GAL::SetLayerDepth(), KIGFX::GAL::SetLineWidth(), KIGFX::GAL::SetStrokeColor(), KIGFX::GAL::SetTarget(), KIGFX::SMALL_CROSS, KIGFX::TARGET_NONCACHED, KIGFX::GAL::worldScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDA_DRAW_PANEL_GAL::onPaint().

217 {
219 
220  // Draw the grid
221  // For the drawing the start points, end points and increments have
222  // to be calculated in world coordinates
223  VECTOR2D worldStartPoint = screenWorldMatrix * VECTOR2D( 0.0, 0.0 );
224  VECTOR2D worldEndPoint = screenWorldMatrix * VECTOR2D( screenSize );
225 
226  const double gridThreshold = computeMinGridSpacing();
227 
228  int gridScreenSizeDense = KiROUND( gridSize.x * worldScale );
229  int gridScreenSizeCoarse = KiROUND( gridSize.x * static_cast<double>( gridTick ) * worldScale );
230 
231  // Compute the line marker or point radius of the grid
232  // Note: generic grids can't handle sub-pixel lines without
233  // either losing fine/course distinction or having some dots
234  // fail to render
235  float marker = std::fmax( 1.0f, gridLineWidth ) / worldScale;
236  float doubleMarker = 2.0f * marker;
237 
238  // Draw axes if desired
239  if( axesEnabled )
240  {
241  SetIsFill( false );
242  SetIsStroke( true );
244  SetLineWidth( marker );
245 
246  drawGridLine( VECTOR2D( worldStartPoint.x, 0 ),
247  VECTOR2D( worldEndPoint.x, 0 ) );
248 
249  drawGridLine( VECTOR2D( 0, worldStartPoint.y ),
250  VECTOR2D( 0, worldEndPoint.y ) );
251  }
252 
253  if( !gridVisibility )
254  return;
255 
256  // Check if the grid would not be too dense
257  if( std::max( gridScreenSizeDense, gridScreenSizeCoarse ) <= gridThreshold )
258  return;
259 
260  // Compute grid staring and ending indexes to draw grid points on the
261  // visible screen area
262  // Note: later any point coordinate will be offsetted by gridOrigin
263  int gridStartX = KiROUND( ( worldStartPoint.x - gridOrigin.x ) / gridSize.x );
264  int gridEndX = KiROUND( ( worldEndPoint.x - gridOrigin.x ) / gridSize.x );
265  int gridStartY = KiROUND( ( worldStartPoint.y - gridOrigin.y ) / gridSize.y );
266  int gridEndY = KiROUND( ( worldEndPoint.y - gridOrigin.y ) / gridSize.y );
267 
268  // Ensure start coordinate > end coordinate
269  if( gridStartX > gridEndX )
270  std::swap( gridStartX, gridEndX );
271 
272  if( gridStartY > gridEndY )
273  std::swap( gridStartY, gridEndY );
274 
275  // Ensure the grid fills the screen
276  --gridStartX; ++gridEndX;
277  --gridStartY; ++gridEndY;
278 
279  // Draw the grid behind all other layers
280  SetLayerDepth( depthRange.y * 0.75 );
281 
283  {
284  SetIsFill( false );
285  SetIsStroke( true );
287 
288  // Now draw the grid, every coarse grid line gets the double width
289 
290  // Vertical lines
291  for( int j = gridStartY; j <= gridEndY; j++ )
292  {
293  const double y = j * gridSize.y + gridOrigin.y;
294 
295  if( axesEnabled && y == 0 )
296  continue;
297 
298  if( j % gridTick == 0 && gridScreenSizeDense > gridThreshold )
299  SetLineWidth( doubleMarker );
300  else
301  SetLineWidth( marker );
302 
303  if( ( j % gridTick == 0 && gridScreenSizeCoarse > gridThreshold )
304  || gridScreenSizeDense > gridThreshold )
305  {
306  drawGridLine( VECTOR2D( gridStartX * gridSize.x + gridOrigin.x, y ),
307  VECTOR2D( gridEndX * gridSize.x + gridOrigin.x, y ) );
308  }
309  }
310 
311  // Horizontal lines
312  for( int i = gridStartX; i <= gridEndX; i++ )
313  {
314  const double x = i * gridSize.x + gridOrigin.x;
315 
316  if( axesEnabled && x == 0 )
317  continue;
318 
319  if( i % gridTick == 0 && gridScreenSizeDense > gridThreshold )
320  SetLineWidth( doubleMarker );
321  else
322  SetLineWidth( marker );
323 
324  if( ( i % gridTick == 0 && gridScreenSizeCoarse > gridThreshold )
325  || gridScreenSizeDense > gridThreshold )
326  {
327  drawGridLine( VECTOR2D( x, gridStartY * gridSize.y + gridOrigin.y ),
328  VECTOR2D( x, gridEndY * gridSize.y + gridOrigin.y ) );
329  }
330  }
331  }
332  else if( gridStyle == GRID_STYLE::SMALL_CROSS )
333  {
334  SetIsFill( false );
335  SetIsStroke( true );
337 
338  SetLineWidth( marker );
339  double lineLen = GetLineWidth() * 2;
340 
341  // Vertical positions:
342  for( int j = gridStartY; j <= gridEndY; j++ )
343  {
344  if( ( j % gridTick == 0 && gridScreenSizeCoarse > gridThreshold )
345  || gridScreenSizeDense > gridThreshold )
346  {
347  int posY = j * gridSize.y + gridOrigin.y;
348 
349  // Horizontal positions:
350  for( int i = gridStartX; i <= gridEndX; i++ )
351  {
352  if( ( i % gridTick == 0 && gridScreenSizeCoarse > gridThreshold )
353  || gridScreenSizeDense > gridThreshold )
354  {
355  int posX = i * gridSize.x + gridOrigin.x;
356 
357  drawGridLine( VECTOR2D( posX - lineLen, posY ),
358  VECTOR2D( posX + lineLen, posY ) );
359 
360  drawGridLine( VECTOR2D( posX, posY - lineLen ),
361  VECTOR2D( posX, posY + lineLen ) );
362  }
363  }
364  }
365  }
366  }
367  else // Dotted grid
368  {
369  bool tickX, tickY;
370  SetIsFill( true );
371  SetIsStroke( false );
373 
374  for( int j = gridStartY; j <= gridEndY; j++ )
375  {
376  if( j % gridTick == 0 && gridScreenSizeDense > gridThreshold )
377  tickY = true;
378  else
379  tickY = false;
380 
381  for( int i = gridStartX; i <= gridEndX; i++ )
382  {
383  if( i % gridTick == 0 && gridScreenSizeDense > gridThreshold )
384  tickX = true;
385  else
386  tickX = false;
387 
388  if( tickX || tickY || gridScreenSizeDense > gridThreshold )
389  {
390  double radius = ( ( tickX && tickY ) ? doubleMarker : marker ) / 2.0;
391  DrawRectangle( VECTOR2D( i * gridSize.x - radius + gridOrigin.x,
392  j * gridSize.y - radius + gridOrigin.y ),
393  VECTOR2D( i * gridSize.x + radius + gridOrigin.x,
394  j * gridSize.y + radius + gridOrigin.y ) );
395  }
396  }
397  }
398  }
399 }
int gridTick
Every tick line gets the double width.
virtual void SetFillColor(const COLOR4D &aColor)
Set the fill color.
float GetLineWidth() const
Get the line width.
virtual void DrawRectangle(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
Draw a rectangle.
Use lines for the grid.
bool axesEnabled
Should the axes be drawn.
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:121
double computeMinGridSpacing() const
compute minimum grid spacing from the grid settings
GRID_STYLE gridStyle
Grid display style.
Class VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
VECTOR2D depthRange
Range of the depth.
MATRIX3x3D screenWorldMatrix
Screen transformation.
virtual void SetLayerDepth(double aLayerDepth)
Set the depth of the layer (position on the z-axis)
virtual void drawGridLine(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
Draw a grid line (usually a simplified line function).
virtual void SetLineWidth(float aLineWidth)
Set the line width.
Auxiliary rendering target (noncached)
Definition: definitions.h:42
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
virtual void SetIsFill(bool aIsFillEnabled)
Enable/disable fill.
COLOR4D axesColor
Color of the axes.
float gridLineWidth
Line width of the grid.
VECTOR2D gridOrigin
The grid origin.
Use small cross instead of dots for the grid.
virtual void SetStrokeColor(const COLOR4D &aColor)
Set the stroke color.
COLOR4D gridColor
Color of the grid.
bool gridVisibility
Should the grid be shown.
#define max(a, b)
Definition: auxiliary.h:86
double worldScale
The scale factor world->screen.
VECTOR2D gridSize
The grid size.
size_t i
Definition: json11.cpp:597
VECTOR2I screenSize
Screen size in screen coordinates.
virtual void SetIsStroke(bool aIsStrokeEnabled)
Enable/disable stroked outlines.
virtual void SetTarget(RENDER_TARGET aTarget)
Sets the target for rendering.

◆ drawGridLine()

void CAIRO_GAL_BASE::drawGridLine ( const VECTOR2D aStartPoint,
const VECTOR2D aEndPoint 
)
overrideprotectedvirtualinherited

Draw a grid line (usually a simplified line function).

Parameters
aStartPointis the start point of the line.
aEndPointis the end point of the line.

Reimplemented from KIGFX::GAL.

Definition at line 773 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::COLOR4D::g, KIGFX::COLOR4D::r, KIGFX::GAL::strokeColor, VECTOR2< T >::x, and VECTOR2< T >::y.

774 {
775  cairo_move_to( currentContext, aStartPoint.x, aStartPoint.y );
776  cairo_line_to( currentContext, aEndPoint.x, aEndPoint.y );
777  cairo_set_source_rgba( currentContext, strokeColor.r, strokeColor.g, strokeColor.b, strokeColor.a );
778  cairo_stroke( currentContext );
779 }
double g
Green component.
Definition: color4d.h:288
double b
Blue component.
Definition: color4d.h:289
double a
Alpha component.
Definition: color4d.h:290
COLOR4D strokeColor
The color of the outlines.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
double r
Red component.
Definition: color4d.h:287

◆ DrawGroup()

void CAIRO_GAL_BASE::DrawGroup ( int  aGroupNumber)
overridevirtualinherited

Draw the stored group.

Parameters
aGroupNumberis the group number.

Reimplemented from KIGFX::GAL.

Definition at line 584 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::CMD_CALL_GROUP, KIGFX::CAIRO_GAL_BASE::CMD_FILL_PATH, KIGFX::CAIRO_GAL_BASE::CMD_RESTORE, KIGFX::CAIRO_GAL_BASE::CMD_ROTATE, KIGFX::CAIRO_GAL_BASE::CMD_SAVE, KIGFX::CAIRO_GAL_BASE::CMD_SCALE, KIGFX::CAIRO_GAL_BASE::CMD_SET_FILL, KIGFX::CAIRO_GAL_BASE::CMD_SET_FILLCOLOR, KIGFX::CAIRO_GAL_BASE::CMD_SET_LINE_WIDTH, KIGFX::CAIRO_GAL_BASE::CMD_SET_STROKE, KIGFX::CAIRO_GAL_BASE::CMD_SET_STROKECOLOR, KIGFX::CAIRO_GAL_BASE::CMD_STROKE_PATH, KIGFX::CAIRO_GAL_BASE::CMD_TRANSLATE, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::GAL::fillColor, KIGFX::COLOR4D::g, KIGFX::CAIRO_GAL_BASE::groups, KIGFX::GAL::isFillEnabled, KIGFX::GAL::isStrokeEnabled, max, min, KIGFX::COLOR4D::r, KIGFX::CAIRO_GAL_BASE::storePath(), and KIGFX::GAL::strokeColor.

585 {
586  // This method implements a small Virtual Machine - all stored commands
587  // are executed; nested calling is also possible
588 
589  storePath();
590 
591  for( GROUP::iterator it = groups[aGroupNumber].begin();
592  it != groups[aGroupNumber].end(); ++it )
593  {
594  switch( it->command )
595  {
596  case CMD_SET_FILL:
597  isFillEnabled = it->argument.boolArg;
598  break;
599 
600  case CMD_SET_STROKE:
601  isStrokeEnabled = it->argument.boolArg;
602  break;
603 
604  case CMD_SET_FILLCOLOR:
605  fillColor = COLOR4D( it->argument.dblArg[0], it->argument.dblArg[1], it->argument.dblArg[2],
606  it->argument.dblArg[3] );
607  break;
608 
609  case CMD_SET_STROKECOLOR:
610  strokeColor = COLOR4D( it->argument.dblArg[0], it->argument.dblArg[1], it->argument.dblArg[2],
611  it->argument.dblArg[3] );
612  break;
613 
614  case CMD_SET_LINE_WIDTH:
615  {
616  // Make lines appear at least 1 pixel wide, no matter of zoom
617  double x = 1.0, y = 1.0;
618  cairo_device_to_user_distance( currentContext, &x, &y );
619  double minWidth = std::min( fabs( x ), fabs( y ) );
620  cairo_set_line_width( currentContext, std::max( it->argument.dblArg[0], minWidth ) );
621  }
622  break;
623 
624 
625  case CMD_STROKE_PATH:
626  cairo_set_source_rgba( currentContext, strokeColor.r, strokeColor.g, strokeColor.b, strokeColor.a );
627  cairo_append_path( currentContext, it->cairoPath );
628  cairo_stroke( currentContext );
629  break;
630 
631  case CMD_FILL_PATH:
632  cairo_set_source_rgba( currentContext, fillColor.r, fillColor.g, fillColor.b, strokeColor.a );
633  cairo_append_path( currentContext, it->cairoPath );
634  cairo_fill( currentContext );
635  break;
636 
637  /*
638  case CMD_TRANSFORM:
639  cairo_matrix_t matrix;
640  cairo_matrix_init( &matrix, it->argument.dblArg[0], it->argument.dblArg[1], it->argument.dblArg[2],
641  it->argument.dblArg[3], it->argument.dblArg[4], it->argument.dblArg[5] );
642  cairo_transform( currentContext, &matrix );
643  break;
644  */
645 
646  case CMD_ROTATE:
647  cairo_rotate( currentContext, it->argument.dblArg[0] );
648  break;
649 
650  case CMD_TRANSLATE:
651  cairo_translate( currentContext, it->argument.dblArg[0], it->argument.dblArg[1] );
652  break;
653 
654  case CMD_SCALE:
655  cairo_scale( currentContext, it->argument.dblArg[0], it->argument.dblArg[1] );
656  break;
657 
658  case CMD_SAVE:
659  cairo_save( currentContext );
660  break;
661 
662  case CMD_RESTORE:
663  cairo_restore( currentContext );
664  break;
665 
666  case CMD_CALL_GROUP:
667  DrawGroup( it->argument.intArg );
668  break;
669  }
670  }
671 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
Rotate the context.
Definition: cairo_gal.h:245
double g
Green component.
Definition: color4d.h:288
COLOR4D fillColor
The fill color.
Enable/disable filling.
Definition: cairo_gal.h:237
double b
Blue component.
Definition: color4d.h:289
double a
Alpha component.
Definition: color4d.h:290
bool isStrokeEnabled
Are the outlines stroked ?
std::map< int, GROUP > groups
List of graphic groups.
Definition: cairo_gal.h:269
COLOR4D strokeColor
The color of the outlines.
Save the transformation matrix.
Definition: cairo_gal.h:248
bool isFillEnabled
Is filling of graphic objects enabled ?
#define max(a, b)
Definition: auxiliary.h:86
Translate the context.
Definition: cairo_gal.h:246
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
virtual void DrawGroup(int aGroupNumber) override
Draw the stored group.
Definition: cairo_gal.cpp:584
double r
Red component.
Definition: color4d.h:287
Enable/disable stroking.
Definition: cairo_gal.h:238
Restore the transformation matrix.
Definition: cairo_gal.h:249
#define min(a, b)
Definition: auxiliary.h:85
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

◆ DrawLine()

void CAIRO_GAL_BASE::DrawLine ( const VECTOR2D aStartPoint,
const VECTOR2D aEndPoint 
)
overridevirtualinherited

Draw a line.

Start and end points are defined as 2D-Vectors.

Parameters
aStartPointis the start point of the line.
aEndPointis the end point of the line.

Reimplemented from KIGFX::GAL.

Definition at line 92 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::flushPath(), KIGFX::CAIRO_GAL_BASE::isElementAdded, VECTOR2< T >::x, and VECTOR2< T >::y.

93 {
94  cairo_move_to( currentContext, aStartPoint.x, aStartPoint.y );
95  cairo_line_to( currentContext, aEndPoint.x, aEndPoint.y );
96  flushPath();
97  isElementAdded = true;
98 }
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:267

◆ drawPoly() [1/3]

void CAIRO_GAL_BASE::drawPoly ( const std::deque< VECTOR2D > &  aPointList)
protectedinherited

Drawing polygons & polylines is the same in cairo, so here is the common code.

Definition at line 870 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::flushPath(), and KIGFX::CAIRO_GAL_BASE::isElementAdded.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawPolygon(), and KIGFX::CAIRO_GAL_BASE::DrawPolyline().

871 {
872  // Iterate over the point list and draw the segments
873  std::deque<VECTOR2D>::const_iterator it = aPointList.begin();
874 
875  cairo_move_to( currentContext, it->x, it->y );
876 
877  for( ++it; it != aPointList.end(); ++it )
878  {
879  cairo_line_to( currentContext, it->x, it->y );
880  }
881 
882  flushPath();
883  isElementAdded = true;
884 }
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:267

◆ drawPoly() [2/3]

void CAIRO_GAL_BASE::drawPoly ( const VECTOR2D  aPointList[],
int  aListSize 
)
protectedinherited

Definition at line 887 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::flushPath(), i, KIGFX::CAIRO_GAL_BASE::isElementAdded, VECTOR2< T >::x, and VECTOR2< T >::y.

888 {
889  // Iterate over the point list and draw the segments
890  const VECTOR2D* ptr = aPointList;
891 
892  cairo_move_to( currentContext, ptr->x, ptr->y );
893 
894  for( int i = 0; i < aListSize; ++i )
895  {
896  ++ptr;
897  cairo_line_to( currentContext, ptr->x, ptr->y );
898  }
899 
900  flushPath();
901  isElementAdded = true;
902 }
size_t i
Definition: json11.cpp:597
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:267

◆ drawPoly() [3/3]

void CAIRO_GAL_BASE::drawPoly ( const SHAPE_LINE_CHAIN aLineChain)
protectedinherited

Definition at line 905 of file cairo_gal.cpp.

References SHAPE_LINE_CHAIN::CPoint(), KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::flushPath(), i, SHAPE_LINE_CHAIN::IsClosed(), KIGFX::CAIRO_GAL_BASE::isElementAdded, SHAPE_LINE_CHAIN::PointCount(), VECTOR2< T >::x, and VECTOR2< T >::y.

906 {
907  if( aLineChain.PointCount() < 2 )
908  return;
909 
910  auto numPoints = aLineChain.PointCount();
911 
912  if( aLineChain.IsClosed() )
913  numPoints += 1;
914 
915  const VECTOR2I start = aLineChain.CPoint( 0 );
916  cairo_move_to( currentContext, start.x, start.y );
917 
918  for( int i = 1; i < numPoints; ++i )
919  {
920  const VECTOR2I& p = aLineChain.CPoint( i );
921  cairo_line_to( currentContext, p.x, p.y );
922  }
923 
924  flushPath();
925  isElementAdded = true;
926 }
int PointCount() const
Function PointCount()
const VECTOR2I & CPoint(int aIndex) const
Function CPoint()
size_t i
Definition: json11.cpp:597
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
bool IsClosed() const
Function IsClosed()
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:267

◆ DrawPolygon() [1/4]

virtual void KIGFX::CAIRO_GAL_BASE::DrawPolygon ( const std::deque< VECTOR2D > &  aPointList)
inlineoverridevirtualinherited

Draw a polygon.

Parameters
aPointListis the list of the polygon points.

Reimplemented from KIGFX::GAL.

Definition at line 107 of file cairo_gal.h.

References KIGFX::CAIRO_GAL_BASE::drawPoly().

107 { drawPoly( aPointList ); }
void drawPoly(const std::deque< VECTOR2D > &aPointList)
Drawing polygons & polylines is the same in cairo, so here is the common code.
Definition: cairo_gal.cpp:870

◆ DrawPolygon() [2/4]

virtual void KIGFX::CAIRO_GAL_BASE::DrawPolygon ( const VECTOR2D  aPointList[],
int  aListSize 
)
inlineoverridevirtualinherited

Reimplemented from KIGFX::GAL.

Definition at line 108 of file cairo_gal.h.

References KIGFX::CAIRO_GAL_BASE::drawPoly().

108 { drawPoly( aPointList, aListSize ); }
void drawPoly(const std::deque< VECTOR2D > &aPointList)
Drawing polygons & polylines is the same in cairo, so here is the common code.
Definition: cairo_gal.cpp:870

◆ DrawPolygon() [3/4]

void CAIRO_GAL_BASE::DrawPolygon ( const SHAPE_POLY_SET aPolySet)
overridevirtualinherited

Reimplemented from KIGFX::GAL.

Definition at line 255 of file cairo_gal.cpp.

References SHAPE_POLY_SET::COutline(), KIGFX::CAIRO_GAL_BASE::drawPoly(), i, and SHAPE_POLY_SET::OutlineCount().

256 {
257  for( int i = 0; i < aPolySet.OutlineCount(); ++i )
258  drawPoly( aPolySet.COutline( i ) );
259 }
int OutlineCount() const
Returns the number of outlines in the set
void drawPoly(const std::deque< VECTOR2D > &aPointList)
Drawing polygons & polylines is the same in cairo, so here is the common code.
Definition: cairo_gal.cpp:870
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
size_t i
Definition: json11.cpp:597

◆ DrawPolygon() [4/4]

void CAIRO_GAL_BASE::DrawPolygon ( const SHAPE_LINE_CHAIN aPolySet)
overridevirtualinherited

Reimplemented from KIGFX::GAL.

Definition at line 262 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::drawPoly().

263 {
264  drawPoly( aPolygon );
265 }
void drawPoly(const std::deque< VECTOR2D > &aPointList)
Drawing polygons & polylines is the same in cairo, so here is the common code.
Definition: cairo_gal.cpp:870

◆ DrawPolyline() [1/3]

virtual void KIGFX::CAIRO_GAL_BASE::DrawPolyline ( const std::deque< VECTOR2D > &  aPointList)
inlineoverridevirtualinherited

Draw a polyline.

Parameters
aPointListis a list of 2D-Vectors containing the polyline points.

Reimplemented from KIGFX::GAL.

Definition at line 102 of file cairo_gal.h.

References KIGFX::CAIRO_GAL_BASE::drawPoly().

102 { drawPoly( aPointList ); }
void drawPoly(const std::deque< VECTOR2D > &aPointList)
Drawing polygons & polylines is the same in cairo, so here is the common code.
Definition: cairo_gal.cpp:870

◆ DrawPolyline() [2/3]

virtual void KIGFX::CAIRO_GAL_BASE::DrawPolyline ( const VECTOR2D  aPointList[],
int  aListSize 
)
inlineoverridevirtualinherited

Reimplemented from KIGFX::GAL.

Definition at line 103 of file cairo_gal.h.

References KIGFX::CAIRO_GAL_BASE::drawPoly().

103 { drawPoly( aPointList, aListSize ); }
void drawPoly(const std::deque< VECTOR2D > &aPointList)
Drawing polygons & polylines is the same in cairo, so here is the common code.
Definition: cairo_gal.cpp:870

◆ DrawPolyline() [3/3]

virtual void KIGFX::CAIRO_GAL_BASE::DrawPolyline ( const SHAPE_LINE_CHAIN aLineChain)
inlineoverridevirtualinherited

Reimplemented from KIGFX::GAL.

Definition at line 104 of file cairo_gal.h.

References KIGFX::CAIRO_GAL_BASE::drawPoly().

104 { drawPoly( aLineChain ); }
void drawPoly(const std::deque< VECTOR2D > &aPointList)
Drawing polygons & polylines is the same in cairo, so here is the common code.
Definition: cairo_gal.cpp:870

◆ DrawRectangle()

void CAIRO_GAL_BASE::DrawRectangle ( const VECTOR2D aStartPoint,
const VECTOR2D aEndPoint 
)
overridevirtualinherited

Draw a rectangle.

Parameters
aStartPointis the start point of the rectangle.
aEndPointis the end point of the rectangle.

Reimplemented from KIGFX::GAL.

Definition at line 237 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::flushPath(), KIGFX::CAIRO_GAL_BASE::isElementAdded, VECTOR2< T >::x, and VECTOR2< T >::y.

238 {
239  // Calculate the diagonal points
240  VECTOR2D diagonalPointA( aEndPoint.x, aStartPoint.y );
241  VECTOR2D diagonalPointB( aStartPoint.x, aEndPoint.y );
242 
243  // The path is composed from 4 segments
244  cairo_move_to( currentContext, aStartPoint.x, aStartPoint.y );
245  cairo_line_to( currentContext, diagonalPointA.x, diagonalPointA.y );
246  cairo_line_to( currentContext, aEndPoint.x, aEndPoint.y );
247  cairo_line_to( currentContext, diagonalPointB.x, diagonalPointB.y );
248  cairo_close_path( currentContext );
249  flushPath();
250 
251  isElementAdded = true;
252 }
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:267

◆ DrawSegment()

void CAIRO_GAL_BASE::DrawSegment ( const VECTOR2D aStartPoint,
const VECTOR2D aEndPoint,
double  aWidth 
)
overridevirtualinherited

Draw a rounded segment.

Start and end points are defined as 2D-Vectors.

Parameters
aStartPointis the start point of the segment.
aEndPointis the end point of the segment.
aWidthis a width of the segment

Reimplemented from KIGFX::GAL.

Definition at line 101 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::currentContext, VECTOR2< T >::EuclideanNorm(), KIGFX::GAL::fillColor, KIGFX::CAIRO_GAL_BASE::flushPath(), KIGFX::COLOR4D::g, KIGFX::CAIRO_GAL_BASE::isElementAdded, KIGFX::GAL::isFillEnabled, KIGFX::COLOR4D::r, KIGFX::CAIRO_GAL_BASE::SetLineWidth(), KIGFX::GAL::strokeColor, VECTOR2< T >::x, and VECTOR2< T >::y.

103 {
104  if( isFillEnabled )
105  {
106  // Filled tracks mode
107  SetLineWidth( aWidth );
108 
109  cairo_move_to( currentContext, (double) aStartPoint.x, (double) aStartPoint.y );
110  cairo_line_to( currentContext, (double) aEndPoint.x, (double) aEndPoint.y );
111  cairo_set_source_rgba( currentContext, fillColor.r, fillColor.g, fillColor.b, fillColor.a );
112  cairo_stroke( currentContext );
113  }
114  else
115  {
116  // Outline mode for tracks
117  VECTOR2D startEndVector = aEndPoint - aStartPoint;
118  double lineAngle = atan2( startEndVector.y, startEndVector.x );
119  double lineLength = startEndVector.EuclideanNorm();
120 
121  cairo_save( currentContext );
122 
123  cairo_set_source_rgba( currentContext, strokeColor.r, strokeColor.g, strokeColor.b, strokeColor.a );
124 
125  cairo_translate( currentContext, aStartPoint.x, aStartPoint.y );
126  cairo_rotate( currentContext, lineAngle );
127 
128  cairo_arc( currentContext, 0.0, 0.0, aWidth / 2.0, M_PI / 2.0, 3.0 * M_PI / 2.0 );
129  cairo_arc( currentContext, lineLength, 0.0, aWidth / 2.0, -M_PI / 2.0, M_PI / 2.0 );
130 
131  cairo_move_to( currentContext, 0.0, aWidth / 2.0 );
132  cairo_line_to( currentContext, lineLength, aWidth / 2.0 );
133 
134  cairo_move_to( currentContext, 0.0, -aWidth / 2.0 );
135  cairo_line_to( currentContext, lineLength, -aWidth / 2.0 );
136 
137  cairo_restore( currentContext );
138  flushPath();
139  }
140 
141  isElementAdded = true;
142 }
double g
Green component.
Definition: color4d.h:288
COLOR4D fillColor
The fill color.
double b
Blue component.
Definition: color4d.h:289
double a
Alpha component.
Definition: color4d.h:290
COLOR4D strokeColor
The color of the outlines.
bool isFillEnabled
Is filling of graphic objects enabled ?
virtual void SetLineWidth(float aLineWidth) override
Set the line width.
Definition: cairo_gal.cpp:425
T EuclideanNorm() const
Destructor.
Definition: vector2d.h:292
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
double r
Red component.
Definition: color4d.h:287
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:267

◆ EnableDepthTest()

void CAIRO_GAL_BASE::EnableDepthTest ( bool  aEnabled = false)
overridevirtualinherited

Reimplemented from KIGFX::GAL.

Definition at line 740 of file cairo_gal.cpp.

741 {
742 }

◆ endDrawing()

void CAIRO_GAL_BASE::endDrawing ( )
overrideprotectedvirtualinherited

Reimplemented from KIGFX::GAL.

Reimplemented in KIGFX::CAIRO_GAL.

Definition at line 85 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::Flush().

Referenced by KIGFX::CAIRO_GAL::endDrawing().

86 {
87  // Force remaining objects to be drawn
88  Flush();
89 }
virtual void Flush() override
Force all remaining objects to be drawn.
Definition: cairo_gal.cpp:345

◆ EndGroup()

void CAIRO_GAL_BASE::EndGroup ( )
overridevirtualinherited

End the group.

Reimplemented from KIGFX::GAL.

Reimplemented in KIGFX::CAIRO_GAL.

Definition at line 577 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::isGrouping, and KIGFX::CAIRO_GAL_BASE::storePath().

Referenced by KIGFX::CAIRO_GAL::EndGroup().

578 {
579  storePath();
580  isGrouping = false;
581 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:266

◆ endUpdate()

virtual void KIGFX::GAL::endUpdate ( )
inlineprotectedvirtualinherited

Disables item update mode.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1111 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL_UPDATE_CONTEXT::~GAL_UPDATE_CONTEXT().

1111 {}

◆ Flush()

void CAIRO_GAL_BASE::Flush ( )
overridevirtualinherited

Force all remaining objects to be drawn.

Reimplemented from KIGFX::GAL.

Definition at line 345 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::storePath().

Referenced by KIGFX::CAIRO_GAL_BASE::endDrawing().

346 {
347  storePath();
348 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804

◆ flushPath()

void CAIRO_GAL_BASE::flushPath ( )
protectedinherited

Definition at line 782 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::GAL::fillColor, KIGFX::COLOR4D::g, KIGFX::GAL::isFillEnabled, KIGFX::GAL::isStrokeEnabled, KIGFX::COLOR4D::r, and KIGFX::GAL::strokeColor.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawArc(), KIGFX::CAIRO_GAL_BASE::DrawArcSegment(), KIGFX::CAIRO_GAL_BASE::DrawCircle(), KIGFX::CAIRO_GAL_BASE::DrawCurve(), KIGFX::CAIRO_GAL_BASE::DrawLine(), KIGFX::CAIRO_GAL_BASE::drawPoly(), KIGFX::CAIRO_GAL_BASE::DrawRectangle(), and KIGFX::CAIRO_GAL_BASE::DrawSegment().

783 {
784  if( isFillEnabled )
785  {
786  cairo_set_source_rgba( currentContext,
788 
789  if( isStrokeEnabled )
790  cairo_fill_preserve( currentContext );
791  else
792  cairo_fill( currentContext );
793  }
794 
795  if( isStrokeEnabled )
796  {
797  cairo_set_source_rgba( currentContext,
799  cairo_stroke( currentContext );
800  }
801 }
double g
Green component.
Definition: color4d.h:288
COLOR4D fillColor
The fill color.
double b
Blue component.
Definition: color4d.h:289
double a
Alpha component.
Definition: color4d.h:290
bool isStrokeEnabled
Are the outlines stroked ?
COLOR4D strokeColor
The color of the outlines.
bool isFillEnabled
Is filling of graphic objects enabled ?
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
double r
Red component.
Definition: color4d.h:287

◆ GetClearColor()

const COLOR4D& KIGFX::GAL::GetClearColor ( ) const
inlineinherited

Definition at line 213 of file graphics_abstraction_layer.h.

References KIGFX::GAL::m_clearColor.

214  {
215  return m_clearColor;
216  }

◆ getCursorColor()

COLOR4D GAL::getCursorColor ( ) const
protectedinherited

Gets the actual cursor color to draw.

Definition at line 424 of file graphics_abstraction_layer.cpp.

References color, KIGFX::GAL::cursorColor, and KIGFX::GAL::isCursorEnabled.

Referenced by KIGFX::CAIRO_GAL_BASE::blitCursor(), and KIGFX::OPENGL_GAL::blitCursor().

425 {
426  auto color = cursorColor;
427 
428  // dim the cursor if it's only on because it was forced
429  // (this helps to provide a hint for active tools)
430  if( !isCursorEnabled )
431  {
432  color.a = color.a * 0.5;
433  }
434 
435  return color;
436 }
bool isCursorEnabled
Is the cursor enabled?
int color
Definition: DXF_plotter.cpp:62
COLOR4D cursorColor
Cursor color.

◆ GetFillColor()

const COLOR4D& KIGFX::GAL::GetFillColor ( ) const
inlineinherited

Get the fill color.

Returns
the color for filling a outline.

Definition at line 263 of file graphics_abstraction_layer.h.

References KIGFX::GAL::fillColor.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawArc().

264  {
265  return fillColor;
266  }
COLOR4D fillColor
The fill color.

◆ GetGAL()

GAL* KIGFX::CAIRO_PRINT_GAL::GetGAL ( )
inlineoverridevirtual

Implements KIGFX::GAL_PRINT.

Definition at line 89 of file cairo_print.h.

90  {
91  return this;
92  }

◆ GetGlyphSize()

◆ GetGridLineWidth()

float KIGFX::GAL::GetGridLineWidth ( ) const
inlineinherited

Get the grid line width.

Returns
the grid line width

Definition at line 941 of file graphics_abstraction_layer.h.

References KIGFX::GAL::gridLineWidth.

942  {
943  return gridLineWidth;
944  }
float gridLineWidth
Line width of the grid.

◆ GetGridPoint()

VECTOR2D GAL::GetGridPoint ( const VECTOR2D aPoint) const
inherited

Function GetGridPoint() For a given point it returns the nearest point belonging to the grid in world coordinates.

Parameters
aPointis the point for which the grid point is searched.
Returns
The nearest grid point in world coordinates.

Definition at line 402 of file graphics_abstraction_layer.cpp.

References KIGFX::GAL::gridOffset, KIGFX::GAL::gridSize, KiROUND(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDIT_POINTS_FACTORY::buildForPolyOutline(), and KIGFX::WX_VIEW_CONTROLS::GetRawCursorPosition().

403 {
404 #if 0
405  // This old code expects a non zero grid size, which can be wrong here.
406  return VECTOR2D( KiROUND( ( aPoint.x - gridOffset.x ) / gridSize.x ) * gridSize.x + gridOffset.x,
407  KiROUND( ( aPoint.y - gridOffset.y ) / gridSize.y ) * gridSize.y + gridOffset.y );
408 #else
409  // if grid size == 0.0 there is no grid, so use aPoint as grid reference position
410  double cx = gridSize.x > 0.0 ? KiROUND( ( aPoint.x - gridOffset.x ) / gridSize.x ) * gridSize.x + gridOffset.x
411  : aPoint.x;
412  double cy = gridSize.y > 0.0 ? KiROUND( ( aPoint.y - gridOffset.y ) / gridSize.y ) * gridSize.y + gridOffset.y
413  : aPoint.y;
414 
415  return VECTOR2D( cx, cy );
416 #endif
417 }
VECTOR2D gridOffset
The grid offset to compensate cursor position.
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:121
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
VECTOR2D gridSize
The grid size.

◆ GetGridSize()

const VECTOR2D& KIGFX::GAL::GetGridSize ( ) const
inlineinherited

Returns the grid size.

Returns
A vector containing the grid size in x and y direction.

Definition at line 893 of file graphics_abstraction_layer.h.

References KIGFX::GAL::gridSize.

Referenced by SCH_BASE_FRAME::SyncView().

894  {
895  return gridSize;
896  }
VECTOR2D gridSize
The grid size.

◆ GetHorizontalJustify()

EDA_TEXT_HJUSTIFY_T KIGFX::GAL::GetHorizontalJustify ( ) const
inlineinherited

Returns current text horizontal justification setting.

Definition at line 485 of file graphics_abstraction_layer.h.

References KIGFX::GAL::TEXT_PROPERTIES::m_horizontalJustify, and KIGFX::GAL::textProperties.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), and KIGFX::STROKE_FONT::drawSingleLineText().

486  {
488  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties
EDA_TEXT_HJUSTIFY_T m_horizontalJustify
Horizontal justification.

◆ GetLineWidth()

float KIGFX::GAL::GetLineWidth ( ) const
inlineinherited

◆ GetLookAtPoint()

const VECTOR2D& KIGFX::GAL::GetLookAtPoint ( ) const
inlineinherited

Get the look at point.

Returns
the look at point.

Definition at line 685 of file graphics_abstraction_layer.h.

References KIGFX::GAL::lookAtPoint.

686  {
687  return lookAtPoint;
688  }
VECTOR2D lookAtPoint
Point to be looked at in world space.

◆ GetMaxDepth()

double KIGFX::GAL::GetMaxDepth ( ) const
inlineinherited

Returns the maximum depth in the currently used range (the bottom).

Definition at line 754 of file graphics_abstraction_layer.h.

References KIGFX::GAL::depthRange, and VECTOR2< T >::y.

755  {
756  return depthRange.y;
757  }
VECTOR2D depthRange
Range of the depth.

◆ GetMinDepth()

double KIGFX::GAL::GetMinDepth ( ) const
inlineinherited

Returns the minimum depth in the currently used range (the top).

Definition at line 746 of file graphics_abstraction_layer.h.

References KIGFX::GAL::depthRange, and VECTOR2< T >::x.

747  {
748  return depthRange.x;
749  }
VECTOR2D depthRange
Range of the depth.

◆ getNewGroupNumber()

unsigned int CAIRO_GAL_BASE::getNewGroupNumber ( )
protectedinherited

Returns a valid key that can be used as a new group number.

Returns
An unique group number that is not used by any other group.

Definition at line 929 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::groupCounter, KIGFX::CAIRO_GAL_BASE::groups, and max.

Referenced by KIGFX::CAIRO_GAL_BASE::BeginGroup().

930 {
931  wxASSERT_MSG( groups.size() < std::numeric_limits<unsigned int>::max(),
932  wxT( "There are no free slots to store a group" ) );
933 
934  while( groups.find( groupCounter ) != groups.end() )
935  groupCounter++;
936 
937  return groupCounter++;
938 }
unsigned int groupCounter
Counter used for generating keys for groups.
Definition: cairo_gal.h:270
std::map< int, GROUP > groups
List of graphic groups.
Definition: cairo_gal.h:269
#define max(a, b)
Definition: auxiliary.h:86

◆ GetOverbarVerticalPosition()

double KIGFX::GAL::GetOverbarVerticalPosition ( ) const
inlineinherited

Compute the vertical position of an overbar, sometimes used in texts.

This is the distance between the text base line and the overbar.

Returns
the relative position of the overbar axis.

Definition at line 380 of file graphics_abstraction_layer.h.

References KIGFX::STROKE_FONT::computeOverbarVerticalPosition(), and KIGFX::GAL::strokeFont.

381  {
383  }
STROKE_FONT strokeFont
Instance of object that stores information about how to draw texts.
double computeOverbarVerticalPosition() const
Compute the vertical position of an overbar, sometimes used in texts.

◆ GetPrintCtx()

PRINT_CONTEXT* KIGFX::CAIRO_PRINT_GAL::GetPrintCtx ( ) const
inlineoverridevirtual

Implements KIGFX::GAL_PRINT.

Definition at line 94 of file cairo_print.h.

References m_printCtx.

95  {
96  return m_printCtx.get();
97  }
std::unique_ptr< CAIRO_PRINT_CTX > m_printCtx
Definition: cairo_print.h:125

◆ GetRotation()

double KIGFX::GAL::GetRotation ( ) const
inlineinherited

Get the rotation angle.

Returns
The rotation angle (radians).

Definition at line 725 of file graphics_abstraction_layer.h.

References KIGFX::GAL::rotation.

726  {
727  return rotation;
728  }
double rotation
Rotation transformation (radians)

◆ GetScreenPixelSize()

const VECTOR2I& KIGFX::GAL::GetScreenPixelSize ( ) const
inlineinherited

◆ GetScreenWorldMatrix()

const MATRIX3x3D& KIGFX::GAL::GetScreenWorldMatrix ( ) const
inlineinherited

Get the screen <-> world transformation matrix.

Returns
the transformation matrix.

Definition at line 621 of file graphics_abstraction_layer.h.

References KIGFX::GAL::screenWorldMatrix.

Referenced by KIGFX::OPENGL_GAL::getWorldPixelSize(), and KIGFX::VIEW::ToWorld().

622  {
623  return screenWorldMatrix;
624  }
MATRIX3x3D screenWorldMatrix
Screen transformation.

◆ GetStrokeColor()

const COLOR4D& KIGFX::GAL::GetStrokeColor ( ) const
inlineinherited

Get the stroke color.

Returns
the color for stroking the outline.

Definition at line 283 of file graphics_abstraction_layer.h.

References KIGFX::GAL::strokeColor.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawArc().

284  {
285  return strokeColor;
286  }
COLOR4D strokeColor
The color of the outlines.

◆ GetStrokeFont()

const STROKE_FONT& KIGFX::GAL::GetStrokeFont ( ) const
inlineinherited

Definition at line 325 of file graphics_abstraction_layer.h.

References KIGFX::GAL::strokeFont.

Referenced by EDA_TEXT::GetTextBox().

326  {
327  return strokeFont;
328  }
STROKE_FONT strokeFont
Instance of object that stores information about how to draw texts.

◆ GetTarget()

virtual RENDER_TARGET KIGFX::GAL::GetTarget ( ) const
inlinevirtualinherited

Gets the currently used target for rendering.

Returns
The current rendering target.

Reimplemented in KIGFX::CAIRO_GAL, and KIGFX::OPENGL_GAL.

Definition at line 823 of file graphics_abstraction_layer.h.

References KIGFX::TARGET_CACHED.

823 { return TARGET_CACHED; };
Main rendering target (cached)
Definition: definitions.h:41

◆ GetTextLineSize()

VECTOR2D GAL::GetTextLineSize ( const UTF8 aText) const
inherited

Compute the X and Y size of a given text.

The text is expected to be a only one line text.

Parameters
aTextis the text string (one line).
Returns
is the text size.

Definition at line 170 of file graphics_abstraction_layer.cpp.

References KIGFX::STROKE_FONT::computeTextLineSize(), and KIGFX::GAL::strokeFont.

Referenced by GraphicTextWidth(), and EDA_TEXT::LenSize().

171 {
172  // Compute the X and Y size of a given text.
173  // Because computeTextLineSize expects a one line text,
174  // aText is expected to be only one line text.
175  return strokeFont.computeTextLineSize( aText );
176 }
STROKE_FONT strokeFont
Instance of object that stores information about how to draw texts.
VECTOR2D computeTextLineSize(const UTF8 &aText) const
Compute the X and Y size of a given text.

◆ GetVerticalJustify()

EDA_TEXT_VJUSTIFY_T KIGFX::GAL::GetVerticalJustify ( ) const
inlineinherited

Returns current text vertical justification setting.

Definition at line 503 of file graphics_abstraction_layer.h.

References KIGFX::GAL::TEXT_PROPERTIES::m_verticalJustify, and KIGFX::GAL::textProperties.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), and KIGFX::STROKE_FONT::Draw().

504  {
506  }
EDA_TEXT_VJUSTIFY_T m_verticalJustify
Vertical justification.
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

◆ GetWorldScale()

double KIGFX::GAL::GetWorldScale ( ) const
inlineinherited

Get the world scale.

Returns
the actual world scale factor.

Definition at line 764 of file graphics_abstraction_layer.h.

References KIGFX::GAL::worldScale.

Referenced by GRID_HELPER::BestDragOrigin(), GRID_HELPER::BestSnapAnchor(), KIGFX::PCB_PAINTER::draw(), SCH_BASE_FRAME::RedrawScreen(), SCH_BASE_FRAME::RedrawScreen2(), and KIGFX::PREVIEW::SetConstantGlyphHeight().

765  {
766  return worldScale;
767  }
double worldScale
The scale factor world->screen.

◆ GetWorldScreenMatrix()

const MATRIX3x3D& KIGFX::GAL::GetWorldScreenMatrix ( ) const
inlineinherited

Get the world <-> screen transformation matrix.

Returns
the transformation matrix.

Definition at line 611 of file graphics_abstraction_layer.h.

References KIGFX::GAL::worldScreenMatrix.

Referenced by KIGFX::VIEW::ToScreen().

612  {
613  return worldScreenMatrix;
614  }
MATRIX3x3D worldScreenMatrix
World transformation.

◆ GetZoomFactor()

double KIGFX::GAL::GetZoomFactor ( ) const
inlineinherited

Get the zoom factor.

Returns
the zoom factor.

Definition at line 705 of file graphics_abstraction_layer.h.

References KIGFX::GAL::zoomFactor.

Referenced by EDA_DRAW_PANEL_GAL::GetLegacyZoom(), EDA_DRAW_FRAME::GetZoomLevelIndicator(), SCH_BASE_FRAME::RedrawScreen(), and SCH_BASE_FRAME::RedrawScreen2().

706  {
707  return zoomFactor;
708  }
double zoomFactor
The zoom factor.

◆ IsCairoEngine()

virtual bool KIGFX::CAIRO_GAL_BASE::IsCairoEngine ( )
inlineoverridevirtualinherited

Returns true if the GAL engine is a cairo based type.

Reimplemented from KIGFX::GAL.

Definition at line 75 of file cairo_gal.h.

75 { return true; }

◆ IsCursorEnabled()

bool KIGFX::GAL::IsCursorEnabled ( ) const
inlineinherited

Returns information about cursor visibility.

Returns
True if cursor is visible.

Definition at line 994 of file graphics_abstraction_layer.h.

References KIGFX::GAL::forceDisplayCursor, and KIGFX::GAL::isCursorEnabled.

Referenced by KIGFX::CAIRO_GAL_BASE::blitCursor(), and KIGFX::OPENGL_GAL::blitCursor().

995  {
997  }
bool isCursorEnabled
Is the cursor enabled?
bool forceDisplayCursor
Always show cursor.

◆ IsFlippedX()

bool KIGFX::GAL::IsFlippedX ( ) const
inlineinherited

Return true if flip flag for the X axis is set.

Definition at line 784 of file graphics_abstraction_layer.h.

References KIGFX::GAL::globalFlipX.

785  {
786  return globalFlipX;
787  }
bool globalFlipX
Flag for X axis flipping.

◆ IsFlippedY()

bool KIGFX::GAL::IsFlippedY ( ) const
inlineinherited

Return true if flip flag for the Y axis is set.

Definition at line 792 of file graphics_abstraction_layer.h.

References KIGFX::GAL::globalFlipY.

793  {
794  return globalFlipY;
795  }
bool globalFlipY
Flag for Y axis flipping.

◆ IsFontBold()

bool KIGFX::GAL::IsFontBold ( ) const
inlineinherited

Returns true if current font has 'bold' attribute enabled.

Definition at line 431 of file graphics_abstraction_layer.h.

References KIGFX::GAL::TEXT_PROPERTIES::m_bold, and KIGFX::GAL::textProperties.

Referenced by KIGFX::STROKE_FONT::Draw().

432  {
433  return textProperties.m_bold;
434  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

◆ IsFontItalic()

bool KIGFX::GAL::IsFontItalic ( ) const
inlineinherited

Returns true if current font has 'italic' attribute enabled.

Definition at line 449 of file graphics_abstraction_layer.h.

References KIGFX::GAL::TEXT_PROPERTIES::m_italic, and KIGFX::GAL::textProperties.

Referenced by KIGFX::STROKE_FONT::ComputeStringBoundaryLimits(), and KIGFX::STROKE_FONT::drawSingleLineText().

450  {
451  return textProperties.m_italic;
452  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

◆ IsInitialized()

virtual bool KIGFX::GAL::IsInitialized ( ) const
inlinevirtualinherited

Returns the initalization status for the canvas.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 73 of file graphics_abstraction_layer.h.

Referenced by EDA_DRAW_PANEL_GAL::onRefreshTimer().

73 { return true; }

◆ isLandscape()

bool KIGFX::CAIRO_PRINT_GAL::isLandscape ( ) const
inlineprivate

Returns true if page orientation is landscape

Definition at line 113 of file cairo_print.h.

References m_nativePaperSize, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ComputeWorldScreenMatrix().

114  {
116  }
VECTOR2D m_nativePaperSize
Printout size
Definition: cairo_print.h:119

◆ IsOpenGlEngine()

virtual bool KIGFX::GAL::IsOpenGlEngine ( )
inlinevirtualinherited

Returns true if the GAL engine is a opengl based type.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 82 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GERBVIEW_PAINTER::draw(), and KIGFX::PCB_PAINTER::draw().

82 { return false; }

◆ IsTextMirrored()

bool KIGFX::GAL::IsTextMirrored ( ) const
inlineinherited

Returns true if text should displayed mirrored.

Definition at line 467 of file graphics_abstraction_layer.h.

References KIGFX::GAL::TEXT_PROPERTIES::m_mirrored, and KIGFX::GAL::textProperties.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), and KIGFX::STROKE_FONT::drawSingleLineText().

468  {
469  return textProperties.m_mirrored;
470  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

◆ IsVisible()

virtual bool KIGFX::GAL::IsVisible ( ) const
inlinevirtualinherited

◆ lockContext()

virtual void KIGFX::GAL::lockContext ( int  aClientCookie)
inlineprotectedvirtualinherited

Private: use GAL_CONTEXT_LOCKER RAII object.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1102 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL_CONTEXT_LOCKER::GAL_CONTEXT_LOCKER().

1102 {}

◆ OnGalDisplayOptionsChanged()

void GAL::OnGalDisplayOptionsChanged ( const GAL_DISPLAY_OPTIONS aOptions)
overrideprotectedvirtualinherited

Handler for observer settings changes.

Implements KIGFX::GAL_DISPLAY_OPTIONS_OBSERVER.

Definition at line 90 of file graphics_abstraction_layer.cpp.

References KIGFX::GAL::updatedGalDisplayOptions().

91 {
92  // defer to the child class first
93  updatedGalDisplayOptions( aOptions );
94 
95  // there is no refresh to do at this level
96 }
virtual bool updatedGalDisplayOptions(const GAL_DISPLAY_OPTIONS &aOptions)
Function updatedGalDisplayOptions.

◆ PopDepth()

void KIGFX::GAL::PopDepth ( )
inlineinherited

Restores previously stored drawing depth for the depth stack.

Definition at line 1036 of file graphics_abstraction_layer.h.

References KIGFX::GAL::depthStack, and KIGFX::GAL::layerDepth.

Referenced by KIGFX::VIEW_GROUP::ViewDraw().

1037  {
1038  layerDepth = depthStack.top();
1039  depthStack.pop();
1040  }
double layerDepth
The actual layer depth.
std::stack< double > depthStack
Stored depth values.

◆ PushDepth()

void KIGFX::GAL::PushDepth ( )
inlineinherited

Stores current drawing depth on the depth stack.

Definition at line 1028 of file graphics_abstraction_layer.h.

References KIGFX::GAL::depthStack, and KIGFX::GAL::layerDepth.

Referenced by KIGFX::VIEW_GROUP::ViewDraw().

1029  {
1030  depthStack.push( layerDepth );
1031  }
double layerDepth
The actual layer depth.
std::stack< double > depthStack
Stored depth values.

◆ resetContext()

void CAIRO_GAL_BASE::resetContext ( )
protectedinherited

Definition at line 745 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::cairoWorldScreenMatrix, KIGFX::CAIRO_GAL_BASE::ClearScreen(), KIGFX::GAL::ComputeWorldScreenMatrix(), KIGFX::CAIRO_GAL_BASE::context, KIGFX::CAIRO_GAL_BASE::isElementAdded, KIGFX::GAL::lineWidth, MATRIX3x3< T >::m_data, and KIGFX::GAL::worldScreenMatrix.

Referenced by KIGFX::CAIRO_GAL_BASE::beginDrawing(), and CAIRO_PRINT_GAL().

746 {
747 
748  cairo_set_antialias( context, CAIRO_ANTIALIAS_NONE );
749 
750  ClearScreen();
751 
752  // Compute the world <-> screen transformations
754 
755  cairo_matrix_init( &cairoWorldScreenMatrix, worldScreenMatrix.m_data[0][0],
758  worldScreenMatrix.m_data[1][2] );
759 
760  cairo_set_matrix( context, &cairoWorldScreenMatrix );
761 
762  // Start drawing with a new path
763  cairo_new_path( context );
764  isElementAdded = true;
765 
766  cairo_set_line_join( context, CAIRO_LINE_JOIN_ROUND );
767  cairo_set_line_cap( context, CAIRO_LINE_CAP_ROUND );
768 
769  lineWidth = 0;
770 }
virtual void ComputeWorldScreenMatrix()
Compute the world <-> screen transformation matrix.
T m_data[3][3]
Definition: matrix3x3.h:64
virtual void ClearScreen() override
Clear the screen.
Definition: cairo_gal.cpp:351
cairo_t * context
Cairo image.
Definition: cairo_gal.h:275
MATRIX3x3D worldScreenMatrix
World transformation.
float lineWidth
The line width.
cairo_matrix_t cairoWorldScreenMatrix
Cairo world to screen transformation matrix.
Definition: cairo_gal.h:273
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:267

◆ ResetTextAttributes()

void GAL::ResetTextAttributes ( )
inherited

Reset text attributes to default styling.

Normally, custom attributes will be set individually after this, otherwise you can use SetTextAttributes()

Definition at line 155 of file graphics_abstraction_layer.cpp.

References GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_CENTER, KIGFX::GAL::SetFontBold(), KIGFX::GAL::SetFontItalic(), KIGFX::GAL::SetGlyphSize(), KIGFX::GAL::SetHorizontalJustify(), KIGFX::GAL::SetTextMirrored(), and KIGFX::GAL::SetVerticalJustify().

Referenced by KIGFX::PCB_PAINTER::draw(), and KIGFX::GAL::GAL().

156 {
157  // Tiny but non-zero - this will always need setting
158  // there is no built-in default
159  SetGlyphSize( { 1.0, 1.0 } );
160 
163 
164  SetFontBold( false );
165  SetFontItalic( false );
166  SetTextMirrored( false );
167 }
void SetFontItalic(const bool aItalic)
Set italic property of current font.
void SetFontBold(const bool aBold)
Set bold property of current font.
void SetTextMirrored(const bool aMirrored)
Set a mirrored property of text.
void SetVerticalJustify(const EDA_TEXT_VJUSTIFY_T aVerticalJustify)
Set the vertical justify for text drawing.
void SetGlyphSize(const VECTOR2D aGlyphSize)
Set the font glyph size.
void SetHorizontalJustify(const EDA_TEXT_HJUSTIFY_T aHorizontalJustify)
Set the horizontal justify for text drawing.

◆ ResizeScreen()

void CAIRO_GAL_BASE::ResizeScreen ( int  aWidth,
int  aHeight 
)
overridevirtualinherited

Resizes the canvas.

Reimplemented from KIGFX::GAL.

Reimplemented in KIGFX::CAIRO_GAL.

Definition at line 339 of file cairo_gal.cpp.

References KIGFX::GAL::screenSize.

Referenced by KIGFX::CAIRO_GAL::ResizeScreen().

340 {
341  screenSize = VECTOR2I( aWidth, aHeight );
342 }
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
VECTOR2I screenSize
Screen size in screen coordinates.

◆ Restore()

void CAIRO_GAL_BASE::Restore ( )
overridevirtualinherited

Restore the context.

Reimplemented from KIGFX::GAL.

Definition at line 544 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::CMD_RESTORE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::command, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::CAIRO_GAL_BASE::isGrouping, and KIGFX::CAIRO_GAL_BASE::storePath().

545 {
546  storePath();
547 
548  if( isGrouping )
549  {
550  GROUP_ELEMENT groupElement;
551  groupElement.command = CMD_RESTORE;
552  currentGroup->push_back( groupElement );
553  }
554  else
555  {
556  cairo_restore( currentContext );
557  }
558 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:271
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:266
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
Restore the transformation matrix.
Definition: cairo_gal.h:249

◆ RestoreScreen()

virtual void KIGFX::GAL::RestoreScreen ( )
inlinevirtualinherited

Restore the screen contents.

Reimplemented in KIGFX::CAIRO_GAL, and KIGFX::OPENGL_GAL.

Definition at line 809 of file graphics_abstraction_layer.h.

809 {};

◆ Rotate()

void CAIRO_GAL_BASE::Rotate ( double  aAngle)
overridevirtualinherited

Rotate the context.

Parameters
aAngleis the rotation angle in radians.

Reimplemented from KIGFX::GAL.

Definition at line 471 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::argument, KIGFX::CAIRO_GAL_BASE::CMD_ROTATE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::command, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::dblArg, KIGFX::CAIRO_GAL_BASE::isGrouping, and KIGFX::CAIRO_GAL_BASE::storePath().

472 {
473  storePath();
474 
475  if( isGrouping )
476  {
477  GROUP_ELEMENT groupElement;
478  groupElement.command = CMD_ROTATE;
479  groupElement.argument.dblArg[0] = aAngle;
480  currentGroup->push_back( groupElement );
481  }
482  else
483  {
484  cairo_rotate( currentContext, aAngle );
485  }
486 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
Rotate the context.
Definition: cairo_gal.h:245
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:271
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:266
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274

◆ Save()

void CAIRO_GAL_BASE::Save ( )
overridevirtualinherited

Save the context.

Reimplemented from KIGFX::GAL.

Definition at line 527 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::CMD_SAVE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::command, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::CAIRO_GAL_BASE::isGrouping, and KIGFX::CAIRO_GAL_BASE::storePath().

528 {
529  storePath();
530 
531  if( isGrouping )
532  {
533  GROUP_ELEMENT groupElement;
534  groupElement.command = CMD_SAVE;
535  currentGroup->push_back( groupElement );
536  }
537  else
538  {
539  cairo_save( currentContext );
540  }
541 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:271
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:266
Save the transformation matrix.
Definition: cairo_gal.h:248
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274

◆ SaveScreen()

virtual void KIGFX::GAL::SaveScreen ( )
inlinevirtualinherited

Save the screen contents.

Reimplemented in KIGFX::CAIRO_GAL, and KIGFX::OPENGL_GAL.

Definition at line 804 of file graphics_abstraction_layer.h.

804 {};

◆ Scale()

void CAIRO_GAL_BASE::Scale ( const VECTOR2D aScale)
overridevirtualinherited

Scale the context.

Parameters
aScaleis the scale factor for the x- and y-axis.

Reimplemented from KIGFX::GAL.

Definition at line 508 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::argument, KIGFX::CAIRO_GAL_BASE::CMD_SCALE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::command, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::dblArg, KIGFX::CAIRO_GAL_BASE::isGrouping, KIGFX::CAIRO_GAL_BASE::storePath(), VECTOR2< T >::x, and VECTOR2< T >::y.

509 {
510  storePath();
511 
512  if( isGrouping )
513  {
514  GROUP_ELEMENT groupElement;
515  groupElement.command = CMD_SCALE;
516  groupElement.argument.dblArg[0] = aScale.x;
517  groupElement.argument.dblArg[1] = aScale.y;
518  currentGroup->push_back( groupElement );
519  }
520  else
521  {
522  cairo_scale( currentContext, aScale.x, aScale.y );
523  }
524 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:271
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:266
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274

◆ SetAxesColor()

void KIGFX::GAL::SetAxesColor ( const COLOR4D aAxesColor)
inlineinherited

Set the axes color.

Parameters
aAxesColoris the color to draw the axes if enabled.

Definition at line 913 of file graphics_abstraction_layer.h.

References KIGFX::GAL::axesColor.

Referenced by KIGFX::CAIRO_GAL_BASE::CAIRO_GAL_BASE(), and KIGFX::OPENGL_GAL::OPENGL_GAL().

914  {
915  axesColor = aAxesColor;
916  }
COLOR4D axesColor
Color of the axes.

◆ SetAxesEnabled()

void KIGFX::GAL::SetAxesEnabled ( bool  aAxesEnabled)
inlineinherited

Enables drawing the axes.

Definition at line 921 of file graphics_abstraction_layer.h.

References KIGFX::GAL::axesEnabled.

Referenced by FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), KIGFX::GAL::GAL(), and FOOTPRINT_EDIT_FRAME::UseGalCanvas().

922  {
923  axesEnabled = aAxesEnabled;
924  }
bool axesEnabled
Should the axes be drawn.

◆ SetClearColor()

void KIGFX::GAL::SetClearColor ( const COLOR4D aColor)
inlineinherited

Definition at line 208 of file graphics_abstraction_layer.h.

References KIGFX::GAL::m_clearColor.

Referenced by EDA_DRAW_PANEL_GAL::onPaint().

209  {
210  m_clearColor = aColor;
211  }

◆ SetCoarseGrid()

void KIGFX::GAL::SetCoarseGrid ( int  aInterval)
inlineinherited

Draw every tick line wider.

Parameters
aIntervalincrease the width of every aInterval line, if 0 do not use this feature.

Definition at line 931 of file graphics_abstraction_layer.h.

References KIGFX::GAL::gridTick.

Referenced by KIGFX::GAL::GAL().

932  {
933  gridTick = aInterval;
934  }
int gridTick
Every tick line gets the double width.

◆ SetCursorColor()

void KIGFX::GAL::SetCursorColor ( const COLOR4D aCursorColor)
inlineinherited

Set the cursor color.

Parameters
aCursorColoris the color of the cursor.

Definition at line 1004 of file graphics_abstraction_layer.h.

References KIGFX::GAL::cursorColor.

Referenced by KIGFX::GAL::GAL(), EDA_DRAW_PANEL_GAL::onPaint(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), and PCB_DRAW_PANEL_GAL::UseColorScheme().

1005  {
1006  cursorColor = aCursorColor;
1007  }
COLOR4D cursorColor
Cursor color.

◆ SetCursorEnabled()

void KIGFX::GAL::SetCursorEnabled ( bool  aCursorEnabled)
inlineinherited

Enable/disable cursor.

Parameters
aCursorEnabledis true if the cursor should be drawn, else false.

Definition at line 985 of file graphics_abstraction_layer.h.

References KIGFX::GAL::isCursorEnabled.

Referenced by KIGFX::GAL::GAL(), and KIGFX::VIEW_CONTROLS::ShowCursor().

986  {
987  isCursorEnabled = aCursorEnabled;
988  }
bool isCursorEnabled
Is the cursor enabled?

◆ SetDepthRange()

void KIGFX::GAL::SetDepthRange ( const VECTOR2D aDepthRange)
inlineinherited

Set the range of the layer depth.

Usually required for the OpenGL implementation, any object outside this range is not drawn.

Parameters
aDepthRangeis the depth range where component x is the near clipping plane and y is the far clipping plane.

Definition at line 738 of file graphics_abstraction_layer.h.

References KIGFX::GAL::depthRange.

Referenced by KIGFX::GAL::GAL().

739  {
740  depthRange = aDepthRange;
741  }
VECTOR2D depthRange
Range of the depth.

◆ SetFillColor()

void CAIRO_GAL_BASE::SetFillColor ( const COLOR4D aColor)
overridevirtualinherited

Set the fill color.

Parameters
aColoris the color for filling.

Reimplemented from KIGFX::GAL.

Definition at line 407 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::argument, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::CMD_SET_FILLCOLOR, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::command, KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::dblArg, KIGFX::GAL::fillColor, KIGFX::COLOR4D::g, KIGFX::CAIRO_GAL_BASE::isGrouping, KIGFX::COLOR4D::r, and KIGFX::CAIRO_GAL_BASE::storePath().

408 {
409  storePath();
410  fillColor = aColor;
411 
412  if( isGrouping )
413  {
414  GROUP_ELEMENT groupElement;
415  groupElement.command = CMD_SET_FILLCOLOR;
416  groupElement.argument.dblArg[0] = fillColor.r;
417  groupElement.argument.dblArg[1] = fillColor.g;
418  groupElement.argument.dblArg[2] = fillColor.b;
419  groupElement.argument.dblArg[3] = fillColor.a;
420  currentGroup->push_back( groupElement );
421  }
422 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
double g
Green component.
Definition: color4d.h:288
COLOR4D fillColor
The fill color.
double b
Blue component.
Definition: color4d.h:289
double a
Alpha component.
Definition: color4d.h:290
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:271
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:266
double r
Red component.
Definition: color4d.h:287

◆ SetFlip()

void KIGFX::GAL::SetFlip ( bool  xAxis,
bool  yAxis 
)
inlineinherited

Sets flipping of the screen.

Parameters
xAxisis the flip flag for the X axis.
yAxisis the flip flag for the Y axis.

Definition at line 775 of file graphics_abstraction_layer.h.

References KIGFX::GAL::globalFlipX, and KIGFX::GAL::globalFlipY.

Referenced by KIGFX::GAL::GAL(), KIGFX::VIEW::SetMirror(), and BOARD_PRINTOUT::setupGal().

776  {
777  globalFlipX = xAxis;
778  globalFlipY = yAxis;
779  }
bool globalFlipX
Flag for X axis flipping.
bool globalFlipY
Flag for Y axis flipping.

◆ SetFontBold()

void KIGFX::GAL::SetFontBold ( const bool  aBold)
inlineinherited

Set bold property of current font.

Parameters
aBoldtells if the font should be bold or not.

Definition at line 423 of file graphics_abstraction_layer.h.

References KIGFX::GAL::TEXT_PROPERTIES::m_bold, and KIGFX::GAL::textProperties.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), GraphicTextWidth(), EDA_TEXT::LenSize(), KIGFX::GAL::ResetTextAttributes(), and KIGFX::GAL::SetTextAttributes().

424  {
425  textProperties.m_bold = aBold;
426  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

◆ SetFontItalic()

void KIGFX::GAL::SetFontItalic ( const bool  aItalic)
inlineinherited

Set italic property of current font.

Parameters
aItalictells if the font should be italic or not.

Definition at line 441 of file graphics_abstraction_layer.h.

References KIGFX::GAL::TEXT_PROPERTIES::m_italic, and KIGFX::GAL::textProperties.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), GraphicTextWidth(), EDA_TEXT::LenSize(), KIGFX::GAL::ResetTextAttributes(), and KIGFX::GAL::SetTextAttributes().

442  {
443  textProperties.m_italic = aItalic;
444  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

◆ SetGlyphSize()

void KIGFX::GAL::SetGlyphSize ( const VECTOR2D  aGlyphSize)
inlineinherited

Set the font glyph size.

Parameters
aGlyphSizeis the new font glyph size.

Definition at line 405 of file graphics_abstraction_layer.h.

References KIGFX::GAL::TEXT_PROPERTIES::m_glyphSize, and KIGFX::GAL::textProperties.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), GraphicTextWidth(), EDA_TEXT::LenSize(), KIGFX::GAL::ResetTextAttributes(), KIGFX::PREVIEW::SetConstantGlyphHeight(), and KIGFX::GAL::SetTextAttributes().

406  {
407  textProperties.m_glyphSize = aGlyphSize;
408  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties
VECTOR2D m_glyphSize
Size of the glyphs.

◆ SetGridColor()

void KIGFX::GAL::SetGridColor ( const COLOR4D aGridColor)
inlineinherited

Set the grid color.

Parameters
aGridColoris the grid color, it should have a low alpha value for the best effect.

Definition at line 903 of file graphics_abstraction_layer.h.

References KIGFX::GAL::gridColor.

Referenced by KIGFX::CAIRO_GAL_BASE::CAIRO_GAL_BASE(), EDA_DRAW_PANEL_GAL::onPaint(), PCB_LAYER_WIDGET::OnRenderColorChange(), KIGFX::OPENGL_GAL::OPENGL_GAL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), GERBVIEW_FRAME::SetGridColor(), PCB_DRAW_PANEL_GAL::UseColorScheme(), and GERBVIEW_FRAME::UseGalCanvas().

904  {
905  gridColor = aGridColor;
906  }
COLOR4D gridColor
Color of the grid.

◆ SetGridOrigin()

void KIGFX::GAL::SetGridOrigin ( const VECTOR2D aGridOrigin)
inlineinherited

Set the origin point for the grid.

Parameters
aGridOriginis a vector containing the grid origin point, in world coordinates.

Definition at line 864 of file graphics_abstraction_layer.h.

References KIGFX::GAL::gridOffset, KIGFX::GAL::gridOrigin, KIGFX::GAL::gridSize, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCBNEW_CONTROL::DoSetGridOrigin(), and PCB_BASE_EDIT_FRAME::SetBoard().

865  {
866  gridOrigin = aGridOrigin;
867 
868  if( gridSize.x == 0.0 || gridSize.y == 0.0 )
869  gridOffset = VECTOR2D(0.0, 0.0);
870  else
871  gridOffset = VECTOR2D( (long) gridOrigin.x % (long) gridSize.x,
872  (long) gridOrigin.y % (long) gridSize.y );
873  }
VECTOR2D gridOffset
The grid offset to compensate cursor position.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
VECTOR2D gridOrigin
The grid origin.
VECTOR2D gridSize
The grid size.

◆ SetGridSize()

void KIGFX::GAL::SetGridSize ( const VECTOR2D aGridSize)
inlineinherited

Set the grid size.

Parameters
aGridSizeis a vector containing the grid size in x and y direction.

Definition at line 880 of file graphics_abstraction_layer.h.

References KIGFX::GAL::gridOffset, KIGFX::GAL::gridOrigin, KIGFX::GAL::gridSize, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DIALOG_PAD_PROPERTIES::prepareCanvas(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), EDA_DRAW_FRAME::SetPresetGrid(), COMMON_TOOLS::updateGrid(), and PCBNEW_CONTROL::updateGrid().

881  {
882  gridSize = aGridSize;
883 
884  gridOffset = VECTOR2D( (long) gridOrigin.x % (long) gridSize.x,
885  (long) gridOrigin.y % (long) gridSize.y );
886  }
VECTOR2D gridOffset
The grid offset to compensate cursor position.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
VECTOR2D gridOrigin
The grid origin.
VECTOR2D gridSize
The grid size.

◆ SetGridVisibility()

void KIGFX::GAL::SetGridVisibility ( bool  aVisibility)
inlineinherited

Sets the visibility setting of the grid.

Parameters
aVisibilityis the new visibility setting of the grid.

Definition at line 854 of file graphics_abstraction_layer.h.

References KIGFX::GAL::gridVisibility.

Referenced by KIGFX::GAL::GAL(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBER_LAYER_WIDGET::OnRenderEnable(), EDA_DRAW_FRAME::OnToggleGridState(), and SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET().

855  {
856  gridVisibility = aVisibility;
857  }
bool gridVisibility
Should the grid be shown.

◆ SetHorizontalJustify()

void KIGFX::GAL::SetHorizontalJustify ( const EDA_TEXT_HJUSTIFY_T  aHorizontalJustify)
inlineinherited

Set the horizontal justify for text drawing.

Parameters
aHorizontalJustifyis the horizontal justify value.

Definition at line 477 of file graphics_abstraction_layer.h.

References KIGFX::GAL::TEXT_PROPERTIES::m_horizontalJustify, and KIGFX::GAL::textProperties.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GAL::ResetTextAttributes(), and KIGFX::GAL::SetTextAttributes().

478  {
479  textProperties.m_horizontalJustify = aHorizontalJustify;
480  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties
EDA_TEXT_HJUSTIFY_T m_horizontalJustify
Horizontal justification.

◆ SetIsFill()

void CAIRO_GAL_BASE::SetIsFill ( bool  aIsFillEnabled)
overridevirtualinherited

Enable/disable fill.

Parameters
aIsFillEnabledis true, when the graphics objects should be filled, else false.

Reimplemented from KIGFX::GAL.

Definition at line 359 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::argument, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::boolArg, KIGFX::CAIRO_GAL_BASE::CMD_SET_FILL, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::command, KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::GAL::isFillEnabled, KIGFX::CAIRO_GAL_BASE::isGrouping, and KIGFX::CAIRO_GAL_BASE::storePath().

360 {
361  storePath();
362  isFillEnabled = aIsFillEnabled;
363 
364  if( isGrouping )
365  {
366  GROUP_ELEMENT groupElement;
367  groupElement.command = CMD_SET_FILL;
368  groupElement.argument.boolArg = aIsFillEnabled;
369  currentGroup->push_back( groupElement );
370  }
371 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
Enable/disable filling.
Definition: cairo_gal.h:237
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:271
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:266
bool isFillEnabled
Is filling of graphic objects enabled ?

◆ SetIsStroke()

void CAIRO_GAL_BASE::SetIsStroke ( bool  aIsStrokeEnabled)
overridevirtualinherited

Enable/disable stroked outlines.

Parameters
aIsStrokeEnabledis true, if the outline of an object should be stroked.

Reimplemented from KIGFX::GAL.

Definition at line 374 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::argument, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::boolArg, KIGFX::CAIRO_GAL_BASE::CMD_SET_STROKE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::command, KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::CAIRO_GAL_BASE::isGrouping, KIGFX::GAL::isStrokeEnabled, and KIGFX::CAIRO_GAL_BASE::storePath().

375 {
376  storePath();
377  isStrokeEnabled = aIsStrokeEnabled;
378 
379  if( isGrouping )
380  {
381  GROUP_ELEMENT groupElement;
382  groupElement.command = CMD_SET_STROKE;
383  groupElement.argument.boolArg = aIsStrokeEnabled;
384  currentGroup->push_back( groupElement );
385  }
386 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
bool isStrokeEnabled
Are the outlines stroked ?
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:271
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:266
Enable/disable stroking.
Definition: cairo_gal.h:238

◆ SetLayerDepth()

void CAIRO_GAL_BASE::SetLayerDepth ( double  aLayerDepth)
overridevirtualinherited

Set the depth of the layer (position on the z-axis)

Parameters
aLayerDepththe layer depth for the objects.

Reimplemented from KIGFX::GAL.

Definition at line 448 of file cairo_gal.cpp.

References KIGFX::GAL::SetLayerDepth(), and KIGFX::CAIRO_GAL_BASE::storePath().

449 {
450  super::SetLayerDepth( aLayerDepth );
451  storePath();
452 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
virtual void SetLayerDepth(double aLayerDepth)
Set the depth of the layer (position on the z-axis)

◆ SetLineWidth()

void CAIRO_PRINT_GAL::SetLineWidth ( float  aLineWidth)
overridevirtual

Set the line width.

Parameters
aLineWidthis the line width.

Reimplemented from KIGFX::CAIRO_GAL_BASE.

Definition at line 129 of file cairo_print.cpp.

References KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::GAL::lineWidth, and KIGFX::CAIRO_GAL_BASE::storePath().

130 {
131  storePath();
132  lineWidth = aLineWidth;
133  cairo_set_line_width( currentContext, aLineWidth );
134 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
float lineWidth
The line width.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274

◆ SetLookAtPoint()

void KIGFX::GAL::SetLookAtPoint ( const VECTOR2D aPoint)
inlineinherited

Set the Point in world space to look at.

This point corresponds with the center of the actual drawing area.

Parameters
aPointis the look at point (center of the actual drawing area).

Definition at line 675 of file graphics_abstraction_layer.h.

References KIGFX::GAL::lookAtPoint.

Referenced by KIGFX::GAL::GAL(), and KIGFX::VIEW::SetCenter().

676  {
677  lookAtPoint = aPoint;
678  }
VECTOR2D lookAtPoint
Point to be looked at in world space.

◆ SetNativePaperSize()

void CAIRO_PRINT_GAL::SetNativePaperSize ( const VECTOR2D aSize,
bool  aRotateIfLandscape 
)
overridevirtual
Parameters
aSizeis the printing sheet size expressed in inches.
aRotateIfLandscapetrue if the platform requires 90 degrees rotation in order to print in landscape format.

Implements KIGFX::GAL_PRINT.

Definition at line 177 of file cairo_print.cpp.

References m_hasNativeLandscapeRotation, and m_nativePaperSize.

178 {
179  m_nativePaperSize = aSize;
180  m_hasNativeLandscapeRotation = aHasNativeLandscapeRotation;
181 }
VECTOR2D m_nativePaperSize
Printout size
Definition: cairo_print.h:119
bool m_hasNativeLandscapeRotation
Flag indicating whether the platform rotates page automatically or GAL needs to handle it in the tran...
Definition: cairo_print.h:123

◆ SetNegativeDrawMode()

void CAIRO_GAL_BASE::SetNegativeDrawMode ( bool  aSetting)
overridevirtualinherited

Sets negative draw mode in the renderer.

When negative mode is enabled, drawn items will subtract from previously drawn items. This is mainly needed for Gerber negative item support in Cairo, since unlike in OpenGL, objects drawn with zero opacity on top of other objects would not normally mask objects in Cairo. This method is a no-op in OpenGL.

Parameters
aSettingis true if negative mode should be enabled

Reimplemented from KIGFX::GAL.

Definition at line 728 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::currentContext.

729 {
730  cairo_set_operator( currentContext, aSetting ? CAIRO_OPERATOR_CLEAR : CAIRO_OPERATOR_OVER );
731 }
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274

◆ SetRotation()

void KIGFX::GAL::SetRotation ( double  aRotation)
inlineinherited

Set the rotation angle.

Parameters
aRotationis the new rotation angle (radians).

Definition at line 715 of file graphics_abstraction_layer.h.

References KIGFX::GAL::rotation.

Referenced by KIGFX::GAL::GAL().

716  {
717  rotation = aRotation;
718  }
double rotation
Rotation transformation (radians)

◆ SetScreenDPI()

void KIGFX::GAL::SetScreenDPI ( double  aScreenDPI)
inlineinherited

Set the dots per inch of the screen.

This value depends on the user screen, it should be configurable by the application. For instance a typical notebook with HD+ resolution (1600x900) has 106 DPI.

Parameters
aScreenDPIare the screen DPI.

Definition at line 663 of file graphics_abstraction_layer.h.

References KIGFX::GAL::screenDPI.

Referenced by CAIRO_PRINT_GAL(), and KIGFX::GAL::GAL().

664  {
665  screenDPI = aScreenDPI;
666  }
double screenDPI
The dots per inch of the screen.

◆ SetScreenSize()

void KIGFX::GAL::SetScreenSize ( const VECTOR2I aSize)
inlineinherited

Definition at line 650 of file graphics_abstraction_layer.h.

References KIGFX::GAL::screenSize.

Referenced by SetSheetSize().

651  {
652  screenSize = aSize;
653  }
VECTOR2I screenSize
Screen size in screen coordinates.

◆ SetSheetSize()

void CAIRO_PRINT_GAL::SetSheetSize ( const VECTOR2D aSize)
overridevirtual
Parameters
aSizeis the schematics sheet size expressed in inches.

Implements KIGFX::GAL_PRINT.

Definition at line 184 of file cairo_print.cpp.

References KIGFX::GAL::screenDPI, KIGFX::GAL::SetScreenSize(), VECTOR2< T >::x, and VECTOR2< T >::y.

185 {
186  // Convert aSize (inches) to pixels
187  SetScreenSize( VECTOR2I( std::ceil( aSize.x * screenDPI ) * 2,
188  std::ceil( aSize.y * screenDPI ) * 2 ) );
189 }
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
void SetScreenSize(const VECTOR2I &aSize)
double screenDPI
The dots per inch of the screen.

◆ SetStrokeColor()

void CAIRO_GAL_BASE::SetStrokeColor ( const COLOR4D aColor)
overridevirtualinherited

Set the stroke color.

Parameters
aColoris the color for stroking the outline.

Reimplemented from KIGFX::GAL.

Definition at line 389 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::argument, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::CMD_SET_STROKECOLOR, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::command, KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::dblArg, KIGFX::COLOR4D::g, KIGFX::CAIRO_GAL_BASE::isGrouping, KIGFX::COLOR4D::r, KIGFX::CAIRO_GAL_BASE::storePath(), and KIGFX::GAL::strokeColor.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawArc().

390 {
391  storePath();
392  strokeColor = aColor;
393 
394  if( isGrouping )
395  {
396  GROUP_ELEMENT groupElement;
397  groupElement.command = CMD_SET_STROKECOLOR;
398  groupElement.argument.dblArg[0] = strokeColor.r;
399  groupElement.argument.dblArg[1] = strokeColor.g;
400  groupElement.argument.dblArg[2] = strokeColor.b;
401  groupElement.argument.dblArg[3] = strokeColor.a;
402  currentGroup->push_back( groupElement );
403  }
404 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
double g
Green component.
Definition: color4d.h:288
double b
Blue component.
Definition: color4d.h:289
double a
Alpha component.
Definition: color4d.h:290
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:271
COLOR4D strokeColor
The color of the outlines.
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:266
double r
Red component.
Definition: color4d.h:287

◆ SetTarget()

virtual void KIGFX::GAL::SetTarget ( RENDER_TARGET  aTarget)
inlinevirtualinherited

Sets the target for rendering.

Parameters
aTargetis the new target for rendering.

Reimplemented in KIGFX::CAIRO_GAL, and KIGFX::OPENGL_GAL.

Definition at line 816 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL::DrawGrid(), KIGFX::VIEW::redrawRect(), and KIGFX::VIEW::updateItemGeometry().

816 {};

◆ SetTextAttributes()

void GAL::SetTextAttributes ( const EDA_TEXT aText)
virtualinherited

Loads attributes of the given text (bold/italic/underline/mirrored and so on).

Parameters
aTextis the text item.

Definition at line 144 of file graphics_abstraction_layer.cpp.

References EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetVertJustify(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), KIGFX::GAL::SetFontBold(), KIGFX::GAL::SetFontItalic(), KIGFX::GAL::SetGlyphSize(), KIGFX::GAL::SetHorizontalJustify(), KIGFX::GAL::SetTextMirrored(), and KIGFX::GAL::SetVerticalJustify().

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::WORKSHEET_VIEWITEM::draw(), KIGFX::PCB_PAINTER::draw(), and DrawGraphicText().

145 {
146  SetGlyphSize( VECTOR2D( aText->GetTextSize() ) );
149  SetFontBold( aText->IsBold() );
150  SetFontItalic( aText->IsItalic() );
151  SetTextMirrored( aText->IsMirrored() );
152 }
void SetFontItalic(const bool aItalic)
Set italic property of current font.
bool IsBold() const
Definition: eda_text.h:186
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:204
bool IsMirrored() const
Definition: eda_text.h:192
bool IsItalic() const
Definition: eda_text.h:183
void SetFontBold(const bool aBold)
Set bold property of current font.
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:203
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
const wxSize & GetTextSize() const
Definition: eda_text.h:228
void SetTextMirrored(const bool aMirrored)
Set a mirrored property of text.
void SetVerticalJustify(const EDA_TEXT_VJUSTIFY_T aVerticalJustify)
Set the vertical justify for text drawing.
void SetGlyphSize(const VECTOR2D aGlyphSize)
Set the font glyph size.
void SetHorizontalJustify(const EDA_TEXT_HJUSTIFY_T aHorizontalJustify)
Set the horizontal justify for text drawing.

◆ SetTextMirrored()

void KIGFX::GAL::SetTextMirrored ( const bool  aMirrored)
inlineinherited

Set a mirrored property of text.

Parameters
aMirroredtells if the text should be mirrored or not.

Definition at line 459 of file graphics_abstraction_layer.h.

References KIGFX::GAL::TEXT_PROPERTIES::m_mirrored, and KIGFX::GAL::textProperties.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GAL::ResetTextAttributes(), and KIGFX::GAL::SetTextAttributes().

460  {
461  textProperties.m_mirrored = aMirrored;
462  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

◆ SetVerticalJustify()

void KIGFX::GAL::SetVerticalJustify ( const EDA_TEXT_VJUSTIFY_T  aVerticalJustify)
inlineinherited

Set the vertical justify for text drawing.

Parameters
aVerticalJustifyis the vertical justify value.

Definition at line 495 of file graphics_abstraction_layer.h.

References KIGFX::GAL::TEXT_PROPERTIES::m_verticalJustify, and KIGFX::GAL::textProperties.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GAL::ResetTextAttributes(), and KIGFX::GAL::SetTextAttributes().

496  {
497  textProperties.m_verticalJustify = aVerticalJustify;
498  }
EDA_TEXT_VJUSTIFY_T m_verticalJustify
Vertical justification.
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

◆ SetWorldScreenMatrix()

void KIGFX::GAL::SetWorldScreenMatrix ( const MATRIX3x3D aMatrix)
inlineinherited

Set the world <-> screen transformation matrix.

Parameters
aMatrixis the 3x3 world <-> screen transformation matrix.

Definition at line 631 of file graphics_abstraction_layer.h.

References KIGFX::GAL::worldScreenMatrix.

632  {
633  worldScreenMatrix = aMatrix;
634  }
MATRIX3x3D worldScreenMatrix
World transformation.

◆ SetWorldUnitLength()

void KIGFX::GAL::SetWorldUnitLength ( double  aWorldUnitLength)
inlineinherited

Set the unit length.

This defines the length [inch] per one integer. For instance a value 0.001 means that the coordinate [1000, 1000] corresponds with a point at (1 inch, 1 inch) or 1 mil resolution per integer.

Parameters
aWorldUnitLengthis the world Unit length.

Definition at line 645 of file graphics_abstraction_layer.h.

References KIGFX::GAL::worldUnitLength.

Referenced by KIGFX::GAL::GAL(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), GERBVIEW_PRINTOUT::setupGal(), PCBNEW_PRINTOUT::setupGal(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), and PCB_DRAW_PANEL_GAL::SwitchBackend().

646  {
647  worldUnitLength = aWorldUnitLength;
648  }
double worldUnitLength
The unit length of the world coordinates [inch].

◆ SetZoomFactor()

void KIGFX::GAL::SetZoomFactor ( double  aZoomFactor)
inlineinherited

Set the zoom factor of the scene.

Parameters
aZoomFactoris the zoom factor.

Definition at line 695 of file graphics_abstraction_layer.h.

References KIGFX::GAL::zoomFactor.

Referenced by KIGFX::GAL::GAL(), and KIGFX::VIEW::SetScale().

696  {
697  zoomFactor = aZoomFactor;
698  }
double zoomFactor
The zoom factor.

◆ Show()

virtual bool KIGFX::GAL::Show ( bool  aShow)
inlinevirtualinherited

Shows/hides the GAL canvas.

Reimplemented in KIGFX::CAIRO_GAL, and KIGFX::OPENGL_GAL.

Definition at line 197 of file graphics_abstraction_layer.h.

197 { return true; };

◆ storePath()

void CAIRO_GAL_BASE::storePath ( )
protectedinherited

Store the actual path.

Definition at line 804 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::cairoPath, KIGFX::CAIRO_GAL_BASE::CMD_FILL_PATH, KIGFX::CAIRO_GAL_BASE::CMD_STROKE_PATH, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::command, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::GAL::fillColor, KIGFX::COLOR4D::g, KIGFX::CAIRO_GAL_BASE::isElementAdded, KIGFX::GAL::isFillEnabled, KIGFX::CAIRO_GAL_BASE::isGrouping, KIGFX::GAL::isStrokeEnabled, KIGFX::COLOR4D::r, and KIGFX::GAL::strokeColor.

Referenced by KIGFX::CAIRO_GAL_BASE::BeginGroup(), KIGFX::CAIRO_GAL_BASE::ChangeGroupColor(), KIGFX::CAIRO_GAL_BASE::DeleteGroup(), KIGFX::CAIRO_GAL_BASE::DrawGroup(), KIGFX::CAIRO_GAL_BASE::EndGroup(), KIGFX::CAIRO_GAL_BASE::Flush(), KIGFX::CAIRO_GAL_BASE::Restore(), KIGFX::CAIRO_GAL_BASE::Rotate(), KIGFX::CAIRO_GAL_BASE::Save(), KIGFX::CAIRO_GAL_BASE::Scale(), KIGFX::CAIRO_GAL_BASE::SetFillColor(), KIGFX::CAIRO_GAL_BASE::SetIsFill(), KIGFX::CAIRO_GAL_BASE::SetIsStroke(), KIGFX::CAIRO_GAL_BASE::SetLayerDepth(), SetLineWidth(), KIGFX::CAIRO_GAL_BASE::SetLineWidth(), KIGFX::CAIRO_GAL_BASE::SetStrokeColor(), KIGFX::CAIRO_GAL::SetTarget(), and KIGFX::CAIRO_GAL_BASE::Translate().

805 {
806  if( isElementAdded )
807  {
808  isElementAdded = false;
809 
810  if( !isGrouping )
811  {
812  if( isFillEnabled )
813  {
814  cairo_set_source_rgba( currentContext, fillColor.r, fillColor.g, fillColor.b, fillColor.a );
815  cairo_fill_preserve( currentContext );
816  }
817 
818  if( isStrokeEnabled )
819  {
820  cairo_set_source_rgba( currentContext, strokeColor.r, strokeColor.g,
822  cairo_stroke_preserve( currentContext );
823  }
824  }
825  else
826  {
827  // Copy the actual path, append it to the global path list
828  // then check, if the path needs to be stroked/filled and
829  // add this command to the group list;
830  if( isStrokeEnabled )
831  {
832  GROUP_ELEMENT groupElement;
833  groupElement.cairoPath = cairo_copy_path( currentContext );
834  groupElement.command = CMD_STROKE_PATH;
835  currentGroup->push_back( groupElement );
836  }
837 
838  if( isFillEnabled )
839  {
840  GROUP_ELEMENT groupElement;
841  groupElement.cairoPath = cairo_copy_path( currentContext );
842  groupElement.command = CMD_FILL_PATH;
843  currentGroup->push_back( groupElement );
844  }
845  }
846 
847  cairo_new_path( currentContext );
848  }
849 }
double g
Green component.
Definition: color4d.h:288
COLOR4D fillColor
The fill color.
double b
Blue component.
Definition: color4d.h:289
double a
Alpha component.
Definition: color4d.h:290
bool isStrokeEnabled
Are the outlines stroked ?
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:271
COLOR4D strokeColor
The color of the outlines.
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:266
bool isFillEnabled
Is filling of graphic objects enabled ?
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274
double r
Red component.
Definition: color4d.h:287
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:267

◆ StrokeText()

virtual void KIGFX::GAL::StrokeText ( const wxString &  aText,
const VECTOR2D aPosition,
double  aRotationAngle 
)
inlinevirtualinherited

Draws a vector type text using preloaded Newstroke font.

Parameters
aTextis the text to be drawn.
aPositionis the text position in world coordinates.
aRotationAngleis the text rotation angle.

Definition at line 337 of file graphics_abstraction_layer.h.

References KIGFX::STROKE_FONT::Draw(), and KIGFX::GAL::strokeFont.

Referenced by KIGFX::GAL::BitmapText(), KIGFX::SCH_PAINTER::draw(), KIGFX::WORKSHEET_VIEWITEM::draw(), KIGFX::PCB_PAINTER::draw(), and DrawGraphicText().

339  {
340  strokeFont.Draw( aText, aPosition, aRotationAngle );
341  }
STROKE_FONT strokeFont
Instance of object that stores information about how to draw texts.
void Draw(const UTF8 &aText, const VECTOR2D &aPosition, double aRotationAngle)
Draw a string.

◆ ToScreen()

VECTOR2D KIGFX::GAL::ToScreen ( const VECTOR2D aPoint) const
inlineinherited

Compute the point position in screen coordinates from given world coordinates.

Parameters
aPointthe pointposition in world coordinates.
Returns
the point position in screen coordinates.

Definition at line 975 of file graphics_abstraction_layer.h.

References KIGFX::GAL::worldScreenMatrix.

Referenced by KIGFX::CAIRO_GAL_BASE::blitCursor().

976  {
977  return VECTOR2D( worldScreenMatrix * aPoint );
978  }
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
MATRIX3x3D worldScreenMatrix
World transformation.

◆ ToWorld()

VECTOR2D KIGFX::GAL::ToWorld ( const VECTOR2D aPoint) const
inlineinherited

Compute the point position in world coordinates from given screen coordinates.

Parameters
aPointthe pointposition in screen coordinates.
Returns
the point position in world coordinates.

Definition at line 964 of file graphics_abstraction_layer.h.

References KIGFX::GAL::screenWorldMatrix.

965  {
966  return VECTOR2D( screenWorldMatrix * aPoint );
967  }
MATRIX3x3D screenWorldMatrix
Screen transformation.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586

◆ Transform()

void CAIRO_GAL_BASE::Transform ( const MATRIX3x3D aTransformation)
overridevirtualinherited

Transform the context.

Parameters
aTransformationis the transformation matrix.

Reimplemented from KIGFX::GAL.

Definition at line 455 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::currentContext, and MATRIX3x3< T >::m_data.

456 {
457  cairo_matrix_t cairoTransformation;
458 
459  cairo_matrix_init( &cairoTransformation,
460  aTransformation.m_data[0][0],
461  aTransformation.m_data[1][0],
462  aTransformation.m_data[0][1],
463  aTransformation.m_data[1][1],
464  aTransformation.m_data[0][2],
465  aTransformation.m_data[1][2] );
466 
467  cairo_transform( currentContext, &cairoTransformation );
468 }
T m_data[3][3]
Definition: matrix3x3.h:64
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274

◆ Translate()

void CAIRO_GAL_BASE::Translate ( const VECTOR2D aTranslation)
overridevirtualinherited

Translate the context.

Parameters
aTranslationis the translation vector.

Reimplemented from KIGFX::GAL.

Definition at line 489 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::argument, KIGFX::CAIRO_GAL_BASE::CMD_TRANSLATE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::command, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::dblArg, KIGFX::CAIRO_GAL_BASE::isGrouping, KIGFX::CAIRO_GAL_BASE::storePath(), VECTOR2< T >::x, and VECTOR2< T >::y.

490 {
491  storePath();
492 
493  if( isGrouping )
494  {
495  GROUP_ELEMENT groupElement;
496  groupElement.command = CMD_TRANSLATE;
497  groupElement.argument.dblArg[0] = aTranslation.x;
498  groupElement.argument.dblArg[1] = aTranslation.y;
499  currentGroup->push_back( groupElement );
500  }
501  else
502  {
503  cairo_translate( currentContext, aTranslation.x, aTranslation.y );
504  }
505 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:804
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:271
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:266
Translate the context.
Definition: cairo_gal.h:246
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:274

◆ unlockContext()

virtual void KIGFX::GAL::unlockContext ( int  aClientCookie)
inlineprotectedvirtualinherited

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1104 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL_CONTEXT_LOCKER::~GAL_CONTEXT_LOCKER().

1104 {}

◆ updatedGalDisplayOptions()

bool GAL::updatedGalDisplayOptions ( const GAL_DISPLAY_OPTIONS aOptions)
protectedvirtualinherited

Function updatedGalDisplayOptions.

handler for updated display options. Derived classes should call up to this to set base-class methods.

Returns
true if the new settings changed something. Derived classes can use this information to refresh themselves

Reimplemented in KIGFX::CAIRO_GAL, and KIGFX::OPENGL_GAL.

Definition at line 99 of file graphics_abstraction_layer.cpp.

References KIGFX::GAL::axesEnabled, KIGFX::GAL::forceDisplayCursor, KIGFX::GAL::fullscreenCursor, KIGFX::GAL::gridLineWidth, KIGFX::GAL::gridMinSpacing, KIGFX::GAL::gridStyle, KIGFX::GAL_DISPLAY_OPTIONS::m_axesEnabled, KIGFX::GAL_DISPLAY_OPTIONS::m_forceDisplayCursor, KIGFX::GAL_DISPLAY_OPTIONS::m_fullscreenCursor, KIGFX::GAL_DISPLAY_OPTIONS::m_gridLineWidth, KIGFX::GAL_DISPLAY_OPTIONS::m_gridMinSpacing, KIGFX::GAL_DISPLAY_OPTIONS::m_gridStyle, and KIGFX::GAL::options.

Referenced by KIGFX::GAL::OnGalDisplayOptionsChanged(), KIGFX::OPENGL_GAL::updatedGalDisplayOptions(), and KIGFX::CAIRO_GAL::updatedGalDisplayOptions().

100 {
101  bool refresh = false;
102 
103  if( options.m_gridStyle != gridStyle )
104  {
106  refresh = true;
107  }
108 
110  {
112  refresh = true;
113  }
114 
116  {
118  refresh = true;
119  }
120 
122  {
124  refresh = true;
125  }
126 
128  {
130  refresh = true;
131  }
132 
134  {
136  refresh = true;
137  }
138 
139  // tell the derived class if the base class needs an update or not
140  return refresh;
141 }
bool axesEnabled
Should the axes be drawn.
KIGFX::GRID_STYLE m_gridStyle
The grid style to draw the grid in
int gridMinSpacing
Minimum screen size of the grid (pixels) below which the grid is not drawn.
GRID_STYLE gridStyle
Grid display style.
GAL_DISPLAY_OPTIONS & options
bool m_forceDisplayCursor
Force cursor display
double m_gridMinSpacing
Minimum pixel distance between displayed grid lines
bool m_axesEnabled
Whether or not to draw the coordinate system axes
bool fullscreenCursor
Shape of the cursor (fullscreen or small cross)
float gridLineWidth
Line width of the grid.
double m_gridLineWidth
Thickness to render grid lines/dots
bool m_fullscreenCursor
Fullscreen crosshair or small cross
bool forceDisplayCursor
Always show cursor.

Member Data Documentation

◆ axesColor

COLOR4D KIGFX::GAL::axesColor
protectedinherited

Color of the axes.

Definition at line 1084 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::GAL::DrawGrid(), and KIGFX::GAL::SetAxesColor().

◆ axesEnabled

bool KIGFX::GAL::axesEnabled
protectedinherited

◆ cairoWorldScreenMatrix

cairo_matrix_t KIGFX::CAIRO_GAL_BASE::cairoWorldScreenMatrix
protectedinherited

Cairo world to screen transformation matrix.

Definition at line 273 of file cairo_gal.h.

Referenced by KIGFX::CAIRO_GAL_BASE::CAIRO_GAL_BASE(), and KIGFX::CAIRO_GAL_BASE::resetContext().

◆ context

◆ currentContext

◆ currentGroup

◆ cursorColor

COLOR4D KIGFX::GAL::cursorColor
protectedinherited

Cursor color.

Definition at line 1094 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL::getCursorColor(), and KIGFX::GAL::SetCursorColor().

◆ cursorPosition

VECTOR2D KIGFX::GAL::cursorPosition
protectedinherited

◆ depthRange

◆ depthStack

std::stack<double> KIGFX::GAL::depthStack
protectedinherited

Stored depth values.

Definition at line 1049 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL::PopDepth(), and KIGFX::GAL::PushDepth().

◆ fillColor

◆ forceDisplayCursor

bool KIGFX::GAL::forceDisplayCursor
protectedinherited

◆ fullscreenCursor

bool KIGFX::GAL::fullscreenCursor
protectedinherited

Shape of the cursor (fullscreen or small cross)

Definition at line 1095 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL_BASE::blitCursor(), KIGFX::OPENGL_GAL::blitCursor(), KIGFX::GAL::GAL(), and KIGFX::GAL::updatedGalDisplayOptions().

◆ GAL_FORMAT

constexpr cairo_format_t KIGFX::CAIRO_GAL_BASE::GAL_FORMAT = CAIRO_FORMAT_RGB24
staticprotectedinherited

Format used to store pixels.

Definition at line 299 of file cairo_gal.h.

Referenced by KIGFX::CAIRO_GAL::allocateBitmaps(), and KIGFX::CAIRO_GAL::initSurface().

◆ globalFlipX

bool KIGFX::GAL::globalFlipX
protectedinherited

◆ globalFlipY

bool KIGFX::GAL::globalFlipY
protectedinherited

◆ GRID_DEPTH

const int GAL::GRID_DEPTH = MAX_DEPTH - 1
staticprotectedinherited

Depth level on which the grid is drawn.

Definition at line 1147 of file graphics_abstraction_layer.h.

◆ gridColor

COLOR4D KIGFX::GAL::gridColor
protectedinherited

Color of the grid.

Definition at line 1083 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::GAL::DrawGrid(), and KIGFX::GAL::SetGridColor().

◆ gridLineWidth

float KIGFX::GAL::gridLineWidth
protectedinherited

◆ gridMinSpacing

int KIGFX::GAL::gridMinSpacing
protectedinherited

Minimum screen size of the grid (pixels) below which the grid is not drawn.

Definition at line 1088 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL::computeMinGridSpacing(), KIGFX::GAL::GAL(), and KIGFX::GAL::updatedGalDisplayOptions().

◆ gridOffset

VECTOR2D KIGFX::GAL::gridOffset
protectedinherited

The grid offset to compensate cursor position.

Definition at line 1082 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL::GetGridPoint(), KIGFX::GAL::SetGridOrigin(), and KIGFX::GAL::SetGridSize().

◆ gridOrigin

VECTOR2D KIGFX::GAL::gridOrigin
protectedinherited

◆ gridSize

◆ gridStyle

GRID_STYLE KIGFX::GAL::gridStyle
protectedinherited

◆ gridTick

int KIGFX::GAL::gridTick
protectedinherited

Every tick line gets the double width.

Definition at line 1086 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::GAL::DrawGrid(), and KIGFX::GAL::SetCoarseGrid().

◆ gridVisibility

bool KIGFX::GAL::gridVisibility
protectedinherited

Should the grid be shown.

Definition at line 1078 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::GAL::DrawGrid(), and KIGFX::GAL::SetGridVisibility().

◆ groupCounter

unsigned int KIGFX::CAIRO_GAL_BASE::groupCounter
protectedinherited

Counter used for generating keys for groups.

Definition at line 270 of file cairo_gal.h.

Referenced by KIGFX::CAIRO_GAL_BASE::CAIRO_GAL_BASE(), and KIGFX::CAIRO_GAL_BASE::getNewGroupNumber().

◆ groups

◆ isCursorEnabled

bool KIGFX::GAL::isCursorEnabled
protectedinherited

◆ isElementAdded

◆ isFillEnabled

◆ isGrouping

◆ isStrokeEnabled

◆ layerDepth

◆ lineWidth

◆ lookAtPoint

VECTOR2D KIGFX::GAL::lookAtPoint
protectedinherited

◆ m_clearColor

◆ m_hasNativeLandscapeRotation

bool KIGFX::CAIRO_PRINT_GAL::m_hasNativeLandscapeRotation
private

Flag indicating whether the platform rotates page automatically or GAL needs to handle it in the transformation matrix

Definition at line 123 of file cairo_print.h.

Referenced by CAIRO_PRINT_GAL(), ComputeWorldScreenMatrix(), and SetNativePaperSize().

◆ m_nativePaperSize

VECTOR2D KIGFX::CAIRO_PRINT_GAL::m_nativePaperSize
private

Printout size

Definition at line 119 of file cairo_print.h.

Referenced by ComputeWorldScreenMatrix(), isLandscape(), and SetNativePaperSize().

◆ m_printCtx

std::unique_ptr<CAIRO_PRINT_CTX> KIGFX::CAIRO_PRINT_GAL::m_printCtx
private

Definition at line 125 of file cairo_print.h.

Referenced by CAIRO_PRINT_GAL(), and GetPrintCtx().

◆ MAX_CAIRO_ARGUMENTS

const int KIGFX::CAIRO_GAL_BASE::MAX_CAIRO_ARGUMENTS = 4
staticprotectedinherited

Maximum number of arguments for one command.

Definition at line 232 of file cairo_gal.h.

◆ MAX_DEPTH

const int GAL::MAX_DEPTH = 1023
staticprotectedinherited

Definition at line 1144 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL::GAL().

◆ MIN_DEPTH

const int GAL::MIN_DEPTH = -1024
staticprotectedinherited

Possible depth range.

Definition at line 1140 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL::GAL().

◆ observerLink

UTIL::LINK KIGFX::GAL::observerLink
protectedinherited

Definition at line 1047 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL::GAL().

◆ options

◆ rotation

double KIGFX::GAL::rotation
protectedinherited

Rotation transformation (radians)

Definition at line 1057 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL::ComputeWorldScreenMatrix(), KIGFX::GAL::GetRotation(), and KIGFX::GAL::SetRotation().

◆ screenDPI

double KIGFX::GAL::screenDPI
protectedinherited

The dots per inch of the screen.

Definition at line 1053 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL::computeWorldScale(), ComputeWorldScreenMatrix(), KIGFX::GAL::SetScreenDPI(), and SetSheetSize().

◆ screenSize

◆ screenWorldMatrix

◆ strokeColor

◆ strokeFont

STROKE_FONT KIGFX::GAL::strokeFont
protectedinherited

Instance of object that stores information about how to draw texts.

Definition at line 1099 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL::GAL(), KIGFX::GAL::GetOverbarVerticalPosition(), KIGFX::GAL::GetStrokeFont(), KIGFX::GAL::GetTextLineSize(), and KIGFX::GAL::StrokeText().

◆ surface

cairo_surface_t* KIGFX::CAIRO_GAL_BASE::surface
protectedinherited

◆ worldScale

◆ worldScreenMatrix

◆ worldUnitLength

double KIGFX::GAL::worldUnitLength
protectedinherited

◆ zoomFactor

double KIGFX::GAL::zoomFactor
protectedinherited

The documentation for this class was generated from the following files: