KIGFX::GAL Class Reference

Abstract interface for drawing on a 2D-surface. More...

#include <graphics_abstraction_layer.h>

Inheritance diagram for KIGFX::GAL:

Classes
struct	TEXT_PROPERTIES

Public Member Functions
	GAL (GAL_DISPLAY_OPTIONS &aOptions)
virtual	~GAL ()
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	IsCairoEngine ()
	Return true if the GAL engine is a Cairo based type. More...
virtual bool	IsOpenGlEngine ()
	Return true if the GAL engine is a OpenGL based type. More...
virtual void	DrawLine (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
	Draw a line. More...
virtual void	DrawSegment (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint, double aWidth)
	Draw a rounded segment. More...
virtual void	DrawPolyline (const std::deque< VECTOR2D > &aPointList)
	Draw a polyline. More...
virtual void	DrawPolyline (const VECTOR2D aPointList[], int aListSize)
virtual void	DrawPolyline (const SHAPE_LINE_CHAIN &aLineChain)
virtual void	DrawCircle (const VECTOR2D &aCenterPoint, double aRadius)
	Draw a circle using world coordinates. More...
virtual void	DrawArc (const VECTOR2D &aCenterPoint, double aRadius, double aStartAngle, double aEndAngle)
	Draw an arc. More...
virtual void	DrawArcSegment (const VECTOR2D &aCenterPoint, double aRadius, double aStartAngle, double aEndAngle, double aWidth)
	Draw an arc segment. More...
virtual void	DrawRectangle (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
	Draw a rectangle. More...
virtual void	DrawPolygon (const std::deque< VECTOR2D > &aPointList)
	Draw a polygon. More...
virtual void	DrawPolygon (const VECTOR2D aPointList[], int aListSize)
virtual void	DrawPolygon (const SHAPE_POLY_SET &aPolySet)
virtual void	DrawPolygon (const SHAPE_LINE_CHAIN &aPolySet)
virtual void	DrawCurve (const VECTOR2D &startPoint, const VECTOR2D &controlPointA, const VECTOR2D &controlPointB, const VECTOR2D &endPoint, double aFilterValue=0.0)
	Draw a cubic bezier spline. More...
virtual void	DrawBitmap (const BITMAP_BASE &aBitmap)
	Draw a bitmap image. More...
virtual void	ResizeScreen (int aWidth, int aHeight)
	Resize the canvas. More...
virtual bool	Show (bool aShow)
	Show/hide the GAL canvas. More...
const VECTOR2I &	GetScreenPixelSize () const
	Return GAL canvas size in pixels. More...
virtual void	Flush ()
	Force all remaining objects to be drawn. More...
void	SetClearColor (const COLOR4D &aColor)
const COLOR4D &	GetClearColor () const
virtual void	ClearScreen ()
	Clear the screen. More...
virtual void	SetIsFill (bool aIsFillEnabled)
	Enable/disable fill. More...
virtual void	SetIsStroke (bool aIsStrokeEnabled)
	Enable/disable stroked outlines. More...
virtual void	SetFillColor (const COLOR4D &aColor)
	Set the fill color. More...
const COLOR4D &	GetFillColor () const
	Get the fill color. More...
virtual void	SetStrokeColor (const COLOR4D &aColor)
	Set the stroke color. More...
const COLOR4D &	GetStrokeColor () const
	Get the stroke color. More...
virtual void	SetLineWidth (float aLineWidth)
	Set the line width. More...
float	GetLineWidth () const
	Get the line width. More...
virtual void	SetLayerDepth (double aLayerDepth)
	Set the depth of the layer (position on the z-axis) 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	Transform (const MATRIX3x3D &aTransformation)
	Transform the context. More...
virtual void	Rotate (double aAngle)
	Rotate the context. More...
virtual void	Translate (const VECTOR2D &aTranslation)
	Translate the context. More...
virtual void	Scale (const VECTOR2D &aScale)
	Scale the context. More...
virtual void	Save ()
	Save the context. More...
virtual void	Restore ()
	Restore the context. More...
virtual int	BeginGroup ()
	Begin a group. More...
virtual void	EndGroup ()
	End the group. More...
virtual void	DrawGroup (int aGroupNumber)
	Draw the stored group. More...
virtual void	ChangeGroupColor (int aGroupNumber, const COLOR4D &aNewColor)
	Change the color used to draw the group. More...
virtual void	ChangeGroupDepth (int aGroupNumber, int aDepth)
	Change the depth (Z-axis position) of the group. More...
virtual void	DeleteGroup (int aGroupNumber)
	Delete the group from the memory. More...
virtual void	ClearCache ()
	Delete all data created during caching of graphic items. 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...
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...
virtual void	SetNegativeDrawMode (bool aSetting)
	Set negative draw mode in the renderer. 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...
virtual void	DrawGrid ()
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...
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...
virtual void	DrawCursor (const VECTOR2D &aCursorPosition)
	Draw the cursor. 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 void	EnableDepthTest (bool aEnabled=false)
virtual bool	IsContextLocked ()
	Checks the state of the context lock. More...

Protected Member Functions
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...
virtual void	beginDrawing ()
	Begin the drawing, needs to be called for every new frame. More...
virtual void	endDrawing ()
	End the drawing, needs to be called for every new frame. 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
GAL_DISPLAY_OPTIONS &	options
UTIL::LINK	observerLink
std::stack< double >	depthStack
	Stored depth values. More...
VECTOR2I	screenSize
	Screen size in screen coordinates. More...
double	worldUnitLength
	The unit length of the world coordinates [inch]. More...
double	screenDPI
	The dots per inch of the screen. More...
VECTOR2D	lookAtPoint
	Point to be looked at in world space. More...
double	zoomFactor
	The zoom factor. More...
double	rotation
	Rotation transformation (radians) More...
MATRIX3x3D	worldScreenMatrix
	World transformation. More...
MATRIX3x3D	screenWorldMatrix
	Screen transformation. More...
double	worldScale
	The scale factor world->screen. More...
bool	globalFlipX
	Flag for X axis flipping. More...
bool	globalFlipY
	Flag for Y axis flipping. More...
float	lineWidth
	The line width. More...
bool	isFillEnabled
	Is filling of graphic objects enabled ? More...
bool	isStrokeEnabled
	Are the outlines stroked ? More...
COLOR4D	fillColor
	The fill color. More...
COLOR4D	strokeColor
	The color of the outlines. More...
COLOR4D	m_clearColor
double	layerDepth
	The actual layer depth. More...
VECTOR2D	depthRange
	Range of the depth. More...
bool	gridVisibility
	Should the grid be shown. More...
GRID_STYLE	gridStyle
	Grid display style. More...
VECTOR2D	gridSize
	The grid size. More...
VECTOR2D	gridOrigin
	The grid origin. More...
VECTOR2D	gridOffset
	The grid offset to compensate cursor position. More...
COLOR4D	gridColor
	Color of the grid. More...
COLOR4D	axesColor
	Color of the axes. More...
bool	axesEnabled
	Should the axes be drawn. More...
int	gridTick
	Every tick line gets the double width. More...
float	gridLineWidth
	Line width of the grid. More...
int	gridMinSpacing
	Minimum screen size of the grid (pixels) below which the grid is not drawn. More...
bool	isCursorEnabled
	Is the cursor enabled? More...
bool	forceDisplayCursor
	Always show cursor. More...
COLOR4D	cursorColor
	Cursor color. More...
bool	fullscreenCursor
	Shape of the cursor (fullscreen or small cross) More...
VECTOR2D	cursorPosition
	Current cursor position (world coordinates) More...
STROKE_FONT	strokeFont
	Instance of object that stores information about how to draw texts. More...

Static Protected Attributes
static const int	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...

Private Attributes
struct KIGFX::GAL::TEXT_PROPERTIES	textProperties

Friends
class	GAL_CONTEXT_LOCKER
class	GAL_UPDATE_CONTEXT
class	GAL_DRAWING_CONTEXT

Detailed Description

Abstract interface for drawing on a 2D-surface.

The functions are optimized for drawing shapes of an EDA-program such as KiCad. Most methods are abstract and need to be implemented by a lower layer, for example by a Cairo or OpenGL implementation. Almost all methods use world coordinates as arguments. The board design is defined in world space units for drawing purposes these are transformed to screen units with this layer. So zooming is handled here as well.

Definition at line 59 of file graphics_abstraction_layer.h.

Constructor & Destructor Documentation

GAL()

GAL::GAL

(

GAL_DISPLAY_OPTIONS &

aOptions

)

Definition at line 39 of file graphics_abstraction_layer.cpp.

                                               :
    options( aDisplayOptions ),
    strokeFont( this )
{
    // Set the default values for the internal variables
    SetIsFill( false );
    SetIsStroke( true );
    SetFillColor( COLOR4D( 0.0, 0.0, 0.0, 0.0 ) );
    SetStrokeColor( COLOR4D( 1.0, 1.0, 1.0, 1.0 ) );
    SetLookAtPoint( VECTOR2D( 0, 0 ) );
    SetZoomFactor( 1.0 );
    SetRotation( 0.0 );
    // this value for SetWorldUnitLength is only suitable for Pcbnew.
    // Other editors/viewer must call SetWorldUnitLength with their internal units
    SetWorldUnitLength( 1e-9 /* 1 nm */ / 0.0254 /* 1 inch in meters */ );
    // wxDC::GetPPI() reports 96 DPI, but somehow this value
    // is the closest match to the legacy renderer
    SetScreenDPI( 91 );
    SetDepthRange( VECTOR2D( GAL::MIN_DEPTH, GAL::MAX_DEPTH ) );
    SetLayerDepth( 0.0 );
    SetFlip( false, false );
    SetLineWidth( 1.0f );
    computeWorldScale();
    SetAxesEnabled( false );

    // Set grid defaults
    SetGridVisibility( true );
    SetCoarseGrid( 10 );
    gridLineWidth = 0.5f;
    gridStyle = GRID_STYLE::LINES;
    gridMinSpacing = 10;

    // Initialize the cursor shape
    SetCursorColor( COLOR4D( 1.0, 1.0, 1.0, 1.0 ) );
    fullscreenCursor = false;
    forceDisplayCursor = false;
    SetCursorEnabled( false );

    // Initialize text properties
    ResetTextAttributes();

    strokeFont.LoadNewStrokeFont( newstroke_font, newstroke_font_bufsize );

    // subscribe for settings updates
    observerLink = options.Subscribe( this );
}

References computeWorldScale(), forceDisplayCursor, fullscreenCursor, gridLineWidth, gridMinSpacing, gridStyle, KIGFX::LINES, KIGFX::STROKE_FONT::LoadNewStrokeFont(), MAX_DEPTH, MIN_DEPTH, newstroke_font, newstroke_font_bufsize, observerLink, options, ResetTextAttributes(), SetAxesEnabled(), SetCoarseGrid(), SetCursorColor(), SetCursorEnabled(), SetDepthRange(), SetFillColor(), SetFlip(), SetGridVisibility(), SetIsFill(), SetIsStroke(), SetLayerDepth(), SetLineWidth(), SetLookAtPoint(), SetRotation(), SetScreenDPI(), SetStrokeColor(), SetWorldUnitLength(), SetZoomFactor(), strokeFont, and UTIL::OBSERVABLE< ObserverInterface >::Subscribe().

~GAL()

GAL::~GAL ( )

virtual

Definition at line 87 of file graphics_abstraction_layer.cpp.

{
}

Member Function Documentation

AdvanceDepth()

void KIGFX::GAL::AdvanceDepth ( )

inline

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

Definition at line 1005 of file graphics_abstraction_layer.h.

    {
        layerDepth -= 0.05;
    }

References layerDepth.

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

beginDrawing()

virtual void KIGFX::GAL::beginDrawing ( )

inlineprotectedvirtual

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

Private: use GAL_DRAWING_CONTEXT RAII object

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

Definition at line 1053 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::GAL_DRAWING_CONTEXT::GAL_DRAWING_CONTEXT().

BeginGroup()

virtual int KIGFX::GAL::BeginGroup ( )

inlinevirtual

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

Definition at line 531 of file graphics_abstraction_layer.h.

{ return 0; };

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

beginUpdate()

virtual void KIGFX::GAL::beginUpdate ( )

inlineprotectedvirtual

Enable item update mode.

Private: use GAL_UPDATE_CONTEXT RAII object

Reimplemented in KIGFX::OPENGL_GAL.

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

inlinevirtual

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

    {
        // Fallback: use stroke font

        // Handle flipped view
        if( 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 = lineWidth;
        VECTOR2D saveGlyphSize = textProperties.m_glyphSize;
        {
            lineWidth *= 1.2f;
            textProperties.m_glyphSize = textProperties.m_glyphSize * 0.8;

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

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

References globalFlipX, lineWidth, KIGFX::GAL::TEXT_PROPERTIES::m_glyphSize, KIGFX::GAL::TEXT_PROPERTIES::m_mirrored, StrokeText(), and textProperties.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), and KIGFX::VIEW_OVERLAY::COMMAND_BITMAP_TEXT::Execute().

ChangeGroupColor()

virtual void KIGFX::GAL::ChangeGroupColor ( int  aGroupNumber, const COLOR4D &  aNewColor  )

inlinevirtual

Change the color used to draw the group.

Parameters

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

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

Definition at line 549 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::VIEW::updateItemsColor::operator()(), KIGFX::VIEW::UpdateAllLayersColor(), and KIGFX::VIEW::updateItemColor().

ChangeGroupDepth()

virtual void KIGFX::GAL::ChangeGroupDepth ( int  aGroupNumber, int  aDepth  )

inlinevirtual

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

Parameters

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

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

Definition at line 557 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::VIEW::changeItemsDepth::operator()(), and KIGFX::VIEW::UpdateAllLayersOrder().

ClearCache()

virtual void KIGFX::GAL::ClearCache ( )

inlinevirtual

Delete all data created during caching of graphic items.

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

Definition at line 569 of file graphics_abstraction_layer.h.

{};

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

ClearScreen()

virtual void KIGFX::GAL::ClearScreen ( )

inlinevirtual

Clear the screen.

Parameters

aColor

is the color used for clearing.

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

Definition at line 231 of file graphics_abstraction_layer.h.

{};

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint().

ClearTarget()

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

inlinevirtual

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

{};

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

computeMinGridSpacing()

double GAL::computeMinGridSpacing ( ) const

protected

compute minimum grid spacing from the grid settings

Returns

the minimum spacing to use for drawing the grid

Definition at line 212 of file graphics_abstraction_layer.cpp.

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

References gridMinSpacing.

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

computeWorldScale()

void KIGFX::GAL::computeWorldScale ( )

inlineprotected

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

Definition at line 1060 of file graphics_abstraction_layer.h.

    {
        worldScale = screenDPI * worldUnitLength * zoomFactor;
    }

References screenDPI, worldScale, worldUnitLength, and zoomFactor.

Referenced by ComputeWorldScreenMatrix(), and GAL().

ComputeWorldScreenMatrix()

void GAL::ComputeWorldScreenMatrix ( )

virtual

Compute the world <-> screen transformation matrix.

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

Definition at line 183 of file graphics_abstraction_layer.cpp.

{
    computeWorldScale();

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

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

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

    MATRIX3x3D flip;
    flip.SetIdentity();
    flip.SetScale( VECTOR2D( globalFlipX ? -1.0 : 1.0, globalFlipY ? -1.0 : 1.0 ) );

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

    worldScreenMatrix = translation * rotate * flip * scale * lookat;
    screenWorldMatrix = worldScreenMatrix.Inverse();
}

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

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

DeleteGroup()

virtual void KIGFX::GAL::DeleteGroup ( int  aGroupNumber )

inlinevirtual

Delete the group from the memory.

Parameters

aGroupNumber

is the group number.

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

Definition at line 564 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::VIEW::recacheItem::operator()(), KIGFX::VIEW::Remove(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

DrawArc()

virtual void KIGFX::GAL::DrawArc ( const VECTOR2D &  aCenterPoint, double  aRadius, double  aStartAngle, double  aEndAngle  )

inlinevirtual

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

Definition at line 136 of file graphics_abstraction_layer.h.

                                {};

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), ROUTER_PREVIEW_ITEM::drawLineChain(), ROUTER_PREVIEW_ITEM::drawShape(), and KIGFX::VIEW_OVERLAY::COMMAND_ARC::Execute().

DrawArcSegment()

virtual void KIGFX::GAL::DrawArcSegment ( const VECTOR2D &  aCenterPoint, double  aRadius, double  aStartAngle, double  aEndAngle, double  aWidth  )

inlinevirtual

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

Definition at line 156 of file graphics_abstraction_layer.h.

                                                      {};

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

DrawBitmap()

virtual void KIGFX::GAL::DrawBitmap ( const BITMAP_BASE &  aBitmap )

inlinevirtual

Draw a bitmap image.

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

Definition at line 195 of file graphics_abstraction_layer.h.

{};

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

DrawCircle()

virtual void KIGFX::GAL::DrawCircle ( const VECTOR2D &  aCenterPoint, double  aRadius  )

inlinevirtual

Draw a circle using world coordinates.

Parameters

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

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

Definition at line 125 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawCircle(), KIGFX::GERBVIEW_PAINTER::drawFlashedShape(), KIGFX::SCH_PAINTER::drawPinDanglingSymbol(), ROUTER_PREVIEW_ITEM::drawShape(), KIGFX::VIEW_OVERLAY::COMMAND_CIRCLE::Execute(), and screenSpaceCircle().

DrawCursor()

virtual void KIGFX::GAL::DrawCursor ( const VECTOR2D &  aCursorPosition )

inlinevirtual

Draw the cursor.

Parameters

aCursorPosition

is the cursor position in screen coordinates.

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

Definition at line 999 of file graphics_abstraction_layer.h.

{};

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint().

DrawCurve()

virtual void KIGFX::GAL::DrawCurve ( const VECTOR2D &  startPoint, const VECTOR2D &  controlPointA, const VECTOR2D &  controlPointB, const VECTOR2D &  endPoint, double  aFilterValue = 0.0  )

inlinevirtual

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

Definition at line 188 of file graphics_abstraction_layer.h.

                                                        {};

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

DrawGrid()

virtual void KIGFX::GAL::DrawGrid ( )

inlinevirtual

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

Definition at line 932 of file graphics_abstraction_layer.h.

{};

Referenced by SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), and EDA_DRAW_PANEL_GAL::DoRePaint().

DrawGroup()

virtual void KIGFX::GAL::DrawGroup ( int  aGroupNumber )

inlinevirtual

Draw the stored group.

Parameters

aGroupNumber

is the group number.

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

Definition at line 541 of file graphics_abstraction_layer.h.

{};

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

DrawLine()

virtual void KIGFX::GAL::DrawLine ( const VECTOR2D &  aStartPoint, const VECTOR2D &  aEndPoint  )

inlinevirtual

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

Definition at line 96 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), drawBacksideTicks(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawLine(), ROUTER_PREVIEW_ITEM::drawLineChain(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawLineWithAngleHighlight(), KIGFX::PREVIEW::CENTRELINE_RECT_ITEM::drawPreviewShape(), ROUTER_PREVIEW_ITEM::drawShape(), KIGFX::STROKE_FONT::drawSingleLineText(), drawTicksAlongLine(), KIGFX::VIEW_OVERLAY::COMMAND_LINE::Execute(), screenSpaceLine(), KIGFX::SCH_PAINTER::triLine(), and KIGFX::PREVIEW::RULER_ITEM::ViewDraw().

DrawPolygon() [1/4]

virtual void KIGFX::GAL::DrawPolygon ( const std::deque< VECTOR2D > &  aPointList )

inlinevirtual

Draw a polygon.

Parameters

aPointList

is the list of the polygon points.

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

Definition at line 172 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::drawApertureMacro(), KIGFX::GERBVIEW_PAINTER::drawPolygon(), KIGFX::PREVIEW::CENTRELINE_RECT_ITEM::drawPreviewShape(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), ROUTER_PREVIEW_ITEM::drawShape(), KIGFX::VIEW_OVERLAY::COMMAND_POLYGON::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_POLY_POLYGON::Execute(), and KIGFX::VIEW_OVERLAY::COMMAND_POINT_POLYGON::Execute().

DrawPolygon() [2/4]

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

inlinevirtual

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

Definition at line 173 of file graphics_abstraction_layer.h.

{};

DrawPolygon() [3/4]

virtual void KIGFX::GAL::DrawPolygon ( const SHAPE_POLY_SET &  aPolySet )

inlinevirtual

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

Definition at line 174 of file graphics_abstraction_layer.h.

{};

DrawPolygon() [4/4]

virtual void KIGFX::GAL::DrawPolygon ( const SHAPE_LINE_CHAIN &  aPolySet )

inlinevirtual

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

Definition at line 175 of file graphics_abstraction_layer.h.

{};

DrawPolyline() [1/3]

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

inlinevirtual

Draw a polyline.

Parameters

aPointList

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

Reimplemented in KIGFX::OPENGL_GAL, BASIC_GAL, and KIGFX::CAIRO_GAL_BASE.

Definition at line 115 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::drawApertureMacro(), KIGFX::GERBVIEW_PAINTER::drawPolygon(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), ROUTER_PREVIEW_ITEM::drawShape(), and KIGFX::STROKE_FONT::drawSingleLineText().

DrawPolyline() [2/3]

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

inlinevirtual

Reimplemented in KIGFX::OPENGL_GAL, BASIC_GAL, and KIGFX::CAIRO_GAL_BASE.

Definition at line 116 of file graphics_abstraction_layer.h.

{};

DrawPolyline() [3/3]

virtual void KIGFX::GAL::DrawPolyline ( const SHAPE_LINE_CHAIN &  aLineChain )

inlinevirtual

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

Definition at line 117 of file graphics_abstraction_layer.h.

{};

DrawRectangle()

virtual void KIGFX::GAL::DrawRectangle ( const VECTOR2D &  aStartPoint, const VECTOR2D &  aEndPoint  )

inlinevirtual

Draw a rectangle.

Parameters

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

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

Definition at line 165 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::SCH_PAINTER::Draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::drawDanglingSymbol(), KIGFX::GERBVIEW_PAINTER::drawFlashedShape(), ROUTER_PREVIEW_ITEM::drawShape(), KIGFX::VIEW_OVERLAY::COMMAND_RECTANGLE::Execute(), BRIGHT_BOX::ViewDraw(), and KIGFX::PREVIEW::SELECTION_AREA::ViewDraw().

DrawSegment()

virtual void KIGFX::GAL::DrawSegment ( const VECTOR2D &  aStartPoint, const VECTOR2D &  aEndPoint, double  aWidth  )

inlinevirtual

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

Definition at line 107 of file graphics_abstraction_layer.h.

                                              {};

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

EnableDepthTest()

virtual void KIGFX::GAL::EnableDepthTest ( bool  aEnabled = false )

inlinevirtual

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

Definition at line 1027 of file graphics_abstraction_layer.h.

{};

endDrawing()

virtual void KIGFX::GAL::endDrawing ( )

inlineprotectedvirtual

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

Private: use GAL_DRAWING_CONTEXT RAII object

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

Definition at line 1057 of file graphics_abstraction_layer.h.

{};

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

EndGroup()

virtual void KIGFX::GAL::EndGroup ( )

inlinevirtual

End the group.

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

Definition at line 534 of file graphics_abstraction_layer.h.

{};

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

endUpdate()

virtual void KIGFX::GAL::endUpdate ( )

inlineprotectedvirtual

Disable item update mode.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1049 of file graphics_abstraction_layer.h.

{}

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

Flush()

virtual void KIGFX::GAL::Flush ( )

inlinevirtual

Force all remaining objects to be drawn.

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

Definition at line 214 of file graphics_abstraction_layer.h.

{};

GetClearColor()

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

inline

Definition at line 221 of file graphics_abstraction_layer.h.

    {
        return m_clearColor;
    }

References m_clearColor.

getCursorColor()

COLOR4D GAL::getCursorColor ( ) const

protected

Get the actual cursor color to draw.

Definition at line 242 of file graphics_abstraction_layer.cpp.

{
    auto color = cursorColor;

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

    return color;
}

References color, cursorColor, and isCursorEnabled.

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

GetFillColor()

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

inline

Get the fill color.

Returns

the color for filling a outline.

Definition at line 272 of file graphics_abstraction_layer.h.

    {
        return fillColor;
    }

References fillColor.

GetGlyphSize()

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

inline

Definition at line 415 of file graphics_abstraction_layer.h.

{ return textProperties.m_glyphSize; }

References KIGFX::GAL::TEXT_PROPERTIES::m_glyphSize, and 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

inline

Get the grid line width.

Returns

the grid line widthDraw the grid

Definition at line 926 of file graphics_abstraction_layer.h.

References gridLineWidth.

GetGridOrigin()

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

inline

Definition at line 851 of file graphics_abstraction_layer.h.

    {
        return gridOrigin;
    }

References gridOrigin.

Referenced by GRID_HELPER::GetOrigin().

GetGridPoint()

VECTOR2D GAL::GetGridPoint

(

const VECTOR2D &

aPoint

)

const

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 220 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 - gridOffset.x ) / gridSize.x ) * gridSize.x + gridOffset.x,
                     KiROUND( ( aPoint.y - gridOffset.y ) / gridSize.y ) * gridSize.y + gridOffset.y );
#else
    // if grid size == 0.0 there is no grid, so use aPoint as grid reference position
    double cx = gridSize.x > 0.0 ? KiROUND( ( aPoint.x - gridOffset.x ) / gridSize.x ) * gridSize.x + gridOffset.x
            : aPoint.x;
    double cy = gridSize.y > 0.0 ? KiROUND( ( aPoint.y - gridOffset.y ) / gridSize.y ) * gridSize.y + gridOffset.y
            : aPoint.y;

    return VECTOR2D( cx, cy );
#endif
}

