#include <cairo_gal.h>

Inheritance diagram for KIGFX::CAIRO_GAL_BASE:

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	DrawEllipse (const VECTOR2D &aCenterPoint, double aMajorRadius, double aMinorRadius, const EDA_ANGLE &aRotation) override
	Draw a closed ellipse.

void	DrawEllipseArc (const VECTOR2D &aCenterPoint, double aMajorRadius, double aMinorRadius, const EDA_ANGLE &aRotation, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aEndAngle) override
	Draw an elliptical arc in world coordinates.

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
	Draw the grid.

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 bool	RefillsNonCachedTargets () const
	Return true if the backend empties every non-cached target each frame, so VIEW must emit them again even when clean.

virtual bool	HasStaticRebuildPending () const
	Return true if the backend dropped its cached geometry and VIEW must draw the cached layers again, even when its own TARGET_CACHED is clean.

virtual bool	HasRetainedScene () const
	Return true if the backend keeps cached groups in a persistent scene that it patches in place, so one changed item does not make VIEW emit every cached layer again.

virtual void	BeginSceneLayer (int aLayer)
	Open a cached layer of the retained scene during a rebuild.

virtual void	SetSceneLayerState (int aLayer, int aOrder, bool aVisible, bool aHasNegatives)
	Describe a cached layer to the retained scene.

virtual void	SetSceneLayerDim (int aLayer, const COLOR4D &aToward, double aKeep)
	Fade a cached layer towards a colour in the shader, so dimming it recolours none of its groups.

virtual void	SetSceneLayerOverlayAlpha (int aLayer)
	Blend a cached layer the way the other canvases blend the overlay they draw it in.

virtual void	SetSceneDrawOrdered (bool aOrdered)
	Tell the retained scene whether cached groups are placed in an order that matters.

virtual void	SetGroupPlacement (int aGroup, int aLayer, double aLodScale, bool aShown, const RETAINED_GROUP_ORDER &aOrder)
	Declare where a cached group belongs in the retained scene.

virtual void	SetSceneScale (double aScale)
	Set the view scale that group placements are tested against.

virtual bool	IsDrawingMode () const
	Return true if the GAL is inside a BeginDrawing/EndDrawing pair.

virtual bool	SupportsTypedPads () const
	Return true if DrawPad() renders every standard pad shape.

virtual bool	UsesPolygonTriangulationCache () const
	Return true if filled polygons are drawn from the SHAPE_POLY_SET triangulation cache, which painters should then fill before calling DrawPolygon.

virtual void	DrawTrack (const VECTOR2D &aStart, const VECTOR2D &aEnd, double aWidth, const COLOR4D &aColor)
	Draw a filled track capsule in aColor without touching the fill and stroke state.

virtual void	DrawPad (const VECTOR2D &aCenter, double aHalfWidth, double aHalfHeight, double aCornerRadius, float aShapeType, double aRotation, const COLOR4D &aColor)
	Draw a filled pad as one primitive in aColor.

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

void	DrawRectangle (const BOX2I &aRect)

virtual bool	Show (bool aShow)
	Show/hide the GAL canvas.

const VECTOR2I &	GetScreenPixelSize () const
	Return GAL canvas size in pixels.

virtual VECTOR2I	GetLayoutPixelSize () const
	Return the size the view is centred in and panned by.

virtual int	GetSwapInterval () const
	Return the swap interval. -1 for adaptive, 0 for disabled/unknown.

virtual void	MarkStaticDirty ()
	Make a backend that keeps a static geometry pool rebuild it on the next frame.

void	SetClearColor (const COLOR4D &aColor)

const COLOR4D &	GetClearColor () const

bool	GetIsFill () const
	Get the fill status.

bool	GetIsStroke () const
	Get the stroke status.

const COLOR4D &	GetFillColor () const
	Get the fill color.

virtual void	SetHoverColor (const COLOR4D &aColor)

const COLOR4D &	GetStrokeColor () 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 VECTOR2I &	GetGlyphSize () 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 std::array< uint64_t, 2 >	GroupContentFingerprint (int aGroupNumber) const

virtual void	ChangeGroupUndimmed (int aGroupNumber, bool aUndimmed)
	Exempt the group from its layer's dim, see SetSceneLayerDim().

virtual void	ComputeWorldScreenMatrix ()
	Compute the world <-> screen transformation matrix.

const MATRIX3x3D &	GetWorldScreenMatrix () const
	Get the world <-> screen transformation matrix.

const MATRIX3x3D &	GetScreenWorldMatrix () 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.

double	GetWorldUnitLength () const

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 VECTOR2D &	GetLookAtPoint () 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.

double	GetWorldScaleForScreenSpace () const
	Get the world scale to size something drawn in screen space mode.

bool	WorldScaleBelow (double aLimit) const
	Tell whether the world scale is below a limit.

void	TakeWorldScaleLimits (double &aBelow, double &aAbove) const
	Give and forget the nearest limits on either side of the scale passed to WorldScaleBelow().

bool	TakeWorldScaleRead () const
	Tell whether GetWorldScale() or a transformation matrix was read since the last call.

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	SetScreenSpaceMode (bool aEnabled)
	Store sizes of what is drawn next in pixels rather than world units, so it keeps its pixel size through a zoom without being drawn again.

virtual bool	SupportsStrokePixelPad () const
	Tell whether strokes can carry part of their width in pixels, see SetStrokePixelPad().

virtual bool	SupportsStrokeLengthPad () const
	Tell whether strokes can be longer by a number of pixels, see SetStrokeLengthPad().

virtual void	SetStrokeLengthPad (double aPixels)
	Extend every stroke drawn from now on by aPixels at each end.

virtual void	SetStrokePixelPad (double aPixels)
	Widen every stroke, circle and pad drawn from now on by aPixels.

virtual bool	SupportsStrokeLevelOfDetail () const
	Tell whether strokes can carry a level of detail, see SetStrokeLevelOfDetail().

virtual void	SetStrokeLevelOfDetail (double aLod)
	Show every stroke drawn from now on only while the view scale is above aLod, as VIEW::IsShownAtScale() decides.

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 VECTOR2D &	GetGridOrigin () const

void	SetGridSize (const VECTOR2D &aGridSize)
	Set the grid size.

const VECTOR2D &	GetGridSize () 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.

void	SetGridSources (std::vector< GRID_SOURCE > aSources)
	Set the grid-source list rendered alongside the display grid.

const std::vector< GRID_SOURCE > &	GetGridSources () const

GRID_STYLE	GetGridStyle () const

int	GetCoarseGrid () const

const COLOR4D &	GetGridColor () const

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 bool	IsContextValid () const
	Check whether the locked context is actually the current one.

virtual GAL_CONTEXT_LOSS	GetContextLoss () const
	Check whether a GPU reset destroyed this canvas' rendering context.

virtual bool	IsResetSettled ()
	Check whether the driver has finished the reset that destroyed this canvas' context.

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_ELEMENT >	GROUP
	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, const COLOR4D &aColor)
	Draw a grid line (usually a simplified line function).

void	drawGridCross (const VECTOR2D &aPoint, const COLOR4D &aColor)

void	drawGridPoint (const VECTOR2D &aPoint, double aWidth, double aHeight, const COLOR4D &aColor)

void	drawAxes (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)

void	drawGridSources ()
	Render m_gridSources precedence-ascending; each bounded source paints its coverage out first, so the last drawn wins.

void	drawGridSource (const GRID_SOURCE &aSrc)
	Paint one source: coverage wash, grid content, then hairline.

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.

float	gridMinorLineWidth (double aWorldPixelSize, double aScaleFactor) const
	Compute the world width of a minor grid line.

BOX2D	gridScreenBBox (const GRID_SOURCE &aSrc) const

GRID_LATTICE	gridLattice (const GRID_SOURCE &aSrc) const
	Thin a grid source's pitch out until its lines are far enough apart on screen.

COLOR4D	gridSourceColor (const GRID_SOURCE &aSrc) const
	The colour a grid source is drawn in, brightened while it is being edited.

void	drawGridCoverageShape (const GRID_SOURCE &aSrc)
	Draw the area a grid source covers in its own frame with the current fill and stroke.

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.

Static Protected Member Functions
static double	calcAngleStep (double aRadius)
	Compute the angle step when drawing arcs/circles approximated with lines.

Protected Attributes
bool	m_isGrouping
	Is grouping enabled ?

bool	m_isElementAdded
	Was an graphic element added ?

std::map< int, GROUP >	m_groups
	List of graphic groups.

unsigned int	m_groupCounter
	Counter used for generating group keys.

GROUP *	m_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_OPTIONS &	m_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_worldScaleRead = false
	see TakeWorldScaleRead()

double	m_scaleLimitBelow = 0.0
	see TakeWorldScaleLimits()

double	m_scaleLimitAbove = std::numeric_limits<double>::max()

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

COLOR4D	m_hoverColor
	Color for hovered (active) links.

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.

std::vector< GRID_SOURCE >	m_gridSources
	Sources overlayed on the display grid.

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 constexpr int	SEG_PER_CIRCLE_COUNT = 64
	The default number of segments approximating a full circle.

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

◆ super

typedef GAL KIGFX::CAIRO_GAL_BASE::super

protected

Super class definition.

Definition at line 335 of file cairo_gal.h.

Member Enumeration Documentation

◆ GRAPHICS_COMMAND

enum KIGFX::CAIRO_GAL_BASE::GRAPHICS_COMMAND

protected

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

Constructor & Destructor Documentation

◆ CAIRO_GAL_BASE()

CAIRO_GAL_BASE::CAIRO_GAL_BASE ( GAL_DISPLAY_OPTIONS & aDisplayOptions )

Definition at line 50 of file cairo_gal.cpp.

References BLUE, KIGFX::GAL::GAL(), m_cairoWorldScreenMatrix, m_context, m_currentContext, m_currentGroup, m_currentWorld2Screen, m_currentXform, m_groupCounter, m_isElementAdded, m_isGrouping, KIGFX::GAL::m_lineWidth, m_lineWidthInPixels, m_lineWidthIsOdd, m_surface, KIGFX::GAL::SetAxesColor(), and KIGFX::GAL::SetGridColor().

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

◆ ~CAIRO_GAL_BASE()

CAIRO_GAL_BASE::~CAIRO_GAL_BASE ( )

Definition at line 78 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 683 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

aAngle is the angle in radians to transform.

Returns: the modified angle.

Definition at line 128 of file cairo_gal.cpp.

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

Referenced by arc_angles_xform_and_normalize(), DrawEllipse(), and DrawEllipseArc().

◆ 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

aStartAngle	is the arc starting point in radians to transform
aEndAngle	is the arc ending point in radians to transform

Definition at line 142 of file cairo_gal.cpp.

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

Referenced by DrawArc(), DrawArcSegment(), and DrawEllipseArc().

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

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

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

◆ BeginSceneLayer()

virtual void KIGFX::GAL::BeginSceneLayer ( int aLayer )

inlinevirtualinherited

Open a cached layer of the retained scene during a rebuild.

Layers draw in the order they are opened, at the current layer depth.

Parameters

aLayer is the VIEW layer id.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 195 of file graphics_abstraction_layer.h.

◆ beginUpdate()

virtual void KIGFX::GAL::beginUpdate ( )

inlineprotectedvirtualinherited

Enable item update mode.

Private: use GAL_UPDATE_CONTEXT RAII object

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

Definition at line 1428 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

aText	is the text to be drawn.
aPosition	is the text position in world coordinates.
aAngle	is the text rotation angle.

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

Definition at line 450 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::GAL_MODERN::BitmapText(), KIGFX::OPENGL_GAL::BitmapText(), KIGFX::bitmapText(), KIGFX::PREVIEW::ANGLE_ITEM::drawPreviewShape(), and KIGFX::VIEW_OVERLAY::COMMAND_BITMAP_TEXT::Execute().

◆ blitCursor()

void CAIRO_GAL_BASE::blitCursor ( wxMemoryDC & clientDC )

protected

Blit cursor into the current screen.

