KiCad PCB EDA Suite
GERBER_LAYER_WIDGET Class Reference

Class GERBER_LAYER_WIDGET is here to implement the abtract functions of LAYER_WIDGET so they may be tied into the GERBVIEW_FRAME's data and so we can add a popup menu which is specific to Pcbnew's needs. More...

#include <class_gerbview_layer_widget.h>

Inheritance diagram for GERBER_LAYER_WIDGET:
LAYER_WIDGET

Public Member Functions

 GERBER_LAYER_WIDGET (GERBVIEW_FRAME *aParent, wxWindow *aFocusOwner, int aPointSize=10)
 Constructor. More...
 
void ReFill ()
 
void ReFillRender ()
 Function ReFillRender Rebuild Render for instance after the config is read. More...
 
void OnLayerRightClick (wxMenu &aMenu) override
 Function OnLayerRightClick is called to notify client code about a layer being right-clicked. More...
 
void OnLayerColorChange (int aLayer, COLOR4D aColor) override
 Function OnLayerColorChange is called to notify client code about a layer color change. More...
 
bool OnLayerSelect (int aLayer) override
 Function OnLayerSelect is called to notify client code whenever the user selects a different layer. More...
 
void OnLayerVisible (int aLayer, bool isVisible, bool isFinal) override
 Function OnLayerVisible is called to notify client code about a layer visibility change. More...
 
void OnRenderColorChange (int aId, COLOR4D aColor) override
 Function OnRenderColorChange is called to notify client code whenever the user changes a rendering color. More...
 
void OnRenderEnable (int aId, bool isEnabled) override
 Function OnRenderEnable is called to notify client code whenever the user changes an rendering enable in one of the rendering checkboxes. More...
 
void SetLayersManagerTabsText ()
 Function SetLayersManagerTabsText Update the layer manager tabs labels Useful when changing Language or to set labels to a non default value. More...
 
bool OnLayerSelected ()
 Function OnLayerSelected ensure the active layer is visible, and other layers not visible when m_alwaysShowActiveLayer is true Otherwise do nothing. More...
 
void AddRightClickMenuItems (wxMenu &menu)
 Function addRightClickMenuItems add menu items to a menu that should be shown when right-clicking the Gerber layer widget. More...
 
wxSize GetBestSize () const
 Function GetBestSize returns the preferred minimum size, taking into consideration the dynamic content. More...
 
int GetLayerRowCount () const
 Function GetLayerRowCount returns the number of rows in the layer tab. More...
 
int GetRenderRowCount () const
 Function GetRenderRowCount returns the number of rows in the render tab. More...
 
void AppendLayerRow (const ROW &aRow)
 Function AppendLayerRow appends a new row in the layer portion of the widget. More...
 
void AppendLayerRows (const ROW *aRowsArray, int aRowCount)
 Function AppendLayerRows appends new rows in the layer portion of the widget. More...
 
void ClearLayerRows ()
 Function ClearLayerRows empties out the layer rows. More...
 
void AppendRenderRow (const ROW &aRow)
 Function AppendRenderRow appends a new row in the render portion of the widget. More...
 
void AppendRenderRows (const ROW *aRowsArray, int aRowCount)
 Function AppendRenderRows appends new rows in the render portion of the widget. More...
 
void ClearRenderRows ()
 Function ClearRenderRows empties out the render rows. More...
 
void SelectLayerRow (int aRow)
 Function SelectLayerRow changes the row selection in the layer list to the given row. More...
 
void SelectLayer (LAYER_NUM aLayer)
 Function SelectLayer changes the row selection in the layer list to aLayer provided. More...
 
LAYER_NUM GetSelectedLayer ()
 Function GetSelectedLayer returns the selected layer or -1 if none. More...
 
void SetLayerVisible (LAYER_NUM aLayer, bool isVisible)
 Function SetLayerVisible sets aLayer visible or not. More...
 
bool IsLayerVisible (LAYER_NUM aLayer)
 Function IsLayerVisible returns the visible state of the layer ROW associated with aLayer id. More...
 
void SetLayerColor (LAYER_NUM aLayer, COLOR4D aColor)
 Function SetLayerColor changes the color of aLayer. More...
 
COLOR4D GetLayerColor (LAYER_NUM aLayer) const
 Function GetLayerColor returns the color of the layer ROW associated with aLayer id. More...
 
void SetRenderState (int aId, bool isSet)
 Function SetRenderState sets the state of the checkbox associated with aId within the Render tab group of the widget. More...
 
bool GetRenderState (int aId)
 Function GetRenderState returns the state of the checkbox associated with aId. More...
 
void UpdateLayouts ()
 
void UpdateLayerIcons ()
 Function UpdateLayerIcons Update all layer manager icons (layers only) Useful when loading a file or clearing a layer because they change, and the indicator arrow icon needs to be updated. More...
 

Static Public Attributes

static const wxEventType EVT_LAYER_COLOR_CHANGE = wxNewEventType()
 

Protected Types

enum  LAYER_MANAGER {
  ID_LAYER_MANAGER_START = LAYER_WIDGET::ID_LAST_VALUE, ID_SHOW_ALL_LAYERS = ID_LAYER_MANAGER_START, ID_SHOW_NO_LAYERS, ID_SHOW_NO_LAYERS_BUT_ACTIVE,
  ID_ALWAYS_SHOW_NO_LAYERS_BUT_ACTIVE, ID_SORT_GBR_LAYERS, ID_LAYER_MANAGER_END = ID_SORT_GBR_LAYERS
}
 
enum  POPUP_ID { ID_CHANGE_LAYER_COLOR = wxID_HIGHEST, ID_CHANGE_RENDER_COLOR, ID_LAST_VALUE }
 

Protected Member Functions

void OnLeftDownLayers (wxMouseEvent &event)
 
void OnRightDownLayer (wxMouseEvent &event, COLOR_SWATCH *aColorSwatch, const wxString &aLayerName)
 Function OnRightDownLayer Called when user right-clicks a layer. More...
 
void OnLayerSwatchChanged (wxCommandEvent &aEvent)
 Function OnSwatchChanged() is called when a user changes a swatch color. More...
 
void OnLayerCheckBox (wxCommandEvent &event)
 Function OnLayerCheckBox handles the "is layer visible" checkbox and propogates the event to the client's notification function. More...
 
void OnRightDownRender (wxMouseEvent &aEvent, COLOR_SWATCH *aColorSwatch, const wxString &aRenderName)
 Function OnRightDownRender Called when user right-clicks a render option. More...
 
void OnRenderSwatchChanged (wxCommandEvent &aEvent)
 Function OnRenderSwatchChanged Called when user has changed the swatch color of a render entry. More...
 
void OnRenderCheckBox (wxCommandEvent &event)
 
void OnTabChange (wxNotebookEvent &event)
 
wxWindow * getLayerComp (int aRow, int aColumn) const
 Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL if these parameters are out of range. More...
 
wxWindow * getRenderComp (int aRow, int aColumn) const
 
int findLayerRow (LAYER_NUM aLayer) const
 Function findLayerRow returns the row index that aLayer resides in, or -1 if not found. More...
 
int findRenderRow (int aId) const
 
void insertLayerRow (int aRow, const ROW &aSpec)
 Function insertLayerRow appends or inserts a new row in the layer portion of the widget. More...
 
void insertRenderRow (int aRow, const ROW &aSpec)
 
void passOnFocus ()
 Function passOnFocus gives away the keyboard focus up to the main parent window. More...
 

Static Protected Member Functions

static int encodeId (int aColumn, int aId)
 Function encodeId is here to allow saving a layer index within a control as its wxControl id, but to do so in a way that all child wxControl ids within a wxWindow are unique, since this is required by Windows. More...
 
static LAYER_NUM getDecodedId (int aControlId)
 Function getDecodedId decodes aControlId to original un-encoded value. More...
 

Protected Attributes

wxAuiNotebook * m_notebook
 
wxPanel * m_LayerPanel
 
wxScrolledWindow * m_LayerScrolledWindow
 
wxFlexGridSizer * m_LayersFlexGridSizer
 
wxPanel * m_RenderingPanel
 
wxScrolledWindow * m_RenderScrolledWindow
 
wxFlexGridSizer * m_RenderFlexGridSizer
 
wxWindow * m_FocusOwner
 
int m_CurrentRow
 selected row of layer list More...
 
int m_PointSize
 

Private Member Functions

void onRightDownLayers (wxMouseEvent &event)
 Function OnRightDownLayers puts up a popup menu for the layer panel. More...
 
void onPopupSelection (wxCommandEvent &event)
 
void installRightLayerClickHandler ()
 this is for the popup menu, the right click handler has to be installed on every child control within the layer panel. More...
 
virtual bool useAlternateBitmap (int aRow) override
 Virtual Function useAlternateBitmap. More...
 
virtual bool AreArbitraryColorsAllowed () override
 Subclasses can override this to provide logic for allowing arbitrary color selection via wxColourPicker instead of DisplayColorFrame. More...
 
GERBER_FILE_IMAGE_LISTGetImagesList ()
 

Private Attributes

GERBVIEW_FRAMEmyframe
 
bool m_alwaysShowActiveLayer
 

Detailed Description

Class GERBER_LAYER_WIDGET is here to implement the abtract functions of LAYER_WIDGET so they may be tied into the GERBVIEW_FRAME's data and so we can add a popup menu which is specific to Pcbnew's needs.

Definition at line 42 of file class_gerbview_layer_widget.h.

Member Enumeration Documentation

enum LAYER_WIDGET::POPUP_ID
protectedinherited
Enumerator
ID_CHANGE_LAYER_COLOR 
ID_CHANGE_RENDER_COLOR 
ID_LAST_VALUE 

Definition at line 227 of file layer_widget.h.

Constructor & Destructor Documentation

GERBER_LAYER_WIDGET::GERBER_LAYER_WIDGET ( GERBVIEW_FRAME aParent,
wxWindow *  aFocusOwner,
int  aPointSize = 10 
)

Constructor.

Parameters
aParent: the parent frame
aFocusOwner: the window that has the keyboard focus.
aPointSizeis the font point size to use within the widget. This effectively sets the overal size of the widget via the row height and bitmap button sizes.

Definition at line 57 of file class_gerbview_layer_widget.cpp.

References ID_LAYER_MANAGER_END, ID_LAYER_MANAGER_START, m_alwaysShowActiveLayer, LAYER_WIDGET::m_LayerScrolledWindow, onPopupSelection(), onRightDownLayers(), ReFillRender(), and SetLayersManagerTabsText().

58  :
59  LAYER_WIDGET( aParent, aFocusOwner, aPointSize ),
60  myframe( aParent )
61 {
63 
64  ReFillRender();
65 
66  // Update default tabs labels for GerbView
68 
69  //-----<Popup menu>-------------------------------------------------
70  // handle the popup menu over the layer window.
71  m_LayerScrolledWindow->Connect( wxEVT_RIGHT_DOWN,
72  wxMouseEventHandler( GERBER_LAYER_WIDGET::onRightDownLayers ), NULL, this );
73 
74  // since Popupmenu() calls this->ProcessEvent() we must call this->Connect()
75  // and not m_LayerScrolledWindow->Connect()
77  wxEVT_COMMAND_MENU_SELECTED,
78  wxCommandEventHandler( GERBER_LAYER_WIDGET::onPopupSelection ), NULL, this );
79 }
void onRightDownLayers(wxMouseEvent &event)
Function OnRightDownLayers puts up a popup menu for the layer panel.
void SetLayersManagerTabsText()
Function SetLayersManagerTabsText Update the layer manager tabs labels Useful when changing Language ...
wxScrolledWindow * m_LayerScrolledWindow
Definition: layer_widget.h:112
void onPopupSelection(wxCommandEvent &event)
void ReFillRender()
Function ReFillRender Rebuild Render for instance after the config is read.
LAYER_WIDGET(wxWindow *aParent, wxWindow *aFocusOwner, int aPointSize=-1, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL)
Constructor.

