KiCad PCB EDA Suite
Loading...
Searching...
No Matches
KIGFX::CAIRO_GAL_BASE Class Reference

#include <cairo_gal.h>

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

Classes

struct  GROUP_ELEMENT
 Type definition for an graphics group element. More...
 

Public Member Functions

 CAIRO_GAL_BASE (GAL_DISPLAY_OPTIONS &aDisplayOptions)
 
 ~CAIRO_GAL_BASE ()
 
bool IsCairoEngine () override
 Return true if the GAL engine is a Cairo based type.
 
void DrawLine (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint) override
 Draw a line.
 
void DrawSegment (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint, double aWidth) override
 Draw a rounded segment.
 
void DrawCircle (const VECTOR2D &aCenterPoint, double aRadius) override
 Draw a circle using world coordinates.
 
void DrawHoleWall (const VECTOR2D &aCenterPoint, double aHoleRadius, double aWallWidth) override
 Draw a hole wall ring.
 
void DrawArc (const VECTOR2D &aCenterPoint, double aRadius, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle) override
 Draw an arc.
 
void DrawArcSegment (const VECTOR2D &aCenterPoint, double aRadius, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle, double aWidth, double aMaxError) override
 Draw an arc segment.
 
void DrawRectangle (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint) override
 Draw a rectangle.
 
void DrawSegmentChain (const std::vector< VECTOR2D > &aPointList, double aWidth) override
 Draw a chain of rounded segments.
 
void DrawSegmentChain (const SHAPE_LINE_CHAIN &aLineChain, double aWidth) override
 
void DrawPolyline (const std::deque< VECTOR2D > &aPointList) override
 Draw a polyline.
 
void DrawPolyline (const VECTOR2D aPointList[], int aListSize) override
 
void DrawPolyline (const SHAPE_LINE_CHAIN &aLineChain) override
 
void DrawPolylines (const std::vector< std::vector< VECTOR2D > > &aPointLists) override
 Draw multiple polylines.
 
void DrawPolygon (const std::deque< VECTOR2D > &aPointList) override
 Draw a polygon.
 
void DrawPolygon (const VECTOR2D aPointList[], int aListSize) override
 
void DrawPolygon (const SHAPE_POLY_SET &aPolySet, bool aStrokeTriangulation=false) override
 
void DrawPolygon (const SHAPE_LINE_CHAIN &aPolySet) override
 
void DrawGlyph (const KIFONT::GLYPH &aPolySet, int aNth, int aTotal) override
 Draw a polygon representing a font glyph.
 
void DrawGlyphs (const std::vector< std::unique_ptr< KIFONT::GLYPH > > &aGlyphs) override
 Draw polygons representing font glyphs.
 
void DrawCurve (const VECTOR2D &startPoint, const VECTOR2D &controlPointA, const VECTOR2D &controlPointB, const VECTOR2D &endPoint, double aFilterValue=0.0) override
 Draw a cubic bezier spline.
 
void DrawBitmap (const BITMAP_BASE &aBitmap, double alphaBlend=1.0) override
 Draw a bitmap image.
 
void ResizeScreen (int aWidth, int aHeight) override
 Resizes the canvas.
 
void Flush () override
 Force all remaining objects to be drawn.
 
void ClearScreen () override
 Clear the screen.
 
void SetIsFill (bool aIsFillEnabled) override
 Enable/disable fill.
 
void SetIsStroke (bool aIsStrokeEnabled) override
 Enable/disable stroked outlines.
 
void SetStrokeColor (const COLOR4D &aColor) override
 Set the stroke color.
 
void SetFillColor (const COLOR4D &aColor) override
 Set the fill color.
 
void SetLineWidth (float aLineWidth) override
 Set the line width.
 
void SetLayerDepth (double aLayerDepth) override
 Set the depth of the layer (position on the z-axis)
 
void Transform (const MATRIX3x3D &aTransformation) override
 Transform the context.
 
void Rotate (double aAngle) override
 Rotate the context.
 
void Translate (const VECTOR2D &aTranslation) override
 Translate the context.
 
void Scale (const VECTOR2D &aScale) override
 Scale the context.
 
void Save () override
 Save the context.
 
void Restore () override
 Restore the context.
 
int BeginGroup () override
 Begin a group.
 
void EndGroup () override
 End the group.
 
void DrawGroup (int aGroupNumber) override
 Draw the stored group.
 
void ChangeGroupColor (int aGroupNumber, const COLOR4D &aNewColor) override
 Change the color used to draw the group.
 
void ChangeGroupDepth (int aGroupNumber, int aDepth) override
 Change the depth (Z-axis position) of the group.
 
void DeleteGroup (int aGroupNumber) override
 Delete the group from the memory.
 
void ClearCache () override
 Delete all data created during caching of graphic items.
 
void SetNegativeDrawMode (bool aSetting) override
 Set negative draw mode in the renderer.
 
void DrawCursor (const VECTOR2D &aCursorPosition) override
 Draw the cursor.
 
void EnableDepthTest (bool aEnabled=false) override
 
void DrawGrid () override
 
void BeginDrawing () override
 Start/end drawing functions, draw calls can be only made in between the calls to BeginDrawing()/EndDrawing().
 
void EndDrawing () override
 End the drawing, needs to be called for every new frame.
 
virtual bool IsInitialized () const
 Return the initialization status for the canvas.
 
virtual bool IsVisible () const
 Return true if the GAL canvas is visible on the screen.
 
virtual bool IsOpenGlEngine ()
 Return true if the GAL engine is a OpenGL based type.
 
virtual void DrawPolyline (const std::vector< VECTOR2D > &aPointList)
 
void DrawRectangle (const BOX2I &aRect)
 
virtual bool Show (bool aShow)
 Show/hide the GAL canvas.
 
const VECTOR2IGetScreenPixelSize () const
 Return GAL canvas size in pixels.
 
virtual int GetSwapInterval () const
 Return the swap interval. -1 for adaptive, 0 for disabled/unknown.
 
void SetClearColor (const COLOR4D &aColor)
 
const COLOR4DGetClearColor () const
 
bool GetIsFill () const
 Get the fill status.
 
bool GetIsStroke () const
 Get the stroke status.
 
const COLOR4DGetFillColor () const
 Get the fill color.
 
const COLOR4DGetStrokeColor () const
 Get the stroke color.
 
virtual void SetMinLineWidth (float aLineWidth)
 Set the minimum line width in pixels.
 
float GetLineWidth () const
 Get the line width.
 
float GetMinLineWidth () const
 Get the minimum line width in pixels.
 
void AdvanceDepth ()
 Change the current depth to deeper, so it is possible to draw objects right beneath other.
 
virtual void BitmapText (const wxString &aText, const VECTOR2I &aPosition, const EDA_ANGLE &aAngle)
 Draw a text using a bitmap font.
 
void ResetTextAttributes ()
 Reset text attributes to default styling.
 
void SetGlyphSize (const VECTOR2I aSize)
 
const VECTOR2IGetGlyphSize () const
 
void SetFontBold (const bool aBold)
 
bool IsFontBold () const
 
void SetFontItalic (bool aItalic)
 
bool IsFontItalic () const
 
void SetFontUnderlined (bool aUnderlined)
 
bool IsFontUnderlined () const
 
void SetTextMirrored (const bool aMirrored)
 
bool IsTextMirrored () const
 
void SetHorizontalJustify (const GR_TEXT_H_ALIGN_T aHorizontalJustify)
 
GR_TEXT_H_ALIGN_T GetHorizontalJustify () const
 
void SetVerticalJustify (const GR_TEXT_V_ALIGN_T aVerticalJustify)
 
GR_TEXT_V_ALIGN_T GetVerticalJustify () const
 
virtual void ComputeWorldScreenMatrix ()
 Compute the world <-> screen transformation matrix.
 
const MATRIX3x3DGetWorldScreenMatrix () const
 Get the world <-> screen transformation matrix.
 
const MATRIX3x3DGetScreenWorldMatrix () const
 Get the screen <-> world transformation matrix.
 
void SetWorldScreenMatrix (const MATRIX3x3D &aMatrix)
 Set the world <-> screen transformation matrix.
 
BOX2D GetVisibleWorldExtents () const
 
