KIGFX::CAIRO_GAL_BASE Class Reference

#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. More...
void	DrawLine (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint) override
	Draw a line. More...
void	DrawSegment (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint, double aWidth) override
	Draw a rounded segment. More...
void	DrawCircle (const VECTOR2D &aCenterPoint, double aRadius) override
	Draw a circle using world coordinates. More...
void	DrawArc (const VECTOR2D &aCenterPoint, double aRadius, double aStartAngle, double aEndAngle) override
	Draw an arc. More...
void	DrawArcSegment (const VECTOR2D &aCenterPoint, double aRadius, double aStartAngle, double aEndAngle, double aWidth) override
	Draw an arc segment. More...
void	DrawRectangle (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint) override
	Draw a rectangle. More...
void	DrawPolyline (const std::deque< VECTOR2D > &aPointList) override
	Draw a polyline. More...
void	DrawPolyline (const VECTOR2D aPointList[], int aListSize) override
void	DrawPolyline (const SHAPE_LINE_CHAIN &aLineChain) override
void	DrawPolygon (const std::deque< VECTOR2D > &aPointList) override
	Draw a polygon. More...
void	DrawPolygon (const VECTOR2D aPointList[], int aListSize) override
void	DrawPolygon (const SHAPE_POLY_SET &aPolySet) override
void	DrawPolygon (const SHAPE_LINE_CHAIN &aPolySet) override
void	DrawCurve (const VECTOR2D &startPoint, const VECTOR2D &controlPointA, const VECTOR2D &controlPointB, const VECTOR2D &endPoint, double aFilterValue=0.0) override
	Draw a cubic bezier spline. More...
void	DrawBitmap (const BITMAP_BASE &aBitmap) override
	Draw a bitmap image. More...
void	ResizeScreen (int aWidth, int aHeight) override
	Resizes the canvas. More...
void	Flush () override
	Force all remaining objects to be drawn. More...
void	ClearScreen () override
	Clear the screen. More...
void	SetIsFill (bool aIsFillEnabled) override
	Enable/disable fill. More...
void	SetIsStroke (bool aIsStrokeEnabled) override
	Enable/disable stroked outlines. More...
void	SetStrokeColor (const COLOR4D &aColor) override
	Set the stroke color. More...
void	SetFillColor (const COLOR4D &aColor) override
	Set the fill color. More...
void	SetLineWidth (float aLineWidth) override
	Set the line width. More...
void	SetLayerDepth (double aLayerDepth) override
	Set the depth of the layer (position on the z-axis) More...
void	Transform (const MATRIX3x3D &aTransformation) override
	Transform the context. More...
void	Rotate (double aAngle) override
	Rotate the context. More...
void	Translate (const VECTOR2D &aTranslation) override
	Translate the context. More...
void	Scale (const VECTOR2D &aScale) override
	Scale the context. More...
void	Save () override
	Save the context. More...
void	Restore () override
	Restore the context. More...
int	BeginGroup () override
	Begin a group. More...
void	EndGroup () override
	End the group. More...
void	DrawGroup (int aGroupNumber) override
	Draw the stored group. More...
void	ChangeGroupColor (int aGroupNumber, const COLOR4D &aNewColor) override
	Change the color used to draw the group. More...
void	ChangeGroupDepth (int aGroupNumber, int aDepth) override
	Change the depth (Z-axis position) of the group. More...
void	DeleteGroup (int aGroupNumber) override
	Delete the group from the memory. More...
void	ClearCache () override
	Delete all data created during caching of graphic items. More...
void	SetNegativeDrawMode (bool aSetting) override
	Set negative draw mode in the renderer. More...
void	DrawCursor (const VECTOR2D &aCursorPosition) override
	Draw the cursor. More...
void	EnableDepthTest (bool aEnabled=false) override
void	DrawGrid () override
virtual bool	IsInitialized () const
	Return the initialization status for the canvas. More...
virtual bool	IsVisible () const
	Return true if the GAL canvas is visible on the screen. More...
virtual bool	IsOpenGlEngine ()
	Return true if the GAL engine is a OpenGL based type. More...
virtual bool	Show (bool aShow)
	Show/hide the GAL canvas. More...
const VECTOR2I &	GetScreenPixelSize () const
	Return GAL canvas size in pixels. More...
void	SetClearColor (const COLOR4D &aColor)
const COLOR4D &	GetClearColor () const
const COLOR4D &	GetFillColor () const
	Get the fill color. More...
const COLOR4D &	GetStrokeColor () const
	Get the stroke color. More...
float	GetLineWidth () const
	Get the line width. More...
const STROKE_FONT &	GetStrokeFont () const
virtual void	StrokeText (const wxString &aText, const VECTOR2D &aPosition, double aRotationAngle)
	Draw a vector type text using preloaded Newstroke font. More...
virtual void	BitmapText (const wxString &aText, const VECTOR2D &aPosition, double aRotationAngle)
	Draw a text using a bitmap font. More...
VECTOR2D	GetTextLineSize (const UTF8 &aText) const
	Compute the X and Y size of a given text. More...
virtual void	SetTextAttributes (const EDA_TEXT *aText)
	Loads attributes of the given text (bold/italic/underline/mirrored and so on). More...
void	ResetTextAttributes ()
	Reset text attributes to default styling. More...
void	SetGlyphSize (const VECTOR2D aSize)
	Set the font glyph size. More...
const VECTOR2D &	GetGlyphSize () const
void	SetFontBold (const bool aBold)
	Set bold property of current font. More...
bool	IsFontBold () const
void	SetFontItalic (bool aItalic)
	Set italic property of current font. More...
bool	IsFontItalic () const
void	SetFontUnderlined (bool aUnderlined)
bool	IsFontUnderlined () const
void	SetTextMirrored (const bool aMirrored)
	Set a mirrored property of text. More...
bool	IsTextMirrored () const
void	SetHorizontalJustify (const EDA_TEXT_HJUSTIFY_T aHorizontalJustify)
	Set the horizontal justify for text drawing. More...
EDA_TEXT_HJUSTIFY_T	GetHorizontalJustify () const
	Return current text horizontal justification setting. More...
void	SetVerticalJustify (const EDA_TEXT_VJUSTIFY_T aVerticalJustify)
	Set the vertical justify for text drawing. More...
EDA_TEXT_VJUSTIFY_T	GetVerticalJustify () const
	Returns current text vertical justification setting. More...
virtual void	ComputeWorldScreenMatrix ()
	Compute the world <-> screen transformation matrix. More...
const MATRIX3x3D &	GetWorldScreenMatrix () const
	Get the world <-> screen transformation matrix. More...
const MATRIX3x3D &	GetScreenWorldMatrix () const
	Get the screen <-> world transformation matrix. More...
void	SetWorldScreenMatrix (const MATRIX3x3D &aMatrix)
	Set the world <-> screen transformation matrix. More...
BOX2D	GetVisibleWorldExtents () const
void	SetWorldUnitLength (double aWorldUnitLength)
	Set the unit length. More...
void	SetScreenSize (const VECTOR2I &aSize)
void	SetScreenDPI (double aScreenDPI)
	Set the dots per inch of the screen. More...
void	SetLookAtPoint (const VECTOR2D &aPoint)
	Set the Point in world space to look at. More...
const VECTOR2D &	GetLookAtPoint () const
	Get the look at point. More...
void	SetZoomFactor (double aZoomFactor)
	Set the zoom factor of the scene. More...
double	GetZoomFactor () const
	Get the zoom factor. More...
void	SetRotation (double aRotation)
	Set the rotation angle. More...
double	GetRotation () const
	Get the rotation angle. More...
void	SetDepthRange (const VECTOR2D &aDepthRange)
	Set the range of the layer depth. More...
double	GetMinDepth () const
	Return the minimum depth in the currently used range (the top). More...
double	GetMaxDepth () const
	Return the maximum depth in the currently used range (the bottom). More...
double	GetWorldScale () const
	Get the world scale. More...
void	SetFlip (bool xAxis, bool yAxis)
	Sets flipping of the screen. More...
bool	IsFlippedX () const
	Return true if flip flag for the X axis is set. More...
bool	IsFlippedY () const
	Return true if flip flag for the Y axis is set. More...
virtual void	SetTarget (RENDER_TARGET aTarget)
	Set the target for rendering. More...
virtual RENDER_TARGET	GetTarget () const
	Get the currently used target for rendering. More...
virtual void	ClearTarget (RENDER_TARGET aTarget)
	Clear the target for rendering. More...
virtual bool	HasTarget (RENDER_TARGET aTarget)
	Return true if the target exists. More...
void	SetGridVisibility (bool aVisibility)
	Set the visibility setting of the grid. More...
bool	GetGridVisibility () const
bool	GetGridSnapping () const
void	SetGridOrigin (const VECTOR2D &aGridOrigin)
	Set the origin point for the grid. More...
const VECTOR2D &	GetGridOrigin () const
void	SetGridSize (const VECTOR2D &aGridSize)
	Set the grid size. More...
const VECTOR2D &	GetGridSize () const
	Return the grid size. More...
void	SetGridColor (const COLOR4D &aGridColor)
	Set the grid color. More...
void	SetAxesColor (const COLOR4D &aAxesColor)
	Set the axes color. More...
void	SetAxesEnabled (bool aAxesEnabled)
	Enable drawing the axes. More...
void	SetCoarseGrid (int aInterval)
	Draw every tick line wider. More...
float	GetGridLineWidth () const
	Get the grid line width. More...
VECTOR2D	GetGridPoint (const VECTOR2D &aPoint) const
	For a given point it returns the nearest point belonging to the grid in world coordinates. More...
VECTOR2D	ToWorld (const VECTOR2D &aPoint) const
	Compute the point position in world coordinates from given screen coordinates. More...
VECTOR2D	ToScreen (const VECTOR2D &aPoint) const
	Compute the point position in screen coordinates from given world coordinates. More...
virtual bool	SetNativeCursorStyle (KICURSOR aCursor)
	Set the cursor in the native panel. More...
void	SetCursorEnabled (bool aCursorEnabled)
	Enable/disable cursor. More...
bool	IsCursorEnabled () const
	Return information about cursor visibility. More...
void	SetCursorColor (const COLOR4D &aCursorColor)
	Set the cursor color. More...
void	AdvanceDepth ()
	Change the current depth to deeper, so it is possible to draw objects right beneath other. More...
void	PushDepth ()
	Store current drawing depth on the depth stack. More...
void	PopDepth ()
	Restore previously stored drawing depth for the depth stack. More...
virtual bool	IsContextLocked ()
	Checks the state of the context lock. More...

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