Definition at line 1273 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::FULLSCREEN_CROSS, KIGFX::FULLSCREEN_DIAGONAL, KIGFX::COLOR4D::g, KIGFX::GAL::getCursorColor(), KIGFX::GAL::IsCursorEnabled(), KIGFX::GAL::m_crossHairMode, KIGFX::GAL::m_cursorPosition, KIGFX::GAL::m_screenSize, KIGFX::COLOR4D::r, KIGFX::GAL::ToScreen(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ calcAngleStep()

static double KIGFX::GAL::calcAngleStep ( double aRadius )

inlinestaticprotectedinherited

Compute the angle step when drawing arcs/circles approximated with lines.

Bigger arcs need smaller alpha increment to make them look smooth

Definition at line 1469 of file graphics_abstraction_layer.h.

References M_PI, and SEG_PER_CIRCLE_COUNT.

Referenced by KIGFX::GAL_MODERN::DrawArc(), KIGFX::OPENGL_GAL::DrawArc(), KIGFX::OPENGL_GAL::DrawEllipse(), and KIGFX::OPENGL_GAL::DrawEllipseArc().

◆ ChangeGroupColor()

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

overridevirtual

Change the color used to draw the group.

Parameters

aGroupNumber	is the group number.
aNewColor	is the new color.

Reimplemented from KIGFX::GAL.

Definition at line 1004 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

aGroupNumber	is the group number.
aDepth	is the new depth.

Reimplemented from KIGFX::GAL.

Definition at line 1021 of file cairo_gal.cpp.

◆ ChangeGroupUndimmed()

virtual void KIGFX::GAL::ChangeGroupUndimmed	(	int	aGroupNumber,
		bool	aUndimmed )

inlinevirtualinherited

Exempt the group from its layer's dim, see SetSceneLayerDim().

Parameters

aGroupNumber	is the group number.
aUndimmed	is true to keep the group's colour while its layer is dimmed.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 827 of file graphics_abstraction_layer.h.

◆ ClearCache()

void CAIRO_GAL_BASE::ClearCache ( )

overridevirtual

Delete all data created during caching of graphic items.

Reimplemented from KIGFX::GAL.

Definition at line 1046 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.

Reimplemented from KIGFX::GAL.

Definition at line 671 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

aTarget is the target to be cleared.

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

Definition at line 1032 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 266 of file graphics_abstraction_layer.cpp.

References m_gridMinSpacing.

Referenced by GetVisibleGridSize(), and gridLattice().

◆ computeWorldScale()

void KIGFX::GAL::computeWorldScale ( )

inlineprotectedinherited

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

Definition at line 1436 of file graphics_abstraction_layer.h.

References PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::m_Appearance, m_screenDPI, m_worldScale, m_worldUnitLength, m_zoomFactor, PgmOrNull(), and COMMON_SETTINGS::APPEARANCE::zoom_correction_factor.

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

◆ ComputeWorldScreenMatrix()

void GAL::ComputeWorldScreenMatrix ( )

virtualinherited

Compute the world <-> screen transformation matrix.

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

Definition at line 220 of file graphics_abstraction_layer.cpp.

References computeWorldScale(), GetLayoutPixelSize(), m_globalFlipX, m_globalFlipY, m_lookAtPoint, m_rotation, m_screenWorldMatrix, m_worldScale, m_worldScreenMatrix, scale, MATRIX3x3< T >::SetIdentity(), MATRIX3x3< T >::SetRotation(), MATRIX3x3< T >::SetScale(), MATRIX3x3< T >::SetTranslation(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by KIGFX::OPENGL_GAL::ComputeWorldScreenMatrix(), KIGFX::CAIRO_GAL_BASE::resetContext(), and KIGFX::GAL_MODERN::ResizeScreen().

◆ DeleteGroup()

void CAIRO_GAL_BASE::DeleteGroup ( int aGroupNumber )

overridevirtual

Delete the group from the memory.

Parameters

aGroupNumber is the group number.

Reimplemented from KIGFX::GAL.

Definition at line 1028 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

aCenterPoint	is the center point of the arc.
aRadius	is the arc radius.
aStartAngle	is the start angle of the arc.
aAngle	is the angle of the arc.

Reimplemented from KIGFX::GAL.

Definition at line 346 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(), and drawGridSource().

◆ 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

aCenterPoint	is the center point of the arc.
aRadius	is the arc radius.
aStartAngle	is the start angle of the arc.
aAngle	is the angle of the arc.
aWidth	is the thickness of the arc (pen size).
aMaxError	is 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 390 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

Definition at line 1128 of file cairo_gal.cpp.

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

Referenced by DrawGrid().

◆ DrawBitmap()

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

overridevirtual

Draw a bitmap image.

Reimplemented from KIGFX::GAL.

Definition at line 579 of file cairo_gal.cpp.

References BITMAP_BASE::GetImageData(), BITMAP_BASE::GetPPI(), BITMAP_BASE::GetSizePixels(), image, m_currentContext, m_currentWorld2Screen, m_imageSurfaces, m_isElementAdded, KIGFX::GAL::m_worldUnitLength, scale, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ DrawCircle()

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

overridevirtual

Draw a circle using world coordinates.

Parameters

aCenterPoint	is the center point of the circle.
aRadius	is the radius of the circle.

Reimplemented from KIGFX::GAL.

Definition at line 330 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

aCursorPosition is the cursor position in screen coordinates.

Reimplemented from KIGFX::GAL.

Definition at line 1085 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

startPoint	is the start point of the spline.
controlPointA	is the first control point.
controlPointB	is the second control point.
endPoint	is the end point of the spline.
aFilterValue	is 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 557 of file cairo_gal.cpp.

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

◆ DrawEllipse()

void CAIRO_GAL_BASE::DrawEllipse	(	const VECTOR2D &	aCenterPoint,
		double	aMajorRadius,
		double	aMinorRadius,
		const EDA_ANGLE &	aRotation )

overridevirtual

Draw a closed ellipse.

Parameters

aCenterPoint	center of the ellipse.
aMajorRadius	major semi-axis length.
aMinorRadius	minor semi-axis length.
aRotation	rotation of the major axis from world X, CCW.

Reimplemented from KIGFX::GAL.

Definition at line 450 of file cairo_gal.cpp.

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

◆ DrawEllipseArc()

void CAIRO_GAL_BASE::DrawEllipseArc	(	const VECTOR2D &	aCenterPoint,
		double	aMajorRadius,
		double	aMinorRadius,
		const EDA_ANGLE &	aRotation,
		const EDA_ANGLE &	aStartAngle,
		const EDA_ANGLE &	aEndAngle )

overridevirtual

Draw an elliptical arc in world coordinates.

Parameters

aCenterPoint	center of the parent ellipse.
aMajorRadius	major semi-axis length.
aMinorRadius	minor semi-axis length.
aRotation	rotation of the major axis from world X, CCW.
aStartAngle	sweep start angle in the ellipse local frame, CCW.
aEndAngle	sweep end angle in the ellipse local frame, CCW.

Reimplemented from KIGFX::GAL.

Definition at line 480 of file cairo_gal.cpp.

References angle_xform(), arc_angles_xform_and_normalize(), EDA_ANGLE::AsRadians(), flushPath(), m_currentContext, m_isElementAdded, KIGFX::GAL::m_isFillEnabled, m_lineWidthInPixels, 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

Draw a polygon representing a font glyph.

Reimplemented from KIGFX::GAL.

Definition at line 2092 of file cairo_gal.cpp.

References drawPoly(), flushPath(), KIFONT::GLYPH::IsOutline(), KIFONT::GLYPH::IsStroke(), m_currentContext, m_isElementAdded, roundp(), SetIsFill(), SetIsStroke(), syncLineWidth(), KIFONT::OUTLINE_GLYPH::Triangulate(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

Referenced by DrawGlyphs().

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

References DrawGlyph().

◆ DrawGrid()

void CAIRO_GAL_BASE::DrawGrid ( )

overridevirtual

◆ drawGridCoverageShape()

void GAL::drawGridCoverageShape ( const GRID_SOURCE & aSrc )

protectedinherited

Draw the area a grid source covers in its own frame with the current fill and stroke.

An unbounded source covers the screen.

Definition at line 359 of file graphics_abstraction_layer.cpp.

References GRID_GEOMETRY::CARTESIAN, DrawCircle(), DrawPolygon(), DrawRectangle(), GRID_GEOMETRY::extent, BOX2< Vec >::GetEnd(), BOX2< Vec >::GetOrigin(), gridScreenBBox(), GRID_GEOMETRY::kind, M_PI, GRID_GEOMETRY::orientation, GRID_GEOMETRY::origin, Restore(), Rotate(), Save(), Translate(), KIGFX::GRID_SOURCE::unbounded, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by KIGFX::CAIRO_GAL_BASE::drawGridSource(), KIGFX::GAL_MODERN::drawGridSource(), and KIGFX::OPENGL_GAL::drawGridSources().

◆ drawGridCross()

void CAIRO_GAL_BASE::drawGridCross	(	const VECTOR2D &	aPoint,
		const COLOR4D &	aColor )

protected

Definition at line 1160 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::COLOR4D::g, m_currentContext, m_lineWidthInPixels, KIGFX::COLOR4D::r, roundp(), syncLineWidth(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

◆ drawGridLine()

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

protected

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

Parameters

aStartPoint	is the start point of the line.
aEndPoint	is the end point of the line.
aColor	is the colour to stroke it in.

Definition at line 1146 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::COLOR4D::g, m_currentContext, KIGFX::COLOR4D::r, roundp(), syncLineWidth(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

Referenced by drawGridSource().

◆ drawGridPoint()

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

protected

Definition at line 1180 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::COLOR4D::g, m_currentContext, KIGFX::COLOR4D::r, roundp(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

Referenced by drawGridSource().

◆ drawGridSource()

void CAIRO_GAL_BASE::drawGridSource ( const GRID_SOURCE & aSrc )

protected

Paint one source: coverage wash, grid content, then hairline.

The unbounded background source gets neither wash nor hairline.

Definition at line 1910 of file cairo_gal.cpp.

References KIGFX::COLOR4D::a, KIGFX::GRID_SOURCE::axesEnabled, GRID_GEOMETRY::CARTESIAN, KIGFX::COLOR4D::Darkened(), KIGFX::DOTS, DrawArc(), KIGFX::GAL::drawGridCoverageShape(), drawGridLine(), drawGridPoint(), GRID_GEOMETRY::extent, KIGFX::GAL::GRID_LATTICE::extent, BOX2< Vec >::GetBottom(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetTop(), KIGFX::GRID_DIM_ALPHA, KIGFX::GRID_EDGE_DARKEN, KIGFX::GAL::gridLattice(), KIGFX::GAL::gridScreenBBox(), KIGFX::GAL::gridSourceColor(), KIGFX::GRID_SOURCE::highlighted, BOX2< Vec >::Inflate(), KIGFX::GAL::GRID_LATTICE::IsMajor(), GRID_GEOMETRY::kind, KIGFX::LINES, KIGFX::GAL::m_clearColor, KIGFX::GAL::m_gridLineWidth, m_lineWidthIsOdd, KIGFX::GAL::m_worldScale, GRID_GEOMETRY::orientation, GRID_GEOMETRY::origin, KIGFX::GAL::GRID_LATTICE::pitch, GRID_GEOMETRY::POLAR, RADIANS_T, Restore(), Rotate(), Save(), SetFillColor(), SetIsFill(), SetIsStroke(), SetLineWidth(), SetStrokeColor(), KIGFX::GRID_SOURCE::style, Translate(), KIGFX::GRID_SOURCE::unbounded, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by drawGridSources().

◆ drawGridSources()

void CAIRO_GAL_BASE::drawGridSources ( )

protected

Render m_gridSources precedence-ascending; each bounded source paints its coverage out first, so the last drawn wins.

Cairo has no stencil, so paint order stands in.

Definition at line 1887 of file cairo_gal.cpp.

References drawGridSource(), KIGFX::GAL::m_depthRange, KIGFX::GAL::m_gridSources, and SetLayerDepth().

Referenced by DrawGrid().

◆ DrawGroup()

void CAIRO_GAL_BASE::DrawGroup ( int aGroupNumber )

overridevirtual

Draw the stored group.

Parameters

aGroupNumber is the group number.

Reimplemented from KIGFX::GAL.

Definition at line 911 of file cairo_gal.cpp.

References CMD_CALL_GROUP, CMD_FILL_PATH, CMD_RESTORE, CMD_ROTATE, CMD_SAVE, CMD_SCALE, CMD_SET_FILL, CMD_SET_FILLCOLOR, CMD_SET_LINE_WIDTH, CMD_SET_STROKE, CMD_SET_STROKECOLOR, CMD_STROKE_PATH, CMD_TRANSLATE, DrawGroup(), m_currentContext, KIGFX::GAL::m_fillColor, m_groups, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_isStrokeEnabled, KIGFX::GAL::m_strokeColor, and storePath().

Referenced by DrawGroup().

◆ DrawHoleWall()

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

overridevirtual

Draw a hole wall ring.

Parameters

aCenterPoint	is the center point of the hole.
aHoleRadius	is the radius of the hole.
aWallWidth	is the wall thickness.

Reimplemented from KIGFX::GAL.

Definition at line 324 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

aStartPoint	is the start point of the line.
aEndPoint	is the end point of the line.

Reimplemented from KIGFX::GAL.

Definition at line 199 of file cairo_gal.cpp.

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

◆ DrawPad()

virtual void KIGFX::GAL::DrawPad	(	const VECTOR2D &	aCenter,
		double	aHalfWidth,
		double	aHalfHeight,
		double	aCornerRadius,
		float	aShapeType,
		double	aRotation,
		const COLOR4D &	aColor )

inlinevirtualinherited

Draw a filled pad as one primitive in aColor.

Only called when SupportsTypedPads().

Parameters

aShapeType is 0 circle, 1 rect, 2 roundrect, 3 chamfered, 4 oval or 5 trapezoid.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 300 of file graphics_abstraction_layer.h.

◆ drawPoly() [1/4]

void CAIRO_GAL_BASE::drawPoly ( const SHAPE_LINE_CHAIN & aLineChain )

protected

Definition at line 1385 of file cairo_gal.cpp.

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

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

Definition at line 1334 of file cairo_gal.cpp.

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

◆ drawPoly() [4/4]

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

protected

Definition at line 1360 of file cairo_gal.cpp.

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

◆ DrawPolygon() [1/4]

void CAIRO_GAL_BASE::DrawPolygon ( const SHAPE_LINE_CHAIN & aPolySet )

overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 551 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 544 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

aPointList is the list of the polygon points.

Reimplemented from KIGFX::GAL.

Definition at line 123 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 124 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 113 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

aPointList is a list of 2D-Vectors containing the polyline points.

Reimplemented from KIGFX::GAL.

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

References drawPoly().

◆ DrawPolyline() [4/4]

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

inlinevirtualinherited

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

Definition at line 319 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

aPointLists are lists of 2D-Vectors containing the polyline points.

Reimplemented from KIGFX::GAL.

Definition at line 116 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

aStartPoint	is the start point of the rectangle.
aEndPoint	is the end point of the rectangle.

Reimplemented from KIGFX::GAL.

Definition at line 522 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

Definition at line 415 of file graphics_abstraction_layer.h.

References DrawRectangle(), BOX2< Vec >::GetEnd(), and BOX2< Vec >::GetOrigin().

◆ 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

aStartPoint	is the start point of the segment.
aEndPoint	is the end point of the segment.
aWidth	is a width of the segment

Reimplemented from KIGFX::GAL.

Definition at line 256 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

Reimplemented from KIGFX::GAL.

Definition at line 244 of file cairo_gal.cpp.

References SHAPE_LINE_CHAIN::CPoint(), DrawSegment(), SHAPE_LINE_CHAIN::IsClosed(), and SHAPE_LINE_CHAIN::PointCount().

◆ DrawSegmentChain() [2/2]

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

overridevirtual

Draw a chain of rounded segments.

Parameters

aPointList	is a list of 2D-Vectors containing the chain points.
aWidth	is a width of the segments

Reimplemented from KIGFX::GAL.

Definition at line 237 of file cairo_gal.cpp.

References DrawSegment().

◆ DrawTrack()

void GAL::DrawTrack	(	const VECTOR2D &	aStart,
		const VECTOR2D &	aEnd,
		double	aWidth,
		const COLOR4D &	aColor )

virtualinherited

Draw a filled track capsule in aColor without touching the fill and stroke state.

Backends may override it to skip that overhead on the track hot path.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 193 of file graphics_abstraction_layer.cpp.

References DrawSegment(), SetFillColor(), SetIsFill(), SetIsStroke(), and SetStrokeColor().

◆ EnableDepthTest()

void CAIRO_GAL_BASE::EnableDepthTest ( bool aEnabled = false )

overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 1091 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, KIGFX::GAL_MODERN, and KIGFX::OPENGL_GAL.

Definition at line 1104 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 99 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 904 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, and KIGFX::GAL_MODERN.

Definition at line 1120 of file graphics_abstraction_layer.h.

◆ endUpdate()

virtual void KIGFX::GAL::endUpdate ( )

inlineprotectedvirtualinherited

Disable item update mode.

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

Definition at line 1431 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 665 of file cairo_gal.cpp.

References storePath().

Referenced by EndDrawing().

◆ flushPath()

void CAIRO_GAL_BASE::flushPath ( )

protected

Definition at line 1196 of file cairo_gal.cpp.

References m_currentContext, KIGFX::GAL::m_fillColor, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_isStrokeEnabled, m_lineWidthInPixels, and KIGFX::GAL::m_strokeColor.

Referenced by DrawArc(), DrawArcSegment(), DrawCircle(), DrawCurve(), DrawEllipse(), DrawEllipseArc(), DrawGlyph(), DrawLine(), drawPoly(), drawPoly(), drawPoly(), drawPoly(), DrawRectangle(), and DrawSegment().

◆ GetClearColor()

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

inlineinherited

Definition at line 519 of file graphics_abstraction_layer.h.

References m_clearColor.

Referenced by EDIT_POINTS::ViewDraw().

◆ GetCoarseGrid()

int KIGFX::GAL::GetCoarseGrid ( ) const

inlineinherited

Definition at line 1280 of file graphics_abstraction_layer.h.

References m_gridTick.

◆ GetContextLoss()

virtual GAL_CONTEXT_LOSS KIGFX::GAL::GetContextLoss ( ) const

inlinevirtualinherited

Check whether a GPU reset destroyed this canvas' rendering context.

A lost canvas cannot draw or update cached items until its owner rebuilds it.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1391 of file graphics_abstraction_layer.h.

References KIGFX::NONE.

◆ getCursorColor()

COLOR4D GAL::getCursorColor ( ) const

protectedinherited

Get the actual cursor color to draw.

Definition at line 437 of file graphics_abstraction_layer.cpp.

References KIGFX::COLOR4D::a, m_cursorColor, and m_isCursorEnabled.

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

◆ GetFillColor()

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

inlineinherited

Get the fill color.

Returns: the color for filling a outline.

Definition at line 588 of file graphics_abstraction_layer.h.

References m_fillColor.

Referenced by DrawGlyphs().

◆ GetGlyphSize()

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

inlineinherited

Definition at line 712 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by KIGFX::GAL_MODERN::BitmapText(), KIGFX::OPENGL_GAL::BitmapText(), KIGFX::GAL_MODERN::drawBitmapGlyphs(), and KIGFX::PREVIEW::ANGLE_ITEM::drawPreviewShape().

◆ GetGridColor()

const COLOR4D & KIGFX::GAL::GetGridColor ( ) const

inlineinherited

Definition at line 1281 of file graphics_abstraction_layer.h.

References m_gridColor.

◆ GetGridLineWidth()

float KIGFX::GAL::GetGridLineWidth ( ) const

inlineinherited

Get the grid line width.

Returns: the grid line width

Definition at line 1263 of file graphics_abstraction_layer.h.

References m_gridLineWidth.

◆ GetGridOrigin()

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

inlineinherited

Definition at line 1161 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

aPoint is the point for which the grid point is searched.

Returns: The nearest grid point in world coordinates.

Definition at line 405 of file graphics_abstraction_layer.cpp.

References KiROUND(), m_gridOffset, m_gridSize, m_gridSources, 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 1188 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(), DIALOG_FP_EDIT_PAD_TABLE::OnAddRow(), COMMON_TOOLS::PanControl(), and SCH_DRAWING_TOOLS::sizeSheet().

◆ GetGridSnapping()

bool KIGFX::GAL::GetGridSnapping ( ) const

inlineinherited

Definition at line 1135 of file graphics_abstraction_layer.h.

References KIGFX::ALWAYS, m_gridVisibility, m_options, and KIGFX::WITH_GRID.

Referenced by KIGFX::WX_VIEW_CONTROLS::GetRawCursorPosition(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

◆ GetGridSources()

const std::vector< GRID_SOURCE > & KIGFX::GAL::GetGridSources ( ) const

inlineinherited

Definition at line 1277 of file graphics_abstraction_layer.h.

References m_gridSources.

◆ GetGridStyle()

GRID_STYLE KIGFX::GAL::GetGridStyle ( ) const

inlineinherited

Definition at line 1279 of file graphics_abstraction_layer.h.

References m_gridStyle.

◆ GetGridVisibility()

bool KIGFX::GAL::GetGridVisibility ( ) const

inlineinherited

Definition at line 1133 of file graphics_abstraction_layer.h.

References m_gridVisibility.

◆ GetHorizontalJustify()

GR_TEXT_H_ALIGN_T KIGFX::GAL::GetHorizontalJustify ( ) const

inlineinherited

Definition at line 731 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), and KIGFX::GAL_MODERN::drawBitmapGlyphs().

◆ GetIsFill()

bool KIGFX::GAL::GetIsFill ( ) const

inlineinherited

Get the fill status.

Returns: true if fill is enabled, false otherwise.

Definition at line 548 of file graphics_abstraction_layer.h.

References m_isFillEnabled.

◆ GetIsStroke()

bool KIGFX::GAL::GetIsStroke ( ) const

inlineinherited

Get the stroke status.

Returns: true if stroke is enabled, false otherwise.

Definition at line 568 of file graphics_abstraction_layer.h.

References m_isStrokeEnabled.

◆ getLayerDepth()

double KIGFX::GAL::getLayerDepth ( ) const

inlineprivateinherited

Definition at line 1613 of file graphics_abstraction_layer.h.

References m_layerDepth.

◆ GetLayoutPixelSize()

virtual VECTOR2I KIGFX::GAL::GetLayoutPixelSize ( ) const

inlinevirtualinherited

Return the size the view is centred in and panned by.

It is the canvas size unless the canvas lays its view out like one of another size.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 503 of file graphics_abstraction_layer.h.

References m_screenSize.

Referenced by ComputeWorldScreenMatrix().

◆ GetLineWidth()

float KIGFX::GAL::GetLineWidth ( ) const

inlineinherited

Get the line width.

Returns: the actual line width.

Definition at line 643 of file graphics_abstraction_layer.h.

References m_lineWidth.

Referenced by BitmapText(), CALLBACK_GAL::DrawGlyph(), ROUTER_PREVIEW_ITEM::drawLineChain(), and RATSNEST_VIEW_ITEM::ViewDraw().

◆ GetLookAtPoint()

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

inlineinherited

Definition at line 917 of file graphics_abstraction_layer.h.

References m_lookAtPoint.

Referenced by GetVisibleWorldExtents().

◆ GetMaxDepth()

double KIGFX::GAL::GetMaxDepth ( ) const

inlineinherited

Definition at line 938 of file graphics_abstraction_layer.h.

References m_depthRange.

◆ GetMinDepth()

double KIGFX::GAL::GetMinDepth ( ) const

inlineinherited

Definition at line 937 of file graphics_abstraction_layer.h.

References m_depthRange.

Referenced by EDIT_POINTS::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), and KIGFX::VIEW_OVERLAY::ViewDraw().

◆ GetMinLineWidth()

float KIGFX::GAL::GetMinLineWidth ( ) const

inlineinherited

Get the minimum line width in pixels.

Returns: the minimum line width.

Definition at line 653 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 1413 of file cairo_gal.cpp.

References m_groupCounter, and m_groups.

Referenced by BeginGroup().

◆ GetRotation()

double KIGFX::GAL::GetRotation ( ) const

inlineinherited

Definition at line 926 of file graphics_abstraction_layer.h.

References m_rotation.

◆ GetScreenDPI()

double KIGFX::GAL::GetScreenDPI ( ) const

inlineinherited

Definition at line 909 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 494 of file graphics_abstraction_layer.h.

References m_screenSize.

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

◆ GetScreenWorldMatrix()

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

inlineinherited

Get the screen <-> world transformation matrix.

The matrix carries the world scale, so this counts as a read of it, see TakeWorldScaleRead().

Returns: the transformation matrix.

Definition at line 868 of file graphics_abstraction_layer.h.

References m_screenWorldMatrix, and m_worldScaleRead.

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

References m_strokeColor.

Referenced by DrawGlyphs(), KIGFX::PREVIEW::DrawTextNextToCursor(), 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::GAL_MODERN, and KIGFX::OPENGL_GAL.

Definition at line 506 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, KIGFX::GAL_MODERN, and KIGFX::OPENGL_GAL.

Definition at line 1025 of file graphics_abstraction_layer.h.

References KIGFX::TARGET_CACHED.

◆ GetVerticalJustify()

GR_TEXT_V_ALIGN_T KIGFX::GAL::GetVerticalJustify ( ) const

inlineinherited

Definition at line 738 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), and KIGFX::GAL_MODERN::drawBitmapGlyphs().

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

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

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

◆ GetVisibleWorldExtents()

BOX2D GAL::GetVisibleWorldExtents ( ) const

inherited

Returns: the bounding box of the world that is displayed on screen at the moment

Definition at line 251 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()

double KIGFX::GAL::GetWorldScale ( ) const

inlineinherited

Get the world scale.

Returns: the actual world scale factor.

Definition at line 945 of file graphics_abstraction_layer.h.

References m_worldScale, and m_worldScaleRead.

Referenced by KIGFX::DrawDashedLine(), KIGFX::PREVIEW::DrawTextNextToCursor(), drawTicksAlongLine(), KIGFX::PREVIEW::GetConstantGlyphHeight(), SCH_BASE_FRAME::RefreshZoomDependentItems(), CONSTRAINT_BADGE_ITEM::ViewDraw(), KIGFX::CONSTRUCTION_GEOM::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), and RATSNEST_VIEW_ITEM::ViewDraw().

◆ GetWorldScaleForScreenSpace()

double KIGFX::GAL::GetWorldScaleForScreenSpace ( ) const

inlineinherited

Get the world scale to size something drawn in screen space mode.

Such things keep their pixel size at any scale, so unlike GetWorldScale() this is not a read, see TakeWorldScaleRead().

Definition at line 955 of file graphics_abstraction_layer.h.

References m_worldScale.

◆ GetWorldScreenMatrix()

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

inlineinherited

Get the world <-> screen transformation matrix.

The matrix carries the world scale, so this counts as a read of it, see TakeWorldScaleRead().

Returns: the transformation matrix.

Definition at line 855 of file graphics_abstraction_layer.h.

References m_worldScaleRead, and m_worldScreenMatrix.

◆ GetWorldUnitLength()

double KIGFX::GAL::GetWorldUnitLength ( ) const

inlineinherited

Definition at line 898 of file graphics_abstraction_layer.h.

References m_worldUnitLength.

Referenced by CONSTRAINT_BADGE_ITEM::ViewDraw().

◆ GetZoomFactor()

double KIGFX::GAL::GetZoomFactor ( ) const

inlineinherited

Definition at line 920 of file graphics_abstraction_layer.h.

References m_zoomFactor.

Referenced by COMMON_TOOLS::doZoomInOut(), and EDA_DRAW_FRAME::SyncZoomSelectBox().

◆ gridLattice()

GAL::GRID_LATTICE GAL::gridLattice ( const GRID_SOURCE & aSrc ) const

protectedinherited

Thin a grid source's pitch out until its lines are far enough apart on screen.

A cartesian grid keeps the shape of its cells.

Definition at line 308 of file graphics_abstraction_layer.cpp.

References std::abs(), KIGFX::AutoSparsePitch(), computeMinGridSpacing(), GRID_GEOMETRY::extent, KIGFX::GAL::GRID_LATTICE::extent, BOX2< Vec >::GetBottom(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetTop(), gridScreenBBox(), GRID_GEOMETRY::kind, m_gridTick, M_PI, m_worldScale, GRID_GEOMETRY::pitch, KIGFX::GAL::GRID_LATTICE::pitch, GRID_GEOMETRY::POLAR, KIGFX::SMALL_CROSS, KIGFX::GRID_SOURCE::style, KIGFX::GAL::GRID_LATTICE::tick, KIGFX::GRID_SOURCE::tick, KIGFX::GRID_SOURCE::unbounded, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by KIGFX::CAIRO_GAL_BASE::drawGridSource(), KIGFX::GAL_MODERN::drawGridSource(), and KIGFX::OPENGL_GAL::drawGridSources().

◆ gridMinorLineWidth()

float KIGFX::GAL::gridMinorLineWidth	(	double	aWorldPixelSize,
		double	aScaleFactor ) const

inlineprotectedinherited

Compute the world width of a minor grid line.

A major line is twice as wide. Shaders round this to whole pixels, so every canvas must evaluate it in the same order to round the same way.

Parameters

aWorldPixelSize	is the world length of a screen pixel.
aScaleFactor	is the canvas DPI scale factor.

Definition at line 1460 of file graphics_abstraction_layer.h.

References m_gridLineWidth.

Referenced by KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::GAL_MODERN::drawGridSource(), KIGFX::OPENGL_GAL::drawGridSources(), and KIGFX::GAL_MODERN::PopulateCameraUBOs().

◆ gridScreenBBox()

BOX2D GAL::gridScreenBBox ( const GRID_SOURCE & aSrc ) const

protectedinherited

Returns: the visible screen area expressed in aSrc's frame (relative to its origin and counter-rotated by its orientation).

Definition at line 286 of file graphics_abstraction_layer.cpp.

References m_screenSize, m_screenWorldMatrix, BOX2< Vec >::Merge(), GRID_GEOMETRY::orientation, GRID_GEOMETRY::origin, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by drawGridCoverageShape(), KIGFX::CAIRO_GAL_BASE::drawGridSource(), KIGFX::GAL_MODERN::drawGridSource(), KIGFX::OPENGL_GAL::drawGridSources(), and gridLattice().

◆ gridSourceColor()

COLOR4D GAL::gridSourceColor ( const GRID_SOURCE & aSrc ) const

protectedinherited

The colour a grid source is drawn in, brightened while it is being edited.

Definition at line 348 of file graphics_abstraction_layer.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::Brighten(), KIGFX::GRID_SOURCE::color, KIGFX::GRID_SELECTED_BRIGHTEN, KIGFX::GRID_SOURCE::highlighted, and m_gridColor.

Referenced by KIGFX::CAIRO_GAL_BASE::drawGridSource(), KIGFX::GAL_MODERN::drawGridSource(), and KIGFX::OPENGL_GAL::drawGridSources().

◆ GroupContentFingerprint()

virtual std::array< uint64_t, 2 > KIGFX::GAL::GroupContentFingerprint ( int aGroupNumber ) const

inlinevirtualinherited

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 796 of file graphics_abstraction_layer.h.

Referenced by KIGFX::sortRetainedOrder().

◆ HasRetainedScene()

virtual bool KIGFX::GAL::HasRetainedScene ( ) const

inlinevirtualinherited

Return true if the backend keeps cached groups in a persistent scene that it patches in place, so one changed item does not make VIEW emit every cached layer again.

VIEW places each group with SetGroupPlacement() and emits the cached layers through BeginSceneLayer() only while HasStaticRebuildPending(). The scene holds every item, not just the viewport.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 187 of file graphics_abstraction_layer.h.

Referenced by PCB_EDIT_FRAME::redrawNetnames(), APPEARANCE_CONTROLS::setVisibleLayers(), and DS_PROXY_VIEW_ITEM::ViewDraw().

◆ HasStaticRebuildPending()

virtual bool KIGFX::GAL::HasStaticRebuildPending ( ) const

inlinevirtualinherited

Return true if the backend dropped its cached geometry and VIEW must draw the cached layers again, even when its own TARGET_CACHED is clean.

Otherwise the pool would rebuild empty and blank the scene.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 179 of file graphics_abstraction_layer.h.

◆ HasTarget()

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

inlinevirtualinherited

Return true if the target exists.

Parameters

aTarget is the target to be checked.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1039 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 61 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 1368 of file graphics_abstraction_layer.h.

◆ IsContextValid()

virtual bool KIGFX::GAL::IsContextValid ( ) const

inlinevirtualinherited

Check whether the locked context is actually the current one.

A canvas whose native window is already gone cannot be made current. GL commands issued while this is false land in whichever sibling context is still bound.

Returns: True if GL commands may be issued.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1381 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 1340 of file graphics_abstraction_layer.h.

References m_forceDisplayCursor, and m_isCursorEnabled.

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

◆ IsDrawingMode()

virtual bool KIGFX::GAL::IsDrawingMode ( ) const

inlinevirtualinherited

Return true if the GAL is inside a BeginDrawing/EndDrawing pair.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 248 of file graphics_abstraction_layer.h.

◆ IsFlippedX()

bool KIGFX::GAL::IsFlippedX ( ) const

inlineinherited

Definition at line 1006 of file graphics_abstraction_layer.h.

References m_globalFlipX.

Referenced by KIGFX::CAIRO_GAL_BASE::angle_xform(), KIGFX::CAIRO_GAL_BASE::arc_angles_xform_and_normalize(), KIGFX::PREVIEW::DrawTextNextToCursor(), DS_PROXY_VIEW_ITEM::ViewDraw(), ROUTER_STATUS_VIEW_ITEM::ViewDraw(), and TUNING_STATUS_VIEW_ITEM::ViewDraw().

◆ IsFlippedY()

bool KIGFX::GAL::IsFlippedY ( ) const

inlineinherited

Definition at line 1007 of file graphics_abstraction_layer.h.

References m_globalFlipY.

◆ IsFontBold()

bool KIGFX::GAL::IsFontBold ( ) const

inlineinherited

Definition at line 715 of file graphics_abstraction_layer.h.

References m_attributes.

◆ IsFontItalic()

bool KIGFX::GAL::IsFontItalic ( ) const

inlineinherited

Definition at line 718 of file graphics_abstraction_layer.h.

References m_attributes.

◆ IsFontUnderlined()

bool KIGFX::GAL::IsFontUnderlined ( ) const

inlineinherited

Definition at line 721 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::GAL_MODERN, and KIGFX::OPENGL_GAL.

Definition at line 158 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 167 of file graphics_abstraction_layer.h.

◆ IsResetSettled()

virtual bool KIGFX::GAL::IsResetSettled ( )

inlinevirtualinherited

Check whether the driver has finished the reset that destroyed this canvas' context.

Rebuilding before then can fail or hang in the driver.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1401 of file graphics_abstraction_layer.h.

◆ IsTextMirrored()

bool KIGFX::GAL::IsTextMirrored ( ) const

inlineinherited

Definition at line 724 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), and KIGFX::GAL_MODERN::drawBitmapGlyphs().

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

◆ MarkStaticDirty()

virtual void KIGFX::GAL::MarkStaticDirty ( )

inlinevirtualinherited

Make a backend that keeps a static geometry pool rebuild it on the next frame.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 512 of file graphics_abstraction_layer.h.

◆ normalize()

template<typename T>

void KIGFX::GAL::normalize	(	T &	a,
		T &	b )

inlineprotectedinherited

Ensure that the first element is smaller than the second.

Definition at line 1540 of file graphics_abstraction_layer.h.

References T.

Referenced by KIGFX::CAIRO_GAL_BASE::arc_angles_xform_and_normalize(), KIGFX::GAL_MODERN::DrawArc(), KIGFX::OPENGL_GAL::DrawArc(), KIGFX::GAL_MODERN::DrawArcSegment(), KIGFX::OPENGL_GAL::DrawArcSegment(), and KIGFX::OPENGL_GAL::DrawEllipseArc().

◆ OnGalDisplayOptionsChanged()

void GAL::OnGalDisplayOptionsChanged ( const GAL_DISPLAY_OPTIONS & aOptions )

overrideprotectedvirtualinherited

Handler for observer settings changes.

Implements KIGFX::GAL_DISPLAY_OPTIONS_OBSERVER.

Definition at line 105 of file graphics_abstraction_layer.cpp.

References updatedGalDisplayOptions().

◆ RefillsNonCachedTargets()

virtual bool KIGFX::GAL::RefillsNonCachedTargets ( ) const

inlinevirtualinherited

Return true if the backend empties every non-cached target each frame, so VIEW must emit them again even when clean.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 173 of file graphics_abstraction_layer.h.

◆ resetContext()

void CAIRO_GAL_BASE::resetContext ( )

protected

Definition at line 1096 of file cairo_gal.cpp.

References ClearScreen(), KIGFX::GAL::ComputeWorldScreenMatrix(), m_cairoWorldScreenMatrix, m_context, m_currentXform, m_imageSurfaces, m_isElementAdded, KIGFX::GAL::m_lineWidth, KIGFX::GAL::m_worldScreenMatrix, and updateWorldScreenMatrix().

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

◆ 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 204 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::ELLIPSE_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 659 of file cairo_gal.cpp.

References KIGFX::GAL::m_screenSize.

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

◆ Restore()

void CAIRO_GAL_BASE::Restore ( )

overridevirtual

Restore the context.

Reimplemented from KIGFX::GAL.

Definition at line 866 of file cairo_gal.cpp.

References CMD_RESTORE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Command, m_currentGroup, m_currentXform, m_isGrouping, m_xformStack, storePath(), and updateWorldScreenMatrix().

Referenced by drawGridSource().

◆ Rotate()

void CAIRO_GAL_BASE::Rotate ( double aAngle )

overridevirtual

Rotate the context.

Parameters

aAngle is the rotation angle in radians.

Reimplemented from KIGFX::GAL.

Definition at line 789 of file cairo_gal.cpp.

References CMD_ROTATE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::DblArg, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Argument, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Command, m_currentGroup, m_currentXform, m_isGrouping, storePath(), and updateWorldScreenMatrix().

Referenced by drawGridSource().

◆ roundp()

const VECTOR2D CAIRO_GAL_BASE::roundp ( const VECTOR2D & v )

protected

Definition at line 190 of file cairo_gal.cpp.

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

Referenced by DrawArc(), drawAxes(), DrawCircle(), DrawCurve(), DrawEllipse(), DrawEllipseArc(), DrawGlyph(), drawGridCross(), drawGridLine(), drawGridPoint(), DrawLine(), drawPoly(), drawPoly(), drawPoly(), drawPoly(), DrawRectangle(), DrawSegment(), and roundp().

◆ Save()

void CAIRO_GAL_BASE::Save ( )

overridevirtual

Save the context.

Reimplemented from KIGFX::GAL.

Definition at line 848 of file cairo_gal.cpp.

References CMD_SAVE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Command, m_currentGroup, m_currentXform, m_isGrouping, m_xformStack, storePath(), and updateWorldScreenMatrix().

Referenced by drawGridSource().

◆ Scale()

void CAIRO_GAL_BASE::Scale ( const VECTOR2D & aScale )

overridevirtual

Scale the context.

Parameters

aScale is the scale factor for the x- and y-axis.

Reimplemented from KIGFX::GAL.

Definition at line 828 of file cairo_gal.cpp.

References CMD_SCALE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::DblArg, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Argument, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Command, m_currentGroup, m_currentXform, m_isGrouping, storePath(), updateWorldScreenMatrix(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SetAxesColor()

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

inlineinherited

Set the axes color.

Parameters

aAxesColor is the color to draw the axes if enabled.

Definition at line 1235 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::GAL_MODERN::GAL_MODERN(), KIGFX::OPENGL_GAL::OPENGL_GAL(), and SYMBOL_EDIT_FRAME::SwitchCanvas().

◆ SetAxesEnabled()

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

inlineinherited

Enable drawing the axes.

Definition at line 1243 of file graphics_abstraction_layer.h.

References m_axesEnabled.

Referenced by FOOTPRINT_EDIT_FRAME::ActivateGalCanvas(), GAL(), DIALOG_PAD_PROPERTIES::prepareCanvas(), DIALOG_VIA_STITCH_PROPERTIES::prepareCanvas(), FP_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), FOOTPRINT_EDIT_FRAME::SwitchCanvas(), and SYMBOL_EDIT_FRAME::SwitchCanvas().

◆ SetClearColor()

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

inlineinherited

Definition at line 514 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

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

Definition at line 1253 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

aCursorColor is the color of the cursor.

Definition at line 1350 of file graphics_abstraction_layer.h.

References m_cursorColor.

Referenced by GAL().

◆ SetCursorEnabled()

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

inlineinherited

Enable/disable cursor.

Parameters

aCursorEnabled is true if the cursor should be drawn, else false.

Definition at line 1330 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 936 of file graphics_abstraction_layer.h.

References m_depthRange.

Referenced by GAL().

◆ SetFillColor()

void CAIRO_GAL_BASE::SetFillColor ( const COLOR4D & aColor )

overridevirtual

Set the fill color.

Parameters

aColor is the color for filling.

Reimplemented from KIGFX::GAL.

Definition at line 730 of file cairo_gal.cpp.

References CMD_SET_FILLCOLOR, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::DblArg, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Argument, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Command, m_currentGroup, KIGFX::GAL::m_fillColor, m_isGrouping, and storePath().

Referenced by drawGridSource().

◆ SetFlip()

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

inlineinherited

Sets flipping of the screen.

Parameters

xAxis	is the flip flag for the X axis.
yAxis	is the flip flag for the Y axis.

Definition at line 1000 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 714 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by ResetTextAttributes().

◆ SetFontItalic()

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

inlineinherited

Definition at line 717 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by ResetTextAttributes().

◆ SetFontUnderlined()

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

inlineinherited

Definition at line 720 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by ResetTextAttributes().

◆ SetGlyphSize()

void KIGFX::GAL::SetGlyphSize ( const VECTOR2I aSize )

inlineinherited

Definition at line 711 of file graphics_abstraction_layer.h.

References m_attributes.

Referenced by KIGFX::bitmapText(), KIGFX::PREVIEW::ANGLE_ITEM::drawPreviewShape(), KIGFX::VIEW_OVERLAY::COMMAND_GLYPH_SIZE::Execute(), and ResetTextAttributes().

◆ SetGridColor()

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

inlineinherited

Set the grid color.

Parameters

aGridColor is the grid color, it should have a low alpha value for the best effect.

Definition at line 1225 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

aGridOrigin is a vector containing the grid origin point, in world coordinates.

Definition at line 1146 of file graphics_abstraction_layer.h.

References m_gridOffset, m_gridOrigin, and m_gridSize.

Referenced by FOOTPRINT_EDIT_FRAME::borrowBoardNonDestructive(), PCB_CONTROL::DoSetGridOrigin(), and PCB_BASE_EDIT_FRAME::SetBoard().

◆ SetGridSize()

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

inlineinherited

Set the grid size.

Parameters

aGridSize is a vector containing the grid size in x and y direction.

Definition at line 1171 of file graphics_abstraction_layer.h.

References m_gridOffset, m_gridOrigin, and m_gridSize.

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

◆ SetGridSources()

void GAL::SetGridSources ( std::vector< GRID_SOURCE > aSources )

inherited

Set the grid-source list rendered alongside the display grid.

The list is sorted by GRID_GEOMETRY::TakesPrecedenceOver, so every consumer can take the first source that applies rather than re-deriving the overlap rules. The sort is stable, leaving exact ties in the caller's original order.

Definition at line 274 of file graphics_abstraction_layer.cpp.

References m_gridSources.

◆ SetGridVisibility()

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

inlineinherited

Set the visibility setting of the grid.

Parameters

aVisibility is the new visibility setting of the grid.

Definition at line 1131 of file graphics_abstraction_layer.h.

References m_gridVisibility.

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

◆ SetGroupPlacement()

virtual void KIGFX::GAL::SetGroupPlacement	(	int	aGroup,
		int	aLayer,
		double	aLodScale,
		bool	aShown,
		const RETAINED_GROUP_ORDER &	aOrder )

inlinevirtualinherited

Declare where a cached group belongs in the retained scene.

Parameters

aGroup	is the group number returned by BeginGroup().
aLayer	is the VIEW layer id the group was cached for.
aLodScale	is the view scale above which the group is drawn.
aShown	is false to keep the group out of the scene regardless of scale.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 241 of file graphics_abstraction_layer.h.

◆ SetHorizontalJustify()

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

inlineinherited

Definition at line 726 of file graphics_abstraction_layer.h.

References m_attributes.

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

◆ SetHoverColor()

virtual void KIGFX::GAL::SetHoverColor ( const COLOR4D & aColor )

inlinevirtualinherited

Definition at line 603 of file graphics_abstraction_layer.h.

References m_hoverColor.

◆ SetIsFill()

void CAIRO_GAL_BASE::SetIsFill ( bool aIsFillEnabled )

overridevirtual

Enable/disable fill.

Parameters

aIsFillEnabled is true, when the graphics objects should be filled, else false.

Reimplemented from KIGFX::GAL.

Definition at line 682 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(), and drawGridSource().

◆ SetIsStroke()

void CAIRO_GAL_BASE::SetIsStroke ( bool aIsStrokeEnabled )

overridevirtual

Enable/disable stroked outlines.

Parameters

aIsStrokeEnabled is true, if the outline of an object should be stroked.

Reimplemented from KIGFX::GAL.

Definition at line 697 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(), and drawGridSource().

◆ 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

aLayerDepth the layer depth for the objects. Smaller is closer to the viewer.

Reimplemented from KIGFX::GAL.

Definition at line 767 of file cairo_gal.cpp.

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

Referenced by drawGridSources().

◆ SetLineWidth()

void CAIRO_GAL_BASE::SetLineWidth ( float aLineWidth )

overridevirtual

Set the line width.

Parameters

aLineWidth is the line width.

Reimplemented from KIGFX::GAL.

Definition at line 748 of file cairo_gal.cpp.

References CMD_SET_LINE_WIDTH, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::DblArg, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Argument, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Command, m_currentGroup, m_isGrouping, KIGFX::GAL::m_lineWidth, KIGFX::GAL::SetLineWidth(), and storePath().

Referenced by DrawGrid(), drawGridSource(), and DrawSegment().

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

aLineWidth is the minimum line width.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 633 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

aCursor	is the cursor to use in the native panell
aHiDPI	is used to determine if high DPI cursors should be used.

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 470 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

aSetting is true if negative mode should be enabled

Reimplemented from KIGFX::GAL.

Definition at line 1053 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 925 of file graphics_abstraction_layer.h.

References m_rotation.

Referenced by GAL().

◆ SetSceneDrawOrdered()

virtual void KIGFX::GAL::SetSceneDrawOrdered ( bool aOrdered )

inlinevirtualinherited

Tell the retained scene whether cached groups are placed in an order that matters.

When they are, a knockout erases only what was placed before it on its layer, as on a Gerber layer. Otherwise a layer's knockouts apply to all of it.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 231 of file graphics_abstraction_layer.h.

◆ SetSceneLayerDim()

virtual void KIGFX::GAL::SetSceneLayerDim	(	int	aLayer,
		const COLOR4D &	aToward,
		double	aKeep )

inlinevirtualinherited

Fade a cached layer towards a colour in the shader, so dimming it recolours none of its groups.

Groups marked with ChangeGroupUndimmed() keep their colour.

Parameters

aLayer	is the VIEW layer id.
aToward	is the colour the layer fades towards, usually the background.
aKeep	is the share of each colour that is kept, 1 to leave the layer as it is.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 216 of file graphics_abstraction_layer.h.

◆ SetSceneLayerOverlayAlpha()

virtual void KIGFX::GAL::SetSceneLayerOverlayAlpha ( int aLayer )

inlinevirtualinherited

Blend a cached layer the way the other canvases blend the overlay they draw it in.

Colour c with alpha a over d then shows c*a + d*(1 - a*a) rather than c*a + d*(1 - a).

Parameters

aLayer is the VIEW layer id.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 224 of file graphics_abstraction_layer.h.

◆ SetSceneLayerState()

virtual void KIGFX::GAL::SetSceneLayerState	(	int	aLayer,
		int	aOrder,
		bool	aVisible,
		bool	aHasNegatives )

inlinevirtualinherited

Describe a cached layer to the retained scene.

Layers draw in decreasing order value and a hidden layer keeps its groups, so showing, hiding or reordering layers emits nothing again.

Parameters

aLayer	is the VIEW layer id.
aOrder	is the layer's rendering order.
aVisible	is false to leave the layer out of the frame.
aHasNegatives	is true if the layer has to contain its own knockouts.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 206 of file graphics_abstraction_layer.h.

◆ SetSceneScale()

virtual void KIGFX::GAL::SetSceneScale ( double aScale )

inlinevirtualinherited

Set the view scale that group placements are tested against.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 245 of file graphics_abstraction_layer.h.

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

References m_screenSize.

Referenced by KIGFX::GAL_MODERN::ResizeScreen(), and KIGFX::CAIRO_PRINT_GAL::SetSheetSize().

◆ SetScreenSpaceMode()

virtual void KIGFX::GAL::SetScreenSpaceMode ( bool aEnabled )

inlinevirtualinherited

Store sizes of what is drawn next in pixels rather than world units, so it keeps its pixel size through a zoom without being drawn again.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 1061 of file graphics_abstraction_layer.h.

◆ SetStrokeColor()

void CAIRO_GAL_BASE::SetStrokeColor ( const COLOR4D & aColor )

overridevirtual

Set the stroke color.

Parameters

aColor is the color for stroking the outline.

Reimplemented from KIGFX::GAL.

Definition at line 712 of file cairo_gal.cpp.

References CMD_SET_STROKECOLOR, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::DblArg, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Argument, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Command, m_currentGroup, m_isGrouping, KIGFX::GAL::m_strokeColor, and storePath().

Referenced by drawGridSource().

◆ SetStrokeLengthPad()

virtual void KIGFX::GAL::SetStrokeLengthPad ( double aPixels )

inlinevirtualinherited

Extend every stroke drawn from now on by aPixels at each end.

Pixels are resolved per frame so the look survives a zoom without drawing again. Zero turns it off.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 1073 of file graphics_abstraction_layer.h.

◆ SetStrokeLevelOfDetail()

virtual void KIGFX::GAL::SetStrokeLevelOfDetail ( double aLod )

inlinevirtualinherited

Show every stroke drawn from now on only while the view scale is above aLod, as VIEW::IsShownAtScale() decides.

It is decided per frame so a zoom needs no redraw. Zero turns it off.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 1088 of file graphics_abstraction_layer.h.

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

◆ SetStrokePixelPad()

virtual void KIGFX::GAL::SetStrokePixelPad ( double aPixels )

inlinevirtualinherited

Widen every stroke, circle and pad drawn from now on by aPixels.

Pixels are resolved per frame so the look survives a zoom without drawing again. Zero turns it off.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 1079 of file graphics_abstraction_layer.h.

Referenced by RATSNEST_VIEW_ITEM::ViewDraw().

◆ SetTarget()

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

inlinevirtualinherited

Set the target for rendering.

Parameters

aTarget is the new target for rendering.

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

Definition at line 1018 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

Definition at line 723 of file graphics_abstraction_layer.h.

References m_attributes.

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

◆ SetVerticalJustify()

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

inlineinherited

Definition at line 733 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

aMatrix is the 3x3 world <-> screen transformation matrix.

Definition at line 879 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 896 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 919 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 491 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, KIGFX::GAL_MODERN, and KIGFX::OPENGL_GAL.

Definition at line 1097 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, and KIGFX::GAL_MODERN.

Definition at line 1114 of file graphics_abstraction_layer.h.

◆ storePath()

void CAIRO_GAL_BASE::storePath ( )

protected

Store the actual path.

Definition at line 1224 of file cairo_gal.cpp.

References CMD_FILL_PATH, CMD_STROKE_PATH, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_CairoPath, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Command, m_currentContext, m_currentGroup, KIGFX::GAL::m_fillColor, m_isElementAdded, KIGFX::GAL::m_isFillEnabled, m_isGrouping, KIGFX::GAL::m_isStrokeEnabled, and KIGFX::GAL::m_strokeColor.

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

◆ SupportsStrokeLengthPad()

virtual bool KIGFX::GAL::SupportsStrokeLengthPad ( ) const

inlinevirtualinherited

Tell whether strokes can be longer by a number of pixels, see SetStrokeLengthPad().

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 1067 of file graphics_abstraction_layer.h.

◆ SupportsStrokeLevelOfDetail()

virtual bool KIGFX::GAL::SupportsStrokeLevelOfDetail ( ) const

inlinevirtualinherited

Tell whether strokes can carry a level of detail, see SetStrokeLevelOfDetail().

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 1082 of file graphics_abstraction_layer.h.

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

◆ SupportsStrokePixelPad()

virtual bool KIGFX::GAL::SupportsStrokePixelPad ( ) const

inlinevirtualinherited

Tell whether strokes can carry part of their width in pixels, see SetStrokePixelPad().

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 1064 of file graphics_abstraction_layer.h.

Referenced by SCH_BASE_FRAME::RefreshZoomDependentItems(), and RATSNEST_VIEW_ITEM::ViewDraw().

◆ SupportsTypedPads()

virtual bool KIGFX::GAL::SupportsTypedPads ( ) const

inlinevirtualinherited

Return true if DrawPad() renders every standard pad shape.

Painters must not use it otherwise, since the base implementation draws every non-circular pad as a rectangle.

Reimplemented in KIGFX::GAL_MODERN.

Definition at line 254 of file graphics_abstraction_layer.h.

◆ syncLineWidth()

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

protected

Definition at line 213 of file cairo_gal.cpp.

References m_currentContext, KIGFX::GAL::m_lineWidth, m_lineWidthInPixels, m_lineWidthIsOdd, and xform().

Referenced by DrawArc(), DrawArcSegment(), drawAxes(), DrawCircle(), DrawCurve(), DrawEllipse(), DrawEllipseArc(), DrawGlyph(), drawGridCross(), drawGridLine(), DrawLine(), drawPoly(), drawPoly(), drawPoly(), drawPoly(), DrawRectangle(), and DrawSegment().

◆ TakeWorldScaleLimits()

void KIGFX::GAL::TakeWorldScaleLimits	(	double &	aBelow,
		double &	aAbove ) const

inlineinherited

Give and forget the nearest limits on either side of the scale passed to WorldScaleBelow().

Definition at line 974 of file graphics_abstraction_layer.h.

References m_scaleLimitAbove, and m_scaleLimitBelow.

◆ TakeWorldScaleRead()

bool KIGFX::GAL::TakeWorldScaleRead ( ) const

inlineinherited

Tell whether GetWorldScale() or a transformation matrix was read since the last call.

A backend that keeps geometry across frames needs this because whatever was sized from the scale goes stale on zoom.

Definition at line 986 of file graphics_abstraction_layer.h.

References m_worldScaleRead.

◆ ToScreen()

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

inlineinherited

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

Parameters

aPoint the point position in world coordinates.

Returns: the point position in screen coordinates.

Definition at line 1311 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

aPoint the point position in screen coordinates.

Returns: the point position in world coordinates.

Definition at line 1300 of file graphics_abstraction_layer.h.

References m_screenWorldMatrix.

◆ Transform()

void CAIRO_GAL_BASE::Transform ( const MATRIX3x3D & aTransformation )

overridevirtual

Transform the context.

Parameters

aTransformation is the transformation matrix.

Reimplemented from KIGFX::GAL.

Definition at line 774 of file cairo_gal.cpp.

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

◆ Translate()

void CAIRO_GAL_BASE::Translate ( const VECTOR2D & aTranslation )

overridevirtual

Translate the context.

Parameters

aTranslation is the translation vector.

Reimplemented from KIGFX::GAL.

Definition at line 808 of file cairo_gal.cpp.

References CMD_TRANSLATE, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::DblArg, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Argument, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Command, m_currentGroup, m_currentXform, m_isGrouping, storePath(), updateWorldScreenMatrix(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by drawGridSource().

◆ UnlockContext()

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

inlinevirtualinherited

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1410 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 138 of file graphics_abstraction_layer.cpp.

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

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

◆ updateWorldScreenMatrix()

void CAIRO_GAL_BASE::updateWorldScreenMatrix ( )

protected

Definition at line 106 of file cairo_gal.cpp.

References m_cairoWorldScreenMatrix, m_currentWorld2Screen, and m_currentXform.

Referenced by resetContext(), Restore(), Rotate(), Save(), Scale(), Transform(), and Translate().

◆ UsesPolygonTriangulationCache()

virtual bool KIGFX::GAL::UsesPolygonTriangulationCache ( ) const

inlinevirtualinherited

Return true if filled polygons are drawn from the SHAPE_POLY_SET triangulation cache, which painters should then fill before calling DrawPolygon.

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

Definition at line 260 of file graphics_abstraction_layer.h.

◆ WorldScaleBelow()

bool KIGFX::GAL::WorldScaleBelow ( double aLimit ) const

inlineinherited

Tell whether the world scale is below a limit.

This is not a read of the scale, so what depends only on the answer stays valid through a zoom that does not cross the limit, see TakeWorldScaleLimits().

Definition at line 961 of file graphics_abstraction_layer.h.

References m_scaleLimitAbove, m_scaleLimitBelow, and m_worldScale.

Referenced by KIGFX::SCH_PAINTER::draw().

◆ xform() [1/3]

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

protected

Definition at line 122 of file cairo_gal.cpp.

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

◆ xform() [2/3]

double CAIRO_GAL_BASE::xform ( double x )

protected

Definition at line 176 of file cairo_gal.cpp.

References m_currentWorld2Screen.

Referenced by DrawArc(), DrawArcSegment(), drawAxes(), DrawCircle(), DrawCurve(), DrawEllipse(), DrawEllipseArc(), DrawGlyph(), drawGridCross(), drawGridLine(), drawGridPoint(), DrawLine(), drawPoly(), drawPoly(), drawPoly(), drawPoly(), DrawRectangle(), DrawSegment(), syncLineWidth(), and xform().

◆ xform() [3/3]

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

protected

Definition at line 112 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 395 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 1511 of file graphics_abstraction_layer.h.

◆ m_attributes

TEXT_ATTRIBUTES KIGFX::GAL::m_attributes

privateinherited

Definition at line 1618 of file graphics_abstraction_layer.h.

Referenced by BitmapText(), GetGlyphSize(), GetHorizontalJustify(), GetVerticalJustify(), IsFontBold(), IsFontItalic(), IsFontUnderlined(), IsTextMirrored(), SetFontBold(), SetFontItalic(), SetFontUnderlined(), SetGlyphSize(), SetHorizontalJustify(), SetTextMirrored(), and SetVerticalJustify().

◆ m_axesColor

COLOR4D KIGFX::GAL::m_axesColor

protectedinherited

Color of the axes.

Definition at line 1593 of file graphics_abstraction_layer.h.

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

◆ m_axesEnabled

bool KIGFX::GAL::m_axesEnabled

protectedinherited

Should the axes be drawn.

Definition at line 1594 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawGrid(), KIGFX::GAL_MODERN::DrawGrid(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::GAL_MODERN::PopulateCameraUBOs(), SetAxesEnabled(), and updatedGalDisplayOptions().

◆ m_cairoWorldScreenMatrix

cairo_matrix_t KIGFX::CAIRO_GAL_BASE::m_cairoWorldScreenMatrix

protected

Cairo world to screen transform matrix.

Definition at line 383 of file cairo_gal.h.

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

◆ m_clearColor

COLOR4D KIGFX::GAL::m_clearColor

protectedinherited

Definition at line 1580 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_PRINT_GAL::CAIRO_PRINT_GAL(), KIGFX::CAIRO_GAL_BASE::ClearScreen(), KIGFX::OPENGL_GAL::ClearTarget(), KIGFX::CAIRO_GAL_BASE::drawGridSource(), KIGFX::GAL_MODERN::drawGridSource(), KIGFX::OPENGL_GAL::drawGridSources(), GetClearColor(), KIGFX::GAL_MODERN::GetDynamicDrawDesc(), KIGFX::GAL_MODERN::GetStaticDrawDesc(), and SetClearColor().

◆ m_context

cairo_t* KIGFX::CAIRO_GAL_BASE::m_context

protected

Cairo image.

Definition at line 387 of file cairo_gal.h.

Referenced by KIGFX::CAIRO_GAL::BeginDrawing(), CAIRO_GAL_BASE(), KIGFX::CAIRO_PRINT_GAL::CAIRO_PRINT_GAL(), KIGFX::CAIRO_GAL::deinitSurface(), KIGFX::CAIRO_GAL::initSurface(), resetContext(), and ~CAIRO_GAL_BASE().

◆ m_crossHairMode

KIGFX::CROSS_HAIR_MODE KIGFX::GAL::m_crossHairMode

protectedinherited

Crosshair drawing mode.

Definition at line 1606 of file graphics_abstraction_layer.h.

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

◆ m_currentContext

cairo_t* KIGFX::CAIRO_GAL_BASE::m_currentContext

protected

Currently used Cairo context for drawing.

Definition at line 386 of file cairo_gal.h.

Referenced by CAIRO_GAL_BASE(), KIGFX::CAIRO_PRINT_GAL::CAIRO_PRINT_GAL(), ClearScreen(), DrawArc(), DrawArcSegment(), drawAxes(), DrawBitmap(), DrawCircle(), DrawCurve(), DrawEllipse(), DrawEllipseArc(), DrawGlyph(), drawGridCross(), drawGridLine(), drawGridPoint(), DrawGroup(), DrawLine(), drawPoly(), drawPoly(), drawPoly(), drawPoly(), DrawRectangle(), DrawSegment(), flushPath(), KIGFX::CAIRO_GAL::initSurface(), KIGFX::CAIRO_GAL::setCompositor(), SetNegativeDrawMode(), storePath(), and syncLineWidth().

◆ m_currentGroup

GROUP* KIGFX::CAIRO_GAL_BASE::m_currentGroup

protected

Currently used group.

Definition at line 378 of file cairo_gal.h.

Referenced by BeginGroup(), CAIRO_GAL_BASE(), Restore(), Rotate(), Save(), Scale(), SetFillColor(), SetIsFill(), SetIsStroke(), SetLineWidth(), SetStrokeColor(), storePath(), and Translate().

◆ m_currentNativeCursor

KICURSOR KIGFX::GAL::m_currentNativeCursor

protectedinherited

Current cursor.

Definition at line 1609 of file graphics_abstraction_layer.h.

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

◆ m_currentWorld2Screen

cairo_matrix_t KIGFX::CAIRO_GAL_BASE::m_currentWorld2Screen

protected

Definition at line 385 of file cairo_gal.h.

Referenced by angle_xform(), CAIRO_GAL_BASE(), DrawBitmap(), updateWorldScreenMatrix(), xform(), and xform().

◆ m_currentXform

cairo_matrix_t KIGFX::CAIRO_GAL_BASE::m_currentXform

protected

Definition at line 384 of file cairo_gal.h.

Referenced by CAIRO_GAL_BASE(), resetContext(), Restore(), Rotate(), Save(), Scale(), Transform(), Translate(), and updateWorldScreenMatrix().

◆ m_cursorColor

COLOR4D KIGFX::GAL::m_cursorColor

protectedinherited

Cursor color.

Definition at line 1605 of file graphics_abstraction_layer.h.

Referenced by getCursorColor(), and SetCursorColor().

◆ m_cursorPosition

VECTOR2D KIGFX::GAL::m_cursorPosition

protectedinherited

Current cursor position (world coordinates)

Definition at line 1607 of file graphics_abstraction_layer.h.

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

◆ m_depthRange

VECTOR2D KIGFX::GAL::m_depthRange

protectedinherited

Range of the depth.

Definition at line 1584 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::BeginDrawing(), KIGFX::CAIRO_GAL_BASE::drawGridSources(), GetMaxDepth(), GetMinDepth(), SetDepthRange(), and SetLayerDepth().

◆ m_depthStack

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

protectedinherited

Stored depth values.

Definition at line 1553 of file graphics_abstraction_layer.h.

◆ m_fillColor

COLOR4D KIGFX::GAL::m_fillColor

protectedinherited

The fill color.

Definition at line 1578 of file graphics_abstraction_layer.h.

◆ m_forceDisplayCursor

bool KIGFX::GAL::m_forceDisplayCursor

protectedinherited

Always show cursor.

Definition at line 1604 of file graphics_abstraction_layer.h.

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

◆ m_globalFlipX

bool KIGFX::GAL::m_globalFlipX

protectedinherited

Flag for X axis flipping.

Definition at line 1569 of file graphics_abstraction_layer.h.

Referenced by BitmapText(), KIGFX::OPENGL_GAL::BitmapText(), KIGFX::CAIRO_PRINT_GAL::ComputeWorldScreenMatrix(), ComputeWorldScreenMatrix(), KIGFX::GAL_MODERN::drawBitmapGlyphs(), IsFlippedX(), and SetFlip().

◆ m_globalFlipY

bool KIGFX::GAL::m_globalFlipY

protectedinherited

Flag for Y axis flipping.

Definition at line 1570 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), KIGFX::CAIRO_PRINT_GAL::ComputeWorldScreenMatrix(), ComputeWorldScreenMatrix(), KIGFX::GAL_MODERN::drawBitmapGlyphs(), IsFlippedY(), and SetFlip().

◆ m_gridColor

COLOR4D KIGFX::GAL::m_gridColor

protectedinherited

Color of the grid.

Definition at line 1592 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawGrid(), KIGFX::OPENGL_GAL::DrawGrid(), GetGridColor(), gridSourceColor(), KIGFX::GAL_MODERN::PopulateCameraUBOs(), and SetGridColor().

◆ m_gridLineWidth

float KIGFX::GAL::m_gridLineWidth

protectedinherited

Line width of the grid.

Definition at line 1596 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawGrid(), KIGFX::CAIRO_GAL_BASE::drawGridSource(), GAL(), GetGridLineWidth(), gridMinorLineWidth(), KIGFX::GAL_MODERN::PopulateCameraUBOs(), and updatedGalDisplayOptions().

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

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

◆ m_gridOrigin

VECTOR2D KIGFX::GAL::m_gridOrigin

protectedinherited

The grid origin.

Definition at line 1590 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawGrid(), KIGFX::OPENGL_GAL::DrawGrid(), GetGridOrigin(), KIGFX::GAL_MODERN::PopulateCameraUBOs(), SetGridOrigin(), and SetGridSize().

◆ m_gridSize

VECTOR2D KIGFX::GAL::m_gridSize

protectedinherited

The grid size.

Definition at line 1589 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawGrid(), KIGFX::OPENGL_GAL::DrawGrid(), GetGridPoint(), GetGridSize(), GetVisibleGridSize(), KIGFX::GAL_MODERN::gridShown(), SetGridOrigin(), and SetGridSize().

◆ m_gridSources

std::vector<GRID_SOURCE> KIGFX::GAL::m_gridSources

protectedinherited

Sources overlayed on the display grid.

Definition at line 1600 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawGrid(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::CAIRO_GAL_BASE::drawGridSources(), KIGFX::GAL_MODERN::drawGridSources(), KIGFX::OPENGL_GAL::drawGridSources(), GetGridPoint(), GetGridSources(), and SetGridSources().

◆ m_gridStyle

GRID_STYLE KIGFX::GAL::m_gridStyle

protectedinherited

Grid display style.

Definition at line 1588 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawGrid(), KIGFX::OPENGL_GAL::DrawGrid(), GAL(), GetGridStyle(), GetVisibleGridSize(), KIGFX::GAL_MODERN::PopulateCameraUBOs(), and updatedGalDisplayOptions().

◆ m_gridTick

int KIGFX::GAL::m_gridTick

protectedinherited

Every tick line gets the double width.

Definition at line 1595 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawGrid(), KIGFX::OPENGL_GAL::DrawGrid(), GetCoarseGrid(), GetVisibleGridSize(), gridLattice(), KIGFX::GAL_MODERN::PopulateCameraUBOs(), SetCoarseGrid(), and updatedGalDisplayOptions().

◆ m_gridVisibility

bool KIGFX::GAL::m_gridVisibility

protectedinherited

Should the grid be shown.

Definition at line 1587 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawGrid(), KIGFX::OPENGL_GAL::DrawGrid(), GetGridSnapping(), GetGridVisibility(), KIGFX::GAL_MODERN::gridShown(), and SetGridVisibility().

◆ m_groupCounter

unsigned int KIGFX::CAIRO_GAL_BASE::m_groupCounter

protected

Counter used for generating group keys.

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

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

◆ m_hoverColor

COLOR4D KIGFX::GAL::m_hoverColor

protectedinherited

Color for hovered (active) links.

Definition at line 1581 of file graphics_abstraction_layer.h.

Referenced by DrawGlyphs(), and SetHoverColor().

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

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

◆ m_isElementAdded

bool KIGFX::CAIRO_GAL_BASE::m_isElementAdded

protected

Was an graphic element added ?

Definition at line 375 of file cairo_gal.h.

Referenced by CAIRO_GAL_BASE(), DrawArc(), DrawArcSegment(), DrawBitmap(), DrawCircle(), DrawCurve(), DrawEllipse(), DrawEllipseArc(), DrawGlyph(), DrawLine(), drawPoly(), drawPoly(), drawPoly(), drawPoly(), DrawRectangle(), DrawSegment(), resetContext(), and storePath().

◆ m_isFillEnabled

bool KIGFX::GAL::m_isFillEnabled

protectedinherited

Is filling of graphic objects enabled ?

Definition at line 1575 of file graphics_abstraction_layer.h.

◆ m_isGrouping

bool KIGFX::CAIRO_GAL_BASE::m_isGrouping

protected

Is grouping enabled ?

Definition at line 374 of file cairo_gal.h.

Referenced by BeginGroup(), CAIRO_GAL_BASE(), EndGroup(), Restore(), Rotate(), Save(), Scale(), SetFillColor(), SetIsFill(), SetIsStroke(), SetLineWidth(), SetStrokeColor(), storePath(), and Translate().

◆ m_isStrokeEnabled

bool KIGFX::GAL::m_isStrokeEnabled

protectedinherited

Are the outlines stroked ?

Definition at line 1576 of file graphics_abstraction_layer.h.

◆ m_layerDepth

double KIGFX::GAL::m_layerDepth

protectedinherited

The actual layer depth.

Definition at line 1583 of file graphics_abstraction_layer.h.

◆ m_lineWidth

float KIGFX::GAL::m_lineWidth

protectedinherited

The line width.

Definition at line 1572 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL_BASE::CAIRO_GAL_BASE(), KIGFX::GAL_MODERN::DrawArc(), KIGFX::CAIRO_GAL_BASE::DrawArcSegment(), KIGFX::GAL_MODERN::DrawArcSegment(), KIGFX::GAL_MODERN::DrawCircle(), KIGFX::OPENGL_GAL::drawCircle(), KIGFX::GAL_MODERN::DrawLine(), KIGFX::OPENGL_GAL::drawLineQuad(), KIGFX::GAL_MODERN::DrawRectangle(), KIGFX::OPENGL_GAL::drawStrokedSemiCircle(), GetLineWidth(), KIGFX::CAIRO_GAL_BASE::resetContext(), KIGFX::CAIRO_GAL_BASE::SetLineWidth(), SetLineWidth(), and KIGFX::CAIRO_GAL_BASE::syncLineWidth().

◆ m_lineWidthInPixels

double KIGFX::CAIRO_GAL_BASE::m_lineWidthInPixels

protected

Definition at line 380 of file cairo_gal.h.

Referenced by CAIRO_GAL_BASE(), DrawArc(), DrawCircle(), DrawEllipse(), DrawEllipseArc(), drawGridCross(), flushPath(), and syncLineWidth().

◆ m_lineWidthIsOdd

bool KIGFX::CAIRO_GAL_BASE::m_lineWidthIsOdd

protected

Definition at line 381 of file cairo_gal.h.

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

◆ m_lookAtPoint

VECTOR2D KIGFX::GAL::m_lookAtPoint

protectedinherited

Point to be looked at in world space.

Definition at line 1558 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_PRINT_GAL::ComputeWorldScreenMatrix(), ComputeWorldScreenMatrix(), KIGFX::OPENGL_GAL::ComputeWorldScreenMatrix(), GetLookAtPoint(), and SetLookAtPoint().

◆ m_minLineWidth

float KIGFX::GAL::m_minLineWidth

protectedinherited

Minimum line width in pixels.

Definition at line 1573 of file graphics_abstraction_layer.h.

Referenced by GetMinLineWidth(), and SetMinLineWidth().

◆ m_observerLink

UTIL::LINK KIGFX::GAL::m_observerLink

protectedinherited

Definition at line 1551 of file graphics_abstraction_layer.h.

Referenced by GAL().

◆ m_options

GAL_DISPLAY_OPTIONS& KIGFX::GAL::m_options

protectedinherited

Definition at line 1550 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::BeginDrawing(), GAL(), GetGridSnapping(), KIGFX::OPENGL_GAL::OPENGL_GAL(), KIGFX::CAIRO_GAL::setCompositor(), KIGFX::CAIRO_GAL::updatedGalDisplayOptions(), updatedGalDisplayOptions(), and KIGFX::OPENGL_GAL::updatedGalDisplayOptions().

◆ m_rotation

double KIGFX::GAL::m_rotation

protectedinherited

Rotation transformation (radians)

Definition at line 1561 of file graphics_abstraction_layer.h.

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

◆ m_scaleLimitAbove

double KIGFX::GAL::m_scaleLimitAbove = std::numeric_limits<double>::max()

mutableprotectedinherited

Definition at line 1567 of file graphics_abstraction_layer.h.

Referenced by TakeWorldScaleLimits(), and WorldScaleBelow().

◆ m_scaleLimitBelow

double KIGFX::GAL::m_scaleLimitBelow = 0.0

mutableprotectedinherited

see TakeWorldScaleLimits()

Definition at line 1566 of file graphics_abstraction_layer.h.

Referenced by TakeWorldScaleLimits(), and WorldScaleBelow().

◆ m_screenDPI

double KIGFX::GAL::m_screenDPI

protectedinherited

The dots per inch of the screen.

Definition at line 1557 of file graphics_abstraction_layer.h.

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

◆ m_screenSize

VECTOR2I KIGFX::GAL::m_screenSize

protectedinherited

◆ m_screenWorldMatrix

MATRIX3x3D KIGFX::GAL::m_screenWorldMatrix

protectedinherited

Screen transformation.

Definition at line 1563 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::blitCursor(), KIGFX::CAIRO_PRINT_GAL::ComputeWorldScreenMatrix(), ComputeWorldScreenMatrix(), KIGFX::CAIRO_GAL_BASE::DrawGrid(), KIGFX::OPENGL_GAL::DrawGrid(), GetScreenWorldMatrix(), gridScreenBBox(), KIGFX::GAL_MODERN::PopulateCameraUBOs(), KIGFX::GAL_MODERN::screenPixelSize(), and ToWorld().

◆ m_strokeColor

COLOR4D KIGFX::GAL::m_strokeColor

protectedinherited

The color of the outlines.

Definition at line 1579 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::BeginDrawing(), KIGFX::OPENGL_GAL::BitmapText(), KIGFX::GAL_MODERN::DrawArc(), KIGFX::OPENGL_GAL::DrawArc(), KIGFX::CAIRO_GAL_BASE::DrawArcSegment(), KIGFX::GAL_MODERN::DrawArcSegment(), KIGFX::OPENGL_GAL::DrawArcSegment(), KIGFX::GAL_MODERN::drawBitmapGlyphs(), KIGFX::OPENGL_GAL::drawBitmapOverbar(), KIGFX::GAL_MODERN::DrawCircle(), KIGFX::OPENGL_GAL::drawCircle(), KIGFX::OPENGL_GAL::DrawEllipse(), KIGFX::OPENGL_GAL::DrawEllipseArc(), KIGFX::CAIRO_GAL_BASE::DrawGroup(), KIGFX::GAL_MODERN::DrawLine(), KIGFX::OPENGL_GAL::DrawLine(), KIGFX::OPENGL_GAL::drawPolyline(), KIGFX::GAL_MODERN::DrawRectangle(), KIGFX::OPENGL_GAL::DrawRectangle(), KIGFX::CAIRO_GAL_BASE::DrawSegment(), KIGFX::GAL_MODERN::DrawSegment(), KIGFX::OPENGL_GAL::drawSegment(), KIGFX::OPENGL_GAL::drawSegmentChain(), KIGFX::OPENGL_GAL::drawSemiCircle(), KIGFX::CAIRO_GAL_BASE::flushPath(), GetStrokeColor(), KIGFX::CAIRO_GAL_BASE::SetStrokeColor(), SetStrokeColor(), and KIGFX::CAIRO_GAL_BASE::storePath().

◆ m_surface

cairo_surface_t* KIGFX::CAIRO_GAL_BASE::m_surface

protected

Cairo surface.

Definition at line 388 of file cairo_gal.h.

Referenced by CAIRO_GAL_BASE(), KIGFX::CAIRO_PRINT_GAL::CAIRO_PRINT_GAL(), KIGFX::CAIRO_GAL::deinitSurface(), KIGFX::CAIRO_GAL::initSurface(), and ~CAIRO_GAL_BASE().

◆ m_worldScale

double KIGFX::GAL::m_worldScale

protectedinherited

The scale factor world->screen.

Definition at line 1564 of file graphics_abstraction_layer.h.

Referenced by KIGFX::GAL_MODERN::addCapsuleInstance(), KIGFX::OPENGL_GAL::blitCursor(), computeWorldScale(), KIGFX::CAIRO_PRINT_GAL::ComputeWorldScreenMatrix(), ComputeWorldScreenMatrix(), KIGFX::OPENGL_GAL::ComputeWorldScreenMatrix(), KIGFX::CAIRO_GAL_BASE::DrawGrid(), KIGFX::CAIRO_GAL_BASE::drawGridSource(), GetVisibleGridSize(), GetWorldScale(), GetWorldScaleForScreenSpace(), gridLattice(), and WorldScaleBelow().

◆ m_worldScaleRead

bool KIGFX::GAL::m_worldScaleRead = false

mutableprotectedinherited

see TakeWorldScaleRead()

Definition at line 1565 of file graphics_abstraction_layer.h.

Referenced by GetScreenWorldMatrix(), GetWorldScale(), GetWorldScreenMatrix(), and TakeWorldScaleRead().

◆ m_worldScreenMatrix

MATRIX3x3D KIGFX::GAL::m_worldScreenMatrix

protectedinherited

World transformation.

Definition at line 1562 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::BeginDrawing(), KIGFX::CAIRO_PRINT_GAL::ComputeWorldScreenMatrix(), ComputeWorldScreenMatrix(), GetWorldScreenMatrix(), KIGFX::GAL_MODERN::PopulateCursorUBO(), KIGFX::CAIRO_GAL_BASE::resetContext(), SetWorldScreenMatrix(), and ToScreen().

◆ m_worldUnitLength

double KIGFX::GAL::m_worldUnitLength

protectedinherited

The unit length of the world coordinates [inch].

Definition at line 1556 of file graphics_abstraction_layer.h.

Referenced by computeWorldScale(), KIGFX::CAIRO_PRINT_GAL::ComputeWorldScreenMatrix(), KIGFX::CAIRO_GAL_BASE::DrawBitmap(), KIGFX::GAL_MODERN::DrawBitmap(), KIGFX::OPENGL_GAL::DrawBitmap(), GetWorldUnitLength(), and SetWorldUnitLength().

◆ m_xformStack

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

protected

Definition at line 393 of file cairo_gal.h.

Referenced by Restore(), and Save().

◆ m_zoomFactor

double KIGFX::GAL::m_zoomFactor

protectedinherited

The zoom factor.

Definition at line 1560 of file graphics_abstraction_layer.h.

Referenced by computeWorldScale(), KIGFX::CAIRO_PRINT_GAL::ComputeWorldScreenMatrix(), GetZoomFactor(), KIGFX::GAL_MODERN::PopulateCameraUBOs(), and SetZoomFactor().

◆ MAX_CAIRO_ARGUMENTS

const int KIGFX::CAIRO_GAL_BASE::MAX_CAIRO_ARGUMENTS = 4

staticprotected

Maximum number of arguments for one command.

Definition at line 338 of file cairo_gal.h.

◆ MAX_DEPTH

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

staticprotectedinherited

Definition at line 1508 of file graphics_abstraction_layer.h.

Referenced by GAL(), and KIGFX::GAL_MODERN::PopulateCameraUBOs().

◆ MIN_DEPTH

const int GAL::MIN_DEPTH = -2*MAX_LAYERS_FOR_VIEW

staticprotectedinherited

Possible depth range.

Definition at line 1507 of file graphics_abstraction_layer.h.

Referenced by GAL().

◆ SEG_PER_CIRCLE_COUNT

int KIGFX::GAL::SEG_PER_CIRCLE_COUNT = 64

staticconstexprprotectedinherited

The default number of segments approximating a full circle.

Definition at line 1466 of file graphics_abstraction_layer.h.

Referenced by calcAngleStep(), and KIGFX::OPENGL_GAL::DrawArcSegment().

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

Classes

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ GROUP

◆ super

Member Enumeration Documentation

◆ GRAPHICS_COMMAND

Constructor & Destructor Documentation

◆ CAIRO_GAL_BASE()

◆ ~CAIRO_GAL_BASE()

Member Function Documentation

◆ AdvanceDepth()

◆ angle_xform()

◆ arc_angles_xform_and_normalize()

◆ BeginDrawing()

◆ BeginGroup()

◆ BeginSceneLayer()

◆ beginUpdate()

◆ BitmapText()

◆ blitCursor()

◆ calcAngleStep()

◆ ChangeGroupColor()

◆ ChangeGroupDepth()

◆ ChangeGroupUndimmed()

◆ ClearCache()

◆ ClearScreen()

◆ ClearTarget()

◆ computeMinGridSpacing()

◆ computeWorldScale()

◆ ComputeWorldScreenMatrix()

◆ DeleteGroup()

◆ DrawArc()

◆ DrawArcSegment()

◆ drawAxes()

◆ DrawBitmap()

◆ DrawCircle()

◆ DrawCursor()

◆ DrawCurve()

◆ DrawEllipse()

◆ DrawEllipseArc()

◆ DrawGlyph()

◆ DrawGlyphs()

◆ DrawGrid()

◆ drawGridCoverageShape()

◆ drawGridCross()

◆ drawGridLine()

◆ drawGridPoint()

◆ drawGridSource()

◆ drawGridSources()

◆ DrawGroup()

◆ DrawHoleWall()

◆ DrawLine()

◆ DrawPad()

◆ drawPoly() [1/4]

◆ drawPoly() [2/4]

◆ drawPoly() [3/4]

◆ drawPoly() [4/4]

◆ DrawPolygon() [1/4]

◆ DrawPolygon() [2/4]

◆ DrawPolygon() [3/4]

◆ DrawPolygon() [4/4]

◆ DrawPolyline() [1/4]

◆ DrawPolyline() [2/4]

◆ DrawPolyline() [3/4]

◆ DrawPolyline() [4/4]

◆ DrawPolylines()

◆ DrawRectangle() [1/2]

◆ DrawRectangle() [2/2]

◆ DrawSegment()

◆ DrawSegmentChain() [1/2]

◆ DrawSegmentChain() [2/2]

◆ DrawTrack()