References gridOffset, gridSize, KiROUND(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

GetGridSize()

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

inline

Return the grid size.

Returns

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

Definition at line 878 of file graphics_abstraction_layer.h.

    {
        return gridSize;
    }

References 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

inline

Definition at line 830 of file graphics_abstraction_layer.h.

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

References KIGFX::ALWAYS, gridVisibility, KIGFX::GAL_DISPLAY_OPTIONS::m_gridSnapping, 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

inline

Definition at line 828 of file graphics_abstraction_layer.h.

{ return gridVisibility; }

References gridVisibility.

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

GetHorizontalJustify()

EDA_TEXT_HJUSTIFY_T KIGFX::GAL::GetHorizontalJustify ( ) const

inline

Return current text horizontal justification setting.

Definition at line 457 of file graphics_abstraction_layer.h.

    {
        return textProperties.m_horizontalJustify;
    }

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

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

GetLineWidth()

float KIGFX::GAL::GetLineWidth ( ) const

inline

Get the line width.

Returns

the actual line width.

Definition at line 312 of file graphics_abstraction_layer.h.

    {
        return lineWidth;
    }

References 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

inline

Get the look at point.

Returns

the look at point.

Definition at line 657 of file graphics_abstraction_layer.h.

    {
        return lookAtPoint;
    }

References lookAtPoint.

GetMaxDepth()

double KIGFX::GAL::GetMaxDepth ( ) const

inline

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

Definition at line 726 of file graphics_abstraction_layer.h.

    {
        return depthRange.y;
    }

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

GetMinDepth()

double KIGFX::GAL::GetMinDepth ( ) const

inline

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

Definition at line 718 of file graphics_abstraction_layer.h.

    {
        return depthRange.x;
    }

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

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

GetRotation()

double KIGFX::GAL::GetRotation ( ) const

inline

Get the rotation angle.

Returns

The rotation angle (radians).

Definition at line 697 of file graphics_abstraction_layer.h.

    {
        return rotation;
    }

References rotation.

GetScreenPixelSize()

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

inline

Return GAL canvas size in pixels.

Definition at line 208 of file graphics_abstraction_layer.h.

    {
        return screenSize;
    }

References 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

inline

Get the screen <-> world transformation matrix.

Returns

the transformation matrix.

Definition at line 593 of file graphics_abstraction_layer.h.

    {
        return screenWorldMatrix;
    }

References screenWorldMatrix.

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

GetStrokeColor()

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

inline

Get the stroke color.

Returns

the color for stroking the outline.

Definition at line 292 of file graphics_abstraction_layer.h.

    {
        return strokeColor;
    }

References strokeColor.

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

GetStrokeFont()

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

inline

Definition at line 334 of file graphics_abstraction_layer.h.

    {
        return strokeFont;
    }

References strokeFont.

Referenced by EDA_TEXT::GetTextBox().

GetTarget()

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

inlinevirtual

Get the currently used target for rendering.

Returns

The current rendering target.

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

Definition at line 785 of file graphics_abstraction_layer.h.

{ return TARGET_CACHED; };

References KIGFX::TARGET_CACHED.

GetTextLineSize()

VECTOR2D GAL::GetTextLineSize

(

const UTF8 &

aText

)

const

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 174 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 strokeFont.computeTextLineSize( aText );
}

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

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

