KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SYMBOL_PREVIEW_WIDGET Class Reference

#include <symbol_preview_widget.h>

Inheritance diagram for SYMBOL_PREVIEW_WIDGET:
SYMBOL_DIFF_WIDGET

Public Member Functions

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

Protected Member Functions

void onSize (wxSizeEvent &aEvent)
 
void fitOnDrawArea ()
 

Protected Attributes

KIWAY * m_kiway
 
GAL_DISPLAY_OPTIONS_IMPL 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.
 
BOX2I m_itemBBox
 The bounding box of the current item.
 

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,
bool  aIncludeStatus,
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 38 of file symbol_preview_widget.cpp.

References DEFAULT_THEME, EDA_DRAW_PANEL_GAL::GAL_FALLBACK, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, GetColorSettings(), PGM_BASE::GetCommonSettings(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::GetView(), LAYER_REFERENCEPART, SCH_RENDER_SETTINGS::LoadColors(), APP_SETTINGS_BASE::m_ColorTheme, KIGFX::GAL_DISPLAY_OPTIONS::m_forceDisplayCursor, m_galDisplayOptions, EESCHEMA_SETTINGS::m_LibViewPanel, m_outerSizer, m_preview, m_status, m_statusPanel, m_statusSizer, APP_SETTINGS_BASE::m_Window, onSize(), Pgm(), GAL_DISPLAY_OPTIONS_IMPL::ReadConfig(), KIGFX::GAL::SetAxesEnabled(), KIGFX::GAL::SetClearColor(), KIGFX::GAL::SetGridVisibility(), EDA_DRAW_PANEL_GAL::SetStealsFocus(), EESCHEMA_SETTINGS::PANEL_LIB_VIEW::show_pin_electrical_type, EESCHEMA_SETTINGS::PANEL_LIB_VIEW::show_pin_numbers, and KIGFX::COLOR4D::ToColour().

◆ ~SYMBOL_PREVIEW_WIDGET()

SYMBOL_PREVIEW_WIDGET::~SYMBOL_PREVIEW_WIDGET ( )
override

Definition at line 132 of file symbol_preview_widget.cpp.

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  aBodyStyle = 0 
)

Definition at line 262 of file symbol_preview_widget.cpp.

References KIGFX::VIEW::Add(), AUTOPLACE_AUTO, LIB_SYMBOL::AutoplaceFields(), fitOnDrawArea(), EDA_DRAW_PANEL_GAL::ForceRefresh(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), LIB_SYMBOL::GetUnitBoundingBox(), EDA_DRAW_PANEL_GAL::GetView(), LIB_SYMBOL::HasAlternateBodyStyle(), LIB_SYMBOL::IsMulti(), m_itemBBox, m_preview, m_previewItem, SCH_RENDER_SETTINGS::m_ShowUnit, m_statusPanel, KIGFX::VIEW::Remove(), SYMBOL::SetPreviewBodyStyle(), and SYMBOL::SetPreviewUnit().

Referenced by DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_RESCUE_EACH::displayItemsInConflict(), and DIALOG_PIN_PROPERTIES::OnPropertiesChange().

◆ DisplaySymbol()

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

Set the currently displayed symbol.

Definition at line 188 of file symbol_preview_widget.cpp.

References _, KIGFX::VIEW::Add(), AUTOPLACE_AUTO, LIB_SYMBOL::AutoplaceFields(), 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::HasAlternateBodyStyle(), LIB_SYMBOL::IsMulti(), SYMBOL_LIB_TABLE::LoadSymbol(), m_itemBBox, m_kiway, m_preview, m_previewItem, m_statusPanel, KIWAY::Prj(), KIGFX::VIEW::Remove(), PROJECT_SCH::SchSymbolLibTable(), SYMBOL::SetPreviewBodyStyle(), SYMBOL::SetPreviewUnit(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by PANEL_SYMBOL_CHOOSER::onSymbolSelected(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::ShowPreview().

◆ fitOnDrawArea()

void SYMBOL_PREVIEW_WIDGET::fitOnDrawArea ( )
protected

Definition at line 164 of file symbol_preview_widget.cpp.

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(), ToVECTOR2D(), KIGFX::VIEW::ToWorld(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SYMBOL_DIFF_WIDGET::DisplayDiff(), DisplayPart(), DisplaySymbol(), and onSize().

◆ onSize()

void SYMBOL_PREVIEW_WIDGET::onSize ( wxSizeEvent &  aEvent)
protected

Definition at line 152 of file symbol_preview_widget.cpp.

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 141 of file symbol_preview_widget.cpp.

References m_preview, m_status, and m_statusPanel.

Referenced by PANEL_SYMBOL_CHOOSER::onSymbolSelected().

Member Data Documentation

◆ m_galDisplayOptions

GAL_DISPLAY_OPTIONS_IMPL SYMBOL_PREVIEW_WIDGET::m_galDisplayOptions
protected

Definition at line 70 of file symbol_preview_widget.h.

Referenced by SYMBOL_PREVIEW_WIDGET().

◆ m_itemBBox

BOX2I SYMBOL_PREVIEW_WIDGET::m_itemBBox
protected

The bounding box of the current item.

Definition at line 84 of file symbol_preview_widget.h.

Referenced by SYMBOL_DIFF_WIDGET::DisplayDiff(), DisplayPart(), DisplaySymbol(), and fitOnDrawArea().

◆ m_kiway

KIWAY* SYMBOL_PREVIEW_WIDGET::m_kiway
protected

Definition at line 68 of file symbol_preview_widget.h.

Referenced by DisplaySymbol().

◆ m_outerSizer

wxSizer* SYMBOL_PREVIEW_WIDGET::m_outerSizer
protected

Definition at line 76 of file symbol_preview_widget.h.

Referenced by SYMBOL_DIFF_WIDGET::SYMBOL_DIFF_WIDGET(), and SYMBOL_PREVIEW_WIDGET().

◆ m_preview

EDA_DRAW_PANEL_GAL* SYMBOL_PREVIEW_WIDGET::m_preview
protected

Definition at line 71 of file symbol_preview_widget.h.

Referenced by SYMBOL_DIFF_WIDGET::DisplayDiff(), DisplayPart(), DisplaySymbol(), fitOnDrawArea(), onSize(), SYMBOL_DIFF_WIDGET::onSlider(), SetStatusText(), SYMBOL_PREVIEW_WIDGET(), and ~SYMBOL_PREVIEW_WIDGET().

◆ m_previewItem

LIB_SYMBOL* SYMBOL_PREVIEW_WIDGET::m_previewItem
protected

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

Definition at line 81 of file symbol_preview_widget.h.

Referenced by SYMBOL_DIFF_WIDGET::DisplayDiff(), DisplayPart(), DisplaySymbol(), fitOnDrawArea(), onSize(), SYMBOL_DIFF_WIDGET::onSlider(), and ~SYMBOL_PREVIEW_WIDGET().

◆ m_status

wxStaticText* SYMBOL_PREVIEW_WIDGET::m_status
protected

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
protected

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
protected

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: