KIGFX::OPENGL_GAL Class Reference

OpenGL implementation of the Graphics Abstraction Layer. More...

#include <opengl_gal.h>

Inheritance diagram for KIGFX::OPENGL_GAL:

Classes
struct	TessParams

Public Member Functions
	OPENGL_GAL (GAL_DISPLAY_OPTIONS &aDisplayOptions, wxWindow *aParent, wxEvtHandler *aMouseListener=nullptr, wxEvtHandler *aPaintListener=nullptr, const wxString &aName=wxT("GLCanvas"))
	~OPENGL_GAL ()
bool	IsOpenGlEngine () override
	Return true if the GAL engine is a OpenGL based type. More...
bool	IsInitialized () const override
	Return the initialization status for the canvas. More...
bool	IsVisible () const override
	Return true if the GAL canvas is visible on the screen. More...
void	DrawLine (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint) override
	Draw a line. More...
void	DrawSegment (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint, double aWidth) override
	Draw a rounded segment. More...
void	DrawCircle (const VECTOR2D &aCenterPoint, double aRadius) override
	Draw a circle using world coordinates. More...
void	DrawArc (const VECTOR2D &aCenterPoint, double aRadius, double aStartAngle, double aEndAngle) override
	Draw an arc. More...
void	DrawArcSegment (const VECTOR2D &aCenterPoint, double aRadius, double aStartAngle, double aEndAngle, double aWidth, double aMaxError) override
	Draw an arc segment. More...
void	DrawRectangle (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint) override
	Draw a rectangle. More...
void	DrawPolyline (const std::deque< VECTOR2D > &aPointList) override
	Draw a polyline. More...
void	DrawPolyline (const VECTOR2D aPointList[], int aListSize) override
void	DrawPolyline (const SHAPE_LINE_CHAIN &aLineChain) override
void	DrawPolygon (const std::deque< VECTOR2D > &aPointList) override
	Draw a polygon. More...
void	DrawPolygon (const VECTOR2D aPointList[], int aListSize) override
void	DrawPolygon (const SHAPE_POLY_SET &aPolySet, bool aStrokeTriangulation=false) override
void	DrawPolygon (const SHAPE_LINE_CHAIN &aPolySet) override
void	DrawCurve (const VECTOR2D &startPoint, const VECTOR2D &controlPointA, const VECTOR2D &controlPointB, const VECTOR2D &endPoint, double aFilterValue=0.0) override
	Draw a cubic bezier spline. More...
void	DrawBitmap (const BITMAP_BASE &aBitmap) override
	Draw a bitmap image. More...
void	BitmapText (const wxString &aText, const VECTOR2D &aPosition, double aRotationAngle) override
	Draw a text using a bitmap font. More...
void	DrawGrid () override
void	ResizeScreen (int aWidth, int aHeight) override
	Resizes the canvas. More...
bool	Show (bool aShow) override
	Shows/hides the GAL canvas. More...
void	Flush () override
	Force all remaining objects to be drawn. More...
void	ClearScreen () override
	Clear the screen. More...
void	Transform (const MATRIX3x3D &aTransformation) override
	Transform the context. More...
void	Rotate (double aAngle) override
	Rotate the context. More...
void	Translate (const VECTOR2D &aTranslation) override
	Translate the context. More...
void	Scale (const VECTOR2D &aScale) override
	Scale the context. More...
void	Save () override
	Save the context. More...
void	Restore () override
	Restore the context. More...
int	BeginGroup () override
	Begin a group. More...
void	EndGroup () override
	End the group. More...
void	DrawGroup (int aGroupNumber) override
	Draw the stored group. More...
void	ChangeGroupColor (int aGroupNumber, const COLOR4D &aNewColor) override
	Change the color used to draw the group. More...
void	ChangeGroupDepth (int aGroupNumber, int aDepth) override
	Change the depth (Z-axis position) of the group. More...
void	DeleteGroup (int aGroupNumber) override
	Delete the group from the memory. More...
void	ClearCache () override
	Delete all data created during caching of graphic items. More...
void	SetTarget (RENDER_TARGET aTarget) override
	Set the target for rendering. More...
RENDER_TARGET	GetTarget () const override
	Get the currently used target for rendering. More...
void	ClearTarget (RENDER_TARGET aTarget) override
	Clear the target for rendering. More...
virtual bool	HasTarget (RENDER_TARGET aTarget) override
	Return true if the target exists. More...
void	SetNegativeDrawMode (bool aSetting) override
	Set negative draw mode in the renderer. More...
void	StartDiffLayer () override
	Begins rendering of a differential layer. More...
void	EndDiffLayer () override
	Ends rendering of a differential layer. More...
void	ComputeWorldScreenMatrix () override
	Compute the world <-> screen transformation matrix. More...
bool	SetNativeCursorStyle (KICURSOR aCursor) override
	Set the cursor in the native panel. More...
void	DrawCursor (const VECTOR2D &aCursorPosition) override
	Draw the cursor. More...
void	PostPaint (wxPaintEvent &aEvent)
	Function PostPaint posts an event to m_paint_listener. More...
void	SetMouseListener (wxEvtHandler *aMouseListener)
void	SetPaintListener (wxEvtHandler *aPaintListener)
void	EnableDepthTest (bool aEnabled=false) override
bool	IsContextLocked () override
	Parameters passed to the GLU tesselator. More...
virtual bool	IsCairoEngine ()
	Return true if the GAL engine is a Cairo based type. More...
const VECTOR2I &	GetScreenPixelSize () const
	Return GAL canvas size in pixels. More...
void	SetClearColor (const COLOR4D &aColor)
const COLOR4D &	GetClearColor () const
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...
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 (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 (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...
const MATRIX3x3D &	GetWorldScreenMatrix () const
	Get the world <-> screen transformation matrix. More...
const MATRIX3x3D &	GetScreenWorldMatrix () const
	Get the screen <-> world transformation matrix. More...
void	SetWorldScreenMatrix (const MATRIX3x3D &aMatrix)
	Set the world <-> screen transformation matrix. More...
BOX2D	GetVisibleWorldExtents () const
void	SetWorldUnitLength (double aWorldUnitLength)
	Set the unit length. More...
void	SetScreenSize (const VECTOR2I &aSize)
void	SetScreenDPI (double aScreenDPI)
	Set the dots per inch of the screen. More...
void	SetLookAtPoint (const VECTOR2D &aPoint)
	Set the Point in world space to look at. More...
const VECTOR2D &	GetLookAtPoint () const
	Get the look at point. More...
void	SetZoomFactor (double aZoomFactor)
	Set the zoom factor of the scene. More...
double	GetZoomFactor () const
	Get the zoom factor. More...
void	SetRotation (double aRotation)
	Set the rotation angle. More...
double	GetRotation () const
	Get the rotation angle. More...
void	SetDepthRange (const VECTOR2D &aDepthRange)
	Set the range of the layer depth. More...
double	GetMinDepth () const
	Return the minimum depth in the currently used range (the top). More...
double	GetMaxDepth () const
	Return the maximum depth in the currently used range (the bottom). More...
double	GetWorldScale () const
	Get the world scale. More...
void	SetFlip (bool xAxis, bool yAxis)
	Sets flipping of the screen. More...
bool	IsFlippedX () const
	Return true if flip flag for the X axis is set. More...
bool	IsFlippedY () const
	Return true if flip flag for the Y axis is set. More...
virtual void	StartNegativesLayer ()
	Begins rendering in a new layer that will be copied to the main layer in EndNegativesLayer(). More...
virtual void	EndNegativesLayer ()
	Ends rendering of a negatives layer and draws it to the main layer. More...
void	SetGridVisibility (bool aVisibility)
	Set the visibility setting of the grid. More...
bool	GetGridVisibility () const
bool	GetGridSnapping () const
void	SetGridOrigin (const VECTOR2D &aGridOrigin)
	Set the origin point for the grid. More...
const VECTOR2D &	GetGridOrigin () const
void	SetGridSize (const VECTOR2D &aGridSize)
	Set the grid size. More...
const VECTOR2D &	GetGridSize () const
	Return the grid size. More...
void	SetGridColor (const COLOR4D &aGridColor)
	Set the grid color. More...
void	SetAxesColor (const COLOR4D &aAxesColor)
	Set the axes color. More...
void	SetAxesEnabled (bool aAxesEnabled)
	Enable drawing the axes. More...
void	SetCoarseGrid (int aInterval)
	Draw every tick line wider. More...
float	GetGridLineWidth () const
	Get the grid line width. More...
VECTOR2D	GetGridPoint (const VECTOR2D &aPoint) const
	For a given point it returns the nearest point belonging to the grid in world coordinates. More...
VECTOR2D	ToWorld (const VECTOR2D &aPoint) const
	Compute the point position in world coordinates from given screen coordinates. More...
VECTOR2D	ToScreen (const VECTOR2D &aPoint) const
	Compute the point position in screen coordinates from given world coordinates. More...
void	SetCursorEnabled (bool aCursorEnabled)
	Enable/disable cursor. More...
bool	IsCursorEnabled () const
	Return information about cursor visibility. More...
void	SetCursorColor (const COLOR4D &aCursorColor)
	Set the cursor color. More...
void	AdvanceDepth ()
	Change the current depth to deeper, so it is possible to draw objects right beneath other. More...
void	PushDepth ()
	Store current drawing depth on the depth stack. More...
void	PopDepth ()
	Restore previously stored drawing depth for the depth stack. More...
virtual wxSize	GetNativePixelSize () const
wxPoint	GetNativePosition (const wxPoint &aPoint) const
	Convert the given point from client coordinates to native pixel coordinates. More...
void	SetScaleFactor (double aFactor)
	Set the canvas scale factor, probably for a hi-DPI display. More...
double	GetScaleFactor () const
	Get the current scale factor. More...

Static Public Member Functions
static wxString	CheckFeatures (GAL_DISPLAY_OPTIONS &aOptions)
	Checks OpenGL features. More...

Protected Member Functions
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...

Protected Attributes
GAL_DISPLAY_OPTIONS &	m_options
UTIL::LINK	m_observerLink
std::stack< double >	m_depthStack
	Stored depth values. More...
VECTOR2I	m_screenSize
	Screen size in screen coordinates. More...
double	m_worldUnitLength
	The unit length of the world coordinates [inch]. More...
double	m_screenDPI
	The dots per inch of the screen. More...
VECTOR2D	m_lookAtPoint
	Point to be looked at in world space. More...
double	m_zoomFactor
	The zoom factor. More...
double	m_rotation
	Rotation transformation (radians) More...
MATRIX3x3D	m_worldScreenMatrix
	World transformation. More...
MATRIX3x3D	m_screenWorldMatrix
	Screen transformation. More...
double	m_worldScale
	The scale factor world->screen. More...
bool	m_globalFlipX
	Flag for X axis flipping. More...
bool	m_globalFlipY
	Flag for Y axis flipping. More...
float	m_lineWidth
	The line width. More...
bool	m_isFillEnabled
	Is filling of graphic objects enabled ? More...
bool	m_isStrokeEnabled
	Are the outlines stroked ? More...
COLOR4D	m_fillColor
	The fill color. More...
COLOR4D	m_strokeColor
	The color of the outlines. More...
COLOR4D	m_clearColor
double	m_layerDepth
	The actual layer depth. More...
VECTOR2D	m_depthRange
	Range of the depth. More...
bool	m_gridVisibility
	Should the grid be shown. More...
GRID_STYLE	m_gridStyle
	Grid display style. More...
VECTOR2D	m_gridSize
	The grid size. More...
VECTOR2D	m_gridOrigin
	The grid origin. More...
VECTOR2D	m_gridOffset
	The grid offset to compensate cursor position. More...
COLOR4D	m_gridColor
	Color of the grid. More...
COLOR4D	m_axesColor
	Color of the axes. More...
bool	m_axesEnabled
	Should the axes be drawn. More...
int	m_gridTick
	Every tick line gets the double width. More...
float	m_gridLineWidth
	Line width of the grid. More...
int	m_gridMinSpacing
	Minimum screen size of the grid (pixels) below which the grid is not drawn. More...
bool	m_isCursorEnabled
	Is the cursor enabled? More...
bool	m_forceDisplayCursor
	Always show cursor. More...
COLOR4D	m_cursorColor
	Cursor color. More...
bool	m_fullscreenCursor
	Shape of the cursor (fullscreen or small cross) More...
VECTOR2D	m_cursorPosition
	Current cursor position (world coordinates) More...
STROKE_FONT	m_strokeFont
	Instance of object that stores information about how to draw texts. More...
KICURSOR	m_currentNativeCursor
	Current cursor. More...

Static Protected Attributes
static const int	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 Types
typedef GAL	super
	Super class definition. More...
typedef std::unordered_map< unsigned int, std::shared_ptr< VERTEX_ITEM > >	GROUPS_MAP

Private Member Functions
void	lockContext (int aClientCookie) override
	Use GAL_CONTEXT_LOCKER RAII object. More...
void	unlockContext (int aClientCookie) override
void	beginUpdate () override
void	endUpdate () override
void	beginDrawing () override
void	endDrawing () override
bool	updatedGalDisplayOptions (const GAL_DISPLAY_OPTIONS &aOptions) override
	Handle updating display options. More...
void	drawLineQuad (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
	Draw a quad for the line. More...
void	drawSemiCircle (const VECTOR2D &aCenterPoint, double aRadius, double aAngle)
	Draw a semicircle. More...
void	drawFilledSemiCircle (const VECTOR2D &aCenterPoint, double aRadius, double aAngle)
	Draw a filled semicircle. More...
void	drawStrokedSemiCircle (const VECTOR2D &aCenterPoint, double aRadius, double aAngle)
	Draw a stroked semicircle. More...
void	drawPolyline (const std::function< VECTOR2D(int)> &aPointGetter, int aPointCount)
	Generic way of drawing a polyline stored in different containers. More...
void	drawPolygon (GLdouble *aPoints, int aPointCount)
	Draw a filled polygon. More...
void	drawTriangulatedPolyset (const SHAPE_POLY_SET &aPoly, bool aStrokeTriangulation)
	Draw a set of polygons with a cached triangulation. More...
int	drawBitmapChar (unsigned long aChar)
	Draw a single character using bitmap font. More...
void	drawBitmapOverbar (double aLength, double aHeight)
	Draw an overbar over the currently drawn text. More...
std::pair< VECTOR2D, float >	computeBitmapTextSize (const UTF8 &aText) const
	Compute a size of text drawn using bitmap font with current text setting applied. More...
void	onPaint (wxPaintEvent &aEvent)
	This is the OnPaint event handler. More...
void	skipMouseEvent (wxMouseEvent &aEvent)
	Skip the mouse event to the parent. More...
void	onSetNativeCursor (wxSetCursorEvent &aEvent)
	Give the correct cursor image when the native widget asks for it. More...
void	blitCursor ()
	Blit cursor into the current screen. More...
unsigned int	getNewGroupNumber ()
	Return a valid key that can be used as a new group number. More...
double	calcAngleStep (double aRadius) const
	Compute the angle step when drawing arcs/circles approximated with lines. More...
double	getWorldPixelSize () const
VECTOR2D	getScreenPixelSize () const
void	init ()
	Basic OpenGL initialization and feature checks. More...

Private Attributes
wxGLContext *	m_glPrivContext
	Canvas-specific OpenGL context. More...
wxEvtHandler *	m_mouseListener
wxEvtHandler *	m_paintListener
GROUPS_MAP	m_groups
	Stores information about VBO objects (groups) More...
unsigned int	m_groupCounter
	Counter used for generating keys for groups. More...
VERTEX_MANAGER *	m_currentManager
	Currently used VERTEX_MANAGER (for storing VERTEX_ITEMs). More...
VERTEX_MANAGER *	m_cachedManager
	Container for storing cached VERTEX_ITEMs. More...
VERTEX_MANAGER *	m_nonCachedManager
	Container for storing non-cached VERTEX_ITEMs. More...
VERTEX_MANAGER *	m_overlayManager
	Container for storing overlaid VERTEX_ITEMs. More...
OPENGL_COMPOSITOR *	m_compositor
	Handles multiple rendering targets. More...
unsigned int	m_mainBuffer
	Main rendering target. More...
unsigned int	m_overlayBuffer
	Auxiliary rendering target (for menus etc.) More...
RENDER_TARGET	m_currentTarget
	Current rendering target. More...
SHADER *	m_shader
	There is only one shader used for different objects. More...
bool	m_isFramebufferInitialized
	Are the framebuffers initialized? More...
bool	m_isBitmapFontInitialized
	Is the shader set to use bitmap fonts? More...
bool	m_isInitialized
	Basic initialization flag, has to be done when the window is visible. More...
bool	m_isGrouping
	Was a group started? More...
bool	m_isContextLocked
	Used for assertion checking. More...
int	m_lockClientCookie
GLint	ufm_worldPixelSize
GLint	ufm_screenPixelSize
GLint	ufm_pixelSizeMultiplier
GLint	ufm_antialiasingOffset
wxCursor	m_currentwxCursor
	wxCursor showing the current native cursor More...
std::unique_ptr< GL_BITMAP_CACHE >	m_bitmapCache
GLUtesselator *	m_tesselator
std::deque< boost::shared_array< GLdouble > >	m_tessIntersects

Static Private Attributes
static wxGLContext *	m_glMainContext = nullptr
	Parent OpenGL context. More...
static int	m_instanceCounter = 0
	GL GAL instance counter. More...
static GLuint	g_fontTexture = 0
	Bitmap font texture handle (shared) More...
static bool	m_isBitmapFontLoaded = false
	Is the bitmap font texture loaded? More...

Detailed Description

OpenGL implementation of the Graphics Abstraction Layer.

This is a direct OpenGL-implementation and uses low-level graphics primitives like triangles and quads. The purpose is to provide a fast graphics interface, that takes advantage of modern graphics card GPUs. All methods here benefit thus from the hardware acceleration.

Definition at line 70 of file opengl_gal.h.

Member Typedef Documentation

GROUPS_MAP

typedef std::unordered_map< unsigned int, std::shared_ptr<VERTEX_ITEM> > KIGFX::OPENGL_GAL::GROUPS_MAP

private

Definition at line 315 of file opengl_gal.h.

super

typedef GAL KIGFX::OPENGL_GAL::super

private

Super class definition.

Definition at line 304 of file opengl_gal.h.

Constructor & Destructor Documentation

OPENGL_GAL()

OPENGL_GAL::OPENGL_GAL	(	GAL_DISPLAY_OPTIONS &	aDisplayOptions,
		wxWindow *	aParent,
		wxEvtHandler *	aMouseListener = nullptr,
		wxEvtHandler *	aPaintListener = nullptr,
		const wxString &	aName = wxT( "GLCanvas" )
	)

Parameters

aParent	is the wxWidgets immediate wxWindow parent of this object.
aMouseListener	is the wxEvtHandler that should receive the mouse events, this can be can be any wxWindow, but is often a wxFrame container.
aPaintListener	is the wxEvtHandler that should receive the paint event. This can be any wxWindow, but is often a derived instance of this class or a containing wxFrame. The "paint event" here is a wxCommandEvent holding EVT_GAL_REDRAW, as sent by PostPaint().
aName	is the name of this window for use by wxWindow::FindWindowByName()

Definition at line 197 of file opengl_gal.cpp.

                                                :
        GAL( aDisplayOptions ),
        HIDPI_GL_CANVAS( aParent, wxID_ANY, (int*) glAttributes, wxDefaultPosition, wxDefaultSize,
                         wxEXPAND, aName ),
        m_mouseListener( aMouseListener ),
        m_paintListener( aPaintListener ),
        m_currentManager( nullptr ),
        m_cachedManager( nullptr ),
        m_nonCachedManager( nullptr ),
        m_overlayManager( nullptr ),
        m_mainBuffer( 0 ),
        m_overlayBuffer( 0 ),
        m_isContextLocked( false ),
        m_lockClientCookie( 0 )
{
    if( m_glMainContext == nullptr )
    {
        m_glMainContext = GL_CONTEXT_MANAGER::Get().CreateCtx( this );

        m_glPrivContext = m_glMainContext;
    }
    else
    {
        m_glPrivContext = GL_CONTEXT_MANAGER::Get().CreateCtx( this, m_glMainContext );
    }

    m_shader = new SHADER();
    ++m_instanceCounter;

    m_bitmapCache = std::make_unique<GL_BITMAP_CACHE>();

    m_compositor = new OPENGL_COMPOSITOR;
    m_compositor->SetAntialiasingMode( m_options.gl_antialiasing_mode );

    // Initialize the flags
    m_isFramebufferInitialized = false;
    m_isBitmapFontInitialized = false;
    m_isInitialized = false;
    m_isGrouping = false;
    m_groupCounter = 0;

    // Connect the native cursor handler
    Connect( wxEVT_SET_CURSOR, wxSetCursorEventHandler( OPENGL_GAL::onSetNativeCursor ), nullptr,
             this );

    // Connecting the event handlers
    Connect( wxEVT_PAINT, wxPaintEventHandler( OPENGL_GAL::onPaint ) );

    // Mouse events are skipped to the parent
    Connect( wxEVT_MOTION, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
    Connect( wxEVT_LEFT_DOWN, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
    Connect( wxEVT_LEFT_UP, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
    Connect( wxEVT_LEFT_DCLICK, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
    Connect( wxEVT_MIDDLE_DOWN, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
    Connect( wxEVT_MIDDLE_UP, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
    Connect( wxEVT_MIDDLE_DCLICK, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
    Connect( wxEVT_RIGHT_DOWN, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
    Connect( wxEVT_RIGHT_UP, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
    Connect( wxEVT_RIGHT_DCLICK, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
    Connect( wxEVT_MOUSEWHEEL, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
#if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
    Connect( wxEVT_MAGNIFY, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
#endif
#if defined _WIN32 || defined _WIN64
    Connect( wxEVT_ENTER_WINDOW, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
#endif

    SetSize( aParent->GetClientSize() );
    m_screenSize = VECTOR2I( GetNativePixelSize() );

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

    // Tesselator initialization
    m_tesselator = gluNewTess();
    InitTesselatorCallbacks( m_tesselator );

    gluTessProperty( m_tesselator, GLU_TESS_WINDING_RULE, GLU_TESS_WINDING_POSITIVE );

    SetTarget( TARGET_NONCACHED );

    // Avoid uninitialized variables:
    ufm_worldPixelSize = 1;
    ufm_screenPixelSize = 1;
    ufm_pixelSizeMultiplier = 1;
    ufm_antialiasingOffset = 1;
}

References BLUE, GL_CONTEXT_MANAGER::CreateCtx(), GL_CONTEXT_MANAGER::Get(), HIDPI_GL_CANVAS::GetNativePixelSize(), KIGFX::GAL_DISPLAY_OPTIONS::gl_antialiasing_mode, InitTesselatorCallbacks(), m_bitmapCache, m_compositor, m_glMainContext, m_glPrivContext, m_groupCounter, m_instanceCounter, m_isBitmapFontInitialized, m_isFramebufferInitialized, m_isGrouping, m_isInitialized, KIGFX::GAL::m_options, KIGFX::GAL::m_screenSize, m_shader, m_tesselator, onPaint(), onSetNativeCursor(), KIGFX::OPENGL_COMPOSITOR::SetAntialiasingMode(), KIGFX::GAL::SetAxesColor(), KIGFX::GAL::SetGridColor(), SetTarget(), skipMouseEvent(), KIGFX::TARGET_NONCACHED, ufm_antialiasingOffset, ufm_pixelSizeMultiplier, ufm_screenPixelSize, and ufm_worldPixelSize.

~OPENGL_GAL()

OPENGL_GAL::~OPENGL_GAL

(

)

Definition at line 289 of file opengl_gal.cpp.

{
    GL_CONTEXT_MANAGER::Get().LockCtx( m_glPrivContext, this );

    --m_instanceCounter;
    glFlush();
    gluDeleteTess( m_tesselator );
    ClearCache();

    delete m_compositor;

    if( m_isInitialized )
    {
        delete m_cachedManager;
        delete m_nonCachedManager;
        delete m_overlayManager;
    }

    GL_CONTEXT_MANAGER::Get().UnlockCtx( m_glPrivContext );

    // If it was the main context, then it will be deleted
    // when the last OpenGL GAL instance is destroyed (a few lines below)
    if( m_glPrivContext != m_glMainContext )
        GL_CONTEXT_MANAGER::Get().DestroyCtx( m_glPrivContext );

    delete m_shader;

    // Are we destroying the last GAL instance?
    if( m_instanceCounter == 0 )
    {
        GL_CONTEXT_MANAGER::Get().LockCtx( m_glMainContext, this );

        if( m_isBitmapFontLoaded )
        {
            glDeleteTextures( 1, &g_fontTexture );
            m_isBitmapFontLoaded = false;
        }

        GL_CONTEXT_MANAGER::Get().UnlockCtx( m_glMainContext );
        GL_CONTEXT_MANAGER::Get().DestroyCtx( m_glMainContext );
        m_glMainContext = nullptr;
    }
}

References ClearCache(), GL_CONTEXT_MANAGER::DestroyCtx(), g_fontTexture, GL_CONTEXT_MANAGER::Get(), GL_CONTEXT_MANAGER::LockCtx(), m_cachedManager, m_compositor, m_glMainContext, m_glPrivContext, m_instanceCounter, m_isBitmapFontLoaded, m_isInitialized, m_nonCachedManager, m_overlayManager, m_shader, m_tesselator, and GL_CONTEXT_MANAGER::UnlockCtx().

Member Function Documentation

AdvanceDepth()

void KIGFX::GAL::AdvanceDepth ( )

inlineinherited

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

Definition at line 1056 of file graphics_abstraction_layer.h.

    {
        m_layerDepth -= 0.05;
    }

References KIGFX::GAL::m_layerDepth.

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

beginDrawing()

void OPENGL_GAL::beginDrawing ( )

overrideprivatevirtual

Reimplemented from KIGFX::GAL.

Definition at line 418 of file opengl_gal.cpp.

{
#ifdef KICAD_GAL_PROFILE
    PROF_COUNTER totalRealTime( "OPENGL_GAL::beginDrawing()", true );
#endif /* KICAD_GAL_PROFILE */

    wxASSERT_MSG( m_isContextLocked, "GAL_DRAWING_CONTEXT RAII object should have locked context. "
                                     "Calling GAL::beginDrawing() directly is not allowed." );

    wxASSERT_MSG( IsVisible(), "GAL::beginDrawing() must not be entered when GAL is not visible. "
                               "Other drawing routines will expect everything to be initialized "
                               "which will not be the case." );

    if( !m_isInitialized )
        init();

    // Set up the view port
    glMatrixMode( GL_PROJECTION );
    glLoadIdentity();

    // Create the screen transformation (Do the RH-LH conversion here)
    glOrtho( 0, (GLint) m_screenSize.x, (GLsizei) m_screenSize.y, 0,
             -m_depthRange.x, -m_depthRange.y );

    if( !m_isFramebufferInitialized )
    {
        // Prepare rendering target buffers
        m_compositor->Initialize();
        m_mainBuffer = m_compositor->CreateBuffer();
        try
        {
            m_overlayBuffer = m_compositor->CreateBuffer();
        }
        catch( const std::runtime_error& )
        {
            wxLogVerbose( "Could not create a framebuffer for overlays.\n" );
            m_overlayBuffer = 0;
        }

        m_isFramebufferInitialized = true;
    }

    m_compositor->Begin();

    // Disable 2D Textures
    glDisable( GL_TEXTURE_2D );

    glShadeModel( GL_FLAT );

    // Enable the depth buffer
    glEnable( GL_DEPTH_TEST );
    glDepthFunc( GL_LESS );

    // Setup blending, required for transparent objects
    glEnable( GL_BLEND );
    glBlendFunc( GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA );

    glMatrixMode( GL_MODELVIEW );

    // Set up the world <-> screen transformation
    ComputeWorldScreenMatrix();
    GLdouble matrixData[16] = { 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1 };
    matrixData[0] = m_worldScreenMatrix.m_data[0][0];
    matrixData[1] = m_worldScreenMatrix.m_data[1][0];
    matrixData[2] = m_worldScreenMatrix.m_data[2][0];
    matrixData[4] = m_worldScreenMatrix.m_data[0][1];
    matrixData[5] = m_worldScreenMatrix.m_data[1][1];
    matrixData[6] = m_worldScreenMatrix.m_data[2][1];
    matrixData[12] = m_worldScreenMatrix.m_data[0][2];
    matrixData[13] = m_worldScreenMatrix.m_data[1][2];
    matrixData[14] = m_worldScreenMatrix.m_data[2][2];
    glLoadMatrixd( matrixData );

    // Set defaults
    SetFillColor( m_fillColor );
    SetStrokeColor( m_strokeColor );

    // Remove all previously stored items
    m_nonCachedManager->Clear();
    m_overlayManager->Clear();

    m_cachedManager->BeginDrawing();
    m_nonCachedManager->BeginDrawing();
    m_overlayManager->BeginDrawing();

    if( !m_isBitmapFontInitialized )
    {
        // Keep bitmap font texture always bound to the second texturing unit
        const GLint FONT_TEXTURE_UNIT = 2;

        // Either load the font atlas to video memory, or simply bind it to a texture unit
        if( !m_isBitmapFontLoaded )
        {
            glActiveTexture( GL_TEXTURE0 + FONT_TEXTURE_UNIT );
            glGenTextures( 1, &g_fontTexture );
            glBindTexture( GL_TEXTURE_2D, g_fontTexture );
            glTexImage2D( GL_TEXTURE_2D, 0, GL_RGB8, font_image.width, font_image.height, 0, GL_RGB,
                          GL_UNSIGNED_BYTE, font_image.pixels );
            glTexParameteri( GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR );
            glTexParameteri( GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR );
            checkGlError( "loading bitmap font", __FILE__, __LINE__ );

            glActiveTexture( GL_TEXTURE0 );

            m_isBitmapFontLoaded = true;
        }
        else
        {
            glActiveTexture( GL_TEXTURE0 + FONT_TEXTURE_UNIT );
            glBindTexture( GL_TEXTURE_2D, g_fontTexture );
            glActiveTexture( GL_TEXTURE0 );
        }

        // Set shader parameter
        GLint ufm_fontTexture = m_shader->AddParameter( "fontTexture" );
        GLint ufm_fontTextureWidth = m_shader->AddParameter( "fontTextureWidth" );
        ufm_worldPixelSize = m_shader->AddParameter( "worldPixelSize" );
        ufm_screenPixelSize = m_shader->AddParameter( "screenPixelSize" );
        ufm_pixelSizeMultiplier = m_shader->AddParameter( "pixelSizeMultiplier" );
        ufm_antialiasingOffset = m_shader->AddParameter( "antialiasingOffset" );

        m_shader->Use();
        m_shader->SetParameter( ufm_fontTexture, (int) FONT_TEXTURE_UNIT );
        m_shader->SetParameter( ufm_fontTextureWidth, (int) font_image.width );
        m_shader->Deactivate();
        checkGlError( "setting bitmap font sampler as shader parameter", __FILE__, __LINE__ );

        m_isBitmapFontInitialized = true;
    }

    m_shader->Use();
    m_shader->SetParameter( ufm_worldPixelSize,
                            (float) ( getWorldPixelSize() / GetScaleFactor() ) );
    const VECTOR2D& screenPixelSize = getScreenPixelSize();
    m_shader->SetParameter( ufm_screenPixelSize, screenPixelSize );
    double pixelSizeMultiplier = m_compositor->GetAntialiasSupersamplingFactor();
    m_shader->SetParameter( ufm_pixelSizeMultiplier, (float) pixelSizeMultiplier );
    VECTOR2D renderingOffset = m_compositor->GetAntialiasRenderingOffset();
    renderingOffset.x *= screenPixelSize.x;
    renderingOffset.y *= screenPixelSize.y;
    m_shader->SetParameter( ufm_antialiasingOffset, renderingOffset );
    m_shader->Deactivate();

    // Something betreen BeginDrawing and EndDrawing seems to depend on
    // this texture unit being active, but it does not assure it itself.
    glActiveTexture( GL_TEXTURE0 );

    // Unbind buffers - set compositor for direct drawing
    m_compositor->SetBuffer( OPENGL_COMPOSITOR::DIRECT_RENDERING );

#ifdef KICAD_GAL_PROFILE
    totalRealTime.Stop();
    wxLogTrace( traceGalProfile, wxT( "OPENGL_GAL::beginDrawing(): %.1f ms" ),
                totalRealTime.msecs() );
#endif /* KICAD_GAL_PROFILE */
}

References KIGFX::SHADER::AddParameter(), KIGFX::OPENGL_COMPOSITOR::Begin(), KIGFX::VERTEX_MANAGER::BeginDrawing(), checkGlError(), KIGFX::VERTEX_MANAGER::Clear(), ComputeWorldScreenMatrix(), KIGFX::OPENGL_COMPOSITOR::CreateBuffer(), KIGFX::SHADER::Deactivate(), KIGFX::OPENGL_COMPOSITOR::DIRECT_RENDERING, KIGFX::BUILTIN_FONT::font_image, g_fontTexture, KIGFX::OPENGL_COMPOSITOR::GetAntialiasRenderingOffset(), KIGFX::OPENGL_COMPOSITOR::GetAntialiasSupersamplingFactor(), HIDPI_GL_CANVAS::GetScaleFactor(), getScreenPixelSize(), getWorldPixelSize(), KIGFX::BUILTIN_FONT::FONT_IMAGE_TYPE::height, init(), KIGFX::OPENGL_COMPOSITOR::Initialize(), IsVisible(), m_cachedManager, m_compositor, MATRIX3x3< T >::m_data, KIGFX::GAL::m_depthRange, KIGFX::GAL::m_fillColor, m_isBitmapFontInitialized, m_isBitmapFontLoaded, m_isContextLocked, m_isFramebufferInitialized, m_isInitialized, m_mainBuffer, m_nonCachedManager, m_overlayBuffer, m_overlayManager, KIGFX::GAL::m_screenSize, m_shader, KIGFX::GAL::m_strokeColor, KIGFX::GAL::m_worldScreenMatrix, PROF_COUNTER::msecs(), KIGFX::BUILTIN_FONT::FONT_IMAGE_TYPE::pixels, KIGFX::OPENGL_COMPOSITOR::SetBuffer(), KIGFX::GAL::SetFillColor(), KIGFX::SHADER::SetParameter(), KIGFX::GAL::SetStrokeColor(), PROF_COUNTER::Stop(), traceGalProfile, ufm_antialiasingOffset, ufm_pixelSizeMultiplier, ufm_screenPixelSize, ufm_worldPixelSize, KIGFX::SHADER::Use(), KIGFX::BUILTIN_FONT::FONT_IMAGE_TYPE::width, VECTOR2< T >::x, and VECTOR2< T >::y.

BeginGroup()

int OPENGL_GAL::BeginGroup ( )

overridevirtual

Begin a group.

A group is a collection of graphic items. Hierarchical groups are possible, attributes and transformations can be used.

Returns

the number of the group.

Reimplemented from KIGFX::GAL.

Definition at line 1621 of file opengl_gal.cpp.

{
    m_isGrouping = true;

    std::shared_ptr<VERTEX_ITEM> newItem = std::make_shared<VERTEX_ITEM>( *m_cachedManager );
    int                          groupNumber = getNewGroupNumber();
    m_groups.insert( std::make_pair( groupNumber, newItem ) );

    return groupNumber;
}

References getNewGroupNumber(), m_cachedManager, m_groups, and m_isGrouping.

beginUpdate()

void OPENGL_GAL::beginUpdate ( )

overrideprivatevirtual

Reimplemented from KIGFX::GAL.

Definition at line 641 of file opengl_gal.cpp.

{
    wxASSERT_MSG( m_isContextLocked, "GAL_UPDATE_CONTEXT RAII object should have locked context. "
                                     "Calling this from anywhere else is not allowed." );

    wxASSERT_MSG( IsVisible(), "GAL::beginUpdate() must not be entered when GAL is not visible. "
                               "Other update routines will expect everything to be initialized "
                               "which will not be the case." );

    if( !m_isInitialized )
        init();

    m_cachedManager->Map();
}

References init(), IsVisible(), m_cachedManager, m_isContextLocked, m_isInitialized, and KIGFX::VERTEX_MANAGER::Map().

BitmapText()

void OPENGL_GAL::BitmapText ( const wxString &  aText, const VECTOR2D &  aPosition, double  aRotationAngle  )

overridevirtual

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

Definition at line 1257 of file opengl_gal.cpp.

{
    // Fallback to generic impl (which uses the stroke font) on cases we don't handle
    if( IsTextMirrored() || aText.Contains( wxT( "^{" ) ) || aText.Contains( wxT( "_{" ) ) )
        return GAL::BitmapText( aText, aPosition, aRotationAngle );

    const UTF8   text( aText );
    VECTOR2D     textSize;
    float        commonOffset;
    std::tie( textSize, commonOffset ) = computeBitmapTextSize( text );

    const double SCALE = 1.4 * GetGlyphSize().y / textSize.y;
    int          overbarLength = 0;
    double       overbarHeight = textSize.y;

    Save();

    m_currentManager->Color( m_strokeColor.r, m_strokeColor.g, m_strokeColor.b, m_strokeColor.a );
    m_currentManager->Translate( aPosition.x, aPosition.y, m_layerDepth );
    m_currentManager->Rotate( aRotationAngle, 0.0f, 0.0f, -1.0f );

    double sx = SCALE * ( m_globalFlipX ? -1.0 : 1.0 );
    double sy = SCALE * ( m_globalFlipY ? -1.0 : 1.0 );

    m_currentManager->Scale( sx, sy, 0 );
    m_currentManager->Translate( 0, -commonOffset, 0 );

    switch( GetHorizontalJustify() )
    {
    case GR_TEXT_HJUSTIFY_CENTER:
        Translate( VECTOR2D( -textSize.x / 2.0, 0 ) );
        break;

    case GR_TEXT_HJUSTIFY_RIGHT:
        //if( !IsTextMirrored() )
        Translate( VECTOR2D( -textSize.x, 0 ) );
        break;

    case GR_TEXT_HJUSTIFY_LEFT:
        //if( IsTextMirrored() )
        //Translate( VECTOR2D( -textSize.x, 0 ) );
        break;
    }

    switch( GetVerticalJustify() )
    {
    case GR_TEXT_VJUSTIFY_TOP:
        Translate( VECTOR2D( 0, -textSize.y ) );
        overbarHeight = -textSize.y / 2.0;
        break;

    case GR_TEXT_VJUSTIFY_CENTER:
        Translate( VECTOR2D( 0, -textSize.y / 2.0 ) );
        overbarHeight = 0;
        break;

    case GR_TEXT_VJUSTIFY_BOTTOM:
        break;
    }

    int overbarDepth = -1;
    int braceNesting = 0;

    for( UTF8::uni_iter chIt = text.ubegin(), end = text.uend(); chIt < end; ++chIt )
    {
        wxASSERT_MSG( *chIt != '\n' && *chIt != '\r',
                wxT( "No support for multiline bitmap text yet" ) );

        if( *chIt == '~' && overbarDepth == -1 )
        {
            UTF8::uni_iter lookahead = chIt;

            if( ++lookahead != end && *lookahead == '{' )
            {
                chIt = lookahead;
                overbarDepth = braceNesting;
                braceNesting++;
                continue;
            }
        }
        else if( *chIt == '{' )
        {
            braceNesting++;
        }
        else if( *chIt == '}' )
        {
            if( braceNesting > 0 )
                braceNesting--;

            if( braceNesting == overbarDepth )
            {
                drawBitmapOverbar( overbarLength, overbarHeight );
                overbarLength = 0;

                overbarDepth = -1;
                continue;
            }
        }

        if( overbarDepth != -1 )
            overbarLength += drawBitmapChar( *chIt );
        else
            drawBitmapChar( *chIt );
    }

    // Handle the case when overbar is active till the end of the drawn text
    m_currentManager->Translate( 0, commonOffset, 0 );

    if( overbarDepth != -1 && overbarLength > 0 )
        drawBitmapOverbar( overbarLength, overbarHeight );

    Restore();
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::GAL::BitmapText(), KIGFX::VERTEX_MANAGER::Color(), computeBitmapTextSize(), drawBitmapChar(), drawBitmapOverbar(), KIGFX::COLOR4D::g, KIGFX::GAL::GetGlyphSize(), KIGFX::GAL::GetHorizontalJustify(), KIGFX::GAL::GetVerticalJustify(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, KIGFX::GAL::IsTextMirrored(), m_currentManager, KIGFX::GAL::m_globalFlipX, KIGFX::GAL::m_globalFlipY, KIGFX::GAL::m_layerDepth, KIGFX::GAL::m_strokeColor, KIGFX::COLOR4D::r, Restore(), KIGFX::VERTEX_MANAGER::Rotate(), Save(), KIGFX::VERTEX_MANAGER::Scale(), text, Translate(), KIGFX::VERTEX_MANAGER::Translate(), VECTOR2< T >::x, and VECTOR2< T >::y.

blitCursor()

void OPENGL_GAL::blitCursor ( )

private

Blit cursor into the current screen.

Definition at line 2157 of file opengl_gal.cpp.

{
    if( !IsCursorEnabled() )
        return;

    m_compositor->SetBuffer( OPENGL_COMPOSITOR::DIRECT_RENDERING );

    const int cursorSize = m_fullscreenCursor ? 8000 : 80;

    VECTOR2D cursorBegin = m_cursorPosition - cursorSize / ( 2 * m_worldScale );
    VECTOR2D cursorEnd = m_cursorPosition + cursorSize / ( 2 * m_worldScale );
    VECTOR2D cursorCenter = ( cursorBegin + cursorEnd ) / 2;

    const COLOR4D cColor = getCursorColor();
    const COLOR4D color( cColor.r * cColor.a, cColor.g * cColor.a, cColor.b * cColor.a, 1.0 );

    glActiveTexture( GL_TEXTURE0 );
    glDisable( GL_TEXTURE_2D );
    glLineWidth( 1.0 );
    glColor4d( color.r, color.g, color.b, color.a );

    glBegin( GL_LINES );
    glVertex2d( cursorCenter.x, cursorBegin.y );
    glVertex2d( cursorCenter.x, cursorEnd.y );

    glVertex2d( cursorBegin.x, cursorCenter.y );
    glVertex2d( cursorEnd.x, cursorCenter.y );
    glEnd();
}

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

Referenced by endDrawing().

calcAngleStep()

double KIGFX::OPENGL_GAL::calcAngleStep ( double  aRadius ) const

inlineprivate

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

Definition at line 511 of file opengl_gal.h.

    {
        // Bigger arcs need smaller alpha increment to make them look smooth
        return std::min( 1e6 / aRadius, 2.0 * M_PI / SEG_PER_CIRCLE_COUNT );
    }

References SEG_PER_CIRCLE_COUNT.

Referenced by DrawArc().

ChangeGroupColor()

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

overridevirtual

Change the color used to draw the group.

Parameters

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

Reimplemented from KIGFX::GAL.

Definition at line 1649 of file opengl_gal.cpp.

{
    auto group = m_groups.find( aGroupNumber );

    if( group != m_groups.end() )
        m_cachedManager->ChangeItemColor( *group->second, aNewColor );
}

References KIGFX::VERTEX_MANAGER::ChangeItemColor(), group, m_cachedManager, and m_groups.

ChangeGroupDepth()

void OPENGL_GAL::ChangeGroupDepth ( int  aGroupNumber, int  aDepth  )

overridevirtual

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

Parameters

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

Reimplemented from KIGFX::GAL.

Definition at line 1658 of file opengl_gal.cpp.

{
    auto group = m_groups.find( aGroupNumber );

    if( group != m_groups.end() )
        m_cachedManager->ChangeItemDepth( *group->second, aDepth );
}

References KIGFX::VERTEX_MANAGER::ChangeItemDepth(), group, m_cachedManager, and m_groups.

CheckFeatures()

wxString OPENGL_GAL::CheckFeatures ( GAL_DISPLAY_OPTIONS &  aOptions )

static

Checks OpenGL features.

Parameters

aOptions

Returns

wxEmptyString if OpenGL 2.1 or greater is available, otherwise returns error message

Definition at line 334 of file opengl_gal.cpp.

{
    wxString retVal = wxEmptyString;

    wxFrame* testFrame = new wxFrame( nullptr, wxID_ANY, wxT( "" ), wxDefaultPosition,
                                      wxSize( 1, 1 ), wxFRAME_TOOL_WINDOW | wxNO_BORDER );

    KIGFX::OPENGL_GAL* opengl_gal = nullptr;

    try
    {
        opengl_gal = new KIGFX::OPENGL_GAL( aOptions, testFrame );

        testFrame->Raise();
        testFrame->Show();

        GAL_CONTEXT_LOCKER lock( opengl_gal );
        opengl_gal->init();
    }
    catch( std::runtime_error& err )
    {
        //Test failed
        retVal = wxString( err.what() );
    }

    delete opengl_gal;
    delete testFrame;

    return retVal;
}

References init().

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

ClearCache()

void OPENGL_GAL::ClearCache ( )

overridevirtual

Delete all data created during caching of graphic items.

Reimplemented from KIGFX::GAL.

Definition at line 1674 of file opengl_gal.cpp.

{
    m_bitmapCache = std::make_unique<GL_BITMAP_CACHE>();

    m_groups.clear();

    if( m_isInitialized )
        m_cachedManager->Clear();
}

References KIGFX::VERTEX_MANAGER::Clear(), m_bitmapCache, m_cachedManager, m_groups, and m_isInitialized.

Referenced by ~OPENGL_GAL().

ClearScreen()

void OPENGL_GAL::ClearScreen ( )

overridevirtual

Clear the screen.

Parameters

aColor

is the color used for clearing.

Reimplemented from KIGFX::GAL.

Definition at line 1562 of file opengl_gal.cpp.

{
    // Clear screen
    m_compositor->SetBuffer( OPENGL_COMPOSITOR::DIRECT_RENDERING );

    // NOTE: Black used here instead of m_clearColor; it will be composited later
    glClearColor( 0, 0, 0, 1 );
    glClear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT );
}

References KIGFX::OPENGL_COMPOSITOR::DIRECT_RENDERING, m_compositor, and KIGFX::OPENGL_COMPOSITOR::SetBuffer().

ClearTarget()

void OPENGL_GAL::ClearTarget ( RENDER_TARGET  aTarget )

overridevirtual

Clear the target for rendering.

Parameters

aTarget

is the target to be cleared.

Reimplemented from KIGFX::GAL.

Definition at line 1705 of file opengl_gal.cpp.

{
    // Save the current state
    unsigned int oldTarget = m_compositor->GetBuffer();

    switch( aTarget )
    {
    // Cached and noncached items are rendered to the same buffer
    default:
    case TARGET_CACHED:
    case TARGET_NONCACHED:
        m_compositor->SetBuffer( m_mainBuffer );
        break;

    case TARGET_OVERLAY:
        if( m_overlayBuffer )
            m_compositor->SetBuffer( m_overlayBuffer );
        break;
    }

    if( aTarget != TARGET_OVERLAY )
        m_compositor->ClearBuffer( m_clearColor );
    else if( m_overlayBuffer )
        m_compositor->ClearBuffer( COLOR4D::BLACK );

    // Restore the previous state
    m_compositor->SetBuffer( oldTarget );
}

References KIGFX::COLOR4D::BLACK, KIGFX::OPENGL_COMPOSITOR::ClearBuffer(), KIGFX::OPENGL_COMPOSITOR::GetBuffer(), KIGFX::GAL::m_clearColor, m_compositor, m_mainBuffer, m_overlayBuffer, KIGFX::OPENGL_COMPOSITOR::SetBuffer(), KIGFX::TARGET_CACHED, KIGFX::TARGET_NONCACHED, and KIGFX::TARGET_OVERLAY.

computeBitmapTextSize()

std::pair< VECTOR2D, float > OPENGL_GAL::computeBitmapTextSize ( const UTF8 &  aText ) const

private

Compute a size of text drawn using bitmap font with current text setting applied.

Parameters

aText

is the text to be drawn.

Returns

Pair containing text bounding box and common Y axis offset. The values are expressed as a number of pixels on the bitmap font texture and need to be scaled before drawing.

Definition at line 2083 of file opengl_gal.cpp.

{
    static const FONT_GLYPH_TYPE* defaultGlyph = LookupGlyph( '(' ); // for strange chars

    VECTOR2D textSize( 0, 0 );
    float    commonOffset = std::numeric_limits<float>::max();
    float    charHeight = font_information.max_y - defaultGlyph->miny;
    int      overbarDepth = -1;
    int braceNesting = 0;

    for( UTF8::uni_iter chIt = aText.ubegin(), end = aText.uend(); chIt < end; ++chIt )
    {
        if( *chIt == '~' && overbarDepth == -1 )
        {
            UTF8::uni_iter lookahead = chIt;

            if( ++lookahead != end && *lookahead == '{' )
            {
                chIt = lookahead;
                overbarDepth = braceNesting;
                braceNesting++;
                continue;
            }
        }
        else if( *chIt == '{' )
        {
            braceNesting++;
        }
        else if( *chIt == '}' )
        {
            if( braceNesting > 0 )
                braceNesting--;

            if( braceNesting == overbarDepth )
            {
                overbarDepth = -1;
                continue;
            }
        }

        const FONT_GLYPH_TYPE* glyph = LookupGlyph( *chIt );

        if( !glyph                            // Not coded in font
            || *chIt == '-' || *chIt == '_' ) // Strange size of these 2 chars
        {
            glyph = defaultGlyph;
        }

        if( glyph )
            textSize.x += glyph->advance;
    }

    textSize.y = std::max<float>( textSize.y, charHeight );
    commonOffset = std::min<float>( font_information.max_y - defaultGlyph->maxy, commonOffset );
    textSize.y -= commonOffset;

    return std::make_pair( textSize, commonOffset );
}

References KIGFX::BUILTIN_FONT::FONT_GLYPH_TYPE::advance, KIGFX::BUILTIN_FONT::font_information, KIGFX::BUILTIN_FONT::LookupGlyph(), KIGFX::BUILTIN_FONT::FONT_INFO_TYPE::max_y, KIGFX::BUILTIN_FONT::FONT_GLYPH_TYPE::maxy, KIGFX::BUILTIN_FONT::FONT_GLYPH_TYPE::miny, UTF8::ubegin(), UTF8::uend(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BitmapText().

computeMinGridSpacing()

double GAL::computeMinGridSpacing ( ) const

protectedinherited

compute minimum grid spacing from the grid settings

Returns

the minimum spacing to use for drawing the grid

Definition at line 237 of file graphics_abstraction_layer.cpp.

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

References KIGFX::GAL::m_gridMinSpacing.

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

computeWorldScale()

void KIGFX::GAL::computeWorldScale ( )

inlineprotectedinherited

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

Definition at line 1111 of file graphics_abstraction_layer.h.

    {
        m_worldScale = m_screenDPI * m_worldUnitLength * m_zoomFactor;
    }

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

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

ComputeWorldScreenMatrix()

void OPENGL_GAL::ComputeWorldScreenMatrix ( )

overridevirtual

Compute the world <-> screen transformation matrix.

Reimplemented from KIGFX::GAL.

Definition at line 2356 of file opengl_gal.cpp.

{
    computeWorldScale();
    auto pixelSize = m_worldScale;

    // we need -m_lookAtPoint == -k * pixelSize + 0.5 * pixelSize for OpenGL
    // meaning m_lookAtPoint = (k-0.5)*pixelSize with integer k
    m_lookAtPoint.x = round_to_half_pixel( m_lookAtPoint.x, pixelSize );
    m_lookAtPoint.y = round_to_half_pixel( m_lookAtPoint.y, pixelSize );

    GAL::ComputeWorldScreenMatrix();
}

References KIGFX::GAL::computeWorldScale(), KIGFX::GAL::ComputeWorldScreenMatrix(), KIGFX::GAL::m_lookAtPoint, KIGFX::GAL::m_worldScale, round_to_half_pixel(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by beginDrawing().

DeleteGroup()

void OPENGL_GAL::DeleteGroup ( int  aGroupNumber )

overridevirtual

Delete the group from the memory.

Parameters

aGroupNumber

is the group number.

Reimplemented from KIGFX::GAL.

Definition at line 1667 of file opengl_gal.cpp.

{
    // Frees memory in the container as well
    m_groups.erase( aGroupNumber );
}

References m_groups.

DrawArc()

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

overridevirtual

Draw an arc.

Parameters

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

Reimplemented from KIGFX::GAL.

Definition at line 785 of file opengl_gal.cpp.

{
    if( aRadius <= 0 )
        return;

    // Swap the angles, if start angle is greater than end angle
    SWAP( aStartAngle, >, aEndAngle );

    const double alphaIncrement = calcAngleStep( aRadius );

    Save();
    m_currentManager->Translate( aCenterPoint.x, aCenterPoint.y, 0.0 );

    if( m_isFillEnabled )
    {
        double alpha;
        m_currentManager->Color( m_fillColor.r, m_fillColor.g, m_fillColor.b, m_fillColor.a );
        m_currentManager->Shader( SHADER_NONE );

        // Triangle fan
        for( alpha = aStartAngle; ( alpha + alphaIncrement ) < aEndAngle; )
        {
            m_currentManager->Reserve( 3 );
            m_currentManager->Vertex( 0.0, 0.0, m_layerDepth );
            m_currentManager->Vertex( cos( alpha ) * aRadius, sin( alpha ) * aRadius,
                                      m_layerDepth );
            alpha += alphaIncrement;
            m_currentManager->Vertex( cos( alpha ) * aRadius, sin( alpha ) * aRadius,
                                      m_layerDepth );
        }

        // The last missing triangle
        const VECTOR2D endPoint( cos( aEndAngle ) * aRadius, sin( aEndAngle ) * aRadius );

        m_currentManager->Reserve( 3 );
        m_currentManager->Vertex( 0.0, 0.0, m_layerDepth );
        m_currentManager->Vertex( cos( alpha ) * aRadius, sin( alpha ) * aRadius, m_layerDepth );
        m_currentManager->Vertex( endPoint.x, endPoint.y, m_layerDepth );
    }

    if( m_isStrokeEnabled )
    {
        m_currentManager->Color( m_strokeColor.r, m_strokeColor.g, m_strokeColor.b,
                                 m_strokeColor.a );

        VECTOR2D p( cos( aStartAngle ) * aRadius, sin( aStartAngle ) * aRadius );
        double   alpha;

        for( alpha = aStartAngle + alphaIncrement; alpha <= aEndAngle; alpha += alphaIncrement )
        {
            VECTOR2D p_next( cos( alpha ) * aRadius, sin( alpha ) * aRadius );
            DrawLine( p, p_next );

            p = p_next;
        }

        // Draw the last missing part
        if( alpha != aEndAngle )
        {
            VECTOR2D p_last( cos( aEndAngle ) * aRadius, sin( aEndAngle ) * aRadius );
            DrawLine( p, p_last );
        }
    }

    Restore();
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, calcAngleStep(), KIGFX::VERTEX_MANAGER::Color(), DrawLine(), KIGFX::COLOR4D::g, m_currentManager, KIGFX::GAL::m_fillColor, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_isStrokeEnabled, KIGFX::GAL::m_layerDepth, KIGFX::GAL::m_strokeColor, KIGFX::COLOR4D::r, KIGFX::VERTEX_MANAGER::Reserve(), Restore(), Save(), KIGFX::VERTEX_MANAGER::Shader(), KIGFX::SHADER_NONE, SWAP, KIGFX::VERTEX_MANAGER::Translate(), KIGFX::VERTEX_MANAGER::Vertex(), VECTOR2< T >::x, and VECTOR2< T >::y.

DrawArcSegment()

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

overridevirtual

Draw an arc segment.

This method differs from DrawArc() in what happens when fill/stroke are on or off. DrawArc() draws a "pie piece" when fill is turned on, and a thick stroke when fill is off. DrawArcSegment() with fill on behaves like DrawArc() with fill off. DrawArcSegment() with fill off draws the outline of what it would have drawn with fill on.

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).
aMaxError	is the max allowed error to create segments to approximate a circle. It has meaning only for back ends that can't draw a true arc, and use segments to approximate.

Reimplemented from KIGFX::GAL.

Definition at line 854 of file opengl_gal.cpp.

{
    if( aRadius <= 0 )
    {
        // Arcs of zero radius are a circle of aWidth diameter
        if( aWidth > 0 )
            DrawCircle( aCenterPoint, aWidth / 2.0 );

        return;
    }

    // Swap the angles, if start angle is greater than end angle
    SWAP( aStartAngle, >, aEndAngle );

    // Calculate the seg count to approximate the arc with aMaxError or less
    int segCount360 = GetArcToSegmentCount( aRadius, aMaxError, 360.0 );
    segCount360 = std::max( SEG_PER_CIRCLE_COUNT, segCount360 );
    double alphaIncrement = 2.0 * M_PI / segCount360;

    // Refinement: Use a segment count multiple of 2, because we have a control point
    // on the middle of the arc, and the look is better if it is on a segment junction
    // because there is no approx error
    int seg_count = KiROUND( ( aEndAngle - aStartAngle ) / alphaIncrement );

    if( seg_count % 2 != 0 )
        seg_count += 1;

    // Recalculate alphaIncrement with a even integer number of segment
    if( seg_count )
        alphaIncrement = ( aEndAngle - aStartAngle ) / seg_count;

    Save();
    m_currentManager->Translate( aCenterPoint.x, aCenterPoint.y, 0.0 );

    if( m_isStrokeEnabled )
    {
        m_currentManager->Color( m_strokeColor.r, m_strokeColor.g, m_strokeColor.b,
                                 m_strokeColor.a );

        double   width = aWidth / 2.0;
        VECTOR2D startPoint( cos( aStartAngle ) * aRadius, sin( aStartAngle ) * aRadius );
        VECTOR2D endPoint( cos( aEndAngle ) * aRadius, sin( aEndAngle ) * aRadius );

        drawStrokedSemiCircle( startPoint, width, aStartAngle + M_PI );
        drawStrokedSemiCircle( endPoint, width, aEndAngle );

        VECTOR2D pOuter( cos( aStartAngle ) * ( aRadius + width ),
                         sin( aStartAngle ) * ( aRadius + width ) );

        VECTOR2D pInner( cos( aStartAngle ) * ( aRadius - width ),
                         sin( aStartAngle ) * ( aRadius - width ) );

        double alpha;

        for( alpha = aStartAngle + alphaIncrement; alpha <= aEndAngle; alpha += alphaIncrement )
        {
            VECTOR2D pNextOuter( cos( alpha ) * ( aRadius + width ),
                                 sin( alpha ) * ( aRadius + width ) );
            VECTOR2D pNextInner( cos( alpha ) * ( aRadius - width ),
                                 sin( alpha ) * ( aRadius - width ) );

            DrawLine( pOuter, pNextOuter );
            DrawLine( pInner, pNextInner );

            pOuter = pNextOuter;
            pInner = pNextInner;
        }

        // Draw the last missing part
        if( alpha != aEndAngle )
        {
            VECTOR2D pLastOuter( cos( aEndAngle ) * ( aRadius + width ),
                                 sin( aEndAngle ) * ( aRadius + width ) );
            VECTOR2D pLastInner( cos( aEndAngle ) * ( aRadius - width ),
                                 sin( aEndAngle ) * ( aRadius - width ) );

            DrawLine( pOuter, pLastOuter );
            DrawLine( pInner, pLastInner );
        }
    }

    if( m_isFillEnabled )
    {
        m_currentManager->Color( m_fillColor.r, m_fillColor.g, m_fillColor.b, m_fillColor.a );
        SetLineWidth( aWidth );

        VECTOR2D p( cos( aStartAngle ) * aRadius, sin( aStartAngle ) * aRadius );
        double   alpha;

        for( alpha = aStartAngle + alphaIncrement; alpha <= aEndAngle; alpha += alphaIncrement )
        {
            VECTOR2D p_next( cos( alpha ) * aRadius, sin( alpha ) * aRadius );
            DrawLine( p, p_next );

            p = p_next;
        }

        // Draw the last missing part
        if( alpha != aEndAngle )
        {
            VECTOR2D p_last( cos( aEndAngle ) * aRadius, sin( aEndAngle ) * aRadius );
            DrawLine( p, p_last );
        }
    }

    Restore();
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::VERTEX_MANAGER::Color(), DrawCircle(), DrawLine(), drawStrokedSemiCircle(), KIGFX::COLOR4D::g, GetArcToSegmentCount(), KiROUND(), m_currentManager, KIGFX::GAL::m_fillColor, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_isStrokeEnabled, KIGFX::GAL::m_strokeColor, KIGFX::COLOR4D::r, Restore(), Save(), SEG_PER_CIRCLE_COUNT, KIGFX::GAL::SetLineWidth(), SWAP, KIGFX::VERTEX_MANAGER::Translate(), VECTOR2< T >::x, and VECTOR2< T >::y.

DrawBitmap()

void OPENGL_GAL::DrawBitmap ( const BITMAP_BASE &  aBitmap )

overridevirtual

Draw a bitmap image.

Reimplemented from KIGFX::GAL.

Definition at line 1202 of file opengl_gal.cpp.

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

    auto xform = m_currentManager->GetTransformation();

    glm::vec4 v0 = xform * glm::vec4( -w / 2, -h / 2, 0.0, 0.0 );
    glm::vec4 v1 = xform * glm::vec4( w / 2, h / 2, 0.0, 0.0 );
    glm::vec4 trans = xform[3];

    auto texture_id = m_bitmapCache->RequestBitmap( &aBitmap );

    if( !glIsTexture( texture_id ) ) // ensure the bitmap texture is still valid
        return;

    auto oldTarget = GetTarget();

    glPushMatrix();
    glTranslated( trans.x, trans.y, trans.z );

    SetTarget( TARGET_NONCACHED );
    glEnable( GL_TEXTURE_2D );
    glActiveTexture( GL_TEXTURE0 );
    glBindTexture( GL_TEXTURE_2D, texture_id );

    glBegin( GL_QUADS );
    glColor4f( 1.0, 1.0, 1.0, 1.0 );
    glTexCoord2f( 0.0, 0.0 );
    glVertex3f( v0.x, v0.y, m_layerDepth );
    glColor4f( 1.0, 1.0, 1.0, 1.0 );
    glTexCoord2f( 1.0, 0.0 );
    glVertex3f( v1.x, v0.y, m_layerDepth );
    glColor4f( 1.0, 1.0, 1.0, 1.0 );
    glTexCoord2f( 1.0, 1.0 );
    glVertex3f( v1.x, v1.y, m_layerDepth );
    glColor4f( 1.0, 1.0, 1.0, 1.0 );
    glTexCoord2f( 0.0, 1.0 );
    glVertex3f( v0.x, v1.y, m_layerDepth );
    glEnd();

    SetTarget( oldTarget );
    glBindTexture( GL_TEXTURE_2D, 0 );

#ifdef DISABLE_BITMAP_CACHE
    glDeleteTextures( 1, &texture_id );
#endif

    glPopMatrix();
}

References BITMAP_BASE::GetPPI(), BITMAP_BASE::GetSizePixels(), GetTarget(), KIGFX::VERTEX_MANAGER::GetTransformation(), m_bitmapCache, m_currentManager, KIGFX::GAL::m_layerDepth, KIGFX::GAL::m_worldUnitLength, scale, SetTarget(), and KIGFX::TARGET_NONCACHED.

drawBitmapChar()

int OPENGL_GAL::drawBitmapChar ( unsigned long  aChar )

private

Draw a single character using bitmap font.

Its main purpose is to be used in BitmapText() function.

Parameters

aChar

is the character to be drawn.

Returns

Width of the drawn glyph.

Definition at line 1977 of file opengl_gal.cpp.

{
    const float TEX_X = font_image.width;
    const float TEX_Y = font_image.height;

    // handle space
    if( aChar == ' ' )
    {
        const FONT_GLYPH_TYPE* g = LookupGlyph( 'x' );
        wxASSERT( g );

        if( !g ) // Should not happen.
            return 0;

        Translate( VECTOR2D( g->advance, 0 ) );
        return g->advance;
    }

    const FONT_GLYPH_TYPE* glyph = LookupGlyph( aChar );

    // If the glyph is not found (happens for many esoteric unicode chars)
    // shows a '?' instead.
    if( !glyph )
        glyph = LookupGlyph( '?' );

    if( !glyph ) // Should not happen.
        return 0;

    const float X = glyph->atlas_x + font_information.smooth_pixels;
    const float Y = glyph->atlas_y + font_information.smooth_pixels;
    const float XOFF = glyph->minx;

    // adjust for height rounding
    const float round_adjust = ( glyph->maxy - glyph->miny )
                               - float( glyph->atlas_h - font_information.smooth_pixels * 2 );
    const float top_adjust = font_information.max_y - glyph->maxy;
    const float YOFF = round_adjust + top_adjust;
    const float W = glyph->atlas_w - font_information.smooth_pixels * 2;
    const float H = glyph->atlas_h - font_information.smooth_pixels * 2;
    const float B = 0;

    m_currentManager->Reserve( 6 );
    Translate( VECTOR2D( XOFF, YOFF ) );

    /* Glyph:
     * v0    v1
     *   +--+
     *   | /|
     *   |/ |
     *   +--+
     * v2    v3
     */
    m_currentManager->Shader( SHADER_FONT, X / TEX_X, ( Y + H ) / TEX_Y );
    m_currentManager->Vertex( -B, -B, 0 ); // v0

    m_currentManager->Shader( SHADER_FONT, ( X + W ) / TEX_X, ( Y + H ) / TEX_Y );
    m_currentManager->Vertex( W + B, -B, 0 ); // v1

    m_currentManager->Shader( SHADER_FONT, X / TEX_X, Y / TEX_Y );
    m_currentManager->Vertex( -B, H + B, 0 ); // v2


    m_currentManager->Shader( SHADER_FONT, ( X + W ) / TEX_X, ( Y + H ) / TEX_Y );
    m_currentManager->Vertex( W + B, -B, 0 ); // v1

    m_currentManager->Shader( SHADER_FONT, X / TEX_X, Y / TEX_Y );
    m_currentManager->Vertex( -B, H + B, 0 ); // v2

    m_currentManager->Shader( SHADER_FONT, ( X + W ) / TEX_X, Y / TEX_Y );
    m_currentManager->Vertex( W + B, H + B, 0 ); // v3

    Translate( VECTOR2D( -XOFF + glyph->advance, -YOFF ) );

    return glyph->advance;
}

References KIGFX::BUILTIN_FONT::FONT_GLYPH_TYPE::advance, KIGFX::BUILTIN_FONT::FONT_GLYPH_TYPE::atlas_h, KIGFX::BUILTIN_FONT::FONT_GLYPH_TYPE::atlas_w, KIGFX::BUILTIN_FONT::FONT_GLYPH_TYPE::atlas_x, KIGFX::BUILTIN_FONT::FONT_GLYPH_TYPE::atlas_y, KIGFX::BUILTIN_FONT::font_image, KIGFX::BUILTIN_FONT::font_information, H, KIGFX::BUILTIN_FONT::FONT_IMAGE_TYPE::height, KIGFX::BUILTIN_FONT::LookupGlyph(), m_currentManager, KIGFX::BUILTIN_FONT::FONT_INFO_TYPE::max_y, KIGFX::BUILTIN_FONT::FONT_GLYPH_TYPE::maxy, KIGFX::BUILTIN_FONT::FONT_GLYPH_TYPE::minx, KIGFX::BUILTIN_FONT::FONT_GLYPH_TYPE::miny, KIGFX::VERTEX_MANAGER::Reserve(), KIGFX::VERTEX_MANAGER::Shader(), KIGFX::SHADER_FONT, KIGFX::BUILTIN_FONT::FONT_INFO_TYPE::smooth_pixels, Translate(), KIGFX::VERTEX_MANAGER::Vertex(), and KIGFX::BUILTIN_FONT::FONT_IMAGE_TYPE::width.

Referenced by BitmapText().

drawBitmapOverbar()

void OPENGL_GAL::drawBitmapOverbar ( double  aLength, double  aHeight  )

private

Draw an overbar over the currently drawn text.

Its main purpose is to be used in BitmapText() function. This method requires appropriate scaling to be applied (as is done in BitmapText() function). The current X coordinate will be the overbar ending.

Parameters

aLength	is the width of the overbar.
aHeight	is the height for the overbar.

Definition at line 2054 of file opengl_gal.cpp.

{
    // To draw an overbar, simply draw an overbar
    const FONT_GLYPH_TYPE* glyph = LookupGlyph( '_' );
    wxCHECK( glyph, /* void */ );

    const float H = glyph->maxy - glyph->miny;

    Save();

    Translate( VECTOR2D( -aLength, -aHeight ) );

    m_currentManager->Reserve( 6 );
    m_currentManager->Color( m_strokeColor.r, m_strokeColor.g, m_strokeColor.b, m_strokeColor.a );

    m_currentManager->Shader( 0 );

    m_currentManager->Vertex( 0, 0, 0 );       // v0
    m_currentManager->Vertex( aLength, 0, 0 ); // v1
    m_currentManager->Vertex( 0, H, 0 );       // v2

    m_currentManager->Vertex( aLength, 0, 0 ); // v1
    m_currentManager->Vertex( 0, H, 0 );       // v2
    m_currentManager->Vertex( aLength, H, 0 ); // v3

    Restore();
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::VERTEX_MANAGER::Color(), KIGFX::COLOR4D::g, H, KIGFX::BUILTIN_FONT::LookupGlyph(), m_currentManager, KIGFX::GAL::m_strokeColor, KIGFX::BUILTIN_FONT::FONT_GLYPH_TYPE::maxy, KIGFX::BUILTIN_FONT::FONT_GLYPH_TYPE::miny, KIGFX::COLOR4D::r, KIGFX::VERTEX_MANAGER::Reserve(), Restore(), Save(), KIGFX::VERTEX_MANAGER::Shader(), Translate(), and KIGFX::VERTEX_MANAGER::Vertex().

Referenced by BitmapText().

DrawCircle()

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

overridevirtual

Draw a circle using world coordinates.

Parameters

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

Reimplemented from KIGFX::GAL.

Definition at line 728 of file opengl_gal.cpp.

{
    if( m_isFillEnabled )
    {
        m_currentManager->Reserve( 3 );
        m_currentManager->Color( m_fillColor.r, m_fillColor.g, m_fillColor.b, m_fillColor.a );

        /* Draw a triangle that contains the circle, then shade it leaving only the circle.
         *  Parameters given to Shader() are indices of the triangle's vertices
         *  (if you want to understand more, check the vertex shader source [shader.vert]).
         *  Shader uses this coordinates to determine if fragments are inside the circle or not.
         *  Does the calculations in the vertex shader now (pixel alignment)
         *       v2
         *       /\
         *      //\\
         *  v0 /_\/_\ v1
         */
        m_currentManager->Shader( SHADER_FILLED_CIRCLE, 1.0, aRadius );
        m_currentManager->Vertex( aCenterPoint.x, aCenterPoint.y, m_layerDepth );

        m_currentManager->Shader( SHADER_FILLED_CIRCLE, 2.0, aRadius );
        m_currentManager->Vertex( aCenterPoint.x, aCenterPoint.y, m_layerDepth );

        m_currentManager->Shader( SHADER_FILLED_CIRCLE, 3.0, aRadius );
        m_currentManager->Vertex( aCenterPoint.x, aCenterPoint.y, m_layerDepth );
    }
    if( m_isStrokeEnabled )
    {
        m_currentManager->Reserve( 3 );
        m_currentManager->Color( m_strokeColor.r, m_strokeColor.g, m_strokeColor.b,
                                 m_strokeColor.a );

        /* Draw a triangle that contains the circle, then shade it leaving only the circle.
         *  Parameters given to Shader() are indices of the triangle's vertices
         *  (if you want to understand more, check the vertex shader source [shader.vert]).
         *  and the line width. Shader uses this coordinates to determine if fragments are
         *  inside the circle or not.
         *       v2
         *       /\
         *      //\\
         *  v0 /_\/_\ v1
         */
        m_currentManager->Shader( SHADER_STROKED_CIRCLE, 1.0, aRadius, m_lineWidth );
        m_currentManager->Vertex( aCenterPoint.x, // v0
                                  aCenterPoint.y, m_layerDepth );

        m_currentManager->Shader( SHADER_STROKED_CIRCLE, 2.0, aRadius, m_lineWidth );
        m_currentManager->Vertex( aCenterPoint.x, // v1
                                  aCenterPoint.y, m_layerDepth );

        m_currentManager->Shader( SHADER_STROKED_CIRCLE, 3.0, aRadius, m_lineWidth );
        m_currentManager->Vertex( aCenterPoint.x, aCenterPoint.y, // v2
                                  m_layerDepth );
    }
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::VERTEX_MANAGER::Color(), KIGFX::COLOR4D::g, m_currentManager, KIGFX::GAL::m_fillColor, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_isStrokeEnabled, KIGFX::GAL::m_layerDepth, KIGFX::GAL::m_lineWidth, KIGFX::GAL::m_strokeColor, KIGFX::COLOR4D::r, KIGFX::VERTEX_MANAGER::Reserve(), KIGFX::VERTEX_MANAGER::Shader(), KIGFX::SHADER_FILLED_CIRCLE, KIGFX::SHADER_STROKED_CIRCLE, KIGFX::VERTEX_MANAGER::Vertex(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DrawArcSegment(), and DrawSegment().

DrawCursor()

void OPENGL_GAL::DrawCursor ( const VECTOR2D &  aCursorPosition )

overridevirtual

Draw the cursor.

Parameters

aCursorPosition

is the cursor position in screen coordinates.

Reimplemented from KIGFX::GAL.

Definition at line 1782 of file opengl_gal.cpp.

{
    // Now we should only store the position of the mouse cursor
    // The real drawing routines are in blitCursor()
    //VECTOR2D screenCursor = m_worldScreenMatrix * aCursorPosition;
    //m_cursorPosition = m_screenWorldMatrix * VECTOR2D( screenCursor.x, screenCursor.y );
    m_cursorPosition = aCursorPosition;
}

References KIGFX::GAL::m_cursorPosition.

DrawCurve()

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

overridevirtual

Draw a cubic bezier spline.

Parameters

startPoint	is the start point of the spline.
controlPointA	is the first control point.
controlPointB	is the second control point.
endPoint	is the end point of the spline.
aFilterValue	is used by Bezier to segments approximation, if the Bezier curve is not supported and needs a curve to polyline conversion. aFilterValue = 0 means no filtering.

Reimplemented from KIGFX::GAL.

Definition at line 1183 of file opengl_gal.cpp.

{
    std::vector<VECTOR2D> output;
    std::vector<VECTOR2D> pointCtrl;

    pointCtrl.push_back( aStartPoint );
    pointCtrl.push_back( aControlPointA );
    pointCtrl.push_back( aControlPointB );
    pointCtrl.push_back( aEndPoint );

    BEZIER_POLY converter( pointCtrl );
    converter.GetPoly( output, aFilterValue );

    DrawPolyline( &output[0], output.size() );
}

References DrawPolyline(), and BEZIER_POLY::GetPoly().

drawFilledSemiCircle()

void OPENGL_GAL::drawFilledSemiCircle ( const VECTOR2D &  aCenterPoint, double  aRadius, double  aAngle  )

private

Draw a filled semicircle.

Parameters

aCenterPoint	is the center point.
aRadius	is the radius of the semicircle.
aAngle	is the angle of the semicircle.

Definition at line 1856 of file opengl_gal.cpp.

{
    Save();

    m_currentManager->Reserve( 3 );
    m_currentManager->Translate( aCenterPoint.x, aCenterPoint.y, 0.0f );
    m_currentManager->Rotate( aAngle, 0.0f, 0.0f, 1.0f );

    /* Draw a triangle that contains the semicircle, then shade it to leave only
     * the semicircle. Parameters given to Shader() are indices of the triangle's vertices
     * (if you want to understand more, check the vertex shader source [shader.vert]).
     * Shader uses these coordinates to determine if fragments are inside the semicircle or not.
     *       v2
     *       /\
     *      /__\
     *  v0 //__\\ v1
     */
    m_currentManager->Shader( SHADER_FILLED_CIRCLE, 4.0f );
    m_currentManager->Vertex( -aRadius * 3.0f / sqrt( 3.0f ), 0.0f, m_layerDepth ); // v0

    m_currentManager->Shader( SHADER_FILLED_CIRCLE, 5.0f );
    m_currentManager->Vertex( aRadius * 3.0f / sqrt( 3.0f ), 0.0f, m_layerDepth ); // v1

    m_currentManager->Shader( SHADER_FILLED_CIRCLE, 6.0f );
    m_currentManager->Vertex( 0.0f, aRadius * 2.0f, m_layerDepth ); // v2

    Restore();
}

References m_currentManager, KIGFX::GAL::m_layerDepth, KIGFX::VERTEX_MANAGER::Reserve(), Restore(), KIGFX::VERTEX_MANAGER::Rotate(), Save(), KIGFX::VERTEX_MANAGER::Shader(), KIGFX::SHADER_FILLED_CIRCLE, KIGFX::VERTEX_MANAGER::Translate(), KIGFX::VERTEX_MANAGER::Vertex(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by drawSemiCircle().

DrawGrid()

void OPENGL_GAL::DrawGrid ( )

overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 1373 of file opengl_gal.cpp.

{
    SetTarget( TARGET_NONCACHED );
    m_compositor->SetBuffer( m_mainBuffer );

    m_nonCachedManager->EnableDepthTest( false );

    // sub-pixel lines all render the same
    float minorLineWidth = std::fmax( 1.0f,
                                      m_gridLineWidth ) * getWorldPixelSize() / GetScaleFactor();
    float majorLineWidth = minorLineWidth * 2.0f;

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

    // Draw axes if desired
    if( m_axesEnabled )
    {
        SetLineWidth( minorLineWidth );
        SetStrokeColor( m_axesColor );

        DrawLine( VECTOR2D( worldStartPoint.x, 0 ), VECTOR2D( worldEndPoint.x, 0 ) );
        DrawLine( VECTOR2D( 0, worldStartPoint.y ), VECTOR2D( 0, worldEndPoint.y ) );
    }

    // force flush
    m_nonCachedManager->EndDrawing();

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

    VECTOR2D gridScreenSize( m_gridSize );

    double gridThreshold = computeMinGridSpacing() / m_worldScale;

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

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

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

    // Ensure start coordinate > end coordinate
    SWAP( gridStartX, >, gridEndX );
    SWAP( gridStartY, >, gridEndY );

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

    glDisable( GL_DEPTH_TEST );
    glDisable( GL_TEXTURE_2D );

    if( m_gridStyle == GRID_STYLE::DOTS )
    {
        glEnable( GL_STENCIL_TEST );
        glStencilFunc( GL_ALWAYS, 1, 1 );
        glStencilOp( GL_KEEP, GL_KEEP, GL_INCR );
        glColor4d( 0.0, 0.0, 0.0, 0.0 );
        SetStrokeColor( COLOR4D( 0.0, 0.0, 0.0, 0.0 ) );
    }
    else
    {
        glColor4d( m_gridColor.r, m_gridColor.g, m_gridColor.b, m_gridColor.a );
        SetStrokeColor( m_gridColor );
    }

    if( m_gridStyle == GRID_STYLE::SMALL_CROSS )
    {
        // Vertical positions
        for( int j = gridStartY; j <= gridEndY; j++ )
        {
            bool         tickY = ( j % m_gridTick == 0 );
            const double posY = j * gridScreenSize.y + m_gridOrigin.y;

            // Horizontal positions
            for( int i = gridStartX; i <= gridEndX; i++ )
            {
                bool tickX = ( i % m_gridTick == 0 );
                SetLineWidth( ( ( tickX && tickY ) ? majorLineWidth : minorLineWidth ) );
                auto lineLen = 2.0 * GetLineWidth();
                auto posX = i * gridScreenSize.x + m_gridOrigin.x;

                DrawLine( VECTOR2D( posX - lineLen, posY ), VECTOR2D( posX + lineLen, posY ) );
                DrawLine( VECTOR2D( posX, posY - lineLen ), VECTOR2D( posX, posY + lineLen ) );
            }
        }

        m_nonCachedManager->EndDrawing();
    }
    else
    {
        // Vertical lines
        for( int j = gridStartY; j <= gridEndY; j++ )
        {
            const double y = j * gridScreenSize.y + m_gridOrigin.y;

            // If axes are drawn, skip the lines that would cover them
            if( m_axesEnabled && y == 0.0 )
                continue;

            SetLineWidth( ( j % m_gridTick == 0 ) ? majorLineWidth : minorLineWidth );
            VECTOR2D a( gridStartX * gridScreenSize.x + m_gridOrigin.x, y );
            VECTOR2D b( gridEndX * gridScreenSize.x + m_gridOrigin.x, y );

            DrawLine( a, b );
        }

        m_nonCachedManager->EndDrawing();

        if( m_gridStyle == GRID_STYLE::DOTS )
        {
            glStencilFunc( GL_NOTEQUAL, 0, 1 );
            glColor4d( m_gridColor.r, m_gridColor.g, m_gridColor.b, m_gridColor.a );
            SetStrokeColor( m_gridColor );
        }

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

            // If axes are drawn, skip the lines that would cover them
            if( m_axesEnabled && x == 0.0 )
                continue;

            SetLineWidth( ( i % m_gridTick == 0 ) ? majorLineWidth : minorLineWidth );
            VECTOR2D a( x, gridStartY * gridScreenSize.y + m_gridOrigin.y );
            VECTOR2D b( x, gridEndY * gridScreenSize.y + m_gridOrigin.y );
            DrawLine( a, b );
        }

        m_nonCachedManager->EndDrawing();

        if( m_gridStyle == GRID_STYLE::DOTS )
            glDisable( GL_STENCIL_TEST );
    }

    glEnable( GL_DEPTH_TEST );
    glEnable( GL_TEXTURE_2D );
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::GAL::computeMinGridSpacing(), KIGFX::DOTS, DrawLine(), KIGFX::VERTEX_MANAGER::EnableDepthTest(), KIGFX::VERTEX_MANAGER::EndDrawing(), KIGFX::COLOR4D::g, KIGFX::GAL::GetLineWidth(), HIDPI_GL_CANVAS::GetScaleFactor(), getWorldPixelSize(), KiROUND(), KIGFX::GAL::m_axesColor, KIGFX::GAL::m_axesEnabled, m_compositor, KIGFX::GAL::m_gridColor, KIGFX::GAL::m_gridLineWidth, KIGFX::GAL::m_gridOrigin, KIGFX::GAL::m_gridSize, KIGFX::GAL::m_gridStyle, KIGFX::GAL::m_gridTick, KIGFX::GAL::m_gridVisibility, m_mainBuffer, m_nonCachedManager, KIGFX::GAL::m_screenSize, KIGFX::GAL::m_screenWorldMatrix, KIGFX::GAL::m_worldScale, KIGFX::COLOR4D::r, KIGFX::OPENGL_COMPOSITOR::SetBuffer(), KIGFX::GAL::SetLineWidth(), KIGFX::GAL::SetStrokeColor(), SetTarget(), KIGFX::SMALL_CROSS, SWAP, KIGFX::TARGET_NONCACHED, VECTOR2< T >::x, and VECTOR2< T >::y.

DrawGroup()

void OPENGL_GAL::DrawGroup ( int  aGroupNumber )

overridevirtual

Draw the stored group.

Parameters

aGroupNumber

is the group number.

Reimplemented from KIGFX::GAL.

Definition at line 1640 of file opengl_gal.cpp.

{
    auto group = m_groups.find( aGroupNumber );

    if( group != m_groups.end() )
        m_cachedManager->DrawItem( *group->second );
}

References KIGFX::VERTEX_MANAGER::DrawItem(), group, m_cachedManager, and m_groups.

DrawLine()

void OPENGL_GAL::DrawLine ( const VECTOR2D &  aStartPoint, const VECTOR2D &  aEndPoint  )

overridevirtual

Draw a line.

Start and end points are defined as 2D-Vectors.

Parameters

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

Reimplemented from KIGFX::GAL.

Definition at line 666 of file opengl_gal.cpp.

{
    m_currentManager->Color( m_strokeColor.r, m_strokeColor.g, m_strokeColor.b, m_strokeColor.a );

    drawLineQuad( aStartPoint, aEndPoint );
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::VERTEX_MANAGER::Color(), drawLineQuad(), KIGFX::COLOR4D::g, m_currentManager, KIGFX::GAL::m_strokeColor, and KIGFX::COLOR4D::r.

Referenced by DrawArc(), DrawArcSegment(), DrawGrid(), and drawTriangulatedPolyset().

drawLineQuad()

void OPENGL_GAL::drawLineQuad ( const VECTOR2D &  aStartPoint, const VECTOR2D &  aEndPoint  )

private

Draw a quad for the line.

Parameters

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

Definition at line 1792 of file opengl_gal.cpp.

{
    /* Helper drawing:                   ____--- v3       ^
     *                           ____---- ...   \          \
     *                   ____----      ...       \   end    \
     *     v1    ____----           ...    ____----          \ width
     *       ----                ...___----        \          \
     *       \             ___...--                 \          v
     *        \    ____----...                ____---- v2
     *         ----     ...           ____----
     *  start   \    ...      ____----
     *           \... ____----
     *            ----
     *            v0
     * dots mark triangles' hypotenuses
     */

    auto v1 = m_currentManager->GetTransformation()
              * glm::vec4( aStartPoint.x, aStartPoint.y, 0.0, 0.0 );
    auto v2 = m_currentManager->GetTransformation()
              * glm::vec4( aEndPoint.x, aEndPoint.y, 0.0, 0.0 );

    VECTOR2D vs( v2.x - v1.x, v2.y - v1.y );

    m_currentManager->Reserve( 6 );

    // Line width is maintained by the vertex shader
    m_currentManager->Shader( SHADER_LINE_A, m_lineWidth, vs.x, vs.y );
    m_currentManager->Vertex( aStartPoint, m_layerDepth );

    m_currentManager->Shader( SHADER_LINE_B, m_lineWidth, vs.x, vs.y );
    m_currentManager->Vertex( aStartPoint, m_layerDepth );

    m_currentManager->Shader( SHADER_LINE_C, m_lineWidth, vs.x, vs.y );
    m_currentManager->Vertex( aEndPoint, m_layerDepth );

    m_currentManager->Shader( SHADER_LINE_D, m_lineWidth, vs.x, vs.y );
    m_currentManager->Vertex( aEndPoint, m_layerDepth );

    m_currentManager->Shader( SHADER_LINE_E, m_lineWidth, vs.x, vs.y );
    m_currentManager->Vertex( aEndPoint, m_layerDepth );

    m_currentManager->Shader( SHADER_LINE_F, m_lineWidth, vs.x, vs.y );
    m_currentManager->Vertex( aStartPoint, m_layerDepth );
}

References KIGFX::VERTEX_MANAGER::GetTransformation(), m_currentManager, KIGFX::GAL::m_layerDepth, KIGFX::GAL::m_lineWidth, KIGFX::VERTEX_MANAGER::Reserve(), KIGFX::VERTEX_MANAGER::Shader(), KIGFX::SHADER_LINE_A, KIGFX::SHADER_LINE_B, KIGFX::SHADER_LINE_C, KIGFX::SHADER_LINE_D, KIGFX::SHADER_LINE_E, KIGFX::SHADER_LINE_F, v2, KIGFX::VERTEX_MANAGER::Vertex(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DrawLine(), drawPolyline(), and DrawSegment().

DrawPolygon() [1/4]

void OPENGL_GAL::DrawPolygon ( const std::deque< VECTOR2D > &  aPointList )

overridevirtual

Draw a polygon.

Parameters

aPointList

is the list of the polygon points.

Reimplemented from KIGFX::GAL.

Definition at line 1042 of file opengl_gal.cpp.

{
    wxCHECK( aPointList.size() >= 2, /* void */ );
    auto      points = std::unique_ptr<GLdouble[]>( new GLdouble[3 * aPointList.size()] );
    GLdouble* ptr = points.get();

    for( const VECTOR2D& p : aPointList )
    {
        *ptr++ = p.x;
        *ptr++ = p.y;
        *ptr++ = m_layerDepth;
    }

    drawPolygon( points.get(), aPointList.size() );
}

References drawPolygon(), and KIGFX::GAL::m_layerDepth.

Referenced by DrawPolygon().

DrawPolygon() [2/4]

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

overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 1059 of file opengl_gal.cpp.

{
    wxCHECK( aListSize >= 2, /* void */ );
    auto            points = std::unique_ptr<GLdouble[]>( new GLdouble[3 * aListSize] );
    GLdouble*       target = points.get();
    const VECTOR2D* src = aPointList;

    for( int i = 0; i < aListSize; ++i )
    {
        *target++ = src->x;
        *target++ = src->y;
        *target++ = m_layerDepth;
        ++src;
    }

    drawPolygon( points.get(), aListSize );
}

References drawPolygon(), KIGFX::GAL::m_layerDepth, VECTOR2< T >::x, and VECTOR2< T >::y.

DrawPolygon() [3/4]

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

overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 1147 of file opengl_gal.cpp.

{
    if( aPolySet.IsTriangulationUpToDate() )
    {
        drawTriangulatedPolyset( aPolySet, aStrokeTriangulation );
        return;
    }

    for( int j = 0; j < aPolySet.OutlineCount(); ++j )
    {
        const SHAPE_LINE_CHAIN& outline = aPolySet.COutline( j );
        DrawPolygon( outline );
    }
}

References SHAPE_POLY_SET::COutline(), DrawPolygon(), drawTriangulatedPolyset(), SHAPE_POLY_SET::IsTriangulationUpToDate(), and SHAPE_POLY_SET::OutlineCount().

DrawPolygon() [4/4]

void OPENGL_GAL::DrawPolygon ( const SHAPE_LINE_CHAIN &  aPolySet )

overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 1163 of file opengl_gal.cpp.

{
    wxCHECK( aPolygon.PointCount() >= 2, /* void */ );

    const int                   pointCount = aPolygon.SegmentCount() + 1;
    std::unique_ptr<GLdouble[]> points( new GLdouble[3 * pointCount] );
    GLdouble*                   ptr = points.get();

    for( int i = 0; i < pointCount; ++i )
    {
        const VECTOR2I& p = aPolygon.CPoint( i );
        *ptr++ = p.x;
        *ptr++ = p.y;
        *ptr++ = m_layerDepth;
    }

    drawPolygon( points.get(), pointCount );
}

References SHAPE_LINE_CHAIN::CPoint(), drawPolygon(), KIGFX::GAL::m_layerDepth, SHAPE_LINE_CHAIN::PointCount(), SHAPE_LINE_CHAIN::SegmentCount(), VECTOR2< T >::x, and VECTOR2< T >::y.

drawPolygon()

void OPENGL_GAL::drawPolygon ( GLdouble *  aPoints, int  aPointCount  )

private

Draw a filled polygon.

It does not need the last point to have the same coordinates as the first one.

Parameters

aPoints	is the vertices data (3 coordinates: x, y, z).
aPointCount	is the number of points.

Definition at line 1920 of file opengl_gal.cpp.

{
    if( m_isFillEnabled )
    {
        m_currentManager->Shader( SHADER_NONE );
        m_currentManager->Color( m_fillColor.r, m_fillColor.g, m_fillColor.b, m_fillColor.a );

        // Any non convex polygon needs to be tesselated
        // for this purpose the GLU standard functions are used
        TessParams params = { m_currentManager, m_tessIntersects };
        gluTessBeginPolygon( m_tesselator, &params );
        gluTessBeginContour( m_tesselator );

        GLdouble* point = aPoints;

        for( int i = 0; i < aPointCount; ++i )
        {
            gluTessVertex( m_tesselator, point, point );
            point += 3; // 3 coordinates
        }

        gluTessEndContour( m_tesselator );
        gluTessEndPolygon( m_tesselator );

        // Free allocated intersecting points
        m_tessIntersects.clear();
    }

    if( m_isStrokeEnabled )
    {
        drawPolyline(
                [&]( int idx )
                {
                    return VECTOR2D( aPoints[idx * 3], aPoints[idx * 3 + 1] );
                },
                aPointCount );
    }
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::VERTEX_MANAGER::Color(), drawPolyline(), KIGFX::COLOR4D::g, m_currentManager, KIGFX::GAL::m_fillColor, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_isStrokeEnabled, m_tesselator, m_tessIntersects, KIGFX::COLOR4D::r, KIGFX::VERTEX_MANAGER::Shader(), and KIGFX::SHADER_NONE.

Referenced by DrawPolygon().

DrawPolyline() [1/3]

void OPENGL_GAL::DrawPolyline ( const std::deque< VECTOR2D > &  aPointList )

overridevirtual

Draw a polyline.

Parameters

aPointList

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

Reimplemented from KIGFX::GAL.

Definition at line 1004 of file opengl_gal.cpp.

{
    drawPolyline(
            [&]( int idx )
            {
                return aPointList[idx];
            },
            aPointList.size() );
}

References drawPolyline().

Referenced by DrawCurve(), DrawRectangle(), and drawTriangulatedPolyset().

DrawPolyline() [2/3]

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

overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 1015 of file opengl_gal.cpp.

{
    drawPolyline(
            [&]( int idx )
            {
                return aPointList[idx];
            },
            aListSize );
}

References drawPolyline().

DrawPolyline() [3/3]

void OPENGL_GAL::DrawPolyline ( const SHAPE_LINE_CHAIN &  aLineChain )

overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 1026 of file opengl_gal.cpp.

{
    auto numPoints = aLineChain.PointCount();

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

    drawPolyline(
            [&]( int idx )
            {
                return aLineChain.CPoint( idx );
            },
            numPoints );
}

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

drawPolyline()

void OPENGL_GAL::drawPolyline ( const std::function< VECTOR2D(int)> &  aPointGetter, int  aPointCount  )

private

Generic way of drawing a polyline stored in different containers.

Parameters

aPointGetter	is a function to obtain coordinates of n-th vertex.
aPointCount	is the number of points to be drawn.

Definition at line 1960 of file opengl_gal.cpp.

{
    wxCHECK( aPointCount >= 2, /* return */ );

    m_currentManager->Color( m_strokeColor.r, m_strokeColor.g, m_strokeColor.b, m_strokeColor.a );
    int i;

    for( i = 1; i < aPointCount; ++i )
    {
        auto start = aPointGetter( i - 1 );
        auto end = aPointGetter( i );

        drawLineQuad( start, end );
    }
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::VERTEX_MANAGER::Color(), drawLineQuad(), KIGFX::COLOR4D::g, m_currentManager, KIGFX::GAL::m_strokeColor, and KIGFX::COLOR4D::r.

Referenced by drawPolygon(), and DrawPolyline().

DrawRectangle()

void OPENGL_GAL::DrawRectangle ( const VECTOR2D &  aStartPoint, const VECTOR2D &  aEndPoint  )

overridevirtual

Draw a rectangle.

Parameters

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

Reimplemented from KIGFX::GAL.

Definition at line 965 of file opengl_gal.cpp.

{
    // Compute the diagonal points of the rectangle
    VECTOR2D diagonalPointA( aEndPoint.x, aStartPoint.y );
    VECTOR2D diagonalPointB( aStartPoint.x, aEndPoint.y );

    // Fill the rectangle
    if( m_isFillEnabled )
    {
        m_currentManager->Reserve( 6 );
        m_currentManager->Shader( SHADER_NONE );
        m_currentManager->Color( m_fillColor.r, m_fillColor.g, m_fillColor.b, m_fillColor.a );

        m_currentManager->Vertex( aStartPoint.x, aStartPoint.y, m_layerDepth );
        m_currentManager->Vertex( diagonalPointA.x, diagonalPointA.y, m_layerDepth );
        m_currentManager->Vertex( aEndPoint.x, aEndPoint.y, m_layerDepth );

        m_currentManager->Vertex( aStartPoint.x, aStartPoint.y, m_layerDepth );
        m_currentManager->Vertex( aEndPoint.x, aEndPoint.y, m_layerDepth );
        m_currentManager->Vertex( diagonalPointB.x, diagonalPointB.y, m_layerDepth );
    }

    // Stroke the outline
    if( m_isStrokeEnabled )
    {
        m_currentManager->Color( m_strokeColor.r, m_strokeColor.g, m_strokeColor.b,
                                 m_strokeColor.a );

        std::deque<VECTOR2D> pointList;
        pointList.push_back( aStartPoint );
        pointList.push_back( diagonalPointA );
        pointList.push_back( aEndPoint );
        pointList.push_back( diagonalPointB );
        pointList.push_back( aStartPoint );
        DrawPolyline( pointList );
    }
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::VERTEX_MANAGER::Color(), DrawPolyline(), KIGFX::COLOR4D::g, m_currentManager, KIGFX::GAL::m_fillColor, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_isStrokeEnabled, KIGFX::GAL::m_layerDepth, KIGFX::GAL::m_strokeColor, KIGFX::COLOR4D::r, KIGFX::VERTEX_MANAGER::Reserve(), KIGFX::VERTEX_MANAGER::Shader(), KIGFX::SHADER_NONE, KIGFX::VERTEX_MANAGER::Vertex(), VECTOR2< T >::x, and VECTOR2< T >::y.

DrawSegment()

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

overridevirtual

Draw a rounded segment.

Start and end points are defined as 2D-Vectors.

Parameters

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

Reimplemented from KIGFX::GAL.

Definition at line 674 of file opengl_gal.cpp.

{
    VECTOR2D startEndVector = aEndPoint - aStartPoint;
    double   lineLength = startEndVector.EuclideanNorm();

    float startx = aStartPoint.x;
    float starty = aStartPoint.y;
    float endx = aStartPoint.x + lineLength;
    float endy = aStartPoint.y + lineLength;

    // Be careful about floating point rounding.  As we draw segments in larger and larger
    // coordinates, the shader (which uses floats) will lose precision and stop drawing small
    // segments.  In this case, we need to draw a circle for the minimal segment.
    if( startx == endx || starty == endy )
    {
        DrawCircle( aStartPoint, aWidth / 2 );
        return;
    }

    if( m_isFillEnabled || aWidth == 1.0 )
    {
        m_currentManager->Color( m_fillColor.r, m_fillColor.g, m_fillColor.b, m_fillColor.a );

        SetLineWidth( aWidth );
        drawLineQuad( aStartPoint, aEndPoint );
    }
    else
    {
        auto lineAngle = startEndVector.Angle();
        // Outlined tracks

        SetLineWidth( 1.0 );
        m_currentManager->Color( m_strokeColor.r, m_strokeColor.g, m_strokeColor.b,
                                 m_strokeColor.a );

        Save();

        m_currentManager->Translate( aStartPoint.x, aStartPoint.y, 0.0 );
        m_currentManager->Rotate( lineAngle, 0.0f, 0.0f, 1.0f );

        drawLineQuad( VECTOR2D( 0.0, aWidth / 2.0 ), VECTOR2D( lineLength, aWidth / 2.0 ) );

        drawLineQuad( VECTOR2D( 0.0, -aWidth / 2.0 ), VECTOR2D( lineLength, -aWidth / 2.0 ) );

        // Draw line caps
        drawStrokedSemiCircle( VECTOR2D( 0.0, 0.0 ), aWidth / 2, M_PI / 2 );
        drawStrokedSemiCircle( VECTOR2D( lineLength, 0.0 ), aWidth / 2, -M_PI / 2 );

        Restore();
    }
}

References KIGFX::COLOR4D::a, VECTOR2< T >::Angle(), KIGFX::COLOR4D::b, KIGFX::VERTEX_MANAGER::Color(), DrawCircle(), drawLineQuad(), drawStrokedSemiCircle(), VECTOR2< T >::EuclideanNorm(), KIGFX::COLOR4D::g, m_currentManager, KIGFX::GAL::m_fillColor, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_strokeColor, KIGFX::COLOR4D::r, Restore(), KIGFX::VERTEX_MANAGER::Rotate(), Save(), KIGFX::GAL::SetLineWidth(), and KIGFX::VERTEX_MANAGER::Translate().

drawSemiCircle()

void OPENGL_GAL::drawSemiCircle ( const VECTOR2D &  aCenterPoint, double  aRadius, double  aAngle  )

private

Draw a semicircle.

Depending on settings (m_isStrokeEnabled & isFilledEnabled) it runs the proper function (drawStrokedSemiCircle or drawFilledSemiCircle).

Parameters

aCenterPoint	is the center point.
aRadius	is the radius of the semicircle.
aAngle	is the angle of the semicircle.

Definition at line 1839 of file opengl_gal.cpp.

{
    if( m_isFillEnabled )
    {
        m_currentManager->Color( m_fillColor.r, m_fillColor.g, m_fillColor.b, m_fillColor.a );
        drawFilledSemiCircle( aCenterPoint, aRadius, aAngle );
    }

    if( m_isStrokeEnabled )
    {
        m_currentManager->Color( m_strokeColor.r, m_strokeColor.g, m_strokeColor.b,
                                 m_strokeColor.a );
        drawStrokedSemiCircle( aCenterPoint, aRadius, aAngle );
    }
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::VERTEX_MANAGER::Color(), drawFilledSemiCircle(), drawStrokedSemiCircle(), KIGFX::COLOR4D::g, m_currentManager, KIGFX::GAL::m_fillColor, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_isStrokeEnabled, KIGFX::GAL::m_strokeColor, and KIGFX::COLOR4D::r.

drawStrokedSemiCircle()

void OPENGL_GAL::drawStrokedSemiCircle ( const VECTOR2D &  aCenterPoint, double  aRadius, double  aAngle  )

private

Draw a stroked semicircle.

Parameters

aCenterPoint	is the center point.
aRadius	is the radius of the semicircle.
aAngle	is the angle of the semicircle.

Definition at line 1886 of file opengl_gal.cpp.

{
    double outerRadius = aRadius + ( m_lineWidth / 2 );

    Save();

    m_currentManager->Reserve( 3 );
    m_currentManager->Translate( aCenterPoint.x, aCenterPoint.y, 0.0f );
    m_currentManager->Rotate( aAngle, 0.0f, 0.0f, 1.0f );

    /* Draw a triangle that contains the semicircle, then shade it to leave only
     * the semicircle. Parameters given to Shader() are indices of the triangle's vertices
     * (if you want to understand more, check the vertex shader source [shader.vert]), the
     * radius and the line width. Shader uses these coordinates to determine if fragments are
     * inside the semicircle or not.
     *       v2
     *       /\
     *      /__\
     *  v0 //__\\ v1
     */
    m_currentManager->Shader( SHADER_STROKED_CIRCLE, 4.0f, aRadius, m_lineWidth );
    m_currentManager->Vertex( -outerRadius * 3.0f / sqrt( 3.0f ), 0.0f, m_layerDepth ); // v0

    m_currentManager->Shader( SHADER_STROKED_CIRCLE, 5.0f, aRadius, m_lineWidth );
    m_currentManager->Vertex( outerRadius * 3.0f / sqrt( 3.0f ), 0.0f, m_layerDepth ); // v1

    m_currentManager->Shader( SHADER_STROKED_CIRCLE, 6.0f, aRadius, m_lineWidth );
    m_currentManager->Vertex( 0.0f, outerRadius * 2.0f, m_layerDepth ); // v2

    Restore();
}

References m_currentManager, KIGFX::GAL::m_layerDepth, KIGFX::GAL::m_lineWidth, KIGFX::VERTEX_MANAGER::Reserve(), Restore(), KIGFX::VERTEX_MANAGER::Rotate(), Save(), KIGFX::VERTEX_MANAGER::Shader(), KIGFX::SHADER_STROKED_CIRCLE, KIGFX::VERTEX_MANAGER::Translate(), KIGFX::VERTEX_MANAGER::Vertex(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DrawArcSegment(), DrawSegment(), and drawSemiCircle().

drawTriangulatedPolyset()

void OPENGL_GAL::drawTriangulatedPolyset ( const SHAPE_POLY_SET &  aPoly, bool  aStrokeTriangulation  )

private

Draw a set of polygons with a cached triangulation.

Way faster than drawPolygon.

Parameters

aStrokeTriangulation

indicates the triangulation should be stroked rather than filled. Used for debugging.

Definition at line 1078 of file opengl_gal.cpp.

{
    m_currentManager->Shader( SHADER_NONE );
    m_currentManager->Color( m_fillColor.r, m_fillColor.g, m_fillColor.b, m_fillColor.a );

    if( m_isFillEnabled )
    {
        for( unsigned int j = 0; j < aPolySet.TriangulatedPolyCount(); ++j )
        {
            auto triPoly = aPolySet.TriangulatedPolygon( j );

            for( size_t i = 0; i < triPoly->GetTriangleCount(); i++ )
            {
                VECTOR2I a, b, c;
                triPoly->GetTriangle( i, a, b, c );
                m_currentManager->Vertex( a.x, a.y, m_layerDepth );
                m_currentManager->Vertex( b.x, b.y, m_layerDepth );
                m_currentManager->Vertex( c.x, c.y, m_layerDepth );
            }
        }
    }

    if( m_isStrokeEnabled )
    {
        for( int j = 0; j < aPolySet.OutlineCount(); ++j )
        {
            const auto& poly = aPolySet.Polygon( j );

            for( const auto& lc : poly )
            {
                DrawPolyline( lc );
            }
        }
    }

    if( ADVANCED_CFG::GetCfg().m_DrawTriangulationOutlines )
    {
        aStrokeTriangulation = true;
        SetStrokeColor( COLOR4D( 0.0, 1.0, 0.2, 1.0 ) );
    }

    if( aStrokeTriangulation )
    {
        COLOR4D oldStrokeColor = m_strokeColor;
        double  oldLayerDepth = m_layerDepth;

        SetLayerDepth( m_layerDepth - 1 );

        for( unsigned int j = 0; j < aPolySet.TriangulatedPolyCount(); ++j )
        {
            auto triPoly = aPolySet.TriangulatedPolygon( j );

            for( size_t i = 0; i < triPoly->GetTriangleCount(); i++ )
            {
                VECTOR2I a, b, c;
                triPoly->GetTriangle( i, a, b, c );
                DrawLine( a, b );
                DrawLine( b, c );
                DrawLine( c, a );
            }
        }

        SetStrokeColor( oldStrokeColor );
        SetLayerDepth( oldLayerDepth );
    }
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::VERTEX_MANAGER::Color(), DrawLine(), DrawPolyline(), KIGFX::COLOR4D::g, ADVANCED_CFG::GetCfg(), m_currentManager, KIGFX::GAL::m_fillColor, KIGFX::GAL::m_isFillEnabled, KIGFX::GAL::m_isStrokeEnabled, KIGFX::GAL::m_layerDepth, KIGFX::GAL::m_strokeColor, SHAPE_POLY_SET::OutlineCount(), SHAPE_POLY_SET::Polygon(), KIGFX::COLOR4D::r, KIGFX::GAL::SetLayerDepth(), KIGFX::GAL::SetStrokeColor(), KIGFX::VERTEX_MANAGER::Shader(), KIGFX::SHADER_NONE, SHAPE_POLY_SET::TriangulatedPolyCount(), SHAPE_POLY_SET::TriangulatedPolygon(), KIGFX::VERTEX_MANAGER::Vertex(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DrawPolygon().

EnableDepthTest()

void OPENGL_GAL::EnableDepthTest ( bool  aEnabled = false )

overridevirtual

Reimplemented from KIGFX::GAL.

Definition at line 2342 of file opengl_gal.cpp.

{
    m_cachedManager->EnableDepthTest( aEnabled );
    m_nonCachedManager->EnableDepthTest( aEnabled );
    m_overlayManager->EnableDepthTest( aEnabled );
}

References KIGFX::VERTEX_MANAGER::EnableDepthTest(), m_cachedManager, m_nonCachedManager, and m_overlayManager.

EndDiffLayer()

void OPENGL_GAL::EndDiffLayer ( )

overridevirtual

Ends rendering of a differential layer.

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

Reimplemented from KIGFX::GAL.

Definition at line 1753 of file opengl_gal.cpp.

{
    glBlendFunc( GL_SRC_ALPHA, GL_ONE );
    m_currentManager->EndDrawing();
    glBlendFunc( GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA );
}

References KIGFX::VERTEX_MANAGER::EndDrawing(), and m_currentManager.

endDrawing()

void OPENGL_GAL::endDrawing ( )

overrideprivatevirtual

Update handler for OpenGL settings

Reimplemented from KIGFX::GAL.

Definition at line 576 of file opengl_gal.cpp.

{
    wxASSERT_MSG( m_isContextLocked, "What happened to the context lock?" );

#ifdef KICAD_GAL_PROFILE
    PROF_COUNTER totalRealTime( "OPENGL_GAL::endDrawing()", true );
#endif /* KICAD_GAL_PROFILE */

    // Cached & non-cached containers are rendered to the same buffer
    m_compositor->SetBuffer( m_mainBuffer );
    m_nonCachedManager->EndDrawing();
    m_cachedManager->EndDrawing();

    // Overlay container is rendered to a different buffer
    if( m_overlayBuffer )
        m_compositor->SetBuffer( m_overlayBuffer );

    m_overlayManager->EndDrawing();

    // Be sure that the framebuffer is not colorized (happens on specific GPU&drivers combinations)
    glColor4d( 1.0, 1.0, 1.0, 1.0 );

    // Draw the remaining contents, blit the rendering targets to the screen, swap the buffers
    m_compositor->DrawBuffer( m_mainBuffer );

    if( m_overlayBuffer )
        m_compositor->DrawBuffer( m_overlayBuffer );

    m_compositor->Present();
    blitCursor();

    SwapBuffers();

#ifdef KICAD_GAL_PROFILE
    totalRealTime.Stop();
    wxLogTrace( traceGalProfile, wxT( "OPENGL_GAL::endDrawing(): %.1f ms" ),
                totalRealTime.msecs() );
#endif /* KICAD_GAL_PROFILE */
}

References blitCursor(), KIGFX::OPENGL_COMPOSITOR::DrawBuffer(), KIGFX::VERTEX_MANAGER::EndDrawing(), m_cachedManager, m_compositor, m_isContextLocked, m_mainBuffer, m_nonCachedManager, m_overlayBuffer, m_overlayManager, PROF_COUNTER::msecs(), KIGFX::OPENGL_COMPOSITOR::Present(), KIGFX::OPENGL_COMPOSITOR::SetBuffer(), PROF_COUNTER::Stop(), and traceGalProfile.

EndGroup()

void OPENGL_GAL::EndGroup ( )

overridevirtual

End the group.

Reimplemented from KIGFX::GAL.

Definition at line 1633 of file opengl_gal.cpp.

{
    m_cachedManager->FinishItem();
    m_isGrouping = false;
}

References KIGFX::VERTEX_MANAGER::FinishItem(), m_cachedManager, and m_isGrouping.

EndNegativesLayer()

virtual void KIGFX::GAL::EndNegativesLayer ( )

inlinevirtualinherited

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

No-op in OpenGL.

Reimplemented in KIGFX::CAIRO_GAL.

Definition at line 853 of file graphics_abstraction_layer.h.

{};

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

endUpdate()

void OPENGL_GAL::endUpdate ( )

overrideprivatevirtual

Reimplemented from KIGFX::GAL.

Definition at line 657 of file opengl_gal.cpp.

{
    if( !m_isInitialized )
        return;

    m_cachedManager->Unmap();
}

References m_cachedManager, m_isInitialized, and KIGFX::VERTEX_MANAGER::Unmap().

Flush()

void OPENGL_GAL::Flush ( )

overridevirtual

Force all remaining objects to be drawn.

Reimplemented from KIGFX::GAL.

Definition at line 1556 of file opengl_gal.cpp.

{
    glFlush();
}

GetClearColor()

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

inlineinherited

Definition at line 222 of file graphics_abstraction_layer.h.

    {
        return m_clearColor;
    }

References KIGFX::GAL::m_clearColor.

Referenced by EDIT_POINTS::ViewDraw().

getCursorColor()

COLOR4D GAL::getCursorColor ( ) const

protectedinherited

Get the actual cursor color to draw.

Definition at line 267 of file graphics_abstraction_layer.cpp.

{
    COLOR4D color = m_cursorColor;

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

    return color;
}

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

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

GetFillColor()

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

inlineinherited

Get the fill color.

Returns

the color for filling a outline.

Definition at line 273 of file graphics_abstraction_layer.h.

    {
        return m_fillColor;
    }

References KIGFX::GAL::m_fillColor.

GetGlyphSize()

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

inlineinherited

Definition at line 416 of file graphics_abstraction_layer.h.

{ return textProperties.m_glyphSize; }

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

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

GetGridLineWidth()

float KIGFX::GAL::GetGridLineWidth ( ) const

inlineinherited

Get the grid line width.

Returns

the grid line widthDraw the grid

Definition at line 969 of file graphics_abstraction_layer.h.

References KIGFX::GAL::m_gridLineWidth.

GetGridOrigin()

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

inlineinherited

Definition at line 894 of file graphics_abstraction_layer.h.

    {
        return m_gridOrigin;
    }

References KIGFX::GAL::m_gridOrigin.

Referenced by GRID_HELPER::GetOrigin().

GetGridPoint()

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

inherited

For a given point it returns the nearest point belonging to the grid in world coordinates.

Parameters

aPoint

is the point for which the grid point is searched.

Returns

The nearest grid point in world coordinates.

Definition at line 245 of file graphics_abstraction_layer.cpp.

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

    return VECTOR2D( cx, cy );
#endif
}

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

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

GetGridSize()

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

inlineinherited

Return the grid size.

Returns

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

Definition at line 921 of file graphics_abstraction_layer.h.

    {
        return m_gridSize;
    }

References KIGFX::GAL::m_gridSize.

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

GetGridSnapping()

bool KIGFX::GAL::GetGridSnapping ( ) const

inlineinherited

Definition at line 868 of file graphics_abstraction_layer.h.

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

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

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

GetGridVisibility()

bool KIGFX::GAL::GetGridVisibility ( ) const

inlineinherited

Definition at line 866 of file graphics_abstraction_layer.h.

{ return m_gridVisibility; }

References KIGFX::GAL::m_gridVisibility.

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

GetHorizontalJustify()

EDA_TEXT_HJUSTIFY_T KIGFX::GAL::GetHorizontalJustify ( ) const

inlineinherited

Return current text horizontal justification setting.

Definition at line 458 of file graphics_abstraction_layer.h.

    {
        return textProperties.m_horizontalJustify;
    }

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

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

GetLineWidth()

float KIGFX::GAL::GetLineWidth ( ) const

inlineinherited

Get the line width.

Returns

the actual line width.

Definition at line 313 of file graphics_abstraction_layer.h.

    {
        return m_lineWidth;
    }

References KIGFX::GAL::m_lineWidth.

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

GetLookAtPoint()

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

inlineinherited

Get the look at point.

Returns

the look at point.

Definition at line 663 of file graphics_abstraction_layer.h.

    {
        return m_lookAtPoint;
    }

References KIGFX::GAL::m_lookAtPoint.

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

GetMaxDepth()

double KIGFX::GAL::GetMaxDepth ( ) const

inlineinherited

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

Definition at line 732 of file graphics_abstraction_layer.h.

    {
        return m_depthRange.y;
    }

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

GetMinDepth()

double KIGFX::GAL::GetMinDepth ( ) const

inlineinherited

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

Definition at line 724 of file graphics_abstraction_layer.h.

    {
        return m_depthRange.x;
    }

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

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

GetNativePixelSize()

wxSize HIDPI_GL_CANVAS::GetNativePixelSize ( ) const

virtualinherited

Definition at line 41 of file hidpi_gl_canvas.cpp.

{
    wxSize size = wxGLCanvas::GetClientSize();

    const double scaleFactor = GetScaleFactor();
    size.x *= scaleFactor;
    size.y *= scaleFactor;

    return size;
}

References HIDPI_GL_CANVAS::GetScaleFactor().

Referenced by EDA_3D_CANVAS::DoRePaint(), EDA_3D_MODEL_VIEWER::OnMouseMove(), EDA_3D_CANVAS::OnMouseMove(), EDA_3D_MODEL_VIEWER::OnPaint(), and OPENGL_GAL().

GetNativePosition()

wxPoint HIDPI_GL_CANVAS::GetNativePosition ( const wxPoint &  aPoint ) const

inherited

Convert the given point from client coordinates to native pixel coordinates.

Definition at line 53 of file hidpi_gl_canvas.cpp.

{
    wxPoint nativePoint = aPoint;

    const double scaleFactor = GetScaleFactor();
    nativePoint.x *= scaleFactor;
    nativePoint.y *= scaleFactor;

    return nativePoint;
}

References HIDPI_GL_CANVAS::GetScaleFactor().

Referenced by EDA_3D_MODEL_VIEWER::OnMouseMove(), EDA_3D_CANVAS::OnMouseMove(), and EDA_3D_CANVAS::OnMouseWheel().

getNewGroupNumber()

unsigned int OPENGL_GAL::getNewGroupNumber ( )

private

Return a valid key that can be used as a new group number.

Returns

An unique group number that is not used by any other group.

Definition at line 2188 of file opengl_gal.cpp.

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

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

    return m_groupCounter++;
}

References m_groupCounter, and m_groups.

Referenced by BeginGroup().

GetRotation()

double KIGFX::GAL::GetRotation ( ) const

inlineinherited

Get the rotation angle.

Returns

The rotation angle (radians).

Definition at line 703 of file graphics_abstraction_layer.h.

    {
        return m_rotation;
    }

References KIGFX::GAL::m_rotation.

GetScaleFactor()

double HIDPI_GL_CANVAS::GetScaleFactor ( ) const

inherited

Get the current scale factor.

Definition at line 71 of file hidpi_gl_canvas.cpp.

{
    return m_scale_factor;
}

References HIDPI_GL_CANVAS::m_scale_factor.

Referenced by beginDrawing(), DrawGrid(), HIDPI_GL_CANVAS::GetNativePixelSize(), HIDPI_GL_CANVAS::GetNativePosition(), getScreenPixelSize(), ResizeScreen(), KIGFX::PREVIEW::SetConstantGlyphHeight(), and updatedGalDisplayOptions().

GetScreenPixelSize()

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

inlineinherited

Return GAL canvas size in pixels.

Definition at line 209 of file graphics_abstraction_layer.h.

    {
        return m_screenSize;
    }

References KIGFX::GAL::m_screenSize.

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

getScreenPixelSize()

VECTOR2D OPENGL_GAL::getScreenPixelSize ( ) const

private

Definition at line 410 of file opengl_gal.cpp.

{
    double sf = GetScaleFactor();
    return VECTOR2D( 2.0 / (double) ( m_screenSize.x * sf ), 2.0 /
                     (double) ( m_screenSize.y * sf ) );
}

References HIDPI_GL_CANVAS::GetScaleFactor(), KIGFX::GAL::m_screenSize, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by beginDrawing().

GetScreenWorldMatrix()

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

inlineinherited

Get the screen <-> world transformation matrix.

Returns

the transformation matrix.

Definition at line 594 of file graphics_abstraction_layer.h.

    {
        return m_screenWorldMatrix;
    }

References KIGFX::GAL::m_screenWorldMatrix.

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

GetStrokeColor()

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

inlineinherited

Get the stroke color.

Returns

the color for stroking the outline.

Definition at line 293 of file graphics_abstraction_layer.h.

    {
        return m_strokeColor;
    }

References KIGFX::GAL::m_strokeColor.

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

GetStrokeFont()

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

inlineinherited

Definition at line 335 of file graphics_abstraction_layer.h.

    {
        return m_strokeFont;
    }

References KIGFX::GAL::m_strokeFont.

Referenced by KIGFX::SCH_PAINTER::boxText(), and EDA_TEXT::GetTextBox().

GetTarget()

RENDER_TARGET OPENGL_GAL::GetTarget ( ) const

overridevirtual

Get the currently used target for rendering.

Returns

The current rendering target.

Reimplemented from KIGFX::GAL.

Definition at line 1699 of file opengl_gal.cpp.

{
    return m_currentTarget;
}

References m_currentTarget.

Referenced by DrawBitmap().

GetTextLineSize()

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

inherited

Compute the X and Y size of a given text.

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

Parameters

aText

is the text string (one line).

Returns

is the text size.

Definition at line 183 of file graphics_abstraction_layer.cpp.

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

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

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

GetVerticalJustify()

EDA_TEXT_VJUSTIFY_T KIGFX::GAL::GetVerticalJustify ( ) const

inlineinherited

Returns current text vertical justification setting.

Definition at line 476 of file graphics_abstraction_layer.h.

    {
        return textProperties.m_verticalJustify;
    }

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

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

GetVisibleWorldExtents()

BOX2D GAL::GetVisibleWorldExtents ( ) const

inherited

Returns

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

Definition at line 222 of file graphics_abstraction_layer.cpp.

{
    const MATRIX3x3D& matrix = GetScreenWorldMatrix();

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

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

    return extents;
}

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

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

getWorldPixelSize()

double OPENGL_GAL::getWorldPixelSize ( ) const

private

Definition at line 403 of file opengl_gal.cpp.

{
    MATRIX3x3D matrix = GetScreenWorldMatrix();
    return std::min( std::abs( matrix.GetScale().x ), std::abs( matrix.GetScale().y ) );
}

References MATRIX3x3< T >::GetScale(), KIGFX::GAL::GetScreenWorldMatrix(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by beginDrawing(), and DrawGrid().

GetWorldScale()

double KIGFX::GAL::GetWorldScale ( ) const

inlineinherited

Get the world scale.

Returns

the actual world scale factor.

Definition at line 742 of file graphics_abstraction_layer.h.

    {
        return m_worldScale;
    }

References KIGFX::GAL::m_worldScale.

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

GetWorldScreenMatrix()

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

inlineinherited

Get the world <-> screen transformation matrix.

Returns

the transformation matrix.

Definition at line 584 of file graphics_abstraction_layer.h.

    {
        return m_worldScreenMatrix;
    }

References KIGFX::GAL::m_worldScreenMatrix.

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

GetZoomFactor()

double KIGFX::GAL::GetZoomFactor ( ) const

inlineinherited

Get the zoom factor.

Returns

the zoom factor.

Definition at line 683 of file graphics_abstraction_layer.h.

    {
        return m_zoomFactor;
    }

References KIGFX::GAL::m_zoomFactor.

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

HasTarget()

bool OPENGL_GAL::HasTarget ( RENDER_TARGET  aTarget )

overridevirtual

Return true if the target exists.

Parameters

aTarget

is the target to be checked.

Reimplemented from KIGFX::GAL.

Definition at line 1735 of file opengl_gal.cpp.

{
    switch( aTarget )
    {
    default:
    case TARGET_CACHED:
    case TARGET_NONCACHED: return true;
    case TARGET_OVERLAY:   return ( m_overlayBuffer != 0 );
    }
}

References m_overlayBuffer, KIGFX::TARGET_CACHED, KIGFX::TARGET_NONCACHED, and KIGFX::TARGET_OVERLAY.

init()

void OPENGL_GAL::init ( )

private

Basic OpenGL initialization and feature checks.

Exceptions

std::runtime_error

if any of the OpenGL feature checks failed

Definition at line 2200 of file opengl_gal.cpp.

{
    wxASSERT( IsShownOnScreen() );

    wxASSERT_MSG( m_isContextLocked, "This should only be called from within a locked context." );

// IsDisplayAttr() handles WX_GL_{MAJOR,MINOR}_VERSION correctly only in 3.0.4
// starting with 3.1.0 one should use wxGLContext::IsOk() (done by GL_CONTEXT_MANAGER)
#if wxCHECK_VERSION( 3, 0, 3 ) and !wxCHECK_VERSION( 3, 1, 0 )
    const int attr[] = { WX_GL_MAJOR_VERSION, 2, WX_GL_MINOR_VERSION, 1, 0 };

    if( !IsDisplaySupported( attr ) )
        throw std::runtime_error( "OpenGL 2.1 or higher is required!" );
#endif /* wxCHECK_VERSION( 3, 0, 3 ) */

    // Check correct initialization from the constructor
    if( !m_glMainContext )
        throw std::runtime_error( "Could not create the main OpenGL context" );

    if( !m_glPrivContext )
        throw std::runtime_error( "Could not create a private OpenGL context" );

    if( m_tesselator == nullptr )
        throw std::runtime_error( "Could not create the m_tesselator" );
    // End initialization checks

    GLenum err = glewInit();

    if( GLEW_OK != err )
        throw std::runtime_error( (const char*) glewGetErrorString( err ) );

    // Check the OpenGL version (minimum 2.1 is required)
    if( !GLEW_VERSION_2_1 )
        throw std::runtime_error( "OpenGL 2.1 or higher is required!" );

#if defined( __LINUX__ ) // calling enableGlDebug crashes opengl on some OS (OSX and some Windows)
#ifdef DEBUG
    if( GLEW_ARB_debug_output )
        enableGlDebug( true );
#endif
#endif

    // Framebuffers have to be supported
    if( !GLEW_EXT_framebuffer_object )
        throw std::runtime_error( "Framebuffer objects are not supported!" );

    // Vertex buffer has to be supported
    if( !GLEW_ARB_vertex_buffer_object )
        throw std::runtime_error( "Vertex buffer objects are not supported!" );

    // Prepare shaders
    if( !m_shader->IsLinked()
        && !m_shader->LoadShaderFromStrings( SHADER_TYPE_VERTEX,
                                             BUILTIN_SHADERS::kicad_vertex_shader ) )
    {
        throw std::runtime_error( "Cannot compile vertex shader!" );
    }

    if( !m_shader->IsLinked()
        && !m_shader->LoadShaderFromStrings( SHADER_TYPE_FRAGMENT,
                                             BUILTIN_SHADERS::kicad_fragment_shader ) )
    {
        throw std::runtime_error( "Cannot compile fragment shader!" );
    }

    if( !m_shader->IsLinked() && !m_shader->Link() )
        throw std::runtime_error( "Cannot link the shaders!" );

    // Check if video card supports textures big enough to fit the font atlas
    int maxTextureSize;
    glGetIntegerv( GL_MAX_TEXTURE_SIZE, &maxTextureSize );

    if( maxTextureSize < (int) font_image.width || maxTextureSize < (int) font_image.height )
    {
        // TODO implement software texture scaling
        // for bitmap fonts and use a higher resolution texture?
        throw std::runtime_error( "Requested texture size is not supported" );
    }

    GL_UTILS::SetSwapInterval( -1 );

    m_cachedManager = new VERTEX_MANAGER( true );
    m_nonCachedManager = new VERTEX_MANAGER( false );
    m_overlayManager = new VERTEX_MANAGER( false );

    // Make VBOs use shaders
    m_cachedManager->SetShader( *m_shader );
    m_nonCachedManager->SetShader( *m_shader );
    m_overlayManager->SetShader( *m_shader );

    m_isInitialized = true;
}

References enableGlDebug(), KIGFX::BUILTIN_FONT::font_image, KIGFX::BUILTIN_FONT::FONT_IMAGE_TYPE::height, KIGFX::SHADER::IsLinked(), KIGFX::BUILTIN_SHADERS::kicad_fragment_shader, KIGFX::BUILTIN_SHADERS::kicad_vertex_shader, KIGFX::SHADER::Link(), KIGFX::SHADER::LoadShaderFromStrings(), m_cachedManager, m_glMainContext, m_glPrivContext, m_isContextLocked, m_isInitialized, m_nonCachedManager, m_overlayManager, m_shader, m_tesselator, KIGFX::VERTEX_MANAGER::SetShader(), GL_UTILS::SetSwapInterval(), KIGFX::SHADER_TYPE_FRAGMENT, KIGFX::SHADER_TYPE_VERTEX, and KIGFX::BUILTIN_FONT::FONT_IMAGE_TYPE::width.

Referenced by beginDrawing(), beginUpdate(), and CheckFeatures().

IsCairoEngine()

virtual bool KIGFX::GAL::IsCairoEngine ( )

inlinevirtualinherited

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

Reimplemented in KIGFX::CAIRO_GAL_BASE.

Definition at line 80 of file graphics_abstraction_layer.h.

{ return false; }

Referenced by getShadowLayer().

IsContextLocked()

bool KIGFX::OPENGL_GAL::IsContextLocked ( )

inlineoverridevirtual

Parameters passed to the GLU tesselator.

Reimplemented from KIGFX::GAL.

Definition at line 287 of file opengl_gal.h.

References m_isContextLocked.

IsCursorEnabled()

bool KIGFX::GAL::IsCursorEnabled ( ) const

inlineinherited

Return information about cursor visibility.

Returns

True if cursor is visible.

Definition at line 1030 of file graphics_abstraction_layer.h.

    {
        return m_isCursorEnabled || m_forceDisplayCursor;
    }

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

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

IsFlippedX()

bool KIGFX::GAL::IsFlippedX ( ) const

inlineinherited

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

Definition at line 762 of file graphics_abstraction_layer.h.

    {
        return m_globalFlipX;
    }

References KIGFX::GAL::m_globalFlipX.

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

inlineinherited

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

Definition at line 770 of file graphics_abstraction_layer.h.

    {
        return m_globalFlipY;