GetVerticalJustify()

EDA_TEXT_VJUSTIFY_T KIGFX::GAL::GetVerticalJustify ( ) const

inline

Returns current text vertical justification setting.

Definition at line 475 of file graphics_abstraction_layer.h.

    {
        return textProperties.m_verticalJustify;
    }

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

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

GetWorldScale()

double KIGFX::GAL::GetWorldScale ( ) const

inline

Get the world scale.

Returns

the actual world scale factor.

Definition at line 736 of file graphics_abstraction_layer.h.

    {
        return worldScale;
    }

References 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

inline

Get the world <-> screen transformation matrix.

Returns

the transformation matrix.

Definition at line 583 of file graphics_abstraction_layer.h.

    {
        return worldScreenMatrix;
    }

References worldScreenMatrix.

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

GetZoomFactor()

double KIGFX::GAL::GetZoomFactor ( ) const

inline

Get the zoom factor.

Returns

the zoom factor.

Definition at line 677 of file graphics_abstraction_layer.h.

    {
        return zoomFactor;
    }

References 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 )

inlinevirtual

Return true if the target exists.

Parameters

aTarget

is the target to be checked.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 799 of file graphics_abstraction_layer.h.

    {
        return true;
    };

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint().

IsCairoEngine()

virtual bool KIGFX::GAL::IsCairoEngine ( )

