FOOTPRINT_DIFF_WIDGET Class Reference

#include <footprint_diff_widget.h>

Inheritance diagram for FOOTPRINT_DIFF_WIDGET:

Public Member Functions
	FOOTPRINT_DIFF_WIDGET (wxWindow *aParent, KIWAY &aKiway)
	Construct a footprint diff widget, consisting on a canvas for displaying a board and a library footprint, and a slider for fading between the two.
void	DisplayDiff (FOOTPRINT *aBoardFootprint, std::shared_ptr< FOOTPRINT > &aLibFootprint)
	Set the currently displayed symbol.
bool	IsInitialized () const
	Return whether the widget initialized properly.
void	SetStatusText (const wxString &aText)
	Set the contents of the status label and display it.
void	ClearStatus ()
	Clear the contents of the status label and hide it.
void	SetUserUnits (EDA_UNITS aUnits)
	Set the units for the preview.
void	SetPinFunctions (const std::map< wxString, wxString > &aPinFunctions)
	Set the pin functions from the symbol's netlist.
void	DisplayFootprint (const LIB_ID &aFPID)
	Set the currently displayed footprint.
void	DisplayFootprints (std::shared_ptr< FOOTPRINT > aFootprintA, std::shared_ptr< FOOTPRINT > aFootprintB)
	Display a pair of footprints.
void	RefreshAll ()
	Force the redrawing of all contents.
FOOTPRINT_PREVIEW_PANEL_BASE *	GetPreviewPanel ()

Protected Attributes
FOOTPRINT_PREVIEW_PANEL_BASE *	m_prev_panel
wxStaticText *	m_status
wxPanel *	m_statusPanel
wxSizer *	m_statusSizer
wxSizer *	m_outerSizer
LIB_ID	m_libid

Private Member Functions
void	onSlider (wxScrollEvent &aEvent)

Private Attributes
std::shared_ptr< FOOTPRINT >	m_boardItemCopy
std::shared_ptr< FOOTPRINT >	m_libraryItem
wxSlider *	m_slider

Detailed Description

Definition at line 30 of file footprint_diff_widget.h.

Constructor & Destructor Documentation

FOOTPRINT_DIFF_WIDGET()

FOOTPRINT_DIFF_WIDGET::FOOTPRINT_DIFF_WIDGET	(	wxWindow *	aParent,
		KIWAY &	aKiway
	)

Construct a footprint diff widget, consisting on a canvas for displaying a board and a library footprint, and a slider for fading between the two.

Parameters

aParent	- parent window
aKiway	- an active Kiway instance

Definition at line 29 of file footprint_diff_widget.cpp.

References _, FOOTPRINT_PREVIEW_WIDGET::m_outerSizer, m_slider, and onSlider().

Member Function Documentation

ClearStatus()

void FOOTPRINT_PREVIEW_WIDGET::ClearStatus ( )

inherited

Clear the contents of the status label and hide it.

Definition at line 80 of file footprint_preview_widget.cpp.

References FOOTPRINT_PREVIEW_PANEL_BASE::GetWindow(), FOOTPRINT_PREVIEW_WIDGET::m_prev_panel, FOOTPRINT_PREVIEW_WIDGET::m_status, and FOOTPRINT_PREVIEW_WIDGET::m_statusPanel.

Referenced by FOOTPRINT_PREVIEW_WIDGET::DisplayFootprint(), FOOTPRINT_PREVIEW_WIDGET::DisplayFootprints(), PANEL_FOOTPRINT_CHOOSER::onFootprintSelected(), and PANEL_SYMBOL_CHOOSER::showFootprint().

DisplayDiff()

void FOOTPRINT_DIFF_WIDGET::DisplayDiff	(	FOOTPRINT *	aBoardFootprint,
		std::shared_ptr< FOOTPRINT > &	aLibFootprint
	)

Set the currently displayed symbol.

Definition at line 60 of file footprint_diff_widget.cpp.

References ANGLE_0, EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearSelected(), FOOTPRINT::Clone(), FOOTPRINT_PREVIEW_WIDGET::DisplayFootprints(), dummy, m_boardItemCopy, m_libraryItem, and onSlider().

Referenced by BOARD_INSPECTION_TOOL::DiffFootprint().

DisplayFootprint()

void FOOTPRINT_PREVIEW_WIDGET::DisplayFootprint ( const LIB_ID &  aFPID )

inherited

Set the currently displayed footprint.