void SetWorldUnitLength (double aWorldUnitLength)
 Set the unit length.
 
void SetScreenSize (const VECTOR2I &aSize)
 
void SetScreenDPI (double aScreenDPI)
 Set the dots per inch of the screen.
 
double GetScreenDPI () const
 
void SetLookAtPoint (const VECTOR2D &aPoint)
 Get/set the Point in world space to look at.
 
const VECTOR2DGetLookAtPoint () const
 
void SetZoomFactor (double aZoomFactor)
 
double GetZoomFactor () const
 
void SetRotation (double aRotation)
 Get/set the rotation angle (in radians).
 
double GetRotation () const
 
void SetDepthRange (const VECTOR2D &aDepthRange)
 Set the range of the layer depth.
 
double GetMinDepth () const
 
double GetMaxDepth () const
 
double GetWorldScale () const
 Get the world scale.
 
void SetFlip (bool xAxis, bool yAxis)
 Sets flipping of the screen.
 
bool IsFlippedX () const
 
bool IsFlippedY () const
 
virtual void SetTarget (RENDER_TARGET aTarget)
 Set the target for rendering.
 
virtual RENDER_TARGET GetTarget () const
 Get the currently used target for rendering.
 
virtual void ClearTarget (RENDER_TARGET aTarget)
 Clear the target for rendering.
 
virtual bool HasTarget (RENDER_TARGET aTarget)
 Return true if the target exists.
 
virtual void StartDiffLayer ()
 Begins rendering of a differential layer.
 
virtual void EndDiffLayer ()
 Ends rendering of a differential layer.
 
virtual void StartNegativesLayer ()
 Begins rendering in a new layer that will be copied to the main layer in EndNegativesLayer().
 
virtual void EndNegativesLayer ()
 Ends rendering of a negatives layer and draws it to the main layer.
 
void SetGridVisibility (bool aVisibility)
 Set the visibility setting of the grid.
 
bool GetGridVisibility () const
 
bool GetGridSnapping () const
 
void SetGridOrigin (const VECTOR2D &aGridOrigin)
 Set the origin point for the grid.
 
const VECTOR2DGetGridOrigin () const
 
void SetGridSize (const VECTOR2D &aGridSize)
 Set the grid size.
 
const VECTOR2DGetGridSize () const
 Return the grid size.
 
VECTOR2D GetVisibleGridSize () const
 Return the visible grid size in x and y directions.
 
void SetGridColor (const COLOR4D &aGridColor)
 Set the grid color.
 
void SetAxesColor (const COLOR4D &aAxesColor)
 Set the axes color.
 
void SetAxesEnabled (bool aAxesEnabled)
 Enable drawing the axes.
 
void SetCoarseGrid (int aInterval)
 Draw every tick line wider.
 
float GetGridLineWidth () const
 Get the grid line width.
 
VECTOR2D GetGridPoint (const VECTOR2D &aPoint) const
 For a given point it returns the nearest point belonging to the grid in world coordinates.
 
VECTOR2D ToWorld (const VECTOR2D &aPoint) const
 Compute the point position in world coordinates from given screen coordinates.
 
VECTOR2D ToScreen (const VECTOR2D &aPoint) const
 Compute the point position in screen coordinates from given world coordinates.
 
virtual bool SetNativeCursorStyle (KICURSOR aCursor, bool aHiDPI)
 Set the cursor in the native panel.
 
void SetCursorEnabled (bool aCursorEnabled)
 Enable/disable cursor.
 
bool IsCursorEnabled () const
 Return information about cursor visibility.
 
void SetCursorColor (const COLOR4D &aCursorColor)
 Set the cursor color.
 
virtual bool IsContextLocked ()
 Checks the state of the context lock.
 
virtual void LockContext (int aClientCookie)
 Use GAL_CONTEXT_LOCKER RAII object unless you know what you're doing.
 
virtual void UnlockContext (int aClientCookie)
 

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.
 
typedef std::deque< GROUP_ELEMENTGROUP
 A graphic group type definition.
 

Protected Member Functions

double xform (double x)
 
const VECTOR2D xform (double x, double y)
 
const VECTOR2D xform (const VECTOR2D &aP)
 
double angle_xform (double aAngle)
 Transform according to the rotation from m_currentWorld2Screen transform matrix.
 
void arc_angles_xform_and_normalize (double &aStartAngle, double &aEndAngle)
 Transform according to the rotation from m_currentWorld2Screen transform matrix for the start angle and the end angle of an arc.
 
void resetContext ()
 
