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 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, double aFilterValue=0.0) 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, int aMarkupFlags=0)
 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, int aMarkupFlags=0) 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 char * bitmapBuffer
 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_ARGB32
 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 339 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 290 of file cairo_gal.h.

◆ super

typedef GAL KIGFX::CAIRO_GAL_BASE::super
protectedinherited

Super class definition.

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

258  {
259  CMD_SET_FILL,
265  CMD_FILL_PATH,
266  //CMD_TRANSFORM, ///< Transform the actual context
267  CMD_ROTATE,
268  CMD_TRANSLATE,
269  CMD_SCALE,
270  CMD_SAVE,
271  CMD_RESTORE,
273  };
Enable/disable filling.
Definition: cairo_gal.h:259
Save the transformation matrix.
Definition: cairo_gal.h:270
Translate the context.
Definition: cairo_gal.h:268
Enable/disable stroking.
Definition: cairo_gal.h:260
Restore the transformation matrix.
Definition: cairo_gal.h:271

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

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

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

1235 {
1236  deleteBitmaps();
1237 }
void deleteBitmaps()
Allocate the bitmaps for drawing.
Definition: cairo_gal.cpp:1440

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

1019  {
1020  layerDepth -= 0.05;
1021  }
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 1426 of file cairo_gal.cpp.

1427 {
1429  while( ( ( wxBufferWidth * 3 ) % 4 ) != 0 ) wxBufferWidth++;
1430 
1431  // Create buffer, use the system independent Cairo context backend
1432  stride = cairo_format_stride_for_width( GAL_FORMAT, wxBufferWidth );
1434 
1435  bitmapBuffer = new unsigned char[bufferSize * 4];
1436  wxOutput = new unsigned char[wxBufferWidth * 3 * screenSize.y];
1437 }
unsigned char * wxOutput
wxImage comaptible buffer
Definition: cairo_gal.h:420
int stride
Stride value for Cairo.
Definition: cairo_gal.h:424
VECTOR2I screenSize
Screen size in screen coordinates.
unsigned int bufferSize
Size of buffers cairoOutput, bitmapBuffers.
Definition: cairo_gal.h:419
unsigned char * bitmapBuffer
Storage of the cairo image.
Definition: cairo_gal.h:423
static constexpr cairo_format_t GAL_FORMAT
Format used to store pixels.
Definition: cairo_gal.h:335

References bitmapBuffer, 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 119 of file cairo_gal.cpp.

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

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

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

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

1241 {
1242  initSurface();
1243 
1245 
1246  if( !validCompositor )
1247  setCompositor();
1248 
1249  compositor->SetMainContext( context );
1250  compositor->SetBuffer( mainBuffer );
1251 }
void initSurface()
Prepare Cairo surfaces for drawing.
Definition: cairo_gal.cpp:1392
void setCompositor()
Prepare the compositor.
Definition: cairo_gal.cpp:1447
bool validCompositor
Compositor initialization flag.
Definition: cairo_gal.h:413
std::shared_ptr< CAIRO_COMPOSITOR > compositor
Object for layers compositing.
Definition: cairo_gal.h:409
cairo_t * context
Cairo image.
Definition: cairo_gal.h:304
virtual void beginDrawing() override
Definition: cairo_gal.cpp:85
unsigned int mainBuffer
Handle to the main buffer.
Definition: cairo_gal.h:410

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

1319 {
1320  initSurface();
1321  return CAIRO_GAL_BASE::BeginGroup();
1322 }
void initSurface()
Prepare Cairo surfaces for drawing.
Definition: cairo_gal.cpp:1392
virtual int BeginGroup() override
Begin a group.
Definition: cairo_gal.cpp:744

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

1106 {}

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

360  {
361  // Fallback: use stroke font
362 
363  // Handle flipped view
364  if( globalFlipX )
366 
367  StrokeText( aText, aPosition, aRotationAngle );
368 
369  if( globalFlipX )
371  }
bool globalFlipX
Flag for X axis flipping.
virtual void StrokeText(const wxString &aText, const VECTOR2D &aPosition, double aRotationAngle, int aMarkupFlags=0)
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 1086 of file cairo_gal.cpp.

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