Protected Member Functions
const double	xform (double x)
const VECTOR2D	xform (double x, double y)
const VECTOR2D	xform (const VECTOR2D &aP)
const double	angle_xform (const double aAngle)
	Transform according to the rotation from m_currentWorld2Screen transform matrix. More...
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. More...
void	beginDrawing () override
void	endDrawing () override
void	resetContext ()
void	drawGridLine (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
	Draw a grid line (usually a simplified line function). More...
void	drawGridCross (const VECTOR2D &aPoint)
void	drawGridPoint (const VECTOR2D &aPoint, double aWidth, double aHeight)
void	drawAxes (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
void	flushPath ()
void	storePath ()
	Store the actual path. More...
void	blitCursor (wxMemoryDC &clientDC)
	Blit cursor into the current screen. More...
void	drawPoly (const std::deque< VECTOR2D > &aPointList)
	Drawing polygons & polylines is the same in Cairo, so here is the common code. More...
void	drawPoly (const VECTOR2D aPointList[], int aListSize)
void	drawPoly (const SHAPE_LINE_CHAIN &aLineChain)
unsigned int	getNewGroupNumber ()
	Return a valid key that can be used as a new group number. More...
void	syncLineWidth (bool aForceWidth=false, double aWidth=0.0)
void	updateWorldScreenMatrix ()
const VECTOR2D	roundp (const VECTOR2D &v)
virtual void	lockContext (int aClientCookie)
	Use GAL_CONTEXT_LOCKER RAII object. More...
virtual void	unlockContext (int aClientCookie)
virtual void	beginUpdate ()
	Enable item update mode. More...
virtual void	endUpdate ()
	Disable item update mode. More...
void	computeWorldScale ()
	Compute the scaling factor for the world->screen matrix. More...
double	computeMinGridSpacing () const
	compute minimum grid spacing from the grid settings More...
COLOR4D	getCursorColor () const
	Get the actual cursor color to draw. More...
void	OnGalDisplayOptionsChanged (const GAL_DISPLAY_OPTIONS &aOptions) override
	Handler for observer settings changes. More...
virtual bool	updatedGalDisplayOptions (const GAL_DISPLAY_OPTIONS &aOptions)
	Handle updating display options. More...

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

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

Detailed Description

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

super

typedef GAL KIGFX::CAIRO_GAL_BASE::super

protected

Super class definition.

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

    {
        CMD_SET_FILL,                               
        CMD_SET_STROKE,                             
        CMD_SET_FILLCOLOR,                          
        CMD_SET_STROKECOLOR,                        
        CMD_SET_LINE_WIDTH,                         
        CMD_STROKE_PATH,                            
        CMD_FILL_PATH,                              
        //CMD_TRANSFORM,                              ///< Transform the actual context
        CMD_ROTATE,                                 
        CMD_TRANSLATE,                              
        CMD_SCALE,                                  
        CMD_SAVE,                                   
        CMD_RESTORE,                                
        CMD_CALL_GROUP                              
    };

Constructor & Destructor Documentation

CAIRO_GAL_BASE()

CAIRO_GAL_BASE::CAIRO_GAL_BASE

(

GAL_DISPLAY_OPTIONS &

aDisplayOptions

)

Definition at line 49 of file cairo_gal.cpp.

                                                                     : GAL( aDisplayOptions )
{
    // Initialise grouping
    m_isGrouping = false;
    m_isElementAdded = false;
    m_groupCounter = 0;
    m_currentGroup = nullptr;

    m_lineWidth = 1.0;
    m_lineWidthInPixels = 1.0;
    m_lineWidthIsOdd = true;

    // Initialise Cairo state
    cairo_matrix_init_identity( &m_cairoWorldScreenMatrix );
    m_currentContext = nullptr;
    m_context = nullptr;
    m_surface = nullptr;

    // Grid color settings are different in Cairo and OpenGL
    SetGridColor( COLOR4D( 0.1, 0.1, 0.1, 0.8 ) );
    SetAxesColor( COLOR4D( BLUE ) );

    // Avoid uninitialized variables:
    cairo_matrix_init_identity( &m_currentXform );
    cairo_matrix_init_identity( &m_currentWorld2Screen );
}

References BLUE, 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().

~CAIRO_GAL_BASE()

CAIRO_GAL_BASE::~CAIRO_GAL_BASE

(

)

Definition at line 77 of file cairo_gal.cpp.

{
    ClearCache();

    if( m_surface )
        cairo_surface_destroy( m_surface );

    if( m_context )
        cairo_destroy( m_context );

    for( _cairo_surface* imageSurface : m_imageSurfaces )
        cairo_surface_destroy( imageSurface );
}

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.

Definition at line 1023 of file graphics_abstraction_layer.h.

    {
        m_layerDepth -= 0.05;
    }

References KIGFX::GAL::m_layerDepth.

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

angle_xform()

const double CAIRO_GAL_BASE::angle_xform ( const 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 127 of file cairo_gal.cpp.

{
    // calculate rotation angle due to the rotation transform
    // and if flipped on X axis.
    double world_rotation = -std::atan2( m_currentWorld2Screen.xy, m_currentWorld2Screen.xx );

    // When flipped on X axis, the rotation angle is M_PI - initial angle:
    if( IsFlippedX() )
        world_rotation = M_PI - world_rotation;

    return std::fmod( aAngle + world_rotation, 2.0 * M_PI );
}

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

Referenced by arc_angles_xform_and_normalize().

arc_angles_xform_and_normalize()

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

protected

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

Parameters

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

Definition at line 141 of file cairo_gal.cpp.

{
    double startAngle = aStartAngle;
    double endAngle = aEndAngle;

    // When the view is flipped, the coordinates are flipped by the matrix transform
    // However, arc angles need to be "flipped": the flipped angle is M_PI - initial angle.
    if( IsFlippedX() )
    {
        startAngle = M_PI - startAngle;
        endAngle = M_PI - endAngle;
    }

    // Normalize arc angles
    SWAP( startAngle, >, endAngle );

    // now rotate arc according to the rotation transform matrix
    // Remark:
    // We call angle_xform() to calculate angles according to the flip/rotation
    // transform and normalize between -2M_PI and +2M_PI.
    // Therefore, if aStartAngle = aEndAngle + 2*n*M_PI, the transform gives
    // aEndAngle = aStartAngle
    // So, if this is the case, force the aEndAngle value to draw a circle.
    aStartAngle = angle_xform( startAngle );

    if( std::abs( aEndAngle - aStartAngle ) >= 2 * M_PI ) // arc is a full circle
        aEndAngle = aStartAngle + 2 * M_PI;
    else
        aEndAngle = angle_xform( endAngle );
}

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

Referenced by DrawArc(), and DrawArcSegment().

beginDrawing()

void CAIRO_GAL_BASE::beginDrawing ( )

overrideprotectedvirtual

Reimplemented from KIGFX::GAL.

Reimplemented in KIGFX::CAIRO_GAL.

Definition at line 92 of file cairo_gal.cpp.

{
    resetContext();
}

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.

Reimplemented in KIGFX::CAIRO_GAL.

Definition at line 756 of file cairo_gal.cpp.

{
    // If the grouping is started: the actual path is stored in the group, when
    // a attribute was changed or when grouping stops with the end group method.
    storePath();

    GROUP group;
    int   groupNumber = getNewGroupNumber();
    m_groups.insert( std::make_pair( groupNumber, group ) );
    m_currentGroup = &m_groups[groupNumber];
    m_isGrouping = true;

    return groupNumber;
}

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

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

beginUpdate()

virtual void KIGFX::GAL::beginUpdate ( )

inlineprotectedvirtualinherited

Enable item update mode.

Private: use GAL_UPDATE_CONTEXT RAII object

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1064 of file graphics_abstraction_layer.h.

{}

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

BitmapText()

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

inlinevirtualinherited

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.
aRotationAngle	is the text rotation angle.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 361 of file graphics_abstraction_layer.h.

    {
        // Fallback: use stroke font

        // Handle flipped view
        if( m_globalFlipX )
            textProperties.m_mirrored = !textProperties.m_mirrored;

        // Bitmap font is slightly smaller and slightly heavier than the stroke font so we
        // compensate a bit before stroking
        float    saveLineWidth = m_lineWidth;
        VECTOR2D saveGlyphSize = textProperties.m_glyphSize;
        {
            m_lineWidth *= 1.2f;
            textProperties.m_glyphSize = textProperties.m_glyphSize * 0.8;

            StrokeText( aText, aPosition, aRotationAngle );
        }
        m_lineWidth = saveLineWidth;
        textProperties.m_glyphSize = saveGlyphSize;

        if( m_globalFlipX )
            textProperties.m_mirrored = !textProperties.m_mirrored;
    }

References KIGFX::GAL::m_globalFlipX, KIGFX::GAL::TEXT_PROPERTIES::m_glyphSize, KIGFX::GAL::m_lineWidth, KIGFX::GAL::TEXT_PROPERTIES::m_mirrored, KIGFX::GAL::StrokeText(), and KIGFX::GAL::textProperties.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), 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 1109 of file cairo_gal.cpp.

{
    if( !IsCursorEnabled() )
        return;

    VECTOR2D      p = ToScreen( m_cursorPosition );
    const COLOR4D cColor = getCursorColor();
    const int     cursorSize = m_fullscreenCursor ? 8000 : 80;

    wxColour color( cColor.r * cColor.a * 255, cColor.g * cColor.a * 255, cColor.b * cColor.a * 255,
                    255 );
    clientDC.SetPen( wxPen( color ) );
    clientDC.DrawLine( p.x - cursorSize / 2, p.y, p.x + cursorSize / 2, p.y );
    clientDC.DrawLine( p.x, p.y - cursorSize / 2, p.x, p.y + cursorSize / 2 );
}

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

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

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

{
    storePath();

    for( auto it = m_groups[aGroupNumber].begin(); it != m_groups[aGroupNumber].end(); ++it )
    {
        if( it->m_Command == CMD_SET_FILLCOLOR || it->m_Command == CMD_SET_STROKECOLOR )
        {
            it->m_Argument.DblArg[0] = aNewColor.r;
            it->m_Argument.DblArg[1] = aNewColor.g;
            it->m_Argument.DblArg[2] = aNewColor.b;
            it->m_Argument.DblArg[3] = aNewColor.a;
        }
    }
}

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

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

ClearCache()

void CAIRO_GAL_BASE::ClearCache ( )

overridevirtual

Delete all data created during caching of graphic items.

Reimplemented from KIGFX::GAL.

Definition at line 913 of file cairo_gal.cpp.

{
    for( auto it = m_groups.begin(); it != m_groups.end(); )
        DeleteGroup( ( it++ )->first );
}

References DeleteGroup(), and m_groups.

Referenced by ~CAIRO_GAL_BASE().

ClearScreen()

void CAIRO_GAL_BASE::ClearScreen ( )

overridevirtual

Clear the screen.

Parameters

aColor

is the color used for clearing.

Reimplemented from KIGFX::GAL.

Definition at line 542 of file cairo_gal.cpp.

{
    cairo_set_source_rgb( m_currentContext, m_clearColor.r, m_clearColor.g, m_clearColor.b );
    cairo_rectangle( m_currentContext, 0.0, 0.0, m_screenSize.x, m_screenSize.y );
    cairo_fill( m_currentContext );
}

References KIGFX::COLOR4D::b, KIGFX::COLOR4D::g, KIGFX::GAL::m_clearColor, m_currentContext, KIGFX::GAL::m_screenSize, KIGFX::COLOR4D::r, VECTOR2< T >::x, and VECTOR2< T >::y.

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, and KIGFX::OPENGL_GAL.

Definition at line 798 of file graphics_abstraction_layer.h.

{};

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

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

{
    // just return the current value. This could be cleverer and take
    // into account other settings in future
    return m_gridMinSpacing;
}

References KIGFX::GAL::m_gridMinSpacing.

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

computeWorldScale()

void KIGFX::GAL::computeWorldScale ( )

inlineprotectedinherited

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

Definition at line 1078 of file graphics_abstraction_layer.h.

    {
        m_worldScale = m_screenDPI * m_worldUnitLength * m_zoomFactor;
    }

References KIGFX::GAL::m_screenDPI, KIGFX::GAL::m_worldScale, KIGFX::GAL::m_worldUnitLength, and KIGFX::GAL::m_zoomFactor.

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

ComputeWorldScreenMatrix()

void GAL::ComputeWorldScreenMatrix ( )

virtualinherited

Compute the world <-> screen transformation matrix.

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

Definition at line 186 of file graphics_abstraction_layer.cpp.

{
    computeWorldScale();

    MATRIX3x3D translation;
    translation.SetIdentity();
    translation.SetTranslation( 0.5 * VECTOR2D( m_screenSize ) );

    MATRIX3x3D rotate;
    rotate.SetIdentity();
    rotate.SetRotation( m_rotation );

    MATRIX3x3D scale;
    scale.SetIdentity();
    scale.SetScale( VECTOR2D( m_worldScale, m_worldScale ) );

    MATRIX3x3D flip;
    flip.SetIdentity();
    flip.SetScale( VECTOR2D( m_globalFlipX ? -1.0 : 1.0, m_globalFlipY ? -1.0 : 1.0 ) );

    MATRIX3x3D lookat;
    lookat.SetIdentity();
    lookat.SetTranslation( -m_lookAtPoint );

    m_worldScreenMatrix = translation * rotate * flip * scale * lookat;
    m_screenWorldMatrix = m_worldScreenMatrix.Inverse();
}

References KIGFX::GAL::computeWorldScale(), MATRIX3x3< T >::Inverse(), KIGFX::GAL::m_globalFlipX, KIGFX::GAL::m_globalFlipY, KIGFX::GAL::m_lookAtPoint, KIGFX::GAL::m_rotation, KIGFX::GAL::m_screenSize, KIGFX::GAL::m_screenWorldMatrix, KIGFX::GAL::m_worldScale, KIGFX::GAL::m_worldScreenMatrix, scale, MATRIX3x3< T >::SetIdentity(), MATRIX3x3< T >::SetRotation(), MATRIX3x3< T >::SetScale(), and MATRIX3x3< T >::SetTranslation().

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

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

{
    storePath();

    // Delete the Cairo paths
    std::deque<GROUP_ELEMENT>::iterator it, end;

    for( it = m_groups[aGroupNumber].begin(), end = m_groups[aGroupNumber].end(); it != end; ++it )
    {
        if( it->m_Command == CMD_FILL_PATH || it->m_Command == CMD_STROKE_PATH )
            cairo_path_destroy( it->m_CairoPath );
    }

    // Delete the group
    m_groups.erase( aGroupNumber );
}

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

Referenced by ClearCache().

DrawArc()

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

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.
aEndAngle	is the end angle of the arc.

Reimplemented from KIGFX::GAL.

Definition at line 307 of file cairo_gal.cpp.

{
    syncLineWidth();

    // calculate start and end arc angles according to the rotation transform matrix
    // and normalize:
    arc_angles_xform_and_normalize( aStartAngle, aEndAngle );

    double r = xform( aRadius );

    // N.B. This is backwards. We set this because we want to adjust the center
    // point that changes both endpoints.  In the worst case, this is twice as far.
    // We cannot adjust radius or center based on the other because this causes the
    // whole arc to change position/size
    m_lineWidthIsOdd = !( static_cast<int>( aRadius ) % 2 );

    auto mid = roundp( xform( aCenterPoint ) );

    cairo_set_line_width( m_currentContext, m_lineWidthInPixels );
    cairo_new_sub_path( m_currentContext );

    if( m_isFillEnabled )
        cairo_move_to( m_currentContext, mid.x, mid.y );

    cairo_arc( m_currentContext, mid.x, mid.y, r, aStartAngle, aEndAngle );

    if( m_isFillEnabled )
        cairo_close_path( m_currentContext );

    flushPath();

    m_isElementAdded = true;
}

References arc_angles_xform_and_normalize(), flushPath(), m_currentContext, m_isElementAdded, KIGFX::GAL::m_isFillEnabled, m_lineWidthInPixels, m_lineWidthIsOdd, roundp(), syncLineWidth(), and xform().

Referenced by DrawArcSegment().

DrawArcSegment()

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

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.

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.
aEndAngle	is the end angle of the arc.
aWidth	is the thickness of the arc (pen size).

Reimplemented from KIGFX::GAL.

Definition at line 343 of file cairo_gal.cpp.

{
    if( m_isFillEnabled )
    {
        m_lineWidth = aWidth;
        m_isStrokeEnabled = true;
        m_isFillEnabled = false;
        DrawArc( aCenterPoint, aRadius, aStartAngle, aEndAngle );
        m_isFillEnabled = true;
        m_isStrokeEnabled = false;
        return;
    }

    syncLineWidth();

    // calculate start and end arc angles according to the rotation transform matrix
    // and normalize:
    double startAngleS = aStartAngle;
    double endAngleS = aEndAngle;
    arc_angles_xform_and_normalize( startAngleS, endAngleS );

    double r = xform( aRadius );

    // N.B. This is backwards. We set this because we want to adjust the center
    // point that changes both endpoints.  In the worst case, this is twice as far.
    // We cannot adjust radius or center based on the other because this causes the
    // whole arc to change position/size
    m_lineWidthIsOdd = !( static_cast<int>( aRadius ) % 2 );

    VECTOR2D mid = roundp( xform( aCenterPoint ) );
    double   width = xform( aWidth / 2.0 );
    VECTOR2D startPointS = VECTOR2D( r, 0.0 ).Rotate( startAngleS );
    VECTOR2D endPointS = VECTOR2D( r, 0.0 ).Rotate( endAngleS );

    cairo_save( m_currentContext );

    cairo_set_source_rgba( m_currentContext, m_strokeColor.r, m_strokeColor.g, m_strokeColor.b,
                           m_strokeColor.a );

    cairo_translate( m_currentContext, mid.x, mid.y );

    cairo_new_sub_path( m_currentContext );
    cairo_arc( m_currentContext, 0, 0, r - width, startAngleS, endAngleS );

    cairo_new_sub_path( m_currentContext );
    cairo_arc( m_currentContext, 0, 0, r + width, startAngleS, endAngleS );

    cairo_new_sub_path( m_currentContext );
    cairo_arc_negative( m_currentContext, startPointS.x, startPointS.y, width, startAngleS,
                        startAngleS + M_PI );

    cairo_new_sub_path( m_currentContext );
    cairo_arc( m_currentContext, endPointS.x, endPointS.y, width, endAngleS, endAngleS + M_PI );

    cairo_restore( m_currentContext );
    flushPath();

    m_isElementAdded = true;
}

References KIGFX::COLOR4D::a, arc_angles_xform_and_normalize(), KIGFX::COLOR4D::b, DrawArc(), flushPath(), KIGFX::COLOR4D::g, m_currentContext, m_isElementAdded, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_isStrokeEnabled, KIGFX::GAL::m_lineWidth, m_lineWidthIsOdd, KIGFX::GAL::m_strokeColor, KIGFX::COLOR4D::r, VECTOR2< T >::Rotate(), roundp(), 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 969 of file cairo_gal.cpp.

{
    syncLineWidth();

    VECTOR2D p0 = roundp( xform( aStartPoint ) );
    VECTOR2D p1 = roundp( xform( aEndPoint ) );
    VECTOR2D org = roundp( xform( VECTOR2D( 0.0, 0.0 ) ) ); // Axis origin = 0,0 coord

    cairo_set_source_rgba( m_currentContext, m_axesColor.r, m_axesColor.g, m_axesColor.b,
                           m_axesColor.a );
    cairo_move_to( m_currentContext, p0.x, org.y );
    cairo_line_to( m_currentContext, p1.x, org.y );
    cairo_move_to( m_currentContext, org.x, p0.y );
    cairo_line_to( m_currentContext, org.x, p1.y );
    cairo_stroke( m_currentContext );
}

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

Referenced by DrawGrid().

DrawBitmap()

void CAIRO_GAL_BASE::DrawBitmap ( const BITMAP_BASE &  aBitmap )

overridevirtual

Draw a bitmap image.

Reimplemented from KIGFX::GAL.

Definition at line 462 of file cairo_gal.cpp.

{
    cairo_save( m_currentContext );

    // We have to calculate the pixel size in users units to draw the image.
    // m_worldUnitLength is a factor used for converting IU to inches
    double scale = 1.0 / ( aBitmap.GetPPI() * m_worldUnitLength );

    // The position of the bitmap is the bitmap center.
    // move the draw origin to the top left bitmap corner:
    int w = aBitmap.GetSizePixels().x;
    int h = aBitmap.GetSizePixels().y;

    cairo_set_matrix( m_currentContext, &m_currentWorld2Screen );
    cairo_scale( m_currentContext, scale, scale );
    cairo_translate( m_currentContext, -w / 2.0, -h / 2.0 );

    cairo_new_path( m_currentContext );
    cairo_surface_t* image = cairo_image_surface_create( CAIRO_FORMAT_ARGB32, w, h );
    cairo_surface_flush( image );

    unsigned char* pix_buffer = cairo_image_surface_get_data( image );

    // The pixel buffer of the initial bitmap:
    const wxImage& bm_pix_buffer = *aBitmap.GetImageData();

    uint32_t mask_color = ( bm_pix_buffer.GetMaskRed() << 16 )
                          + ( bm_pix_buffer.GetMaskGreen() << 8 ) + ( bm_pix_buffer.GetMaskBlue() );

    // Copy the source bitmap to the cairo bitmap buffer.
    // In cairo bitmap buffer, a ARGB32 bitmap is an ARGB pixel packed into a uint_32
    // 24 low bits only are used for color, top 8 are transparency.
    for( int row = 0; row < h; row++ )
    {
        for( int col = 0; col < w; col++ )
        {
            // Build the RGB24 pixel:
            uint32_t pixel = bm_pix_buffer.GetRed( col, row ) << 16;
            pixel += bm_pix_buffer.GetGreen( col, row ) << 8;
            pixel += bm_pix_buffer.GetBlue( col, row );

            if( bm_pix_buffer.HasAlpha() )
                pixel += bm_pix_buffer.GetAlpha( col, row ) << 24;
            else if( bm_pix_buffer.HasMask() && pixel == mask_color )
                pixel += ( wxALPHA_TRANSPARENT << 24 );
            else
                pixel += ( wxALPHA_OPAQUE << 24 );

            // Write the pixel to the cairo image buffer:
            uint32_t* pix_ptr = (uint32_t*) pix_buffer;
            *pix_ptr = pixel;
            pix_buffer += 4;
        }
    }

    cairo_surface_mark_dirty( image );
    cairo_set_source_surface( m_currentContext, image, 0, 0 );
    cairo_paint( m_currentContext );

    // store the image handle so it can be destroyed later
    m_imageSurfaces.push_back( image );

    m_isElementAdded = true;

    cairo_restore( m_currentContext );
}

References BITMAP_BASE::GetImageData(), BITMAP_BASE::GetPPI(), BITMAP_BASE::GetSizePixels(), image, m_currentContext, m_currentWorld2Screen, m_imageSurfaces, m_isElementAdded, KIGFX::GAL::m_worldUnitLength, and scale.

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

{
    syncLineWidth();

    VECTOR2D c = roundp( xform( aCenterPoint ) );
    double   r = ::roundp( xform( aRadius ) );

    cairo_set_line_width( m_currentContext, std::min( 2.0 * r, m_lineWidthInPixels ) );
    cairo_new_sub_path( m_currentContext );
    cairo_arc( m_currentContext, c.x, c.y, r, 0.0, 2 * M_PI );
    cairo_close_path( m_currentContext );
    flushPath();
    m_isElementAdded = true;
}

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

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

{
    m_cursorPosition = aCursorPosition;
}

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

{
    // Note: aFilterValue is not used because the cubic Bezier curve is
    // supported by Cairo.
    syncLineWidth();

    const VECTOR2D sp = roundp( xform( aStartPoint ) );
    const VECTOR2D cpa = roundp( xform( aControlPointA ) );
    const VECTOR2D cpb = roundp( xform( aControlPointB ) );
    const VECTOR2D ep = roundp( xform( aEndPoint ) );

    cairo_move_to( m_currentContext, sp.x, sp.y );
    cairo_curve_to( m_currentContext, cpa.x, cpa.y, cpb.x, cpb.y, ep.x, ep.y );
    cairo_line_to( m_currentContext, ep.x, ep.y );

    flushPath();
    m_isElementAdded = true;
}

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

DrawGrid()

void CAIRO_GAL_BASE::DrawGrid ( )

overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 1562 of file cairo_gal.cpp.

{
    SetTarget( TARGET_NONCACHED );

    // Draw the grid
    // For the drawing the start points, end points and increments have
    // to be calculated in world coordinates
    VECTOR2D worldStartPoint = m_screenWorldMatrix * VECTOR2D( 0.0, 0.0 );
    VECTOR2D worldEndPoint = m_screenWorldMatrix * VECTOR2D( m_screenSize );

    // Compute the line marker or point radius of the grid
    // Note: generic grids can't handle sub-pixel lines without
    // either losing fine/course distinction or having some dots
    // fail to render
    float marker = std::fmax( 1.0f, m_gridLineWidth ) / m_worldScale;
    float doubleMarker = 2.0f * marker;

    // Draw axes if desired
    if( m_axesEnabled )
    {
        SetLineWidth( marker );
        drawAxes( worldStartPoint, worldEndPoint );
    }

    if( !m_gridVisibility || m_gridSize.x == 0 || m_gridSize.y == 0 )
        return;

    VECTOR2D gridScreenSize( m_gridSize );

    double gridThreshold = KiROUND( computeMinGridSpacing() / m_worldScale );

    if( m_gridStyle == GRID_STYLE::SMALL_CROSS )
        gridThreshold *= 2.0;

    // If we cannot display the grid density, scale down by a tick size and
    // try again.  Eventually, we get some representation of the grid
    while( std::min( gridScreenSize.x, gridScreenSize.y ) <= gridThreshold )
    {
        gridScreenSize = gridScreenSize * static_cast<double>( m_gridTick );
    }

    // Compute grid starting and ending indexes to draw grid points on the
    // visible screen area
    // Note: later any point coordinate will be offsetted by m_gridOrigin
    int gridStartX = KiROUND( ( worldStartPoint.x - m_gridOrigin.x ) / gridScreenSize.x );
    int gridEndX = KiROUND( ( worldEndPoint.x - m_gridOrigin.x ) / gridScreenSize.x );
    int gridStartY = KiROUND( ( worldStartPoint.y - m_gridOrigin.y ) / gridScreenSize.y );
    int gridEndY = KiROUND( ( worldEndPoint.y - m_gridOrigin.y ) / gridScreenSize.y );

    // Ensure start coordinate > end coordinate

    SWAP( gridStartX, >, gridEndX );
    SWAP( gridStartY, >, gridEndY );

    // Ensure the grid fills the screen
    --gridStartX;
    ++gridEndX;
    --gridStartY;
    ++gridEndY;

    // Draw the grid behind all other layers
    SetLayerDepth( m_depthRange.y * 0.75 );

    if( m_gridStyle == GRID_STYLE::LINES )
    {
        // Now draw the grid, every coarse grid line gets the double width

        // Vertical lines
        for( int j = gridStartY; j <= gridEndY; j++ )
        {
            const double y = j * gridScreenSize.y + m_gridOrigin.y;

            if( m_axesEnabled && y == 0.0 )
                continue;

            SetLineWidth( ( j % m_gridTick ) ? marker : doubleMarker );
            drawGridLine( VECTOR2D( gridStartX * gridScreenSize.x + m_gridOrigin.x, y ),
                          VECTOR2D( gridEndX * gridScreenSize.x + m_gridOrigin.x, y ) );
        }

        // Horizontal lines
        for( int i = gridStartX; i <= gridEndX; i++ )
        {
            const double x = i * gridScreenSize.x + m_gridOrigin.x;

            if( m_axesEnabled && x == 0.0 )
                continue;

            SetLineWidth( ( i % m_gridTick ) ? marker : doubleMarker );
            drawGridLine( VECTOR2D( x, gridStartY * gridScreenSize.y + m_gridOrigin.y ),
                          VECTOR2D( x, gridEndY * gridScreenSize.y + m_gridOrigin.y ) );
        }
    }
    else // Dots or Crosses grid
    {
        m_lineWidthIsOdd = true;
        m_isStrokeEnabled = true;
        for( int j = gridStartY; j <= gridEndY; j++ )
        {
            bool tickY = ( j % m_gridTick == 0 );

            for( int i = gridStartX; i <= gridEndX; i++ )
            {
                bool     tickX = ( i % m_gridTick == 0 );
                VECTOR2D pos{ i * gridScreenSize.x + m_gridOrigin.x,
                              j * gridScreenSize.y + m_gridOrigin.y };

                if( m_gridStyle == GRID_STYLE::SMALL_CROSS )
                {
                    SetLineWidth( ( tickX && tickY ) ? doubleMarker : marker );
                    drawGridCross( pos );
                }
                else if( m_gridStyle == GRID_STYLE::DOTS )
                {
                    double doubleGridLineWidth = m_gridLineWidth * 2.0f;
                    drawGridPoint( pos, ( tickX ) ? doubleGridLineWidth : m_gridLineWidth,
                                   ( tickY ) ? doubleGridLineWidth : m_gridLineWidth );
                }
            }
        }
    }
}

References KIGFX::GAL::computeMinGridSpacing(), KIGFX::DOTS, drawAxes(), drawGridCross(), drawGridLine(), drawGridPoint(), KiROUND(), KIGFX::LINES, KIGFX::GAL::m_axesEnabled, KIGFX::GAL::m_depthRange, KIGFX::GAL::m_gridLineWidth, KIGFX::GAL::m_gridOrigin, KIGFX::GAL::m_gridSize, KIGFX::GAL::m_gridStyle, KIGFX::GAL::m_gridTick, KIGFX::GAL::m_gridVisibility, KIGFX::GAL::m_isStrokeEnabled, m_lineWidthIsOdd, KIGFX::GAL::m_screenSize, KIGFX::GAL::m_screenWorldMatrix, KIGFX::GAL::m_worldScale, SetLayerDepth(), SetLineWidth(), KIGFX::GAL::SetTarget(), KIGFX::SMALL_CROSS, SWAP, KIGFX::TARGET_NONCACHED, VECTOR2< T >::x, and VECTOR2< T >::y.

drawGridCross()

void CAIRO_GAL_BASE::drawGridCross ( const VECTOR2D &  aPoint )

protected

Definition at line 1001 of file cairo_gal.cpp.

{
    syncLineWidth();
    VECTOR2D offset( 0, 0 );
    double   size = 2.0 * m_lineWidthInPixels + 0.5;

    VECTOR2D p0 = roundp( xform( aPoint ) ) - VECTOR2D( size, 0 ) + offset;
    VECTOR2D p1 = roundp( xform( aPoint ) ) + VECTOR2D( size, 0 ) + offset;
    VECTOR2D p2 = roundp( xform( aPoint ) ) - VECTOR2D( 0, size ) + offset;
    VECTOR2D p3 = roundp( xform( aPoint ) ) + VECTOR2D( 0, size ) + offset;

    cairo_set_source_rgba( m_currentContext, m_gridColor.r, m_gridColor.g, m_gridColor.b,
                           m_gridColor.a );
    cairo_move_to( m_currentContext, p0.x, p0.y );
    cairo_line_to( m_currentContext, p1.x, p1.y );
    cairo_move_to( m_currentContext, p2.x, p2.y );
    cairo_line_to( m_currentContext, p3.x, p3.y );
    cairo_stroke( m_currentContext );
}

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

Referenced by DrawGrid().

drawGridLine()

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

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.

Definition at line 987 of file cairo_gal.cpp.

{
    syncLineWidth();
    VECTOR2D p0 = roundp( xform( aStartPoint ) );
    VECTOR2D p1 = roundp( xform( aEndPoint ) );

    cairo_set_source_rgba( m_currentContext, m_gridColor.r, m_gridColor.g, m_gridColor.b,
                           m_gridColor.a );
    cairo_move_to( m_currentContext, p0.x, p0.y );
    cairo_line_to( m_currentContext, p1.x, p1.y );
    cairo_stroke( m_currentContext );
}

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

Referenced by DrawGrid().

drawGridPoint()

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

protected

Definition at line 1022 of file cairo_gal.cpp.

{
    VECTOR2D p = roundp( xform( aPoint ) );

    double sw = std::max( 1.0, aWidth );
    double sh = std::max( 1.0, aHeight );

    cairo_set_source_rgba( m_currentContext, m_gridColor.r, m_gridColor.g, m_gridColor.b,
                           m_gridColor.a );
    cairo_rectangle( m_currentContext, p.x - std::floor( sw / 2 ) - 0.5,
                     p.y - std::floor( sh / 2 ) - 0.5, sw, sh );

    cairo_fill( m_currentContext );
}

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

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

{
    // This method implements a small Virtual Machine - all stored commands
    // are executed; nested calling is also possible

    storePath();

    for( auto it = m_groups[aGroupNumber].begin(); it != m_groups[aGroupNumber].end(); ++it )
    {
        switch( it->m_Command )
        {
        case CMD_SET_FILL:
            m_isFillEnabled = it->m_Argument.BoolArg;
            break;

        case CMD_SET_STROKE:
            m_isStrokeEnabled = it->m_Argument.BoolArg;
            break;

        case CMD_SET_FILLCOLOR:
            m_fillColor = COLOR4D( it->m_Argument.DblArg[0], it->m_Argument.DblArg[1],
                                   it->m_Argument.DblArg[2], it->m_Argument.DblArg[3] );
            break;

        case CMD_SET_STROKECOLOR:
            m_strokeColor = COLOR4D( it->m_Argument.DblArg[0], it->m_Argument.DblArg[1],
                                     it->m_Argument.DblArg[2], it->m_Argument.DblArg[3] );
            break;

        case CMD_SET_LINE_WIDTH:
        {
            // Make lines appear at least 1 pixel wide, no matter of zoom
            double x = 1.0, y = 1.0;
            cairo_device_to_user_distance( m_currentContext, &x, &y );
            double minWidth = std::min( fabs( x ), fabs( y ) );
            cairo_set_line_width( m_currentContext, std::max( it->m_Argument.DblArg[0], minWidth ) );
            break;
        }


        case CMD_STROKE_PATH:
            cairo_set_source_rgba( m_currentContext, m_strokeColor.r, m_strokeColor.g,
                                   m_strokeColor.b, m_strokeColor.a );
            cairo_append_path( m_currentContext, it->m_CairoPath );
            cairo_stroke( m_currentContext );
            break;

        case CMD_FILL_PATH:
            cairo_set_source_rgba( m_currentContext, m_fillColor.r, m_fillColor.g, m_fillColor.b,
                                   m_strokeColor.a );
            cairo_append_path( m_currentContext, it->m_CairoPath );
            cairo_fill( m_currentContext );
            break;

            /*
        case CMD_TRANSFORM:
            cairo_matrix_t matrix;
            cairo_matrix_init( &matrix, it->argument.DblArg[0], it->argument.DblArg[1],
                               it->argument.DblArg[2], it->argument.DblArg[3],
                               it->argument.DblArg[4], it->argument.DblArg[5] );
            cairo_transform( m_currentContext, &matrix );
            break;
            */

        case CMD_ROTATE:
            cairo_rotate( m_currentContext, it->m_Argument.DblArg[0] );
            break;

        case CMD_TRANSLATE:
            cairo_translate( m_currentContext, it->m_Argument.DblArg[0], it->m_Argument.DblArg[1] );
            break;

        case CMD_SCALE:
            cairo_scale( m_currentContext, it->m_Argument.DblArg[0], it->m_Argument.DblArg[1] );
            break;

        case CMD_SAVE:
            cairo_save( m_currentContext );
            break;

        case CMD_RESTORE:
            cairo_restore( m_currentContext );
            break;

        case CMD_CALL_GROUP:
            DrawGroup( it->m_Argument.IntArg );
            break;
        }
    }
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, 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, KIGFX::COLOR4D::g, m_currentContext, KIGFX::GAL::m_fillColor, m_groups, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_isStrokeEnabled, KIGFX::GAL::m_strokeColor, KIGFX::COLOR4D::r, and storePath().

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

{
    syncLineWidth();

    VECTOR2D p0 = roundp( xform( aStartPoint ) );
    VECTOR2D p1 = roundp( xform( aEndPoint ) );

    cairo_move_to( m_currentContext, p0.x, p0.y );
    cairo_line_to( m_currentContext, p1.x, p1.y );
    flushPath();
    m_isElementAdded = true;
}

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

drawPoly() [1/3]

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

{
    wxCHECK( aPointList.size() > 1, /* void */ );

    // Iterate over the point list and draw the segments
    std::deque<VECTOR2D>::const_iterator it = aPointList.begin();

    syncLineWidth();

    const VECTOR2D p = roundp( xform( it->x, it->y ) );

    cairo_move_to( m_currentContext, p.x, p.y );

    for( ++it; it != aPointList.end(); ++it )
    {
        const VECTOR2D p2 = roundp( xform( it->x, it->y ) );

        cairo_line_to( m_currentContext, p2.x, p2.y );
    }

    flushPath();
    m_isElementAdded = true;
}

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

Referenced by DrawPolygon(), and DrawPolyline().

drawPoly() [2/3]

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

protected

Definition at line 1151 of file cairo_gal.cpp.

{
    wxCHECK( aListSize > 1, /* void */ );

    // Iterate over the point list and draw the segments
    const VECTOR2D* ptr = aPointList;

    syncLineWidth();

    const VECTOR2D p = roundp( xform( ptr->x, ptr->y ) );
    cairo_move_to( m_currentContext, p.x, p.y );

    for( int i = 1; i < aListSize; ++i )
    {
        ++ptr;
        const VECTOR2D p2 = roundp( xform( ptr->x, ptr->y ) );
        cairo_line_to( m_currentContext, p2.x, p2.y );
    }

    flushPath();
    m_isElementAdded = true;
}

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

drawPoly() [3/3]

void CAIRO_GAL_BASE::drawPoly ( const SHAPE_LINE_CHAIN &  aLineChain )

protected

Definition at line 1175 of file cairo_gal.cpp.

{
    wxCHECK( aLineChain.PointCount() > 1, /* void */ );

    syncLineWidth();

    auto numPoints = aLineChain.PointCount();

    if( aLineChain.IsClosed() )
        numPoints += 1;

    const VECTOR2I start = aLineChain.CPoint( 0 );
    const VECTOR2D p = roundp( xform( start.x, start.y ) );
    cairo_move_to( m_currentContext, p.x, p.y );

    for( int i = 1; i < numPoints; ++i )
    {
        const VECTOR2I& pw = aLineChain.CPoint( i );
        const VECTOR2D  ps = roundp( xform( pw.x, pw.y ) );
        cairo_line_to( m_currentContext, ps.x, ps.y );
    }

    flushPath();
    m_isElementAdded = true;
}

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.

DrawPolygon() [1/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 101 of file cairo_gal.h.

{ drawPoly( aPointList ); }

References drawPoly().

DrawPolygon() [2/4]

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

inlineoverridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 102 of file cairo_gal.h.

    {
        drawPoly( aPointList, aListSize );
    }

References drawPoly().

DrawPolygon() [3/4]

void CAIRO_GAL_BASE::DrawPolygon ( const SHAPE_POLY_SET &  aPolySet )

overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 427 of file cairo_gal.cpp.

{
    for( int i = 0; i < aPolySet.OutlineCount(); ++i )
        drawPoly( aPolySet.COutline( i ) );
}

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

DrawPolygon() [4/4]

void CAIRO_GAL_BASE::DrawPolygon ( const SHAPE_LINE_CHAIN &  aPolySet )

overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 434 of file cairo_gal.cpp.

{
    drawPoly( aPolygon );
}

References drawPoly().

DrawPolyline() [1/3]

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

{ drawPoly( aPointList ); }

References drawPoly().

DrawPolyline() [2/3]

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

inlineoverridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 93 of file cairo_gal.h.

    {
        drawPoly( aPointList, aListSize );
    }

References drawPoly().

DrawPolyline() [3/3]

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

inlineoverridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 98 of file cairo_gal.h.

{ drawPoly( aLineChain ); }

References drawPoly().

DrawRectangle()

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

{
    // Calculate the diagonal points
    syncLineWidth();

    const VECTOR2D p0 = roundp( xform( aStartPoint ) );
    const VECTOR2D p1 = roundp( xform( VECTOR2D( aEndPoint.x, aStartPoint.y ) ) );
    const VECTOR2D p2 = roundp( xform( aEndPoint ) );
    const VECTOR2D p3 = roundp( xform( VECTOR2D( aStartPoint.x, aEndPoint.y ) ) );

    // The path is composed from 4 segments
    cairo_move_to( m_currentContext, p0.x, p0.y );
    cairo_line_to( m_currentContext, p1.x, p1.y );
    cairo_line_to( m_currentContext, p2.x, p2.y );
    cairo_line_to( m_currentContext, p3.x, p3.y );
    cairo_close_path( m_currentContext );
    flushPath();

    m_isElementAdded = true;
}

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

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

{
    if( m_isFillEnabled )
    {
        syncLineWidth( true, aWidth );

        VECTOR2D p0 = roundp( xform( aStartPoint ) );
        VECTOR2D p1 = roundp( xform( aEndPoint ) );

        cairo_move_to( m_currentContext, p0.x, p0.y );
        cairo_line_to( m_currentContext, p1.x, p1.y );
        cairo_set_source_rgba( m_currentContext, m_fillColor.r, m_fillColor.g, m_fillColor.b,
                               m_fillColor.a );
        cairo_stroke( m_currentContext );
    }
    else
    {
        aWidth /= 2.0;
        SetLineWidth( 1.0 );
        syncLineWidth();

        // Outline mode for tracks
        VECTOR2D startEndVector = aEndPoint - aStartPoint;
        double   lineAngle = atan2( startEndVector.y, startEndVector.x );

        double sa = sin( lineAngle + M_PI / 2.0 );
        double ca = cos( lineAngle + M_PI / 2.0 );

        auto pa0 = xform( aStartPoint + VECTOR2D( aWidth * ca, aWidth * sa ) );
        auto pa1 = xform( aStartPoint - VECTOR2D( aWidth * ca, aWidth * sa ) );
        auto pb0 = xform( aEndPoint + VECTOR2D( aWidth * ca, aWidth * sa ) );
        auto pb1 = xform( aEndPoint - VECTOR2D( aWidth * ca, aWidth * sa ) );
        auto pa = xform( aStartPoint );
        auto pb = xform( aEndPoint );
        auto rb = ( pa0 - pa ).EuclideanNorm();

        cairo_set_source_rgba( m_currentContext, m_strokeColor.r, m_strokeColor.g, m_strokeColor.b,
                               m_strokeColor.a );

        cairo_move_to( m_currentContext, pa0.x, pa0.y );
        cairo_line_to( m_currentContext, pb0.x, pb0.y );

        cairo_move_to( m_currentContext, pa1.x, pa1.y );
        cairo_line_to( m_currentContext, pb1.x, pb1.y );

        cairo_arc( m_currentContext, pb.x, pb.y, rb, lineAngle - M_PI / 2.0, lineAngle + M_PI / 2.0 );
        cairo_arc( m_currentContext, pa.x, pa.y, rb, lineAngle + M_PI / 2.0,
                   lineAngle + 3.0 * M_PI / 2.0 );

        flushPath();
    }

    m_isElementAdded = true;
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, EuclideanNorm(), flushPath(), KIGFX::COLOR4D::g, m_currentContext, KIGFX::GAL::m_fillColor, m_isElementAdded, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_strokeColor, KIGFX::COLOR4D::r, roundp(), SetLineWidth(), syncLineWidth(), VECTOR2< T >::x, xform(), and VECTOR2< T >::y.

EnableDepthTest()

void CAIRO_GAL_BASE::EnableDepthTest ( bool  aEnabled = false )

overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 932 of file cairo_gal.cpp.

{
}

endDrawing()

void CAIRO_GAL_BASE::endDrawing ( )

overrideprotectedvirtual

Reimplemented from KIGFX::GAL.

Reimplemented in KIGFX::CAIRO_GAL.

Definition at line 98 of file cairo_gal.cpp.

{
    // Force remaining objects to be drawn
    Flush();
}

References Flush().

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

EndGroup()

void CAIRO_GAL_BASE::EndGroup ( )

overridevirtual

End the group.

Reimplemented from KIGFX::GAL.

Reimplemented in KIGFX::CAIRO_GAL.

Definition at line 772 of file cairo_gal.cpp.

{
    storePath();
    m_isGrouping = false;
}

References m_isGrouping, and storePath().

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

endUpdate()

virtual void KIGFX::GAL::endUpdate ( )

inlineprotectedvirtualinherited

Disable item update mode.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1067 of file graphics_abstraction_layer.h.

{}

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

Flush()

void CAIRO_GAL_BASE::Flush ( )

overridevirtual

Force all remaining objects to be drawn.

Reimplemented from KIGFX::GAL.

Definition at line 536 of file cairo_gal.cpp.

{
    storePath();
}

References storePath().

Referenced by endDrawing().

flushPath()

void CAIRO_GAL_BASE::flushPath ( )

protected

Definition at line 1038 of file cairo_gal.cpp.

{
    if( m_isFillEnabled )
    {
        cairo_set_source_rgba( m_currentContext, m_fillColor.r, m_fillColor.g, m_fillColor.b,
                               m_fillColor.a );

        if( m_isStrokeEnabled )
            cairo_fill_preserve( m_currentContext );
        else
            cairo_fill( m_currentContext );
    }

    if( m_isStrokeEnabled )
    {
        cairo_set_source_rgba( m_currentContext, m_strokeColor.r, m_strokeColor.g, m_strokeColor.b,
                               m_strokeColor.a );
        cairo_stroke( m_currentContext );
    }
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::COLOR4D::g, m_currentContext, KIGFX::GAL::m_fillColor, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_isStrokeEnabled, KIGFX::GAL::m_strokeColor, and KIGFX::COLOR4D::r.

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

GetClearColor()

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

inlineinherited

Definition at line 222 of file graphics_abstraction_layer.h.

    {
        return m_clearColor;
    }

References KIGFX::GAL::m_clearColor.

getCursorColor()

COLOR4D GAL::getCursorColor ( ) const

protectedinherited

Get the actual cursor color to draw.

Definition at line 260 of file graphics_abstraction_layer.cpp.

{
    COLOR4D color = m_cursorColor;

    // dim the cursor if it's only on because it was forced
    // (this helps to provide a hint for active tools)
    if( !m_isCursorEnabled )
        color.a = color.a * 0.5;

    return color;
}

References color, KIGFX::GAL::m_cursorColor, and KIGFX::GAL::m_isCursorEnabled.

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

GetFillColor()

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

inlineinherited

Get the fill color.

Returns

the color for filling a outline.

Definition at line 273 of file graphics_abstraction_layer.h.

    {
        return m_fillColor;
    }

References KIGFX::GAL::m_fillColor.

GetGlyphSize()

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

inlineinherited

Definition at line 416 of file graphics_abstraction_layer.h.

{ return textProperties.m_glyphSize; }

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

Referenced by KIGFX::OPENGL_GAL::BitmapText(), KIGFX::STROKE_FONT::computeOverbarVerticalPosition(), KIGFX::STROKE_FONT::computeTextLineSize(), KIGFX::STROKE_FONT::computeUnderlineVerticalPosition(), KIGFX::STROKE_FONT::Draw(), KIGFX::STROKE_FONT::drawSingleLineText(), and KIGFX::PREVIEW::SetConstantGlyphHeight().

GetGridLineWidth()

float KIGFX::GAL::GetGridLineWidth ( ) const

inlineinherited

Get the grid line width.

Returns

the grid line widthDraw the grid

Definition at line 936 of file graphics_abstraction_layer.h.

References KIGFX::GAL::m_gridLineWidth.

GetGridOrigin()

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

inlineinherited

Definition at line 861 of file graphics_abstraction_layer.h.

    {
        return m_gridOrigin;
    }

References KIGFX::GAL::m_gridOrigin.

Referenced by GRID_HELPER::GetOrigin().

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

{
#if 0
    // This old code expects a non zero grid size, which can be wrong here.
    return VECTOR2D( KiROUND( ( aPoint.x - m_gridOffset.x ) / m_gridSize.x ) * m_gridSize.x + m_gridOffset.x,
                     KiROUND( ( aPoint.y - m_gridOffset.y ) / m_gridSize.y ) * m_gridSize.y + m_gridOffset.y );
#else
    // if grid size == 0.0 there is no grid, so use aPoint as grid reference position
    double cx = m_gridSize.x > 0.0 ? KiROUND( ( aPoint.x - m_gridOffset.x ) / m_gridSize.x ) * m_gridSize.x + m_gridOffset.x
                                   : aPoint.x;
    double cy = m_gridSize.y > 0.0 ? KiROUND( ( aPoint.y - m_gridOffset.y ) / m_gridSize.y ) * m_gridSize.y + m_gridOffset.y
                                   : aPoint.y;

    return VECTOR2D( cx, cy );
#endif
}

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

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

GetGridSize()

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

inlineinherited

Return the grid size.

Returns

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

Definition at line 888 of file graphics_abstraction_layer.h.

    {
        return m_gridSize;
    }

References KIGFX::GAL::m_gridSize.

Referenced by COMMON_TOOLS::CursorControl(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), GRID_HELPER::GetGrid(), EDA_DRAW_FRAME::GetNearestGridPosition(), EDA_DRAW_FRAME::GetNearestHalfGridPosition(), EE_SELECTION_TOOL::GetNode(), COMMON_TOOLS::PanControl(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

GetGridSnapping()

bool KIGFX::GAL::GetGridSnapping ( ) const

inlineinherited

Definition at line 836 of file graphics_abstraction_layer.h.

    {
        return m_options.m_gridSnapping == KIGFX::GRID_SNAPPING::ALWAYS ||
                 ( m_gridVisibility && m_options.m_gridSnapping == KIGFX::GRID_SNAPPING::WITH_GRID );
    }

References KIGFX::ALWAYS, KIGFX::GAL_DISPLAY_OPTIONS::m_gridSnapping, KIGFX::GAL::m_gridVisibility, KIGFX::GAL::m_options, and KIGFX::WITH_GRID.

Referenced by GRID_HELPER::canUseGrid(), KIGFX::WX_VIEW_CONTROLS::GetRawCursorPosition(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

GetGridVisibility()

bool KIGFX::GAL::GetGridVisibility ( ) const

inlineinherited

Definition at line 834 of file graphics_abstraction_layer.h.

{ return m_gridVisibility; }

References KIGFX::GAL::m_gridVisibility.

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

GetHorizontalJustify()

EDA_TEXT_HJUSTIFY_T KIGFX::GAL::GetHorizontalJustify ( ) const

inlineinherited

Return current text horizontal justification setting.

Definition at line 458 of file graphics_abstraction_layer.h.

    {
        return textProperties.m_horizontalJustify;
    }

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

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

GetLineWidth()

float KIGFX::GAL::GetLineWidth ( ) const

inlineinherited

Get the line width.

Returns

the actual line width.

Definition at line 313 of file graphics_abstraction_layer.h.

    {
        return m_lineWidth;
    }

References KIGFX::GAL::m_lineWidth.

Referenced by KIGFX::STROKE_FONT::computeTextLineSize(), KIGFX::STROKE_FONT::Draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::STROKE_FONT::drawSingleLineText(), and KIGFX::PREVIEW::DrawTextNextToCursor().

GetLookAtPoint()

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

inlineinherited

Get the look at point.

Returns

the look at point.

Definition at line 663 of file graphics_abstraction_layer.h.

    {
        return m_lookAtPoint;
    }

References KIGFX::GAL::m_lookAtPoint.

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

GetMaxDepth()

double KIGFX::GAL::GetMaxDepth ( ) const

inlineinherited

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

Definition at line 732 of file graphics_abstraction_layer.h.

    {
        return m_depthRange.y;
    }

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

GetMinDepth()

double KIGFX::GAL::GetMinDepth ( ) const

inlineinherited

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

Definition at line 724 of file graphics_abstraction_layer.h.

    {
        return m_depthRange.x;
    }

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

Referenced by KIGFX::PREVIEW::RULER_ITEM::ViewDraw().

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

{
    wxASSERT_MSG( m_groups.size() < std::numeric_limits<unsigned int>::max(),
                  wxT( "There are no free slots to store a group" ) );

    while( m_groups.find( m_groupCounter ) != m_groups.end() )
        m_groupCounter++;

    return m_groupCounter++;
}

References m_groupCounter, and m_groups.

Referenced by BeginGroup().

GetRotation()

double KIGFX::GAL::GetRotation ( ) const

inlineinherited

Get the rotation angle.

Returns

The rotation angle (radians).

Definition at line 703 of file graphics_abstraction_layer.h.

    {
        return m_rotation;
    }

References KIGFX::GAL::m_rotation.

GetScreenPixelSize()

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

inlineinherited

Return GAL canvas size in pixels.

Definition at line 209 of file graphics_abstraction_layer.h.

    {
        return m_screenSize;
    }

References KIGFX::GAL::m_screenSize.

Referenced by KIGFX::WX_VIEW_CONTROLS::CenterOnCursor(), KIGFX::VIEW::GetScreenPixelSize(), KIGFX::VIEW::GetViewport(), EDA_DRAW_PANEL_GAL::onSize(), KIGFX::VIEW::Redraw(), KIGFX::VIEW::SetCenter(), KIGFX::WX_VIEW_CONTROLS::SetCrossHairCursorPosition(), KIGFX::VIEW::SetViewport(), and KIGFX::WX_VIEW_CONTROLS::WarpCursor().

GetScreenWorldMatrix()

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

inlineinherited

Get the screen <-> world transformation matrix.

Returns

the transformation matrix.

Definition at line 594 of file graphics_abstraction_layer.h.

    {
        return m_screenWorldMatrix;
    }

References KIGFX::GAL::m_screenWorldMatrix.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::getShadowWidth(), KIGFX::GAL::GetVisibleWorldExtents(), KIGFX::OPENGL_GAL::getWorldPixelSize(), screenSpaceCircle(), screenSpaceLine(), and KIGFX::VIEW::ToWorld().

GetStrokeColor()

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

inlineinherited

Get the stroke color.

Returns

the color for stroking the outline.

Definition at line 293 of file graphics_abstraction_layer.h.

    {
        return m_strokeColor;
    }

References KIGFX::GAL::m_strokeColor.

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

GetStrokeFont()

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

inlineinherited

Definition at line 335 of file graphics_abstraction_layer.h.

    {
        return m_strokeFont;
    }

References KIGFX::GAL::m_strokeFont.

Referenced by EDA_TEXT::GetTextBox().

GetTarget()

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

inlinevirtualinherited

Get the currently used target for rendering.

Returns

The current rendering target.

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

Definition at line 791 of file graphics_abstraction_layer.h.

{ return TARGET_CACHED; };

References KIGFX::TARGET_CACHED.

GetTextLineSize()

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

inherited

Compute the X and Y size of a given text.

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

Parameters

aText

is the text string (one line).

Returns

is the text size.

Definition at line 177 of file graphics_abstraction_layer.cpp.

{
    // Compute the X and Y size of a given text.
    // Because computeTextLineSize expects a one line text,
    // aText is expected to be only one line text.
    return m_strokeFont.computeTextLineSize( aText );
}

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

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

GetVerticalJustify()

EDA_TEXT_VJUSTIFY_T KIGFX::GAL::GetVerticalJustify ( ) const

inlineinherited

Returns current text vertical justification setting.

Definition at line 476 of file graphics_abstraction_layer.h.

    {
        return textProperties.m_verticalJustify;
    }

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

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

GetVisibleWorldExtents()

BOX2D GAL::GetVisibleWorldExtents ( ) const

inherited

Returns

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

Definition at line 215 of file graphics_abstraction_layer.cpp.

{
    const MATRIX3x3D& matrix = GetScreenWorldMatrix();

    VECTOR2D halfSize = VECTOR2D( matrix.GetScale().x * m_screenSize.x * 0.5,
                                  matrix.GetScale().y * m_screenSize.y * 0.5 );

    BOX2D extents;
    extents.SetOrigin( GetLookAtPoint() - halfSize );
    extents.SetSize( halfSize * 2 );

    return extents;
}

References KIGFX::GAL::GetLookAtPoint(), MATRIX3x3< T >::GetScale(), KIGFX::GAL::GetScreenWorldMatrix(), KIGFX::GAL::m_screenSize, BOX2< Vec >::SetOrigin(), 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 742 of file graphics_abstraction_layer.h.

    {
        return m_worldScale;
    }

References KIGFX::GAL::m_worldScale.

Referenced by PCB_GRID_HELPER::BestDragOrigin(), EE_GRID_HELPER::BestDragOrigin(), PCB_GRID_HELPER::BestSnapAnchor(), KIGFX::PCB_PAINTER::draw(), KIGFX::PREVIEW::DrawTextNextToCursor(), drawTicksAlongLine(), KIGFX::PREVIEW::SetConstantGlyphHeight(), and KIGFX::PREVIEW::RULER_ITEM::ViewDraw().

GetWorldScreenMatrix()

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

inlineinherited

Get the world <-> screen transformation matrix.

Returns

the transformation matrix.

Definition at line 584 of file graphics_abstraction_layer.h.

    {
        return m_worldScreenMatrix;
    }

References KIGFX::GAL::m_worldScreenMatrix.

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

GetZoomFactor()

double KIGFX::GAL::GetZoomFactor ( ) const

inlineinherited

Get the zoom factor.

Returns

the zoom factor.

Definition at line 683 of file graphics_abstraction_layer.h.

    {
        return m_zoomFactor;
    }

References KIGFX::GAL::m_zoomFactor.

Referenced by COMMON_TOOLS::doZoomInOut(), EDA_DRAW_FRAME::GetZoomLevelIndicator(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), ZOOM_MENU::update(), and EDA_DRAW_FRAME::UpdateZoomSelectBox().

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

    {
        return true;
    };

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint().

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

{ return true; }

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

    {
        return false;
    }

Referenced by EDA_DRAW_PANEL_GAL::onSize().

IsCursorEnabled()

bool KIGFX::GAL::IsCursorEnabled ( ) const

inlineinherited

Return information about cursor visibility.

Returns

True if cursor is visible.

Definition at line 997 of file graphics_abstraction_layer.h.

    {
        return m_isCursorEnabled || m_forceDisplayCursor;
    }

References KIGFX::GAL::m_forceDisplayCursor, and KIGFX::GAL::m_isCursorEnabled.

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

IsFlippedX()

bool KIGFX::GAL::IsFlippedX ( ) const

inlineinherited

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

Definition at line 762 of file graphics_abstraction_layer.h.

    {
        return m_globalFlipX;
    }

References KIGFX::GAL::m_globalFlipX.

Referenced by angle_xform(), arc_angles_xform_and_normalize(), KIGFX::PCB_PAINTER::draw(), KIGFX::PREVIEW::DrawTextNextToCursor(), and DS_PROXY_VIEW_ITEM::ViewDraw().

IsFlippedY()

bool KIGFX::GAL::IsFlippedY ( ) const

inlineinherited

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

Definition at line 770 of file graphics_abstraction_layer.h.

    {
        return m_globalFlipY;
    }

References KIGFX::GAL::m_globalFlipY.

IsFontBold()

bool KIGFX::GAL::IsFontBold ( ) const

inlineinherited

Definition at line 424 of file graphics_abstraction_layer.h.

{ return textProperties.m_bold; }

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

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

IsFontItalic()

bool KIGFX::GAL::IsFontItalic ( ) const

inlineinherited

Definition at line 432 of file graphics_abstraction_layer.h.

{ return textProperties.m_italic; }

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

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

IsFontUnderlined()

bool KIGFX::GAL::IsFontUnderlined ( ) const

inlineinherited

Definition at line 435 of file graphics_abstraction_layer.h.

{ return textProperties.m_underlined; }

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

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

IsInitialized()

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

inlinevirtualinherited

Return the initialization status for the canvas.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 74 of file graphics_abstraction_layer.h.

{ return true; }

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

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

{ return false; }

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

IsTextMirrored()

bool KIGFX::GAL::IsTextMirrored ( ) const

inlineinherited

Definition at line 443 of file graphics_abstraction_layer.h.

{ return textProperties.m_mirrored; }

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

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

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

{ return true; }

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), SCH_DRAW_PANEL::onPaint(), EDA_DRAW_PANEL_GAL::onShowTimer(), KIGFX::VIEW::UpdateAllLayersColor(), KIGFX::VIEW::UpdateAllLayersOrder(), KIGFX::VIEW::UpdateItems(), and KIGFX::VIEW::UpdateLayerColor().

lockContext()

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

inlineprotectedvirtualinherited

Use GAL_CONTEXT_LOCKER RAII object.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1058 of file graphics_abstraction_layer.h.

{}

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

OnGalDisplayOptionsChanged()

void GAL::OnGalDisplayOptionsChanged ( const GAL_DISPLAY_OPTIONS &  aOptions )

overrideprotectedvirtualinherited

Handler for observer settings changes.

Implements KIGFX::GAL_DISPLAY_OPTIONS_OBSERVER.

Definition at line 95 of file graphics_abstraction_layer.cpp.

{
    // defer to the child class first
    updatedGalDisplayOptions( aOptions );

    // there is no refresh to do at this level
}

References KIGFX::GAL::updatedGalDisplayOptions().

PopDepth()

void KIGFX::GAL::PopDepth ( )

inlineinherited

Restore previously stored drawing depth for the depth stack.

Definition at line 1039 of file graphics_abstraction_layer.h.

    {
        m_layerDepth = m_depthStack.top();
        m_depthStack.pop();
    }

References KIGFX::GAL::m_depthStack, and KIGFX::GAL::m_layerDepth.

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

PushDepth()

void KIGFX::GAL::PushDepth ( )

inlineinherited

Store current drawing depth on the depth stack.

Definition at line 1031 of file graphics_abstraction_layer.h.

    {
        m_depthStack.push( m_layerDepth );
    }

References KIGFX::GAL::m_depthStack, and KIGFX::GAL::m_layerDepth.

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

resetContext()

void CAIRO_GAL_BASE::resetContext ( )

protected

Definition at line 937 of file cairo_gal.cpp.

{
    for( _cairo_surface* imageSurface : m_imageSurfaces )
        cairo_surface_destroy( imageSurface );

    m_imageSurfaces.clear();

    ClearScreen();

    // Compute the world <-> screen transformations
    ComputeWorldScreenMatrix();

    cairo_matrix_init( &m_cairoWorldScreenMatrix, m_worldScreenMatrix.m_data[0][0],
                       m_worldScreenMatrix.m_data[1][0], m_worldScreenMatrix.m_data[0][1],
                       m_worldScreenMatrix.m_data[1][1], m_worldScreenMatrix.m_data[0][2],
                       m_worldScreenMatrix.m_data[1][2] );

    // we work in screen-space coordinates and do the transforms outside.
    cairo_identity_matrix( m_context );

    cairo_matrix_init_identity( &m_currentXform );

    // Start drawing with a new path
    cairo_new_path( m_context );
    m_isElementAdded = true;

    updateWorldScreenMatrix();

    m_lineWidth = 0;
}

References ClearScreen(), KIGFX::GAL::ComputeWorldScreenMatrix(), m_cairoWorldScreenMatrix, m_context, m_currentXform, MATRIX3x3< T >::m_data, 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.

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

Definition at line 161 of file graphics_abstraction_layer.cpp.

{
     // Tiny but non-zero - this will always need setting
     // there is no built-in default
    SetGlyphSize( { 1.0, 1.0 } );

    SetHorizontalJustify( GR_TEXT_HJUSTIFY_CENTER );
    SetVerticalJustify( GR_TEXT_VJUSTIFY_CENTER );

    SetFontBold( false );
    SetFontItalic( false );
    SetFontUnderlined( false );
    SetTextMirrored( false );
}

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

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::GAL::GAL(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), KIGFX::PREVIEW::ARC_ASSISTANT::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.

Reimplemented in KIGFX::CAIRO_GAL.

Definition at line 530 of file cairo_gal.cpp.

{
    m_screenSize = VECTOR2I( aWidth, aHeight );
}

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

{
    storePath();

    if( m_isGrouping )
    {
        GROUP_ELEMENT groupElement;
        groupElement.m_Command = CMD_RESTORE;
        m_currentGroup->push_back( groupElement );
    }
    else
    {
        if( !m_xformStack.empty() )
        {
            m_currentXform = m_xformStack.back();
            m_xformStack.pop_back();
            updateWorldScreenMatrix();
        }
    }
}

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

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

{
    storePath();

    if( m_isGrouping )
    {
        GROUP_ELEMENT groupElement;
        groupElement.m_Command = CMD_ROTATE;
        groupElement.m_Argument.DblArg[0] = aAngle;
        m_currentGroup->push_back( groupElement );
    }
    else
    {
        cairo_matrix_rotate( &m_currentXform, aAngle );
        updateWorldScreenMatrix();
    }
}

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

roundp()

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

protected

Definition at line 187 of file cairo_gal.cpp.

{
    if( m_lineWidthIsOdd && m_isStrokeEnabled )
        return VECTOR2D( ::roundp( v.x ), ::roundp( v.y ) );
    else
        return VECTOR2D( floor( v.x + 0.5 ), floor( v.y + 0.5 ) );
}

References KIGFX::GAL::m_isStrokeEnabled, m_lineWidthIsOdd, VECTOR2< T >::x, and VECTOR2< T >::y.

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

Save()

void CAIRO_GAL_BASE::Save ( )

overridevirtual

Save the context.

Reimplemented from KIGFX::GAL.

Definition at line 716 of file cairo_gal.cpp.

{
    storePath();

    if( m_isGrouping )
    {
        GROUP_ELEMENT groupElement;
        groupElement.m_Command = CMD_SAVE;
        m_currentGroup->push_back( groupElement );
    }
    else
    {
        m_xformStack.push_back( m_currentXform );
        updateWorldScreenMatrix();
    }
}

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

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

{
    storePath();

    if( m_isGrouping )
    {
        GROUP_ELEMENT groupElement;
        groupElement.m_Command = CMD_SCALE;
        groupElement.m_Argument.DblArg[0] = aScale.x;
        groupElement.m_Argument.DblArg[1] = aScale.y;
        m_currentGroup->push_back( groupElement );
    }
    else
    {
        cairo_matrix_scale( &m_currentXform, aScale.x, aScale.y );
        updateWorldScreenMatrix();
    }
}

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

    {
        m_axesColor = aAxesColor;
    }

References KIGFX::GAL::m_axesColor.

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

SetAxesEnabled()

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

inlineinherited

Enable drawing the axes.

Definition at line 916 of file graphics_abstraction_layer.h.

    {
        m_axesEnabled = aAxesEnabled;
    }

References KIGFX::GAL::m_axesEnabled.

Referenced by FOOTPRINT_EDIT_FRAME::ActivateGalCanvas(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), KIGFX::GAL::GAL(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SYMBOL_EDIT_FRAME::SwitchCanvas(), FOOTPRINT_EDIT_FRAME::SwitchCanvas(), and SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET().

SetClearColor()

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

inlineinherited

Definition at line 217 of file graphics_abstraction_layer.h.

    {
        m_clearColor = aColor;
    }

References KIGFX::GAL::m_clearColor.

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), and PANEL_EESCHEMA_COLOR_SETTINGS::updatePreview().

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

    {
        m_gridTick = aInterval;
    }

References KIGFX::GAL::m_gridTick.

Referenced by KIGFX::GAL::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 1007 of file graphics_abstraction_layer.h.

    {
        m_cursorColor = aCursorColor;
    }

References KIGFX::GAL::m_cursorColor.

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), KIGFX::GAL::GAL(), and PCB_DRAW_PANEL_GAL::UpdateColors().

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

    {
        m_isCursorEnabled = aCursorEnabled;
    }

References KIGFX::GAL::m_isCursorEnabled.

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

SetDepthRange()

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

inlineinherited

Set the range of the layer depth.

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

Parameters

aDepthRange

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

Definition at line 716 of file graphics_abstraction_layer.h.

    {
        m_depthRange = aDepthRange;
    }

References KIGFX::GAL::m_depthRange.

Referenced by KIGFX::GAL::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 598 of file cairo_gal.cpp.

{
    storePath();
    m_fillColor = aColor;

    if( m_isGrouping )
    {
        GROUP_ELEMENT groupElement;
        groupElement.m_Command = CMD_SET_FILLCOLOR;
        groupElement.m_Argument.DblArg[0] = m_fillColor.r;
        groupElement.m_Argument.DblArg[1] = m_fillColor.g;
        groupElement.m_Argument.DblArg[2] = m_fillColor.b;
        groupElement.m_Argument.DblArg[3] = m_fillColor.a;
        m_currentGroup->push_back( groupElement );
    }
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, CMD_SET_FILLCOLOR, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::DblArg, KIGFX::COLOR4D::g, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Argument, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Command, m_currentGroup, KIGFX::GAL::m_fillColor, m_isGrouping, KIGFX::COLOR4D::r, and storePath().

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

    {
        m_globalFlipX = xAxis;
        m_globalFlipY = yAxis;
    }

References KIGFX::GAL::m_globalFlipX, and KIGFX::GAL::m_globalFlipY.

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

SetFontBold()

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

inlineinherited

Set bold property of current font.

Parameters

aBold

tells if the font should be bold or not.

Definition at line 423 of file graphics_abstraction_layer.h.

{ textProperties.m_bold = aBold;  }

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

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

SetFontItalic()

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

inlineinherited

Set italic property of current font.

Parameters

aItalic

tells if the font should be italic or not.

Definition at line 431 of file graphics_abstraction_layer.h.

{ textProperties.m_italic = aItalic; }

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

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

SetFontUnderlined()

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

inlineinherited

Definition at line 434 of file graphics_abstraction_layer.h.

{ textProperties.m_underlined = aUnderlined; }

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

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

SetGlyphSize()

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

inlineinherited

Set the font glyph size.

Parameters

aGlyphSize

is the new font glyph size.

Definition at line 415 of file graphics_abstraction_layer.h.

{ textProperties.m_glyphSize = aSize; }

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

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

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

    {
        m_gridColor = aGridColor;
    }

References KIGFX::GAL::m_gridColor.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), CAIRO_GAL_BASE(), EDA_DRAW_PANEL_GAL::DoRePaint(), KIGFX::OPENGL_GAL::OPENGL_GAL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), GERBVIEW_FRAME::SetGridColor(), and PCB_DRAW_PANEL_GAL::UpdateColors().

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

    {
        m_gridOrigin = aGridOrigin;

        if( m_gridSize.x == 0.0 || m_gridSize.y == 0.0 )
        {
            m_gridOffset = VECTOR2D( 0.0, 0.0);
        }
        else
        {
            m_gridOffset = VECTOR2D( (long) m_gridOrigin.x % (long) m_gridSize.x,
                                     (long) m_gridOrigin.y % (long) m_gridSize.y );
        }
    }

References KIGFX::GAL::m_gridOffset, KIGFX::GAL::m_gridOrigin, KIGFX::GAL::m_gridSize, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by 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 871 of file graphics_abstraction_layer.h.

    {
        m_gridSize = aGridSize;

        // Avoid stupid grid size values: a grid size  should be >= 1 in internal units
        m_gridSize.x = std::max( 1.0, m_gridSize.x );
        m_gridSize.y = std::max( 1.0, m_gridSize.y );

        m_gridOffset = VECTOR2D( (long) m_gridOrigin.x % (long) m_gridSize.x,
                                 (long) m_gridOrigin.y % (long) m_gridSize.y );
    }

References KIGFX::GAL::m_gridOffset, KIGFX::GAL::m_gridOrigin, KIGFX::GAL::m_gridSize, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by COMMON_TOOLS::OnGridChanged(), DIALOG_PAD_PROPERTIES::prepareCanvas(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

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

{ m_gridVisibility = aVisibility; }

References KIGFX::GAL::m_gridVisibility.

Referenced by KIGFX::GAL::GAL(), COMMON_TOOLS::OnGridChanged(), GERBER_LAYER_WIDGET::OnRenderEnable(), DIALOG_PAD_PROPERTIES::prepareCanvas(), EDA_DRAW_FRAME::SetGridVisibility(), EDA_DRAW_PANEL_GAL::SwitchBackend(), and SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET().

SetHorizontalJustify()

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

inlineinherited

Set the horizontal justify for text drawing.

Parameters

aHorizontalJustify

is the horizontal justify value.

Definition at line 450 of file graphics_abstraction_layer.h.

    {
        textProperties.m_horizontalJustify = aHorizontalJustify;
    }

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

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

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

{
    storePath();
    m_isFillEnabled = aIsFillEnabled;

    if( m_isGrouping )
    {
        GROUP_ELEMENT groupElement;
        groupElement.m_Command = CMD_SET_FILL;
        groupElement.m_Argument.BoolArg = aIsFillEnabled;
        m_currentGroup->push_back( groupElement );
    }
}

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

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

{
    storePath();
    m_isStrokeEnabled = aIsStrokeEnabled;

    if( m_isGrouping )
    {
        GROUP_ELEMENT groupElement;
        groupElement.m_Command = CMD_SET_STROKE;
        groupElement.m_Argument.BoolArg = aIsStrokeEnabled;
        m_currentGroup->push_back( groupElement );
    }
}

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

SetLayerDepth()

void CAIRO_GAL_BASE::SetLayerDepth ( double  aLayerDepth )

overridevirtual

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

Parameters

aLayerDepth

the layer depth for the objects.

Reimplemented from KIGFX::GAL.

Definition at line 635 of file cairo_gal.cpp.

{
    super::SetLayerDepth( aLayerDepth );
    storePath();
}

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

Referenced by DrawGrid().

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

{
    storePath();
    GAL::SetLineWidth( aLineWidth );

    if( m_isGrouping )
    {
        GROUP_ELEMENT groupElement;
        groupElement.m_Command = CMD_SET_LINE_WIDTH;
        groupElement.m_Argument.DblArg[0] = aLineWidth;
        m_currentGroup->push_back( groupElement );
    }
    else
    {
        m_lineWidth = aLineWidth;
    }
}

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(), and DrawSegment().

SetLookAtPoint()

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

inlineinherited

Set the Point in world space to look at.

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

Parameters

aPoint

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

Definition at line 653 of file graphics_abstraction_layer.h.

    {
        m_lookAtPoint = aPoint;
    }

References KIGFX::GAL::m_lookAtPoint.

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

SetNativeCursorStyle()

bool GAL::SetNativeCursorStyle ( KICURSOR  aCursor )

virtualinherited

Set the cursor in the native panel.

Parameters

aCursor

is the cursor to use in the native panel

Returns

true if the cursor was updated, false if the cursor given was already set

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

Definition at line 273 of file graphics_abstraction_layer.cpp.

{
    if( m_currentNativeCursor == aCursor )
        return false;

    m_currentNativeCursor = aCursor;

    return true;
}

References KIGFX::GAL::m_currentNativeCursor.

Referenced by KIGFX::GAL::GAL(), EDA_DRAW_PANEL_GAL::SetCurrentCursor(), KIGFX::OPENGL_GAL::SetNativeCursorStyle(), and KIGFX::CAIRO_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 920 of file cairo_gal.cpp.

{
    cairo_set_operator( m_currentContext, aSetting ? CAIRO_OPERATOR_CLEAR : CAIRO_OPERATOR_OVER );
}

References m_currentContext.

SetRotation()

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

inlineinherited

Set the rotation angle.

Parameters

aRotation

is the new rotation angle (radians).

Definition at line 693 of file graphics_abstraction_layer.h.

    {
        m_rotation = aRotation;
    }

References KIGFX::GAL::m_rotation.

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

SetScreenDPI()

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

inlineinherited

Set the dots per inch of the screen.

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

Parameters

aScreenDPI

are the screen DPI.

Definition at line 641 of file graphics_abstraction_layer.h.

    {
        m_screenDPI = aScreenDPI;
    }

References KIGFX::GAL::m_screenDPI.

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

SetScreenSize()

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

inlineinherited

Definition at line 628 of file graphics_abstraction_layer.h.

    {
        m_screenSize = aSize;
    }

References KIGFX::GAL::m_screenSize.

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

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

{
    storePath();
    m_strokeColor = aColor;

    if( m_isGrouping )
    {
        GROUP_ELEMENT groupElement;
        groupElement.m_Command = CMD_SET_STROKECOLOR;
        groupElement.m_Argument.DblArg[0] = m_strokeColor.r;
        groupElement.m_Argument.DblArg[1] = m_strokeColor.g;
        groupElement.m_Argument.DblArg[2] = m_strokeColor.b;
        groupElement.m_Argument.DblArg[3] = m_strokeColor.a;
        m_currentGroup->push_back( groupElement );
    }
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, CMD_SET_STROKECOLOR, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::DblArg, KIGFX::COLOR4D::g, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Argument, KIGFX::CAIRO_GAL_BASE::GROUP_ELEMENT::m_Command, m_currentGroup, m_isGrouping, KIGFX::GAL::m_strokeColor, KIGFX::COLOR4D::r, and storePath().

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, and KIGFX::OPENGL_GAL.

Definition at line 784 of file graphics_abstraction_layer.h.

{};

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

SetTextAttributes()

void GAL::SetTextAttributes ( const EDA_TEXT *  aText )

virtualinherited

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

Parameters

aText

is the text item.

Definition at line 149 of file graphics_abstraction_layer.cpp.

{
    SetGlyphSize( VECTOR2D( aText->GetTextSize() ) );
    SetHorizontalJustify( aText->GetHorizJustify() );
    SetVerticalJustify( aText->GetVertJustify() );
    SetFontBold( aText->IsBold() );
    SetFontItalic( aText->IsItalic() );
    SetFontUnderlined( false );
    SetTextMirrored( aText->IsMirrored() );
}

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

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

SetTextMirrored()

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

inlineinherited

Set a mirrored property of text.

Parameters

aMirrored

tells if the text should be mirrored or not.

Definition at line 442 of file graphics_abstraction_layer.h.

{ textProperties.m_mirrored = aMirrored; }

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

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

SetVerticalJustify()

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

inlineinherited

Set the vertical justify for text drawing.

Parameters

aVerticalJustify

is the vertical justify value.

Definition at line 468 of file graphics_abstraction_layer.h.

    {
        textProperties.m_verticalJustify = aVerticalJustify;
    }

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

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

SetWorldScreenMatrix()

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

inlineinherited

Set the world <-> screen transformation matrix.

Parameters

aMatrix

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

Definition at line 604 of file graphics_abstraction_layer.h.

    {
        m_worldScreenMatrix = aMatrix;
    }

References KIGFX::GAL::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.

Parameters

aWorldUnitLength

is the world Unit length.

Definition at line 623 of file graphics_abstraction_layer.h.

    {
        m_worldUnitLength = aWorldUnitLength;
    }

References KIGFX::GAL::m_worldUnitLength.

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

SetZoomFactor()

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

inlineinherited

Set the zoom factor of the scene.

Parameters

aZoomFactor

is the zoom factor.

Definition at line 673 of file graphics_abstraction_layer.h.

    {
        m_zoomFactor = aZoomFactor;
    }

References KIGFX::GAL::m_zoomFactor.

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

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

{ return true; };

storePath()

void CAIRO_GAL_BASE::storePath ( )

protected

Store the actual path.

Definition at line 1060 of file cairo_gal.cpp.

{
    if( m_isElementAdded )
    {
        m_isElementAdded = false;

        if( !m_isGrouping )
        {
            if( m_isFillEnabled )
            {
                cairo_set_source_rgba( m_currentContext, m_fillColor.r, m_fillColor.g, m_fillColor.b,
                                       m_fillColor.a );
                cairo_fill_preserve( m_currentContext );
            }

            if( m_isStrokeEnabled )
            {
                cairo_set_source_rgba( m_currentContext, m_strokeColor.r, m_strokeColor.g,
                                       m_strokeColor.b, m_strokeColor.a );
                cairo_stroke_preserve( m_currentContext );
            }
        }
        else
        {
            // Copy the actual path, append it to the global path list
            // then check, if the path needs to be stroked/filled and
            // add this command to the group list;
            if( m_isStrokeEnabled )
            {
                GROUP_ELEMENT groupElement;
                groupElement.m_CairoPath = cairo_copy_path( m_currentContext );
                groupElement.m_Command = CMD_STROKE_PATH;
                m_currentGroup->push_back( groupElement );
            }

            if( m_isFillEnabled )
            {
                GROUP_ELEMENT groupElement;
                groupElement.m_CairoPath = cairo_copy_path( m_currentContext );
                groupElement.m_Command = CMD_FILL_PATH;
                m_currentGroup->push_back( groupElement );
            }
        }

        cairo_new_path( m_currentContext );
    }
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, CMD_FILL_PATH, CMD_STROKE_PATH, KIGFX::COLOR4D::g, 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, KIGFX::GAL::m_strokeColor, and KIGFX::COLOR4D::r.

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

StrokeText()

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

inlinevirtualinherited

Draw a vector type text using preloaded Newstroke font.

Parameters

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

Definition at line 347 of file graphics_abstraction_layer.h.

    {
        m_strokeFont.Draw( aText, aPosition, aRotationAngle );
    }

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

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

syncLineWidth()

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

protected

Definition at line 210 of file cairo_gal.cpp.

{
    double w = floor( xform( aForceWidth ? aWidth : m_lineWidth ) + 0.5 );

    if( w <= 1.0 )
    {
        w = 1.0;
        cairo_set_line_join( m_currentContext, CAIRO_LINE_JOIN_MITER );
        cairo_set_line_cap( m_currentContext, CAIRO_LINE_CAP_BUTT );
        cairo_set_line_width( m_currentContext, 1.0 );
        m_lineWidthIsOdd = true;
    }
    else
    {
        cairo_set_line_join( m_currentContext, CAIRO_LINE_JOIN_ROUND );
        cairo_set_line_cap( m_currentContext, CAIRO_LINE_CAP_ROUND );
        cairo_set_line_width( m_currentContext, w );
        m_lineWidthIsOdd = ( (int) w % 2 ) == 1;
    }

    m_lineWidthInPixels = w;
}

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

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

ToScreen()

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

inlineinherited

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

Parameters

aPoint

the pointposition in world coordinates.

Returns

the point position in screen coordinates.

Definition at line 969 of file graphics_abstraction_layer.h.

    {
        return VECTOR2D( m_worldScreenMatrix * aPoint );
    }

References KIGFX::GAL::m_worldScreenMatrix.

Referenced by blitCursor().

ToWorld()

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

inlineinherited

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

Parameters

aPoint

the pointposition in screen coordinates.

Returns

the point position in world coordinates.

Definition at line 958 of file graphics_abstraction_layer.h.

    {
        return VECTOR2D( m_screenWorldMatrix * aPoint );
    }

References KIGFX::GAL::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 642 of file cairo_gal.cpp.

{
    cairo_matrix_t cairoTransformation, newXform;

    cairo_matrix_init( &cairoTransformation, aTransformation.m_data[0][0],
                       aTransformation.m_data[1][0], aTransformation.m_data[0][1],
                       aTransformation.m_data[1][1], aTransformation.m_data[0][2],
                       aTransformation.m_data[1][2] );

    cairo_matrix_multiply( &newXform, &m_currentXform, &cairoTransformation );
    m_currentXform = newXform;
    updateWorldScreenMatrix();
}

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

{
    storePath();

    if( m_isGrouping )
    {
        GROUP_ELEMENT groupElement;
        groupElement.m_Command = CMD_TRANSLATE;
        groupElement.m_Argument.DblArg[0] = aTranslation.x;
        groupElement.m_Argument.DblArg[1] = aTranslation.y;
        m_currentGroup->push_back( groupElement );
    }
    else
    {
        cairo_matrix_translate( &m_currentXform, aTranslation.x, aTranslation.y );
        updateWorldScreenMatrix();
    }
}

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.

unlockContext()

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

inlineprotectedvirtualinherited

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1060 of file graphics_abstraction_layer.h.

{}

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

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

{
    bool refresh = false;

    if( m_options.m_gridStyle != m_gridStyle )
    {
        m_gridStyle = m_options.m_gridStyle ;
        refresh = true;
    }

    if( m_options.m_gridLineWidth != m_gridLineWidth )
    {
        m_gridLineWidth = std::floor( m_options.m_gridLineWidth + 0.5 );
        refresh = true;
    }

    if( m_options.m_gridMinSpacing != m_gridMinSpacing )
    {
        m_gridMinSpacing = m_options.m_gridMinSpacing;
        refresh = true;
    }

    if( m_options.m_axesEnabled != m_axesEnabled )
    {
        m_axesEnabled = m_options.m_axesEnabled;
        refresh = true;
    }

    if( m_options.m_forceDisplayCursor != m_forceDisplayCursor )
    {
        m_forceDisplayCursor = m_options.m_forceDisplayCursor;
        refresh = true;
    }

    if( m_options.m_fullscreenCursor != m_fullscreenCursor )
    {
        m_fullscreenCursor = m_options.m_fullscreenCursor;
        refresh = true;
    }

    // tell the derived class if the base class needs an update or not
    return refresh;
}

References KIGFX::GAL_DISPLAY_OPTIONS::m_axesEnabled, KIGFX::GAL::m_axesEnabled, KIGFX::GAL_DISPLAY_OPTIONS::m_forceDisplayCursor, KIGFX::GAL::m_forceDisplayCursor, KIGFX::GAL_DISPLAY_OPTIONS::m_fullscreenCursor, KIGFX::GAL::m_fullscreenCursor, KIGFX::GAL_DISPLAY_OPTIONS::m_gridLineWidth, KIGFX::GAL::m_gridLineWidth, KIGFX::GAL_DISPLAY_OPTIONS::m_gridMinSpacing, KIGFX::GAL::m_gridMinSpacing, KIGFX::GAL_DISPLAY_OPTIONS::m_gridStyle, KIGFX::GAL::m_gridStyle, KIGFX::GAL::m_options, and refresh.

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

updateWorldScreenMatrix()

void CAIRO_GAL_BASE::updateWorldScreenMatrix ( )

protected

Definition at line 105 of file cairo_gal.cpp.

{
    cairo_matrix_multiply( &m_currentWorld2Screen, &m_currentXform, &m_cairoWorldScreenMatrix );
}

References m_cairoWorldScreenMatrix, m_currentWorld2Screen, and m_currentXform.

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

xform() [1/3]

const double CAIRO_GAL_BASE::xform ( double  x )

protected

Definition at line 173 of file cairo_gal.cpp.

{
    double dx = m_currentWorld2Screen.xx * x;
    double dy = m_currentWorld2Screen.yx * x;
    return sqrt( dx * dx + dy * dy );
}

References m_currentWorld2Screen.

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

xform() [2/3]

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

protected

Definition at line 111 of file cairo_gal.cpp.

{
    VECTOR2D rv;

    rv.x = m_currentWorld2Screen.xx * x + m_currentWorld2Screen.xy * y + m_currentWorld2Screen.x0;
    rv.y = m_currentWorld2Screen.yx * x + m_currentWorld2Screen.yy * y + m_currentWorld2Screen.y0;
    return rv;
}

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

xform() [3/3]

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

protected

Definition at line 121 of file cairo_gal.cpp.

{
    return xform( aP.x, aP.y );
}

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

Member Data Documentation

GAL_FORMAT

constexpr cairo_format_t KIGFX::CAIRO_GAL_BASE::GAL_FORMAT = CAIRO_FORMAT_ARGB32

staticprotected

Format used to store pixels.

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

m_axesColor

COLOR4D KIGFX::GAL::m_axesColor

protectedinherited

Color of the axes.

Definition at line 1158 of file graphics_abstraction_layer.h.

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

m_axesEnabled

bool KIGFX::GAL::m_axesEnabled

protectedinherited

Should the axes be drawn.

Definition at line 1159 of file graphics_abstraction_layer.h.

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

m_cairoWorldScreenMatrix

cairo_matrix_t KIGFX::CAIRO_GAL_BASE::m_cairoWorldScreenMatrix

protected

Cairo world to screen transform matrix.

Definition at line 336 of file cairo_gal.h.

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

m_clearColor

COLOR4D KIGFX::GAL::m_clearColor

protectedinherited

Definition at line 1146 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_PRINT_GAL::CAIRO_PRINT_GAL(), ClearScreen(), KIGFX::OPENGL_GAL::ClearTarget(), KIGFX::GAL::GetClearColor(), and KIGFX::GAL::SetClearColor().

m_context

cairo_t* KIGFX::CAIRO_GAL_BASE::m_context

protected

Cairo image.

Definition at line 340 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_currentContext

cairo_t* KIGFX::CAIRO_GAL_BASE::m_currentContext

protected

Currently used Cairo context for drawing.

Definition at line 339 of file cairo_gal.h.

Referenced by CAIRO_GAL_BASE(), KIGFX::CAIRO_PRINT_GAL::CAIRO_PRINT_GAL(), ClearScreen(), DrawArc(), DrawArcSegment(), drawAxes(), DrawBitmap(), DrawCircle(), DrawCurve(), drawGridCross(), drawGridLine(), drawGridPoint(), DrawGroup(), DrawLine(), 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 331 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 1175 of file graphics_abstraction_layer.h.

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

m_currentWorld2Screen

cairo_matrix_t KIGFX::CAIRO_GAL_BASE::m_currentWorld2Screen

protected

Definition at line 338 of file cairo_gal.h.

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

m_currentXform

cairo_matrix_t KIGFX::CAIRO_GAL_BASE::m_currentXform

protected

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

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

m_cursorPosition

VECTOR2D KIGFX::GAL::m_cursorPosition

protectedinherited

Current cursor position (world coordinates)

Definition at line 1170 of file graphics_abstraction_layer.h.

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

m_depthRange

VECTOR2D KIGFX::GAL::m_depthRange

protectedinherited

Range of the depth.

Definition at line 1149 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::beginDrawing(), DrawGrid(), KIGFX::GAL::GetMaxDepth(), KIGFX::GAL::GetMinDepth(), KIGFX::GAL::SetDepthRange(), and KIGFX::GAL::SetLayerDepth().

m_depthStack

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

protectedinherited

Stored depth values.

Definition at line 1123 of file graphics_abstraction_layer.h.

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

m_fillColor

COLOR4D KIGFX::GAL::m_fillColor

protectedinherited

The fill color.

Definition at line 1144 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::beginDrawing(), KIGFX::OPENGL_GAL::DrawArc(), KIGFX::OPENGL_GAL::DrawArcSegment(), KIGFX::OPENGL_GAL::DrawCircle(), DrawGroup(), KIGFX::OPENGL_GAL::drawPolygon(), KIGFX::OPENGL_GAL::DrawRectangle(), DrawSegment(), KIGFX::OPENGL_GAL::DrawSegment(), KIGFX::OPENGL_GAL::drawSemiCircle(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), flushPath(), KIGFX::GAL::GetFillColor(), SetFillColor(), KIGFX::GAL::SetFillColor(), and storePath().

m_forceDisplayCursor

bool KIGFX::GAL::m_forceDisplayCursor

protectedinherited

Always show cursor.

Definition at line 1167 of file graphics_abstraction_layer.h.

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

m_fullscreenCursor

bool KIGFX::GAL::m_fullscreenCursor

protectedinherited

Shape of the cursor (fullscreen or small cross)

Definition at line 1169 of file graphics_abstraction_layer.h.

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

m_globalFlipX

bool KIGFX::GAL::m_globalFlipX

protectedinherited

Flag for X axis flipping.

Definition at line 1136 of file graphics_abstraction_layer.h.

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

m_globalFlipY

bool KIGFX::GAL::m_globalFlipY

protectedinherited