Member Function Documentation

void GERBER_LAYER_WIDGET::AddRightClickMenuItems ( wxMenu &  menu)

Function addRightClickMenuItems add menu items to a menu that should be shown when right-clicking the Gerber layer widget.

Definition at line 137 of file class_gerbview_layer_widget.cpp.

References ID_ALWAYS_SHOW_NO_LAYERS_BUT_ACTIVE, ID_SHOW_ALL_LAYERS, ID_SHOW_NO_LAYERS, ID_SHOW_NO_LAYERS_BUT_ACTIVE, and ID_SORT_GBR_LAYERS.

Referenced by OnLayerRightClick(), and onRightDownLayers().

138 {
139  // Remember: menu text is capitalized (see our rules_for_capitalization_in_Kicad_UI.txt)
140  menu.Append( new wxMenuItem( &menu, ID_SHOW_ALL_LAYERS,
141  _("Show All Layers") ) );
142 
143  menu.Append( new wxMenuItem( &menu, ID_SHOW_NO_LAYERS_BUT_ACTIVE,
144  _( "Hide All Layers But Active" ) ) );
145 
146  menu.Append( new wxMenuItem( &menu, ID_ALWAYS_SHOW_NO_LAYERS_BUT_ACTIVE,
147  _( "Always Hide All Layers But Active" ) ) );
148 
149  menu.Append( new wxMenuItem( &menu, ID_SHOW_NO_LAYERS,
150  _( "Hide All Layers" ) ) );
151 
152  menu.AppendSeparator();
153  menu.Append( new wxMenuItem( &menu, ID_SORT_GBR_LAYERS,
154  _( "Sort Layers if X2 Mode" ) ) );
155 }
void LAYER_WIDGET::AppendLayerRow ( const ROW aRow)
inherited

Function AppendLayerRow appends a new row in the layer portion of the widget.

The user must ensure that ROW::id is unique for all existing rows on Windows.

Definition at line 572 of file layer_widget.cpp.

References LAYER_WIDGET::GetLayerRowCount(), LAYER_WIDGET::insertLayerRow(), and LAYER_WIDGET::UpdateLayouts().

Referenced by LAYER_WIDGET::AppendLayerRows(), PCB_LAYER_WIDGET::ReFill(), and ReFill().

573 {
574  int nextRow = GetLayerRowCount();
575  insertLayerRow( nextRow, aRow );
576  UpdateLayouts();
577 }
void UpdateLayouts()
int GetLayerRowCount() const
Function GetLayerRowCount returns the number of rows in the layer tab.
void insertLayerRow(int aRow, const ROW &aSpec)
Function insertLayerRow appends or inserts a new row in the layer portion of the widget.
void LAYER_WIDGET::AppendLayerRows ( const ROW aRowsArray,
int  aRowCount 
)
inlineinherited

Function AppendLayerRows appends new rows in the layer portion of the widget.

The user must ensure that ROW::id is unique for all existing rows on Windows.

Definition at line 286 of file layer_widget.h.

References LAYER_WIDGET::AppendLayerRow().

287  {
288  for( int row=0; row<aRowCount; ++row )
289  AppendLayerRow( aRowsArray[row] );
290  }
void AppendLayerRow(const ROW &aRow)
Function AppendLayerRow appends a new row in the layer portion of the widget.
void LAYER_WIDGET::AppendRenderRow ( const ROW aRow)
inherited

Function AppendRenderRow appends a new row in the render portion of the widget.

The user must ensure that ROW::id is unique for all existing rows on Windows.

Definition at line 586 of file layer_widget.cpp.

References LAYER_WIDGET::GetRenderRowCount(), LAYER_WIDGET::insertRenderRow(), and LAYER_WIDGET::UpdateLayouts().

Referenced by LAYER_WIDGET::AppendRenderRows(), and PCB_LAYER_WIDGET::ReFillRender().

587 {
588  int nextRow = GetRenderRowCount();
589  insertRenderRow( nextRow, aRow );
590  UpdateLayouts();
591 }
void insertRenderRow(int aRow, const ROW &aSpec)
void UpdateLayouts()
int GetRenderRowCount() const
Function GetRenderRowCount returns the number of rows in the render tab.
void LAYER_WIDGET::AppendRenderRows ( const ROW aRowsArray,
int  aRowCount 
)
inlineinherited

Function AppendRenderRows appends new rows in the render portion of the widget.

The user must ensure that ROW::id is unique for all existing rows on Windows.

Definition at line 310 of file layer_widget.h.

References LAYER_WIDGET::AppendRenderRow().

Referenced by ReFillRender().

311  {
312  for( int row=0; row<aRowCount; ++row )
313  AppendRenderRow( aRowsArray[row] );
314  }
void AppendRenderRow(const ROW &aRow)
Function AppendRenderRow appends a new row in the render portion of the widget.
bool GERBER_LAYER_WIDGET::AreArbitraryColorsAllowed ( )
overrideprivatevirtual

Subclasses can override this to provide logic for allowing arbitrary color selection via wxColourPicker instead of DisplayColorFrame.

Reimplemented from LAYER_WIDGET.

Definition at line 87 of file class_gerbview_layer_widget.cpp.

References EDA_DRAW_FRAME::IsGalCanvasActive(), and myframe.

88 {
89  return myframe->IsGalCanvasActive();
90 }
bool IsGalCanvasActive() const
Function IsGalCanvasActive is used to check which canvas (GAL-based or standard) is currently in use...
Definition: draw_frame.h:848
void LAYER_WIDGET::ClearLayerRows ( )
inherited

Function ClearLayerRows empties out the layer rows.

Definition at line 580 of file layer_widget.cpp.

References LAYER_WIDGET::m_LayersFlexGridSizer.

Referenced by PCB_LAYER_WIDGET::ReFill(), and ReFill().

581 {
582  m_LayersFlexGridSizer->Clear( true );
583 }
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
void LAYER_WIDGET::ClearRenderRows ( )
inherited

Function ClearRenderRows empties out the render rows.

Definition at line 594 of file layer_widget.cpp.

References LAYER_WIDGET::m_RenderFlexGridSizer.

Referenced by PCB_LAYER_WIDGET::ReFillRender(), and ReFillRender().

595 {
596  m_RenderFlexGridSizer->Clear( true );
597 }
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:116
int LAYER_WIDGET::encodeId ( int  aColumn,
int  aId 
)
staticprotectedinherited

Function encodeId is here to allow saving a layer index within a control as its wxControl id, but to do so in a way that all child wxControl ids within a wxWindow are unique, since this is required by Windows.

See also
getDecodedId()

Definition at line 68 of file layer_widget.cpp.

References LYR_COLUMN_COUNT.

Referenced by LAYER_WIDGET::insertLayerRow(), and LAYER_WIDGET::insertRenderRow().