inlinevirtual

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

Reimplemented in KIGFX::CAIRO_GAL_BASE.

Definition at line 79 of file graphics_abstraction_layer.h.

{ return false; }

Referenced by getShadowLayer().

IsContextLocked()

virtual bool KIGFX::GAL::IsContextLocked ( )

inlinevirtual

Checks the state of the context lock.

Returns

True if the context is currently locked

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1033 of file graphics_abstraction_layer.h.

    {
        return false;
    }

Referenced by EDA_DRAW_PANEL_GAL::onSize().

IsCursorEnabled()

bool KIGFX::GAL::IsCursorEnabled ( ) const

inline

Return information about cursor visibility.

Returns

True if cursor is visible.

Definition at line 979 of file graphics_abstraction_layer.h.

    {
        return isCursorEnabled || forceDisplayCursor;
    }

References forceDisplayCursor, and isCursorEnabled.

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

IsFlippedX()

bool KIGFX::GAL::IsFlippedX ( ) const

inline

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

Definition at line 756 of file graphics_abstraction_layer.h.

    {
        return globalFlipX;
    }

References globalFlipX.

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

IsFlippedY()

bool KIGFX::GAL::IsFlippedY ( ) const

inline

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

Definition at line 764 of file graphics_abstraction_layer.h.

    {
        return globalFlipY;
    }

References globalFlipY.

IsFontBold()

bool KIGFX::GAL::IsFontBold ( ) const

inline

Definition at line 423 of file graphics_abstraction_layer.h.

{ return textProperties.m_bold; }

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

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

IsFontItalic()

bool KIGFX::GAL::IsFontItalic ( ) const

inline

Definition at line 431 of file graphics_abstraction_layer.h.

{ return textProperties.m_italic; }

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

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

IsFontUnderlined()

bool KIGFX::GAL::IsFontUnderlined ( ) const

inline

Definition at line 434 of file graphics_abstraction_layer.h.

{ return textProperties.m_underlined; }

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

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

IsInitialized()

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

inlinevirtual

Return the initialization status for the canvas.

Reimplemented in KIGFX::OPENGL_GAL.

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

inlinevirtual

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

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 82 of file graphics_abstraction_layer.h.

{ return false; }

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

IsTextMirrored()

bool KIGFX::GAL::IsTextMirrored ( ) const

inline

Definition at line 442 of file graphics_abstraction_layer.h.

{ return textProperties.m_mirrored; }

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

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

IsVisible()

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

inlinevirtual

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

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

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

inlineprotectedvirtual

Use GAL_CONTEXT_LOCKER RAII object.

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1040 of file graphics_abstraction_layer.h.

{}

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

OnGalDisplayOptionsChanged()

