dialog_pad_properties.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2013 Dick Hollenbeck, [email protected]
 * Copyright (C) 2008-2013 Wayne Stambaugh <[email protected]>
 * Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */

#ifndef _DIALOG_PAD_PROPERTIES_H_
#define _DIALOG_PAD_PROPERTIES_H_

#include <pcb_base_frame.h>
#include <base_units.h>
#include <wx/valnum.h>
#include <board.h>
#include <footprint.h>
#include <pad_shapes.h>
#include <pcb_shape.h>
#include <origin_viewitem.h>
#include <dialog_pad_properties_base.h>
#include <widgets/text_ctrl_eval.h>
#include <pcb_draw_panel_gal.h>
#include <widgets/unit_binder.h>

// The wxWidgets window name. Used to retrieve the dialog by window name
#define PAD_PROPERTIES_DLG_NAME wxT( "pad_properties_dlg_name" )

class DIALOG_PAD_PROPERTIES : public DIALOG_PAD_PROPERTIES_BASE
{
public:
 DIALOG_PAD_PROPERTIES( PCB_BASE_FRAME* aParent, PAD* aPad );
 ~DIALOG_PAD_PROPERTIES();

private:
 void prepareCanvas(); // Initialize the canvases (legacy or gal) to display the pad
 void initValues();
 void displayPrimitivesList();
 bool padValuesOK(); 
 void redraw();
 void editPrimitive();
 void updateRoundRectCornerValues();
 void enablePrimitivePage( bool aEnable ); 

 void updatePadLayersList( LSET layer_mask, bool remove_unconnected, bool keep_top_bottom );

 bool transferDataToPad( PAD* aPad );

 bool Show( bool aShow ) override;

 // event handlers:
 void OnInitDialog( wxInitDialogEvent& event ) override;
 void OnResize( wxSizeEvent& event );
 void OnCancel( wxCommandEvent& event ) override;
 void OnUpdateUI( wxUpdateUIEvent& event ) override;

 void OnUpdateUINonCopperWarning( wxUpdateUIEvent& event ) override;

 void OnPadShapeSelection( wxCommandEvent& event ) override;
 void OnDrillShapeSelected( wxCommandEvent& event ) override;
 void onChangePadMode( wxCommandEvent& event ) override;
 void OnOffsetCheckbox( wxCommandEvent& event ) override;
 void OnPadToDieCheckbox( wxCommandEvent& event ) override;

 void PadOrientEvent( wxCommandEvent& event ) override;
 void PadTypeSelected( wxCommandEvent& event ) override;

 void UpdateLayersDropdown();
 void OnSetCopperLayers( wxCommandEvent& event ) override;
 void OnSetLayers( wxCommandEvent& event ) override;

 // Called when corner setup value is changed for rounded rect pads
 void onCornerSizePercentChange( wxCommandEvent& event ) override;
 void onCornerRadiusChange( wxCommandEvent& event ) override;

 void OnValuesChanged( wxCommandEvent& event ) override;


 bool TransferDataFromWindow() override;
 bool TransferDataToWindow() override;

 void onDeletePrimitive( wxCommandEvent& event ) override;
 void onEditPrimitive( wxCommandEvent& event ) override;
 void onAddPrimitive( wxCommandEvent& event ) override;
 void onGeometryTransform( wxCommandEvent& event ) override;
 void onDuplicatePrimitive( wxCommandEvent& event ) override;

 void onPrimitiveDClick( wxMouseEvent& event ) override;
 void OnPrimitiveSelection( wxListEvent& event ) override;

 PAD_PROP getSelectedProperty();

private:
 PCB_BASE_FRAME* m_parent;
 PAD* m_currentPad; // pad currently being edited
 PAD* m_dummyPad; // a working copy used to show changes
 PAD* m_padMaster; // pad used to create new pads in board or footprint editor
 BOARD* m_board; // the main board: this is the board handled by the PCB
 // editor or the dummy board used by the footprint editor
 bool m_isFlipped; // indicates the parent footprint is flipped (mirrored) in
 // which case some Y coordinates values must be negated
 bool m_canUpdate;
 bool m_canEditNetName; // true only if the caller is the board editor
 bool m_isFpEditor; // true if the caller is the footprint editor

 std::vector<std::shared_ptr<PCB_SHAPE>> m_primitives; // the custom shape primitives in
 // local coords, orient 0
 // must define a single copper area
 COLOR4D m_selectedColor; // color used to draw selected primitives when
 // editing a custom pad shape

