KiCad PCB EDA Suite
KIGFX::CAIRO_GAL Class Reference

#include <cairo_gal.h>

Inheritance diagram for KIGFX::CAIRO_GAL:
KIGFX::CAIRO_GAL_BASE KIGFX::GAL KIGFX::GAL_DISPLAY_OPTIONS_OBSERVER

Public Member Functions

 CAIRO_GAL (GAL_DISPLAY_OPTIONS &aDisplayOptions, wxWindow *aParent, wxEvtHandler *aMouseListener=NULL, wxEvtHandler *aPaintListener=NULL, const wxString &aName=wxT("CairoCanvas"))
 Constructor CAIRO_GAL_BASE. More...
 
virtual ~CAIRO_GAL ()
 
bool IsVisible () const override
 

More...
 
virtual void ResizeScreen (int aWidth, int aHeight) override
 Resizes the canvas. More...
 
virtual bool Show (bool aShow) override
 Shows/hides the GAL canvas. More...
 
virtual void SaveScreen () override
 Save the screen contents. More...
 
virtual void RestoreScreen () override
 Restore the screen contents. More...
 
virtual int BeginGroup () override
 Begin a group. More...
 
virtual void EndGroup () override
 End the group. More...
 
virtual void SetTarget (RENDER_TARGET aTarget) override
 Sets the target for rendering. More...
 
virtual RENDER_TARGET GetTarget () const override
 Gets the currently used target for rendering. More...
 
virtual void ClearTarget (RENDER_TARGET aTarget) override
 Clears the target for rendering. More...
 
void PostPaint ()
 Function PostPaint posts an event to m_paint_listener. More...
 
void SetMouseListener (wxEvtHandler *aMouseListener)
 
void SetPaintListener (wxEvtHandler *aPaintListener)
 
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 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 SetLineWidth (float aLineWidth) override
 Set the line width. 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 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 void DrawGrid () override
 

More...
 
virtual bool IsInitialized () const
 Returns the initalization status for the canvas. More...
 
virtual bool IsOpenGlEngine ()
 Returns true if the GAL engine is a opengl based type. 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...
 
virtual void ComputeWorldScreenMatrix ()
 Compute the world <-> screen transformation matrix. 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...
 
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...
 
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 initSurface ()
 Prepare Cairo surfaces for drawing. More...
 
void deinitSurface ()
 Destroy Cairo surfaces when are not needed anymore. More...
 
void allocateBitmaps ()
 Allocate the bitmaps for drawing. More...
 
void deleteBitmaps ()
 Allocate the bitmaps for drawing. More...
 
void setCompositor ()
 Prepare the compositor. More...
 
void onPaint (wxPaintEvent &aEvent)
 Paint event handler. More...
 
void skipMouseEvent (wxMouseEvent &aEvent)
 Mouse event handler, forwards the event to the child. More...
 
bool updatedGalDisplayOptions (const GAL_DISPLAY_OPTIONS &aOptions) override
 

Cairo-specific update handlers

More...
 
const double xform (double x)
 
const VECTOR2D xform (double x, double y)
 
const VECTOR2D xform (const VECTOR2D &aP)
 
const double angle_xform (const double aAngle)
 Transform according to the rotation from currentWorld2Screen transform matrix: More...
 
void arc_angles_xform_and_normalize (double &aStartAngle, double &aEndAngle)
 Transform according to the rotation from currentWorld2Screen transform matrix for the start angle and the end angle of an arc. More...
 
void resetContext ()
 
