SYMBOL_PREVIEW_WIDGET Class Reference

#include <symbol_preview_widget.h>

Inheritance diagram for SYMBOL_PREVIEW_WIDGET:

Public Member Functions
	SYMBOL_PREVIEW_WIDGET (wxWindow *aParent, KIWAY &aKiway, EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
	Construct a symbol preview widget. More...
	~SYMBOL_PREVIEW_WIDGET () override
void	SetStatusText (const wxString &aText)
	Set the contents of the status label and display it. More...
void	DisplaySymbol (const LIB_ID &aSymbolID, int aUnit, int aConvert=0)
	Set the currently displayed symbol. More...
void	DisplayPart (LIB_SYMBOL *aSymbol, int aUnit, int aConvert=0)

Private Member Functions
void	onSize (wxSizeEvent &aEvent)
void	fitOnDrawArea ()

Private Attributes
KIWAY &	m_kiway
KIGFX::GAL_DISPLAY_OPTIONS	m_galDisplayOptions
EDA_DRAW_PANEL_GAL *	m_preview
wxStaticText *	m_status
wxPanel *	m_statusPanel
wxSizer *	m_statusSizer
wxSizer *	m_outerSizer
LIB_SYMBOL *	m_previewItem
	A local copy of the LIB_SYMBOL to display on the canvas. More...
BOX2I	m_itemBBox
	The bounding box of the current item. More...

Detailed Description

Definition at line 35 of file symbol_preview_widget.h.

Constructor & Destructor Documentation

SYMBOL_PREVIEW_WIDGET()

SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET	(	wxWindow *	aParent,
		KIWAY &	aKiway,
		EDA_DRAW_PANEL_GAL::GAL_TYPE	aCanvasType
	)

Construct a symbol preview widget.

Parameters

aParent	- parent window
aKiway	- an active Kiway instance
aCanvasType	= the type of canvas (GAL_TYPE_OPENGL or GAL_TYPE_CAIRO only)

Definition at line 34 of file symbol_preview_widget.cpp.

                                                                                       :
    wxPanel( aParent, wxID_ANY, wxDefaultPosition, wxDefaultSize, 0 ),
    m_kiway( aKiway ),
    m_preview( nullptr ), m_status( nullptr ), m_statusSizer( nullptr ), m_previewItem( nullptr )
{
    auto common_settings = Pgm().GetCommonSettings();
    auto app_settings = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();

    m_galDisplayOptions.ReadConfig( *common_settings, app_settings->m_Window, this );
    m_galDisplayOptions.m_forceDisplayCursor = false;

    EDA_DRAW_PANEL_GAL::GAL_TYPE canvasType = aCanvasType;

    // Allows only a CAIRO or OPENGL canvas:
    if( canvasType != EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL
            && canvasType != EDA_DRAW_PANEL_GAL::GAL_FALLBACK )
    {
        canvasType = EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL;
    }

    m_preview = new SCH_PREVIEW_PANEL( aParent, wxID_ANY, wxDefaultPosition, wxSize( -1, -1 ),
                                       m_galDisplayOptions, canvasType );
    m_preview->SetStealsFocus( false );
    m_preview->ShowScrollbars( wxSHOW_SB_NEVER, wxSHOW_SB_NEVER );
    m_preview->GetGAL()->SetAxesEnabled( false );

    // Do not display the grid: the look is not good for a small canvas area.
    // But mainly, due to some strange bug I (JPC) was unable to fix, the grid creates
    // strange artifacts on Windows when Eeschema is run from KiCad manager (but not in
    // stand alone...).
    m_preview->GetGAL()->SetGridVisibility( false );

    // Early initialization of the canvas background color,
    // before any OnPaint event is fired for the canvas using a wrong bg color
    KIGFX::VIEW* view = m_preview->GetView();
    auto settings = static_cast<KIGFX::SCH_RENDER_SETTINGS*>( view->GetPainter()->GetSettings() );

    if( auto* theme = Pgm().GetSettingsManager().GetColorSettings( app_settings->m_ColorTheme ) )
        settings->LoadColors( theme );

    const COLOR4D& backgroundColor = settings->GetBackgroundColor();
    const COLOR4D& foregroundColor = settings->GetCursorColor();

    m_preview->GetGAL()->SetClearColor( backgroundColor );

    m_statusPanel = new wxPanel( this );
    m_statusPanel->SetBackgroundColour( backgroundColor.ToColour() );
    m_status = new wxStaticText( m_statusPanel, wxID_ANY, wxEmptyString );
    m_status->SetForegroundColour( settings->GetLayerColor( LAYER_REFERENCEPART ).ToColour() );
    m_statusSizer = new wxBoxSizer( wxVERTICAL );
    m_statusSizer->Add( 0, 0, 1 );  // add a spacer
    m_statusSizer->Add( m_status, 0, wxALIGN_CENTER );
    m_statusSizer->Add( 0, 0, 1 );  // add a spacer
    m_statusPanel->SetSizer( m_statusSizer );

    // Give the status panel the same color scheme as the canvas so it isn't jarring when
    // switched to.
    m_statusPanel->SetBackgroundColour( backgroundColor.ToColour() );
    m_statusPanel->SetForegroundColour( foregroundColor.ToColour() );

    // Give the preview panel a small top border to align its top with the status panel,
    // and give the status panel a small bottom border to align its bottom with the preview
    // panel.
    m_outerSizer = new wxBoxSizer( wxVERTICAL );
    m_outerSizer->Add( m_preview, 1, wxTOP | wxEXPAND, 5 );
    m_outerSizer->Add( m_statusPanel, 1, wxBOTTOM | wxEXPAND, 5 );

    // Hide the status panel to start
    m_statusPanel->Hide();

    SetSizer( m_outerSizer );
    Layout();

    Connect( wxEVT_SIZE, wxSizeEventHandler( SYMBOL_PREVIEW_WIDGET::onSize ), nullptr, this );
}

References EDA_DRAW_PANEL_GAL::GAL_FALLBACK, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::GetView(), LAYER_REFERENCEPART, KIGFX::GAL_DISPLAY_OPTIONS::m_forceDisplayCursor, m_galDisplayOptions, m_outerSizer, m_preview, m_status, m_statusPanel, m_statusSizer, onSize(), Pgm(), KIGFX::GAL_DISPLAY_OPTIONS::ReadConfig(), KIGFX::GAL::SetAxesEnabled(), KIGFX::GAL::SetClearColor(), KIGFX::GAL::SetGridVisibility(), and EDA_DRAW_PANEL_GAL::SetStealsFocus().

~SYMBOL_PREVIEW_WIDGET()

SYMBOL_PREVIEW_WIDGET::~SYMBOL_PREVIEW_WIDGET ( )

override

Definition at line 112 of file symbol_preview_widget.cpp.

{
    if( m_previewItem )
        m_preview->GetView()->Remove( m_previewItem );

    delete m_previewItem;
}

References EDA_DRAW_PANEL_GAL::GetView(), m_preview, m_previewItem, and KIGFX::VIEW::Remove().

Member Function Documentation

DisplayPart()

void SYMBOL_PREVIEW_WIDGET::DisplayPart	(	LIB_SYMBOL *	aSymbol,
		int	aUnit,
		int	aConvert = 0
	)

Definition at line 228 of file symbol_preview_widget.cpp.

{
    KIGFX::VIEW* view = m_preview->GetView();

    if( m_previewItem )
    {
        view->Remove( m_previewItem );
        delete m_previewItem;
        m_previewItem = nullptr;
    }

    if( aSymbol )
    {
        m_previewItem = new LIB_SYMBOL( *aSymbol );

        // For symbols having a De Morgan body style, use the first style
        auto settings =
                static_cast<KIGFX::SCH_RENDER_SETTINGS*>( view->GetPainter()->GetSettings() );

        // If unit isn't specified for a multi-unit part, pick the first.  (Otherwise we'll
        // draw all of them.)
        settings->m_ShowUnit = ( m_previewItem->IsMulti() && aUnit == 0 ) ? 1 : aUnit;

        settings->m_ShowConvert =
                ( m_previewItem->HasConversion() && aConvert == 0 ) ? 1 : aConvert;

        view->Add( m_previewItem );

        // Get the symbol size, in internal units
        m_itemBBox = aSymbol->GetUnitBoundingBox( settings->m_ShowUnit, settings->m_ShowConvert );

        // Calculate the draw scale to fit the drawing area
        fitOnDrawArea();
    }

    m_preview->ForceRefresh();
    m_preview->Show();
    m_statusPanel->Hide();
    Layout();
}

References KIGFX::VIEW::Add(), fitOnDrawArea(), EDA_DRAW_PANEL_GAL::ForceRefresh(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), LIB_SYMBOL::GetUnitBoundingBox(), EDA_DRAW_PANEL_GAL::GetView(), LIB_SYMBOL::HasConversion(), LIB_SYMBOL::IsMulti(), m_itemBBox, m_preview, m_previewItem, m_statusPanel, and KIGFX::VIEW::Remove().

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().

DisplaySymbol()

void SYMBOL_PREVIEW_WIDGET::DisplaySymbol	(	const LIB_ID &	aSymbolID,
		int	aUnit,
		int	aConvert = 0
	)

Set the currently displayed symbol.

Definition at line 166 of file symbol_preview_widget.cpp.

{
    KIGFX::VIEW* view = m_preview->GetView();
    auto settings = static_cast<KIGFX::SCH_RENDER_SETTINGS*>( view->GetPainter()->GetSettings() );
    std::unique_ptr< LIB_SYMBOL > symbol;

    try
    {
        LIB_SYMBOL* tmp = m_kiway.Prj().SchSymbolLibTable()->LoadSymbol( aSymbolID );

        if( tmp )
            symbol = tmp->Flatten();
    }
    catch( const IO_ERROR& ioe )
    {
        wxLogError( _( "Error loading symbol %s from library '%s'." ) + wxS( "\n%s" ),
                    aSymbolID.GetLibItemName().wx_str(),
                    aSymbolID.GetLibNickname().wx_str(),
                    ioe.What() );
    }

    if( m_previewItem )
    {
        view->Remove( m_previewItem );
        delete m_previewItem;
        m_previewItem = nullptr;
    }

    if( symbol )
    {
        // This will flatten derived parts so that the correct final symbol can be shown.
        m_previewItem = symbol.release();

        // If unit isn't specified for a multi-unit part, pick the first.  (Otherwise we'll
        // draw all of them.)
        settings->m_ShowUnit = ( m_previewItem->IsMulti() && aUnit == 0 ) ? 1 : aUnit;

        // For symbols having a De Morgan body style, use the first style
        settings->m_ShowConvert =
                ( m_previewItem->HasConversion() && aConvert == 0 ) ? 1 : aConvert;

        view->Add( m_previewItem );

        // Get the symbol size, in internal units
        m_itemBBox = m_previewItem->GetUnitBoundingBox( settings->m_ShowUnit,
                                                        settings->m_ShowConvert );

        if( !m_preview->IsShown() )
        {
            m_preview->Show();
            m_statusPanel->Hide();
            Layout();   // Ensure panel size is up to date.
        }

        // Calculate the draw scale to fit the drawing area
        fitOnDrawArea();
    }

    m_preview->ForceRefresh();
}

References _, KIGFX::VIEW::Add(), fitOnDrawArea(), LIB_SYMBOL::Flatten(), EDA_DRAW_PANEL_GAL::ForceRefresh(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), LIB_SYMBOL::GetUnitBoundingBox(), EDA_DRAW_PANEL_GAL::GetView(), LIB_SYMBOL::HasConversion(), LIB_SYMBOL::IsMulti(), m_itemBBox, m_kiway, m_preview, m_previewItem, m_statusPanel, KIWAY::Prj(), KIGFX::VIEW::Remove(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by DIALOG_CHOOSE_SYMBOL::OnComponentPreselected().

fitOnDrawArea()

void SYMBOL_PREVIEW_WIDGET::fitOnDrawArea ( )

private

Definition at line 142 of file symbol_preview_widget.cpp.

{
    if( !m_previewItem )
        return;

    // set the view scale to fit the item on screen
    KIGFX::VIEW* view = m_preview->GetView();

    // Calculate the drawing area size, in internal units, for a scaling factor = 1.0
    view->SetScale( 1.0 );
    VECTOR2D  clientSize = view->ToWorld( m_preview->GetClientSize(), false );
    // Calculate the draw scale to fit the drawing area
    double    scale = std::min( fabs( clientSize.x / m_itemBBox.GetWidth() ),
                                fabs( clientSize.y / m_itemBBox.GetHeight() ) );

    // Above calculation will yield an exact fit; add a bit of whitespace around symbol
    scale /= 1.2;

    // Now fix the best scale
    view->SetScale( scale );
    view->SetCenter( m_itemBBox.Centre() );
}

References BOX2< Vec >::Centre(), BOX2< Vec >::GetHeight(), EDA_DRAW_PANEL_GAL::GetView(), BOX2< Vec >::GetWidth(), m_itemBBox, m_preview, m_previewItem, scale, KIGFX::VIEW::SetCenter(), KIGFX::VIEW::SetScale(), KIGFX::VIEW::ToWorld(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DisplayPart(), DisplaySymbol(), and onSize().

onSize()

void SYMBOL_PREVIEW_WIDGET::onSize ( wxSizeEvent &  aEvent )

private

Definition at line 130 of file symbol_preview_widget.cpp.

{
    if( m_previewItem )
    {
        fitOnDrawArea();
        m_preview->ForceRefresh();
    }

    aEvent.Skip();
}

References fitOnDrawArea(), EDA_DRAW_PANEL_GAL::ForceRefresh(), m_preview, and m_previewItem.

Referenced by SYMBOL_PREVIEW_WIDGET().

SetStatusText()

void SYMBOL_PREVIEW_WIDGET::SetStatusText

(

const wxString &

aText

)

Set the contents of the status label and display it.

Definition at line 121 of file symbol_preview_widget.cpp.

{
    m_status->SetLabel( aText );
    m_preview->Hide();
    m_statusPanel->Show();
    Layout();
}

References m_preview, m_status, and m_statusPanel.

Referenced by DIALOG_CHOOSE_SYMBOL::OnComponentPreselected().

Member Data Documentation

m_galDisplayOptions

KIGFX::GAL_DISPLAY_OPTIONS SYMBOL_PREVIEW_WIDGET::m_galDisplayOptions

private

Definition at line 70 of file symbol_preview_widget.h.

Referenced by SYMBOL_PREVIEW_WIDGET().

m_itemBBox

BOX2I SYMBOL_PREVIEW_WIDGET::m_itemBBox

private

The bounding box of the current item.

Definition at line 84 of file symbol_preview_widget.h.

Referenced by DisplayPart(), DisplaySymbol(), and fitOnDrawArea().

m_kiway

KIWAY& SYMBOL_PREVIEW_WIDGET::m_kiway

private

Definition at line 68 of file symbol_preview_widget.h.

Referenced by DisplaySymbol().

m_outerSizer

wxSizer* SYMBOL_PREVIEW_WIDGET::m_outerSizer

private

Definition at line 76 of file symbol_preview_widget.h.

Referenced by SYMBOL_PREVIEW_WIDGET().

m_preview

EDA_DRAW_PANEL_GAL* SYMBOL_PREVIEW_WIDGET::m_preview

private

Definition at line 71 of file symbol_preview_widget.h.

Referenced by DisplayPart(), DisplaySymbol(), fitOnDrawArea(), onSize(), SetStatusText(), SYMBOL_PREVIEW_WIDGET(), and ~SYMBOL_PREVIEW_WIDGET().

m_previewItem

LIB_SYMBOL* SYMBOL_PREVIEW_WIDGET::m_previewItem

private

A local copy of the LIB_SYMBOL to display on the canvas.

Definition at line 81 of file symbol_preview_widget.h.

Referenced by DisplayPart(), DisplaySymbol(), fitOnDrawArea(), onSize(), and ~SYMBOL_PREVIEW_WIDGET().

m_status

wxStaticText* SYMBOL_PREVIEW_WIDGET::m_status

private

Definition at line 73 of file symbol_preview_widget.h.

Referenced by SetStatusText(), and SYMBOL_PREVIEW_WIDGET().

m_statusPanel

wxPanel* SYMBOL_PREVIEW_WIDGET::m_statusPanel

private

Definition at line 74 of file symbol_preview_widget.h.

Referenced by DisplayPart(), DisplaySymbol(), SetStatusText(), and SYMBOL_PREVIEW_WIDGET().

m_statusSizer

wxSizer* SYMBOL_PREVIEW_WIDGET::m_statusSizer

private

Definition at line 75 of file symbol_preview_widget.h.

Referenced by SYMBOL_PREVIEW_WIDGET().

---

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

• symbol_preview_widget.h
• symbol_preview_widget.cpp