858 {
859  storePath();
860 
861  for( GROUP::iterator it = groups[aGroupNumber].begin();
862  it != groups[aGroupNumber].end(); ++it )
863  {
864  if( it->command == CMD_SET_FILLCOLOR || it->command == CMD_SET_STROKECOLOR )
865  {
866  it->argument.dblArg[0] = aNewColor.r;
867  it->argument.dblArg[1] = aNewColor.g;
868  it->argument.dblArg[2] = aNewColor.b;
869  it->argument.dblArg[3] = aNewColor.a;
870  }
871  }
872 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1038
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:291
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 875 of file cairo_gal.cpp.

876 {
877  // Cairo does not have any possibilities to change the depth coordinate of stored items,
878  // it depends only on the order of drawing
879 }

◆ ClearCache()

void CAIRO_GAL_BASE::ClearCache ( )
overridevirtualinherited

Delete all data created during caching of graphic items.

Reimplemented from KIGFX::GAL.

Definition at line 902 of file cairo_gal.cpp.

903 {
904  for( auto it = groups.begin(); it != groups.end(); )
905  DeleteGroup( ( it++ )->first );
906 }
virtual void DeleteGroup(int aGroupNumber) override
Delete the group from the memory.
Definition: cairo_gal.cpp:882
std::map< int, GROUP > groups
List of graphic groups.
Definition: cairo_gal.h:291

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

528 {
529  cairo_set_source_rgb( currentContext, m_clearColor.r, m_clearColor.g, m_clearColor.b );
530  cairo_rectangle( currentContext, 0.0, 0.0, screenSize.x, screenSize.y );
531  cairo_fill( currentContext );
532 }
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:303
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 1366 of file cairo_gal.cpp.

1367 {
1368  // Save the current state
1369  unsigned int currentBuffer = compositor->GetBuffer();
1370 
1371  switch( aTarget )
1372  {
1373  // Cached and noncached items are rendered to the same buffer
1374  default:
1375  case TARGET_CACHED:
1376  case TARGET_NONCACHED:
1377  compositor->SetBuffer( mainBuffer );
1378  break;
1379 
1380  case TARGET_OVERLAY:
1381  compositor->SetBuffer( overlayBuffer );
1382  break;
1383  }
1384 
1385  compositor->ClearBuffer( COLOR4D::BLACK );
1386 
1387  // Restore the previous state
1388  compositor->SetBuffer( currentBuffer );
1389 }
unsigned int overlayBuffer
Handle to the overlay buffer.
Definition: cairo_gal.h:411
Auxiliary rendering target (noncached)
Definition: definitions.h:49
static const COLOR4D BLACK
Definition: color4d.h:311
std::shared_ptr< CAIRO_COMPOSITOR > compositor
Object for layers compositing.
Definition: cairo_gal.h:409
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:410

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

211 {
212  // just return the current value. This could be cleverer and take
213  // into account other settings in future
214  return gridMinSpacing;
215 }
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 1120 of file graphics_abstraction_layer.h.

1121  {
1123  }
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 181 of file graphics_abstraction_layer.cpp.

182 {
184 
185  MATRIX3x3D translation;
186  translation.SetIdentity();
187  translation.SetTranslation( 0.5 * VECTOR2D( screenSize ) );
188 
189  MATRIX3x3D rotate;
190  rotate.SetIdentity();
191  rotate.SetRotation( rotation );
192 
194  scale.SetIdentity();
195  scale.SetScale( VECTOR2D( worldScale, worldScale ) );
196 
197  MATRIX3x3D flip;
198  flip.SetIdentity();
199  flip.SetScale( VECTOR2D( globalFlipX ? -1.0 : 1.0, globalFlipY ? -1.0 : 1.0 ) );
200 
201  MATRIX3x3D lookat;
202  lookat.SetIdentity();
203  lookat.SetTranslation( -lookAtPoint );
204 
205  worldScreenMatrix = translation * rotate * flip * scale * lookat;
207 }
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:593
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 1412 of file cairo_gal.cpp.

1413 {
1414  if( !isInitialized )
1415  return;
1416 
1417  cairo_destroy( context );
1418  context = nullptr;
1419  cairo_surface_destroy( surface );
1420  surface = nullptr;
1421 
1422  isInitialized = false;
1423 }
cairo_surface_t * surface
Cairo surface.
Definition: cairo_gal.h:305
bool isInitialized
Are Cairo image & surface ready to use.
Definition: cairo_gal.h:426
cairo_t * context
Cairo image.
Definition: cairo_gal.h:304

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

1441 {
1442  delete[] bitmapBuffer;
1443  delete[] wxOutput;
1444 }
unsigned char * wxOutput
wxImage comaptible buffer
Definition: cairo_gal.h:420
unsigned char * bitmapBuffer
Storage of the cairo image.
Definition: cairo_gal.h:423

References bitmapBuffer, 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 882 of file cairo_gal.cpp.

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

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

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

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

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

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

954 {
955  syncLineWidth();
956 
957  auto p0 = roundp( xform( aStartPoint ) );
958  auto p1 = roundp( xform( aEndPoint ) );
959  auto org = roundp( xform( VECTOR2D( 0.0, 0.0 ) ) ); // Axis origin = 0,0 coord
960 
961  cairo_set_source_rgba( currentContext, axesColor.r, axesColor.g, axesColor.b, axesColor.a );
962  cairo_move_to( currentContext, p0.x, org.y);
963  cairo_line_to( currentContext, p1.x, org.y );
964  cairo_move_to( currentContext, org.x, p0.y );
965  cairo_line_to( currentContext, org.x, p1.y );
966  cairo_stroke( currentContext );
967 }
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:593
COLOR4D axesColor
Color of the axes.
const double xform(double x)
Definition: cairo_gal.cpp:165
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:179
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:303
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:202
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 449 of file cairo_gal.cpp.

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

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

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

References KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::flushPath(), KIGFX::CAIRO_GAL_BASE::isElementAdded, KIGFX::CAIRO_GAL_BASE::lineWidthInPixels, 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 915 of file cairo_gal.cpp.

916 {
917  cursorPosition = aCursorPosition;
918 }
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,
double  aFilterValue = 0.0 
)
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.
aFilterValueis used by Bezier to segments approximation, if the Bezier curve is not supported and needs a curve to polyline conversion. aFilterValue = 0 means no filtering.

Reimplemented from KIGFX::GAL.

Definition at line 427 of file cairo_gal.cpp.

430 {
431  // Note: aFilterValue is not used because the cubic Bezier curve is
432  // supported by Cairo.
433  syncLineWidth();
434 
435  const auto sp = roundp( xform( aStartPoint ) );
436  const auto cpa = roundp( xform( aControlPointA ) );
437  const auto cpb = roundp( xform( aControlPointB ) );
438  const auto ep = roundp( xform( aEndPoint ) );
439 
440  cairo_move_to( currentContext, sp.x, sp.y );
441  cairo_curve_to( currentContext, cpa.x, cpa.y, cpb.x, cpb.y, ep.x, ep.y );
442  cairo_line_to( currentContext, ep.x, ep.y );
443 
444  flushPath();
445  isElementAdded = true;
446 }
const double xform(double x)
Definition: cairo_gal.cpp:165
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:179
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:303
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:202
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:289

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