Any footprint passed in here MUST have been passed to CacheFootprint before.

Definition at line 101 of file footprint_preview_widget.cpp.

References _, LIB_ID::clear(), FOOTPRINT_PREVIEW_WIDGET::ClearStatus(), FOOTPRINT_PREVIEW_PANEL_BASE::DisplayFootprint(), FOOTPRINT_PREVIEW_WIDGET::m_libid, FOOTPRINT_PREVIEW_WIDGET::m_prev_panel, and FOOTPRINT_PREVIEW_WIDGET::SetStatusText().

Referenced by PANEL_FOOTPRINT_CHOOSER::onFootprintSelected(), and PANEL_SYMBOL_CHOOSER::showFootprint().

DisplayFootprints()

void FOOTPRINT_PREVIEW_WIDGET::DisplayFootprints ( std::shared_ptr< FOOTPRINT >  aFootprintA, std::shared_ptr< FOOTPRINT >  aFootprintB  )

inherited

Display a pair of footprints.

(Normally used for diff'ing.)

Definition at line 121 of file footprint_preview_widget.cpp.

References FOOTPRINT_PREVIEW_WIDGET::ClearStatus(), FOOTPRINT_PREVIEW_PANEL_BASE::DisplayFootprints(), and FOOTPRINT_PREVIEW_WIDGET::m_prev_panel.

Referenced by DisplayDiff().

GetPreviewPanel()

FOOTPRINT_PREVIEW_PANEL_BASE * FOOTPRINT_PREVIEW_WIDGET::GetPreviewPanel ( )

inlineinherited

Definition at line 95 of file footprint_preview_widget.h.

References FOOTPRINT_PREVIEW_WIDGET::m_prev_panel.

Referenced by PANEL_FOOTPRINT_CHOOSER::onFootprintSelected().

IsInitialized()

bool FOOTPRINT_PREVIEW_WIDGET::IsInitialized ( ) const

inlineinherited

Return whether the widget initialized properly.

This could return false if Kiway is not available. If this returns false, no other methods should be called.

Definition at line 54 of file footprint_preview_widget.h.

References FOOTPRINT_PREVIEW_WIDGET::m_prev_panel.

Referenced by PANEL_SYMBOL_CHOOSER::FinishSetup(), PANEL_FOOTPRINT_CHOOSER::onFootprintSelected(), PANEL_SYMBOL_CHOOSER::onSymbolSelected(), PANEL_SYMBOL_CHOOSER::showFootprint(), and PANEL_SYMBOL_CHOOSER::showFootprintFor().

onSlider()

void FOOTPRINT_DIFF_WIDGET::onSlider ( wxScrollEvent &  aEvent )

private

Definition at line 91 of file footprint_diff_widget.cpp.

References m_boardItemCopy, m_libraryItem, m_slider, FOOTPRINT_PREVIEW_WIDGET::RefreshAll(), and KIGFX::VIEW_ITEM::SetForcedTransparency().

Referenced by DisplayDiff(), and FOOTPRINT_DIFF_WIDGET().

RefreshAll()

void FOOTPRINT_PREVIEW_WIDGET::RefreshAll ( )

inherited

Force the redrawing of all contents.

Definition at line 129 of file footprint_preview_widget.cpp.

References FOOTPRINT_PREVIEW_WIDGET::m_prev_panel, and FOOTPRINT_PREVIEW_PANEL_BASE::RefreshAll().

Referenced by onSlider().

SetPinFunctions()

void FOOTPRINT_PREVIEW_WIDGET::SetPinFunctions ( const std::map< wxString, wxString > &  aPinFunctions )

inherited

Set the pin functions from the symbol's netlist.

This allows us to display them in the corresponding pads.

Parameters

aPinFunctions

a map from pin_number to pin_function

Definition at line 95 of file footprint_preview_widget.cpp.

References FOOTPRINT_PREVIEW_WIDGET::m_prev_panel, and FOOTPRINT_PREVIEW_PANEL_BASE::SetPinFunctions().

Referenced by FOOTPRINT_CHOOSER_FRAME::KiwayMailIn().

SetStatusText()

void FOOTPRINT_PREVIEW_WIDGET::SetStatusText ( const wxString &  aText )

inherited

Set the contents of the status label and display it.

Definition at line 71 of file footprint_preview_widget.cpp.

References FOOTPRINT_PREVIEW_PANEL_BASE::GetWindow(), FOOTPRINT_PREVIEW_WIDGET::m_prev_panel, FOOTPRINT_PREVIEW_WIDGET::m_status, and FOOTPRINT_PREVIEW_WIDGET::m_statusPanel.

Referenced by FOOTPRINT_PREVIEW_WIDGET::DisplayFootprint(), PANEL_SYMBOL_CHOOSER::FinishSetup(), FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET(), PANEL_FOOTPRINT_CHOOSER::onFootprintSelected(), PANEL_SYMBOL_CHOOSER::onSymbolSelected(), and PANEL_SYMBOL_CHOOSER::showFootprint().

SetUserUnits()

void FOOTPRINT_PREVIEW_WIDGET::SetUserUnits ( EDA_UNITS  aUnits )

inherited

Set the units for the preview.

Definition at line 89 of file footprint_preview_widget.cpp.

References FOOTPRINT_PREVIEW_WIDGET::m_prev_panel, and FOOTPRINT_PREVIEW_PANEL_BASE::SetUserUnits().

Referenced by PANEL_SYMBOL_CHOOSER::constructRightPanel(), and PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER().

Member Data Documentation

m_boardItemCopy

std::shared_ptr<FOOTPRINT> FOOTPRINT_DIFF_WIDGET::m_boardItemCopy

private

Definition at line 51 of file footprint_diff_widget.h.

Referenced by DisplayDiff(), and onSlider().

m_libid

LIB_ID FOOTPRINT_PREVIEW_WIDGET::m_libid

protectedinherited

Definition at line 104 of file footprint_preview_widget.h.

Referenced by FOOTPRINT_PREVIEW_WIDGET::DisplayFootprint().

m_libraryItem

std::shared_ptr<FOOTPRINT> FOOTPRINT_DIFF_WIDGET::m_libraryItem

private

Definition at line 52 of file footprint_diff_widget.h.

Referenced by DisplayDiff(), and onSlider().

m_outerSizer

wxSizer* FOOTPRINT_PREVIEW_WIDGET::m_outerSizer

protectedinherited

Definition at line 103 of file footprint_preview_widget.h.

Referenced by FOOTPRINT_DIFF_WIDGET(), and FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET().

m_prev_panel

FOOTPRINT_PREVIEW_PANEL_BASE* FOOTPRINT_PREVIEW_WIDGET::m_prev_panel

protectedinherited

Definition at line 98 of file footprint_preview_widget.h.

Referenced by FOOTPRINT_PREVIEW_WIDGET::ClearStatus(), FOOTPRINT_PREVIEW_WIDGET::DisplayFootprint(), FOOTPRINT_PREVIEW_WIDGET::DisplayFootprints(), FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET(), FOOTPRINT_PREVIEW_WIDGET::GetPreviewPanel(), FOOTPRINT_PREVIEW_WIDGET::IsInitialized(), FOOTPRINT_PREVIEW_WIDGET::RefreshAll(), FOOTPRINT_PREVIEW_WIDGET::SetPinFunctions(), FOOTPRINT_PREVIEW_WIDGET::SetStatusText(), and FOOTPRINT_PREVIEW_WIDGET::SetUserUnits().

m_slider

wxSlider* FOOTPRINT_DIFF_WIDGET::m_slider

private

Definition at line 53 of file footprint_diff_widget.h.

Referenced by FOOTPRINT_DIFF_WIDGET(), and onSlider().

m_status

wxStaticText* FOOTPRINT_PREVIEW_WIDGET::m_status

protectedinherited

Definition at line 100 of file footprint_preview_widget.h.

Referenced by FOOTPRINT_PREVIEW_WIDGET::ClearStatus(), FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET(), and FOOTPRINT_PREVIEW_WIDGET::SetStatusText().

m_statusPanel

wxPanel* FOOTPRINT_PREVIEW_WIDGET::m_statusPanel

protectedinherited

Definition at line 101 of file footprint_preview_widget.h.

Referenced by FOOTPRINT_PREVIEW_WIDGET::ClearStatus(), FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET(), and FOOTPRINT_PREVIEW_WIDGET::SetStatusText().

m_statusSizer

wxSizer* FOOTPRINT_PREVIEW_WIDGET::m_statusSizer

protectedinherited

Definition at line 102 of file footprint_preview_widget.h.

Referenced by FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET().

---

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

• footprint_diff_widget.h
• footprint_diff_widget.cpp