void GAL::OnGalDisplayOptionsChanged ( const GAL_DISPLAY_OPTIONS &  aOptions )

overrideprotectedvirtual

Handler for observer settings changes.

Implements KIGFX::GAL_DISPLAY_OPTIONS_OBSERVER.

Definition at line 92 of file graphics_abstraction_layer.cpp.

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

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

References updatedGalDisplayOptions().

PopDepth()

void KIGFX::GAL::PopDepth ( )

inline

Restore previously stored drawing depth for the depth stack.

Definition at line 1021 of file graphics_abstraction_layer.h.

    {
        layerDepth = depthStack.top();
        depthStack.pop();
    }

References depthStack, and layerDepth.

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

PushDepth()

void KIGFX::GAL::PushDepth ( )

inline

Store current drawing depth on the depth stack.

Definition at line 1013 of file graphics_abstraction_layer.h.

    {
        depthStack.push( layerDepth );
    }

References depthStack, and layerDepth.

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

ResetTextAttributes()

void GAL::ResetTextAttributes

(

)

Reset text attributes to default styling.

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

Definition at line 158 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, SetFontBold(), SetFontItalic(), SetFontUnderlined(), SetGlyphSize(), SetHorizontalJustify(), SetTextMirrored(), and SetVerticalJustify().

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

ResizeScreen()

virtual void KIGFX::GAL::ResizeScreen ( int  aWidth, int  aHeight  )

inlinevirtual

Resize the canvas.

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

Definition at line 202 of file graphics_abstraction_layer.h.

{};

Referenced by EDA_DRAW_FRAME::OnMove(), EDA_DRAW_PANEL_GAL::onSize(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

Restore()

virtual void KIGFX::GAL::Restore ( )

inlinevirtual

Restore the context.

Reimplemented in KIGFX::OPENGL_GAL, KIGFX::CAIRO_GAL_BASE, and BASIC_GAL.

Definition at line 517 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::STROKE_FONT::Draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::STROKE_FONT::drawSingleLineText(), and DS_PROXY_VIEW_ITEM::ViewDraw().

Rotate()

virtual void KIGFX::GAL::Rotate ( double  aAngle )

inlinevirtual

Rotate the context.

Parameters

aAngle

is the rotation angle in radians.

Reimplemented in KIGFX::OPENGL_GAL, KIGFX::CAIRO_GAL_BASE, and BASIC_GAL.

Definition at line 497 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::STROKE_FONT::Draw(), and KIGFX::PCB_PAINTER::draw().

Save()

virtual void KIGFX::GAL::Save ( )

inlinevirtual

Save the context.

Reimplemented in KIGFX::OPENGL_GAL, KIGFX::CAIRO_GAL_BASE, and BASIC_GAL.

Definition at line 514 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::STROKE_FONT::Draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::STROKE_FONT::drawSingleLineText(), and DS_PROXY_VIEW_ITEM::ViewDraw().

Scale()

virtual void KIGFX::GAL::Scale ( const VECTOR2D &  aScale )

inlinevirtual

Scale the context.

Parameters

aScale

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

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

Definition at line 511 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::SCH_PAINTER::draw(), and DS_PROXY_VIEW_ITEM::ViewDraw().

SetAxesColor()

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

inline

Set the axes color.

Parameters

aAxesColor

is the color to draw the axes if enabled.

Definition at line 898 of file graphics_abstraction_layer.h.

    {
        axesColor = aAxesColor;
    }

References axesColor.

Referenced by KIGFX::CAIRO_GAL_BASE::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 )

inline

Enable drawing the axes.

Definition at line 906 of file graphics_abstraction_layer.h.

    {
        axesEnabled = aAxesEnabled;
    }

References axesEnabled.

Referenced by FOOTPRINT_EDIT_FRAME::ActivateGalCanvas(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), 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 )

inline

Definition at line 216 of file graphics_abstraction_layer.h.

    {
        m_clearColor = aColor;
    }

References 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 )

inline

Draw every tick line wider.

Parameters

aInterval

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

Definition at line 916 of file graphics_abstraction_layer.h.

    {
        gridTick = aInterval;
    }

References gridTick.

Referenced by GAL().

SetCursorColor()

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

inline

Set the cursor color.

Parameters

aCursorColor

is the color of the cursor.

Definition at line 989 of file graphics_abstraction_layer.h.

    {
        cursorColor = aCursorColor;
    }

References cursorColor.

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

SetCursorEnabled()

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

inline

Enable/disable cursor.

Parameters

aCursorEnabled

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

Definition at line 969 of file graphics_abstraction_layer.h.

    {
        isCursorEnabled = aCursorEnabled;
    }

References isCursorEnabled.

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

SetDepthRange()

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

inline

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

    {
        depthRange = aDepthRange;
    }

References depthRange.

Referenced by GAL().

SetFillColor()

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

inlinevirtual

Set the fill color.

Parameters

aColor

is the color for filling.

Reimplemented in KIGFX::CAIRO_GAL_BASE.

Definition at line 262 of file graphics_abstraction_layer.h.

    {
        fillColor = aColor;
    }

References fillColor.

Referenced by KIGFX::OPENGL_GAL::beginDrawing(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), ROUTER_PREVIEW_ITEM::drawShape(), KIGFX::VIEW_OVERLAY::COMMAND_SET_COLOR::Execute(), GAL(), KIGFX::SCH_PAINTER::setDeviceColors(), KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::setupGal(), KIGFX::PREVIEW::SELECTION_AREA::ViewDraw(), and ROUTER_PREVIEW_ITEM::ViewDraw().

SetFlip()

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

inline

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

    {
        globalFlipX = xAxis;
        globalFlipY = yAxis;
    }

References globalFlipX, and globalFlipY.

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

SetFontBold()

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

inline

Set bold property of current font.

Parameters

aBold

tells if the font should be bold or not.

Definition at line 422 of file graphics_abstraction_layer.h.

{ textProperties.m_bold = aBold;  }

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

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

SetFontItalic()

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

inline

Set italic property of current font.

Parameters

aItalic

tells if the font should be italic or not.

Definition at line 430 of file graphics_abstraction_layer.h.

{ textProperties.m_italic = aItalic; }

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

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

SetFontUnderlined()

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

inline

Definition at line 433 of file graphics_abstraction_layer.h.

{ textProperties.m_underlined = aUnderlined; }

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

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

SetGlyphSize()

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

inline

Set the font glyph size.

Parameters

aGlyphSize

is the new font glyph size.

Definition at line 414 of file graphics_abstraction_layer.h.

{ textProperties.m_glyphSize = aSize; }

References KIGFX::GAL::TEXT_PROPERTIES::m_glyphSize, and 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(), ResetTextAttributes(), KIGFX::PREVIEW::SetConstantGlyphHeight(), and SetTextAttributes().

SetGridColor()

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

inline

Set the grid color.

Parameters

aGridColor

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

Definition at line 888 of file graphics_abstraction_layer.h.

    {
        gridColor = aGridColor;
    }

References gridColor.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), KIGFX::CAIRO_GAL_BASE::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 )

inline

Set the origin point for the grid.

Parameters

aGridOrigin

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

Definition at line 840 of file graphics_abstraction_layer.h.

    {
        gridOrigin = aGridOrigin;

        if( gridSize.x == 0.0 || gridSize.y == 0.0 )
            gridOffset = VECTOR2D(0.0, 0.0);
        else
            gridOffset = VECTOR2D( (long) gridOrigin.x % (long) gridSize.x,
                                   (long) gridOrigin.y % (long) gridSize.y );
    }

References gridOffset, gridOrigin, 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 )

inline

Set the grid size.

Parameters

aGridSize

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

Definition at line 861 of file graphics_abstraction_layer.h.

    {
        gridSize = aGridSize;

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

        gridOffset = VECTOR2D( (long) gridOrigin.x % (long) gridSize.x,
                               (long) gridOrigin.y % (long) gridSize.y );
    }

References gridOffset, gridOrigin, 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 )

inline

Set the visibility setting of the grid.

Parameters

aVisibility

is the new visibility setting of the grid.

Definition at line 826 of file graphics_abstraction_layer.h.

{ gridVisibility = aVisibility; }

References gridVisibility.

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

inline

Set the horizontal justify for text drawing.

Parameters

aHorizontalJustify

is the horizontal justify value.

Definition at line 449 of file graphics_abstraction_layer.h.

    {
        textProperties.m_horizontalJustify = aHorizontalJustify;
    }

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

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

