KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_sheet_pin.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2006 Jean-Pierre Charras, [email protected]
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
19 */
20
21#include <algorithm>
22
23#include <bitmaps.h>
24#include <api/api_enums.h>
25#include <api/api_utils.h>
26#include <api/schematic/schematic_types.pb.h>
27#include <general.h>
29#include <string_utils.h>
30#include <plotters/plotter.h>
31#include <sch_draw_panel.h>
32#include <sch_edit_frame.h>
33#include <sch_sheet.h>
34#include <sch_sheet_pin.h>
35#include <sch_painter.h>
36#include <schematic.h>
37#include <trigo.h>
38#include <properties/property.h>
40
41
42SCH_SHEET_PIN::SCH_SHEET_PIN( SCH_SHEET* parent, const VECTOR2I& pos, const wxString& text ) :
45{
46 SetParent( parent );
47 wxASSERT( parent );
49
50 SetTextPos( pos );
51
52 if( parent->IsVerticalOrientation() )
54 else
56
58 m_isDangling = true;
59 m_number = 2;
60}
61
62
63void SCH_SHEET_PIN::Serialize( kiapi::schematic::types::SheetPin& pin ) const
64{
65 using namespace kiapi::schematic::types;
66
67
68 pin.mutable_id()->set_value( m_Uuid.AsStdString() );
69 kiapi::common::PackVector2( *pin.mutable_position(), GetPosition(), schIUScale );
70 pin.set_spin_style( ToProtoEnum<SPIN_STYLE::SPIN,
71 SchematicLabelSpinStyle>( static_cast<SPIN_STYLE::SPIN>( (int) GetSpinStyle() ) ) );
74 pin.set_locked( SCH_ITEM::IsLocked() ? kiapi::common::types::LockedState::LS_LOCKED
75 : kiapi::common::types::LockedState::LS_UNLOCKED );
76
77 EDA_TEXT::Serialize( *pin.mutable_text(), schIUScale );
78
79 kiapi::common::PackCustomProperties( pin.mutable_custom_properties(), *this );
80}
81
82void SCH_SHEET_PIN::Serialize( google::protobuf::Any& aContainer ) const
83{
84 kiapi::schematic::types::SheetPin pin;
85 Serialize( pin );
86
87 if( !aContainer.PackFrom( pin ) )
88 wxFAIL_MSG( wxT( "Failed to pack SCH_SHEET_PIN" ) );
89}
90
91
92bool SCH_SHEET_PIN::Deserialize( const kiapi::schematic::types::SheetPin& pin )
93{
94 using namespace kiapi::schematic::types;
95
96 const_cast<KIID&>( m_Uuid ) = KIID( pin.id().value() );
97
98 if( !EDA_TEXT::Deserialize( pin.text(), schIUScale ) )
99 return false;
100
105 SetLocked( pin.locked() == kiapi::common::types::LockedState::LS_LOCKED );
106 kiapi::common::UnpackCustomProperties( pin.custom_properties(), *this );
107 return true;
108}
109
110bool SCH_SHEET_PIN::Deserialize( const google::protobuf::Any& aContainer )
111{
112 kiapi::schematic::types::SheetPin pin;
113
114 if( !aContainer.UnpackTo( &pin ) )
115 return false;
116
117 return Deserialize( pin );
118}
119
120
122{
123 return new SCH_SHEET_PIN( *this );
124}
125
126
128{
130
131 wxCHECK_RET( aItem->Type() == SCH_SHEET_PIN_T,
132 wxString::Format( "SCH_SHEET_PIN object cannot swap data with %s object.", aItem->GetClass() ) );
133
134 SCH_SHEET_PIN* pin = static_cast<SCH_SHEET_PIN*>( aItem );
135
136 std::swap( m_number, pin->m_number );
137 std::swap( m_edge, pin->m_edge );
138}
139
140
142{
143 if( Schematic() )
145
146 return schIUScale.MilsToIU( DEFAULT_LINE_WIDTH_MILS );
147}
148
149
150void SCH_SHEET_PIN::SetNumber( int aNumber )
151{
152 wxASSERT( aNumber >= 2 );
153
154 m_number = aNumber;
155}
156
157
159{
160 SCH_SHEET* sheet = GetParent();
161
162 // use SHEET_UNDEFINED_SIDE to adjust text orientation without changing edge
163
164 switch( aEdge )
165 {
166 case SHEET_SIDE::LEFT:
167 m_edge = aEdge;
168 SetTextX( sheet->m_pos.x );
169 SetSpinStyle( SPIN_STYLE::RIGHT ); // Orientation horiz inverse
170 break;
171
173 m_edge = aEdge;
174 SetTextX( sheet->m_pos.x + sheet->m_size.x );
175 SetSpinStyle( SPIN_STYLE::LEFT ); // Orientation horiz normal
176 break;
177
178 case SHEET_SIDE::TOP:
179 m_edge = aEdge;
180 SetTextY( sheet->m_pos.y );
181 SetSpinStyle( SPIN_STYLE::BOTTOM ); // Orientation vert BOTTOM
182 break;
183
185 m_edge = aEdge;
186 SetTextY( sheet->m_pos.y + sheet->m_size.y );
187 SetSpinStyle( SPIN_STYLE::UP ); // Orientation vert UP
188 break;
189
190 default:
191 break;
192 }
193}
194
195
197{
198 return m_edge;
199}
200
201
202void SCH_SHEET_PIN::ConstrainOnEdge( const VECTOR2I& aPos, bool aAllowEdgeSwitch )
203{
204 SCH_SHEET* sheet = GetParent();
205
206 if( sheet == nullptr )
207 return;
208
209 int leftSide = sheet->m_pos.x;
210 int rightSide = sheet->m_pos.x + sheet->m_size.x;
211 int topSide = sheet->m_pos.y;
212 int botSide = sheet->m_pos.y + sheet->m_size.y;
213
214 SHAPE_LINE_CHAIN sheetEdge;
215
216 sheetEdge.Append( leftSide, topSide );
217 sheetEdge.Append( rightSide, topSide );
218 sheetEdge.Append( rightSide, botSide );
219 sheetEdge.Append( leftSide, botSide );
220 sheetEdge.Append( leftSide, topSide );
221
222 if( aAllowEdgeSwitch )
223 {
224 switch( sheetEdge.NearestSegment( aPos ) )
225 {
226 case 0: SetSide( SHEET_SIDE::TOP ); break;
227 case 1: SetSide( SHEET_SIDE::RIGHT ); break;
228 case 2: SetSide( SHEET_SIDE::BOTTOM ); break;
229 case 3: SetSide( SHEET_SIDE::LEFT ); break;
230 default: wxASSERT( "Invalid segment number" );
231 }
232 }
233 else
234 {
235 SetSide( GetSide() );
236 }
237
238 switch( GetSide() )
239 {
241 case SHEET_SIDE::LEFT:
242 SetTextY( aPos.y );
243
244 if( GetTextPos().y < topSide )
245 SetTextY( topSide );
246
247 if( GetTextPos().y > botSide )
248 SetTextY( botSide );
249
250 break;
251
253 case SHEET_SIDE::TOP:
254 SetTextX( aPos.x );
255
256 if( GetTextPos().x < leftSide )
257 SetTextX( leftSide );
258
259 if( GetTextPos().x > rightSide )
260 SetTextX( rightSide );
261
262 break;
263
265 wxASSERT( "Undefined sheet side" );
266 }
267}
268
269
271{
272 int p = GetTextPos().y - aCenter;
273
274 SetTextY( aCenter - p );
275
276 switch( m_edge )
277 {
280 default: break;
281 }
282}
283
284
286{
287 int p = GetTextPos().x - aCenter;
288
289 SetTextX( aCenter - p );
290
291 switch( m_edge )
292 {
295 default: break;
296 }
297}
298
299
300void SCH_SHEET_PIN::Rotate( const VECTOR2I& aCenter, bool aRotateCCW )
301{
302 VECTOR2I pt = GetTextPos();
303 VECTOR2I delta = pt - aCenter;
304
305 RotatePoint( pt, aCenter, aRotateCCW ? ANGLE_90 : ANGLE_270 );
306
307 SHEET_SIDE oldSide = GetSide();
308 ConstrainOnEdge( pt, true );
309
310 // If the new side is the same as the old side, instead mirror across the center of that side.
311 if( GetSide() == oldSide )
312 {
313 switch( GetSide() )
314 {
315 case SHEET_SIDE::TOP:
317 SetTextPos( VECTOR2I( aCenter.x - delta.x, GetTextPos().y ) );
318 break;
319
320 case SHEET_SIDE::LEFT:
322 SetTextPos( VECTOR2I( GetTextPos().x, aCenter.y - delta.y ) );
323 break;
324
325 default:
326 break;
327 }
328 }
329 // If the new side is opposite to the old side, instead mirror across the center of an adjacent
330 // side.
331 else if( GetSide() == GetOppositeSide( oldSide ) )
332 {
333 switch( GetSide() )
334 {
335 case SHEET_SIDE::TOP:
337 SetTextPos( VECTOR2I( aCenter.x + delta.x, GetTextPos().y ) );
338 break;
339
340 case SHEET_SIDE::LEFT:
342 SetTextPos( VECTOR2I( GetTextPos().x, aCenter.y + delta.y ) );
343 break;
344
345 default:
346 break;
347 }
348 }
349}
350
351
352void SCH_SHEET_PIN::CreateGraphicShape( const RENDER_SETTINGS* aSettings, std::vector<VECTOR2I>& aPoints,
353 const VECTOR2I& aPos ) const
354{
355 /*
356 * These are the same icon shapes as SCH_HIERLABEL but the graphic icon is slightly
357 * different in 2 cases:
358 * for INPUT type the icon is the OUTPUT shape of SCH_HIERLABEL
359 * for OUTPUT type the icon is the INPUT shape of SCH_HIERLABEL
360 */
362
363 switch( shape )
364 {
367 default: break;
368 }
369
370 SCH_HIERLABEL::CreateGraphicShape( aSettings, aPoints, aPos, shape );
371}
372
373
374void SCH_SHEET_PIN::GetEndPoints( std::vector<DANGLING_END_ITEM>& aItemList )
375{
377 aItemList.push_back( item );
378}
379
380
381wxString SCH_SHEET_PIN::GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
382{
383 return wxString::Format( _( "Hierarchical Sheet Pin '%s'" ), aFull ? GetShownText( FOR_GUI )
385}
386
387
392
393
394bool SCH_SHEET_PIN::HitTest( const VECTOR2I& aPoint, int aAccuracy ) const
395{
397
398 rect.Inflate( aAccuracy );
399
400 return rect.Contains( aPoint );
401}
402
403
404bool SCH_SHEET_PIN::operator==( const SCH_ITEM& aOther ) const
405{
406 if( aOther.Type() != Type() )
407 return false;
408
409 const SCH_SHEET_PIN* other = static_cast<const SCH_SHEET_PIN*>( &aOther );
410
411 if( GetNumber() != other->GetNumber() )
412 return false;
413
414 if( GetSide() != other->GetSide() )
415 return false;
416
417 return SCH_HIERLABEL::operator==( *other );
418}
419
420
421double SCH_SHEET_PIN::Similarity( const SCH_ITEM& aOther ) const
422{
423 if( aOther.Type() != Type() )
424 return 0.0;
425
426 const SCH_SHEET_PIN* other = static_cast<const SCH_SHEET_PIN*>( &aOther );
427
428 double similarity = 1.0;
429
430 if( m_edge != other->m_edge )
431 similarity *= 0.9;
432
433 if( m_number != other->m_number )
434 similarity *= 0.9;
435
436 similarity *= SCH_HIERLABEL::Similarity( aOther );
437
438 return similarity;
439}
440
441
442bool SCH_SHEET_PIN::HasConnectivityChanges( const SCH_ITEM* aItem, const SCH_SHEET_PATH* aInstance ) const
443{
444 // Do not compare to ourself.
445 if( aItem == this )
446 return false;
447
448 const SCH_SHEET_PIN* pin = dynamic_cast<const SCH_SHEET_PIN*>( aItem );
449
450 // Don't compare against a different SCH_ITEM.
451 wxCHECK( pin, false );
452
453 if( GetPosition() != pin->GetPosition() )
454 return true;
455
456 return GetText() != pin->GetText();
457}
458
459
461{
462 if( SCH_SHEET* parentSheet = GetParent() )
463 {
464 if( parentSheet->IsLocked() )
465 return true;
466 }
467
468 return SCH_ITEM::IsLocked();
469}
470
471
472#if defined(DEBUG)
473
474void SCH_SHEET_PIN::Show( int nestLevel, std::ostream& os ) const
475{
476 // XML output:
477 NestedSpace( nestLevel, os ) << '<' << GetClass().Lower().mb_str() << ">"
478 << " pin_name=\"" << TO_UTF8( GetText() )
479 << '"' << "/>\n" << std::flush;
480}
481
482#endif
483
484
KICOMMON_API types::KiCadObjectType ToProtoEnum(KICAD_T aValue)
KICOMMON_API KICAD_T FromProtoEnum(types::KiCadObjectType aValue)
Definition api_enums.cpp:56
constexpr EDA_IU_SCALE schIUScale
Definition base_units.h:130
BITMAPS
A list of all bitmap identifiers.
@ add_hierar_pin
BOX2< VECTOR2I > BOX2I
Definition box2.h:917
Helper class used to store the state of schematic items that can be connected to other schematic item...
Definition sch_item.h:101
A base class for most all the KiCad significant classes used in schematics and boards.
Definition eda_item.h:98
const KIID m_Uuid
Definition eda_item.h:599
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
virtual void SetParent(EDA_ITEM *aParent)
Definition eda_item.cpp:153
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
Definition eda_text.cpp:170
virtual VECTOR2I GetTextPos() const
Definition eda_text.h:313
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition eda_text.h:118
virtual void SetTextPos(const VECTOR2I &aPoint)
Definition eda_text.cpp:557
virtual void SetTextX(int aX)
Definition eda_text.cpp:564
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
Definition eda_text.cpp:201
virtual void SetTextY(int aY)
Definition eda_text.cpp:570
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
Definition kiid.h:46
Provide class metadata.
void InheritsAfter(TYPE_ID aDerived, TYPE_ID aBase)
Declare an inheritance relationship between types.
void Mask(TYPE_ID aDerived, TYPE_ID aBase, const wxString &aName)
Sets a base class property as masked in a derived class.
static PROPERTY_MANAGER & Instance()
void AddTypeCast(TYPE_CAST_BASE *aCast)
Register a type converter.
SCHEMATIC_SETTINGS & Settings() const
void SetSpinStyle(SPIN_STYLE aSpinStyle) override
void CreateGraphicShape(const RENDER_SETTINGS *aSettings, std::vector< VECTOR2I > &aPoints, const VECTOR2I &aPos) const override
Calculate the graphic shape (a polygon) associated to the text.
SCH_HIERLABEL(const VECTOR2I &aPos=VECTOR2I(0, 0), const wxString &aText=wxEmptyString, KICAD_T aType=SCH_HIER_LABEL_T)
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition sch_item.h:170
void SetLocked(bool aLocked) override
Definition sch_item.h:262
virtual void swapData(SCH_ITEM *aItem)
Swap the internal data structures aItem with the schematic item.
Definition sch_item.cpp:834
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
Definition sch_item.cpp:302
virtual double Similarity(const SCH_ITEM &aItem) const
Return a measure of how likely the other object is to represent the same object.
Definition sch_item.h:393
bool IsLocked() const override
Definition sch_item.cpp:179
virtual bool operator==(const SCH_ITEM &aOther) const
Definition sch_item.cpp:911
wxString GetClass() const override
Return the class name.
Definition sch_item.h:180
SCH_LAYER_ID m_layer
Definition sch_item.h:843
SPIN_STYLE GetSpinStyle() const
void SetShape(LABEL_FLAG_SHAPE aShape)
Definition sch_label.h:179
LABEL_FLAG_SHAPE GetShape() const
Definition sch_label.h:178
const BOX2I GetBoundingBox() const override
Return the bounding box of the label including its fields.
wxString GetShownText(const SCH_SHEET_PATH *aPath, RESOLUTION_CONTEXT aContext, int aDepth=0) const override
LABEL_FLAG_SHAPE m_shape
Definition sch_label.h:365
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Define a sheet pin (label) used in sheets to create hierarchical schematics.
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
bool operator==(const SCH_ITEM &aOther) const override
void SetNumber(int aNumber)
Set the sheet label number.
bool IsLocked() const override
SCH_SHEET_PIN(SCH_SHEET *parent, const VECTOR2I &pos=VECTOR2I(0, 0), const wxString &text=wxEmptyString)
SHEET_SIDE m_edge
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
void SetPosition(const VECTOR2I &aPosition) override
int m_number
Label number use for saving sheet label to file.
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
bool HasConnectivityChanges(const SCH_ITEM *aItem, const SCH_SHEET_PATH *aInstance=nullptr) const override
Check if aItem has connectivity changes against this object.
void swapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
double Similarity(const SCH_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
int GetPenWidth() const override
static SHEET_SIDE GetOppositeSide(SHEET_SIDE aSide)
void CreateGraphicShape(const RENDER_SETTINGS *aSettings, std::vector< VECTOR2I > &aPoints, const VECTOR2I &aPos) const override
Calculate the graphic shape (a polygon) associated to the text.
SHEET_SIDE GetSide() const
wxString GetClass() const override
Return the class name.
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Add the schematic item end points to aItemList if the item has end points.
int GetNumber() const
Get the sheet label number.
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
SCH_SHEET * GetParent() const
Get the parent sheet object of this sheet pin.
void ConstrainOnEdge(const VECTOR2I &aPos, bool aAllowEdgeSwitch)
Adjust label position to edge based on proximity to vertical or horizontal edge of the parent sheet.
void SetSide(SHEET_SIDE aEdge)
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition sch_sheet.h:50
VECTOR2I m_size
Definition sch_sheet.h:759
VECTOR2I m_pos
Definition sch_sheet.h:758
bool IsVerticalOrientation() const
VECTOR2I GetPosition() const override
Definition sch_text.h:143
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
int NearestSegment(const VECTOR2I &aP) const
Find the segment nearest the given point.
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
@ FOR_GUI
Definition common.h:93
#define DEFAULT_LINE_WIDTH_MILS
The default line width in mils. (can be changed in preference menu)
#define _(s)
static constexpr EDA_ANGLE ANGLE_90
Definition eda_angle.h:474
static constexpr EDA_ANGLE ANGLE_270
Definition eda_angle.h:477
@ LAYER_SHEETLABEL
Definition layer_ids.h:506
KICOMMON_API wxString EllipsizeMenuText(const wxString &aString)
Ellipsize text (at the end) to be no more than 36 characters.
KICOMMON_API void PackCustomProperties(google::protobuf::RepeatedPtrField< types::CustomProperty > *aOutput, const EDA_ITEM &aItem)
KICOMMON_API VECTOR2I UnpackVector2(const types::Vector2 &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void PackVector2(types::Vector2 &aOutput, const VECTOR2I &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void UnpackCustomProperties(const google::protobuf::RepeatedPtrField< types::CustomProperty > &aInput, EDA_ITEM &aItem)
#define _HKI(x)
Definition page_info.cpp:40
#define TYPE_HASH(x)
Macro to generate unique identifier for a type.
Definition property.h:74
#define REGISTER_TYPE(x)
Helper macro to map type hashes to names.
@ SHEET_LABEL_END
Definition sch_item.h:91
LABEL_FLAG_SHAPE
Label and flag shapes used with text objects.
Definition sch_label.h:97
@ L_OUTPUT
Definition sch_label.h:99
@ L_INPUT
Definition sch_label.h:98
static struct SCH_SHEET_PIN_DESC _SCH_SHEET_PIN_DESC
SHEET_SIDE
Define the edge of the sheet that the sheet pin is positioned.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
KIBIS_PIN * pin
int delta
void RotatePoint(int *pX, int *pY, const EDA_ANGLE &aAngle)
Calculate the new point of coord coord pX, pY, for a rotation center 0, 0.
Definition trigo.cpp:227
@ SCH_SHEET_PIN_T
Definition typeinfo.h:170
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:708
static PIECE rect(double aLeft, double aTop, double aRight, double aBottom, bool aMixed=false)