void drawGridLine (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
 Draw a grid line (usually a simplified line function).
 
void drawGridCross (const VECTOR2D &aPoint)
 
void drawGridPoint (const VECTOR2D &aPoint, double aWidth, double aHeight)
 
void drawAxes (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
 
void flushPath ()
 
void storePath ()
 Store the actual path.
 
void blitCursor (wxMemoryDC &clientDC)
 Blit cursor into the current screen.
 
void drawPoly (const std::deque< VECTOR2D > &aPointList)
 Drawing polygons & polylines is the same in Cairo, so here is the common code.
 
void drawPoly (const std::vector< VECTOR2D > &aPointList)
 
void drawPoly (const VECTOR2D aPointList[], int aListSize)
 
void drawPoly (const SHAPE_LINE_CHAIN &aLineChain)
 
unsigned int getNewGroupNumber ()
 Return a valid key that can be used as a new group number.
 
void syncLineWidth (bool aForceWidth=false, double aWidth=0.0)
 
void updateWorldScreenMatrix ()
 
const VECTOR2D roundp (const VECTOR2D &v)
 
virtual void beginUpdate ()
 Enable item update mode.
 
virtual void endUpdate ()
 Disable item update mode.
 
void computeWorldScale ()
 Compute the scaling factor for the world->screen matrix.
 
double computeMinGridSpacing () const
 Compute minimum grid spacing from the grid settings.
 
COLOR4D getCursorColor () const
 Get the actual cursor color to draw.
 
void OnGalDisplayOptionsChanged (const GAL_DISPLAY_OPTIONS &aOptions) override
 Handler for observer settings changes.
 
virtual bool updatedGalDisplayOptions (const GAL_DISPLAY_OPTIONS &aOptions)
 Handle updating display options.
 
template<typename T>
void normalize (T &a, T &b)
 Ensure that the first element is smaller than the second.
 

Protected Attributes

bool m_isGrouping
 Is grouping enabled ?
 
bool m_isElementAdded
 Was an graphic element added ?
 
std::map< int, GROUPm_groups
 List of graphic groups.
 
unsigned int m_groupCounter
 Counter used for generating group keys.
 
GROUPm_currentGroup
 Currently used group.
 
double m_lineWidthInPixels
 
bool m_lineWidthIsOdd
 
cairo_matrix_t m_cairoWorldScreenMatrix
 Cairo world to screen transform matrix.
 
cairo_matrix_t m_currentXform
 
cairo_matrix_t m_currentWorld2Screen
 
cairo_t * m_currentContext
 Currently used Cairo context for drawing.
 
cairo_t * m_context
 Cairo image.
 
cairo_surface_t * m_surface
 Cairo surface.
 
std::vector< cairo_surface_t * > m_imageSurfaces
 List of surfaces that were created by painting images, to be cleaned up later.
 
std::vector< cairo_matrix_t > m_xformStack
 
GAL_DISPLAY_OPTIONSm_options
 
UTIL::LINK m_observerLink
 
std::stack< double > m_depthStack
 Stored depth values.
 
VECTOR2I m_screenSize
 Screen size in screen (wx logical) coordinates.
 
double m_worldUnitLength
 The unit length of the world coordinates [inch].
 
double m_screenDPI
 The dots per inch of the screen.
 
VECTOR2D m_lookAtPoint
 Point to be looked at in world space.
 
double m_zoomFactor
 The zoom factor.
 
double m_rotation
 Rotation transformation (radians)
 
MATRIX3x3D m_worldScreenMatrix
 World transformation.
 
MATRIX3x3D m_screenWorldMatrix
 Screen transformation.
 
double m_worldScale
 The scale factor world->screen.
 
bool m_globalFlipX
 Flag for X axis flipping.
 
bool m_globalFlipY
 Flag for Y axis flipping.
 
float m_lineWidth
 The line width.
 
float m_minLineWidth
 Minimum line width in pixels.
 
bool m_isFillEnabled
 Is filling of graphic objects enabled ?
 
bool m_isStrokeEnabled
 Are the outlines stroked ?
 
COLOR4D m_fillColor
 The fill color.
 
COLOR4D m_strokeColor
 The color of the outlines.
 
COLOR4D m_clearColor
 
double m_layerDepth
 The actual layer depth.
 
VECTOR2D m_depthRange
 Range of the depth.
 
bool m_gridVisibility
 Should the grid be shown.
 
GRID_STYLE m_gridStyle
 Grid display style.
 
VECTOR2D m_gridSize
 The grid size.
 
VECTOR2D m_gridOrigin
 The grid origin.
 
VECTOR2D m_gridOffset
 The grid offset to compensate cursor position.
 
COLOR4D m_gridColor
 Color of the grid.
 
COLOR4D m_axesColor
 Color of the axes.
 
bool m_axesEnabled
 Should the axes be drawn.
 
int m_gridTick
 Every tick line gets the double width.
 
float m_gridLineWidth
 Line width of the grid.
 
int m_gridMinSpacing
 Minimum screen size of the grid (pixels) below which the grid is not drawn.
 
bool m_isCursorEnabled
 Is the cursor enabled?
 
bool m_forceDisplayCursor
 Always show cursor.
 
COLOR4D m_cursorColor
 Cursor color.
 
KIGFX::CROSS_HAIR_MODE m_crossHairMode
 Crosshair drawing mode.
 
VECTOR2D m_cursorPosition
 Current cursor position (world coordinates)
 
KICURSOR m_currentNativeCursor
 Current cursor.
 

Static Protected Attributes

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

Private Member Functions

double getLayerDepth () const
 

Private Attributes

TEXT_ATTRIBUTES m_attributes
 

Detailed Description

Definition at line 58 of file cairo_gal.h.

Member Typedef Documentation

◆ GROUP

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

A graphic group type definition.

Definition at line 352 of file cairo_gal.h.

◆ super

typedef GAL KIGFX::CAIRO_GAL_BASE::super
protected

Super class definition.

Definition at line 316 of file cairo_gal.h.

Member Enumeration Documentation

◆ GRAPHICS_COMMAND

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

Constructor & Destructor Documentation

◆ CAIRO_GAL_BASE()

◆ ~CAIRO_GAL_BASE()

CAIRO_GAL_BASE::~CAIRO_GAL_BASE ( )

Definition at line 79 of file cairo_gal.cpp.

References ClearCache(), m_context, m_imageSurfaces, and m_surface.

Member Function Documentation

◆ AdvanceDepth()

void KIGFX::GAL::AdvanceDepth ( )
inlineinherited

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

If you do this, you should consider using a GAL_SCOPED_ATTR to ensure the depth is reset to the original value.

Definition at line 439 of file graphics_abstraction_layer.h.

References m_layerDepth, and SetLayerDepth().

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

◆ angle_xform()

double CAIRO_GAL_BASE::angle_xform ( double aAngle)
protected

Transform according to the rotation from m_currentWorld2Screen transform matrix.

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

Definition at line 129 of file cairo_gal.cpp.

References KIGFX::GAL::IsFlippedX(), m_currentWorld2Screen, and M_PI.

Referenced by arc_angles_xform_and_normalize().

◆ arc_angles_xform_and_normalize()

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

Transform according to the rotation from m_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 143 of file cairo_gal.cpp.

References std::abs(), angle_xform(), KIGFX::GAL::IsFlippedX(), M_PI, and KIGFX::GAL::normalize().

Referenced by DrawArc(), and DrawArcSegment().

◆ BeginDrawing()

void CAIRO_GAL_BASE::BeginDrawing ( )
overridevirtual

Start/end drawing functions, draw calls can be only made in between the calls to BeginDrawing()/EndDrawing().

Normally you should create a GAL_DRAWING_CONTEXT RAII object, but I'm leaving these functions public for more precise (i.e. timing/profiling) control of the drawing process - Tom Begin the drawing, needs to be called for every new frame. Use GAL_DRAWING_CONTEXT RAII object unless you know what you're doing.

Reimplemented from KIGFX::GAL.

Definition at line 94 of file cairo_gal.cpp.

References resetContext().

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

◆ BeginGroup()

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

Definition at line 814 of file cairo_gal.cpp.

References getNewGroupNumber(), group, m_currentGroup, m_groups, m_isGrouping, and storePath().

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

◆ beginUpdate()

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

Enable item update mode.

Private: use GAL_UPDATE_CONTEXT RAII object

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1036 of file graphics_abstraction_layer.h.

◆ BitmapText()

void GAL::BitmapText ( const wxString & aText,
const VECTOR2I & aPosition,
const EDA_ANGLE & aAngle )
virtualinherited

Draw 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.
aAngleis the text rotation angle.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 271 of file graphics_abstraction_layer.cpp.

References KIFONT::METRICS::Default(), KIFONT::FONT::Draw(), KIFONT::FONT::GetFont(), GetLineWidth(), TEXT_ATTRIBUTES::m_Angle, m_attributes, m_globalFlipX, TEXT_ATTRIBUTES::m_Mirrored, TEXT_ATTRIBUTES::m_Size, and TEXT_ATTRIBUTES::m_StrokeWidth.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), KIGFX::bitmapText(), KIGFX::PREVIEW::ANGLE_ITEM::drawPreviewShape(), and KIGFX::VIEW_OVERLAY::COMMAND_BITMAP_TEXT::Execute().

◆ blitCursor()

◆ ChangeGroupColor()

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

Change the color used to draw the group.

Parameters
aGroupNumberis the group number.
aNewColoris the new color.

Reimplemented from KIGFX::GAL.

Definition at line 930 of file cairo_gal.cpp.

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

◆ ChangeGroupDepth()

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

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

Parameters
aGroupNumberis the group number.
aDepthis the new depth.

Reimplemented from KIGFX::GAL.

Definition at line 947 of file cairo_gal.cpp.

◆ ClearCache()

void CAIRO_GAL_BASE::ClearCache ( )
overridevirtual

Delete all data created during caching of graphic items.

Reimplemented from KIGFX::GAL.

Definition at line 972 of file cairo_gal.cpp.

References DeleteGroup(), and m_groups.

Referenced by ~CAIRO_GAL_BASE().

◆ ClearScreen()

void CAIRO_GAL_BASE::ClearScreen ( )
overridevirtual

Clear the screen.

Parameters
aColoris the color used for clearing.

Reimplemented from KIGFX::GAL.

Definition at line 600 of file cairo_gal.cpp.

References KIGFX::GAL::m_clearColor, m_currentContext, and KIGFX::GAL::m_screenSize.

Referenced by resetContext().

◆ ClearTarget()

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

Clear the target for rendering.

Parameters
aTargetis the target to be cleared.

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

Definition at line 723 of file graphics_abstraction_layer.h.

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

References m_gridMinSpacing.

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

◆ computeWorldScale()

void KIGFX::GAL::computeWorldScale ( )
inlineprotectedinherited

◆ ComputeWorldScreenMatrix()

◆ DeleteGroup()

void CAIRO_GAL_BASE::DeleteGroup ( int aGroupNumber)
overridevirtual

Delete the group from the memory.

Parameters
aGroupNumberis the group number.

Reimplemented from KIGFX::GAL.

Definition at line 954 of file cairo_gal.cpp.

References CMD_FILL_PATH, CMD_STROKE_PATH, end, m_groups, and storePath().

Referenced by ClearCache().

◆ DrawArc()

void CAIRO_GAL_BASE::DrawArc ( const VECTOR2D & aCenterPoint,
double aRadius,
const EDA_ANGLE & aStartAngle,
const EDA_ANGLE & aAngle )
overridevirtual

Draw an arc.

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

Reimplemented from KIGFX::GAL.

Definition at line 347 of file cairo_gal.cpp.

References arc_angles_xform_and_normalize(), EDA_ANGLE::AsRadians(), flushPath(), m_currentContext, m_isElementAdded, KIGFX::GAL::m_isFillEnabled, m_lineWidthInPixels, RADIANS_T, RotatePoint(), roundp(), syncLineWidth(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

Referenced by DrawArcSegment().

◆ DrawArcSegment()

void CAIRO_GAL_BASE::DrawArcSegment ( const VECTOR2D & aCenterPoint,
double aRadius,
const EDA_ANGLE & aStartAngle,
const EDA_ANGLE & aAngle,
double aWidth,
double aMaxError )
overridevirtual

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.

This has meaning only for back ends that can't draw a true arc, and use segments to approximate.

TODO: Unify Arc routines

Parameters
aCenterPointis the center point of the arc.
aRadiusis the arc radius.
aStartAngleis the start angle of the arc.
aAngleis the angle of the arc.
aWidthis the thickness of the arc (pen size).
aMaxErroris the max allowed error to create segments to approximate a circle. Note: aMaxError is not used in Cairo, because Cairo can draw true arcs

Reimplemented from KIGFX::GAL.

Definition at line 391 of file cairo_gal.cpp.

References arc_angles_xform_and_normalize(), EDA_ANGLE::AsRadians(), DrawArc(), flushPath(), m_currentContext, m_isElementAdded, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_isStrokeEnabled, KIGFX::GAL::m_lineWidth, M_PI, KIGFX::GAL::m_strokeColor, RADIANS_T, RotatePoint(), syncLineWidth(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

◆ drawAxes()

void CAIRO_GAL_BASE::drawAxes ( const VECTOR2D & aStartPoint,
const VECTOR2D & aEndPoint )
protected

◆ DrawBitmap()

void CAIRO_GAL_BASE::DrawBitmap ( const BITMAP_BASE & aBitmap,
double alphaBlend = 1.0 )
overridevirtual

◆ DrawCircle()

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

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

References flushPath(), m_currentContext, m_isElementAdded, m_lineWidthInPixels, M_PI, roundp(), syncLineWidth(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

Referenced by DrawHoleWall().

◆ DrawCursor()

void CAIRO_GAL_BASE::DrawCursor ( const VECTOR2D & aCursorPosition)
overridevirtual

Draw the cursor.

Parameters
aCursorPositionis the cursor position in screen coordinates.

Reimplemented from KIGFX::GAL.

Definition at line 1011 of file cairo_gal.cpp.

References KIGFX::GAL::m_cursorPosition.

◆ DrawCurve()

void CAIRO_GAL_BASE::DrawCurve ( const VECTOR2D & startPoint,
const VECTOR2D & controlPointA,
const VECTOR2D & controlPointB,
const VECTOR2D & endPoint,
double aFilterValue = 0.0 )
overridevirtual

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

References flushPath(), m_currentContext, m_isElementAdded, roundp(), syncLineWidth(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

◆ DrawGlyph()

void CAIRO_GAL_BASE::DrawGlyph ( const KIFONT::GLYPH & aPolySet,
int aNth,
int aTotal )
overridevirtual

◆ DrawGlyphs()

void KIGFX::CAIRO_GAL_BASE::DrawGlyphs ( const std::vector< std::unique_ptr< KIFONT::GLYPH > > & aGlyphs)
inlineoverridevirtual

Draw polygons representing font glyphs.

Reimplemented from KIGFX::GAL.

Definition at line 131 of file cairo_gal.h.

References DrawGlyph().

◆ DrawGrid()

◆ drawGridCross()

void CAIRO_GAL_BASE::drawGridCross ( const VECTOR2D & aPoint)
protected

◆ drawGridLine()

void CAIRO_GAL_BASE::drawGridLine ( const VECTOR2D & aStartPoint,
const VECTOR2D & aEndPoint )
protected

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

References m_currentContext, KIGFX::GAL::m_gridColor, roundp(), syncLineWidth(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

Referenced by DrawGrid().

◆ drawGridPoint()

void CAIRO_GAL_BASE::drawGridPoint ( const VECTOR2D & aPoint,
double aWidth,
double aHeight )
protected

Definition at line 1107 of file cairo_gal.cpp.

References m_currentContext, KIGFX::GAL::m_gridColor, roundp(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

Referenced by DrawGrid().

◆ DrawGroup()

void CAIRO_GAL_BASE::DrawGroup ( int aGroupNumber)
overridevirtual

◆ DrawHoleWall()

void CAIRO_GAL_BASE::DrawHoleWall ( const VECTOR2D & aCenterPoint,
double aHoleRadius,
double aWallWidth )
overridevirtual

Draw a hole wall ring.

Parameters
aCenterPointis the center point of the hole.
aHoleRadiusis the radius of the hole.
aWallWidthis the wall thickness.

Reimplemented from KIGFX::GAL.

Definition at line 325 of file cairo_gal.cpp.

References DrawCircle().

◆ DrawLine()

void CAIRO_GAL_BASE::DrawLine ( const VECTOR2D & aStartPoint,
const VECTOR2D & aEndPoint )
overridevirtual

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

References flushPath(), m_currentContext, m_isElementAdded, roundp(), syncLineWidth(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

◆ drawPoly() [1/4]

◆ drawPoly() [2/4]

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

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

Definition at line 1235 of file cairo_gal.cpp.

References flushPath(), m_currentContext, m_isElementAdded, roundp(), syncLineWidth(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

Referenced by DrawGlyph(), DrawPolygon(), DrawPolygon(), DrawPolygon(), DrawPolygon(), DrawPolyline(), DrawPolyline(), DrawPolyline(), and DrawPolylines().

◆ drawPoly() [3/4]

void CAIRO_GAL_BASE::drawPoly ( const std::vector< VECTOR2D > & aPointList)
protected

◆ drawPoly() [4/4]

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

◆ DrawPolygon() [1/4]

void CAIRO_GAL_BASE::DrawPolygon ( const SHAPE_LINE_CHAIN & aPolySet)
overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 480 of file cairo_gal.cpp.

References drawPoly().

◆ DrawPolygon() [2/4]

void CAIRO_GAL_BASE::DrawPolygon ( const SHAPE_POLY_SET & aPolySet,
bool aStrokeTriangulation = false )
overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 473 of file cairo_gal.cpp.

References SHAPE_POLY_SET::COutline(), drawPoly(), and SHAPE_POLY_SET::OutlineCount().

◆ DrawPolygon() [3/4]

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

Draw a polygon.

Parameters
aPointListis the list of the polygon points.

Reimplemented from KIGFX::GAL.

Definition at line 118 of file cairo_gal.h.

References drawPoly().

◆ DrawPolygon() [4/4]

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

Reimplemented from KIGFX::GAL.

Definition at line 119 of file cairo_gal.h.

References drawPoly().

◆ DrawPolyline() [1/4]

void KIGFX::CAIRO_GAL_BASE::DrawPolyline ( const SHAPE_LINE_CHAIN & aLineChain)
inlineoverridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 108 of file cairo_gal.h.

References drawPoly().

◆ DrawPolyline() [2/4]

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

Draw a polyline.

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

Reimplemented from KIGFX::GAL.

Definition at line 102 of file cairo_gal.h.

References drawPoly().

◆ DrawPolyline() [3/4]

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

Reimplemented from KIGFX::GAL.

Definition at line 103 of file cairo_gal.h.

References drawPoly().

◆ DrawPolyline() [4/4]

virtual void KIGFX::GAL::DrawPolyline ( const std::vector< VECTOR2D > & aPointList)
inlinevirtualinherited

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 128 of file graphics_abstraction_layer.h.

◆ DrawPolylines()

void KIGFX::CAIRO_GAL_BASE::DrawPolylines ( const std::vector< std::vector< VECTOR2D > > & aPointLists)
inlineoverridevirtual

Draw multiple polylines.

Parameters
aPointListsare lists of 2D-Vectors containing the polyline points.

Reimplemented from KIGFX::GAL.

Definition at line 111 of file cairo_gal.h.

References drawPoly().

◆ DrawRectangle() [1/2]

void CAIRO_GAL_BASE::DrawRectangle ( const VECTOR2D & aStartPoint,
const VECTOR2D & aEndPoint )
overridevirtual

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

References flushPath(), m_currentContext, m_isElementAdded, roundp(), syncLineWidth(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

◆ DrawRectangle() [2/2]

void KIGFX::GAL::DrawRectangle ( const BOX2I & aRect)
inlineinherited

◆ DrawSegment()

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

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

References flushPath(), m_currentContext, KIGFX::GAL::m_fillColor, m_isElementAdded, KIGFX::GAL::m_isFillEnabled, M_PI, KIGFX::GAL::m_strokeColor, radius, roundp(), SetLineWidth(), syncLineWidth(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

Referenced by DrawSegmentChain(), and DrawSegmentChain().

◆ DrawSegmentChain() [1/2]

void CAIRO_GAL_BASE::DrawSegmentChain ( const SHAPE_LINE_CHAIN & aLineChain,
double aWidth )
overridevirtual

◆ DrawSegmentChain() [2/2]

void CAIRO_GAL_BASE::DrawSegmentChain ( const std::vector< VECTOR2D > & aPointList,
double aWidth )
overridevirtual

Draw a chain of rounded segments.

Parameters
aPointListis a list of 2D-Vectors containing the chain points.
aWidthis a width of the segments

Reimplemented from KIGFX::GAL.

Definition at line 238 of file cairo_gal.cpp.

References DrawSegment().

◆ EnableDepthTest()

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

Reimplemented from KIGFX::GAL.

Definition at line 1017 of file cairo_gal.cpp.

◆ EndDiffLayer()

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

Ends rendering of a differential layer.

Objects drawn after the StartDiffLayer() will be drawn and composited with a differential blend mode, then drawing is returned to normal.

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

Definition at line 762 of file graphics_abstraction_layer.h.

◆ EndDrawing()

void CAIRO_GAL_BASE::EndDrawing ( )
overridevirtual

End the drawing, needs to be called for every new frame.

Use GAL_DRAWING_CONTEXT RAII object unless you know what you're doing.

Reimplemented from KIGFX::GAL.

Definition at line 100 of file cairo_gal.cpp.

References Flush().

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

◆ EndGroup()

void CAIRO_GAL_BASE::EndGroup ( )
overridevirtual

End the group.

Reimplemented from KIGFX::GAL.

Definition at line 830 of file cairo_gal.cpp.

References m_isGrouping, and storePath().

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

◆ EndNegativesLayer()

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

Ends rendering of a negatives layer and draws it to the main layer.

No-op in OpenGL.

Reimplemented in KIGFX::CAIRO_GAL.

Definition at line 778 of file graphics_abstraction_layer.h.

◆ endUpdate()

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

Disable item update mode.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1039 of file graphics_abstraction_layer.h.

◆ Flush()

void CAIRO_GAL_BASE::Flush ( )
overridevirtual

Force all remaining objects to be drawn.

Reimplemented from KIGFX::GAL.

Definition at line 594 of file cairo_gal.cpp.

References storePath().

Referenced by EndDrawing().

◆ flushPath()

◆ GetClearColor()

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

Definition at line 278 of file graphics_abstraction_layer.h.

References m_clearColor.

Referenced by EDIT_POINTS::ViewDraw().

◆ getCursorColor()

COLOR4D GAL::getCursorColor ( ) const
protectedinherited

Get the actual cursor color to draw.

Definition at line 258 of file graphics_abstraction_layer.cpp.

References color, m_cursorColor, and m_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 349 of file graphics_abstraction_layer.h.

References m_fillColor.

Referenced by KIGFX::GAL_SCOPED_ATTRS::GAL_SCOPED_ATTRS().

◆ GetGlyphSize()

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

◆ GetGridLineWidth()

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

Get the grid line width.

Returns
the grid line width Draw the grid

Definition at line 920 of file graphics_abstraction_layer.h.

References m_gridLineWidth.

◆ GetGridOrigin()

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

Definition at line 819 of file graphics_abstraction_layer.h.

References m_gridOrigin.

◆ GetGridPoint()

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

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

References KiROUND(), m_gridOffset, m_gridSize, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by KIGFX::WX_VIEW_CONTROLS::GetRawCursorPosition().

◆ GetGridSize()

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

Return the grid size.

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

Definition at line 846 of file graphics_abstraction_layer.h.

References m_gridSize.

Referenced by COMMON_TOOLS::CursorControl(), GERBVIEW_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::GetNearestGridPosition(), EDA_DRAW_FRAME::GetNearestHalfGridPosition(), and COMMON_TOOLS::PanControl().

◆ GetGridSnapping()

◆ GetGridVisibility()

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

Definition at line 791 of file graphics_abstraction_layer.h.

References m_gridVisibility.

◆ GetHorizontalJustify()

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

Definition at line 487 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by KIGFX::OPENGL_GAL::BitmapText().

◆ GetIsFill()

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

Get the fill status.

Returns
true if fill is enabled, false otherwise.

Definition at line 309 of file graphics_abstraction_layer.h.

References m_isFillEnabled.

Referenced by KIGFX::GAL_SCOPED_ATTRS::GAL_SCOPED_ATTRS().

◆ GetIsStroke()

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

Get the stroke status.

Returns
true if stroke is enabled, false otherwise.

Definition at line 329 of file graphics_abstraction_layer.h.

References m_isStrokeEnabled.

Referenced by KIGFX::GAL_SCOPED_ATTRS::GAL_SCOPED_ATTRS().

◆ getLayerDepth()

double KIGFX::GAL::getLayerDepth ( ) const
inlineprivateinherited

Definition at line 1160 of file graphics_abstraction_layer.h.

References m_layerDepth.

Referenced by KIGFX::GAL_SCOPED_ATTRS::GAL_SCOPED_ATTRS().

◆ GetLineWidth()

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

◆ GetLookAtPoint()

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

Definition at line 655 of file graphics_abstraction_layer.h.

References m_lookAtPoint.

Referenced by GetVisibleWorldExtents().

◆ GetMaxDepth()

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

Definition at line 676 of file graphics_abstraction_layer.h.

References m_depthRange.

◆ GetMinDepth()

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

◆ GetMinLineWidth()

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

Get the minimum line width in pixels.

Returns
the minimum line width.

Definition at line 409 of file graphics_abstraction_layer.h.

References m_minLineWidth.

Referenced by KIGFX::OPENGL_GAL::BeginDrawing().

◆ getNewGroupNumber()

unsigned int CAIRO_GAL_BASE::getNewGroupNumber ( )
protected

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

References m_groupCounter, and m_groups.

Referenced by BeginGroup().

◆ GetRotation()

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

Definition at line 664 of file graphics_abstraction_layer.h.

References m_rotation.

◆ GetScreenDPI()

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

Definition at line 647 of file graphics_abstraction_layer.h.

References m_screenDPI.

◆ GetScreenPixelSize()

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

Return GAL canvas size in pixels.

Definition at line 262 of file graphics_abstraction_layer.h.

References m_screenSize.

Referenced by BOARD_PRINTOUT::DrawPage(), SCH_PRINTOUT::PrintPage(), and KIGFX::PREVIEW::RULER_ITEM::ViewDraw().

◆ GetScreenWorldMatrix()

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

Get the screen <-> world transformation matrix.

Returns
the transformation matrix.

Definition at line 609 of file graphics_abstraction_layer.h.

References m_screenWorldMatrix.

Referenced by GetVisibleWorldExtents(), KIGFX::OPENGL_GAL::getWorldPixelSize(), screenSpaceCircle(), screenSpaceLine(), ROUTER_STATUS_VIEW_ITEM::ViewDraw(), and TUNING_STATUS_VIEW_ITEM::ViewDraw().

◆ GetStrokeColor()

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

Get the stroke color.

Returns
the color for stroking the outline.

Definition at line 369 of file graphics_abstraction_layer.h.

References m_strokeColor.

Referenced by KIGFX::PREVIEW::DrawTextNextToCursor(), KIGFX::GAL_SCOPED_ATTRS::GAL_SCOPED_ATTRS(), and KIGFX::PREVIEW::RULER_ITEM::ViewDraw().

◆ GetSwapInterval()

virtual int KIGFX::GAL::GetSwapInterval ( ) const
inlinevirtualinherited

Return the swap interval. -1 for adaptive, 0 for disabled/unknown.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 268 of file graphics_abstraction_layer.h.

◆ GetTarget()

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

Get the currently used target for rendering.

Returns
The current rendering target.

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

Definition at line 716 of file graphics_abstraction_layer.h.

References KIGFX::TARGET_CACHED.

◆ GetVerticalJustify()

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

Definition at line 494 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by KIGFX::OPENGL_GAL::BitmapText().

◆ GetVisibleGridSize()

VECTOR2D KIGFX::GAL::GetVisibleGridSize ( ) const
inlineinherited

Return the visible grid size in x and y directions.

Returns
A vector containing the spacing of visible grid marks

Definition at line 856 of file graphics_abstraction_layer.h.

References computeMinGridSpacing(), m_gridSize, m_gridStyle, m_gridTick, m_worldScale, KIGFX::SMALL_CROSS, VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ GetVisibleWorldExtents()

BOX2D GAL::GetVisibleWorldExtents ( ) const
inherited
Returns
the bounding box of the world that is displayed on screen at the moment

Definition at line 203 of file graphics_abstraction_layer.cpp.

References GetLookAtPoint(), MATRIX3x3< T >::GetScale(), GetScreenWorldMatrix(), m_screenSize, BOX2< Vec >::SetOrigin(), BOX2< Vec >::SetSize(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ROUTER_TOOL::handleCommonEvents(), and ROUTER_TOOL::InlineDrag().

◆ GetWorldScale()

◆ GetWorldScreenMatrix()

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

Get the world <-> screen transformation matrix.

Returns
the transformation matrix.

Definition at line 599 of file graphics_abstraction_layer.h.

References m_worldScreenMatrix.

◆ GetZoomFactor()

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

◆ HasTarget()

virtual bool KIGFX::GAL::HasTarget ( RENDER_TARGET aTarget)
inlinevirtualinherited

Return true if the target exists.

Parameters
aTargetis the target to be checked.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 730 of file graphics_abstraction_layer.h.

◆ IsCairoEngine()

bool KIGFX::CAIRO_GAL_BASE::IsCairoEngine ( )
inlineoverridevirtual

Return true if the GAL engine is a Cairo based type.

Reimplemented from KIGFX::GAL.

Definition at line 65 of file cairo_gal.h.

◆ IsContextLocked()

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

Checks the state of the context lock.

Returns
True if the context is currently locked

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1009 of file graphics_abstraction_layer.h.

◆ IsCursorEnabled()

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

Return information about cursor visibility.

Returns
True if cursor is visible.

Definition at line 981 of file graphics_abstraction_layer.h.

References m_forceDisplayCursor, and m_isCursorEnabled.

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

◆ IsFlippedX()

◆ IsFlippedY()

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

Definition at line 698 of file graphics_abstraction_layer.h.

References m_globalFlipY.

◆ IsFontBold()

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

Definition at line 471 of file graphics_abstraction_layer.h.

References m_attributes.

◆ IsFontItalic()

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

Definition at line 474 of file graphics_abstraction_layer.h.

References m_attributes.

◆ IsFontUnderlined()

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

Definition at line 477 of file graphics_abstraction_layer.h.

References m_attributes.

◆ IsInitialized()

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

Return the initialization status for the canvas.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 76 of file graphics_abstraction_layer.h.

◆ IsOpenGlEngine()

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

Return true if the GAL engine is a OpenGL based type.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 85 of file graphics_abstraction_layer.h.

◆ IsTextMirrored()

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

Definition at line 480 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by KIGFX::OPENGL_GAL::BitmapText().

◆ IsVisible()

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

Return true if the GAL canvas is visible on the screen.

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

Definition at line 79 of file graphics_abstraction_layer.h.

◆ LockContext()

virtual void KIGFX::GAL::LockContext ( int aClientCookie)
inlinevirtualinherited

Use GAL_CONTEXT_LOCKER RAII object unless you know what you're doing.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1016 of file graphics_abstraction_layer.h.

◆ normalize()

template<typename T>
void KIGFX::GAL::normalize ( T & a,
T & b )
inlineprotectedinherited

◆ OnGalDisplayOptionsChanged()

void GAL::OnGalDisplayOptionsChanged ( const GAL_DISPLAY_OPTIONS & aOptions)
overrideprotectedvirtualinherited

Handler for observer settings changes.

Implements KIGFX::GAL_DISPLAY_OPTIONS_OBSERVER.

Definition at line 103 of file graphics_abstraction_layer.cpp.

References updatedGalDisplayOptions().

◆ resetContext()

◆ ResetTextAttributes()

void GAL::ResetTextAttributes ( )
inherited

Reset text attributes to default styling.

FONT TODO: do we need any of this in GAL anymore?

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

Definition at line 157 of file graphics_abstraction_layer.cpp.

References GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, SetFontBold(), SetFontItalic(), SetFontUnderlined(), SetGlyphSize(), SetHorizontalJustify(), SetTextMirrored(), and SetVerticalJustify().

Referenced by GAL(), KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw(), KIGFX::PREVIEW::BEZIER_ASSISTANT::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), and KIGFX::PREVIEW::TWO_POINT_ASSISTANT::ViewDraw().

◆ ResizeScreen()

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

Resizes the canvas.

Reimplemented from KIGFX::GAL.

Definition at line 588 of file cairo_gal.cpp.

References KIGFX::GAL::m_screenSize.

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

◆ Restore()

void CAIRO_GAL_BASE::Restore ( )
overridevirtual

◆ Rotate()

void CAIRO_GAL_BASE::Rotate ( double aAngle)
overridevirtual

◆ roundp()

◆ Save()

void CAIRO_GAL_BASE::Save ( )
overridevirtual

◆ Scale()

void CAIRO_GAL_BASE::Scale ( const VECTOR2D & aScale)
overridevirtual

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

References m_axesColor.

Referenced by KIGFX::CAIRO_GAL_BASE::CAIRO_GAL_BASE(), SCH_BASE_FRAME::CommonSettingsChanged(), SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), KIGFX::OPENGL_GAL::OPENGL_GAL(), and SYMBOL_EDIT_FRAME::SwitchCanvas().

◆ SetAxesEnabled()

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

◆ SetClearColor()

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

Definition at line 273 of file graphics_abstraction_layer.h.

References m_clearColor.

Referenced by BOARD_PRINTOUT::DrawPage(), and SCH_PRINTOUT::PrintPage().

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

References m_gridTick.

Referenced by GAL().

◆ SetCursorColor()

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

Set the cursor color.

Parameters
aCursorColoris the color of the cursor.

Definition at line 991 of file graphics_abstraction_layer.h.

References m_cursorColor.

Referenced by GAL().

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

References m_isCursorEnabled.

Referenced by GAL().

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

The MinDepth (x) is closest to the clipping plane (top) while the MaxDepth (y) is farthest from the clipping plane (bottom).

Definition at line 674 of file graphics_abstraction_layer.h.

References m_depthRange.

Referenced by GAL().

◆ SetFillColor()

void CAIRO_GAL_BASE::SetFillColor ( const COLOR4D & aColor)
overridevirtual

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

References m_globalFlipX, and m_globalFlipY.

Referenced by GAL(), and BOARD_PRINTOUT::setupGal().

◆ SetFontBold()

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

Definition at line 470 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by ResetTextAttributes().

◆ SetFontItalic()

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

Definition at line 473 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by ResetTextAttributes().

◆ SetFontUnderlined()

void KIGFX::GAL::SetFontUnderlined ( bool aUnderlined)
inlineinherited

Definition at line 476 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by ResetTextAttributes().

◆ SetGlyphSize()

void KIGFX::GAL::SetGlyphSize ( const VECTOR2I aSize)
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 882 of file graphics_abstraction_layer.h.

References m_gridColor.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), KIGFX::CAIRO_GAL_BASE::CAIRO_GAL_BASE(), KIGFX::OPENGL_GAL::OPENGL_GAL(), GERBVIEW_FRAME::SetGridColor(), and PCB_EDIT_FRAME::SetGridColor().

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

References m_gridOffset, m_gridOrigin, and m_gridSize.

Referenced by PCB_CONTROL::DoSetGridOrigin(), PCB_EDIT_FRAME::RebuildAndRefresh(), 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 829 of file graphics_abstraction_layer.h.

References m_gridOffset, m_gridOrigin, and m_gridSize.

Referenced by FOOTPRINT_PREVIEW_PANEL::New(), COMMON_TOOLS::OnGridChanged(), and DIALOG_PAD_PROPERTIES::prepareCanvas().

◆ SetGridVisibility()

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

Set the visibility setting of the grid.

Parameters
aVisibilityis the new visibility setting of the grid.

Definition at line 789 of file graphics_abstraction_layer.h.

References m_gridVisibility.

Referenced by GAL(), FOOTPRINT_PREVIEW_PANEL::New(), COMMON_TOOLS::OnGridChanged(), DIALOG_PAD_PROPERTIES::prepareCanvas(), and EDA_DRAW_FRAME::SetGridVisibility().

◆ SetHorizontalJustify()

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

Definition at line 482 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by KIGFX::bitmapText(), and ResetTextAttributes().

◆ SetIsFill()

void CAIRO_GAL_BASE::SetIsFill ( bool aIsFillEnabled)
overridevirtual

Enable/disable fill.

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

Reimplemented from KIGFX::GAL.

Definition at line 608 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::BoolArg, CMD_SET_FILL, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Argument, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Command, m_currentGroup, KIGFX::GAL::m_isFillEnabled, m_isGrouping, and storePath().

Referenced by DrawGlyph().

◆ SetIsStroke()

void CAIRO_GAL_BASE::SetIsStroke ( bool aIsStrokeEnabled)
overridevirtual

Enable/disable stroked outlines.

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

Reimplemented from KIGFX::GAL.

Definition at line 623 of file cairo_gal.cpp.

References KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::BoolArg, CMD_SET_STROKE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Argument, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Command, m_currentGroup, m_isGrouping, KIGFX::GAL::m_isStrokeEnabled, and storePath().

Referenced by DrawGlyph().

◆ SetLayerDepth()

void CAIRO_GAL_BASE::SetLayerDepth ( double aLayerDepth)
overridevirtual

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

If you do this, you should consider using a GAL_SCOPED_ATTR to ensure the depth is reset to the original value.

Parameters
aLayerDepththe layer depth for the objects. Smaller is closer to the viewer.

Reimplemented from KIGFX::GAL.

Definition at line 693 of file cairo_gal.cpp.

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

Referenced by DrawGrid().

◆ SetLineWidth()

void CAIRO_GAL_BASE::SetLineWidth ( float aLineWidth)
overridevirtual

◆ SetLookAtPoint()

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

Get/set the Point in world space to look at.

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

Definition at line 654 of file graphics_abstraction_layer.h.

References m_lookAtPoint.

Referenced by BOARD_PRINTOUT::DrawPage(), GAL(), and SCH_PRINTOUT::PrintPage().

◆ SetMinLineWidth()

virtual void KIGFX::GAL::SetMinLineWidth ( float aLineWidth)
inlinevirtualinherited

Set the minimum line width in pixels.

Parameters
aLineWidthis the minimum line width.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 389 of file graphics_abstraction_layer.h.

References m_minLineWidth.

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

◆ SetNativeCursorStyle()

bool GAL::SetNativeCursorStyle ( KICURSOR aCursor,
bool aHiDPI )
virtualinherited

Set the cursor in the native panel.

Parameters
aCursoris the cursor to use in the native panel
Returns
true if the cursor was updated, false if the cursor given was already set

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

Definition at line 291 of file graphics_abstraction_layer.cpp.

References m_currentNativeCursor.

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

◆ SetNegativeDrawMode()

void CAIRO_GAL_BASE::SetNegativeDrawMode ( bool aSetting)
overridevirtual

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

References m_currentContext.

◆ SetRotation()

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

Get/set the rotation angle (in radians).

Definition at line 663 of file graphics_abstraction_layer.h.

References m_rotation.

Referenced by 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.

Definition at line 646 of file graphics_abstraction_layer.h.

References m_screenDPI.

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

◆ SetScreenSize()

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

Definition at line 638 of file graphics_abstraction_layer.h.

References m_screenSize.

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

◆ SetStrokeColor()

void CAIRO_GAL_BASE::SetStrokeColor ( const COLOR4D & aColor)
overridevirtual

◆ SetTarget()

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

Set the target for rendering.

Parameters
aTargetis the new target for rendering.

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

Definition at line 709 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawGrid(), and MY_DRAWING::ViewDraw().

◆ SetTextMirrored()

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

◆ SetVerticalJustify()

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

Definition at line 489 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by KIGFX::bitmapText(), and ResetTextAttributes().

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

References m_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.

Definition at line 636 of file graphics_abstraction_layer.h.

References m_worldUnitLength.

Referenced by GAL(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), SCH_PRINTOUT::PrintPage(), GERBVIEW_PRINTOUT::setupGal(), PCBNEW_PRINTOUT::setupGal(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), and PL_DRAW_PANEL_GAL::SwitchBackend().

◆ SetZoomFactor()

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

Definition at line 657 of file graphics_abstraction_layer.h.

References m_zoomFactor.

Referenced by BOARD_PRINTOUT::DrawPage(), GAL(), and SCH_PRINTOUT::PrintPage().

◆ Show()

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

Show/hide the GAL canvas.

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

Definition at line 259 of file graphics_abstraction_layer.h.

◆ StartDiffLayer()

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

Begins rendering of a differential layer.

Used by gerbview's differential mode.

Differential layers have their drawn objects blended onto the lower layers differently so we need to end drawing of current objects and start a new set to be completed with a different blend mode.

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

Definition at line 755 of file graphics_abstraction_layer.h.

◆ StartNegativesLayer()

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

Begins rendering in a new layer that will be copied to the main layer in EndNegativesLayer().

For Cairo, layers with negative items need a new layer so when negative layers _CLEAR sections it doesn't delete drawings on layers below them. No-op in OpenGL

Reimplemented in KIGFX::CAIRO_GAL.

Definition at line 772 of file graphics_abstraction_layer.h.

◆ storePath()

◆ syncLineWidth()

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

◆ ToScreen()

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

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

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

Definition at line 953 of file graphics_abstraction_layer.h.

References m_worldScreenMatrix.

Referenced by KIGFX::CAIRO_GAL_BASE::blitCursor(), and KIGFX::PREVIEW::RULER_ITEM::ViewDraw().

◆ ToWorld()

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

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

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

Definition at line 942 of file graphics_abstraction_layer.h.

References m_screenWorldMatrix.

◆ Transform()

void CAIRO_GAL_BASE::Transform ( const MATRIX3x3D & aTransformation)
overridevirtual

Transform the context.

Parameters
aTransformationis the transformation matrix.

Reimplemented from KIGFX::GAL.

Definition at line 700 of file cairo_gal.cpp.

References m_currentXform, MATRIX3x3< T >::m_data, and updateWorldScreenMatrix().

◆ Translate()

void CAIRO_GAL_BASE::Translate ( const VECTOR2D & aTranslation)
overridevirtual

◆ UnlockContext()

virtual void KIGFX::GAL::UnlockContext ( int aClientCookie)
inlinevirtualinherited

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1018 of file graphics_abstraction_layer.h.

◆ updatedGalDisplayOptions()

bool GAL::updatedGalDisplayOptions ( const GAL_DISPLAY_OPTIONS & aOptions)
protectedvirtualinherited

Handle updating display options.

Derived classes should call up to this to set base-class methods.

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

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

Definition at line 112 of file graphics_abstraction_layer.cpp.

References m_axesEnabled, m_crossHairMode, m_forceDisplayCursor, m_gridLineWidth, m_gridMinSpacing, m_gridStyle, m_options, and refresh.

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

◆ updateWorldScreenMatrix()

void CAIRO_GAL_BASE::updateWorldScreenMatrix ( )
protected

◆ xform() [1/3]

const VECTOR2D CAIRO_GAL_BASE::xform ( const VECTOR2D & aP)
protected

Definition at line 123 of file cairo_gal.cpp.

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

◆ xform() [2/3]

◆ xform() [3/3]

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

Definition at line 113 of file cairo_gal.cpp.

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

Member Data Documentation

◆ GAL_FORMAT

cairo_format_t KIGFX::CAIRO_GAL_BASE::GAL_FORMAT = CAIRO_FORMAT_ARGB32
staticconstexprprotected

Format used to store pixels.

Definition at line 376 of file cairo_gal.h.

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

◆ GRID_DEPTH

const int GAL::GRID_DEPTH = MAX_DEPTH - 1
staticprotectedinherited

Depth level on which the grid is drawn.

Definition at line 1064 of file graphics_abstraction_layer.h.

◆ m_attributes

◆ m_axesColor

COLOR4D KIGFX::GAL::m_axesColor
protectedinherited

Color of the axes.

Definition at line 1142 of file graphics_abstraction_layer.h.

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

◆ m_axesEnabled

bool KIGFX::GAL::m_axesEnabled
protectedinherited

◆ m_cairoWorldScreenMatrix

cairo_matrix_t KIGFX::CAIRO_GAL_BASE::m_cairoWorldScreenMatrix
protected

Cairo world to screen transform matrix.

Definition at line 364 of file cairo_gal.h.

Referenced by CAIRO_GAL_BASE(), resetContext(), and updateWorldScreenMatrix().

◆ m_clearColor

◆ m_context

◆ m_crossHairMode

KIGFX::CROSS_HAIR_MODE KIGFX::GAL::m_crossHairMode
protectedinherited

◆ m_currentContext

◆ m_currentGroup

GROUP* KIGFX::CAIRO_GAL_BASE::m_currentGroup
protected

◆ m_currentNativeCursor

KICURSOR KIGFX::GAL::m_currentNativeCursor
protectedinherited

◆ m_currentWorld2Screen

cairo_matrix_t KIGFX::CAIRO_GAL_BASE::m_currentWorld2Screen
protected

◆ m_currentXform

cairo_matrix_t KIGFX::CAIRO_GAL_BASE::m_currentXform
protected

◆ m_cursorColor

COLOR4D KIGFX::GAL::m_cursorColor
protectedinherited

Cursor color.

Definition at line 1152 of file graphics_abstraction_layer.h.

Referenced by getCursorColor(), and SetCursorColor().

◆ m_cursorPosition

VECTOR2D KIGFX::GAL::m_cursorPosition
protectedinherited

◆ m_depthRange

VECTOR2D KIGFX::GAL::m_depthRange
protectedinherited

◆ m_depthStack

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

Stored depth values.

Definition at line 1106 of file graphics_abstraction_layer.h.

◆ m_fillColor

◆ m_forceDisplayCursor

bool KIGFX::GAL::m_forceDisplayCursor
protectedinherited

Always show cursor.

Definition at line 1151 of file graphics_abstraction_layer.h.

Referenced by GAL(), IsCursorEnabled(), and updatedGalDisplayOptions().

◆ m_globalFlipX

bool KIGFX::GAL::m_globalFlipX
protectedinherited

◆ m_globalFlipY

bool KIGFX::GAL::m_globalFlipY
protectedinherited

◆ m_gridColor

◆ m_gridLineWidth

float KIGFX::GAL::m_gridLineWidth
protectedinherited

◆ m_gridMinSpacing

int KIGFX::GAL::m_gridMinSpacing
protectedinherited

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

Definition at line 1146 of file graphics_abstraction_layer.h.

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

◆ m_gridOffset

VECTOR2D KIGFX::GAL::m_gridOffset
protectedinherited

The grid offset to compensate cursor position.

Definition at line 1140 of file graphics_abstraction_layer.h.

Referenced by GetGridPoint(), SetGridOrigin(), and SetGridSize().

◆ m_gridOrigin

VECTOR2D KIGFX::GAL::m_gridOrigin
protectedinherited

◆ m_gridSize

VECTOR2D KIGFX::GAL::m_gridSize
protectedinherited

◆ m_gridStyle

GRID_STYLE KIGFX::GAL::m_gridStyle
protectedinherited

◆ m_gridTick

int KIGFX::GAL::m_gridTick
protectedinherited

Every tick line gets the double width.

Definition at line 1144 of file graphics_abstraction_layer.h.

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

◆ m_gridVisibility

bool KIGFX::GAL::m_gridVisibility
protectedinherited

◆ m_groupCounter

unsigned int KIGFX::CAIRO_GAL_BASE::m_groupCounter
protected

Counter used for generating group keys.

Definition at line 358 of file cairo_gal.h.

Referenced by CAIRO_GAL_BASE(), and getNewGroupNumber().

◆ m_groups

std::map<int, GROUP> KIGFX::CAIRO_GAL_BASE::m_groups
protected

List of graphic groups.

Definition at line 357 of file cairo_gal.h.

Referenced by BeginGroup(), ChangeGroupColor(), ClearCache(), DeleteGroup(), DrawGroup(), and getNewGroupNumber().

◆ m_imageSurfaces

std::vector<cairo_surface_t*> KIGFX::CAIRO_GAL_BASE::m_imageSurfaces
protected

List of surfaces that were created by painting images, to be cleaned up later.

Definition at line 372 of file cairo_gal.h.

Referenced by DrawBitmap(), resetContext(), and ~CAIRO_GAL_BASE().

◆ m_isCursorEnabled

bool KIGFX::GAL::m_isCursorEnabled
protectedinherited

Is the cursor enabled?

Definition at line 1150 of file graphics_abstraction_layer.h.

Referenced by getCursorColor(), IsCursorEnabled(), and SetCursorEnabled().

◆ m_isElementAdded

bool KIGFX::CAIRO_GAL_BASE::m_isElementAdded
protected

◆ m_isFillEnabled

◆ m_isGrouping

bool KIGFX::CAIRO_GAL_BASE::m_isGrouping
protected

◆ m_isStrokeEnabled

◆ m_layerDepth

◆ m_lineWidth

◆ m_lineWidthInPixels

double KIGFX::CAIRO_GAL_BASE::m_lineWidthInPixels
protected

◆ m_lineWidthIsOdd

bool KIGFX::CAIRO_GAL_BASE::m_lineWidthIsOdd
protected

Definition at line 362 of file cairo_gal.h.

Referenced by CAIRO_GAL_BASE(), DrawGrid(), roundp(), and syncLineWidth().

◆ m_lookAtPoint

VECTOR2D KIGFX::GAL::m_lookAtPoint
protectedinherited

◆ m_minLineWidth

float KIGFX::GAL::m_minLineWidth
protectedinherited

Minimum line width in pixels.

Definition at line 1123 of file graphics_abstraction_layer.h.

Referenced by GetMinLineWidth(), and SetMinLineWidth().

◆ m_observerLink

UTIL::LINK KIGFX::GAL::m_observerLink
protectedinherited

Definition at line 1104 of file graphics_abstraction_layer.h.

Referenced by GAL().

◆ m_options

◆ m_rotation

double KIGFX::GAL::m_rotation
protectedinherited

Rotation transformation (radians)

Definition at line 1114 of file graphics_abstraction_layer.h.

Referenced by ComputeWorldScreenMatrix(), GetRotation(), and SetRotation().

◆ m_screenDPI

double KIGFX::GAL::m_screenDPI
protectedinherited

◆ m_screenSize

◆ m_screenWorldMatrix

◆ m_strokeColor

◆ m_surface

cairo_surface_t* KIGFX::CAIRO_GAL_BASE::m_surface
protected

◆ m_worldScale

◆ m_worldScreenMatrix

◆ m_worldUnitLength

double KIGFX::GAL::m_worldUnitLength
protectedinherited

◆ m_xformStack

std::vector<cairo_matrix_t> KIGFX::CAIRO_GAL_BASE::m_xformStack
protected

Definition at line 374 of file cairo_gal.h.

Referenced by Restore(), and Save().

◆ m_zoomFactor

double KIGFX::GAL::m_zoomFactor
protectedinherited

◆ MAX_CAIRO_ARGUMENTS

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

Maximum number of arguments for one command.

Definition at line 319 of file cairo_gal.h.

◆ MAX_DEPTH

const int GAL::MAX_DEPTH = 2*MAX_LAYERS_FOR_VIEW - 1
staticprotectedinherited

Definition at line 1061 of file graphics_abstraction_layer.h.

Referenced by GAL().

◆ MIN_DEPTH

const int GAL::MIN_DEPTH = -2*MAX_LAYERS_FOR_VIEW
staticprotectedinherited

Possible depth range.

Definition at line 1060 of file graphics_abstraction_layer.h.

Referenced by GAL().


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