69 {
70  int id = aId * LYR_COLUMN_COUNT + aColumn;
71  return id;
72 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:48
int LAYER_WIDGET::findLayerRow ( LAYER_NUM  aLayer) const
protectedinherited

Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.

Definition at line 247 of file layer_widget.cpp.

References LAYER_WIDGET::getDecodedId(), LAYER_WIDGET::getLayerComp(), and LAYER_WIDGET::GetLayerRowCount().

Referenced by LAYER_WIDGET::GetLayerColor(), LAYER_WIDGET::IsLayerVisible(), LAYER_WIDGET::OnLeftDownLayers(), LAYER_WIDGET::SelectLayer(), LAYER_WIDGET::SetLayerColor(), and LAYER_WIDGET::SetLayerVisible().

248 {
249  int count = GetLayerRowCount();
250 
251  for( int row = 0; row < count; ++row )
252  {
253  // column 0 in the layer scroll window has a wxStaticBitmap, get its ID.
254  wxWindow* w = getLayerComp( row, 0 );
255  wxASSERT( w );
256 
257  if( aLayer == getDecodedId( w->GetId() ))
258  return row;
259  }
260 
261  return -1;
262 }
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
int GetLayerRowCount() const
Function GetLayerRowCount returns the number of rows in the layer tab.
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int LAYER_WIDGET::findRenderRow ( int  aId) const
protectedinherited

Definition at line 276 of file layer_widget.cpp.

References LAYER_WIDGET::getDecodedId(), LAYER_WIDGET::getRenderComp(), and LAYER_WIDGET::GetRenderRowCount().

Referenced by LAYER_WIDGET::GetRenderState(), and LAYER_WIDGET::SetRenderState().

277 {
278  int count = GetRenderRowCount();
279 
280  for( int row = 0; row < count; ++row )
281  {
282  // column 0 in the layer scroll window has a wxStaticBitmap, get its ID.
283  wxWindow* w = getRenderComp( row, 0 );
284  wxASSERT( w );
285 
286  if( aId == getDecodedId( w->GetId() ))
287  return row;
288  }
289 
290  return -1;
291 }
int GetRenderRowCount() const
Function GetRenderRowCount returns the number of rows in the render tab.
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
wxWindow * getRenderComp(int aRow, int aColumn) const
wxSize LAYER_WIDGET::GetBestSize ( ) const
inherited

Function GetBestSize returns the preferred minimum size, taking into consideration the dynamic content.

Nothing in wxWidgets was reliable enough so this overrides one of their functions.

Definition at line 503 of file layer_widget.cpp.

References LYR_COLUMN_COUNT, LAYER_WIDGET::m_LayerPanel, LAYER_WIDGET::m_LayersFlexGridSizer, LAYER_WIDGET::m_RenderFlexGridSizer, LAYER_WIDGET::m_RenderingPanel, max, and RND_COLUMN_COUNT.

Referenced by GERBVIEW_FRAME::GERBVIEW_FRAME(), and GERBVIEW_FRAME::ReFillLayerWidget().

504 {
505  // size of m_LayerScrolledWindow --------------
506  wxArrayInt widths = m_LayersFlexGridSizer->GetColWidths();
507  int totWidth = 0;
508 
509  if( widths.GetCount() )
510  {
511  for( int i = 0; i < LYR_COLUMN_COUNT; ++i )
512  {
513  totWidth += widths[i] + m_LayersFlexGridSizer->GetHGap();
514  // printf("widths[%d]:%d\n", i, widths[i] );
515  }
516  }
517 
518  // Account for the parent's frame:
519  totWidth += 10;
520 
521 
522  /* The minimum height is a small size to properly force computation
523  * of the panel's scrollbars (otherwise it will assume it *has* all
524  * this space) */
525  unsigned totHeight = 32;
526 
527  wxSize layerz( totWidth, totHeight );
528 
529  layerz += m_LayerPanel->GetWindowBorderSize();
530 
531 
532  // size of m_RenderScrolledWindow --------------
533  widths = m_RenderFlexGridSizer->GetColWidths();
534  totWidth = 0;
535 
536  if( widths.GetCount() )
537  {
538  for( int i = 0; i < RND_COLUMN_COUNT; ++i )
539  {
540  totWidth += widths[i] + m_RenderFlexGridSizer->GetHGap();
541  // printf("widths[%d]:%d\n", i, widths[i] );
542  }
543  }
544  // account for the parent's frame, this one has void space of 10 PLUS a border:
545  totWidth += 20;
546 
547  // For totHeight re-use the previous small one
548  wxSize renderz( totWidth, totHeight );
549 
550  renderz += m_RenderingPanel->GetWindowBorderSize();
551 
552  wxSize clientz( std::max(renderz.x,layerz.x), std::max(renderz.y,layerz.y) );
553 
554  return clientz;
555 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:48
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
#define RND_COLUMN_COUNT
Rendering tab column count.
Definition: layer_widget.h:49
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:116
wxPanel * m_RenderingPanel
Definition: layer_widget.h:114
#define max(a, b)
Definition: auxiliary.h:86
wxPanel * m_LayerPanel
Definition: layer_widget.h:111
LAYER_NUM LAYER_WIDGET::getDecodedId ( int  aControlId)
staticprotectedinherited

Function getDecodedId decodes aControlId to original un-encoded value.

This of course holds iff encodedId was called with a LAYER_NUM (this box is used for other things than layers, too)

Definition at line 75 of file layer_widget.cpp.

References LYR_COLUMN_COUNT.

Referenced by LAYER_WIDGET::findLayerRow(), LAYER_WIDGET::findRenderRow(), LAYER_WIDGET::GetSelectedLayer(), LAYER_WIDGET::OnLayerCheckBox(), LAYER_WIDGET::OnLayerSwatchChanged(), LAYER_WIDGET::OnLeftDownLayers(), onPopupSelection(), PCB_LAYER_WIDGET::onPopupSelection(), LAYER_WIDGET::OnRenderCheckBox(), LAYER_WIDGET::OnRenderSwatchChanged(), and PCB_LAYER_WIDGET::SyncLayerVisibilities().

76 {
77  int id = aControlId / LYR_COLUMN_COUNT; // rounding is OK.
78  return id;
79 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:48
GERBER_FILE_IMAGE_LIST * GERBER_LAYER_WIDGET::GetImagesList ( )
private

Definition at line 81 of file class_gerbview_layer_widget.cpp.

References GERBER_FILE_IMAGE_LIST::GetImagesList().

Referenced by onPopupSelection(), ReFill(), and useAlternateBitmap().

82 {
84 }
static GERBER_FILE_IMAGE_LIST & GetImagesList()
COLOR4D LAYER_WIDGET::GetLayerColor ( LAYER_NUM  aLayer) const
inherited

Function GetLayerColor returns the color of the layer ROW associated with aLayer id.

Definition at line 685 of file layer_widget.cpp.

References ColorFromInt(), LAYER_WIDGET::findLayerRow(), LAYER_WIDGET::getLayerComp(), and TO_UTF8.

686 {
687  int row = findLayerRow( aLayer );
688  if( row >= 0 )
689  {
690  int col = 1; // bitmap button is column 1
691  wxBitmapButton* bmb = (wxBitmapButton*) getLayerComp( row, col );
692  wxASSERT( bmb );
693 
694  wxString colorTxt = bmb->GetName();
695  return ColorFromInt( strtoul( TO_UTF8(colorTxt), NULL, 0 ) );
696  }
697 
698  return COLOR4D::UNSPECIFIED; // it's caller fault, gave me a bad layer
699 }
EDA_COLOR_T ColorFromInt(int aColor)
Checked cast. Use only when necessary (usually I/O)
Definition: colors.h:81
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
wxWindow * LAYER_WIDGET::getLayerComp ( int  aRow,
int  aColumn 
) const
protectedinherited

Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL if these parameters are out of range.

Parameters
aRowis the row index
aColumnis the column
Returns
wxWindow - the component installed within the sizer at given grid coordinate.

Definition at line 236 of file layer_widget.cpp.

References LYR_COLUMN_COUNT, and LAYER_WIDGET::m_LayersFlexGridSizer.

Referenced by LAYER_WIDGET::findLayerRow(), LAYER_WIDGET::GetLayerColor(), LAYER_WIDGET::GetSelectedLayer(), LAYER_WIDGET::IsLayerVisible(), LAYER_WIDGET::OnLeftDownLayers(), onPopupSelection(), PCB_LAYER_WIDGET::onPopupSelection(), PCB_LAYER_WIDGET::ReFill(), LAYER_WIDGET::SelectLayerRow(), LAYER_WIDGET::SetLayerColor(), LAYER_WIDGET::SetLayerVisible(), PCB_LAYER_WIDGET::SyncLayerVisibilities(), and LAYER_WIDGET::UpdateLayerIcons().

237 {
238  unsigned ndx = aRow * LYR_COLUMN_COUNT + aColumn;
239 
240  if( ndx < m_LayersFlexGridSizer->GetChildren().GetCount() )
241  return m_LayersFlexGridSizer->GetChildren()[ndx]->GetWindow();
242 
243  return NULL;
244 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:48
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
int LAYER_WIDGET::GetLayerRowCount ( ) const
inherited

Function GetLayerRowCount returns the number of rows in the layer tab.

Definition at line 558 of file layer_widget.cpp.

References LYR_COLUMN_COUNT, and LAYER_WIDGET::m_LayersFlexGridSizer.

Referenced by LAYER_WIDGET::AppendLayerRow(), LAYER_WIDGET::findLayerRow(), LAYER_WIDGET::OnLeftDownLayers(), onPopupSelection(), PCB_LAYER_WIDGET::onPopupSelection(), PCB_LAYER_WIDGET::ReFill(), PCB_LAYER_WIDGET::SyncLayerVisibilities(), and LAYER_WIDGET::UpdateLayerIcons().

559 {
560  int controlCount = m_LayersFlexGridSizer->GetChildren().GetCount();
561  return controlCount / LYR_COLUMN_COUNT;
562 }
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:48
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
wxWindow * LAYER_WIDGET::getRenderComp ( int  aRow,
int  aColumn 
) const
protectedinherited

Definition at line 265 of file layer_widget.cpp.

References LAYER_WIDGET::m_RenderFlexGridSizer, and RND_COLUMN_COUNT.

Referenced by LAYER_WIDGET::findRenderRow(), LAYER_WIDGET::GetRenderState(), and LAYER_WIDGET::SetRenderState().

266 {
267  int ndx = aRow * RND_COLUMN_COUNT + aColumn;
268 
269  if( (unsigned) ndx < m_RenderFlexGridSizer->GetChildren().GetCount() )
270  return m_RenderFlexGridSizer->GetChildren()[ndx]->GetWindow();
271 
272  return NULL;
273 }
#define RND_COLUMN_COUNT
Rendering tab column count.
Definition: layer_widget.h:49
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:116
int LAYER_WIDGET::GetRenderRowCount ( ) const
inherited

Function GetRenderRowCount returns the number of rows in the render tab.

Definition at line 565 of file layer_widget.cpp.

References LAYER_WIDGET::m_RenderFlexGridSizer, and RND_COLUMN_COUNT.

Referenced by LAYER_WIDGET::AppendRenderRow(), and LAYER_WIDGET::findRenderRow().

566 {
567  int controlCount = m_RenderFlexGridSizer->GetChildren().GetCount();
568  return controlCount / RND_COLUMN_COUNT;
569 }
#define RND_COLUMN_COUNT
Rendering tab column count.
Definition: layer_widget.h:49
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:116
bool LAYER_WIDGET::GetRenderState ( int  aId)
inherited

Function GetRenderState returns the state of the checkbox associated with aId.

Returns
bool - true if checked, else false.

Definition at line 716 of file layer_widget.cpp.

References LAYER_WIDGET::findRenderRow(), and LAYER_WIDGET::getRenderComp().

717 {
718  int row = findRenderRow( aId );
719 
720  if( row >= 0 )
721  {
722  int col = 1; // checkbox is column 1
723  wxCheckBox* cb = (wxCheckBox*) getRenderComp( row, col );
724  wxASSERT( cb );
725  return cb->GetValue();
726  }
727 
728  return false; // the value of a non-existent row
729 }
int findRenderRow(int aId) const
wxWindow * getRenderComp(int aRow, int aColumn) const
LAYER_NUM LAYER_WIDGET::GetSelectedLayer ( )
inherited

Function GetSelectedLayer returns the selected layer or -1 if none.

Definition at line 636 of file layer_widget.cpp.

References LAYER_WIDGET::getDecodedId(), LAYER_WIDGET::getLayerComp(), LAYER_WIDGET::m_CurrentRow, and UNDEFINED_LAYER.

637 {
638  wxWindow* w = getLayerComp( m_CurrentRow, 0 );
639  if( w )
640  return getDecodedId( w->GetId() );
641 
642  return UNDEFINED_LAYER;
643 }
int m_CurrentRow
selected row of layer list
Definition: layer_widget.h:119
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
void LAYER_WIDGET::insertLayerRow ( int  aRow,
const ROW aSpec 
)
protectedinherited

Function insertLayerRow appends or inserts a new row in the layer portion of the widget.

Definition at line 294 of file layer_widget.cpp.

References alternativeRowIcons, LAYER_WIDGET::AreArbitraryColorsAllowed(), LAYER_WIDGET::ROW::color, COLUMN_COLOR_LYR_CB, COLUMN_COLOR_LYRNAME, COLUMN_COLORBM, COLUMN_ICON_ACTIVE, defaultRowIcons, LAYER_WIDGET::encodeId(), LAYER_WIDGET::ROW::id, LYR_COLUMN_COUNT, LAYER_WIDGET::m_LayerScrolledWindow, LAYER_WIDGET::m_LayersFlexGridSizer, LAYER_WIDGET::m_PointSize, OFF, LAYER_WIDGET::OnLayerCheckBox(), LAYER_WIDGET::OnLayerSwatchChanged(), LAYER_WIDGET::OnLeftDownLayers(), LAYER_WIDGET::OnRightDownLayer(), LAYER_WIDGET::ROW::rowName, shrinkFont(), LAYER_WIDGET::ROW::state, LAYER_WIDGET::ROW::tooltip, and LAYER_WIDGET::useAlternateBitmap().

Referenced by LAYER_WIDGET::AppendLayerRow().

295 {
296  wxASSERT( aRow >= 0 );
297 
298  int col;
299  int index = aRow * LYR_COLUMN_COUNT;
300  const int flags = wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT;
301 
302  auto& iconProvider = useAlternateBitmap(aRow) ? alternativeRowIcons : defaultRowIcons;
303 
304  // column 0
305  col = COLUMN_ICON_ACTIVE;
306  auto sbm = new INDICATOR_ICON( m_LayerScrolledWindow, iconProvider,
308  encodeId( col, aSpec.id ) );
309  sbm->Bind( wxEVT_LEFT_DOWN, &LAYER_WIDGET::OnLeftDownLayers, this );
310  m_LayersFlexGridSizer->wxSizer::Insert( index+col, sbm, 0, flags );
311 
312  // column 1 (COLUMN_COLORBM)
313  col = COLUMN_COLORBM;
314 
315  auto bmb = new COLOR_SWATCH( m_LayerScrolledWindow, aSpec.color, encodeId( col, aSpec.id ),
317  bmb->Bind( wxEVT_LEFT_DOWN, &LAYER_WIDGET::OnLeftDownLayers, this );
318  bmb->Bind( COLOR_SWATCH_CHANGED, &LAYER_WIDGET::OnLayerSwatchChanged, this );
319  bmb->SetToolTip( _("Left double click or middle click for color change, right click for menu" ) );
320  m_LayersFlexGridSizer->wxSizer::Insert( index+col, bmb, 0, flags );
321 
322  // column 2 (COLUMN_COLOR_LYR_CB)
323  col = COLUMN_COLOR_LYR_CB;
324  wxCheckBox* cb = new wxCheckBox( m_LayerScrolledWindow, encodeId( col, aSpec.id ), wxEmptyString );
325  cb->SetValue( aSpec.state );
326  cb->Bind( wxEVT_COMMAND_CHECKBOX_CLICKED, &LAYER_WIDGET::OnLayerCheckBox, this );
327  cb->SetToolTip( _( "Enable this for visibility" ) );
328  m_LayersFlexGridSizer->wxSizer::Insert( index+col, cb, 0, flags );
329 
330  // column 3 (COLUMN_COLOR_LYRNAME)
331  col = COLUMN_COLOR_LYRNAME;
332  wxStaticText* st = new wxStaticText( m_LayerScrolledWindow, encodeId( col, aSpec.id ), aSpec.rowName );
333  shrinkFont( st, m_PointSize );
334  st->Bind( wxEVT_LEFT_DOWN, &LAYER_WIDGET::OnLeftDownLayers, this );
335  st->SetToolTip( aSpec.tooltip );
336  m_LayersFlexGridSizer->wxSizer::Insert( index+col, st, 0, flags );
337 
338  // Bind right click eventhandler to all columns
339  wxString layerName( aSpec.rowName );
340 
341  sbm->Bind( wxEVT_RIGHT_DOWN, [this, bmb, layerName] ( wxMouseEvent& aEvt ) {
342  OnRightDownLayer( aEvt, bmb, layerName );
343  } );
344  bmb->Bind( wxEVT_RIGHT_DOWN, [this, bmb, layerName] ( wxMouseEvent& aEvt ) {
345  OnRightDownLayer( aEvt, bmb, layerName );
346  } );
347  cb->Bind( wxEVT_RIGHT_DOWN, [this, bmb, layerName] ( wxMouseEvent& aEvt ) {
348  OnRightDownLayer( aEvt, bmb, layerName );
349  } );
350  st->Bind( wxEVT_RIGHT_DOWN, [this, bmb, layerName] ( wxMouseEvent& aEvt ) {
351  OnRightDownLayer( aEvt, bmb, layerName );
352  } );
353 }
#define COLUMN_COLOR_LYRNAME
Definition: layer_widget.h:54
void OnLeftDownLayers(wxMouseEvent &event)
#define LYR_COLUMN_COUNT
Layer tab column count.
Definition: layer_widget.h:48
#define OFF
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
virtual bool useAlternateBitmap(int aRow)
Virtual Function useAlternateBitmap.
Definition: layer_widget.h:130
static void shrinkFont(wxWindow *aControl, int aPointSize)
Function shrinkFont reduces the size of the wxFont associated with aControl.
void OnLayerCheckBox(wxCommandEvent &event)
Function OnLayerCheckBox handles the "is layer visible" checkbox and propogates the event to the clie...
static int encodeId(int aColumn, int aId)
Function encodeId is here to allow saving a layer index within a control as its wxControl id...
Class representing a row indicator icon for use in places like the layer widget.
#define COLUMN_ICON_ACTIVE
Definition: layer_widget.h:51
#define COLUMN_COLORBM
Definition: layer_widget.h:52
static ROW_ICON_PROVIDER alternativeRowIcons(true)
virtual bool AreArbitraryColorsAllowed()
Subclasses can override this to provide logic for allowing arbitrary color selection via wxColourPick...
Definition: layer_widget.h:136
wxScrolledWindow * m_LayerScrolledWindow
Definition: layer_widget.h:112
static ROW_ICON_PROVIDER defaultRowIcons(false)
void OnRightDownLayer(wxMouseEvent &event, COLOR_SWATCH *aColorSwatch, const wxString &aLayerName)
Function OnRightDownLayer Called when user right-clicks a layer.
#define COLUMN_COLOR_LYR_CB
Definition: layer_widget.h:53
Class representing a simple color swatch, of the kind used to set layer colors.
Definition: color_swatch.h:38
void OnLayerSwatchChanged(wxCommandEvent &aEvent)
Function OnSwatchChanged() is called when a user changes a swatch color.
void LAYER_WIDGET::insertRenderRow ( int  aRow,
const ROW aSpec 
)
protectedinherited

Definition at line 356 of file layer_widget.cpp.

References LAYER_WIDGET::AreArbitraryColorsAllowed(), LAYER_WIDGET::ROW::changeable, LAYER_WIDGET::ROW::color, LAYER_WIDGET::encodeId(), LAYER_WIDGET::ROW::id, LAYER_WIDGET::m_PointSize, LAYER_WIDGET::m_RenderFlexGridSizer, LAYER_WIDGET::m_RenderScrolledWindow, LAYER_WIDGET::OnRenderCheckBox(), LAYER_WIDGET::OnRenderSwatchChanged(), LAYER_WIDGET::OnRightDownRender(), RND_COLUMN_COUNT, LAYER_WIDGET::ROW::rowName, shrinkFont(), LAYER_WIDGET::ROW::state, and LAYER_WIDGET::ROW::tooltip.

Referenced by LAYER_WIDGET::AppendRenderRow().

357 {
358  wxASSERT( aRow >= 0 );
359 
360  int col;
361  int index = aRow * RND_COLUMN_COUNT;
362  const int flags = wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT;
363 
364  wxString renderName( aSpec.rowName );
365 
366  // column 1
367  col = 1;
368  wxCheckBox* cb = new wxCheckBox( m_RenderScrolledWindow, encodeId( col, aSpec.id ),
369  aSpec.rowName, wxDefaultPosition, wxDefaultSize, wxALIGN_LEFT );
370  shrinkFont( cb, m_PointSize );
371  cb->SetValue( aSpec.state );
372  cb->Enable( aSpec.changeable );
373  cb->Bind( wxEVT_COMMAND_CHECKBOX_CLICKED, &LAYER_WIDGET::OnRenderCheckBox, this );
374  cb->SetToolTip( aSpec.tooltip );
375 
376  // column 0
377  col = 0;
378  if( aSpec.color != COLOR4D::UNSPECIFIED )
379  {
380  auto bmb = new COLOR_SWATCH( m_RenderScrolledWindow, aSpec.color, encodeId( col, aSpec.id ),
382  bmb->Bind( COLOR_SWATCH_CHANGED, &LAYER_WIDGET::OnRenderSwatchChanged, this );
383  bmb->SetToolTip( _( "Left double click or middle click for color change" ) );
384  m_RenderFlexGridSizer->wxSizer::Insert( index+col, bmb, 0, flags );
385 
386  bmb->Bind( wxEVT_RIGHT_DOWN, [this, bmb, renderName] ( wxMouseEvent& aEvt ) {
387  OnRightDownRender( aEvt, bmb, renderName );
388  } );
389  cb->Bind( wxEVT_RIGHT_DOWN, [this, bmb, renderName] ( wxMouseEvent& aEvt ) {
390  OnRightDownRender( aEvt, bmb, renderName );
391  } );
392 
393  // could add a left click handler on the color button that toggles checkbox.
394  }
395  else // == -1, no color selection wanted
396  {
397  // need a place holder within the sizer to keep grid full.
398  wxPanel* invisible = new wxPanel( m_RenderScrolledWindow, encodeId( col, aSpec.id ) );
399  m_RenderFlexGridSizer->wxSizer::Insert( index+col, invisible, 0, flags );
400  }
401 
402  // Items have to be inserted in order
403  col = 1;
404  m_RenderFlexGridSizer->wxSizer::Insert( index+col, cb, 0, flags );
405 }
wxScrolledWindow * m_RenderScrolledWindow
Definition: layer_widget.h:115
static void shrinkFont(wxWindow *aControl, int aPointSize)
Function shrinkFont reduces the size of the wxFont associated with aControl.
#define RND_COLUMN_COUNT
Rendering tab column count.
Definition: layer_widget.h:49
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:116
void OnRenderCheckBox(wxCommandEvent &event)
static int encodeId(int aColumn, int aId)
Function encodeId is here to allow saving a layer index within a control as its wxControl id...
void OnRightDownRender(wxMouseEvent &aEvent, COLOR_SWATCH *aColorSwatch, const wxString &aRenderName)
Function OnRightDownRender Called when user right-clicks a render option.
virtual bool AreArbitraryColorsAllowed()
Subclasses can override this to provide logic for allowing arbitrary color selection via wxColourPick...
Definition: layer_widget.h:136
void OnRenderSwatchChanged(wxCommandEvent &aEvent)
Function OnRenderSwatchChanged Called when user has changed the swatch color of a render entry...
Class representing a simple color swatch, of the kind used to set layer colors.
Definition: color_swatch.h:38
void GERBER_LAYER_WIDGET::installRightLayerClickHandler ( )
private

this is for the popup menu, the right click handler has to be installed on every child control within the layer panel.

bool LAYER_WIDGET::IsLayerVisible ( LAYER_NUM  aLayer)
inherited

Function IsLayerVisible returns the visible state of the layer ROW associated with aLayer id.

Definition at line 658 of file layer_widget.cpp.

References COLUMN_COLOR_LYR_CB, LAYER_WIDGET::findLayerRow(), and LAYER_WIDGET::getLayerComp().

Referenced by GERBVIEW_FRAME::IsLayerVisible().

659 {
660  int row = findLayerRow( aLayer );
661  if( row >= 0 )
662  {
663  wxCheckBox* cb = (wxCheckBox*) getLayerComp( row, COLUMN_COLOR_LYR_CB );
664  wxASSERT( cb );
665  return cb->GetValue();
666  }
667  return false;
668 }
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
#define COLUMN_COLOR_LYR_CB
Definition: layer_widget.h:53
void LAYER_WIDGET::OnLayerCheckBox ( wxCommandEvent &  event)
protectedinherited

Function OnLayerCheckBox handles the "is layer visible" checkbox and propogates the event to the client's notification function.

Definition at line 173 of file layer_widget.cpp.

References LAYER_WIDGET::getDecodedId(), LAYER_WIDGET::OnLayerVisible(), and LAYER_WIDGET::passOnFocus().

Referenced by LAYER_WIDGET::insertLayerRow().

174 {
175  wxCheckBox* eventSource = (wxCheckBox*) event.GetEventObject();
176  LAYER_NUM layer = getDecodedId( eventSource->GetId() );
177  OnLayerVisible( layer, eventSource->IsChecked() );
178  passOnFocus();
179 }
virtual void OnLayerVisible(LAYER_NUM aLayer, bool isVisible, bool isFinal=true)=0
Function OnLayerVisible is called to notify client code about a layer visibility change.
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
void GERBER_LAYER_WIDGET::OnLayerColorChange ( int  aLayer,
COLOR4D  aColor 
)
overridevirtual

Function OnLayerColorChange is called to notify client code about a layer color change.

Derived classes will handle this accordingly.

Parameters
aLayeris the board layer to change
aColoris the new color

Implements LAYER_WIDGET.

Definition at line 269 of file class_gerbview_layer_widget.cpp.

References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_FRAME::GetGalCanvas(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::GetView(), KIGFX::RENDER_SETTINGS::ImportLegacyColors(), EDA_DRAW_FRAME::IsGalCanvasActive(), GERBVIEW_FRAME::m_colorsSettings, GERBVIEW_FRAME::m_SelLayerBox, myframe, EDA_DRAW_PANEL::Refresh(), LAYER_BOX_SELECTOR::ResyncBitmapOnly(), GERBVIEW_FRAME::SetLayerColor(), and KIGFX::VIEW::UpdateLayerColor().

270 {
271  myframe->SetLayerColor( aLayer, aColor );
273 
274  if( myframe->IsGalCanvasActive() )
275  {
276  KIGFX::VIEW* view = myframe->GetGalCanvas()->GetView();
278  view->UpdateLayerColor( aLayer );
279  }
280 
281  myframe->GetCanvas()->Refresh();
282 }
virtual void Refresh(bool eraseBackground=true, const wxRect *rect=NULL) override
Update the board display after modifying it bu a python script (note: it is automatically called by a...
Definition: draw_panel.cpp:325
EDA_DRAW_PANEL * GetCanvas()
Definition: draw_frame.h:324
GBR_LAYER_BOX_SELECTOR * m_SelLayerBox
KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
COLORS_DESIGN_SETTINGS * m_colorsSettings
bool IsGalCanvasActive() const
Function IsGalCanvasActive is used to check which canvas (GAL-based or standard) is currently in use...
Definition: draw_frame.h:848
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:196
virtual void ImportLegacyColors(const COLORS_DESIGN_SETTINGS *aSettings)=0
Function ImportLegacyColors Loads a list of color settings for layers.
void UpdateLayerColor(int aLayer)
Function UpdateLayerColor() Applies the new coloring scheme held by RENDER_SETTINGS in case that it h...
Definition: view.cpp:657
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
void SetLayerColor(int aLayer, COLOR4D aColor)
Function SetLayerColor changes a layer color for any valid layer.
EDA_DRAW_PANEL_GAL * GetGalCanvas() const
Function GetGalCanvas returns a pointer to GAL-based canvas of given EDA draw frame.
Definition: draw_frame.h:856
Class VIEW.
Definition: view.h:58
void GERBER_LAYER_WIDGET::OnLayerRightClick ( wxMenu &  aMenu)
overridevirtual

Function OnLayerRightClick is called to notify client code about a layer being right-clicked.

Parameters
aMenuis the right-click menu containing layer-scoped options. It can be used to add extra, wider scoped menu items.

Implements LAYER_WIDGET.

Definition at line 264 of file class_gerbview_layer_widget.cpp.

References AddRightClickMenuItems().

265 {
266  AddRightClickMenuItems( aMenu );
267 }
void AddRightClickMenuItems(wxMenu &menu)
Function addRightClickMenuItems add menu items to a menu that should be shown when right-clicking the...
bool GERBER_LAYER_WIDGET::OnLayerSelect ( int  aLayer)
overridevirtual

Function OnLayerSelect is called to notify client code whenever the user selects a different layer.

Derived classes will handle this accordingly, and can deny the change by returning false.

Parameters
aLayeris the board layer to select

Implements LAYER_WIDGET.

Definition at line 284 of file class_gerbview_layer_widget.cpp.

References GERBER_DRAW_LAYER_INDEX, GERBVIEW_FRAME::GetActiveLayer(), EDA_DRAW_FRAME::GetCanvas(), myframe, OnLayerSelected(), EDA_DRAW_PANEL::Refresh(), GERBVIEW_FRAME::SetActiveLayer(), and GERBVIEW_FRAME::syncLayerBox().

285 {
286  // the layer change from the GERBER_LAYER_WIDGET can be denied by returning
287  // false from this function.
288  int layer = myframe->GetActiveLayer( );
289  // TODO(JE) ActiveLayer is stored as an index from 0 rather than as a layer
290  // id matching GERBER_DRAW_LAYER( idx ), is this what we want long-term?
291  myframe->SetActiveLayer( GERBER_DRAW_LAYER_INDEX( aLayer ), false );
293 
294  if( layer != myframe->GetActiveLayer( ) )
295  {
296  if( ! OnLayerSelected() )
297  myframe->GetCanvas()->Refresh();
298  }
299 
300  return true;
301 }
virtual void Refresh(bool eraseBackground=true, const wxRect *rect=NULL) override
Update the board display after modifying it bu a python script (note: it is automatically called by a...
Definition: draw_panel.cpp:325
EDA_DRAW_PANEL * GetCanvas()
Definition: draw_frame.h:324
void syncLayerBox(bool aRebuildLayerBox=false)
Function syncLayerBox updates the currently "selected" layer within m_SelLayerBox The currently activ...
void SetActiveLayer(int aLayer, bool doLayerWidgetUpdate=true)
Function SetActiveLayer will change the currently active layer to aLayer and also update the GERBER_L...
int GetActiveLayer()
Function SetActiveLayer returns the active layer.
#define GERBER_DRAW_LAYER_INDEX(x)
bool OnLayerSelected()
Function OnLayerSelected ensure the active layer is visible, and other layers not visible when m_alwa...
bool GERBER_LAYER_WIDGET::OnLayerSelected ( )

Function OnLayerSelected ensure the active layer is visible, and other layers not visible when m_alwaysShowActiveLayer is true Otherwise do nothing.

Returns
true m_alwaysShowActiveLayer is true and the canvas is refreshed, and false if do nothing

Definition at line 220 of file class_gerbview_layer_widget.cpp.

References ID_ALWAYS_SHOW_NO_LAYERS_BUT_ACTIVE, m_alwaysShowActiveLayer, and onPopupSelection().

Referenced by GERBVIEW_FRAME::OnHotKey(), OnLayerSelect(), and GERBVIEW_FRAME::OnSelectActiveLayer().

221 {
223  return false;
224 
225  // postprocess after active layer selection
226  // ensure active layer visible
227  wxCommandEvent event;
229  onPopupSelection( event );
230  return true;
231 }
void onPopupSelection(wxCommandEvent &event)
void LAYER_WIDGET::OnLayerSwatchChanged ( wxCommandEvent &  aEvent)
protectedinherited

Function OnSwatchChanged() is called when a user changes a swatch color.

Definition at line 154 of file layer_widget.cpp.

References LAYER_WIDGET::EVT_LAYER_COLOR_CHANGE, LAYER_WIDGET::getDecodedId(), LAYER_WIDGET::OnLayerColorChange(), and LAYER_WIDGET::passOnFocus().

Referenced by LAYER_WIDGET::insertLayerRow().

155 {
156  auto eventSource = static_cast<COLOR_SWATCH*>( aEvent.GetEventObject() );
157 
158  COLOR4D newColor = eventSource->GetSwatchColor();
159 
160  LAYER_NUM layer = getDecodedId( eventSource->GetId() );
161 
162  // tell the client code.
163  OnLayerColorChange( layer, newColor );
164 
165  // notify others
166  wxCommandEvent event( EVT_LAYER_COLOR_CHANGE );
167  wxPostEvent( this, event );
168 
169  passOnFocus();
170 }
static const wxEventType EVT_LAYER_COLOR_CHANGE
Definition: layer_widget.h:106
virtual void OnLayerColorChange(int aLayer, COLOR4D aColor)=0
Function OnLayerColorChange is called to notify client code about a layer color change.
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
Class representing a simple color swatch, of the kind used to set layer colors.
Definition: color_swatch.h:38
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
void GERBER_LAYER_WIDGET::OnLayerVisible ( int  aLayer,
bool  isVisible,
bool  isFinal 
)
overridevirtual

Function OnLayerVisible is called to notify client code about a layer visibility change.

Parameters
aLayeris the board layer to select
isVisibleis the new visible state
isFinalis true when this is the last of potentially several such calls, and can be used to decide when to update the screen only one time instead of several times in the midst of a multiple layer change.

Implements LAYER_WIDGET.

Definition at line 303 of file class_gerbview_layer_widget.cpp.

References GERBVIEW_LAYER_ID_START, EDA_DRAW_FRAME::GetCanvas(), GERBVIEW_FRAME::GetVisibleLayers(), myframe, EDA_DRAW_PANEL::Refresh(), and GERBVIEW_FRAME::SetVisibleLayers().

304 {
305  long visibleLayers = myframe->GetVisibleLayers();
306 
307  if( isVisible )
308  visibleLayers |= 1 << ( aLayer - GERBVIEW_LAYER_ID_START );
309  else
310  visibleLayers &= ~( 1 << ( aLayer - GERBVIEW_LAYER_ID_START ) );
311 
312  myframe->SetVisibleLayers( visibleLayers );
313 
314  if( isFinal )
315  myframe->GetCanvas()->Refresh();
316 }
virtual void Refresh(bool eraseBackground=true, const wxRect *rect=NULL) override
Update the board display after modifying it bu a python script (note: it is automatically called by a...
Definition: draw_panel.cpp:325
EDA_DRAW_PANEL * GetCanvas()
Definition: draw_frame.h:324
void SetVisibleLayers(long aLayerMask)
Function SetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
long GetVisibleLayers() const
Function GetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
void LAYER_WIDGET::OnLeftDownLayers ( wxMouseEvent &  event)
protectedinherited

Definition at line 82 of file layer_widget.cpp.

References LAYER_WIDGET::findLayerRow(), LAYER_WIDGET::getDecodedId(), LAYER_WIDGET::getLayerComp(), LAYER_WIDGET::GetLayerRowCount(), LAYER_WIDGET::m_LayerScrolledWindow, LAYER_WIDGET::m_LayersFlexGridSizer, LAYER_WIDGET::OnLayerSelect(), LAYER_WIDGET::passOnFocus(), and LAYER_WIDGET::SelectLayerRow().

Referenced by LAYER_WIDGET::insertLayerRow().

83 {
84  int row;
85  LAYER_NUM layer;
86 
87  wxWindow* eventSource = (wxWindow*) event.GetEventObject();
88 
89  // if mouse event is coming from the m_LayerScrolledWindow and not one
90  // of its children, we have to find the row manually based on y coord.
91  if( eventSource == m_LayerScrolledWindow )
92  {
93  int y = event.GetY();
94 
95  wxArrayInt heights = m_LayersFlexGridSizer->GetRowHeights();
96 
97  int height = 0;
98 
99  int rowCount = GetLayerRowCount();
100  for( row = 0; row<rowCount; ++row )
101  {
102  if( y < height + heights[row] )
103  break;
104 
105  height += heights[row];
106  }
107 
108  if( row >= rowCount )
109  row = rowCount - 1;
110 
111  layer = getDecodedId( getLayerComp( row, 0 )->GetId() );
112  }
113 
114  else
115  {
116  // all nested controls on a given row will have their ID encoded with
117  // encodeId(), and the corresponding decoding is getDecodedId()
118  int id = eventSource->GetId();
119  layer = getDecodedId( id );
120  row = findLayerRow( layer );
121  }
122 
123  if( OnLayerSelect( layer ) ) // if client allows this change.
124  SelectLayerRow( row );
125 
126  passOnFocus();
127 }
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
wxScrolledWindow * m_LayerScrolledWindow
Definition: layer_widget.h:112
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
int GetLayerRowCount() const
Function GetLayerRowCount returns the number of rows in the layer tab.
void SelectLayerRow(int aRow)
Function SelectLayerRow changes the row selection in the layer list to the given row.
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
virtual bool OnLayerSelect(int aLayer)=0
Function OnLayerSelect is called to notify client code whenever the user selects a different layer...
void GERBER_LAYER_WIDGET::onPopupSelection ( wxCommandEvent &  event)
private

Definition at line 168 of file class_gerbview_layer_widget.cpp.

References COLUMN_COLOR_LYR_CB, GERBER_DRAW_LAYER, GERBVIEW_FRAME::GetActiveLayer(), EDA_DRAW_FRAME::GetCanvas(), LAYER_WIDGET::getDecodedId(), GetImagesList(), LAYER_WIDGET::getLayerComp(), LAYER_WIDGET::GetLayerRowCount(), ID_ALWAYS_SHOW_NO_LAYERS_BUT_ACTIVE, ID_SHOW_ALL_LAYERS, ID_SHOW_NO_LAYERS, ID_SHOW_NO_LAYERS_BUT_ACTIVE, ID_SORT_GBR_LAYERS, m_alwaysShowActiveLayer, myframe, GERBVIEW_FRAME::ReFillLayerWidget(), EDA_DRAW_PANEL::Refresh(), GERBVIEW_FRAME::SetVisibleLayers(), GERBER_FILE_IMAGE_LIST::SortImagesByZOrder(), and GERBVIEW_FRAME::syncLayerBox().

Referenced by GERBER_LAYER_WIDGET(), and OnLayerSelected().

169 {
170  int rowCount;
171  int menuId = event.GetId();
172  bool visible = (menuId == ID_SHOW_ALL_LAYERS) ? true : false;
173  long visibleLayers = 0;
174  bool force_active_layer_visible;
175 
177  force_active_layer_visible = ( menuId == ID_SHOW_NO_LAYERS_BUT_ACTIVE ||
179 
180  switch( menuId )
181  {
182  case ID_SHOW_ALL_LAYERS:
183  case ID_SHOW_NO_LAYERS:
186  rowCount = GetLayerRowCount();
187  for( int row=0; row < rowCount; ++row )
188  {
189  wxCheckBox* cb = (wxCheckBox*) getLayerComp( row, COLUMN_COLOR_LYR_CB );
190  int layer = getDecodedId( cb->GetId() );
191  bool loc_visible = visible;
192 
193  if( force_active_layer_visible &&
194  (layer == GERBER_DRAW_LAYER( myframe->GetActiveLayer() ) ) )
195  {
196  loc_visible = true;
197  }
198 
199  cb->SetValue( loc_visible );
200 
201  if( loc_visible )
202  visibleLayers |= 1 << row;
203  else
204  visibleLayers &= ~( 1 << row );
205  }
206 
207  myframe->SetVisibleLayers( visibleLayers );
208  myframe->GetCanvas()->Refresh();
209  break;
210 
211  case ID_SORT_GBR_LAYERS:
214  myframe->syncLayerBox( true );
215  myframe->GetCanvas()->Refresh();
216  break;
217  }
218 }
virtual void Refresh(bool eraseBackground=true, const wxRect *rect=NULL) override
Update the board display after modifying it bu a python script (note: it is automatically called by a...
Definition: draw_panel.cpp:325
EDA_DRAW_PANEL * GetCanvas()
Definition: draw_frame.h:324
void syncLayerBox(bool aRebuildLayerBox=false)
Function syncLayerBox updates the currently "selected" layer within m_SelLayerBox The currently activ...
void SortImagesByZOrder()
Sort loaded images by Z order priority, if they have the X2 FileFormat info (SortImagesByZOrder updat...
GERBER_FILE_IMAGE_LIST * GetImagesList()
int GetActiveLayer()
Function SetActiveLayer returns the active layer.
void SetVisibleLayers(long aLayerMask)
Function SetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
int GetLayerRowCount() const
Function GetLayerRowCount returns the number of rows in the layer tab.
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
#define COLUMN_COLOR_LYR_CB
Definition: layer_widget.h:53
#define GERBER_DRAW_LAYER(x)
void ReFillLayerWidget()
Function ReFillLayerWidget changes out all the layers in m_Layers and may be called upon loading new ...
void LAYER_WIDGET::OnRenderCheckBox ( wxCommandEvent &  event)
protectedinherited

Definition at line 218 of file layer_widget.cpp.

References LAYER_WIDGET::getDecodedId(), LAYER_WIDGET::OnRenderEnable(), and LAYER_WIDGET::passOnFocus().

Referenced by LAYER_WIDGET::insertRenderRow().

219 {
220  wxCheckBox* eventSource = (wxCheckBox*) event.GetEventObject();
221  LAYER_NUM id = getDecodedId( eventSource->GetId() );
222  OnRenderEnable( id, eventSource->IsChecked() );
223  passOnFocus();
224 }
virtual void OnRenderEnable(int aId, bool isEnabled)=0
Function OnRenderEnable is called to notify client code whenever the user changes an rendering enable...
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
void GERBER_LAYER_WIDGET::OnRenderColorChange ( int  aId,
COLOR4D  aColor 
)
overridevirtual

Function OnRenderColorChange is called to notify client code whenever the user changes a rendering color.

Parameters
aIdis the same id that was established in a Rendering row via the AddRenderRow() function.
aColoris the new color

Implements LAYER_WIDGET.

Definition at line 318 of file class_gerbview_layer_widget.cpp.

References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_FRAME::GetGalCanvas(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::GetView(), KIGFX::RENDER_SETTINGS::ImportLegacyColors(), EDA_DRAW_FRAME::IsGalCanvasActive(), GERBVIEW_FRAME::m_colorsSettings, myframe, EDA_DRAW_PANEL::Refresh(), GERBVIEW_FRAME::SetVisibleElementColor(), and KIGFX::TARGET_NONCACHED.

319 {
321 
322  auto galCanvas = myframe->GetGalCanvas();
323 
324  if( galCanvas && myframe->IsGalCanvasActive() )
325  {
326  auto view = galCanvas->GetView();
328  view->UpdateLayerColor( aId );
329  // TODO(JE) Why are the below two lines needed? Not needed in pcbnew
330  view->MarkTargetDirty( KIGFX::TARGET_NONCACHED );
331  view->RecacheAllItems();
332  }
333 
334  if( galCanvas && myframe->IsGalCanvasActive() )
335  galCanvas->Refresh();
336  else
337  myframe->GetCanvas()->Refresh();
338 }
virtual void Refresh(bool eraseBackground=true, const wxRect *rect=NULL) override
Update the board display after modifying it bu a python script (note: it is automatically called by a...
Definition: draw_panel.cpp:325
EDA_DRAW_PANEL * GetCanvas()
Definition: draw_frame.h:324
void SetVisibleElementColor(GERBVIEW_LAYER_ID aItemIdVisible, COLOR4D aColor)
KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
GERBVIEW_LAYER_ID
GerbView draw layers.
Auxiliary rendering target (noncached)
Definition: definitions.h:42
COLORS_DESIGN_SETTINGS * m_colorsSettings
bool IsGalCanvasActive() const
Function IsGalCanvasActive is used to check which canvas (GAL-based or standard) is currently in use...
Definition: draw_frame.h:848
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:196
virtual void ImportLegacyColors(const COLORS_DESIGN_SETTINGS *aSettings)=0
Function ImportLegacyColors Loads a list of color settings for layers.
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
EDA_DRAW_PANEL_GAL * GetGalCanvas() const
Function GetGalCanvas returns a pointer to GAL-based canvas of given EDA draw frame.
Definition: draw_frame.h:856
void GERBER_LAYER_WIDGET::OnRenderEnable ( int  aId,
bool  isEnabled 
)
overridevirtual

Function OnRenderEnable is called to notify client code whenever the user changes an rendering enable in one of the rendering checkboxes.

Parameters
aIdis the same id that was established in a Rendering row via the AddRenderRow() function.
isEnabledis the state of the checkbox, true if checked.

Implements LAYER_WIDGET.

Definition at line 340 of file class_gerbview_layer_widget.cpp.

References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_FRAME::GetGalCanvas(), EDA_DRAW_FRAME::IsGalCanvasActive(), EDA_DRAW_FRAME::IsGridVisible(), LAYER_GERBVIEW_GRID, myframe, EDA_DRAW_PANEL::Refresh(), GERBVIEW_FRAME::SetElementVisibility(), KIGFX::GAL::SetGridVisibility(), and KIGFX::TARGET_NONCACHED.

341 {
342  myframe->SetElementVisibility( (GERBVIEW_LAYER_ID) aId, isEnabled );
343 
344  auto galCanvas = myframe->GetGalCanvas();
345 
346  if( galCanvas )
347  {
348  if( aId == LAYER_GERBVIEW_GRID )
349  {
350  galCanvas->GetGAL()->SetGridVisibility( myframe->IsGridVisible() );
351  galCanvas->GetView()->MarkTargetDirty( KIGFX::TARGET_NONCACHED );
352  // TODO(JE) Why is the below line needed? Not needed in pcbnew
353  galCanvas->GetView()->RecacheAllItems();
354  }
355  else
356  galCanvas->GetView()->SetLayerVisible( aId, isEnabled );
357  }
358 
359  if( galCanvas && myframe->IsGalCanvasActive() )
360  galCanvas->Refresh();
361  else
362  myframe->GetCanvas()->Refresh();
363 }
virtual void Refresh(bool eraseBackground=true, const wxRect *rect=NULL) override
Update the board display after modifying it bu a python script (note: it is automatically called by a...
Definition: draw_panel.cpp:325
EDA_DRAW_PANEL * GetCanvas()
Definition: draw_frame.h:324
GERBVIEW_LAYER_ID
GerbView draw layers.
virtual bool IsGridVisible() const
Function IsGridVisible() , virtual.
Definition: draw_frame.h:468
Auxiliary rendering target (noncached)
Definition: definitions.h:42
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
bool IsGalCanvasActive() const
Function IsGalCanvasActive is used to check which canvas (GAL-based or standard) is currently in use...
Definition: draw_frame.h:848
void SetElementVisibility(GERBVIEW_LAYER_ID aItemIdVisible, bool aNewState)
Function SetElementVisibility changes the visibility of an element category.
void SetGridVisibility(bool aVisibility)
Sets the visibility setting of the grid.
EDA_DRAW_PANEL_GAL * GetGalCanvas() const
Function GetGalCanvas returns a pointer to GAL-based canvas of given EDA draw frame.
Definition: draw_frame.h:856
void LAYER_WIDGET::OnRenderSwatchChanged ( wxCommandEvent &  aEvent)
protectedinherited

Function OnRenderSwatchChanged Called when user has changed the swatch color of a render entry.

Definition at line 203 of file layer_widget.cpp.

References LAYER_WIDGET::getDecodedId(), LAYER_WIDGET::OnRenderColorChange(), and LAYER_WIDGET::passOnFocus().

Referenced by LAYER_WIDGET::insertRenderRow().

204 {
205  auto eventSource = static_cast<COLOR_SWATCH*>( aEvent.GetEventObject() );
206 
207  COLOR4D newColor = eventSource->GetSwatchColor();
208 
209  LAYER_NUM id = getDecodedId( eventSource->GetId() );
210 
211  // tell the client code.
212  OnRenderColorChange( id, newColor );
213 
214  passOnFocus();
215 }
virtual void OnRenderColorChange(int aId, COLOR4D aColor)=0
Function OnRenderColorChange is called to notify client code whenever the user changes a rendering co...
static LAYER_NUM getDecodedId(int aControlId)
Function getDecodedId decodes aControlId to original un-encoded value.
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
Class representing a simple color swatch, of the kind used to set layer colors.
Definition: color_swatch.h:38
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
void LAYER_WIDGET::OnRightDownLayer ( wxMouseEvent &  event,
COLOR_SWATCH aColorSwatch,
const wxString &  aLayerName 
)
protectedinherited

Function OnRightDownLayer Called when user right-clicks a layer.

Definition at line 130 of file layer_widget.cpp.

References AddMenuItem(), COLOR_SWATCH::GetNewSwatchColor(), LAYER_WIDGET::ID_CHANGE_LAYER_COLOR, KiBitmap(), LAYER_WIDGET::OnLayerRightClick(), and LAYER_WIDGET::passOnFocus().

Referenced by LAYER_WIDGET::insertLayerRow().

131 {
132  wxMenu menu;
133 
135  _( "Change Layer Color for " ) + aLayerName,
136  KiBitmap( setcolor_copper_xpm ) );
137  menu.AppendSeparator();
138 
139  OnLayerRightClick( menu );
140 
141  menu.Bind( wxEVT_COMMAND_MENU_SELECTED, [this, aColorSwatch]( wxCommandEvent& event ) {
142  if ( event.GetId() == ID_CHANGE_LAYER_COLOR ) {
143  aColorSwatch->GetNewSwatchColor();
144  } else {
145  event.Skip();
146  }
147  } );
148 
149  PopupMenu( &menu );
150  passOnFocus();
151 }
wxMenuItem * AddMenuItem(wxMenu *aMenu, int aId, const wxString &aText, const wxBitmap &aImage, wxItemKind aType=wxITEM_NORMAL)
Function AddMenuItem is an inline helper function to create and insert a menu item with an icon into ...
Definition: bitmap.cpp:55
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Function KiBitmap constructs a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:36
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
virtual void OnLayerRightClick(wxMenu &aMenu)=0
Function OnLayerRightClick is called to notify client code about a layer being right-clicked.
void GetNewSwatchColor()
Prompt for a new colour, using the colour picker dialog.
void GERBER_LAYER_WIDGET::onRightDownLayers ( wxMouseEvent &  event)
private

Function OnRightDownLayers puts up a popup menu for the layer panel.

Definition at line 158 of file class_gerbview_layer_widget.cpp.

References AddRightClickMenuItems(), and LAYER_WIDGET::passOnFocus().

Referenced by GERBER_LAYER_WIDGET().

159 {
160  wxMenu menu;
161 
162  AddRightClickMenuItems( menu );
163  PopupMenu( &menu );
164 
165  passOnFocus();
166 }
void AddRightClickMenuItems(wxMenu &menu)
Function addRightClickMenuItems add menu items to a menu that should be shown when right-clicking the...
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
void LAYER_WIDGET::OnRightDownRender ( wxMouseEvent &  aEvent,
COLOR_SWATCH aColorSwatch,
const wxString &  aRenderName 
)
protectedinherited

Function OnRightDownRender Called when user right-clicks a render option.

Definition at line 182 of file layer_widget.cpp.

References AddMenuItem(), COLOR_SWATCH::GetNewSwatchColor(), LAYER_WIDGET::ID_CHANGE_RENDER_COLOR, KiBitmap(), and LAYER_WIDGET::passOnFocus().

Referenced by LAYER_WIDGET::insertRenderRow().

183 {
184  wxMenu menu;
185 
187  _( "Change Render Color for " ) + aRenderName,
188  KiBitmap( setcolor_board_body_xpm ) );
189 
190  menu.Bind( wxEVT_COMMAND_MENU_SELECTED, [this, aColorSwatch]( wxCommandEvent& event ) {
191  if ( event.GetId() == ID_CHANGE_RENDER_COLOR ) {
192  aColorSwatch->GetNewSwatchColor();
193  } else {
194  event.Skip();
195  }
196  } );
197 
198  PopupMenu( &menu );
199  passOnFocus();
200 }
wxMenuItem * AddMenuItem(wxMenu *aMenu, int aId, const wxString &aText, const wxBitmap &aImage, wxItemKind aType=wxITEM_NORMAL)
Function AddMenuItem is an inline helper function to create and insert a menu item with an icon into ...
Definition: bitmap.cpp:55
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Function KiBitmap constructs a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:36
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
void GetNewSwatchColor()
Prompt for a new colour, using the colour picker dialog.
void LAYER_WIDGET::OnTabChange ( wxNotebookEvent &  event)
protectedinherited

Definition at line 227 of file layer_widget.cpp.

References LAYER_WIDGET::passOnFocus().

Referenced by LAYER_WIDGET::LAYER_WIDGET().

228 {
229 // wxFocusEvent event( wxEVT_SET_FOCUS );
230 // m_FocusOwner->AddPendingEvent( event );
231 
232  passOnFocus(); // does not work in this context, probably because we have receive control here too early.
233 }
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
void GERBER_LAYER_WIDGET::ReFill ( )

Definition at line 234 of file class_gerbview_layer_widget.cpp.

References LAYER_WIDGET::AppendLayerRow(), LAYER_WIDGET::ClearLayerRows(), GERBER_DRAW_LAYER, GERBER_DRAWLAYERS_COUNT, GERBER_FILE_IMAGE_LIST::GetDisplayName(), EDA_DRAW_FRAME::GetGalCanvas(), GetImagesList(), GERBVIEW_FRAME::GetLayerColor(), GERBVIEW_FRAME::IsLayerVisible(), and myframe.

Referenced by GERBVIEW_FRAME::GERBVIEW_FRAME(), GERBVIEW_FRAME::ReFillLayerWidget(), and GERBVIEW_FRAME::UseGalCanvas().

235 {
236  Freeze();
237 
238  ClearLayerRows();
239 
240  for( int layer = 0; layer < GERBER_DRAWLAYERS_COUNT; ++layer )
241  {
242  wxString msg = GetImagesList()->GetDisplayName( layer );
243 
244  bool visible = true;
245  if( auto canvas = myframe->GetGalCanvas() )
246  {
247  visible = canvas->GetView()->IsLayerVisible( GERBER_DRAW_LAYER( layer ) );
248  }
249  else
250  {
251  visible = myframe->IsLayerVisible( layer );
252  }
253 
256  wxEmptyString, visible, true ) );
257  }
258 
259  Thaw();
260 }
Struct ROW provides all the data needed to add a row to a LAYER_WIDGET.
Definition: layer_widget.h:85
const wxString GetDisplayName(int aIdx, bool aNameOnly=false)
GERBER_FILE_IMAGE_LIST * GetImagesList()
void ClearLayerRows()
Function ClearLayerRows empties out the layer rows.
#define GERBER_DRAWLAYERS_COUNT
void AppendLayerRow(const ROW &aRow)
Function AppendLayerRow appends a new row in the layer portion of the widget.
bool IsLayerVisible(int aLayer) const
Function IsLayerVisible tests whether a given layer is visible.
COLOR4D GetLayerColor(int aLayer) const
Function GetLayerColor gets a layer color for any valid layer.
EDA_DRAW_PANEL_GAL * GetGalCanvas() const
Function GetGalCanvas returns a pointer to GAL-based canvas of given EDA draw frame.
Definition: draw_frame.h:856
#define GERBER_DRAW_LAYER(x)
void GERBER_LAYER_WIDGET::ReFillRender ( )

Function ReFillRender Rebuild Render for instance after the config is read.

Definition at line 103 of file class_gerbview_layer_widget.cpp.

References LAYER_WIDGET::AppendRenderRows(), LAYER_WIDGET::ClearRenderRows(), color, LAYER_WIDGET::ROW::color, DARKGRAY, DIM, GERBVIEW_FRAME::GetVisibleElementColor(), GERBVIEW_FRAME::IsElementVisible(), LAYER_DCODES, LAYER_GERBVIEW_GRID, LAYER_NEGATIVE_OBJECTS, myframe, RR, LAYER_WIDGET::ROW::state, and WHITE.

Referenced by GERBER_LAYER_WIDGET(), GERBVIEW_FRAME::GERBVIEW_FRAME(), and GERBVIEW_FRAME::UseGalCanvas().

104 {
105  ClearRenderRows();
106 
107  // Fixed "Rendering" tab rows within the LAYER_WIDGET, only the initial color
108  // is changed before appending to the LAYER_WIDGET. This is an automatic variable
109  // not a static variable, change the color & state after copying from code to renderRows
110  // on the stack.
111  LAYER_WIDGET::ROW renderRows[3] = {
112 
113 #define RR LAYER_WIDGET::ROW // Render Row abreviation to reduce source width
114 
115  // text id color tooltip checked
116  RR( _( "Grid" ), LAYER_GERBVIEW_GRID, WHITE, _( "Show the (x,y) grid dots" ) ),
117  RR( _( "DCodes" ), LAYER_DCODES, WHITE, _( "Show DCodes identification" ) ),
118  RR( _( "Neg. Obj." ), LAYER_NEGATIVE_OBJECTS, DARKGRAY,
119  _( "Show negative objects in this color" ) ),
120  };
121 
122  for( unsigned row=0; row<DIM(renderRows); ++row )
123  {
124  if( renderRows[row].color != COLOR4D::UNSPECIFIED ) // does this row show a color?
125  {
126  renderRows[row].color = myframe->GetVisibleElementColor(
127  ( GERBVIEW_LAYER_ID )renderRows[row].id );
128  }
129  renderRows[row].state = myframe->IsElementVisible(
130  ( GERBVIEW_LAYER_ID )renderRows[row].id );
131  }
132 
133  AppendRenderRows( renderRows, DIM(renderRows) );
134 }
#define DIM(x)
of elements in an array
Definition: macros.h:98
Struct ROW provides all the data needed to add a row to a LAYER_WIDGET.
Definition: layer_widget.h:85
void ClearRenderRows()
Function ClearRenderRows empties out the render rows.
GERBVIEW_LAYER_ID
GerbView draw layers.
bool state
initial wxCheckBox state
Definition: layer_widget.h:90
COLOR4D color
COLOR4D::UNSPECIFIED if none.
Definition: layer_widget.h:89
COLOR4D GetVisibleElementColor(GERBVIEW_LAYER_ID aItemIdVisible)
Function GetVisibleElementColor returns the color of a gerber visible element.
#define RR
void AppendRenderRows(const ROW *aRowsArray, int aRowCount)
Function AppendRenderRows appends new rows in the render portion of the widget.
Definition: layer_widget.h:310
bool IsElementVisible(GERBVIEW_LAYER_ID aItemIdVisible) const
Function IsElementVisible tests whether a given element category is visible.
Definition: colors.h:49
void LAYER_WIDGET::SelectLayer ( LAYER_NUM  aLayer)
inherited

Function SelectLayer changes the row selection in the layer list to aLayer provided.

Definition at line 629 of file layer_widget.cpp.

References LAYER_WIDGET::findLayerRow(), and LAYER_WIDGET::SelectLayerRow().

Referenced by GERBVIEW_FRAME::SetActiveLayer(), and GERBVIEW_FRAME::syncLayerWidget().

630 {
631  int row = findLayerRow( aLayer );
632  SelectLayerRow( row );
633 }
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
void SelectLayerRow(int aRow)
Function SelectLayerRow changes the row selection in the layer list to the given row.
void LAYER_WIDGET::SelectLayerRow ( int  aRow)
inherited

Function SelectLayerRow changes the row selection in the layer list to the given row.

Definition at line 600 of file layer_widget.cpp.

References LAYER_WIDGET::getLayerComp(), LAYER_WIDGET::m_CurrentRow, LAYER_WIDGET::m_notebook, OFF, ON, LAYER_WIDGET::passOnFocus(), and INDICATOR_ICON::SetIndicatorState().

Referenced by LAYER_WIDGET::OnLeftDownLayers(), and LAYER_WIDGET::SelectLayer().

601 {
602  // enable the layer tab at index 0
603  m_notebook->SetSelection( 0 );
604 
605  INDICATOR_ICON* oldIndicator = (INDICATOR_ICON*) getLayerComp( m_CurrentRow, 0 );
606  if( oldIndicator )
608 
609  INDICATOR_ICON* newIndicator = (INDICATOR_ICON*) getLayerComp( aRow, 0 );
610  if( newIndicator )
611  {
613 
614  // Make sure the desired layer row is visible.
615  // It seems that as of 2.8.2, setting the focus does this.
616  // I don't expect the scrolling to be needed at all because
617  // the minimum window size may end up being established so that the
618  // scroll bars will not be visible.
619  getLayerComp( aRow, 1 )->SetFocus();
620  }
621 
622  m_CurrentRow = aRow;
623 
624  // give the focus back to the app.
625  passOnFocus();
626 }
void SetIndicatorState(ICON_ID aIconId)
Sets the row indiciator to the given state.
wxAuiNotebook * m_notebook
Definition: layer_widget.h:110
int m_CurrentRow
selected row of layer list
Definition: layer_widget.h:119
#define OFF
Class representing a row indicator icon for use in places like the layer widget.
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
void passOnFocus()
Function passOnFocus gives away the keyboard focus up to the main parent window.
#define ON
void LAYER_WIDGET::SetLayerColor ( LAYER_NUM  aLayer,
COLOR4D  aColor 
)
inherited

Function SetLayerColor changes the color of aLayer.

Definition at line 671 of file layer_widget.cpp.

References LAYER_WIDGET::findLayerRow(), and LAYER_WIDGET::getLayerComp().

672 {
673  int row = findLayerRow( aLayer );
674  if( row >= 0 )
675  {
676  int col = 1; // bitmap button is column 1
677  auto bmb = static_cast<COLOR_SWATCH*>( getLayerComp( row, col ) );
678  wxASSERT( bmb );
679 
680  bmb->SetSwatchColor( aColor, false );
681  }
682 }
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
Class representing a simple color swatch, of the kind used to set layer colors.
Definition: color_swatch.h:38
void GERBER_LAYER_WIDGET::SetLayersManagerTabsText ( )

Function SetLayersManagerTabsText Update the layer manager tabs labels Useful when changing Language or to set labels to a non default value.

Definition at line 93 of file class_gerbview_layer_widget.cpp.

References LAYER_WIDGET::m_notebook.

Referenced by GERBER_LAYER_WIDGET(), and GERBVIEW_FRAME::ShowChangedLanguage().

94 {
95  m_notebook->SetPageText(0, _("Layer") );
96  m_notebook->SetPageText(1, _("Render") );
97 }
wxAuiNotebook * m_notebook
Definition: layer_widget.h:110
void LAYER_WIDGET::SetLayerVisible ( LAYER_NUM  aLayer,
bool  isVisible 
)
inherited

Function SetLayerVisible sets aLayer visible or not.

This does not invoke OnLayerVisible().

Definition at line 646 of file layer_widget.cpp.

References COLUMN_COLOR_LYR_CB, LAYER_WIDGET::findLayerRow(), and LAYER_WIDGET::getLayerComp().

Referenced by PCB_LAYER_WIDGET::SyncLayerVisibilities().

647 {
648  int row = findLayerRow( aLayer );
649  if( row >= 0 )
650  {
651  wxCheckBox* cb = (wxCheckBox*) getLayerComp( row, COLUMN_COLOR_LYR_CB );
652  wxASSERT( cb );
653  cb->SetValue( isVisible ); // does not fire an event
654  }
655 }
int findLayerRow(LAYER_NUM aLayer) const
Function findLayerRow returns the row index that aLayer resides in, or -1 if not found.
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
#define COLUMN_COLOR_LYR_CB
Definition: layer_widget.h:53
void LAYER_WIDGET::SetRenderState ( int  aId,
bool  isSet 
)
inherited

Function SetRenderState sets the state of the checkbox associated with aId within the Render tab group of the widget.

Does not fire an event, i.e. does not invoke OnRenderEnable().

Parameters
aIdis the same unique id used when adding a ROW to the Render tab.
isSet= the new checkbox state

Definition at line 702 of file layer_widget.cpp.

References LAYER_WIDGET::findRenderRow(), and LAYER_WIDGET::getRenderComp().

Referenced by GERBVIEW_FRAME::SetElementVisibility(), FOOTPRINT_EDIT_FRAME::SetElementVisibility(), GERBVIEW_FRAME::SetGridVisibility(), and PCB_LAYER_WIDGET::SyncRenderStates().

703 {
704  int row = findRenderRow( aId );
705 
706  if( row >= 0 )
707  {
708  int col = 1; // checkbox is column 1
709  wxCheckBox* cb = (wxCheckBox*) getRenderComp( row, col );
710  wxASSERT( cb );
711  cb->SetValue( isSet ); // does not fire an event
712  }
713 }
int findRenderRow(int aId) const
wxWindow * getRenderComp(int aRow, int aColumn) const
void LAYER_WIDGET::UpdateLayerIcons ( )
inherited

Function UpdateLayerIcons Update all layer manager icons (layers only) Useful when loading a file or clearing a layer because they change, and the indicator arrow icon needs to be updated.

Definition at line 742 of file layer_widget.cpp.

References COLUMN_ICON_ACTIVE, LAYER_WIDGET::getLayerComp(), LAYER_WIDGET::GetLayerRowCount(), LAYER_WIDGET::m_CurrentRow, OFF, ON, and INDICATOR_ICON::SetIndicatorState().

Referenced by GERBVIEW_FRAME::LoadExcellonFiles(), GERBVIEW_FRAME::LoadGerberFiles(), and GERBVIEW_FRAME::LoadZipArchiveFile().

743 {
744  int rowCount = GetLayerRowCount();
745 
746  for( int row = 0; row < rowCount ; row++ )
747  {
749 
750  if( indicator )
751  {
752  auto state = ( row == m_CurrentRow ) ? ROW_ICON_PROVIDER::STATE::ON
754  indicator->SetIndicatorState( state );
755  }
756  }
757 }
void SetIndicatorState(ICON_ID aIconId)
Sets the row indiciator to the given state.
int m_CurrentRow
selected row of layer list
Definition: layer_widget.h:119
#define OFF
Class representing a row indicator icon for use in places like the layer widget.
#define COLUMN_ICON_ACTIVE
Definition: layer_widget.h:51
wxWindow * getLayerComp(int aRow, int aColumn) const
Function getLayerComp returns the component within the m_LayersFlexGridSizer at aRow and aCol or NULL...
int GetLayerRowCount() const
Function GetLayerRowCount returns the number of rows in the layer tab.
#define ON
void LAYER_WIDGET::UpdateLayouts ( )
inherited

Definition at line 732 of file layer_widget.cpp.

References LAYER_WIDGET::m_LayerPanel, LAYER_WIDGET::m_LayersFlexGridSizer, LAYER_WIDGET::m_RenderFlexGridSizer, and LAYER_WIDGET::m_RenderingPanel.

Referenced by LAYER_WIDGET::AppendLayerRow(), and LAYER_WIDGET::AppendRenderRow().

733 {
734  m_LayersFlexGridSizer->Layout();
735  m_RenderFlexGridSizer->Layout();
736  m_LayerPanel->Layout();
737  m_RenderingPanel->Layout();
738  FitInside();
739 }
wxFlexGridSizer * m_LayersFlexGridSizer
Definition: layer_widget.h:113
wxFlexGridSizer * m_RenderFlexGridSizer
Definition: layer_widget.h:116
wxPanel * m_RenderingPanel
Definition: layer_widget.h:114
wxPanel * m_LayerPanel
Definition: layer_widget.h:111
bool GERBER_LAYER_WIDGET::useAlternateBitmap ( int  aRow)
overrideprivatevirtual

Virtual Function useAlternateBitmap.

Returns
true if bitmaps shown in Render layer list are alternate bitmaps, or false if they are "normal" bitmaps

Reimplemented from LAYER_WIDGET.

Definition at line 372 of file class_gerbview_layer_widget.cpp.

References GERBER_FILE_IMAGE_LIST::GetGbrImage(), and GetImagesList().

373 {
374  return GetImagesList()->GetGbrImage( aRow ) != NULL;
375 }
GERBER_FILE_IMAGE_LIST * GetImagesList()
GERBER_FILE_IMAGE * GetGbrImage(int aIdx)

Member Data Documentation

const wxEventType LAYER_WIDGET::EVT_LAYER_COLOR_CHANGE = wxNewEventType()
staticinherited

Definition at line 106 of file layer_widget.h.

Referenced by LAYER_WIDGET::OnLayerSwatchChanged().

bool GERBER_LAYER_WIDGET::m_alwaysShowActiveLayer
private
int LAYER_WIDGET::m_CurrentRow
protectedinherited
wxWindow* LAYER_WIDGET::m_FocusOwner
protectedinherited

Definition at line 118 of file layer_widget.h.

Referenced by LAYER_WIDGET::LAYER_WIDGET(), and LAYER_WIDGET::passOnFocus().

wxPanel* LAYER_WIDGET::m_LayerPanel
protectedinherited
wxScrolledWindow* LAYER_WIDGET::m_LayerScrolledWindow
protectedinherited
wxAuiNotebook* LAYER_WIDGET::m_notebook
protectedinherited
int LAYER_WIDGET::m_PointSize
protectedinherited
wxPanel* LAYER_WIDGET::m_RenderingPanel
protectedinherited
wxScrolledWindow* LAYER_WIDGET::m_RenderScrolledWindow
protectedinherited

Definition at line 115 of file layer_widget.h.

Referenced by LAYER_WIDGET::insertRenderRow(), and LAYER_WIDGET::LAYER_WIDGET().


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