void drawGridLine (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
 Draw a grid line (usually a simplified line function). More...
 
void drawGridCross (const VECTOR2D &aPoint)
 
void drawGridPoint (const VECTOR2D &aPoint, double aSize)
 
void drawAxes (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
 
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...
 
void syncLineWidth (bool aForceWidth=false, double aWidth=0.0)
 
void updateWorldScreenMatrix ()
 
const VECTOR2D roundp (const VECTOR2D &v)
 
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...
 

Protected Attributes

std::shared_ptr< CAIRO_COMPOSITORcompositor
 Object for layers compositing. More...
 
unsigned int mainBuffer
 Handle to the main buffer. More...
 
unsigned int overlayBuffer
 Handle to the overlay buffer. More...
 
RENDER_TARGET currentTarget
 Current rendering target. More...
 
bool validCompositor
 Compositor initialization flag. More...
 
wxWindow * parentWindow
 Parent window. More...
 
wxEvtHandler * mouseListener
 Mouse listener. More...
 
wxEvtHandler * paintListener
 Paint listener. More...
 
unsigned int bufferSize
 Size of buffers cairoOutput, bitmapBuffers. More...
 
unsigned char * wxOutput
 wxImage comaptible buffer More...
 
unsigned int * bitmapBuffer
 Storage of the cairo image. More...
 
unsigned int * bitmapBufferBackup
 Backup storage of the cairo image. More...
 
int stride
 Stride value for Cairo. More...
 
int wxBufferWidth
 
bool isInitialized
 Are Cairo image & surface ready to use. More...
 
COLOR4D backgroundColor
 Background color. More...
 
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...
 
double lineWidth
 
double linePixelWidth
 
double lineWidthInPixels
 
bool lineWidthIsOdd
 
cairo_matrix_t cairoWorldScreenMatrix
 Cairo world to screen transformation matrix. More...
 
cairo_matrix_t currentXform
 
cairo_matrix_t currentWorld2Screen
 
cairo_t * currentContext
 Currently used Cairo context for drawing. More...
 
cairo_t * context
 Cairo image. More...
 
cairo_surface_t * surface
 Cairo surface. More...
 
std::vector< cairo_matrix_t > xformStack
 
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...
 
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...
 

Detailed Description

Definition at line 348 of file cairo_gal.h.

Member Typedef Documentation

◆ GROUP

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

A graphic group type definition.

Definition at line 299 of file cairo_gal.h.

◆ super

typedef GAL KIGFX::CAIRO_GAL_BASE::super
protectedinherited

Super class definition.

Definition at line 260 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 266 of file cairo_gal.h.

267  {
268  CMD_SET_FILL,
274  CMD_FILL_PATH,
275  //CMD_TRANSFORM, ///< Transform the actual context
276  CMD_ROTATE,
277  CMD_TRANSLATE,
278  CMD_SCALE,
279  CMD_SAVE,
280  CMD_RESTORE,
282  };
Enable/disable filling.
Definition: cairo_gal.h:268
Save the transformation matrix.
Definition: cairo_gal.h:279
Translate the context.
Definition: cairo_gal.h:277
Enable/disable stroking.
Definition: cairo_gal.h:269
Restore the transformation matrix.
Definition: cairo_gal.h:280

Constructor & Destructor Documentation

◆ CAIRO_GAL()

CAIRO_GAL::CAIRO_GAL ( GAL_DISPLAY_OPTIONS aDisplayOptions,
wxWindow *  aParent,
wxEvtHandler *  aMouseListener = NULL,
wxEvtHandler *  aPaintListener = NULL,
const wxString &  aName = wxT( "CairoCanvas" ) 
)

Constructor CAIRO_GAL_BASE.

Parameters
aParentis the wxWidgets immediate wxWindow parent of this object.
aMouseListeneris the wxEvtHandler that should receive the mouse events, this can be can be any wxWindow, but is often a wxFrame container.
aPaintListeneris the wxEvtHandler that should receive the paint event. This can be any wxWindow, but is often a derived instance of this class or a containing wxFrame. The "paint event" here is a wxCommandEvent holding EVT_GAL_REDRAW, as sent by PostPaint().
aNameis the name of this window for use by wxWindow::FindWindowByName()

Definition at line 1185 of file cairo_gal.cpp.

1187  :
1188  CAIRO_GAL_BASE( aDisplayOptions ),
1189  wxWindow( aParent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxEXPAND, aName )
1190 {
1191  // Initialise compositing state
1192  mainBuffer = 0;
1193  overlayBuffer = 0;
1194  validCompositor = false;
1196 
1197  parentWindow = aParent;
1198  mouseListener = aMouseListener;
1199  paintListener = aPaintListener;
1200 
1201  // Connecting the event handlers
1202  Connect( wxEVT_PAINT, wxPaintEventHandler( CAIRO_GAL::onPaint ) );
1203 
1204  // Mouse events are skipped to the parent
1205  Connect( wxEVT_MOTION, wxMouseEventHandler( CAIRO_GAL::skipMouseEvent ) );
1206  Connect( wxEVT_LEFT_DOWN, wxMouseEventHandler( CAIRO_GAL::skipMouseEvent ) );
1207  Connect( wxEVT_LEFT_UP, wxMouseEventHandler( CAIRO_GAL::skipMouseEvent ) );
1208  Connect( wxEVT_LEFT_DCLICK, wxMouseEventHandler( CAIRO_GAL::skipMouseEvent ) );
1209  Connect( wxEVT_MIDDLE_DOWN, wxMouseEventHandler( CAIRO_GAL::skipMouseEvent ) );
1210  Connect( wxEVT_MIDDLE_UP, wxMouseEventHandler( CAIRO_GAL::skipMouseEvent ) );
1211  Connect( wxEVT_MIDDLE_DCLICK, wxMouseEventHandler( CAIRO_GAL::skipMouseEvent ) );
1212  Connect( wxEVT_RIGHT_DOWN, wxMouseEventHandler( CAIRO_GAL::skipMouseEvent ) );
1213  Connect( wxEVT_RIGHT_UP, wxMouseEventHandler( CAIRO_GAL::skipMouseEvent ) );
1214  Connect( wxEVT_RIGHT_DCLICK, wxMouseEventHandler( CAIRO_GAL::skipMouseEvent ) );
1215  Connect( wxEVT_MOUSEWHEEL, wxMouseEventHandler( CAIRO_GAL::skipMouseEvent ) );
1216 #if defined _WIN32 || defined _WIN64
1217  Connect( wxEVT_ENTER_WINDOW, wxMouseEventHandler( CAIRO_GAL::skipMouseEvent ) );
1218 #endif
1219 
1220  SetSize( aParent->GetClientSize() );
1221  screenSize = VECTOR2I( aParent->GetClientSize() );
1222 
1223  // Allocate memory for pixel storage
1224  allocateBitmaps();
1225 
1226  isInitialized = false;
1227 }
void onPaint(wxPaintEvent &aEvent)
Paint event handler.
Definition: cairo_gal.cpp:1490
CAIRO_GAL_BASE(GAL_DISPLAY_OPTIONS &aDisplayOptions)
Definition: cairo_gal.cpp:46
bool isInitialized
Are Cairo image & surface ready to use.
Definition: cairo_gal.h:440
unsigned int overlayBuffer
Handle to the overlay buffer.
Definition: cairo_gal.h:424
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
bool validCompositor
Compositor initialization flag.
Definition: cairo_gal.h:426
Auxiliary rendering target (noncached)
Definition: definitions.h:49
wxEvtHandler * paintListener
Paint listener.
Definition: cairo_gal.h:431
virtual void SetTarget(RENDER_TARGET aTarget) override
Sets the target for rendering.
Definition: cairo_gal.cpp:1358
void skipMouseEvent(wxMouseEvent &aEvent)
Mouse event handler, forwards the event to the child.
Definition: cairo_gal.cpp:1496
VECTOR2I screenSize
Screen size in screen coordinates.
wxEvtHandler * mouseListener
Mouse listener.
Definition: cairo_gal.h:430
void allocateBitmaps()
Allocate the bitmaps for drawing.
Definition: cairo_gal.cpp:1452
unsigned int mainBuffer
Handle to the main buffer.
Definition: cairo_gal.h:423
wxWindow * parentWindow
Parent window.
Definition: cairo_gal.h:429

References allocateBitmaps(), isInitialized, mainBuffer, mouseListener, onPaint(), overlayBuffer, paintListener, parentWindow, KIGFX::GAL::screenSize, SetTarget(), skipMouseEvent(), KIGFX::TARGET_NONCACHED, and validCompositor.

◆ ~CAIRO_GAL()

CAIRO_GAL::~CAIRO_GAL ( )
virtual

Definition at line 1230 of file cairo_gal.cpp.

1231 {
1232  deleteBitmaps();
1233 }
void deleteBitmaps()
Allocate the bitmaps for drawing.
Definition: cairo_gal.cpp:1467

References deleteBitmaps().

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 1022 of file graphics_abstraction_layer.h.

1023  {
1024  layerDepth -= 0.05;
1025  }
double layerDepth
The actual layer depth.

References KIGFX::GAL::layerDepth.

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

◆ allocateBitmaps()

void CAIRO_GAL::allocateBitmaps ( )
protected

Allocate the bitmaps for drawing.

Definition at line 1452 of file cairo_gal.cpp.

1453 {
1455  while( ( ( wxBufferWidth * 3 ) % 4 ) != 0 ) wxBufferWidth++;
1456 
1457  // Create buffer, use the system independent Cairo context backend
1458  stride = cairo_format_stride_for_width( GAL_FORMAT, wxBufferWidth );
1460 
1461  bitmapBuffer = new unsigned int[bufferSize];
1462  bitmapBufferBackup = new unsigned int[bufferSize];
1463  wxOutput = new unsigned char[wxBufferWidth * 3 * screenSize.y];
1464 }
unsigned char * wxOutput
wxImage comaptible buffer
Definition: cairo_gal.h:433
unsigned int * bitmapBuffer
Storage of the cairo image.
Definition: cairo_gal.h:436
int stride
Stride value for Cairo.
Definition: cairo_gal.h:438
unsigned int * bitmapBufferBackup
Backup storage of the cairo image.
Definition: cairo_gal.h:437
VECTOR2I screenSize
Screen size in screen coordinates.
unsigned int bufferSize
Size of buffers cairoOutput, bitmapBuffers.
Definition: cairo_gal.h:432
static constexpr cairo_format_t GAL_FORMAT
Format used to store pixels.
Definition: cairo_gal.h:344

References bitmapBuffer, bitmapBufferBackup, bufferSize, KIGFX::CAIRO_GAL_BASE::GAL_FORMAT, KIGFX::GAL::screenSize, stride, wxBufferWidth, wxOutput, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by CAIRO_GAL(), and ResizeScreen().

◆ angle_xform()

const double CAIRO_GAL_BASE::angle_xform ( const double  aAngle)
protectedinherited

Transform according to the rotation from currentWorld2Screen transform matrix:

Parameters
aAngleis the angle in radians to transform
Returns
the modified angle

Definition at line 118 of file cairo_gal.cpp.

119 {
120  // calculate rotation angle due to the rotation transform
121  // and if flipped on X axis.
122  double world_rotation = -std::atan2( currentWorld2Screen.xy, currentWorld2Screen.xx );
123 
124  // When flipped on X axis, the rotation angle is M_PI - initial angle:
125  if( IsFlippedX() )
126  world_rotation = M_PI - world_rotation;
127 
128  return std::fmod( aAngle + world_rotation, 2.0 * M_PI );
129 }
bool IsFlippedX() const
Return true if flip flag for the X axis is set.
cairo_matrix_t currentWorld2Screen
Definition: cairo_gal.h:311

References KIGFX::CAIRO_GAL_BASE::currentWorld2Screen, and KIGFX::GAL::IsFlippedX().

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

◆ arc_angles_xform_and_normalize()

void CAIRO_GAL_BASE::arc_angles_xform_and_normalize ( double &  aStartAngle,
double &  aEndAngle 
)
protectedinherited

Transform according to the rotation from currentWorld2Screen transform matrix for the start angle and the end angle of an arc.

Parameters
aStartAngleis the arc starting point in radians to transform
aEndAngleis the arc ending point in radians to transform

Definition at line 132 of file cairo_gal.cpp.

133 {
134  double startAngle = aStartAngle;
135  double endAngle = aEndAngle;
136 
137  // When the view is flipped, the coordinates are flipped by the matrix transform
138  // However, arc angles need to be "flipped": the flipped angle is M_PI - initial angle.
139  if( IsFlippedX() )
140  {
141  startAngle = M_PI - startAngle;
142  endAngle = M_PI - endAngle;
143  }
144 
145  // Normalize arc angles
146  SWAP( startAngle, >, endAngle );
147 
148  // now rotate arc according to the rotation transform matrix
149  // Remark:
150  // We call angle_xform() to calculate angles according to the flip/rotation
151  // transform and normatize between -2M_PI and +2M_PI.
152  // Therefore, if aStartAngle = aEndAngle + 2*n*M_PI, the transform gives
153  // aEndAngle = aStartAngle
154  // So, if this is the case, force the aEndAngle value to draw a circle.
155  aStartAngle = angle_xform( startAngle );
156 
157  if( std::abs( aEndAngle - aStartAngle ) >= 2*M_PI ) // arc is a full circle
158  aEndAngle = aStartAngle + 2*M_PI;
159  else
160  aEndAngle = angle_xform( endAngle );
161 }
bool IsFlippedX() const
Return true if flip flag for the X axis is set.
#define abs(a)
Definition: auxiliary.h:84
const double angle_xform(const double aAngle)
Transform according to the rotation from currentWorld2Screen transform matrix:
Definition: cairo_gal.cpp:118
#define SWAP(varA, condition, varB)
Swap the variables if a condition is met.
Definition: definitions.h:31

References abs, KIGFX::CAIRO_GAL_BASE::angle_xform(), KIGFX::GAL::IsFlippedX(), and SWAP.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawArc(), and KIGFX::CAIRO_GAL_BASE::DrawArcSegment().

◆ beginDrawing()

void CAIRO_GAL::beginDrawing ( )
overrideprotectedvirtual

Reimplemented from KIGFX::CAIRO_GAL_BASE.

Definition at line 1236 of file cairo_gal.cpp.

1237 {
1238  initSurface();
1239 
1241 
1242  if( !validCompositor )
1243  setCompositor();
1244 
1245  compositor->SetMainContext( context );
1246  compositor->SetBuffer( mainBuffer );
1247 }
void initSurface()
Prepare Cairo surfaces for drawing.
Definition: cairo_gal.cpp:1418
void setCompositor()
Prepare the compositor.
Definition: cairo_gal.cpp:1475
bool validCompositor
Compositor initialization flag.
Definition: cairo_gal.h:426
std::shared_ptr< CAIRO_COMPOSITOR > compositor
Object for layers compositing.
Definition: cairo_gal.h:422
cairo_t * context
Cairo image.
Definition: cairo_gal.h:313
virtual void beginDrawing() override
Definition: cairo_gal.cpp:84
unsigned int mainBuffer
Handle to the main buffer.
Definition: cairo_gal.h:423

References KIGFX::CAIRO_GAL_BASE::beginDrawing(), compositor, KIGFX::CAIRO_GAL_BASE::context, initSurface(), mainBuffer, setCompositor(), and validCompositor.

◆ BeginGroup()

int CAIRO_GAL::BeginGroup ( )
overridevirtual

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::CAIRO_GAL_BASE.

Definition at line 1344 of file cairo_gal.cpp.

1345 {
1346  initSurface();
1347  return CAIRO_GAL_BASE::BeginGroup();
1348 }
void initSurface()
Prepare Cairo surfaces for drawing.
Definition: cairo_gal.cpp:1418
virtual int BeginGroup() override
Begin a group.
Definition: cairo_gal.cpp:740

References KIGFX::CAIRO_GAL_BASE::BeginGroup(), and initSurface().

◆ 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 1110 of file graphics_abstraction_layer.h.

1110 {}

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

◆ 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 353 of file graphics_abstraction_layer.h.

355  {
356  // Fallback: use stroke font
357 
358  // Handle flipped view
359  if( globalFlipX )
361 
362  StrokeText( aText, aPosition, aRotationAngle );
363 
364  if( globalFlipX )
366  }
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

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().

◆ blitCursor()

void CAIRO_GAL_BASE::blitCursor ( wxMemoryDC &  clientDC)
protectedvirtualinherited

Blits cursor into the current screen.

Definition at line 1082 of file cairo_gal.cpp.

1083 {
1084  if( !IsCursorEnabled() )
1085  return;
1086 
1087  auto p = ToScreen( cursorPosition );
1088 
1089  const auto cColor = getCursorColor();
1090  const int cursorSize = fullscreenCursor ? 8000 : 80;
1091 
1092  wxColour color( cColor.r * cColor.a * 255, cColor.g * cColor.a * 255,
1093  cColor.b * cColor.a * 255, 255 );
1094  clientDC.SetPen( wxPen( color ) );
1095  clientDC.DrawLine( p.x - cursorSize / 2, p.y, p.x + cursorSize / 2, p.y );
1096  clientDC.DrawLine( p.x, p.y - cursorSize / 2, p.x, p.y + cursorSize / 2 );
1097 }
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.

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

Referenced by endDrawing().

◆ 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 853 of file cairo_gal.cpp.

854 {
855  storePath();
856 
857  for( GROUP::iterator it = groups[aGroupNumber].begin();
858  it != groups[aGroupNumber].end(); ++it )
859  {
860  if( it->command == CMD_SET_FILLCOLOR || it->command == CMD_SET_STROKECOLOR )
861  {
862  it->argument.dblArg[0] = aNewColor.r;
863  it->argument.dblArg[1] = aNewColor.g;
864  it->argument.dblArg[2] = aNewColor.b;
865  it->argument.dblArg[3] = aNewColor.a;
866  }
867  }
868 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
double g
Green component.
Definition: color4d.h:302
double b
Blue component.
Definition: color4d.h:303
double a
Alpha component.
Definition: color4d.h:304
std::map< int, GROUP > groups
List of graphic groups.
Definition: cairo_gal.h:300
double r
Red component.
Definition: color4d.h:301

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().

◆ 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 871 of file cairo_gal.cpp.

872 {
873  // Cairo does not have any possibilities to change the depth coordinate of stored items,
874  // it depends only on the order of drawing
875 }

◆ ClearCache()

void CAIRO_GAL_BASE::ClearCache ( )
overridevirtualinherited

Delete all data created during caching of graphic items.

Reimplemented from KIGFX::GAL.

Definition at line 898 of file cairo_gal.cpp.

899 {
900  for( auto it = groups.begin(); it != groups.end(); )
901  DeleteGroup( ( it++ )->first );
902 }
virtual void DeleteGroup(int aGroupNumber) override
Delete the group from the memory.
Definition: cairo_gal.cpp:878
std::map< int, GROUP > groups
List of graphic groups.
Definition: cairo_gal.h:300

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

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

◆ ClearScreen()

void CAIRO_GAL_BASE::ClearScreen ( )
overridevirtualinherited

Clear the screen.

Parameters
aColoris the color used for clearing.

Reimplemented from KIGFX::GAL.

Definition at line 523 of file cairo_gal.cpp.

524 {
525  cairo_set_source_rgb( currentContext, m_clearColor.r, m_clearColor.g, m_clearColor.b );
526  cairo_rectangle( currentContext, 0.0, 0.0, screenSize.x, screenSize.y );
527  cairo_fill( currentContext );
528 }
double g
Green component.
Definition: color4d.h:302
double b
Blue component.
Definition: color4d.h:303
VECTOR2I screenSize
Screen size in screen coordinates.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
double r
Red component.
Definition: color4d.h:301

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().

◆ ClearTarget()

void CAIRO_GAL::ClearTarget ( RENDER_TARGET  aTarget)
overridevirtual

Clears the target for rendering.

Parameters
aTargetis the target to be cleared.

Reimplemented from KIGFX::GAL.

Definition at line 1392 of file cairo_gal.cpp.

1393 {
1394  // Save the current state
1395  unsigned int currentBuffer = compositor->GetBuffer();
1396 
1397  switch( aTarget )
1398  {
1399  // Cached and noncached items are rendered to the same buffer
1400  default:
1401  case TARGET_CACHED:
1402  case TARGET_NONCACHED:
1403  compositor->SetBuffer( mainBuffer );
1404  break;
1405 
1406  case TARGET_OVERLAY:
1407  compositor->SetBuffer( overlayBuffer );
1408  break;
1409  }
1410 
1411  compositor->ClearBuffer( COLOR4D::BLACK );
1412 
1413  // Restore the previous state
1414  compositor->SetBuffer( currentBuffer );
1415 }
static const COLOR4D BLACK
Definition: color4d.h:311
unsigned int overlayBuffer
Handle to the overlay buffer.
Definition: cairo_gal.h:424
Auxiliary rendering target (noncached)
Definition: definitions.h:49
std::shared_ptr< CAIRO_COMPOSITOR > compositor
Object for layers compositing.
Definition: cairo_gal.h:422
Items that may change while the view stays the same (noncached)
Definition: definitions.h:50
Main rendering target (cached)
Definition: definitions.h:48
unsigned int mainBuffer
Handle to the main buffer.
Definition: cairo_gal.h:423

References KIGFX::COLOR4D::BLACK, compositor, mainBuffer, overlayBuffer, KIGFX::TARGET_CACHED, KIGFX::TARGET_NONCACHED, and KIGFX::TARGET_OVERLAY.

◆ 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.

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.

References KIGFX::GAL::gridMinSpacing.

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

◆ computeWorldScale()

void KIGFX::GAL::computeWorldScale ( )
inlineprotectedinherited

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

Definition at line 1124 of file graphics_abstraction_layer.h.

1125  {
1127  }
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.

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

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

◆ ComputeWorldScreenMatrix()

void GAL::ComputeWorldScreenMatrix ( )
virtualinherited

Compute the world <-> screen transformation matrix.

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

Definition at line 179 of file graphics_abstraction_layer.cpp.

180 {
182 
183  MATRIX3x3D translation;
184  translation.SetIdentity();
185  translation.SetTranslation( 0.5 * VECTOR2D( screenSize ) );
186 
187  MATRIX3x3D rotate;
188  rotate.SetIdentity();
189  rotate.SetRotation( rotation );
190 
192  scale.SetIdentity();
193  scale.SetScale( VECTOR2D( worldScale, worldScale ) );
194 
195  MATRIX3x3D flip;
196  flip.SetIdentity();
197  flip.SetScale( VECTOR2D( globalFlipX ? -1.0 : 1.0, globalFlipY ? -1.0 : 1.0 ) );
198 
199  MATRIX3x3D lookat;
200  lookat.SetIdentity();
201  lookat.SetTranslation( -lookAtPoint );
202 
203  worldScreenMatrix = translation * rotate * flip * scale * lookat;
205 }
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
double rotation
Rotation transformation (radians)
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
MATRIX3x3D worldScreenMatrix
World transformation.
void computeWorldScale()
Compute the scaling factor for the world->screen matrix.
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.
VECTOR2I screenSize
Screen size in screen coordinates.
void SetTranslation(VECTOR2< T > aTranslation)
Set the translation components of the matrix.
Definition: matrix3x3.h:230

References KIGFX::GAL::computeWorldScale(), KIGFX::GAL::globalFlipX, KIGFX::GAL::globalFlipY, MATRIX3x3< T >::Inverse(), KIGFX::GAL::lookAtPoint, KIGFX::GAL::rotation, scale, KIGFX::GAL::screenSize, KIGFX::GAL::screenWorldMatrix, MATRIX3x3< T >::SetIdentity(), MATRIX3x3< T >::SetRotation(), MATRIX3x3< T >::SetScale(), MATRIX3x3< T >::SetTranslation(), KIGFX::GAL::worldScale, and KIGFX::GAL::worldScreenMatrix.

Referenced by KIGFX::OPENGL_GAL::ComputeWorldScreenMatrix(), KIGFX::CAIRO_GAL_BASE::resetContext(), KIGFX::VIEW::SetCenter(), and KIGFX::VIEW::SetScale().

◆ deinitSurface()

void CAIRO_GAL::deinitSurface ( )
protected

Destroy Cairo surfaces when are not needed anymore.

Definition at line 1438 of file cairo_gal.cpp.

1439 {
1440  if( !isInitialized )
1441  return;
1442 
1443  cairo_destroy( context );
1444  context = nullptr;
1445  cairo_surface_destroy( surface );
1446  surface = nullptr;
1447 
1448  isInitialized = false;
1449 }
cairo_surface_t * surface
Cairo surface.
Definition: cairo_gal.h:314
bool isInitialized
Are Cairo image & surface ready to use.
Definition: cairo_gal.h:440
cairo_t * context
Cairo image.
Definition: cairo_gal.h:313

References KIGFX::CAIRO_GAL_BASE::context, isInitialized, and KIGFX::CAIRO_GAL_BASE::surface.

Referenced by endDrawing(), EndGroup(), and updatedGalDisplayOptions().

◆ deleteBitmaps()

void CAIRO_GAL::deleteBitmaps ( )
protected

Allocate the bitmaps for drawing.

Definition at line 1467 of file cairo_gal.cpp.

1468 {
1469  delete[] bitmapBuffer;
1470  delete[] bitmapBufferBackup;
1471  delete[] wxOutput;
1472 }
unsigned char * wxOutput
wxImage comaptible buffer
Definition: cairo_gal.h:433
unsigned int * bitmapBuffer
Storage of the cairo image.
Definition: cairo_gal.h:436
unsigned int * bitmapBufferBackup
Backup storage of the cairo image.
Definition: cairo_gal.h:437

References bitmapBuffer, bitmapBufferBackup, and wxOutput.

Referenced by ResizeScreen(), and ~CAIRO_GAL().

◆ 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 878 of file cairo_gal.cpp.

879 {
880  storePath();
881 
882  // Delete the Cairo paths
883  std::deque<GROUP_ELEMENT>::iterator it, end;
884 
885  for( it = groups[aGroupNumber].begin(), end = groups[aGroupNumber].end(); it != end; ++it )
886  {
887  if( it->command == CMD_FILL_PATH || it->command == CMD_STROKE_PATH )
888  {
889  cairo_path_destroy( it->cairoPath );
890  }
891  }
892 
893  // Delete the group
894  groups.erase( aGroupNumber );
895 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
std::map< int, GROUP > groups
List of graphic groups.
Definition: cairo_gal.h:300

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().

◆ 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 295 of file cairo_gal.cpp.

297 {
298  syncLineWidth();
299 
300  // calculate start and end arc angles according to the rotation transform matrix
301  // and normalize:
302  arc_angles_xform_and_normalize( aStartAngle, aEndAngle );
303 
304  double r = xform( aRadius );
305 
306  // N.B. This is backwards. We set this because we want to adjust the center
307  // point that changes both endpoints. In the worst case, this is twice as far.
308  // We cannot adjust radius or center based on the other because this causes the
309  // whole arc to change position/size
310  lineWidthIsOdd = !( static_cast<int>( aRadius ) % 1 );
311 
312  auto mid = roundp( xform( aCenterPoint ) );
313 
314  cairo_set_line_width( currentContext, lineWidthInPixels );
315  cairo_new_sub_path( currentContext );
316 
317  if( isFillEnabled )
318  cairo_move_to( currentContext, mid.x, mid.y );
319 
320  cairo_arc( currentContext, mid.x, mid.y, r, aStartAngle, aEndAngle );
321 
322  if( isFillEnabled )
323  cairo_close_path( currentContext );
324 
325  flushPath();
326 
327  isElementAdded = true;
328 }
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
bool isFillEnabled
Is filling of graphic objects enabled ?
void arc_angles_xform_and_normalize(double &aStartAngle, double &aEndAngle)
Transform according to the rotation from currentWorld2Screen transform matrix for the start angle and...
Definition: cairo_gal.cpp:132
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:201
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:298

References KIGFX::CAIRO_GAL_BASE::arc_angles_xform_and_normalize(), KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::flushPath(), KIGFX::CAIRO_GAL_BASE::isElementAdded, KIGFX::GAL::isFillEnabled, KIGFX::CAIRO_GAL_BASE::lineWidthInPixels, KIGFX::CAIRO_GAL_BASE::lineWidthIsOdd, KIGFX::CAIRO_GAL_BASE::roundp(), KIGFX::CAIRO_GAL_BASE::syncLineWidth(), and KIGFX::CAIRO_GAL_BASE::xform().

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

◆ 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.

TODO: Unify Arc routines

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 331 of file cairo_gal.cpp.

333 {
334  if( isFillEnabled )
335  {
336  lineWidth = aWidth;
337  isStrokeEnabled = true;
338  isFillEnabled = false;
339  DrawArc( aCenterPoint, aRadius, aStartAngle, aEndAngle );
340  isFillEnabled = true;
341  isStrokeEnabled = false;
342  return;
343  }
344 
345  syncLineWidth();
346 
347  // calculate start and end arc angles according to the rotation transform matrix
348  // and normalize:
349  double startAngleS = aStartAngle;
350  double endAngleS = aEndAngle;
351  arc_angles_xform_and_normalize( startAngleS, endAngleS );
352 
353  double r = xform( aRadius );
354 
355  // N.B. This is backwards. We set this because we want to adjust the center
356  // point that changes both endpoints. In the worst case, this is twice as far.
357  // We cannot adjust radius or center based on the other because this causes the
358  // whole arc to change position/size
359  lineWidthIsOdd = !( static_cast<int>( aRadius ) % 1 );
360 
361  auto mid = roundp( xform( aCenterPoint ) );
362  double width = xform( aWidth / 2.0 );
363  auto startPointS = VECTOR2D( r, 0.0 ).Rotate( startAngleS );
364  auto endPointS = VECTOR2D( r, 0.0 ).Rotate( endAngleS );
365 
366  cairo_save( currentContext );
367 
368  cairo_set_source_rgba( currentContext, strokeColor.r, strokeColor.g, strokeColor.b, strokeColor.a );
369 
370  cairo_translate( currentContext, mid.x, mid.y );
371 
372  cairo_new_sub_path( currentContext );
373  cairo_arc( currentContext, 0, 0, r - width, startAngleS, endAngleS );
374 
375  cairo_new_sub_path( currentContext );
376  cairo_arc( currentContext, 0, 0, r + width, startAngleS, endAngleS );
377 
378  cairo_new_sub_path( currentContext );
379  cairo_arc_negative( currentContext, startPointS.x, startPointS.y, width, startAngleS, startAngleS + M_PI );
380 
381  cairo_new_sub_path( currentContext );
382  cairo_arc( currentContext, endPointS.x, endPointS.y, width, endAngleS, endAngleS + M_PI );
383 
384  cairo_restore( currentContext );
385  flushPath();
386 
387  isElementAdded = true;
388 }
double g
Green component.
Definition: color4d.h:302
double b
Blue component.
Definition: color4d.h:303
double a
Alpha component.
Definition: color4d.h:304
bool isStrokeEnabled
Are the outlines stroked ?
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
COLOR4D strokeColor
The color of the outlines.
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
bool isFillEnabled
Is filling of graphic objects enabled ?
virtual void DrawArc(const VECTOR2D &aCenterPoint, double aRadius, double aStartAngle, double aEndAngle) override
Draw an arc.
Definition: cairo_gal.cpp:295
VECTOR2< T > Rotate(double aAngle) const
Function Rotate rotates the vector by a given angle.
Definition: vector2d.h:370
void arc_angles_xform_and_normalize(double &aStartAngle, double &aEndAngle)
Transform according to the rotation from currentWorld2Screen transform matrix for the start angle and...
Definition: cairo_gal.cpp:132
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:201
double r
Red component.
Definition: color4d.h:301
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:298

References KIGFX::COLOR4D::a, KIGFX::CAIRO_GAL_BASE::arc_angles_xform_and_normalize(), KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::DrawArc(), KIGFX::CAIRO_GAL_BASE::flushPath(), KIGFX::COLOR4D::g, KIGFX::CAIRO_GAL_BASE::isElementAdded, KIGFX::GAL::isFillEnabled, KIGFX::GAL::isStrokeEnabled, KIGFX::CAIRO_GAL_BASE::lineWidth, KIGFX::CAIRO_GAL_BASE::lineWidthIsOdd, KIGFX::COLOR4D::r, VECTOR2< T >::Rotate(), KIGFX::CAIRO_GAL_BASE::roundp(), KIGFX::GAL::strokeColor, KIGFX::CAIRO_GAL_BASE::syncLineWidth(), and KIGFX::CAIRO_GAL_BASE::xform().

◆ drawAxes()

void CAIRO_GAL_BASE::drawAxes ( const VECTOR2D aStartPoint,
const VECTOR2D aEndPoint 
)
protectedinherited

Definition at line 949 of file cairo_gal.cpp.

950 {
951  syncLineWidth();
952 
953  auto p0 = roundp( xform( aStartPoint ) );
954  auto p1 = roundp( xform( aEndPoint ) );
955  auto org = roundp( xform( VECTOR2D( 0.0, 0.0 ) ) ); // Axis origin = 0,0 coord
956 
957  cairo_set_source_rgba( currentContext, axesColor.r, axesColor.g, axesColor.b, axesColor.a );
958  cairo_move_to( currentContext, p0.x, org.y);
959  cairo_line_to( currentContext, p1.x, org.y );
960  cairo_move_to( currentContext, org.x, p0.y );
961  cairo_line_to( currentContext, org.x, p1.y );
962  cairo_stroke( currentContext );
963 }
double g
Green component.
Definition: color4d.h:302
double b
Blue component.
Definition: color4d.h:303
double a
Alpha component.
Definition: color4d.h:304
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
COLOR4D axesColor
Color of the axes.
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:201
double r
Red component.
Definition: color4d.h:301

References KIGFX::COLOR4D::a, KIGFX::GAL::axesColor, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::COLOR4D::g, KIGFX::COLOR4D::r, KIGFX::CAIRO_GAL_BASE::roundp(), KIGFX::CAIRO_GAL_BASE::syncLineWidth(), and KIGFX::CAIRO_GAL_BASE::xform().

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

◆ DrawBitmap()

void CAIRO_GAL_BASE::DrawBitmap ( const BITMAP_BASE aBitmap)
overridevirtualinherited

Draw a bitmap image.

Reimplemented from KIGFX::GAL.

Definition at line 445 of file cairo_gal.cpp.

446 {
447  cairo_save( currentContext );
448 
449  // We have to calculate the pixel size in users units to draw the image.
450  // worldUnitLength is a factor used for converting IU to inches
451  double scale = 1.0 / ( aBitmap.GetPPI() * worldUnitLength );
452 
453  // The position of the bitmap is the bitmap center.
454  // move the draw origin to the top left bitmap corner:
455  int w = aBitmap.GetSizePixels().x;
456  int h = aBitmap.GetSizePixels().y;
457 
458  cairo_set_matrix( currentContext, &currentWorld2Screen );
459  cairo_scale( currentContext, scale, scale );
460  cairo_translate( currentContext, -w / 2.0, -h / 2.0 );
461 
462  cairo_new_path( currentContext );
463  cairo_surface_t* image = cairo_image_surface_create( CAIRO_FORMAT_ARGB32, w, h );
464  cairo_surface_flush( image );
465 
466  unsigned char* pix_buffer = cairo_image_surface_get_data( image );
467  // The pixel buffer of the initial bitmap:
468  const wxImage& bm_pix_buffer = *aBitmap.GetImageData();
469 
470  uint32_t mask_color = ( bm_pix_buffer.GetMaskRed() << 16 ) +
471  ( bm_pix_buffer.GetMaskGreen() << 8 ) +
472  ( bm_pix_buffer.GetMaskBlue() );
473 
474  // Copy the source bitmap to the cairo bitmap buffer.
475  // In cairo bitmap buffer, a ARGB32 bitmap is an ARGB pixel packed into a uint_32
476  // 24 low bits only are used for color, top 8 are transparency.
477  for( int row = 0; row < h; row++ )
478  {
479  for( int col = 0; col < w; col++ )
480  {
481  // Build the RGB24 pixel:
482  uint32_t pixel = bm_pix_buffer.GetRed( col, row ) << 16;
483  pixel += bm_pix_buffer.GetGreen( col, row ) << 8;
484  pixel += bm_pix_buffer.GetBlue( col, row );
485 
486  if( bm_pix_buffer.HasAlpha() )
487  pixel += bm_pix_buffer.GetAlpha( col, row ) << 24;
488  else if( bm_pix_buffer.HasMask() && pixel == mask_color )
489  pixel += ( wxALPHA_TRANSPARENT << 24 );
490  else
491  pixel += ( wxALPHA_OPAQUE << 24 );
492 
493  // Write the pixel to the cairo image buffer:
494  uint32_t* pix_ptr = (uint32_t*) pix_buffer;
495  *pix_ptr = pixel;
496  pix_buffer += 4;
497  }
498  }
499 
500  cairo_surface_mark_dirty( image );
501  cairo_set_source_surface( currentContext, image, 0, 0 );
502  cairo_paint( currentContext );
503  cairo_surface_destroy( image );
504 
505  isElementAdded = true;
506 
507  cairo_restore( currentContext );
508 }
wxImage * GetImageData()
Definition: bitmap_base.h:83
double worldUnitLength
The unit length of the world coordinates [inch].
const int scale
wxSize GetSizePixels() const
Function GetSizePixels.
Definition: bitmap_base.h:141
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:298
int GetPPI() const
Definition: bitmap_base.h:153
cairo_matrix_t currentWorld2Screen
Definition: cairo_gal.h:311

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

◆ 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 279 of file cairo_gal.cpp.

280 {
281  syncLineWidth();
282 
283  auto c = roundp( xform( aCenterPoint ) );
284  auto r = ::roundp( xform( aRadius ) );
285 
286  cairo_set_line_width( currentContext, std::min( 2.0 * r, lineWidthInPixels ) );
287  cairo_new_sub_path( currentContext );
288  cairo_arc( currentContext, c.x, c.y, r, 0.0, 2 * M_PI );
289  cairo_close_path( currentContext );
290  flushPath();
291  isElementAdded = true;
292 }
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:201
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:298
#define min(a, b)
Definition: auxiliary.h:85

References KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::flushPath(), KIGFX::CAIRO_GAL_BASE::isElementAdded, KIGFX::CAIRO_GAL_BASE::lineWidthInPixels, min, KIGFX::CAIRO_GAL_BASE::roundp(), KIGFX::CAIRO_GAL_BASE::syncLineWidth(), and KIGFX::CAIRO_GAL_BASE::xform().

◆ 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 911 of file cairo_gal.cpp.

912 {
913  cursorPosition = aCursorPosition;
914 }
VECTOR2D cursorPosition
Current cursor position (world coordinates)

References KIGFX::GAL::cursorPosition.

◆ 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 426 of file cairo_gal.cpp.

428 {
429  syncLineWidth();
430 
431  const auto sp = roundp( xform( aStartPoint ) );
432  const auto cpa = roundp( xform( aControlPointA ) );
433  const auto cpb = roundp( xform( aControlPointB ) );
434  const auto ep = roundp( xform( aEndPoint ) );
435 
436  cairo_move_to( currentContext, sp.x, sp.y );
437  cairo_curve_to( currentContext, cpa.x, cpa.y, cpb.x, cpb.y, ep.x, ep.y );
438  cairo_line_to( currentContext, ep.x, ep.y );
439 
440  flushPath();
441  isElementAdded = true;
442 }
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:201
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:298

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

◆ DrawGrid()

void CAIRO_GAL_BASE::DrawGrid ( )
overridevirtualinherited

Draw the grid

Reimplemented from KIGFX::GAL.

Definition at line 1528 of file cairo_gal.cpp.

1529 {
1531 
1532  // Draw the grid
1533  // For the drawing the start points, end points and increments have
1534  // to be calculated in world coordinates
1535  VECTOR2D worldStartPoint = screenWorldMatrix * VECTOR2D( 0.0, 0.0 );
1536  VECTOR2D worldEndPoint = screenWorldMatrix * VECTOR2D( screenSize );
1537 
1538  // Compute the line marker or point radius of the grid
1539  // Note: generic grids can't handle sub-pixel lines without
1540  // either losing fine/course distinction or having some dots
1541  // fail to render
1542  float marker = std::fmax( 1.0f, gridLineWidth ) / worldScale;
1543  float doubleMarker = 2.0f * marker;
1544 
1545  // Draw axes if desired
1546  if( axesEnabled )
1547  {
1548  SetLineWidth( marker );
1549  drawAxes( worldStartPoint, worldEndPoint );
1550  }
1551 
1552  if( !gridVisibility || gridSize.x == 0 || gridSize.y == 0 )
1553  return;
1554 
1555  VECTOR2D gridScreenSize( gridSize );
1556 
1557  double gridThreshold = KiROUND( computeMinGridSpacing() / worldScale );
1558 
1560  gridThreshold *= 2.0;
1561 
1562  // If we cannot display the grid density, scale down by a tick size and
1563  // try again. Eventually, we get some representation of the grid
1564  while( std::min( gridScreenSize.x, gridScreenSize.y ) <= gridThreshold )
1565  {
1566  gridScreenSize = gridScreenSize * static_cast<double>( gridTick );
1567  }
1568 
1569  // Compute grid starting and ending indexes to draw grid points on the
1570  // visible screen area
1571  // Note: later any point coordinate will be offsetted by gridOrigin
1572  int gridStartX = KiROUND( ( worldStartPoint.x - gridOrigin.x ) / gridScreenSize.x );
1573  int gridEndX = KiROUND( ( worldEndPoint.x - gridOrigin.x ) / gridScreenSize.x );
1574  int gridStartY = KiROUND( ( worldStartPoint.y - gridOrigin.y ) / gridScreenSize.y );
1575  int gridEndY = KiROUND( ( worldEndPoint.y - gridOrigin.y ) / gridScreenSize.y );
1576 
1577  // Ensure start coordinate > end coordinate
1578 
1579  SWAP( gridStartX, >, gridEndX );
1580  SWAP( gridStartY, >, gridEndY );
1581 
1582  // Ensure the grid fills the screen
1583  --gridStartX; ++gridEndX;
1584  --gridStartY; ++gridEndY;
1585 
1586  // Draw the grid behind all other layers
1587  SetLayerDepth( depthRange.y * 0.75 );
1588 
1589  if( gridStyle == GRID_STYLE::LINES )
1590  {
1591  // Now draw the grid, every coarse grid line gets the double width
1592 
1593  // Vertical lines
1594  for( int j = gridStartY; j <= gridEndY; j++ )
1595  {
1596  const double y = j * gridScreenSize.y + gridOrigin.y;
1597 
1598  if( axesEnabled && y == 0.0 )
1599  continue;
1600 
1601  SetLineWidth( ( j % gridTick ) ? marker : doubleMarker );
1602  drawGridLine( VECTOR2D( gridStartX * gridScreenSize.x + gridOrigin.x, y ),
1603  VECTOR2D( gridEndX * gridScreenSize.x + gridOrigin.x, y ) );
1604  }
1605 
1606  // Horizontal lines
1607  for( int i = gridStartX; i <= gridEndX; i++ )
1608  {
1609  const double x = i * gridScreenSize.x + gridOrigin.x;
1610 
1611  if( axesEnabled && x == 0.0 )
1612  continue;
1613 
1614  SetLineWidth( ( i % gridTick ) ? marker : doubleMarker );
1615  drawGridLine( VECTOR2D( x, gridStartY * gridScreenSize.y + gridOrigin.y ),
1616  VECTOR2D( x, gridEndY * gridScreenSize.y + gridOrigin.y ) );
1617 
1618  }
1619  }
1620  else // Dots or Crosses grid
1621  {
1622  for( int j = gridStartY; j <= gridEndY; j++ )
1623  {
1624  bool tickY = ( j % gridTick == 0 );
1625 
1626  for( int i = gridStartX; i <= gridEndX; i++ )
1627  {
1628  bool tickX = ( i % gridTick == 0 );
1629  SetLineWidth( ( ( tickX && tickY ) ? doubleMarker : marker ) );
1630  auto pos = VECTOR2D( i * gridScreenSize.x + gridOrigin.x,
1631  j * gridScreenSize.y + gridOrigin.y );
1632 
1634  drawGridCross( pos );
1635  else if( gridStyle == GRID_STYLE::DOTS )
1636  drawGridPoint( pos, GetLineWidth() );
1637  }
1638  }
1639  }
1640 }
int gridTick
Every tick line gets the double width.
float GetLineWidth() const
Get the line width.
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:118
double computeMinGridSpacing() const
compute minimum grid spacing from the grid settings
GRID_STYLE gridStyle
Grid display style.
VECTOR2D depthRange
Range of the depth.
MATRIX3x3D screenWorldMatrix
Screen transformation.
void drawAxes(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
Definition: cairo_gal.cpp:949
virtual void SetLayerDepth(double aLayerDepth) override
Set the depth of the layer (position on the z-axis)
Definition: cairo_gal.cpp:616
Auxiliary rendering target (noncached)
Definition: definitions.h:49
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
float gridLineWidth
Line width of the grid.
VECTOR2D gridOrigin
The grid origin.
void drawGridPoint(const VECTOR2D &aPoint, double aSize)
Definition: cairo_gal.cpp:999
Use dots for the grid.
Use small cross instead of dots for the grid.
bool gridVisibility
Should the grid be shown.
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.
#define SWAP(varA, condition, varB)
Swap the variables if a condition is met.
Definition: definitions.h:31
void drawGridLine(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
Draw a grid line (usually a simplified line function).
Definition: cairo_gal.cpp:966
virtual void SetLineWidth(float aLineWidth) override
Set the line width.
Definition: cairo_gal.cpp:597
virtual void SetTarget(RENDER_TARGET aTarget)
Sets the target for rendering.
void drawGridCross(const VECTOR2D &aPoint)
Definition: cairo_gal.cpp:979
#define min(a, b)
Definition: auxiliary.h:85

References KIGFX::GAL::axesEnabled, KIGFX::GAL::computeMinGridSpacing(), KIGFX::GAL::depthRange, KIGFX::DOTS, KIGFX::CAIRO_GAL_BASE::drawAxes(), KIGFX::CAIRO_GAL_BASE::drawGridCross(), KIGFX::CAIRO_GAL_BASE::drawGridLine(), KIGFX::CAIRO_GAL_BASE::drawGridPoint(), KIGFX::GAL::GetLineWidth(), KIGFX::GAL::gridLineWidth, KIGFX::GAL::gridOrigin, KIGFX::GAL::gridSize, KIGFX::GAL::gridStyle, KIGFX::GAL::gridTick, KIGFX::GAL::gridVisibility, i, KiROUND(), KIGFX::LINES, min, KIGFX::GAL::screenSize, KIGFX::GAL::screenWorldMatrix, KIGFX::CAIRO_GAL_BASE::SetLayerDepth(), KIGFX::CAIRO_GAL_BASE::SetLineWidth(), KIGFX::GAL::SetTarget(), KIGFX::SMALL_CROSS, SWAP, KIGFX::TARGET_NONCACHED, KIGFX::GAL::worldScale, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ drawGridCross()

void CAIRO_GAL_BASE::drawGridCross ( const VECTOR2D aPoint)
protectedinherited

Definition at line 979 of file cairo_gal.cpp.

980 {
981  syncLineWidth();
982  VECTOR2D offset( 0, 0 );
983  auto size = 2.0 * lineWidthInPixels;
984 
985  auto p0 = roundp( xform( aPoint ) ) - VECTOR2D( size, 0 ) + offset;
986  auto p1 = roundp( xform( aPoint ) ) + VECTOR2D( size, 0 ) + offset;
987  auto p2 = roundp( xform( aPoint ) ) - VECTOR2D( 0, size ) + offset;
988  auto p3 = roundp( xform( aPoint ) ) + VECTOR2D( 0, size ) + offset;
989 
990  cairo_set_source_rgba( currentContext, gridColor.r, gridColor.g, gridColor.b, gridColor.a );
991  cairo_move_to( currentContext, p0.x, p0.y );
992  cairo_line_to( currentContext, p1.x, p1.y );
993  cairo_move_to( currentContext, p2.x, p2.y );
994  cairo_line_to( currentContext, p3.x, p3.y );
995  cairo_stroke( currentContext );
996 }
double g
Green component.
Definition: color4d.h:302
double b
Blue component.
Definition: color4d.h:303
double a
Alpha component.
Definition: color4d.h:304
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
COLOR4D gridColor
Color of the grid.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:201
double r
Red component.
Definition: color4d.h:301

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::COLOR4D::g, KIGFX::GAL::gridColor, KIGFX::CAIRO_GAL_BASE::lineWidthInPixels, KIGFX::COLOR4D::r, KIGFX::CAIRO_GAL_BASE::roundp(), KIGFX::CAIRO_GAL_BASE::syncLineWidth(), and KIGFX::CAIRO_GAL_BASE::xform().

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

◆ drawGridLine()

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

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

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

Definition at line 966 of file cairo_gal.cpp.

967 {
968  syncLineWidth();
969  auto p0 = roundp( xform( aStartPoint ) );
970  auto p1 = roundp( xform( aEndPoint ) );
971 
972  cairo_set_source_rgba( currentContext, gridColor.r, gridColor.g, gridColor.b, gridColor.a );
973  cairo_move_to( currentContext, p0.x, p0.y );
974  cairo_line_to( currentContext, p1.x, p1.y );
975  cairo_stroke( currentContext );
976 }
double g
Green component.
Definition: color4d.h:302
double b
Blue component.
Definition: color4d.h:303
double a
Alpha component.
Definition: color4d.h:304
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
COLOR4D gridColor
Color of the grid.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:201
double r
Red component.
Definition: color4d.h:301

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::COLOR4D::g, KIGFX::GAL::gridColor, KIGFX::COLOR4D::r, KIGFX::CAIRO_GAL_BASE::roundp(), KIGFX::CAIRO_GAL_BASE::syncLineWidth(), and KIGFX::CAIRO_GAL_BASE::xform().

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

◆ drawGridPoint()

void CAIRO_GAL_BASE::drawGridPoint ( const VECTOR2D aPoint,
double  aSize 
)
protectedinherited

Definition at line 999 of file cairo_gal.cpp.

1000 {
1001  auto p = roundp( xform( aPoint ) );
1002  auto s = xform( aSize / 2.0 );
1003 
1004  cairo_set_source_rgba( currentContext, gridColor.r, gridColor.g, gridColor.b, gridColor.a );
1005  cairo_move_to( currentContext, p.x, p.y );
1006  cairo_arc( currentContext, p.x, p.y, s, 0.0, 2.0 * M_PI );
1007  cairo_close_path( currentContext );
1008 
1009  cairo_fill( currentContext );
1010 }
double g
Green component.
Definition: color4d.h:302
double b
Blue component.
Definition: color4d.h:303
double a
Alpha component.
Definition: color4d.h:304
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
COLOR4D gridColor
Color of the grid.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
double r
Red component.
Definition: color4d.h:301

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::COLOR4D::g, KIGFX::GAL::gridColor, KIGFX::COLOR4D::r, KIGFX::CAIRO_GAL_BASE::roundp(), and KIGFX::CAIRO_GAL_BASE::xform().

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

◆ 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 763 of file cairo_gal.cpp.

764 {
765  // This method implements a small Virtual Machine - all stored commands
766  // are executed; nested calling is also possible
767 
768  storePath();
769 
770  for( GROUP::iterator it = groups[aGroupNumber].begin();
771  it != groups[aGroupNumber].end(); ++it )
772  {
773  switch( it->command )
774  {
775  case CMD_SET_FILL:
776  isFillEnabled = it->argument.boolArg;
777  break;
778 
779  case CMD_SET_STROKE:
780  isStrokeEnabled = it->argument.boolArg;
781  break;
782 
783  case CMD_SET_FILLCOLOR:
784  fillColor = COLOR4D( it->argument.dblArg[0], it->argument.dblArg[1], it->argument.dblArg[2],
785  it->argument.dblArg[3] );
786  break;
787 
788  case CMD_SET_STROKECOLOR:
789  strokeColor = COLOR4D( it->argument.dblArg[0], it->argument.dblArg[1], it->argument.dblArg[2],
790  it->argument.dblArg[3] );
791  break;
792 
793  case CMD_SET_LINE_WIDTH:
794  {
795  // Make lines appear at least 1 pixel wide, no matter of zoom
796  double x = 1.0, y = 1.0;
797  cairo_device_to_user_distance( currentContext, &x, &y );
798  double minWidth = std::min( fabs( x ), fabs( y ) );
799  cairo_set_line_width( currentContext, std::max( it->argument.dblArg[0], minWidth ) );
800  }
801  break;
802 
803 
804  case CMD_STROKE_PATH:
805  cairo_set_source_rgba( currentContext, strokeColor.r, strokeColor.g, strokeColor.b, strokeColor.a );
806  cairo_append_path( currentContext, it->cairoPath );
807  cairo_stroke( currentContext );
808  break;
809 
810  case CMD_FILL_PATH:
811  cairo_set_source_rgba( currentContext, fillColor.r, fillColor.g, fillColor.b, strokeColor.a );
812  cairo_append_path( currentContext, it->cairoPath );
813  cairo_fill( currentContext );
814  break;
815 
816  /*
817  case CMD_TRANSFORM:
818  cairo_matrix_t matrix;
819  cairo_matrix_init( &matrix, it->argument.dblArg[0], it->argument.dblArg[1], it->argument.dblArg[2],
820  it->argument.dblArg[3], it->argument.dblArg[4], it->argument.dblArg[5] );
821  cairo_transform( currentContext, &matrix );
822  break;
823  */
824 
825  case CMD_ROTATE:
826  cairo_rotate( currentContext, it->argument.dblArg[0] );
827  break;
828 
829  case CMD_TRANSLATE:
830  cairo_translate( currentContext, it->argument.dblArg[0], it->argument.dblArg[1] );
831  break;
832 
833  case CMD_SCALE:
834  cairo_scale( currentContext, it->argument.dblArg[0], it->argument.dblArg[1] );
835  break;
836 
837  case CMD_SAVE:
838  cairo_save( currentContext );
839  break;
840 
841  case CMD_RESTORE:
842  cairo_restore( currentContext );
843  break;
844 
845  case CMD_CALL_GROUP:
846  DrawGroup( it->argument.intArg );
847  break;
848  }
849  }
850 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
double g
Green component.
Definition: color4d.h:302
COLOR4D fillColor
The fill color.
Enable/disable filling.
Definition: cairo_gal.h:268
double b
Blue component.
Definition: color4d.h:303
double a
Alpha component.
Definition: color4d.h:304
bool isStrokeEnabled
Are the outlines stroked ?
std::map< int, GROUP > groups
List of graphic groups.
Definition: cairo_gal.h:300
COLOR4D strokeColor
The color of the outlines.
Save the transformation matrix.
Definition: cairo_gal.h:279
bool isFillEnabled
Is filling of graphic objects enabled ?
#define max(a, b)
Definition: auxiliary.h:86
Translate the context.
Definition: cairo_gal.h:277
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
virtual void DrawGroup(int aGroupNumber) override
Draw the stored group.
Definition: cairo_gal.cpp:763
double r
Red component.
Definition: color4d.h:301
Enable/disable stroking.
Definition: cairo_gal.h:269
Restore the transformation matrix.
Definition: cairo_gal.h:280
#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

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.

◆ 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 187 of file cairo_gal.cpp.

188 {
189  syncLineWidth();
190 
191  auto p0 = roundp( xform( aStartPoint ) );
192  auto p1 = roundp( xform( aEndPoint ) );
193 
194  cairo_move_to( currentContext, p0.x, p0.y );
195  cairo_line_to( currentContext, p1.x, p1.y );
196  flushPath();
197  isElementAdded = true;
198 }
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:201
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:298

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

◆ 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 1100 of file cairo_gal.cpp.

1101 {
1102  // Iterate over the point list and draw the segments
1103  std::deque<VECTOR2D>::const_iterator it = aPointList.begin();
1104 
1105  syncLineWidth();
1106 
1107  const auto p = roundp( xform( it->x, it->y ) );
1108 
1109  cairo_move_to( currentContext, p.x, p.y );
1110 
1111  for( ++it; it != aPointList.end(); ++it )
1112  {
1113  const auto p2 = roundp( xform( it->x, it->y ) );
1114 
1115  cairo_line_to( currentContext, p2.x, p2.y );
1116  }
1117 
1118  flushPath();
1119  isElementAdded = true;
1120 }
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:201
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:298

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

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

◆ drawPoly() [2/3]

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

Definition at line 1123 of file cairo_gal.cpp.

1124 {
1125  // Iterate over the point list and draw the segments
1126  const VECTOR2D* ptr = aPointList;
1127 
1128  syncLineWidth();
1129 
1130  const auto p = roundp( xform( ptr->x, ptr->y ) );
1131  cairo_move_to( currentContext, p.x, p.y );
1132 
1133  for( int i = 0; i < aListSize; ++i )
1134  {
1135  ++ptr;
1136  const auto p2 = roundp( xform( ptr->x, ptr->y ) );
1137  cairo_line_to( currentContext, p2.x, p2.y );
1138  }
1139 
1140  flushPath();
1141  isElementAdded = true;
1142 }
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
size_t i
Definition: json11.cpp:597
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:201
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:298

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

◆ drawPoly() [3/3]

void CAIRO_GAL_BASE::drawPoly ( const SHAPE_LINE_CHAIN aLineChain)
protectedinherited

Definition at line 1145 of file cairo_gal.cpp.

1146 {
1147  if( aLineChain.PointCount() < 2 )
1148  return;
1149 
1150  syncLineWidth();
1151 
1152  auto numPoints = aLineChain.PointCount();
1153 
1154  if( aLineChain.IsClosed() )
1155  numPoints += 1;
1156 
1157  const VECTOR2I start = aLineChain.CPoint( 0 );
1158  const auto p = roundp( xform( start.x, start.y ) );
1159  cairo_move_to( currentContext, p.x, p.y );
1160 
1161  for( int i = 1; i < numPoints; ++i )
1162  {
1163  const VECTOR2I& pw = aLineChain.CPoint( i );
1164  const auto ps = roundp( xform( pw.x, pw.y ) );
1165  cairo_line_to( currentContext, ps.x, ps.y );
1166  }
1167 
1168  flushPath();
1169  isElementAdded = true;
1170 }
int PointCount() const
Function PointCount()
const VECTOR2I & CPoint(int aIndex) const
Function CPoint()
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
size_t i
Definition: json11.cpp:597
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:201
bool IsClosed() const
Function IsClosed()
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:298

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(), KIGFX::CAIRO_GAL_BASE::roundp(), KIGFX::CAIRO_GAL_BASE::syncLineWidth(), VECTOR2< T >::x, KIGFX::CAIRO_GAL_BASE::xform(), and VECTOR2< T >::y.

◆ 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.

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:1100

References KIGFX::CAIRO_GAL_BASE::drawPoly().

◆ 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.

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:1100

References KIGFX::CAIRO_GAL_BASE::drawPoly().

◆ DrawPolygon() [3/4]

void CAIRO_GAL_BASE::DrawPolygon ( const SHAPE_POLY_SET aPolySet)
overridevirtualinherited

Reimplemented from KIGFX::GAL.

Definition at line 413 of file cairo_gal.cpp.

414 {
415  for( int i = 0; i < aPolySet.OutlineCount(); ++i )
416  drawPoly( aPolySet.COutline( i ) );
417 }
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:1100
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
size_t i
Definition: json11.cpp:597

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

◆ DrawPolygon() [4/4]

void CAIRO_GAL_BASE::DrawPolygon ( const SHAPE_LINE_CHAIN aPolySet)
overridevirtualinherited

Reimplemented from KIGFX::GAL.

Definition at line 420 of file cairo_gal.cpp.

421 {
422  drawPoly( aPolygon );
423 }
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:1100

References KIGFX::CAIRO_GAL_BASE::drawPoly().

◆ 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.

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:1100

References KIGFX::CAIRO_GAL_BASE::drawPoly().

◆ 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.

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:1100

References KIGFX::CAIRO_GAL_BASE::drawPoly().

◆ 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.

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:1100

References KIGFX::CAIRO_GAL_BASE::drawPoly().

◆ 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 391 of file cairo_gal.cpp.

392 {
393  // Calculate the diagonal points
394  syncLineWidth();
395 
396  const auto p0 = roundp( xform( aStartPoint ) );
397  const auto p1 = roundp( xform( VECTOR2D( aEndPoint.x, aStartPoint.y ) ) );
398  const auto p2 = roundp( xform( aEndPoint ) );
399  const auto p3 = roundp( xform( VECTOR2D( aStartPoint.x, aEndPoint.y ) ) );
400 
401  // The path is composed from 4 segments
402  cairo_move_to( currentContext, p0.x, p0.y );
403  cairo_line_to( currentContext, p1.x, p1.y );
404  cairo_line_to( currentContext, p2.x, p2.y );
405  cairo_line_to( currentContext, p3.x, p3.y );
406  cairo_close_path( currentContext );
407  flushPath();
408 
409  isElementAdded = true;
410 }
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:201
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:298

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

◆ 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 225 of file cairo_gal.cpp.

227 {
228  if( isFillEnabled )
229  {
230  syncLineWidth( true, aWidth );
231 
232  auto p0 = roundp( xform( aStartPoint ) );
233  auto p1 = roundp( xform( aEndPoint ) );
234 
235  cairo_move_to( currentContext, p0.x, p0.y );
236  cairo_line_to( currentContext, p1.x, p1.y );
237  cairo_set_source_rgba( currentContext, fillColor.r, fillColor.g, fillColor.b, fillColor.a );
238  cairo_stroke( currentContext );
239  }
240  else
241  {
242  aWidth /= 2.0;
243  SetLineWidth( 1.0 );
244  syncLineWidth();
245 
246  // Outline mode for tracks
247  VECTOR2D startEndVector = aEndPoint - aStartPoint;
248  double lineAngle = atan2( startEndVector.y, startEndVector.x );
249 
250  double sa = sin( lineAngle + M_PI / 2.0 );
251  double ca = cos( lineAngle + M_PI / 2.0 );
252 
253  auto pa0 = xform ( aStartPoint + VECTOR2D(aWidth * ca, aWidth * sa ) );
254  auto pa1 = xform ( aStartPoint - VECTOR2D(aWidth * ca, aWidth * sa ) );
255  auto pb0 = xform ( aEndPoint + VECTOR2D(aWidth * ca, aWidth * sa ) );
256  auto pb1 = xform ( aEndPoint - VECTOR2D(aWidth * ca, aWidth * sa ) );
257  auto pa = xform( aStartPoint );
258  auto pb = xform( aEndPoint );
259  auto rb = (pa0 - pa).EuclideanNorm();
260 
261  cairo_set_source_rgba( currentContext, strokeColor.r, strokeColor.g, strokeColor.b, strokeColor.a );
262 
263  cairo_move_to( currentContext, pa0.x, pa0.y );
264  cairo_line_to( currentContext, pb0.x, pb0.y );
265 
266  cairo_move_to( currentContext, pa1.x, pa1.y );
267  cairo_line_to( currentContext, pb1.x, pb1.y );
268 
269  cairo_arc( currentContext, pb.x, pb.y, rb, lineAngle - M_PI / 2.0, lineAngle + M_PI / 2.0 );
270  cairo_arc( currentContext, pa.x, pa.y, rb, lineAngle + M_PI / 2.0, lineAngle + 3.0 * M_PI / 2.0 );
271 
272  flushPath();
273  }
274 
275  isElementAdded = true;
276 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:123
double g
Green component.
Definition: color4d.h:302
COLOR4D fillColor
The fill color.
double b
Blue component.
Definition: color4d.h:303
double a
Alpha component.
Definition: color4d.h:304
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
COLOR4D strokeColor
The color of the outlines.
const double xform(double x)
Definition: cairo_gal.cpp:164
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:178
bool isFillEnabled
Is filling of graphic objects enabled ?
virtual void SetLineWidth(float aLineWidth) override
Set the line width.
Definition: cairo_gal.cpp:597
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:201
double r
Red component.
Definition: color4d.h:301
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:298

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::CAIRO_GAL_BASE::currentContext, 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::roundp(), KIGFX::CAIRO_GAL_BASE::SetLineWidth(), KIGFX::GAL::strokeColor, KIGFX::CAIRO_GAL_BASE::syncLineWidth(), VECTOR2< T >::x, KIGFX::CAIRO_GAL_BASE::xform(), and VECTOR2< T >::y.

◆ EnableDepthTest()

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

Reimplemented from KIGFX::GAL.

Definition at line 917 of file cairo_gal.cpp.

918 {
919 }

◆ endDrawing()

void CAIRO_GAL::endDrawing ( )
overrideprotectedvirtual

Reimplemented from KIGFX::CAIRO_GAL_BASE.

Definition at line 1250 of file cairo_gal.cpp.

1251 {
1253 
1254  // Merge buffers on the screen
1255  compositor->DrawBuffer( mainBuffer );
1256  compositor->DrawBuffer( overlayBuffer );
1257 
1258  // Now translate the raw context data from the format stored
1259  // by cairo into a format understood by wxImage.
1260  pixman_image_t* dstImg = pixman_image_create_bits( PIXMAN_r8g8b8,
1261  screenSize.x, screenSize.y, (uint32_t*) wxOutput, wxBufferWidth * 3 );
1262  pixman_image_t* srcImg = pixman_image_create_bits( PIXMAN_a8b8g8r8,
1263  screenSize.x, screenSize.y, (uint32_t*) bitmapBuffer, wxBufferWidth * 4 );
1264 
1265  pixman_image_composite( PIXMAN_OP_SRC, srcImg, NULL, dstImg,
1266  0, 0, 0, 0, 0, 0, screenSize.x, screenSize.y );
1267 
1268  // Free allocated memory
1269  pixman_image_unref( srcImg );
1270  pixman_image_unref( dstImg );
1271 
1272  wxImage img( wxBufferWidth, screenSize.y, (unsigned char*) wxOutput, true );
1273  wxBitmap bmp( img );
1274  wxMemoryDC mdc( bmp );
1275  wxClientDC clientDC( this );
1276 
1277  // Now it is the time to blit the mouse cursor
1278  blitCursor( mdc );
1279  clientDC.Blit( 0, 0, screenSize.x, screenSize.y, &mdc, 0, 0, wxCOPY );
1280 
1281  deinitSurface();
1282 }
void deinitSurface()
Destroy Cairo surfaces when are not needed anymore.
Definition: cairo_gal.cpp:1438
unsigned int overlayBuffer
Handle to the overlay buffer.
Definition: cairo_gal.h:424
unsigned char * wxOutput
wxImage comaptible buffer
Definition: cairo_gal.h:433
std::shared_ptr< CAIRO_COMPOSITOR > compositor
Object for layers compositing.
Definition: cairo_gal.h:422
virtual void endDrawing() override
Definition: cairo_gal.cpp:90
unsigned int * bitmapBuffer
Storage of the cairo image.
Definition: cairo_gal.h:436
VECTOR2I screenSize
Screen size in screen coordinates.
unsigned int mainBuffer
Handle to the main buffer.
Definition: cairo_gal.h:423
virtual void blitCursor(wxMemoryDC &clientDC)
Blits cursor into the current screen.
Definition: cairo_gal.cpp:1082

References bitmapBuffer, KIGFX::CAIRO_GAL_BASE::blitCursor(), compositor, deinitSurface(), KIGFX::CAIRO_GAL_BASE::endDrawing(), mainBuffer, overlayBuffer, KIGFX::GAL::screenSize, wxBufferWidth, wxOutput, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ EndGroup()

void CAIRO_GAL::EndGroup ( )
overridevirtual

End the group.

Reimplemented from KIGFX::CAIRO_GAL_BASE.

Definition at line 1351 of file cairo_gal.cpp.

1352 {
1354  deinitSurface();
1355 }
virtual void EndGroup() override
End the group.
Definition: cairo_gal.cpp:756
void deinitSurface()
Destroy Cairo surfaces when are not needed anymore.
Definition: cairo_gal.cpp:1438

References deinitSurface(), and KIGFX::CAIRO_GAL_BASE::EndGroup().

◆ endUpdate()

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

Disables item update mode.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1113 of file graphics_abstraction_layer.h.

1113 {}

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

◆ Flush()

void CAIRO_GAL_BASE::Flush ( )
overridevirtualinherited

Force all remaining objects to be drawn.

Reimplemented from KIGFX::GAL.

Definition at line 517 of file cairo_gal.cpp.

518 {
519  storePath();
520 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034

References KIGFX::CAIRO_GAL_BASE::storePath().

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

◆ flushPath()

void CAIRO_GAL_BASE::flushPath ( )
protectedinherited

Definition at line 1012 of file cairo_gal.cpp.

1013 {
1014  if( isFillEnabled )
1015  {
1016  cairo_set_source_rgba( currentContext,
1018 
1019  if( isStrokeEnabled )
1020  cairo_fill_preserve( currentContext );
1021  else
1022  cairo_fill( currentContext );
1023  }
1024 
1025  if( isStrokeEnabled )
1026  {
1027  cairo_set_source_rgba( currentContext,
1029  cairo_stroke( currentContext );
1030  }
1031 }
double g
Green component.
Definition: color4d.h:302
COLOR4D fillColor
The fill color.
double b
Blue component.
Definition: color4d.h:303
double a
Alpha component.
Definition: color4d.h:304
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:312
double r
Red component.
Definition: color4d.h:301

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().

◆ GetClearColor()

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

Definition at line 215 of file graphics_abstraction_layer.h.

216  {
217  return m_clearColor;
218  }

References KIGFX::GAL::m_clearColor.

Referenced by EDIT_POINTS::ViewDraw().

◆ getCursorColor()

COLOR4D GAL::getCursorColor ( ) const
protectedinherited

Gets the actual cursor color to draw.

Definition at line 238 of file graphics_abstraction_layer.cpp.

239 {
240  auto color = cursorColor;
241 
242  // dim the cursor if it's only on because it was forced
243  // (this helps to provide a hint for active tools)
244  if( !isCursorEnabled )
245  {
246  color.a = color.a * 0.5;
247  }
248 
249  return color;
250 }
bool isCursorEnabled
Is the cursor enabled?
int color
Definition: DXF_plotter.cpp:62
COLOR4D cursorColor
Cursor color.

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

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

◆ GetFillColor()

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

Get the fill color.

Returns
the color for filling a outline.

Definition at line 265 of file graphics_abstraction_layer.h.

266  {
267  return fillColor;
268  }
COLOR4D fillColor
The fill color.

References KIGFX::GAL::fillColor.

◆ GetGlyphSize()

◆ GetGridLineWidth()

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

Get the grid line width.

Returns
the grid line width

Definition at line 943 of file graphics_abstraction_layer.h.

944  {
945  return gridLineWidth;
946  }
float gridLineWidth
Line width of the grid.

References KIGFX::GAL::gridLineWidth.

◆ 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 216 of file graphics_abstraction_layer.cpp.

217 {
218 #if 0
219  // This old code expects a non zero grid size, which can be wrong here.
220  return VECTOR2D( KiROUND( ( aPoint.x - gridOffset.x ) / gridSize.x ) * gridSize.x + gridOffset.x,
221  KiROUND( ( aPoint.y - gridOffset.y ) / gridSize.y ) * gridSize.y + gridOffset.y );
222 #else
223  // if grid size == 0.0 there is no grid, so use aPoint as grid reference position
224  double cx = gridSize.x > 0.0 ? KiROUND( ( aPoint.x - gridOffset.x ) / gridSize.x ) * gridSize.x + gridOffset.x
225  : aPoint.x;
226  double cy = gridSize.y > 0.0 ? KiROUND( ( aPoint.y - gridOffset.y ) / gridSize.y ) * gridSize.y + gridOffset.y
227  : aPoint.y;
228 
229  return VECTOR2D( cx, cy );
230 #endif
231 }
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:118
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
VECTOR2D gridSize
The grid size.

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().

◆ 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 895 of file graphics_abstraction_layer.h.

896  {
897  return gridSize;
898  }
VECTOR2D gridSize
The grid size.

References KIGFX::GAL::gridSize.

Referenced by SCH_DRAW_PANEL::SwitchBackend().

◆ GetHorizontalJustify()

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

Returns current text horizontal justification setting.

Definition at line 487 of file graphics_abstraction_layer.h.

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

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

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

◆ 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 687 of file graphics_abstraction_layer.h.

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

References KIGFX::GAL::lookAtPoint.

◆ GetMaxDepth()

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

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

Definition at line 756 of file graphics_abstraction_layer.h.

757  {
758  return depthRange.y;
759  }
VECTOR2D depthRange
Range of the depth.

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

◆ GetMinDepth()

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

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

Definition at line 748 of file graphics_abstraction_layer.h.

749  {
750  return depthRange.x;
751  }
VECTOR2D depthRange
Range of the depth.

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

◆ 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 1173 of file cairo_gal.cpp.

1174 {
1175  wxASSERT_MSG( groups.size() < std::numeric_limits<unsigned int>::max(),
1176  wxT( "There are no free slots to store a group" ) );
1177 
1178  while( groups.find( groupCounter ) != groups.end() )
1179  groupCounter++;
1180 
1181  return groupCounter++;
1182 }
unsigned int groupCounter
Counter used for generating keys for groups.
Definition: cairo_gal.h:301
std::map< int, GROUP > groups
List of graphic groups.
Definition: cairo_gal.h:300
#define max(a, b)
Definition: auxiliary.h:86

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

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

◆ 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 382 of file graphics_abstraction_layer.h.

383  {
385  }
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.

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

◆ GetRotation()

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

Get the rotation angle.

Returns
The rotation angle (radians).

Definition at line 727 of file graphics_abstraction_layer.h.

728  {
729  return rotation;
730  }
double rotation
Rotation transformation (radians)

References KIGFX::GAL::rotation.

◆ 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 623 of file graphics_abstraction_layer.h.

624  {
625  return screenWorldMatrix;
626  }
MATRIX3x3D screenWorldMatrix
Screen transformation.

References KIGFX::GAL::screenWorldMatrix.

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

◆ GetStrokeColor()

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

Get the stroke color.

Returns
the color for stroking the outline.

Definition at line 285 of file graphics_abstraction_layer.h.

286  {
287  return strokeColor;
288  }
COLOR4D strokeColor
The color of the outlines.

References KIGFX::GAL::strokeColor.

◆ GetStrokeFont()

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

Definition at line 327 of file graphics_abstraction_layer.h.

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

References KIGFX::GAL::strokeFont.

Referenced by EDA_TEXT::GetTextBox().

◆ GetTarget()

RENDER_TARGET CAIRO_GAL::GetTarget ( ) const
overridevirtual

Gets the currently used target for rendering.

Returns
The current rendering target.

Reimplemented from KIGFX::GAL.

Definition at line 1386 of file cairo_gal.cpp.

1387 {
1388  return currentTarget;
1389 }
RENDER_TARGET currentTarget
Current rendering target.
Definition: cairo_gal.h:425

References currentTarget.

◆ 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.

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.

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

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

◆ GetVerticalJustify()

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

Returns current text vertical justification setting.

Definition at line 505 of file graphics_abstraction_layer.h.

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

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

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

◆ GetWorldScale()

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

Get the world scale.

Returns
the actual world scale factor.

Definition at line 766 of file graphics_abstraction_layer.h.

767  {
768  return worldScale;
769  }
double worldScale
The scale factor world->screen.

References KIGFX::GAL::worldScale.

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

◆ GetWorldScreenMatrix()

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

Get the world <-> screen transformation matrix.

Returns
the transformation matrix.

Definition at line 613 of file graphics_abstraction_layer.h.

614  {
615  return worldScreenMatrix;
616  }
MATRIX3x3D worldScreenMatrix
World transformation.

References KIGFX::GAL::worldScreenMatrix.

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

◆ GetZoomFactor()

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

Get the zoom factor.

Returns
the zoom factor.

Definition at line 707 of file graphics_abstraction_layer.h.

708  {
709  return zoomFactor;
710  }
double zoomFactor
The zoom factor.

References KIGFX::GAL::zoomFactor.

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

◆ initSurface()

void CAIRO_GAL::initSurface ( )
protected

Prepare Cairo surfaces for drawing.

Definition at line 1418 of file cairo_gal.cpp.

1419 {
1420  if( isInitialized )
1421  return;
1422 
1423  surface = cairo_image_surface_create_for_data( (unsigned char*) bitmapBuffer, GAL_FORMAT,
1425 
1426  context = cairo_create( surface );
1427 
1428 #ifdef __WXDEBUG__
1429  cairo_status_t status = cairo_status( context );
1430  wxASSERT_MSG( status == CAIRO_STATUS_SUCCESS, wxT( "Cairo context creation error" ) );
1431 #endif /* __WXDEBUG__ */
1433 
1434  isInitialized = true;
1435 }
cairo_surface_t * surface
Cairo surface.
Definition: cairo_gal.h:314
bool isInitialized
Are Cairo image & surface ready to use.
Definition: cairo_gal.h:440
cairo_t * context
Cairo image.
Definition: cairo_gal.h:313
unsigned int * bitmapBuffer
Storage of the cairo image.
Definition: cairo_gal.h:436
int stride
Stride value for Cairo.
Definition: cairo_gal.h:438
VECTOR2I screenSize
Screen size in screen coordinates.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
static constexpr cairo_format_t GAL_FORMAT
Format used to store pixels.
Definition: cairo_gal.h:344

References bitmapBuffer, KIGFX::CAIRO_GAL_BASE::context, KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::GAL_FORMAT, isInitialized, KIGFX::GAL::screenSize, stride, KIGFX::CAIRO_GAL_BASE::surface, wxBufferWidth, and VECTOR2< T >::y.

Referenced by beginDrawing(), and BeginGroup().

◆ 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 996 of file graphics_abstraction_layer.h.

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

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

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

◆ IsFlippedX()

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

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

Definition at line 786 of file graphics_abstraction_layer.h.

787  {
788  return globalFlipX;
789  }
bool globalFlipX
Flag for X axis flipping.

References KIGFX::GAL::globalFlipX.

Referenced by KIGFX::CAIRO_GAL_BASE::angle_xform(), and KIGFX::CAIRO_GAL_BASE::arc_angles_xform_and_normalize().

◆ IsFlippedY()

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

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

Definition at line 794 of file graphics_abstraction_layer.h.

795  {
796  return globalFlipY;
797  }
bool globalFlipY
Flag for Y axis flipping.

References KIGFX::GAL::globalFlipY.

◆ IsFontBold()

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

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

Definition at line 433 of file graphics_abstraction_layer.h.

434  {
435  return textProperties.m_bold;
436  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

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

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

◆ IsFontItalic()

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

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

Definition at line 451 of file graphics_abstraction_layer.h.

452  {
453  return textProperties.m_italic;
454  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

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

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

◆ 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.

73 { return true; }

Referenced by SCH_DRAW_PANEL::onPaint(), and EDA_DRAW_PANEL_GAL::onRefreshTimer().

◆ 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.

82 { return false; }

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

◆ IsTextMirrored()

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

Returns true if text should displayed mirrored.

Definition at line 469 of file graphics_abstraction_layer.h.

470  {
471  return textProperties.m_mirrored;
472  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

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

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

◆ IsVisible()

bool KIGFX::CAIRO_GAL::IsVisible ( ) const
inlineoverridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 373 of file cairo_gal.h.

374  {
375  return IsShownOnScreen() && !GetClientRect().IsEmpty();
376  }

◆ lockContext()

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

Private: use GAL_CONTEXT_LOCKER RAII object.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1104 of file graphics_abstraction_layer.h.

1104 {}

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

◆ 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.

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.

References KIGFX::GAL::updatedGalDisplayOptions().

◆ onPaint()

void CAIRO_GAL::onPaint ( wxPaintEvent &  aEvent)
protected

Paint event handler.

Parameters
aEventis the paint event.

Definition at line 1490 of file cairo_gal.cpp.

1491 {
1492  PostPaint();
1493 }
void PostPaint()
Function PostPaint posts an event to m_paint_listener.
Definition: cairo_gal.h:401

References PostPaint().

Referenced by CAIRO_GAL().

◆ PopDepth()

void KIGFX::GAL::PopDepth ( )
inlineinherited

Restores previously stored drawing depth for the depth stack.

Definition at line 1038 of file graphics_abstraction_layer.h.

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

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

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

◆ PostPaint()

void KIGFX::CAIRO_GAL::PostPaint ( )
inline

Function PostPaint posts an event to m_paint_listener.

A post is used so that the actual drawing function can use a device context type that is not specific to the wxEVT_PAINT event.

Definition at line 401 of file cairo_gal.h.

402  {
403  if( paintListener )
404  {
405  wxPaintEvent redrawEvent;
406  wxPostEvent( paintListener, redrawEvent );
407  }
408  }
wxEvtHandler * paintListener
Paint listener.
Definition: cairo_gal.h:431

References paintListener.

Referenced by onPaint().

◆ PushDepth()

void KIGFX::GAL::PushDepth ( )
inlineinherited

Stores current drawing depth on the depth stack.

Definition at line 1030 of file graphics_abstraction_layer.h.

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

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

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

◆ resetContext()

void CAIRO_GAL_BASE::resetContext ( )
protectedinherited

Definition at line 922 of file cairo_gal.cpp.

923 {
924  ClearScreen();
925 
926  // Compute the world <-> screen transformations
928 
929  cairo_matrix_init( &cairoWorldScreenMatrix, worldScreenMatrix.m_data[0][0],
932  worldScreenMatrix.m_data[1][2] );
933 
934  // we work in screen-space coordinates and do the transforms outside.
935  cairo_identity_matrix( context );
936 
937  cairo_matrix_init_identity( &currentXform );
938 
939  // Start drawing with a new path
940  cairo_new_path( context );
941  isElementAdded = true;
942 
944 
945  lineWidth = 0;
946 }
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:523
cairo_t * context
Cairo image.
Definition: cairo_gal.h:313
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:96
MATRIX3x3D worldScreenMatrix
World transformation.
cairo_matrix_t currentXform
Definition: cairo_gal.h:310
cairo_matrix_t cairoWorldScreenMatrix
Cairo world to screen transformation matrix.
Definition: cairo_gal.h:309
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:298

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

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

◆ 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.

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.

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(), KIGFX::GAL::GAL(), and KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw().

◆ ResizeScreen()

void CAIRO_GAL::ResizeScreen ( int  aWidth,
int  aHeight 
)
overridevirtual

Resizes the canvas.

Reimplemented from KIGFX::CAIRO_GAL_BASE.

Definition at line 1285 of file cairo_gal.cpp.

1286 {
1287  CAIRO_GAL_BASE::ResizeScreen( aWidth, aHeight );
1288 
1289  // Recreate the bitmaps
1290  deleteBitmaps();
1291  allocateBitmaps();
1292 
1293  if( validCompositor )
1294  compositor->Resize( aWidth, aHeight );
1295 
1296  validCompositor = false;
1297 
1298  SetSize( wxSize( aWidth, aHeight ) );
1299 }
virtual void ResizeScreen(int aWidth, int aHeight) override
Resizes the canvas.
Definition: cairo_gal.cpp:511
bool validCompositor
Compositor initialization flag.
Definition: cairo_gal.h:426
std::shared_ptr< CAIRO_COMPOSITOR > compositor
Object for layers compositing.
Definition: cairo_gal.h:422
void deleteBitmaps()
Allocate the bitmaps for drawing.
Definition: cairo_gal.cpp:1467
void allocateBitmaps()
Allocate the bitmaps for drawing.
Definition: cairo_gal.cpp:1452

References allocateBitmaps(), compositor, deleteBitmaps(), KIGFX::CAIRO_GAL_BASE::ResizeScreen(), and validCompositor.

◆ Restore()

void CAIRO_GAL_BASE::Restore ( )
overridevirtualinherited

Restore the context.

Reimplemented from KIGFX::GAL.

Definition at line 718 of file cairo_gal.cpp.

719 {
720  storePath();
721 
722  if( isGrouping )
723  {
724  GROUP_ELEMENT groupElement;
725  groupElement.command = CMD_RESTORE;
726  currentGroup->push_back( groupElement );
727  }
728  else
729  {
730  if( !xformStack.empty() )
731  {
732  currentXform = xformStack.back();
733  xformStack.pop_back();
735  }
736  }
737 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
std::vector< cairo_matrix_t > xformStack
Definition: cairo_gal.h:316
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:302
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:297
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:96
cairo_matrix_t currentXform
Definition: cairo_gal.h:310
Restore the transformation matrix.
Definition: cairo_gal.h:280

References KIGFX::CAIRO_GAL_BASE::CMD_RESTORE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::command, KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::CAIRO_GAL_BASE::currentXform, KIGFX::CAIRO_GAL_BASE::isGrouping, KIGFX::CAIRO_GAL_BASE::storePath(), KIGFX::CAIRO_GAL_BASE::updateWorldScreenMatrix(), and KIGFX::CAIRO_GAL_BASE::xformStack.

◆ RestoreScreen()

void CAIRO_GAL::RestoreScreen ( )
overridevirtual

Restore the screen contents.

Reimplemented from KIGFX::GAL.

Definition at line 1329 of file cairo_gal.cpp.

1330 {
1331  int offset = 0;
1332 
1333  for( int j = 0; j < screenSize.y; j++ )
1334  {
1335  for( int i = 0; i < stride; i++ )
1336  {
1337  bitmapBuffer[offset + i] = bitmapBufferBackup[offset + i];
1338  offset += stride;
1339  }
1340  }
1341 }
unsigned int * bitmapBuffer
Storage of the cairo image.
Definition: cairo_gal.h:436
int stride
Stride value for Cairo.
Definition: cairo_gal.h:438
unsigned int * bitmapBufferBackup
Backup storage of the cairo image.
Definition: cairo_gal.h:437
size_t i
Definition: json11.cpp:597
VECTOR2I screenSize
Screen size in screen coordinates.

References bitmapBuffer, bitmapBufferBackup, i, KIGFX::GAL::screenSize, stride, and VECTOR2< T >::y.

◆ 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 641 of file cairo_gal.cpp.

642 {
643  storePath();
644 
645  if( isGrouping )
646  {
647  GROUP_ELEMENT groupElement;
648  groupElement.command = CMD_ROTATE;
649  groupElement.argument.dblArg[0] = aAngle;
650  currentGroup->push_back( groupElement );
651  }
652  else
653  {
654  cairo_matrix_rotate( &currentXform, aAngle );
656  }
657 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:302
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:297
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:96
cairo_matrix_t currentXform
Definition: cairo_gal.h:310

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::currentGroup, KIGFX::CAIRO_GAL_BASE::currentXform, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::dblArg, KIGFX::CAIRO_GAL_BASE::isGrouping, KIGFX::CAIRO_GAL_BASE::storePath(), and KIGFX::CAIRO_GAL_BASE::updateWorldScreenMatrix().

◆ roundp()

◆ Save()

void CAIRO_GAL_BASE::Save ( )
overridevirtualinherited

Save the context.

Reimplemented from KIGFX::GAL.

Definition at line 700 of file cairo_gal.cpp.

701 {
702  storePath();
703 
704  if( isGrouping )
705  {
706  GROUP_ELEMENT groupElement;
707  groupElement.command = CMD_SAVE;
708  currentGroup->push_back( groupElement );
709  }
710  else
711  {
712  xformStack.push_back( currentXform );
714  }
715 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
std::vector< cairo_matrix_t > xformStack
Definition: cairo_gal.h:316
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:302
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:297
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:96
Save the transformation matrix.
Definition: cairo_gal.h:279
cairo_matrix_t currentXform
Definition: cairo_gal.h:310

References KIGFX::CAIRO_GAL_BASE::CMD_SAVE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::command, KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::CAIRO_GAL_BASE::currentXform, KIGFX::CAIRO_GAL_BASE::isGrouping, KIGFX::CAIRO_GAL_BASE::storePath(), KIGFX::CAIRO_GAL_BASE::updateWorldScreenMatrix(), and KIGFX::CAIRO_GAL_BASE::xformStack.

◆ SaveScreen()

void CAIRO_GAL::SaveScreen ( )
overridevirtual

Save the screen contents.

Reimplemented from KIGFX::GAL.

Definition at line 1313 of file cairo_gal.cpp.

1314 {
1315  // Copy the current bitmap to the backup buffer
1316  int offset = 0;
1317 
1318  for( int j = 0; j < screenSize.y; j++ )
1319  {
1320  for( int i = 0; i < stride; i++ )
1321  {
1322  bitmapBufferBackup[offset + i] = bitmapBuffer[offset + i];
1323  offset += stride;
1324  }
1325  }
1326 }
unsigned int * bitmapBuffer
Storage of the cairo image.
Definition: cairo_gal.h:436
int stride
Stride value for Cairo.
Definition: cairo_gal.h:438
unsigned int * bitmapBufferBackup
Backup storage of the cairo image.
Definition: cairo_gal.h:437
size_t i
Definition: json11.cpp:597
VECTOR2I screenSize
Screen size in screen coordinates.

References bitmapBuffer, bitmapBufferBackup, i, KIGFX::GAL::screenSize, stride, and VECTOR2< T >::y.

◆ 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 680 of file cairo_gal.cpp.

681 {
682  storePath();
683 
684  if( isGrouping )
685  {
686  GROUP_ELEMENT groupElement;
687  groupElement.command = CMD_SCALE;
688  groupElement.argument.dblArg[0] = aScale.x;
689  groupElement.argument.dblArg[1] = aScale.y;
690  currentGroup->push_back( groupElement );
691  }
692  else
693  {
694  cairo_matrix_scale( &currentXform, aScale.x, aScale.y );
696  }
697 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:302
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:297
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:96
cairo_matrix_t currentXform
Definition: cairo_gal.h:310

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::currentGroup, KIGFX::CAIRO_GAL_BASE::currentXform, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::dblArg, KIGFX::CAIRO_GAL_BASE::isGrouping, KIGFX::CAIRO_GAL_BASE::storePath(), KIGFX::CAIRO_GAL_BASE::updateWorldScreenMatrix(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ 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 915 of file graphics_abstraction_layer.h.

916  {
917  axesColor = aAxesColor;
918  }
COLOR4D axesColor
Color of the axes.

References KIGFX::GAL::axesColor.

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

◆ SetAxesEnabled()

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

◆ SetClearColor()

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

◆ 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 933 of file graphics_abstraction_layer.h.

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

References KIGFX::GAL::gridTick.

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

◆ setCompositor()

void CAIRO_GAL::setCompositor ( )
protected

Prepare the compositor.

Definition at line 1475 of file cairo_gal.cpp.

1476 {
1477  // Recreate the compositor with the new Cairo context
1478  compositor.reset( new CAIRO_COMPOSITOR( &currentContext ) );
1479  compositor->Resize( screenSize.x, screenSize.y );
1480  compositor->SetAntialiasingMode( options.cairo_antialiasing_mode );
1481 
1482  // Prepare buffers
1483  mainBuffer = compositor->CreateBuffer();
1484  overlayBuffer = compositor->CreateBuffer();
1485 
1486  validCompositor = true;
1487 }
GAL_DISPLAY_OPTIONS & options
unsigned int overlayBuffer
Handle to the overlay buffer.
Definition: cairo_gal.h:424
bool validCompositor
Compositor initialization flag.
Definition: cairo_gal.h:426
CAIRO_ANTIALIASING_MODE cairo_antialiasing_mode
std::shared_ptr< CAIRO_COMPOSITOR > compositor
Object for layers compositing.
Definition: cairo_gal.h:422
VECTOR2I screenSize
Screen size in screen coordinates.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
unsigned int mainBuffer
Handle to the main buffer.
Definition: cairo_gal.h:423

References KIGFX::GAL_DISPLAY_OPTIONS::cairo_antialiasing_mode, compositor, KIGFX::CAIRO_GAL_BASE::currentContext, mainBuffer, KIGFX::GAL::options, overlayBuffer, KIGFX::GAL::screenSize, validCompositor, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by beginDrawing().

◆ SetCursorColor()

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

Set the cursor color.

Parameters
aCursorColoris the color of the cursor.

Definition at line 1006 of file graphics_abstraction_layer.h.

1007  {
1008  cursorColor = aCursorColor;
1009  }
COLOR4D cursorColor
Cursor color.

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().

◆ 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 987 of file graphics_abstraction_layer.h.

988  {
989  isCursorEnabled = aCursorEnabled;
990  }
bool isCursorEnabled
Is the cursor enabled?

References KIGFX::GAL::isCursorEnabled.

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

◆ 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 740 of file graphics_abstraction_layer.h.

741  {
742  depthRange = aDepthRange;
743  }
VECTOR2D depthRange
Range of the depth.

References KIGFX::GAL::depthRange.

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

◆ 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 579 of file cairo_gal.cpp.

580 {
581  storePath();
582  fillColor = aColor;
583 
584  if( isGrouping )
585  {
586  GROUP_ELEMENT groupElement;
587  groupElement.command = CMD_SET_FILLCOLOR;
588  groupElement.argument.dblArg[0] = fillColor.r;
589  groupElement.argument.dblArg[1] = fillColor.g;
590  groupElement.argument.dblArg[2] = fillColor.b;
591  groupElement.argument.dblArg[3] = fillColor.a;
592  currentGroup->push_back( groupElement );
593  }
594 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
double g
Green component.
Definition: color4d.h:302
COLOR4D fillColor
The fill color.
double b
Blue component.
Definition: color4d.h:303
double a
Alpha component.
Definition: color4d.h:304
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:302
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:297
double r
Red component.
Definition: color4d.h:301

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().

◆ 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 777 of file graphics_abstraction_layer.h.

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

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

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

◆ 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 425 of file graphics_abstraction_layer.h.

426  {
427  textProperties.m_bold = aBold;
428  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

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().

◆ 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 443 of file graphics_abstraction_layer.h.

444  {
445  textProperties.m_italic = aItalic;
446  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

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().

◆ SetGlyphSize()

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

◆ 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 905 of file graphics_abstraction_layer.h.

906  {
907  gridColor = aGridColor;
908  }
COLOR4D gridColor
Color of the grid.

References KIGFX::GAL::gridColor.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), 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(), and PCB_DRAW_PANEL_GAL::UseColorScheme().

◆ 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 866 of file graphics_abstraction_layer.h.

867  {
868  gridOrigin = aGridOrigin;
869 
870  if( gridSize.x == 0.0 || gridSize.y == 0.0 )
871  gridOffset = VECTOR2D(0.0, 0.0);
872  else
873  gridOffset = VECTOR2D( (long) gridOrigin.x % (long) gridSize.x,
874  (long) gridOrigin.y % (long) gridSize.y );
875  }
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.

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().

◆ 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 882 of file graphics_abstraction_layer.h.

883  {
884  gridSize = aGridSize;
885 
886  gridOffset = VECTOR2D( (long) gridOrigin.x % (long) gridSize.x,
887  (long) gridOrigin.y % (long) gridSize.y );
888  }
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.

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

Referenced by COMMON_TOOLS::GridPreset(), DIALOG_PAD_PROPERTIES::prepareCanvas(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), SCH_DRAW_PANEL::SwitchBackend(), FOOTPRINT_EDIT_FRAME::SwitchCanvas(), SCH_BASE_FRAME::SyncView(), and PCBNEW_CONTROL::updateGrid().

◆ 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 856 of file graphics_abstraction_layer.h.

857  {
858  gridVisibility = aVisibility;
859  }
bool gridVisibility
Should the grid be shown.

References KIGFX::GAL::gridVisibility.

Referenced by KIGFX::GAL::GAL(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBER_LAYER_WIDGET::OnRenderEnable(), DIALOG_PAD_PROPERTIES::prepareCanvas(), SCH_DRAW_PANEL::SwitchBackend(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), and COMMON_TOOLS::ToggleGrid().

◆ 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 479 of file graphics_abstraction_layer.h.

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

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

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

◆ 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 531 of file cairo_gal.cpp.

532 {
533  storePath();
534  isFillEnabled = aIsFillEnabled;
535 
536  if( isGrouping )
537  {
538  GROUP_ELEMENT groupElement;
539  groupElement.command = CMD_SET_FILL;
540  groupElement.argument.boolArg = aIsFillEnabled;
541  currentGroup->push_back( groupElement );
542  }
543 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
Enable/disable filling.
Definition: cairo_gal.h:268
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:302
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:297
bool isFillEnabled
Is filling of graphic objects enabled ?

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().

◆ 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 546 of file cairo_gal.cpp.

547 {
548  storePath();
549  isStrokeEnabled = aIsStrokeEnabled;
550 
551  if( isGrouping )
552  {
553  GROUP_ELEMENT groupElement;
554  groupElement.command = CMD_SET_STROKE;
555  groupElement.argument.boolArg = aIsStrokeEnabled;
556  currentGroup->push_back( groupElement );
557  }
558 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
bool isStrokeEnabled
Are the outlines stroked ?
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:302
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:297
Enable/disable stroking.
Definition: cairo_gal.h:269

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().

◆ 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 616 of file cairo_gal.cpp.

617 {
618  super::SetLayerDepth( aLayerDepth );
619  storePath();
620 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
virtual void SetLayerDepth(double aLayerDepth)
Set the depth of the layer (position on the z-axis)

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

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

◆ SetLineWidth()

void CAIRO_GAL_BASE::SetLineWidth ( float  aLineWidth)
overridevirtualinherited

Set the line width.

Parameters
aLineWidthis the line width.

Reimplemented from KIGFX::GAL.

Reimplemented in KIGFX::CAIRO_PRINT_GAL.

Definition at line 597 of file cairo_gal.cpp.

598 {
599  storePath();
600  GAL::SetLineWidth( aLineWidth );
601 
602  if( isGrouping )
603  {
604  GROUP_ELEMENT groupElement;
605  groupElement.command = CMD_SET_LINE_WIDTH;
606  groupElement.argument.dblArg[0] = aLineWidth;
607  currentGroup->push_back( groupElement );
608  }
609  else
610  {
611  lineWidth = aLineWidth;
612  }
613 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
virtual void SetLineWidth(float aLineWidth)
Set the line width.
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:302
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:297

References KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::argument, KIGFX::CAIRO_GAL_BASE::CMD_SET_LINE_WIDTH, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::command, KIGFX::CAIRO_GAL_BASE::currentGroup, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::dblArg, KIGFX::CAIRO_GAL_BASE::isGrouping, KIGFX::CAIRO_GAL_BASE::lineWidth, KIGFX::GAL::SetLineWidth(), and KIGFX::CAIRO_GAL_BASE::storePath().

Referenced by KIGFX::CAIRO_GAL_BASE::DrawGrid(), and KIGFX::CAIRO_GAL_BASE::DrawSegment().

◆ 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 677 of file graphics_abstraction_layer.h.

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

References KIGFX::GAL::lookAtPoint.

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

◆ SetMouseListener()

void KIGFX::CAIRO_GAL::SetMouseListener ( wxEvtHandler *  aMouseListener)
inline

Definition at line 410 of file cairo_gal.h.

411  {
412  mouseListener = aMouseListener;
413  }
wxEvtHandler * mouseListener
Mouse listener.
Definition: cairo_gal.h:430

References mouseListener.

◆ 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 905 of file cairo_gal.cpp.

906 {
907  cairo_set_operator( currentContext, aSetting ? CAIRO_OPERATOR_CLEAR : CAIRO_OPERATOR_OVER );
908 }
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312

References KIGFX::CAIRO_GAL_BASE::currentContext.

◆ SetPaintListener()

void KIGFX::CAIRO_GAL::SetPaintListener ( wxEvtHandler *  aPaintListener)
inline

Definition at line 415 of file cairo_gal.h.

416  {
417  paintListener = aPaintListener;
418  }
wxEvtHandler * paintListener
Paint listener.
Definition: cairo_gal.h:431

References paintListener.

◆ SetRotation()

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

Set the rotation angle.

Parameters
aRotationis the new rotation angle (radians).

Definition at line 717 of file graphics_abstraction_layer.h.

718  {
719  rotation = aRotation;
720  }
double rotation
Rotation transformation (radians)

References KIGFX::GAL::rotation.

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

◆ 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 665 of file graphics_abstraction_layer.h.

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

References KIGFX::GAL::screenDPI.

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

◆ SetScreenSize()

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

Definition at line 652 of file graphics_abstraction_layer.h.

653  {
654  screenSize = aSize;
655  }
VECTOR2I screenSize
Screen size in screen coordinates.

References KIGFX::GAL::screenSize.

Referenced by KIGFX::CAIRO_PRINT_GAL::SetSheetSize().

◆ 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 561 of file cairo_gal.cpp.

562 {
563  storePath();
564  strokeColor = aColor;
565 
566  if( isGrouping )
567  {
568  GROUP_ELEMENT groupElement;
569  groupElement.command = CMD_SET_STROKECOLOR;
570  groupElement.argument.dblArg[0] = strokeColor.r;
571  groupElement.argument.dblArg[1] = strokeColor.g;
572  groupElement.argument.dblArg[2] = strokeColor.b;
573  groupElement.argument.dblArg[3] = strokeColor.a;
574  currentGroup->push_back( groupElement );
575  }
576 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
double g
Green component.
Definition: color4d.h:302
double b
Blue component.
Definition: color4d.h:303
double a
Alpha component.
Definition: color4d.h:304
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:302
COLOR4D strokeColor
The color of the outlines.
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:297
double r
Red component.
Definition: color4d.h:301

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.

◆ SetTarget()

void CAIRO_GAL::SetTarget ( RENDER_TARGET  aTarget)
overridevirtual

Sets the target for rendering.

Parameters
aTargetis the new target for rendering.

Reimplemented from KIGFX::GAL.

Definition at line 1358 of file cairo_gal.cpp.

1359 {
1360  // If the compositor is not set, that means that there is a recaching process going on
1361  // and we do not need the compositor now
1362  if( !validCompositor )
1363  return;
1364 
1365  // Cairo grouping prevents display of overlapping items on the same layer in the lighter color
1366  if( isInitialized )
1367  storePath();
1368 
1369  switch( aTarget )
1370  {
1371  default:
1372  case TARGET_CACHED:
1373  case TARGET_NONCACHED:
1374  compositor->SetBuffer( mainBuffer );
1375  break;
1376 
1377  case TARGET_OVERLAY:
1378  compositor->SetBuffer( overlayBuffer );
1379  break;
1380  }
1381 
1382  currentTarget = aTarget;
1383 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
bool isInitialized
Are Cairo image & surface ready to use.
Definition: cairo_gal.h:440
unsigned int overlayBuffer
Handle to the overlay buffer.
Definition: cairo_gal.h:424
bool validCompositor
Compositor initialization flag.
Definition: cairo_gal.h:426
Auxiliary rendering target (noncached)
Definition: definitions.h:49
RENDER_TARGET currentTarget
Current rendering target.
Definition: cairo_gal.h:425
std::shared_ptr< CAIRO_COMPOSITOR > compositor
Object for layers compositing.
Definition: cairo_gal.h:422
Items that may change while the view stays the same (noncached)
Definition: definitions.h:50
Main rendering target (cached)
Definition: definitions.h:48
unsigned int mainBuffer
Handle to the main buffer.
Definition: cairo_gal.h:423

References compositor, currentTarget, isInitialized, mainBuffer, overlayBuffer, KIGFX::CAIRO_GAL_BASE::storePath(), KIGFX::TARGET_CACHED, KIGFX::TARGET_NONCACHED, KIGFX::TARGET_OVERLAY, and validCompositor.

Referenced by CAIRO_GAL().

◆ 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.

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:167
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:185
bool IsMirrored() const
Definition: eda_text.h:173
bool IsItalic() const
Definition: eda_text.h:164
void SetFontBold(const bool aBold)
Set bold property of current font.
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:184
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
const wxSize & GetTextSize() const
Definition: eda_text.h:209
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.

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::PCB_PAINTER::draw(), and GRText().

◆ 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 461 of file graphics_abstraction_layer.h.

462  {
463  textProperties.m_mirrored = aMirrored;
464  }
struct KIGFX::GAL::TEXT_PROPERTIES textProperties

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().

◆ 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 497 of file graphics_abstraction_layer.h.

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

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

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

◆ 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 633 of file graphics_abstraction_layer.h.

634  {
635  worldScreenMatrix = aMatrix;
636  }
MATRIX3x3D worldScreenMatrix
World transformation.

References KIGFX::GAL::worldScreenMatrix.

◆ 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 647 of file graphics_abstraction_layer.h.

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

References KIGFX::GAL::worldUnitLength.

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

◆ SetZoomFactor()

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

Set the zoom factor of the scene.

Parameters
aZoomFactoris the zoom factor.

Definition at line 697 of file graphics_abstraction_layer.h.

698  {
699  zoomFactor = aZoomFactor;
700  }
double zoomFactor
The zoom factor.

References KIGFX::GAL::zoomFactor.

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

◆ Show()

bool CAIRO_GAL::Show ( bool  aShow)
overridevirtual

Shows/hides the GAL canvas.

Reimplemented from KIGFX::GAL.

Definition at line 1302 of file cairo_gal.cpp.

1303 {
1304  bool s = wxWindow::Show( aShow );
1305 
1306  if( aShow )
1307  wxWindow::Raise();
1308 
1309  return s;
1310 }

◆ skipMouseEvent()

void CAIRO_GAL::skipMouseEvent ( wxMouseEvent &  aEvent)
protected

Mouse event handler, forwards the event to the child.

Parameters
aEventis the mouse event to be forwarded.

Definition at line 1496 of file cairo_gal.cpp.

1497 {
1498  // Post the mouse event to the event listener registered in constructor, if any
1499  if( mouseListener )
1500  wxPostEvent( mouseListener, aEvent );
1501 }
wxEvtHandler * mouseListener
Mouse listener.
Definition: cairo_gal.h:430

References mouseListener.

Referenced by CAIRO_GAL().

◆ storePath()

void CAIRO_GAL_BASE::storePath ( )
protectedinherited

Store the actual path.

Definition at line 1034 of file cairo_gal.cpp.

1035 {
1036  if( isElementAdded )
1037  {
1038  isElementAdded = false;
1039 
1040  if( !isGrouping )
1041  {
1042  if( isFillEnabled )
1043  {
1044  cairo_set_source_rgba( currentContext, fillColor.r, fillColor.g, fillColor.b, fillColor.a );
1045  cairo_fill_preserve( currentContext );
1046  }
1047 
1048  if( isStrokeEnabled )
1049  {
1050  cairo_set_source_rgba( currentContext, strokeColor.r, strokeColor.g,
1052  cairo_stroke_preserve( currentContext );
1053  }
1054  }
1055  else
1056  {
1057  // Copy the actual path, append it to the global path list
1058  // then check, if the path needs to be stroked/filled and
1059  // add this command to the group list;
1060  if( isStrokeEnabled )
1061  {
1062  GROUP_ELEMENT groupElement;
1063  groupElement.cairoPath = cairo_copy_path( currentContext );
1064  groupElement.command = CMD_STROKE_PATH;
1065  currentGroup->push_back( groupElement );
1066  }
1067 
1068  if( isFillEnabled )
1069  {
1070  GROUP_ELEMENT groupElement;
1071  groupElement.cairoPath = cairo_copy_path( currentContext );
1072  groupElement.command = CMD_FILL_PATH;
1073  currentGroup->push_back( groupElement );
1074  }
1075  }
1076 
1077  cairo_new_path( currentContext );
1078  }
1079 }
double g
Green component.
Definition: color4d.h:302
COLOR4D fillColor
The fill color.
double b
Blue component.
Definition: color4d.h:303
double a
Alpha component.
Definition: color4d.h:304
bool isStrokeEnabled
Are the outlines stroked ?
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:302
COLOR4D strokeColor
The color of the outlines.
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:297
bool isFillEnabled
Is filling of graphic objects enabled ?
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312
double r
Red component.
Definition: color4d.h:301
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:298

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(), KIGFX::CAIRO_PRINT_GAL::SetLineWidth(), KIGFX::CAIRO_GAL_BASE::SetLineWidth(), KIGFX::CAIRO_GAL_BASE::SetStrokeColor(), SetTarget(), and KIGFX::CAIRO_GAL_BASE::Translate().

◆ 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 339 of file graphics_abstraction_layer.h.

341  {
342  strokeFont.Draw( aText, aPosition, aRotationAngle );
343  }
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.

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

Referenced by KIGFX::GAL::BitmapText(), KIGFX::SCH_PAINTER::Draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), and GRText().

◆ syncLineWidth()

void CAIRO_GAL_BASE::syncLineWidth ( bool  aForceWidth = false,
double  aWidth = 0.0 
)
protectedinherited

Definition at line 201 of file cairo_gal.cpp.

202 {
203  auto w = floor( xform( aForceWidth ? aWidth : lineWidth ) + 0.5 );
204 
205  if (w <= 1.0)
206  {
207  w = 1.0;
208  cairo_set_line_join( currentContext, CAIRO_LINE_JOIN_MITER );
209  cairo_set_line_cap( currentContext, CAIRO_LINE_CAP_BUTT );
210  cairo_set_line_width( currentContext, 1.0 );
211  lineWidthIsOdd = true;
212  }
213  else
214  {
215  cairo_set_line_join( currentContext, CAIRO_LINE_JOIN_ROUND );
216  cairo_set_line_cap( currentContext, CAIRO_LINE_CAP_ROUND );
217  cairo_set_line_width( currentContext, w );
218  lineWidthIsOdd = ((int)w % 2) == 1;
219  }
220 
221  lineWidthInPixels = w;
222 }
const double xform(double x)
Definition: cairo_gal.cpp:164
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:312

References KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::lineWidth, KIGFX::CAIRO_GAL_BASE::lineWidthInPixels, KIGFX::CAIRO_GAL_BASE::lineWidthIsOdd, and KIGFX::CAIRO_GAL_BASE::xform().

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

◆ 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 977 of file graphics_abstraction_layer.h.

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

References KIGFX::GAL::worldScreenMatrix.

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

◆ 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 966 of file graphics_abstraction_layer.h.

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

References KIGFX::GAL::screenWorldMatrix.

◆ 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 623 of file cairo_gal.cpp.

624 {
625  cairo_matrix_t cairoTransformation, newXform;
626 
627  cairo_matrix_init( &cairoTransformation,
628  aTransformation.m_data[0][0],
629  aTransformation.m_data[1][0],
630  aTransformation.m_data[0][1],
631  aTransformation.m_data[1][1],
632  aTransformation.m_data[0][2],
633  aTransformation.m_data[1][2] );
634 
635  cairo_matrix_multiply( &newXform, &currentXform, &cairoTransformation );
636  currentXform = newXform;
638 }
T m_data[3][3]
Definition: matrix3x3.h:64
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:96
cairo_matrix_t currentXform
Definition: cairo_gal.h:310

References KIGFX::CAIRO_GAL_BASE::currentXform, MATRIX3x3< T >::m_data, and KIGFX::CAIRO_GAL_BASE::updateWorldScreenMatrix().

◆ 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 660 of file cairo_gal.cpp.

661 {
662  storePath();
663 
664  if( isGrouping )
665  {
666  GROUP_ELEMENT groupElement;
667  groupElement.command = CMD_TRANSLATE;
668  groupElement.argument.dblArg[0] = aTranslation.x;
669  groupElement.argument.dblArg[1] = aTranslation.y;
670  currentGroup->push_back( groupElement );
671  }
672  else
673  {
674  cairo_matrix_translate ( &currentXform, aTranslation.x, aTranslation.y );
676  }
677 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1034
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:302
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:297
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:96
cairo_matrix_t currentXform
Definition: cairo_gal.h:310
Translate the context.
Definition: cairo_gal.h:277

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::currentGroup, KIGFX::CAIRO_GAL_BASE::currentXform, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::dblArg, KIGFX::CAIRO_GAL_BASE::isGrouping, KIGFX::CAIRO_GAL_BASE::storePath(), KIGFX::CAIRO_GAL_BASE::updateWorldScreenMatrix(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ unlockContext()

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

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1106 of file graphics_abstraction_layer.h.

1106 {}

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

◆ updatedGalDisplayOptions()

bool CAIRO_GAL::updatedGalDisplayOptions ( const GAL_DISPLAY_OPTIONS aOptions)
overrideprotectedvirtual

Cairo-specific update handlers

Reimplemented from KIGFX::GAL.

Definition at line 1504 of file cairo_gal.cpp.

1505 {
1506  bool refresh = false;
1507 
1508  if( validCompositor && aOptions.cairo_antialiasing_mode != compositor->GetAntialiasingMode() )
1509  {
1510 
1511  compositor->SetAntialiasingMode( options.cairo_antialiasing_mode );
1512  validCompositor = false;
1513  deinitSurface();
1514 
1515  refresh = true;
1516  }
1517 
1518  if( super::updatedGalDisplayOptions( aOptions ) )
1519  {
1520  Refresh();
1521  refresh = true;
1522  }
1523 
1524  return refresh;
1525 }
void deinitSurface()
Destroy Cairo surfaces when are not needed anymore.
Definition: cairo_gal.cpp:1438
GAL_DISPLAY_OPTIONS & options
bool validCompositor
Compositor initialization flag.
Definition: cairo_gal.h:426
CAIRO_ANTIALIASING_MODE cairo_antialiasing_mode
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
std::shared_ptr< CAIRO_COMPOSITOR > compositor
Object for layers compositing.
Definition: cairo_gal.h:422
virtual bool updatedGalDisplayOptions(const GAL_DISPLAY_OPTIONS &aOptions)
Function updatedGalDisplayOptions.

References KIGFX::GAL_DISPLAY_OPTIONS::cairo_antialiasing_mode, compositor, deinitSurface(), KIGFX::GAL::options, Refresh(), KIGFX::GAL::updatedGalDisplayOptions(), and validCompositor.

◆ updateWorldScreenMatrix()

void CAIRO_GAL_BASE::updateWorldScreenMatrix ( )
protected