1 /*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2012 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6 * Copyright (C) 2012 Wayne Stambaugh <stambaughw@verizon.net>
7 * Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27 #include <bitmaps.h>
28 #include <board.h>
29 #include <board_design_settings.h>
30 #include <pcb_target.h>
31 #include <base_units.h>
32 #include <settings/color_settings.h>
33 #include <settings/settings_manager.h>
34 #include <trigo.h>
35 #include <i18n_utility.h>
36 #include <geometry/shape_circle.h>
37 #include <eda_draw_frame.h>
38
PCB_TARGET(BOARD_ITEM * aParent)39 PCB_TARGET::PCB_TARGET( BOARD_ITEM* aParent ) :
40 BOARD_ITEM( aParent, PCB_TARGET_T )
41 {
42 m_shape = 0;
43 m_size = Millimeter2iu( 5 ); // Gives a decent size
44 m_lineWidth = Millimeter2iu( DEFAULT_COPPER_LINE_WIDTH );
45 m_layer = Edge_Cuts; // a target is on all layers
46 }
47
PCB_TARGET(BOARD_ITEM * aParent,int aShape,PCB_LAYER_ID aLayer,const wxPoint & aPos,int aSize,int aWidth)48 PCB_TARGET::PCB_TARGET( BOARD_ITEM* aParent, int aShape, PCB_LAYER_ID aLayer,
49 const wxPoint& aPos, int aSize, int aWidth ) :
50 BOARD_ITEM( aParent, PCB_TARGET_T )
51 {
52 m_shape = aShape;
53 m_layer = aLayer;
54 m_pos = aPos;
55 m_size = aSize;
56 m_lineWidth = aWidth;
57 }
58
59
~PCB_TARGET()60 PCB_TARGET::~PCB_TARGET()
61 {
62 }
63
64
HitTest(const wxPoint & aPosition,int aAccuracy) const65 bool PCB_TARGET::HitTest( const wxPoint& aPosition, int aAccuracy ) const
66 {
67 int dX = aPosition.x - m_pos.x;
68 int dY = aPosition.y - m_pos.y;
69 int radius = aAccuracy + ( m_size / 2 );
70 return abs( dX ) <= radius && abs( dY ) <= radius;
71 }
72
73
HitTest(const EDA_RECT & aRect,bool aContained,int aAccuracy) const74 bool PCB_TARGET::HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy ) const
75 {
76 EDA_RECT arect = aRect;
77 arect.Inflate( aAccuracy );
78
79 if( aContained )
80 return arect.Contains( GetBoundingBox() );
81 else
82 return GetBoundingBox().Intersects( arect );
83 }
84
85
Rotate(const wxPoint & aRotCentre,double aAngle)86 void PCB_TARGET::Rotate(const wxPoint& aRotCentre, double aAngle)
87 {
88 RotatePoint( &m_pos, aRotCentre, aAngle );
89 }
90
91
Flip(const wxPoint & aCentre,bool aFlipLeftRight)92 void PCB_TARGET::Flip(const wxPoint& aCentre, bool aFlipLeftRight )
93 {
94 if( aFlipLeftRight )
95 m_pos.x = aCentre.x - ( m_pos.x - aCentre.x );
96 else
97 m_pos.y = aCentre.y - ( m_pos.y - aCentre.y );
98
99 SetLayer( FlipLayer( GetLayer(), GetBoard()->GetCopperLayerCount() ) );
100 }
101
102
GetBoundingBox() const103 const EDA_RECT PCB_TARGET::GetBoundingBox() const
104 {
105 EDA_RECT bBox;
106 bBox.SetX( m_pos.x - m_size / 2 );
107 bBox.SetY( m_pos.y - m_size / 2 );
108 bBox.SetWidth( m_size );
109 bBox.SetHeight( m_size );
110
111 return bBox;
112 }
113
114
GetEffectiveShape(PCB_LAYER_ID aLayer) const115 std::shared_ptr<SHAPE> PCB_TARGET::GetEffectiveShape( PCB_LAYER_ID aLayer ) const
116 {
117 return std::make_shared<SHAPE_CIRCLE>( m_pos, m_size / 2 );
118 }
119
120
GetSelectMenuText(EDA_UNITS aUnits) const121 wxString PCB_TARGET::GetSelectMenuText( EDA_UNITS aUnits ) const
122 {
123 // Targets are on *every* layer by definition
124 return _( "Target" );
125 }
126
127
GetMenuImage() const128 BITMAPS PCB_TARGET::GetMenuImage() const
129 {
130 return BITMAPS::add_pcb_target;
131 }
132
133
Clone() const134 EDA_ITEM* PCB_TARGET::Clone() const
135 {
136 return new PCB_TARGET( *this );
137 }
138
139
SwapData(BOARD_ITEM * aImage)140 void PCB_TARGET::SwapData( BOARD_ITEM* aImage )
141 {
142 assert( aImage->Type() == PCB_TARGET_T );
143
144 std::swap( *((PCB_TARGET*) this), *((PCB_TARGET*) aImage) );
145 }
146
147
GetMsgPanelInfo(EDA_DRAW_FRAME * aFrame,std::vector<MSG_PANEL_ITEM> & aList)148 void PCB_TARGET::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
149 {
150 EDA_UNITS units = aFrame->GetUserUnits();
151
152 aList.emplace_back( _( "PCB Target" ), wxEmptyString );
153
154 aList.emplace_back( _( "Layer" ), GetLayerName() );
155
156 aList.emplace_back( _( "Size" ), MessageTextFromValue( units, GetSize() ) );
157 aList.emplace_back( _( "Width" ), MessageTextFromValue( units, GetWidth() ) );
158 aList.emplace_back( _( "Shape" ), GetShape() == 0 ? "+" : "X" );
159 }
160
161
162 static struct PCB_TARGET_DESC
163 {
PCB_TARGET_DESCPCB_TARGET_DESC164 PCB_TARGET_DESC()
165 {
166 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
167 REGISTER_TYPE( PCB_TARGET );
168 propMgr.InheritsAfter( TYPE_HASH( PCB_TARGET ), TYPE_HASH( BOARD_ITEM ) );
169 propMgr.AddProperty( new PROPERTY<PCB_TARGET, int>( _HKI( "Size" ),
170 &PCB_TARGET::SetSize, &PCB_TARGET::GetSize, PROPERTY_DISPLAY::DISTANCE ) );
171 propMgr.AddProperty( new PROPERTY<PCB_TARGET, int>( _HKI( "Width" ),
172 &PCB_TARGET::SetWidth, &PCB_TARGET::GetWidth, PROPERTY_DISPLAY::DISTANCE ) );
173
174 auto shape = new PROPERTY<PCB_TARGET, int>( _HKI( "Shape" ),
175 &PCB_TARGET::SetShape, &PCB_TARGET::GetShape );
176 // TODO change the integer to an enum?
177 //shape->SetValues( { { 0, _HKI( "Cross" ) }, { 1, ( "Plus" ) } } );
178 propMgr.AddProperty( shape );
179 }
180 } _PCB_TARGET_DESC;
181