SetIsFill()

virtual void KIGFX::GAL::SetIsFill ( bool  aIsFillEnabled )

inlinevirtual

Enable/disable fill.

Parameters

aIsFillEnabled

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

Reimplemented in KIGFX::CAIRO_GAL_BASE.

Definition at line 242 of file graphics_abstraction_layer.h.

    {
        isFillEnabled = aIsFillEnabled;
    }

References isFillEnabled.

Referenced by KIGFX::SCH_PAINTER::Draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawCircle(), KIGFX::SCH_PAINTER::drawDanglingSymbol(), KIGFX::GERBVIEW_PAINTER::drawFlashedShape(), ROUTER_PREVIEW_ITEM::drawLineChain(), KIGFX::SCH_PAINTER::drawPinDanglingSymbol(), ROUTER_PREVIEW_ITEM::drawShape(), KIGFX::PREVIEW::DrawTextNextToCursor(), KIGFX::VIEW_OVERLAY::COMMAND_SET_FILL::Execute(), KIGFX::SCH_PAINTER::fillIfSelection(), GAL(), GRText(), KIGFX::SCH_PAINTER::setDeviceColors(), KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::setupGal(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), BRIGHT_BOX::ViewDraw(), KIGFX::PREVIEW::SELECTION_AREA::ViewDraw(), and ROUTER_PREVIEW_ITEM::ViewDraw().

SetIsStroke()

virtual void KIGFX::GAL::SetIsStroke ( bool  aIsStrokeEnabled )

inlinevirtual

Enable/disable stroked outlines.

Parameters

aIsStrokeEnabled

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

Reimplemented in KIGFX::CAIRO_GAL_BASE.

Definition at line 252 of file graphics_abstraction_layer.h.

    {
        isStrokeEnabled = aIsStrokeEnabled;
    }

References isStrokeEnabled.