1501 {
1503 
1504  // Draw the grid
1505  // For the drawing the start points, end points and increments have
1506  // to be calculated in world coordinates
1507  VECTOR2D worldStartPoint = screenWorldMatrix * VECTOR2D( 0.0, 0.0 );
1508  VECTOR2D worldEndPoint = screenWorldMatrix * VECTOR2D( screenSize );
1509 
1510  // Compute the line marker or point radius of the grid
1511  // Note: generic grids can't handle sub-pixel lines without
1512  // either losing fine/course distinction or having some dots
1513  // fail to render
1514  float marker = std::fmax( 1.0f, gridLineWidth ) / worldScale;
1515  float doubleMarker = 2.0f * marker;
1516 
1517  // Draw axes if desired
1518  if( axesEnabled )
1519  {
1520  SetLineWidth( marker );
1521  drawAxes( worldStartPoint, worldEndPoint );
1522  }
1523 
1524  if( !gridVisibility || gridSize.x == 0 || gridSize.y == 0 )
1525  return;
1526 
1527  VECTOR2D gridScreenSize( gridSize );
1528 
1529  double gridThreshold = KiROUND( computeMinGridSpacing() / worldScale );
1530 
1532  gridThreshold *= 2.0;
1533 
1534  // If we cannot display the grid density, scale down by a tick size and
1535  // try again. Eventually, we get some representation of the grid
1536  while( std::min( gridScreenSize.x, gridScreenSize.y ) <= gridThreshold )
1537  {
1538  gridScreenSize = gridScreenSize * static_cast<double>( gridTick );
1539  }
1540 
1541  // Compute grid starting and ending indexes to draw grid points on the
1542  // visible screen area
1543  // Note: later any point coordinate will be offsetted by gridOrigin
1544  int gridStartX = KiROUND( ( worldStartPoint.x - gridOrigin.x ) / gridScreenSize.x );
1545  int gridEndX = KiROUND( ( worldEndPoint.x - gridOrigin.x ) / gridScreenSize.x );
1546  int gridStartY = KiROUND( ( worldStartPoint.y - gridOrigin.y ) / gridScreenSize.y );
1547  int gridEndY = KiROUND( ( worldEndPoint.y - gridOrigin.y ) / gridScreenSize.y );
1548 
1549  // Ensure start coordinate > end coordinate
1550 
1551  SWAP( gridStartX, >, gridEndX );
1552  SWAP( gridStartY, >, gridEndY );
1553 
1554  // Ensure the grid fills the screen
1555  --gridStartX; ++gridEndX;
1556  --gridStartY; ++gridEndY;
1557 
1558  // Draw the grid behind all other layers
1559  SetLayerDepth( depthRange.y * 0.75 );
1560 
1561  if( gridStyle == GRID_STYLE::LINES )
1562  {
1563  // Now draw the grid, every coarse grid line gets the double width
1564 
1565  // Vertical lines
1566  for( int j = gridStartY; j <= gridEndY; j++ )
1567  {
1568  const double y = j * gridScreenSize.y + gridOrigin.y;
1569 
1570  if( axesEnabled && y == 0.0 )
1571  continue;
1572 
1573  SetLineWidth( ( j % gridTick ) ? marker : doubleMarker );
1574  drawGridLine( VECTOR2D( gridStartX * gridScreenSize.x + gridOrigin.x, y ),
1575  VECTOR2D( gridEndX * gridScreenSize.x + gridOrigin.x, y ) );
1576  }
1577 
1578  // Horizontal lines
1579  for( int i = gridStartX; i <= gridEndX; i++ )
1580  {
1581  const double x = i * gridScreenSize.x + gridOrigin.x;
1582 
1583  if( axesEnabled && x == 0.0 )
1584  continue;
1585 
1586  SetLineWidth( ( i % gridTick ) ? marker : doubleMarker );
1587  drawGridLine( VECTOR2D( x, gridStartY * gridScreenSize.y + gridOrigin.y ),
1588  VECTOR2D( x, gridEndY * gridScreenSize.y + gridOrigin.y ) );
1589 
1590  }
1591  }
1592  else // Dots or Crosses grid
1593  {
1594  for( int j = gridStartY; j <= gridEndY; j++ )
1595  {
1596  bool tickY = ( j % gridTick == 0 );
1597 
1598  for( int i = gridStartX; i <= gridEndX; i++ )
1599  {
1600  bool tickX = ( i % gridTick == 0 );
1601  SetLineWidth( ( ( tickX && tickY ) ? doubleMarker : marker ) );
1602  auto pos = VECTOR2D( i * gridScreenSize.x + gridOrigin.x,
1603  j * gridScreenSize.y + gridOrigin.y );
1604 
1606  drawGridCross( pos );
1607  else if( gridStyle == GRID_STYLE::DOTS )
1608  drawGridPoint( pos, GetLineWidth() );
1609  }
1610  }
1611  }
1612 }
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.
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:953
virtual void SetLayerDepth(double aLayerDepth) override
Set the depth of the layer (position on the z-axis)
Definition: cairo_gal.cpp:620
Auxiliary rendering target (noncached)
Definition: definitions.h:49
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
float gridLineWidth
Line width of the grid.
VECTOR2D gridOrigin
The grid origin.
void drawGridPoint(const VECTOR2D &aPoint, double aSize)
Definition: cairo_gal.cpp:1003
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.
VECTOR2I screenSize
Screen size in screen coordinates.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:61
#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:970
virtual void SetLineWidth(float aLineWidth) override
Set the line width.
Definition: cairo_gal.cpp:601
virtual void SetTarget(RENDER_TARGET aTarget)
Sets the target for rendering.
void drawGridCross(const VECTOR2D &aPoint)
Definition: cairo_gal.cpp:983

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, KiROUND(), KIGFX::LINES, 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 983 of file cairo_gal.cpp.

984 {
985  syncLineWidth();
986  VECTOR2D offset( 0, 0 );
987  auto size = 2.0 * lineWidthInPixels;
988 
989  auto p0 = roundp( xform( aPoint ) ) - VECTOR2D( size, 0 ) + offset;
990  auto p1 = roundp( xform( aPoint ) ) + VECTOR2D( size, 0 ) + offset;
991  auto p2 = roundp( xform( aPoint ) ) - VECTOR2D( 0, size ) + offset;
992  auto p3 = roundp( xform( aPoint ) ) + VECTOR2D( 0, size ) + offset;
993 
994  cairo_set_source_rgba( currentContext, gridColor.r, gridColor.g, gridColor.b, gridColor.a );
995  cairo_move_to( currentContext, p0.x, p0.y );
996  cairo_line_to( currentContext, p1.x, p1.y );
997  cairo_move_to( currentContext, p2.x, p2.y );
998  cairo_line_to( currentContext, p3.x, p3.y );
999  cairo_stroke( currentContext );
1000 }
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:593
const double xform(double x)
Definition: cairo_gal.cpp:165
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:179
COLOR4D gridColor
Color of the grid.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:303
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:202
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 970 of file cairo_gal.cpp.

971 {
972  syncLineWidth();
973  auto p0 = roundp( xform( aStartPoint ) );
974  auto p1 = roundp( xform( aEndPoint ) );
975 
976  cairo_set_source_rgba( currentContext, gridColor.r, gridColor.g, gridColor.b, gridColor.a );
977  cairo_move_to( currentContext, p0.x, p0.y );
978  cairo_line_to( currentContext, p1.x, p1.y );
979  cairo_stroke( currentContext );
980 }
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:165
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:179
COLOR4D gridColor
Color of the grid.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:303
void syncLineWidth(bool aForceWidth=false, double aWidth=0.0)
Definition: cairo_gal.cpp:202
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 1003 of file cairo_gal.cpp.