 std::vector<PCB_SHAPE*> m_highlight; // shapes highlighted in GAL mode
 PCB_DRAW_PANEL_GAL* m_padPreviewGAL;
 KIGFX::ORIGIN_VIEWITEM* m_axisOrigin; // origin of the preview canvas
 static bool m_sketchPreview; // session storage

 UNIT_BINDER m_posX, m_posY;
 UNIT_BINDER m_sizeX, m_sizeY;
 UNIT_BINDER m_offsetX, m_offsetY;
 UNIT_BINDER m_padToDie;
 UNIT_BINDER m_trapDelta;
 UNIT_BINDER m_cornerRadius;
 UNIT_BINDER m_cornerRatio;
 UNIT_BINDER m_chamferRatio;
 UNIT_BINDER m_mixedCornerRatio, m_mixedChamferRatio;
 UNIT_BINDER m_holeX, m_holeY;
 UNIT_BINDER m_clearance;
 UNIT_BINDER m_maskMargin;
 UNIT_BINDER m_pasteMargin, m_pasteMarginRatio;
 UNIT_BINDER m_spokeWidth, m_thermalGap;
 UNIT_BINDER m_pad_orientation;
};

class DIALOG_PAD_PRIMITIVES_PROPERTIES: public DIALOG_PAD_PRIMITIVES_PROPERTIES_BASE
{
public:
 DIALOG_PAD_PRIMITIVES_PROPERTIES( wxWindow* aParent, PCB_BASE_FRAME* aFrame,
 PCB_SHAPE* aShape );

 bool TransferDataFromWindow() override;

private:
 bool TransferDataToWindow() override;

 // The basic shape currently edited
 PCB_SHAPE* m_shape;

 UNIT_BINDER m_startX;
 UNIT_BINDER m_startY;
 UNIT_BINDER m_ctrl1X;
 UNIT_BINDER m_ctrl1Y;
 UNIT_BINDER m_ctrl2X;
 UNIT_BINDER m_ctrl2Y;
 UNIT_BINDER m_endX;
 UNIT_BINDER m_endY;
 UNIT_BINDER m_radius;
 UNIT_BINDER m_thickness;
};


class DIALOG_PAD_PRIMITIVE_POLY_PROPS: public DIALOG_PAD_PRIMITIVE_POLY_PROPS_BASE
{
public:
 DIALOG_PAD_PRIMITIVE_POLY_PROPS( wxWindow* aParent, PCB_BASE_FRAME* aFrame,
 PCB_SHAPE* aShape );
 ~DIALOG_PAD_PRIMITIVE_POLY_PROPS();

 bool TransferDataFromWindow() override;

private:
 bool TransferDataToWindow() override;

 bool Validate() override;

 // Events handlers:
 void OnButtonAdd( wxCommandEvent& event ) override;
 void OnButtonDelete( wxCommandEvent& event ) override;
 void onPaintPolyPanel( wxPaintEvent& event ) override;
 void onPolyPanelResize( wxSizeEvent& event ) override;
 void onGridSelect( wxGridRangeSelectEvent& event ) override;
 void onCellChanging( wxGridEvent& event );
 void onCellSelect( wxGridEvent& event ) override
 {
 event.Skip();
 }

 bool doValidate( bool aRemoveRedundantCorners );

 // The basic shape currently edited
 PCB_SHAPE* m_shape;

 // The working copy of the basic shape currently edited
 std::vector<wxPoint> m_currPoints;

 UNIT_BINDER m_thickness;
};


class DIALOG_PAD_PRIMITIVES_TRANSFORM : public DIALOG_PAD_PRIMITIVES_TRANSFORM_BASE
{
public:
 DIALOG_PAD_PRIMITIVES_TRANSFORM( wxWindow* aParent, PCB_BASE_FRAME* aFrame,
 std::vector<std::shared_ptr<PCB_SHAPE>>& aList,
 bool aShowDuplicate );

 void Transform( std::vector<std::shared_ptr<PCB_SHAPE>>* aList = nullptr,
 int aDuplicateCount = 0 );

 int GetDuplicateCount() { return m_spinCtrlDuplicateCount->GetValue(); }

private:
 std::vector<std::shared_ptr<PCB_SHAPE>>& m_list;

 UNIT_BINDER m_vectorX;
 UNIT_BINDER m_vectorY;
 UNIT_BINDER m_rotation;
};

#endif // #ifndef _DIALOG_PAD_PROPERTIES_H_