Referenced by KIGFX::STROKE_FONT::Draw(), KIGFX::SCH_PAINTER::Draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawCircle(), KIGFX::SCH_PAINTER::drawDanglingSymbol(), KIGFX::GERBVIEW_PAINTER::drawFlashedShape(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawLine(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawLineWithAngleHighlight(), KIGFX::SCH_PAINTER::drawPinDanglingSymbol(), ROUTER_PREVIEW_ITEM::drawShape(), KIGFX::VIEW_OVERLAY::COMMAND_SET_STROKE::Execute(), GAL(), KIGFX::SCH_PAINTER::setDeviceColors(), KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::setupGal(), PCB_BRIGHT_BOX::ViewDraw(), RATSNEST_VIEW_ITEM::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), BRIGHT_BOX::ViewDraw(), KIGFX::ORIGIN_VIEWITEM::ViewDraw(), KIGFX::PREVIEW::SELECTION_AREA::ViewDraw(), and ROUTER_PREVIEW_ITEM::ViewDraw().

SetLayerDepth()

virtual void KIGFX::GAL::SetLayerDepth ( double  aLayerDepth )

inlinevirtual

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

Parameters

aLayerDepth

the layer depth for the objects.

Reimplemented in KIGFX::CAIRO_GAL_BASE.

Definition at line 322 of file graphics_abstraction_layer.h.

    {
        assert( aLayerDepth <= depthRange.y );
        assert( aLayerDepth >= depthRange.x );

        layerDepth = aLayerDepth;
    }

References depthRange, layerDepth, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by KIGFX::VIEW::draw(), ROUTER_PREVIEW_ITEM::drawShape(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), GAL(), KIGFX::VIEW::redrawRect(), KIGFX::CAIRO_GAL_BASE::SetLayerDepth(), KIGFX::VIEW::updateItemGeometry(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), and ROUTER_PREVIEW_ITEM::ViewDraw().

SetLineWidth()

virtual void KIGFX::GAL::SetLineWidth ( float  aLineWidth )

inlinevirtual

Set the line width.

Parameters

aLineWidth

is the line width.

Reimplemented in KIGFX::CAIRO_GAL_BASE.

Definition at line 302 of file graphics_abstraction_layer.h.

    {
        lineWidth = aLineWidth;
    }

References lineWidth.

Referenced by KIGFX::STROKE_FONT::Draw(), KIGFX::SCH_PAINTER::Draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::drawApertureMacro(), KIGFX::OPENGL_GAL::DrawArcSegment(), drawBacksideTicks(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawCircle(), KIGFX::SCH_PAINTER::drawDanglingSymbol(), KIGFX::GERBVIEW_PAINTER::drawFlashedShape(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawLine(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawLineWithAngleHighlight(), KIGFX::SCH_PAINTER::drawPinDanglingSymbol(), KIGFX::GERBVIEW_PAINTER::drawPolygon(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), KIGFX::OPENGL_GAL::DrawSegment(), ROUTER_PREVIEW_ITEM::drawShape(), KIGFX::PREVIEW::DrawTextNextToCursor(), drawTicksAlongLine(), KIGFX::VIEW_OVERLAY::COMMAND_SET_WIDTH::Execute(), GAL(), GRText(), EDA_TEXT::LenSize(), screenSpaceCircle(), screenSpaceLine(), KIGFX::SCH_PAINTER::setDeviceColors(), KIGFX::CAIRO_GAL_BASE::SetLineWidth(), KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::setupGal(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), BRIGHT_BOX::ViewDraw(), and KIGFX::PREVIEW::SELECTION_AREA::ViewDraw().

SetLookAtPoint()

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

inline

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

    {
        lookAtPoint = aPoint;
    }

References lookAtPoint.

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

SetNegativeDrawMode()

virtual void KIGFX::GAL::SetNegativeDrawMode ( bool  aSetting )

inlinevirtual

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

Definition at line 815 of file graphics_abstraction_layer.h.

{};

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

SetRotation()

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

inline

Set the rotation angle.

Parameters

aRotation

is the new rotation angle (radians).

Definition at line 687 of file graphics_abstraction_layer.h.

    {
        rotation = aRotation;
    }

References rotation.

Referenced by GAL().

SetScreenDPI()

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

inline

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

    {
        screenDPI = aScreenDPI;
    }

References screenDPI.

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

SetScreenSize()

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

inline

Definition at line 622 of file graphics_abstraction_layer.h.

    {
        screenSize = aSize;
    }

References screenSize.

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

SetStrokeColor()

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

inlinevirtual

Set the stroke color.

Parameters

aColor

is the color for stroking the outline.

Reimplemented in KIGFX::CAIRO_GAL_BASE.

Definition at line 282 of file graphics_abstraction_layer.h.

    {
        strokeColor = aColor;
    }

References strokeColor.

Referenced by KIGFX::OPENGL_GAL::beginDrawing(), KIGFX::SCH_PAINTER::Draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawCircle(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawLine(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawLineWithAngleHighlight(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), ROUTER_PREVIEW_ITEM::drawShape(), KIGFX::PREVIEW::DrawTextNextToCursor(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), KIGFX::VIEW_OVERLAY::COMMAND_SET_COLOR::Execute(), GAL(), KIGFX::SCH_PAINTER::setDeviceColors(), KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::setupGal(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), BRIGHT_BOX::ViewDraw(), KIGFX::PREVIEW::SELECTION_AREA::ViewDraw(), and ROUTER_PREVIEW_ITEM::ViewDraw().

SetTarget()

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

inlinevirtual

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

{};

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

SetTextAttributes()

void GAL::SetTextAttributes ( const EDA_TEXT *  aText )

virtual

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

Parameters

aText

is the text item.

Definition at line 146 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(), SetFontBold(), SetFontItalic(), SetFontUnderlined(), SetGlyphSize(), SetHorizontalJustify(), SetTextMirrored(), and SetVerticalJustify().

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

SetTextMirrored()

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

inline

Set a mirrored property of text.

Parameters

aMirrored

tells if the text should be mirrored or not.

Definition at line 441 of file graphics_abstraction_layer.h.

{ textProperties.m_mirrored = aMirrored; }

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

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

SetVerticalJustify()

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

inline

Set the vertical justify for text drawing.

Parameters

aVerticalJustify

is the vertical justify value.

Definition at line 467 of file graphics_abstraction_layer.h.

    {
        textProperties.m_verticalJustify = aVerticalJustify;
    }

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

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

SetWorldScreenMatrix()

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

inline

Set the world <-> screen transformation matrix.

Parameters

aMatrix

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

Definition at line 603 of file graphics_abstraction_layer.h.

    {
        worldScreenMatrix = aMatrix;
    }

References worldScreenMatrix.

SetWorldUnitLength()

void KIGFX::GAL::SetWorldUnitLength ( double  aWorldUnitLength )

inline

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

    {
        worldUnitLength = aWorldUnitLength;
    }

References worldUnitLength.

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

inline

Set the zoom factor of the scene.

Parameters

aZoomFactor

is the zoom factor.

Definition at line 667 of file graphics_abstraction_layer.h.

    {
        zoomFactor = aZoomFactor;
    }

References zoomFactor.

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

Show()

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

inlinevirtual

Show/hide the GAL canvas.

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

Definition at line 205 of file graphics_abstraction_layer.h.

{ return true; };

StrokeText()

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

inlinevirtual

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

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

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

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

ToScreen()

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

inline

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

    {
        return VECTOR2D( worldScreenMatrix * aPoint );
    }

References worldScreenMatrix.

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

ToWorld()

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

inline

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

    {
        return VECTOR2D( screenWorldMatrix * aPoint );
    }

References screenWorldMatrix.

Transform()

virtual void KIGFX::GAL::Transform ( const MATRIX3x3D &  aTransformation )

inlinevirtual

Transform the context.

Parameters

aTransformation

is the transformation matrix.

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

Definition at line 490 of file graphics_abstraction_layer.h.

{};

Translate()

virtual void KIGFX::GAL::Translate ( const VECTOR2D &  aTranslation )

inlinevirtual

Translate the context.

Parameters

aTranslation

is the translation vector.

Reimplemented in KIGFX::OPENGL_GAL, KIGFX::CAIRO_GAL_BASE, and BASIC_GAL.

Definition at line 504 of file graphics_abstraction_layer.h.

{};

Referenced by KIGFX::STROKE_FONT::Draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::STROKE_FONT::drawSingleLineText(), and DS_PROXY_VIEW_ITEM::ViewDraw().

unlockContext()

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

inlineprotectedvirtual

Reimplemented in KIGFX::OPENGL_GAL.

Definition at line 1042 of file graphics_abstraction_layer.h.

{}

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

updatedGalDisplayOptions()

bool GAL::updatedGalDisplayOptions ( const GAL_DISPLAY_OPTIONS &  aOptions )

protectedvirtual

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

{
    bool refresh = false;

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

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

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

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

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

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

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

References axesEnabled, forceDisplayCursor, fullscreenCursor, gridLineWidth, gridMinSpacing, gridStyle, KIGFX::GAL_DISPLAY_OPTIONS::m_axesEnabled, KIGFX::GAL_DISPLAY_OPTIONS::m_forceDisplayCursor, KIGFX::GAL_DISPLAY_OPTIONS::m_fullscreenCursor, KIGFX::GAL_DISPLAY_OPTIONS::m_gridLineWidth, KIGFX::GAL_DISPLAY_OPTIONS::m_gridMinSpacing, KIGFX::GAL_DISPLAY_OPTIONS::m_gridStyle, and options.

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

Friends And Related Function Documentation

GAL_CONTEXT_LOCKER

friend class GAL_CONTEXT_LOCKER

friend

Definition at line 63 of file graphics_abstraction_layer.h.

GAL_DRAWING_CONTEXT

friend class GAL_DRAWING_CONTEXT

friend

Definition at line 65 of file graphics_abstraction_layer.h.

GAL_UPDATE_CONTEXT

friend class GAL_UPDATE_CONTEXT

friend

Definition at line 64 of file graphics_abstraction_layer.h.

Member Data Documentation

axesColor

COLOR4D KIGFX::GAL::axesColor

protected

Color of the axes.

Definition at line 1140 of file graphics_abstraction_layer.h.

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

axesEnabled

bool KIGFX::GAL::axesEnabled

protected

Should the axes be drawn.

Definition at line 1141 of file graphics_abstraction_layer.h.

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

cursorColor

COLOR4D KIGFX::GAL::cursorColor

protected

Cursor color.

Definition at line 1150 of file graphics_abstraction_layer.h.

Referenced by getCursorColor(), and SetCursorColor().

cursorPosition

VECTOR2D KIGFX::GAL::cursorPosition

protected

Current cursor position (world coordinates)

Definition at line 1152 of file graphics_abstraction_layer.h.

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

depthRange

VECTOR2D KIGFX::GAL::depthRange

protected

Range of the depth.

Definition at line 1131 of file graphics_abstraction_layer.h.

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

depthStack

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

protected

Stored depth values.

Definition at line 1105 of file graphics_abstraction_layer.h.

Referenced by PopDepth(), and PushDepth().

fillColor

COLOR4D KIGFX::GAL::fillColor

protected

The fill color.

Definition at line 1126 of file graphics_abstraction_layer.h.

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

forceDisplayCursor

bool KIGFX::GAL::forceDisplayCursor

protected

Always show cursor.

Definition at line 1149 of file graphics_abstraction_layer.h.

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

fullscreenCursor

bool KIGFX::GAL::fullscreenCursor

protected

Shape of the cursor (fullscreen or small cross)

Definition at line 1151 of file graphics_abstraction_layer.h.

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

globalFlipX

bool KIGFX::GAL::globalFlipX

protected

Flag for X axis flipping.

Definition at line 1118 of file graphics_abstraction_layer.h.

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

globalFlipY

bool KIGFX::GAL::globalFlipY

protected

Flag for Y axis flipping.

Definition at line 1119 of file graphics_abstraction_layer.h.

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

GRID_DEPTH

const int GAL::GRID_DEPTH = MAX_DEPTH - 1

staticprotected

Depth level on which the grid is drawn.

Definition at line 1077 of file graphics_abstraction_layer.h.

gridColor

COLOR4D KIGFX::GAL::gridColor

protected

Color of the grid.

Definition at line 1139 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::CAIRO_GAL_BASE::drawGridCross(), KIGFX::CAIRO_GAL_BASE::drawGridLine(), KIGFX::CAIRO_GAL_BASE::drawGridPoint(), and SetGridColor().

gridLineWidth

float KIGFX::GAL::gridLineWidth

protected

Line width of the grid.

Definition at line 1143 of file graphics_abstraction_layer.h.

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

gridMinSpacing

int KIGFX::GAL::gridMinSpacing

protected

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

Definition at line 1144 of file graphics_abstraction_layer.h.

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

gridOffset

VECTOR2D KIGFX::GAL::gridOffset

protected

The grid offset to compensate cursor position.

Definition at line 1138 of file graphics_abstraction_layer.h.

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

gridOrigin

VECTOR2D KIGFX::GAL::gridOrigin

protected

The grid origin.

Definition at line 1137 of file graphics_abstraction_layer.h.

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

gridSize

VECTOR2D KIGFX::GAL::gridSize

protected

The grid size.

Definition at line 1136 of file graphics_abstraction_layer.h.

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

gridStyle

GRID_STYLE KIGFX::GAL::gridStyle

protected

Grid display style.

Definition at line 1135 of file graphics_abstraction_layer.h.

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

gridTick

int KIGFX::GAL::gridTick

protected

Every tick line gets the double width.

Definition at line 1142 of file graphics_abstraction_layer.h.

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

gridVisibility

bool KIGFX::GAL::gridVisibility

protected

Should the grid be shown.

Definition at line 1134 of file graphics_abstraction_layer.h.

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

isCursorEnabled

bool KIGFX::GAL::isCursorEnabled

protected

Is the cursor enabled?

Definition at line 1148 of file graphics_abstraction_layer.h.

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

isFillEnabled

bool KIGFX::GAL::isFillEnabled

protected

Is filling of graphic objects enabled ?

Definition at line 1123 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL_BASE::DrawArc(), KIGFX::OPENGL_GAL::DrawArc(), KIGFX::CAIRO_GAL_BASE::DrawArcSegment(), KIGFX::OPENGL_GAL::DrawArcSegment(), KIGFX::OPENGL_GAL::DrawCircle(), KIGFX::CAIRO_GAL_BASE::DrawGroup(), KIGFX::OPENGL_GAL::drawPolygon(), KIGFX::OPENGL_GAL::DrawRectangle(), KIGFX::CAIRO_GAL_BASE::DrawSegment(), KIGFX::OPENGL_GAL::DrawSegment(), KIGFX::OPENGL_GAL::drawSemiCircle(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), KIGFX::CAIRO_GAL_BASE::flushPath(), KIGFX::CAIRO_GAL_BASE::SetIsFill(), SetIsFill(), and KIGFX::CAIRO_GAL_BASE::storePath().

isStrokeEnabled

bool KIGFX::GAL::isStrokeEnabled

protected

Are the outlines stroked ?

Definition at line 1124 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::DrawArc(), KIGFX::CAIRO_GAL_BASE::DrawArcSegment(), KIGFX::OPENGL_GAL::DrawArcSegment(), KIGFX::OPENGL_GAL::DrawCircle(), KIGFX::CAIRO_GAL_BASE::DrawGrid(), KIGFX::CAIRO_GAL_BASE::DrawGroup(), KIGFX::OPENGL_GAL::drawPolygon(), KIGFX::OPENGL_GAL::DrawRectangle(), KIGFX::OPENGL_GAL::drawSemiCircle(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), KIGFX::CAIRO_GAL_BASE::flushPath(), KIGFX::CAIRO_GAL_BASE::roundp(), KIGFX::CAIRO_GAL_BASE::SetIsStroke(), SetIsStroke(), and KIGFX::CAIRO_GAL_BASE::storePath().

layerDepth

double KIGFX::GAL::layerDepth

protected

The actual layer depth.

Definition at line 1130 of file graphics_abstraction_layer.h.

Referenced by AdvanceDepth(), KIGFX::OPENGL_GAL::BitmapText(), KIGFX::OPENGL_GAL::DrawArc(), KIGFX::OPENGL_GAL::DrawBitmap(), KIGFX::OPENGL_GAL::DrawCircle(), KIGFX::OPENGL_GAL::drawFilledSemiCircle(), KIGFX::OPENGL_GAL::drawLineQuad(), KIGFX::OPENGL_GAL::DrawPolygon(), KIGFX::OPENGL_GAL::DrawRectangle(), KIGFX::OPENGL_GAL::drawStrokedSemiCircle(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), PopDepth(), PushDepth(), and SetLayerDepth().

lineWidth

float KIGFX::GAL::lineWidth

protected

The line width.

Definition at line 1121 of file graphics_abstraction_layer.h.

Referenced by BitmapText(), KIGFX::CAIRO_GAL_BASE::CAIRO_GAL_BASE(), KIGFX::CAIRO_GAL_BASE::DrawArcSegment(), KIGFX::OPENGL_GAL::DrawCircle(), KIGFX::OPENGL_GAL::drawLineQuad(), KIGFX::OPENGL_GAL::drawStrokedSemiCircle(), GetLineWidth(), KIGFX::CAIRO_GAL_BASE::resetContext(), KIGFX::CAIRO_GAL_BASE::SetLineWidth(), SetLineWidth(), and KIGFX::CAIRO_GAL_BASE::syncLineWidth().

lookAtPoint

VECTOR2D KIGFX::GAL::lookAtPoint

protected

Point to be looked at in world space.

Definition at line 1110 of file graphics_abstraction_layer.h.

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

m_clearColor

COLOR4D KIGFX::GAL::m_clearColor

protected

Definition at line 1128 of file graphics_abstraction_layer.h.

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

MAX_DEPTH

const int GAL::MAX_DEPTH = 1023

staticprotected

Definition at line 1074 of file graphics_abstraction_layer.h.

Referenced by GAL().

MIN_DEPTH

const int GAL::MIN_DEPTH = -1024

staticprotected

Possible depth range.

Definition at line 1073 of file graphics_abstraction_layer.h.

Referenced by GAL().

observerLink

UTIL::LINK KIGFX::GAL::observerLink

protected

Definition at line 1103 of file graphics_abstraction_layer.h.

Referenced by GAL().

options

GAL_DISPLAY_OPTIONS& KIGFX::GAL::options

protected

Definition at line 1102 of file graphics_abstraction_layer.h.

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

rotation

double KIGFX::GAL::rotation

protected

Rotation transformation (radians)

Definition at line 1113 of file graphics_abstraction_layer.h.

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

screenDPI

double KIGFX::GAL::screenDPI

protected

The dots per inch of the screen.

Definition at line 1109 of file graphics_abstraction_layer.h.

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

screenSize

VECTOR2I KIGFX::GAL::screenSize

protected

Screen size in screen coordinates.

Definition at line 1106 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_GAL::allocateBitmaps(), KIGFX::OPENGL_GAL::beginDrawing(), KIGFX::CAIRO_GAL::CAIRO_GAL(), KIGFX::CAIRO_GAL_BASE::ClearScreen(), ComputeWorldScreenMatrix(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::CAIRO_GAL_BASE::DrawGrid(), KIGFX::CAIRO_GAL::endDrawing(), GetScreenPixelSize(), KIGFX::OPENGL_GAL::getScreenPixelSize(), KIGFX::CAIRO_GAL::initSurface(), KIGFX::OPENGL_GAL::OPENGL_GAL(), KIGFX::CAIRO_GAL_BASE::ResizeScreen(), KIGFX::OPENGL_GAL::ResizeScreen(), KIGFX::CAIRO_GAL::setCompositor(), and SetScreenSize().

screenWorldMatrix

MATRIX3x3D KIGFX::GAL::screenWorldMatrix

protected

Screen transformation.

Definition at line 1115 of file graphics_abstraction_layer.h.

Referenced by KIGFX::CAIRO_PRINT_GAL::ComputeWorldScreenMatrix(), ComputeWorldScreenMatrix(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::CAIRO_GAL_BASE::DrawGrid(), GetScreenWorldMatrix(), and ToWorld().

strokeColor

COLOR4D KIGFX::GAL::strokeColor

protected

The color of the outlines.

Definition at line 1127 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::beginDrawing(), KIGFX::OPENGL_GAL::BitmapText(), KIGFX::OPENGL_GAL::DrawArc(), KIGFX::CAIRO_GAL_BASE::DrawArcSegment(), KIGFX::OPENGL_GAL::DrawArcSegment(), KIGFX::OPENGL_GAL::drawBitmapOverbar(), KIGFX::OPENGL_GAL::DrawCircle(), KIGFX::CAIRO_GAL_BASE::DrawGroup(), KIGFX::OPENGL_GAL::DrawLine(), KIGFX::OPENGL_GAL::drawPolyline(), KIGFX::OPENGL_GAL::DrawRectangle(), KIGFX::CAIRO_GAL_BASE::DrawSegment(), KIGFX::OPENGL_GAL::DrawSegment(), KIGFX::OPENGL_GAL::drawSemiCircle(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), KIGFX::CAIRO_GAL_BASE::flushPath(), GetStrokeColor(), KIGFX::CAIRO_GAL_BASE::SetStrokeColor(), SetStrokeColor(), and KIGFX::CAIRO_GAL_BASE::storePath().

strokeFont

STROKE_FONT KIGFX::GAL::strokeFont

protected

Instance of object that stores information about how to draw texts.

Definition at line 1155 of file graphics_abstraction_layer.h.

Referenced by GAL(), GetStrokeFont(), GetTextLineSize(), and StrokeText().

textProperties

struct KIGFX::GAL::TEXT_PROPERTIES KIGFX::GAL::textProperties

private

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

worldScale

double KIGFX::GAL::worldScale

protected

The scale factor world->screen.

Definition at line 1116 of file graphics_abstraction_layer.h.

Referenced by KIGFX::OPENGL_GAL::blitCursor(), computeWorldScale(), KIGFX::CAIRO_PRINT_GAL::ComputeWorldScreenMatrix(), KIGFX::OPENGL_GAL::ComputeWorldScreenMatrix(), ComputeWorldScreenMatrix(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::CAIRO_GAL_BASE::DrawGrid(), and GetWorldScale().

worldScreenMatrix

MATRIX3x3D KIGFX::GAL::worldScreenMatrix

protected

World transformation.

Definition at line 1114 of file graphics_abstraction_layer.h.

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

worldUnitLength

double KIGFX::GAL::worldUnitLength

protected

The unit length of the world coordinates [inch].

Definition at line 1108 of file graphics_abstraction_layer.h.

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

zoomFactor

double KIGFX::GAL::zoomFactor

protected

The zoom factor.

Definition at line 1112 of file graphics_abstraction_layer.h.

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

---

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

• graphics_abstraction_layer.h
• graphics_abstraction_layer.cpp