1004 {
1005  auto p = roundp( xform( aPoint ) );
1006  auto s = xform( aSize / 2.0 );
1007 
1008  cairo_set_source_rgba( currentContext, gridColor.r, gridColor.g, gridColor.b, gridColor.a );
1009  cairo_move_to( currentContext, p.x, p.y );
1010  cairo_arc( currentContext, p.x, p.y, s, 0.0, 2.0 * M_PI );
1011  cairo_close_path( currentContext );
1012 
1013  cairo_fill( currentContext );
1014 }
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:165
const VECTOR2D roundp(const VECTOR2D &v)
Definition: cairo_gal.cpp:179
COLOR4D gridColor
Color of the grid.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:303
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 767 of file cairo_gal.cpp.

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

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

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

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

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

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

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.

◆ drawPoly() [3/3]

void CAIRO_GAL_BASE::drawPoly ( const SHAPE_LINE_CHAIN aLineChain)
protectedinherited

Definition at line 1149 of file cairo_gal.cpp.

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

References SHAPE_LINE_CHAIN::CPoint(), KIGFX::CAIRO_GAL_BASE::currentContext, KIGFX::CAIRO_GAL_BASE::flushPath(), 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 97 of file cairo_gal.h.

97 { 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:1104

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 98 of file cairo_gal.h.

98 { 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:1104

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

415 {
416  for( int i = 0; i < aPolySet.OutlineCount(); ++i )
417  drawPoly( aPolySet.COutline( i ) );
418 }
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:1104
const SHAPE_LINE_CHAIN & COutline(int aIndex) const

References SHAPE_POLY_SET::COutline(), KIGFX::CAIRO_GAL_BASE::drawPoly(), 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 421 of file cairo_gal.cpp.

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

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 92 of file cairo_gal.h.

92 { 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:1104

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 93 of file cairo_gal.h.

93 { 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:1104

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 94 of file cairo_gal.h.

94 { 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:1104

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

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

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

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

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

922 {
923 }

◆ endDrawing()

void CAIRO_GAL::endDrawing ( )
overrideprotectedvirtual

Reimplemented from KIGFX::CAIRO_GAL_BASE.

Definition at line 1254 of file cairo_gal.cpp.

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

References bitmapBuffer, KIGFX::CAIRO_GAL_BASE::blitCursor(), compositor, deinitSurface(), KIGFX::CAIRO_GAL_BASE::endDrawing(), mainBuffer, NULL, 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 1325 of file cairo_gal.cpp.

1326 {
1328  deinitSurface();
1329 }
virtual void EndGroup() override
End the group.
Definition: cairo_gal.cpp:760
void deinitSurface()
Destroy Cairo surfaces when are not needed anymore.
Definition: cairo_gal.cpp:1412

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

1109 {}

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

522 {
523  storePath();
524 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1038

References KIGFX::CAIRO_GAL_BASE::storePath().

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

◆ flushPath()

void CAIRO_GAL_BASE::flushPath ( )
protectedinherited

Definition at line 1016 of file cairo_gal.cpp.

1017 {
1018  if( isFillEnabled )
1019  {
1020  cairo_set_source_rgba( currentContext,
1022 
1023  if( isStrokeEnabled )
1024  cairo_fill_preserve( currentContext );
1025  else
1026  cairo_fill( currentContext );
1027  }
1028 
1029  if( isStrokeEnabled )
1030  {
1031  cairo_set_source_rgba( currentContext,
1033  cairo_stroke( currentContext );
1034  }
1035 }
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:303
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 219 of file graphics_abstraction_layer.h.

220  {
221  return m_clearColor;
222  }

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

241 {
242  auto color = cursorColor;
243 
244  // dim the cursor if it's only on because it was forced
245  // (this helps to provide a hint for active tools)
246  if( !isCursorEnabled )
247  {
248  color.a = color.a * 0.5;
249  }
250 
251  return color;
252 }
bool isCursorEnabled
Is the cursor enabled?
int color
Definition: DXF_plotter.cpp:61
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 269 of file graphics_abstraction_layer.h.

270  {
271  return fillColor;
272  }
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 939 of file graphics_abstraction_layer.h.

940  {
941  return gridLineWidth;
942  }
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 218 of file graphics_abstraction_layer.cpp.

219 {
220 #if 0
221  // This old code expects a non zero grid size, which can be wrong here.
222  return VECTOR2D( KiROUND( ( aPoint.x - gridOffset.x ) / gridSize.x ) * gridSize.x + gridOffset.x,
223  KiROUND( ( aPoint.y - gridOffset.y ) / gridSize.y ) * gridSize.y + gridOffset.y );
224 #else
225  // if grid size == 0.0 there is no grid, so use aPoint as grid reference position
226  double cx = gridSize.x > 0.0 ? KiROUND( ( aPoint.x - gridOffset.x ) / gridSize.x ) * gridSize.x + gridOffset.x
227  : aPoint.x;
228  double cy = gridSize.y > 0.0 ? KiROUND( ( aPoint.y - gridOffset.y ) / gridSize.y ) * gridSize.y + gridOffset.y
229  : aPoint.y;
230 
231  return VECTOR2D( cx, cy );
232 #endif
233 }
VECTOR2D gridOffset
The grid offset to compensate cursor position.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
VECTOR2D gridSize
The grid size.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:61

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

892  {
893  return gridSize;
894  }
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 493 of file graphics_abstraction_layer.h.

494  {
496  }
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 693 of file graphics_abstraction_layer.h.

694  {
695  return lookAtPoint;
696  }
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 762 of file graphics_abstraction_layer.h.

763  {
764  return depthRange.y;
765  }
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 754 of file graphics_abstraction_layer.h.

755  {
756  return depthRange.x;
757  }
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 1177 of file cairo_gal.cpp.

1178 {
1179  wxASSERT_MSG( groups.size() < std::numeric_limits<unsigned int>::max(),
1180  wxT( "There are no free slots to store a group" ) );
1181 
1182  while( groups.find( groupCounter ) != groups.end() )
1183  groupCounter++;
1184 
1185  return groupCounter++;
1186 }
unsigned int groupCounter
Counter used for generating keys for groups.
Definition: cairo_gal.h:292
std::map< int, GROUP > groups
List of graphic groups.
Definition: cairo_gal.h:291

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

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

389  {
391  }
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 733 of file graphics_abstraction_layer.h.

734  {
735  return rotation;
736  }
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 629 of file graphics_abstraction_layer.h.

630  {
631  return screenWorldMatrix;
632  }
MATRIX3x3D screenWorldMatrix
Screen transformation.

References KIGFX::GAL::screenWorldMatrix.

Referenced by KIGFX::SCH_PAINTER::getShadowWidth(), KIGFX::OPENGL_GAL::getWorldPixelSize(), screenSpaceCircle(), screenSpaceLine(), 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 289 of file graphics_abstraction_layer.h.

290  {
291  return strokeColor;
292  }
COLOR4D strokeColor
The color of the outlines.

References KIGFX::GAL::strokeColor.

◆ GetStrokeFont()

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

Definition at line 331 of file graphics_abstraction_layer.h.

332  {
333  return strokeFont;
334  }
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 1360 of file cairo_gal.cpp.

1361 {
1362  return currentTarget;
1363 }
RENDER_TARGET currentTarget
Current rendering target.
Definition: cairo_gal.h:412

References currentTarget.

◆ GetTextLineSize()

VECTOR2D GAL::GetTextLineSize ( const UTF8 aText,
int  aMarkupFlags = 0 
) 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).
aMarkupFlagsa bitset of TEXT_MARKUP_FLAGS.
Returns
is the text size.

Definition at line 172 of file graphics_abstraction_layer.cpp.

173 {
174  // Compute the X and Y size of a given text.
175  // Because computeTextLineSize expects a one line text,
176  // aText is expected to be only one line text.
177  return strokeFont.computeTextLineSize( aText, aMarkupFlags );
178 }
STROKE_FONT strokeFont
Instance of object that stores information about how to draw texts.
VECTOR2D computeTextLineSize(const UTF8 &aText, int aMarkupFlags) 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 511 of file graphics_abstraction_layer.h.

512  {
514  }
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 772 of file graphics_abstraction_layer.h.

773  {
774  return worldScale;
775  }
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 619 of file graphics_abstraction_layer.h.

620  {
621  return worldScreenMatrix;
622  }
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 713 of file graphics_abstraction_layer.h.

714  {
715  return zoomFactor;
716  }
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 1392 of file cairo_gal.cpp.

1393 {
1394  if( isInitialized )
1395  return;
1396 
1397  surface = cairo_image_surface_create_for_data( bitmapBuffer, GAL_FORMAT,
1399 
1400  context = cairo_create( surface );
1401 
1402 #ifdef DEBUG
1403  cairo_status_t status = cairo_status( context );
1404  wxASSERT_MSG( status == CAIRO_STATUS_SUCCESS, wxT( "Cairo context creation error" ) );
1405 #endif /* DEBUG */
1407 
1408  isInitialized = true;
1409 }
cairo_surface_t * surface
Cairo surface.
Definition: cairo_gal.h:305
bool isInitialized
Are Cairo image & surface ready to use.
Definition: cairo_gal.h:426
cairo_t * context
Cairo image.
Definition: cairo_gal.h:304
int stride
Stride value for Cairo.
Definition: cairo_gal.h:424
VECTOR2I screenSize
Screen size in screen coordinates.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:303
unsigned char * bitmapBuffer
Storage of the cairo image.
Definition: cairo_gal.h:423
static constexpr cairo_format_t GAL_FORMAT
Format used to store pixels.
Definition: cairo_gal.h:335

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 65 of file cairo_gal.h.

65 { return true; }

◆ IsCursorEnabled()

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

Returns information about cursor visibility.

Returns
True if cursor is visible.

Definition at line 992 of file graphics_abstraction_layer.h.

993  {
995  }
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 792 of file graphics_abstraction_layer.h.

793  {
794  return globalFlipX;
795  }
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 800 of file graphics_abstraction_layer.h.

801  {
802  return globalFlipY;
803  }
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 439 of file graphics_abstraction_layer.h.

440  {
441  return textProperties.m_bold;
442  }
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 457 of file graphics_abstraction_layer.h.

458  {
459  return textProperties.m_italic;
460  }
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 475 of file graphics_abstraction_layer.h.

476  {
477  return textProperties.m_mirrored;
478  }
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 364 of file cairo_gal.h.

365  {
366  return IsShownOnScreen() && !GetClientRect().IsEmpty();
367  }

◆ lockContext()

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

Private: use GAL_CONTEXT_LOCKER RAII object.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1100 of file graphics_abstraction_layer.h.

1100 {}

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

93 {
94  // defer to the child class first
95  updatedGalDisplayOptions( aOptions );
96 
97  // there is no refresh to do at this level
98 }
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 1462 of file cairo_gal.cpp.

1463 {
1464  PostPaint();
1465 }
void PostPaint()
Function PostPaint posts an event to m_paint_listener.
Definition: cairo_gal.h:388

References PostPaint().

Referenced by CAIRO_GAL().

◆ PopDepth()

void KIGFX::GAL::PopDepth ( )
inlineinherited

Restores previously stored drawing depth for the depth stack.

Definition at line 1034 of file graphics_abstraction_layer.h.

1035  {
1036  layerDepth = depthStack.top();
1037  depthStack.pop();
1038  }
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 388 of file cairo_gal.h.

389  {
390  if( paintListener )
391  {
392  wxPaintEvent redrawEvent;
393  wxPostEvent( paintListener, redrawEvent );
394  }
395  }
wxEvtHandler * paintListener
Paint listener.
Definition: cairo_gal.h:418

References paintListener.

Referenced by onPaint().

◆ PushDepth()

void KIGFX::GAL::PushDepth ( )
inlineinherited

Stores current drawing depth on the depth stack.

Definition at line 1026 of file graphics_abstraction_layer.h.

1027  {
1028  depthStack.push( layerDepth );
1029  }
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 926 of file cairo_gal.cpp.

927 {
928  ClearScreen();
929 
930  // Compute the world <-> screen transformations
932 
933  cairo_matrix_init( &cairoWorldScreenMatrix, worldScreenMatrix.m_data[0][0],
936  worldScreenMatrix.m_data[1][2] );
937 
938  // we work in screen-space coordinates and do the transforms outside.
939  cairo_identity_matrix( context );
940 
941  cairo_matrix_init_identity( &currentXform );
942 
943  // Start drawing with a new path
944  cairo_new_path( context );
945  isElementAdded = true;
946 
948 
949  lineWidth = 0;
950 }
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:527
cairo_t * context
Cairo image.
Definition: cairo_gal.h:304
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:97
MATRIX3x3D worldScreenMatrix
World transformation.
cairo_matrix_t currentXform
Definition: cairo_gal.h:301
cairo_matrix_t cairoWorldScreenMatrix
Cairo world to screen transformation matrix.
Definition: cairo_gal.h:300
bool isElementAdded
Was an graphic element added ?
Definition: cairo_gal.h:289

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

158 {
159  // Tiny but non-zero - this will always need setting
160  // there is no built-in default
161  SetGlyphSize( { 1.0, 1.0 } );
162 
165 
166  SetFontBold( false );
167  SetFontItalic( false );
168  SetTextMirrored( false );
169 }
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 1290 of file cairo_gal.cpp.

1291 {
1292  CAIRO_GAL_BASE::ResizeScreen( aWidth, aHeight );
1293 
1294  // Recreate the bitmaps
1295  deleteBitmaps();
1296  allocateBitmaps();
1297 
1298  if( validCompositor )
1299  compositor->Resize( aWidth, aHeight );
1300 
1301  validCompositor = false;
1302 
1303  SetSize( wxSize( aWidth, aHeight ) );
1304 }
virtual void ResizeScreen(int aWidth, int aHeight) override
Resizes the canvas.
Definition: cairo_gal.cpp:515
bool validCompositor
Compositor initialization flag.
Definition: cairo_gal.h:413
std::shared_ptr< CAIRO_COMPOSITOR > compositor
Object for layers compositing.
Definition: cairo_gal.h:409
void deleteBitmaps()
Allocate the bitmaps for drawing.
Definition: cairo_gal.cpp:1440
void allocateBitmaps()
Allocate the bitmaps for drawing.
Definition: cairo_gal.cpp:1426

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

723 {
724  storePath();
725 
726  if( isGrouping )
727  {
728  GROUP_ELEMENT groupElement;
729  groupElement.command = CMD_RESTORE;
730  currentGroup->push_back( groupElement );
731  }
732  else
733  {
734  if( !xformStack.empty() )
735  {
736  currentXform = xformStack.back();
737  xformStack.pop_back();
739  }
740  }
741 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1038
std::vector< cairo_matrix_t > xformStack
Definition: cairo_gal.h:307
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:293
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:288
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:97
cairo_matrix_t currentXform
Definition: cairo_gal.h:301
Restore the transformation matrix.
Definition: cairo_gal.h:271

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.

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

646 {
647  storePath();
648 
649  if( isGrouping )
650  {
651  GROUP_ELEMENT groupElement;
652  groupElement.command = CMD_ROTATE;
653  groupElement.argument.dblArg[0] = aAngle;
654  currentGroup->push_back( groupElement );
655  }
656  else
657  {
658  cairo_matrix_rotate( &currentXform, aAngle );
660  }
661 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1038
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:293
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:288
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:97
cairo_matrix_t currentXform
Definition: cairo_gal.h:301

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

705 {
706  storePath();
707 
708  if( isGrouping )
709  {
710  GROUP_ELEMENT groupElement;
711  groupElement.command = CMD_SAVE;
712  currentGroup->push_back( groupElement );
713  }
714  else
715  {
716  xformStack.push_back( currentXform );
718  }
719 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1038
std::vector< cairo_matrix_t > xformStack
Definition: cairo_gal.h:307
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:293
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:288
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:97
Save the transformation matrix.
Definition: cairo_gal.h:270
cairo_matrix_t currentXform
Definition: cairo_gal.h:301

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.

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

685 {
686  storePath();
687 
688  if( isGrouping )
689  {
690  GROUP_ELEMENT groupElement;
691  groupElement.command = CMD_SCALE;
692  groupElement.argument.dblArg[0] = aScale.x;
693  groupElement.argument.dblArg[1] = aScale.y;
694  currentGroup->push_back( groupElement );
695  }
696  else
697  {
698  cairo_matrix_scale( &currentXform, aScale.x, aScale.y );
700  }
701 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1038
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:293
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:288
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:97
cairo_matrix_t currentXform
Definition: cairo_gal.h:301

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

912  {
913  axesColor = aAxesColor;
914  }
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 929 of file graphics_abstraction_layer.h.

930  {
931  gridTick = aInterval;
932  }
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 1447 of file cairo_gal.cpp.

1448 {
1449  // Recreate the compositor with the new Cairo context
1450  compositor.reset( new CAIRO_COMPOSITOR( &currentContext ) );
1451  compositor->Resize( screenSize.x, screenSize.y );
1452  compositor->SetAntialiasingMode( options.cairo_antialiasing_mode );
1453 
1454  // Prepare buffers
1455  mainBuffer = compositor->CreateBuffer();
1456  overlayBuffer = compositor->CreateBuffer();
1457 
1458  validCompositor = true;
1459 }
GAL_DISPLAY_OPTIONS & options
unsigned int overlayBuffer
Handle to the overlay buffer.
Definition: cairo_gal.h:411
bool validCompositor
Compositor initialization flag.
Definition: cairo_gal.h:413
CAIRO_ANTIALIASING_MODE cairo_antialiasing_mode
std::shared_ptr< CAIRO_COMPOSITOR > compositor
Object for layers compositing.
Definition: cairo_gal.h:409
VECTOR2I screenSize
Screen size in screen coordinates.
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:303
unsigned int mainBuffer
Handle to the main buffer.
Definition: cairo_gal.h:410

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

1003  {
1004  cursorColor = aCursorColor;
1005  }
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 983 of file graphics_abstraction_layer.h.

984  {
985  isCursorEnabled = aCursorEnabled;
986  }
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 746 of file graphics_abstraction_layer.h.

747  {
748  depthRange = aDepthRange;
749  }
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 583 of file cairo_gal.cpp.

584 {
585  storePath();
586  fillColor = aColor;
587 
588  if( isGrouping )
589  {
590  GROUP_ELEMENT groupElement;
591  groupElement.command = CMD_SET_FILLCOLOR;
592  groupElement.argument.dblArg[0] = fillColor.r;
593  groupElement.argument.dblArg[1] = fillColor.g;
594  groupElement.argument.dblArg[2] = fillColor.b;
595  groupElement.argument.dblArg[3] = fillColor.a;
596  currentGroup->push_back( groupElement );
597  }
598 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1038
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:293
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:288
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 783 of file graphics_abstraction_layer.h.

784  {
785  globalFlipX = xAxis;
786  globalFlipY = yAxis;
787  }
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 431 of file graphics_abstraction_layer.h.

432  {
433  textProperties.m_bold = aBold;
434  }
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 449 of file graphics_abstraction_layer.h.

450  {
451  textProperties.m_italic = aItalic;
452  }
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 901 of file graphics_abstraction_layer.h.

902  {
903  gridColor = aGridColor;
904  }
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 862 of file graphics_abstraction_layer.h.

863  {
864  gridOrigin = aGridOrigin;
865 
866  if( gridSize.x == 0.0 || gridSize.y == 0.0 )
867  gridOffset = VECTOR2D(0.0, 0.0);
868  else
869  gridOffset = VECTOR2D( (long) gridOrigin.x % (long) gridSize.x,
870  (long) gridOrigin.y % (long) gridSize.y );
871  }
VECTOR2D gridOffset
The grid offset to compensate cursor position.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
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 878 of file graphics_abstraction_layer.h.

879  {
880  gridSize = aGridSize;
881 
882  gridOffset = VECTOR2D( (long) gridOrigin.x % (long) gridSize.x,
883  (long) gridOrigin.y % (long) gridSize.y );
884  }
VECTOR2D gridOffset
The grid offset to compensate cursor position.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
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 PCB_BASE_FRAME::ActivateGalCanvas(), 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(), DIALOG_SET_GRID::TransferDataFromWindow(), and PCBNEW_CONTROL::updateGrid().

◆ SetGridVisibility()

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

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

486  {
487  textProperties.m_horizontalJustify = aHorizontalJustify;
488  }
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 535 of file cairo_gal.cpp.

536 {
537  storePath();
538  isFillEnabled = aIsFillEnabled;
539 
540  if( isGrouping )
541  {
542  GROUP_ELEMENT groupElement;
543  groupElement.command = CMD_SET_FILL;
544  groupElement.argument.boolArg = aIsFillEnabled;
545  currentGroup->push_back( groupElement );
546  }
547 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1038
Enable/disable filling.
Definition: cairo_gal.h:259
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:293
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:288
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 550 of file cairo_gal.cpp.

551 {
552  storePath();
553  isStrokeEnabled = aIsStrokeEnabled;
554 
555  if( isGrouping )
556  {
557  GROUP_ELEMENT groupElement;
558  groupElement.command = CMD_SET_STROKE;
559  groupElement.argument.boolArg = aIsStrokeEnabled;
560  currentGroup->push_back( groupElement );
561  }
562 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1038
bool isStrokeEnabled
Are the outlines stroked ?
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:293
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:288
Enable/disable stroking.
Definition: cairo_gal.h:260

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

621 {
622  super::SetLayerDepth( aLayerDepth );
623  storePath();
624 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1038
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 601 of file cairo_gal.cpp.

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

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

684  {
685  lookAtPoint = aPoint;
686  }
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 397 of file cairo_gal.h.

398  {
399  mouseListener = aMouseListener;
400  }
wxEvtHandler * mouseListener
Mouse listener.
Definition: cairo_gal.h:417

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

910 {
911  cairo_set_operator( currentContext, aSetting ? CAIRO_OPERATOR_CLEAR : CAIRO_OPERATOR_OVER );
912 }
cairo_t * currentContext
Currently used Cairo context for drawing.
Definition: cairo_gal.h:303

References KIGFX::CAIRO_GAL_BASE::currentContext.

◆ SetPaintListener()

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

Definition at line 402 of file cairo_gal.h.

403  {
404  paintListener = aPaintListener;
405  }
wxEvtHandler * paintListener
Paint listener.
Definition: cairo_gal.h:418

References paintListener.

◆ SetRotation()

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

Set the rotation angle.

Parameters
aRotationis the new rotation angle (radians).

Definition at line 723 of file graphics_abstraction_layer.h.

724  {
725  rotation = aRotation;
726  }
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 671 of file graphics_abstraction_layer.h.

672  {
673  screenDPI = aScreenDPI;
674  }
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 658 of file graphics_abstraction_layer.h.

659  {
660  screenSize = aSize;
661  }
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 565 of file cairo_gal.cpp.

566 {
567  storePath();
568  strokeColor = aColor;
569 
570  if( isGrouping )
571  {
572  GROUP_ELEMENT groupElement;
573  groupElement.command = CMD_SET_STROKECOLOR;
574  groupElement.argument.dblArg[0] = strokeColor.r;
575  groupElement.argument.dblArg[1] = strokeColor.g;
576  groupElement.argument.dblArg[2] = strokeColor.b;
577  groupElement.argument.dblArg[3] = strokeColor.a;
578  currentGroup->push_back( groupElement );
579  }
580 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1038
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:293
COLOR4D strokeColor
The color of the outlines.
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:288
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 1332 of file cairo_gal.cpp.

1333 {
1334  // If the compositor is not set, that means that there is a recaching process going on
1335  // and we do not need the compositor now
1336  if( !validCompositor )
1337  return;
1338 
1339  // Cairo grouping prevents display of overlapping items on the same layer in the lighter color
1340  if( isInitialized )
1341  storePath();
1342 
1343  switch( aTarget )
1344  {
1345  default:
1346  case TARGET_CACHED:
1347  case TARGET_NONCACHED:
1348  compositor->SetBuffer( mainBuffer );
1349  break;
1350 
1351  case TARGET_OVERLAY:
1352  compositor->SetBuffer( overlayBuffer );
1353  break;
1354  }
1355 
1356  currentTarget = aTarget;
1357 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1038
bool isInitialized
Are Cairo image & surface ready to use.
Definition: cairo_gal.h:426
unsigned int overlayBuffer
Handle to the overlay buffer.
Definition: cairo_gal.h:411
bool validCompositor
Compositor initialization flag.
Definition: cairo_gal.h:413
Auxiliary rendering target (noncached)
Definition: definitions.h:49
RENDER_TARGET currentTarget
Current rendering target.
Definition: cairo_gal.h:412
std::shared_ptr< CAIRO_COMPOSITOR > compositor
Object for layers compositing.
Definition: cairo_gal.h:409
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:410

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

147 {
148  SetGlyphSize( VECTOR2D( aText->GetTextSize() ) );
151  SetFontBold( aText->IsBold() );
152  SetFontItalic( aText->IsItalic() );
153  SetTextMirrored( aText->IsMirrored() );
154 }
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:184
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:183
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
const wxSize & GetTextSize() const
Definition: eda_text.h:223
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 467 of file graphics_abstraction_layer.h.

468  {
469  textProperties.m_mirrored = aMirrored;
470  }
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 503 of file graphics_abstraction_layer.h.

504  {
505  textProperties.m_verticalJustify = aVerticalJustify;
506  }
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 639 of file graphics_abstraction_layer.h.

640  {
641  worldScreenMatrix = aMatrix;
642  }
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 653 of file graphics_abstraction_layer.h.

654  {
655  worldUnitLength = aWorldUnitLength;
656  }
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(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), GERBVIEW_PRINTOUT::setupGal(), PCBNEW_PRINTOUT::setupGal(), 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 703 of file graphics_abstraction_layer.h.

704  {
705  zoomFactor = aZoomFactor;
706  }
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 1307 of file cairo_gal.cpp.

1308 {
1309  bool s = wxWindow::Show( aShow );
1310 
1311  if( aShow )
1312  wxWindow::Raise();
1313 
1314  return s;
1315 }

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

1469 {
1470  // Post the mouse event to the event listener registered in constructor, if any
1471  if( mouseListener )
1472  wxPostEvent( mouseListener, aEvent );
1473 }
wxEvtHandler * mouseListener
Mouse listener.
Definition: cairo_gal.h:417

References mouseListener.

Referenced by CAIRO_GAL().

◆ storePath()

void CAIRO_GAL_BASE::storePath ( )
protectedinherited

Store the actual path.

Definition at line 1038 of file cairo_gal.cpp.

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

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,
int  aMarkupFlags = 0 
)
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.
aMarkupFlagsa bitset of TEXT_MARKUP_FLAGS.

Definition at line 344 of file graphics_abstraction_layer.h.

346  {
347  strokeFont.Draw( aText, aPosition, aRotationAngle, aMarkupFlags );
348  }
STROKE_FONT strokeFont
Instance of object that stores information about how to draw texts.
void Draw(const UTF8 &aText, const VECTOR2D &aPosition, double aRotationAngle, int markupFlags)
Draw a string.

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

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

◆ syncLineWidth()

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

Definition at line 202 of file cairo_gal.cpp.

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

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

974  {
975  return VECTOR2D( worldScreenMatrix * aPoint );
976  }
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
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 962 of file graphics_abstraction_layer.h.

963  {
964  return VECTOR2D( screenWorldMatrix * aPoint );
965  }
MATRIX3x3D screenWorldMatrix
Screen transformation.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593

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

628 {
629  cairo_matrix_t cairoTransformation, newXform;
630 
631  cairo_matrix_init( &cairoTransformation,
632  aTransformation.m_data[0][0],
633  aTransformation.m_data[1][0],
634  aTransformation.m_data[0][1],
635  aTransformation.m_data[1][1],
636  aTransformation.m_data[0][2],
637  aTransformation.m_data[1][2] );
638 
639  cairo_matrix_multiply( &newXform, &currentXform, &cairoTransformation );
640  currentXform = newXform;
642 }
T m_data[3][3]
Definition: matrix3x3.h:64
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:97
cairo_matrix_t currentXform
Definition: cairo_gal.h:301

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

665 {
666  storePath();
667 
668  if( isGrouping )
669  {
670  GROUP_ELEMENT groupElement;
671  groupElement.command = CMD_TRANSLATE;
672  groupElement.argument.dblArg[0] = aTranslation.x;
673  groupElement.argument.dblArg[1] = aTranslation.y;
674  currentGroup->push_back( groupElement );
675  }
676  else
677  {
678  cairo_matrix_translate ( &currentXform, aTranslation.x, aTranslation.y );
680  }
681 }
void storePath()
Store the actual path.
Definition: cairo_gal.cpp:1038
GROUP * currentGroup
Currently used group.
Definition: cairo_gal.h:293
bool isGrouping
Is grouping enabled ?
Definition: cairo_gal.h:288
void updateWorldScreenMatrix()
Definition: cairo_gal.cpp:97
cairo_matrix_t currentXform
Definition: cairo_gal.h:301
Translate the context.
Definition: cairo_gal.h:268

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

1102 {}

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

1477 {
1478  bool refresh = false;
1479 
1480  if( validCompositor && aOptions.cairo_antialiasing_mode != compositor->GetAntialiasingMode() )
1481  {
1482 
1483  compositor->SetAntialiasingMode( options.cairo_antialiasing_mode );
1484  validCompositor = false;
1485  deinitSurface();
1486 
1487  refresh = true;
1488  }
1489 
1490  if( super::updatedGalDisplayOptions( aOptions ) )
1491  {
1492  Refresh();
1493  refresh = true;
1494  }
1495 
1496  return refresh;
1497 }
void deinitSurface()
Destroy Cairo surfaces when are not needed anymore.
Definition: cairo_gal.cpp:1412
GAL_DISPLAY_OPTIONS & options
bool validCompositor
Compositor initialization flag.
Definition: cairo_gal.h:413
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:409
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()

◆ xform() [1/3]

◆ xform() [2/3]

const VECTOR2D CAIRO_GAL_BASE::xform ( double  x,
double  y 
)
protectedinherited

Definition at line 103 of file cairo_gal.cpp.

104 {
105  VECTOR2D rv;
106 
109  return rv;
110 }
cairo_matrix_t currentWorld2Screen
Definition: cairo_gal.h:302

References KIGFX::CAIRO_GAL_BASE::currentWorld2Screen, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ xform() [3/3]

const VECTOR2D CAIRO_GAL_BASE::xform ( const VECTOR2D aP)
protectedinherited

Definition at line 113 of file cairo_gal.cpp.

114 {
115  return xform( aP.x, aP.y );
116 }
const double xform(double x)
Definition: cairo_gal.cpp:165

References VECTOR2< T >::x, KIGFX::CAIRO_GAL_BASE::xform(), and VECTOR2< T >::y.

Member Data Documentation

◆ axesColor

COLOR4D KIGFX::GAL::axesColor
protectedinherited

◆ axesEnabled

bool KIGFX::GAL::axesEnabled
protectedinherited

◆ backgroundColor

COLOR4D KIGFX::CAIRO_GAL::backgroundColor
protected

Background color.

Definition at line 427 of file cairo_gal.h.

◆ bitmapBuffer

unsigned char* KIGFX::CAIRO_GAL::bitmapBuffer
protected

Storage of the cairo image.

Definition at line 423 of file cairo_gal.h.

Referenced by allocateBitmaps(), deleteBitmaps(), endDrawing(), and initSurface().