KiCad PCB EDA Suite
Loading...
Searching...
No Matches
footprint.h
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) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 1992-2023 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, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#ifndef FOOTPRINT_H
26#define FOOTPRINT_H
27
28#include <deque>
29
30#include <template_fieldnames.h>
31
33#include <board_item.h>
34#include <collectors.h>
35#include <layer_ids.h> // ALL_LAYERS definition.
36#include <lib_id.h>
37#include <list>
38
39#include <zones.h>
41#include <pcb_item_containers.h>
42#include <pcb_text.h>
43#include <pcb_field.h>
44#include <functional>
45#include <math/vector3.h>
46
47class LINE_READER;
48class EDA_3D_CANVAS;
49class PAD;
50class BOARD;
51class MSG_PANEL_ITEM;
52class SHAPE;
53class REPORTER;
54
55namespace KIGFX {
56class VIEW;
57}
58
60{
62 INCLUDE_NPTH = true
63};
64
71{
73 FP_SMD = 0x0002,
76 FP_BOARD_ONLY = 0x0010, // Footprint has no corresponding symbol
77 FP_JUST_ADDED = 0x0020, // Footprint just added by netlist update
80 FP_DNP = 0x0100
81};
82
84{
85public:
87 // Initialize with sensible values
88 m_Scale { 1, 1, 1 },
89 m_Rotation { 0, 0, 0 },
90 m_Offset { 0, 0, 0 },
91 m_Opacity( 1.0 ),
92 m_Show( true )
93 {
94 }
95
99 double m_Opacity;
100 wxString m_Filename;
101 bool m_Show;
102};
103
104
106{
107public:
108 FOOTPRINT( BOARD* parent );
109
110 FOOTPRINT( const FOOTPRINT& aFootprint );
111
112 // Move constructor and operator needed due to std containers inside the footprint
113 FOOTPRINT( FOOTPRINT&& aFootprint );
114
115 ~FOOTPRINT();
116
117 FOOTPRINT& operator=( const FOOTPRINT& aOther );
118 FOOTPRINT& operator=( FOOTPRINT&& aOther );
119
120 static inline bool ClassOf( const EDA_ITEM* aItem )
121 {
122 return aItem && aItem->Type() == PCB_FOOTPRINT_T;
123 }
124
126 void SetPrivateLayers( LSET aLayers ) { m_privateLayers = aLayers; }
127
129 void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_MODE::INSERT,
130 bool aSkipConnectivity = false ) override;
131
133 void Remove( BOARD_ITEM* aItem, REMOVE_MODE aMode = REMOVE_MODE::NORMAL ) override;
134
142 void ClearAllNets();
143
151 bool FixUuids();
152
163
170
171 // Virtual function
172 const BOX2I GetBoundingBox() const override;
173 const BOX2I GetBoundingBox( bool aIncludeText, bool aIncludeInvisibleText ) const;
174
178 const BOX2I GetLayerBoundingBox( LSET aLayers ) const;
179
180 VECTOR2I GetCenter() const override
181 {
182 return GetBoundingBox( false, false ).GetCenter();
183 }
184
185 PCB_FIELDS& Fields() { return m_fields; }
186 const PCB_FIELDS& Fields() const { return m_fields; }
187
188 PADS& Pads() { return m_pads; }
189 const PADS& Pads() const { return m_pads; }
190
191 DRAWINGS& GraphicalItems() { return m_drawings; }
192 const DRAWINGS& GraphicalItems() const { return m_drawings; }
193
194 ZONES& Zones() { return m_zones; }
195 const ZONES& Zones() const { return m_zones; }
196
197 GROUPS& Groups() { return m_groups; }
198 const GROUPS& Groups() const { return m_groups; }
199
200 bool HasThroughHolePads() const;
201
202 std::vector<FP_3DMODEL>& Models() { return m_3D_Drawings; }
203 const std::vector<FP_3DMODEL>& Models() const { return m_3D_Drawings; }
204
205 void SetPosition( const VECTOR2I& aPos ) override;
206 VECTOR2I GetPosition() const override { return m_pos; }
207
208 void SetOrientation( const EDA_ANGLE& aNewAngle );
210
215 void SetLayerAndFlip( PCB_LAYER_ID aLayer );
216
217 // to make property magic work
218 PCB_LAYER_ID GetLayer() const override { return BOARD_ITEM::GetLayer(); }
219
220 // For property system:
221 void SetOrientationDegrees( double aOrientation )
222 {
223 SetOrientation( EDA_ANGLE( aOrientation, DEGREES_T ) );
224 }
226 {
227 return m_orient.AsDegrees();
228 }
229
230 const LIB_ID& GetFPID() const { return m_fpid; }
231 void SetFPID( const LIB_ID& aFPID ) { m_fpid = aFPID; }
232
233 wxString GetFPIDAsString() const { return m_fpid.Format(); }
234 void SetFPIDAsString( const wxString& aFPID ) { m_fpid.Parse( aFPID ); }
235
236 wxString GetLibDescription() const { return m_libDescription; }
237 void SetLibDescription( const wxString& aDesc ) { m_libDescription = aDesc; }
238
239 wxString GetKeywords() const { return m_keywords; }
240 void SetKeywords( const wxString& aKeywords ) { m_keywords = aKeywords; }
241
242 const KIID_PATH& GetPath() const { return m_path; }
243 void SetPath( const KIID_PATH& aPath ) { m_path = aPath; }
244
245 wxString GetSheetname() const { return m_sheetname; }
246 void SetSheetname( const wxString& aSheetname ) { m_sheetname = aSheetname; }
247
248 wxString GetSheetfile() const { return m_sheetfile; }
249 void SetSheetfile( const wxString& aSheetfile ) { m_sheetfile = aSheetfile; }
250
251 wxString GetFilters() const { return m_filters; }
252 void SetFilters( const wxString& aFilters ) { m_filters = aFilters; }
253
255 void SetLocalSolderMaskMargin( int aMargin ) { m_localSolderMaskMargin = aMargin; }
256
257 int GetLocalClearance() const { return m_localClearance; }
258 void SetLocalClearance( int aClearance ) { m_localClearance = aClearance; }
259
260 int GetLocalClearance( wxString* aSource ) const
261 {
262 if( aSource )
263 *aSource = wxString::Format( _( "footprint %s" ), GetReference() );
264
265 return m_localClearance;
266 }
267
269 void SetLocalSolderPasteMargin( int aMargin ) { m_localSolderPasteMargin = aMargin; }
270
273
276
277 int GetAttributes() const { return m_attributes; }
278 void SetAttributes( int aAttributes ) { m_attributes = aAttributes; }
279
280 void SetFlag( int aFlag ) { m_arflag = aFlag; }
281 void IncrementFlag() { m_arflag += 1; }
282 int GetFlag() const { return m_arflag; }
283
284 bool IsNetTie() const
285 {
286 for( const wxString& group : m_netTiePadGroups )
287 {
288 if( !group.IsEmpty() )
289 return true;
290 }
291
292 return false;
293 }
294
299 const std::vector<wxString>& GetNetTiePadGroups() const { return m_netTiePadGroups; }
300
302 {
303 m_netTiePadGroups.clear();
304 }
305
306 void AddNetTiePadGroup( const wxString& aGroup )
307 {
308 m_netTiePadGroups.emplace_back( aGroup );
309 }
310
315 std::map<wxString, int> MapPadNumbersToNetTieGroups() const;
316
320 std::vector<PAD*> GetNetTiePads( PAD* aPad ) const;
321
327 int GetLikelyAttribute() const;
328
329 void Move( const VECTOR2I& aMoveVector ) override;
330
331 void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
332
333 void Flip( const VECTOR2I& aCentre, bool aFlipLeftRight ) override;
334
346 void MoveAnchorPosition( const VECTOR2I& aMoveVector );
347
351 bool IsFlipped() const { return GetLayer() == B_Cu; }
352
356 bool IsOnLayer( PCB_LAYER_ID aLayer ) const override;
357
358// m_footprintStatus bits:
359#define FP_is_LOCKED 0x01
360#define FP_is_PLACED 0x02
361#define FP_to_PLACE 0x04
362#define FP_PADS_are_LOCKED 0x08
363
364
365 bool IsLocked() const override
366 {
367 return ( m_fpStatus & FP_is_LOCKED ) != 0;
368 }
369
375 void SetLocked( bool isLocked ) override
376 {
377 if( isLocked )
379 else
380 m_fpStatus &= ~FP_is_LOCKED;
381 }
382
386 bool IsConflicting() const;
387
388 bool IsPlaced() const { return m_fpStatus & FP_is_PLACED; }
389 void SetIsPlaced( bool isPlaced )
390 {
391 if( isPlaced )
393 else
394 m_fpStatus &= ~FP_is_PLACED;
395 }
396
397 bool NeedsPlaced() const { return m_fpStatus & FP_to_PLACE; }
398 void SetNeedsPlaced( bool needsPlaced )
399 {
400 if( needsPlaced )
402 else
403 m_fpStatus &= ~FP_to_PLACE;
404 }
405
407
418 void CheckFootprintAttributes( const std::function<void( const wxString& )>& aErrorHandler );
419
426 void CheckPads( const std::function<void( const PAD*, int, const wxString& )>& aErrorHandler );
427
433 void CheckShortingPads( const std::function<void( const PAD*,
434 const PAD*,
435 const VECTOR2I& )>& aErrorHandler );
436
443 void CheckNetTies( const std::function<void( const BOARD_ITEM* aItem,
444 const BOARD_ITEM* bItem,
445 const BOARD_ITEM* cItem,
446 const VECTOR2I& )>& aErrorHandler );
447
454 void CheckNetTiePadGroups( const std::function<void( const wxString& )>& aErrorHandler );
455
476 void TransformPadsToPolySet( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
477 int aMaxError, ERROR_LOC aErrorLoc,
478 bool aSkipNPTHPadsWihNoCopper = false,
479 bool aSkipPlatedPads = false,
480 bool aSkipNonPlatedPads = false ) const;
481
496 void TransformFPShapesToPolySet( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
497 int aError, ERROR_LOC aErrorLoc,
498 bool aIncludeText = true,
499 bool aIncludeShapes = true,
500 bool aIncludePrivateItems = false ) const;
501
505 void TransformFPTextToPolySet( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
506 int aError, ERROR_LOC aErrorLoc ) const
507 {
508 TransformFPShapesToPolySet( aBuffer, aLayer, aClearance, aError, aErrorLoc, true, false );
509 }
510
514 void GetContextualTextVars( wxArrayString* aVars ) const;
515
521 bool ResolveTextVar( wxString* token, int aDepth = 0 ) const;
522
524 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
525
526 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
527
537 bool HitTestAccurate( const VECTOR2I& aPosition, int aAccuracy = 0 ) const;
538
539 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
540
549 bool HitTestOnLayer( const VECTOR2I& aPosition, PCB_LAYER_ID aLayer, int aAccuracy = 0 ) const;
550
551 bool HitTestOnLayer( const BOX2I& aRect, bool aContained, PCB_LAYER_ID aLayer, int aAccuracy = 0 ) const;
552
556 const wxString& GetReference() const { return Reference().GetText(); }
557
562 void SetReference( const wxString& aReference ) { Reference().SetText( aReference ); }
563
564 // Property system doesn't like const references
565 wxString GetReferenceAsString() const
566 {
567 return GetReference();
568 }
569
573 void IncrementReference( int aDelta );
574
578 const wxString& GetValue() const { return Value().GetText(); }
579
583 void SetValue( const wxString& aValue ) { Value().SetText( aValue ); }
584
585 // Property system doesn't like const references
586 wxString GetValueAsString() const
587 {
588 return GetValue();
589 }
590
595
597 const PCB_FIELD& Value() const { return *GetField( VALUE_FIELD ); }
598 const PCB_FIELD& Reference() const { return *GetField( REFERENCE_FIELD ); }
599 const PCB_FIELD& Footprint() const { return *GetField( FOOTPRINT_FIELD ); }
600
601 //-----<Fields>-----------------------------------------------------------
602
611 PCB_FIELD* GetField( MANDATORY_FIELD_T aFieldType );
612 const PCB_FIELD* GetField( MANDATORY_FIELD_T aFieldNdx ) const;
613
621 PCB_FIELD* GetFieldById( int aFieldId );
622
630 PCB_FIELD* GetFieldByName( const wxString& aFieldName );
631
632 bool HasFieldByName( const wxString& aFieldName ) const;
633
639 wxString GetFieldText( const wxString& aFieldName ) const;
640
647 void GetFields( std::vector<PCB_FIELD*>& aVector, bool aVisibleOnly );
648
652 PCB_FIELDS GetFields() { return m_fields; }
653 const PCB_FIELDS& GetFields() const { return m_fields; }
654
662 PCB_FIELD* AddField( const PCB_FIELD& aField );
663
669 void RemoveField( const wxString& aFieldName );
670
674 int GetFieldCount() const { return (int) m_fields.size(); }
675
683 void ApplyDefaultSettings( const BOARD& board, bool aStyleFields, bool aStyleText,
684 bool aStyleShapes );
685
686 bool IsBoardOnly() const { return m_attributes & FP_BOARD_ONLY; }
687 void SetBoardOnly( bool aIsBoardOnly = true )
688 {
689 if( aIsBoardOnly )
691 else
692 m_attributes &= ~FP_BOARD_ONLY;
693 }
694
696 void SetExcludedFromPosFiles( bool aExclude = true )
697 {
698 if( aExclude )
700 else
701 m_attributes &= ~FP_EXCLUDE_FROM_POS_FILES;
702 }
703
705 void SetExcludedFromBOM( bool aExclude = true )
706 {
707 if( aExclude )
709 else
710 m_attributes &= ~FP_EXCLUDE_FROM_BOM;
711 }
712
714 void SetAllowMissingCourtyard( bool aAllow = true )
715 {
716 if( aAllow )
718 else
719 m_attributes &= ~FP_ALLOW_MISSING_COURTYARD;
720 }
721
722 bool IsDNP() const { return m_attributes & FP_DNP; }
723 void SetDNP( bool aDNP = true )
724 {
725 if( aDNP )
727 else
728 m_attributes &= ~FP_DNP;
729 }
730
731 void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
733
743 PAD* FindPadByNumber( const wxString& aPadNumber, PAD* aSearchAfterMe = nullptr ) const;
744
752 PAD* GetPad( const VECTOR2I& aPosition, LSET aLayerMask = LSET::AllLayersMask() );
753
761 unsigned GetPadCount( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const;
762
773 unsigned GetUniquePadCount( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const;
774
782 wxString GetNextPadNumber( const wxString& aLastPadName ) const;
783
787 void AutoPositionFields();
788
793 wxString GetTypeName() const;
794
795 double GetArea( int aPadding = 0 ) const;
796
797 KIID GetLink() const { return m_link; }
798 void SetLink( const KIID& aLink ) { m_link = aLink; }
799
800 BOARD_ITEM* Duplicate() const override;
801
807 BOARD_ITEM* DuplicateItem( const BOARD_ITEM* aItem, bool aAddToFootprint = false );
808
814 void Add3DModel( FP_3DMODEL* a3DModel );
815
816 INSPECT_RESULT Visit( INSPECTOR inspector, void* testData,
817 const std::vector<KICAD_T>& aScanTypes ) override;
818
819 wxString GetClass() const override
820 {
821 return wxT( "FOOTPRINT" );
822 }
823
824 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
825
826 BITMAPS GetMenuImage() const override;
827
828 EDA_ITEM* Clone() const override;
829
831 void RunOnChildren( const std::function<void (BOARD_ITEM*)>& aFunction ) const override;
832
834 void RunOnDescendants( const std::function<void( BOARD_ITEM* )>& aFunction ) const override;
835
836 virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
837
838 double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
839
840 virtual const BOX2I ViewBBox() const override;
841
849 static bool IsLibNameValid( const wxString& aName );
850
860 static const wxChar* StringLibNameInvalidChars( bool aUserReadable );
861
865 bool FootprintNeedsUpdate( const FOOTPRINT* aLibFP, REPORTER* aReporter = nullptr );
866
881 void SetInitialComments( wxArrayString* aInitialComments )
882 {
883 delete m_initial_comments;
884 m_initial_comments = aInitialComments;
885 }
886
893 double CoverageRatio( const GENERAL_COLLECTOR& aCollector ) const;
894
895 static double GetCoverageArea( const BOARD_ITEM* aItem, const GENERAL_COLLECTOR& aCollector );
896
898 const wxArrayString* GetInitialComments() const { return m_initial_comments; }
899
905 const SHAPE_POLY_SET& GetCourtyard( PCB_LAYER_ID aLayer ) const;
906
913 void BuildCourtyardCaches( OUTLINE_ERROR_HANDLER* aErrorHandler = nullptr );
914
915 // @copydoc BOARD_ITEM::GetEffectiveShape
916 std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
917 FLASHING aFlash = FLASHING::DEFAULT ) const override;
918
919 double Similarity( const BOARD_ITEM& aOther ) const override;
920
921 bool operator==( const BOARD_ITEM& aOther ) const override;
922
923#if defined(DEBUG)
924 virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
925#endif
926
928 {
929 bool operator()( const BOARD_ITEM* itemA, const BOARD_ITEM* itemB ) const;
930 };
931
932 struct cmp_pads
933 {
934 bool operator()( const PAD* aFirst, const PAD* aSecond ) const;
935 };
936
938 {
939 bool operator()( const PAD* aFirst, const PAD* aSecond ) const;
940 };
941
943 {
944 bool operator()( const ZONE* aFirst, const ZONE* aSecond ) const;
945 };
946
947protected:
948 virtual void swapData( BOARD_ITEM* aImage ) override;
949
950private:
951 PCB_FIELDS m_fields;
952 DRAWINGS m_drawings; // BOARD_ITEMs for drawings on the board, owned by pointer.
953 PADS m_pads; // PAD items, owned by pointer
954 ZONES m_zones; // PCB_ZONE items, owned by pointer
955 GROUPS m_groups; // PCB_GROUP items, owned by pointer
956
957 EDA_ANGLE m_orient; // Orientation
958 VECTOR2I m_pos; // Position of footprint on the board in internal units.
959 LIB_ID m_fpid; // The #LIB_ID of the FOOTPRINT.
960 int m_attributes; // Flag bits (see FOOTPRINT_ATTR_T)
961 int m_fpStatus; // For autoplace: flags (LOCKED, FIELDS_AUTOPLACED)
963
964 // Bounding box caching strategy:
965 // While we attempt to notice the low-hanging fruit operations and update the bounding boxes
966 // accordingly, we rely mostly on a "if anything changed then the caches are stale" approach.
967 // We implement this by having PCB_BASE_FRAME's OnModify() method increment an operation
968 // counter, and storing that as a timestamp for the various caches.
969 // This means caches will get regenerated often -- but still far less often than if we had no
970 // caches at all. The principal opitmization would be to change to dirty flag and make sure
971 // that any edit that could affect the bounding boxes (including edits to the footprint
972 // children) marked the bounding boxes dirty. It would definitely be faster -- but also more
973 // fragile.
982
983 // A list of pad groups, each of which is allowed to short nets within their group.
984 // A pad group is a comma-separated list of pad numbers.
985 std::vector<wxString> m_netTiePadGroups;
986
989 int m_localSolderMaskMargin; // Solder mask margin
990 int m_localSolderPasteMargin; // Solder paste margin absolute value
991 double m_localSolderPasteMarginRatio; // Solder mask margin ratio value of pad size
992
993 wxString m_libDescription; // File name and path for documentation file.
994 wxString m_keywords; // Search keywords to find footprint in library.
995 KIID_PATH m_path; // Path to associated symbol ([sheetUUID, .., symbolUUID]).
996 wxString m_sheetname; // Name of the sheet containing the symbol for this footprint
997 wxString m_sheetfile; // File of the sheet containing the symbol for this footprint
998 wxString m_filters; // Footprint filters from symbol
1000 int m_arflag; // Use to trace ratsnest and auto routing.
1001 KIID m_link; // Temporary logical link used during editing
1002 LSET m_privateLayers; // Layers visible only in the footprint editor
1003
1004 std::vector<FP_3DMODEL> m_3D_Drawings; // 3D models.
1005 wxArrayString* m_initial_comments; // s-expression comments in the footprint,
1006 // lazily allocated only if needed for speed
1007
1008 SHAPE_POLY_SET m_courtyard_cache_front; // Note that a footprint can have both front and back
1009 SHAPE_POLY_SET m_courtyard_cache_back; // courtyards populated.
1011};
1012
1013#endif // FOOTPRINT_H
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
Abstract interface for BOARD_ITEMs capable of storing other items inside.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:77
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:225
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:276
const Vec GetCenter() const
Definition: box2.h:196
Implement a canvas based on a wxGLCanvas.
Definition: eda_3d_canvas.h:49
double AsDegrees() const
Definition: eda_angle.h:149
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:97
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:95
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:183
bool FixUuids()
Old footprints do not always have a valid UUID (some can be set to null uuid) However null UUIDs,...
Definition: footprint.cpp:391
void CheckShortingPads(const std::function< void(const PAD *, const PAD *, const VECTOR2I &)> &aErrorHandler)
Check for overlapping, different-numbered, non-net-tie pads.
Definition: footprint.cpp:2772
void SetPosition(const VECTOR2I &aPos) override
Definition: footprint.cpp:1997
void SetFPID(const LIB_ID &aFPID)
Definition: footprint.h:231
LIB_ID m_fpid
Definition: footprint.h:959
wxString GetLibDescription() const
Definition: footprint.h:236
void SetLink(const KIID &aLink)
Definition: footprint.h:798
KIID_PATH m_path
Definition: footprint.h:995
bool IsBoardOnly() const
Definition: footprint.h:686
int GetFieldCount() const
Return the number of fields in this symbol.
Definition: footprint.h:674
BOX2I m_cachedTextExcludedBBox
Definition: footprint.h:978
void CheckPads(const std::function< void(const PAD *, int, const wxString &)> &aErrorHandler)
Run non-board-specific DRC checks on footprint's pads.
Definition: footprint.cpp:2693
bool IsDNP() const
Definition: footprint.h:722
void SetLocked(bool isLocked) override
Set the #MODULE_is_LOCKED bit in the m_ModuleStatus.
Definition: footprint.h:375
VECTOR2I GetCenter() const override
This defaults to the center of the bounding box if not overridden.
Definition: footprint.h:180
std::vector< PAD * > GetNetTiePads(PAD *aPad) const
Definition: footprint.cpp:2646
bool ResolveTextVar(wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the component.
Definition: footprint.cpp:647
EDA_ANGLE GetOrientation() const
Definition: footprint.h:209
bool HasFieldByName(const wxString &aFieldName) const
Definition: footprint.cpp:283
ZONES & Zones()
Definition: footprint.h:194
void Remove(BOARD_ITEM *aItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL) override
Removes an item from the container.
Definition: footprint.cpp:786
void SetIsPlaced(bool isPlaced)
Definition: footprint.h:389
ZONE_CONNECTION m_zoneConnection
Definition: footprint.h:987
BOX2I m_cachedBoundingBox
Definition: footprint.h:974
static double GetCoverageArea(const BOARD_ITEM *aItem, const GENERAL_COLLECTOR &aCollector)
Definition: footprint.cpp:2299
bool IsExcludedFromBOM() const
Definition: footprint.h:704
void SetOrientation(const EDA_ANGLE &aNewAngle)
Definition: footprint.cpp:2069
void SetFlag(int aFlag)
Definition: footprint.h:280
PCB_FIELD * GetFieldByName(const wxString &aFieldName)
Return a field in this symbol.
Definition: footprint.cpp:294
void SetDNP(bool aDNP=true)
Definition: footprint.h:723
static bool IsLibNameValid(const wxString &aName)
Test for validity of a name of a footprint to be used in a footprint library ( no spaces,...
Definition: footprint.cpp:1867
unsigned GetPadCount(INCLUDE_NPTH_T aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const
Return the number of pads.
Definition: footprint.cpp:1532
void IncrementFlag()
Definition: footprint.h:281
const BOX2I GetLayerBoundingBox(LSET aLayers) const
Return the bounding box of the footprint on a given set of layers.
Definition: footprint.cpp:1132
PCB_FIELD * AddField(const PCB_FIELD &aField)
Add a field to the symbol.
Definition: footprint.cpp:336
void CheckNetTies(const std::function< void(const BOARD_ITEM *aItem, const BOARD_ITEM *bItem, const BOARD_ITEM *cItem, const VECTOR2I &)> &aErrorHandler)
Check for un-allowed shorting of pads in net-tie footprints.
Definition: footprint.cpp:2818
void SetExcludedFromBOM(bool aExclude=true)
Definition: footprint.h:705
wxString GetSheetname() const
Definition: footprint.h:245
int m_fpStatus
Definition: footprint.h:961
void SetPath(const KIID_PATH &aPath)
Definition: footprint.h:243
PCB_FIELDS GetFields()
Return a vector of fields from the symbol.
Definition: footprint.h:652
double ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
Definition: footprint.cpp:1811
SHAPE_POLY_SET m_cachedHull
Definition: footprint.h:980
void SetFilters(const wxString &aFilters)
Definition: footprint.h:252
int GetLocalClearance() const
Definition: footprint.h:257
void SetAllowMissingCourtyard(bool aAllow=true)
Definition: footprint.h:714
void SetKeywords(const wxString &aKeywords)
Definition: footprint.h:240
const DRAWINGS & GraphicalItems() const
Definition: footprint.h:192
int m_localSolderPasteMargin
Definition: footprint.h:990
void SetInitialComments(wxArrayString *aInitialComments)
Take ownership of caller's heap allocated aInitialComments block.
Definition: footprint.h:881
int m_attributes
Definition: footprint.h:960
PCB_FIELD & Footprint()
Definition: footprint.h:594
std::vector< FP_3DMODEL > m_3D_Drawings
Definition: footprint.h:1004
double CoverageRatio(const GENERAL_COLLECTOR &aCollector) const
Calculate the ratio of total area of the footprint pads and graphical items to the area of the footpr...
Definition: footprint.cpp:2382
BOARD_ITEM * DuplicateItem(const BOARD_ITEM *aItem, bool aAddToFootprint=false)
Duplicate a given item within the footprint, optionally adding it to the board.
Definition: footprint.cpp:2110
std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
Definition: footprint.cpp:2444
void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction) const override
Invoke a function on all descendants.
Definition: footprint.cpp:1701
void SetAttributes(int aAttributes)
Definition: footprint.h:278
void SetSheetfile(const wxString &aSheetfile)
Definition: footprint.h:249
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: footprint.cpp:1689
void RunOnDescendants(const std::function< void(BOARD_ITEM *)> &aFunction) const override
Invoke a function on all descendants.
Definition: footprint.cpp:1727
double m_localSolderPasteMarginRatio
Definition: footprint.h:991
void TransformPadsToPolySet(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc, bool aSkipNPTHPadsWihNoCopper=false, bool aSkipPlatedPads=false, bool aSkipNonPlatedPads=false) const
Generate pads shapes on layer aLayer as polygons and adds these polygons to aBuffer.
Definition: footprint.cpp:3233
wxArrayString * m_initial_comments
Definition: footprint.h:1005
EDA_ITEM * Clone() const override
Invoke a function on all children.
Definition: footprint.cpp:1695
BOX2I m_cachedVisibleBBox
Definition: footprint.h:976
double GetLocalSolderPasteMarginRatio() const
Definition: footprint.h:271
BOX2I GetFpPadsLocalBbox() const
Return the bounding box containing pads when the footprint is on the front side, orientation 0,...
Definition: footprint.cpp:956
int m_visibleBBoxCacheTimeStamp
Definition: footprint.h:977
PCB_FIELD & Value()
read/write accessors:
Definition: footprint.h:592
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
Definition: footprint.cpp:1902
void SetFileFormatVersionAtLoad(int aVersion)
Definition: footprint.h:731
void SetExcludedFromPosFiles(bool aExclude=true)
Definition: footprint.h:696
int m_localClearance
Definition: footprint.h:988
void SetLocalSolderPasteMarginRatio(double aRatio)
Definition: footprint.h:272
const PCB_FIELD & Footprint() const
Definition: footprint.h:599
void SetOrientationDegrees(double aOrientation)
Definition: footprint.h:221
void SetPrivateLayers(LSET aLayers)
Adds an item to the container.
Definition: footprint.h:126
void ApplyDefaultSettings(const BOARD &board, bool aStyleFields, bool aStyleText, bool aStyleShapes)
Apply default board settings to the footprint field text properties.
Definition: footprint.cpp:358
std::map< wxString, int > MapPadNumbersToNetTieGroups() const
Definition: footprint.cpp:2591
double Similarity(const BOARD_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
Definition: footprint.cpp:3023
void TransformFPTextToPolySet(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc) const
This function is the same as TransformFPShapesToPolySet but only generates text.
Definition: footprint.h:505
void MoveAnchorPosition(const VECTOR2I &aMoveVector)
Move the reference point of the footprint.
Definition: footprint.cpp:2024
FOOTPRINT & operator=(const FOOTPRINT &aOther)
Definition: footprint.cpp:523
int m_arflag
Definition: footprint.h:1000
double GetOrientationDegrees() const
Definition: footprint.h:225
BOARD_ITEM * Duplicate() const override
Create a copy of this BOARD_ITEM.
Definition: footprint.cpp:2097
void SetLocalSolderPasteMargin(int aMargin)
Definition: footprint.h:269
INSPECT_RESULT Visit(INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes) override
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: footprint.cpp:1593
int GetAttributes() const
Definition: footprint.h:277
int m_localSolderMaskMargin
Definition: footprint.h:989
bool FootprintNeedsUpdate(const FOOTPRINT *aLibFP, REPORTER *aReporter=nullptr)
Return true if a board footprint differs from the library version.
void ClearNetTiePadGroups()
Definition: footprint.h:301
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition: footprint.h:218
LSET GetPrivateLayers() const
Definition: footprint.h:125
wxString GetFPIDAsString() const
Definition: footprint.h:233
wxString GetValueAsString() const
Definition: footprint.h:586
bool AllowMissingCourtyard() const
Definition: footprint.h:713
const ZONES & Zones() const
Definition: footprint.h:195
bool IsFlipped() const
Definition: footprint.h:351
wxString GetSheetfile() const
Definition: footprint.h:248
int GetLocalClearance(wxString *aSource) const
Definition: footprint.h:260
PADS & Pads()
Definition: footprint.h:188
SHAPE_POLY_SET GetBoundingHull() const
Return a bounding polygon for the shapes and pads in the footprint.
Definition: footprint.cpp:1177
int GetLocalSolderPasteMargin() const
Definition: footprint.h:268
void TransformFPShapesToPolySet(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool aIncludeText=true, bool aIncludeShapes=true, bool aIncludePrivateItems=false) const
Generate shapes of graphic items (outlines) on layer aLayer as polygons and adds these polygons to aB...
Definition: footprint.cpp:3306
wxString GetTypeName() const
Get the type of footprint.
Definition: footprint.cpp:944
DRAWINGS m_drawings
Definition: footprint.h:952
bool NeedsPlaced() const
Definition: footprint.h:397
PCB_FIELD * GetFieldById(int aFieldId)
Return a field in this symbol.
Definition: footprint.cpp:272
SHAPE_POLY_SET m_courtyard_cache_back
Definition: footprint.h:1009
int m_textExcludedBBoxCacheTimeStamp
Definition: footprint.h:979
const std::vector< wxString > & GetNetTiePadGroups() const
Definition: footprint.h:299
void SetLocalClearance(int aClearance)
Definition: footprint.h:258
const LIB_ID & GetFPID() const
Definition: footprint.h:230
void SetReference(const wxString &aReference)
Definition: footprint.h:562
bool IsLocked() const override
Definition: footprint.h:365
const GROUPS & Groups() const
Definition: footprint.h:198
bool IsExcludedFromPosFiles() const
Definition: footprint.h:695
void SetLayerAndFlip(PCB_LAYER_ID aLayer)
Used as Layer property setter – performs a flip if necessary to set the footprint layer.
Definition: footprint.cpp:1928
void SetLocalSolderMaskMargin(int aMargin)
Definition: footprint.h:255
ZONES m_zones
Definition: footprint.h:954
int m_hullCacheTimeStamp
Definition: footprint.h:981
unsigned GetUniquePadCount(INCLUDE_NPTH_T aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const
Return the number of unique non-blank pads.
Definition: footprint.cpp:1551
void AddNetTiePadGroup(const wxString &aGroup)
Definition: footprint.h:306
bool LegacyPadsLocked() const
Definition: footprint.h:406
virtual const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
Definition: footprint.cpp:1852
LSET m_privateLayers
Definition: footprint.h:1002
int GetLikelyAttribute() const
Returns the most likely attribute based on pads Either FP_THROUGH_HOLE/FP_SMD/OTHER(0)
Definition: footprint.cpp:892
void Move(const VECTOR2I &aMoveVector) override
Move this object.
Definition: footprint.cpp:1895
static bool ClassOf(const EDA_ITEM *aItem)
Definition: footprint.h:120
wxString m_libDescription
Definition: footprint.h:993
bool HitTestOnLayer(const VECTOR2I &aPosition, PCB_LAYER_ID aLayer, int aAccuracy=0) const
Test if the point hits one or more of the footprint elements on a given layer.
Definition: footprint.cpp:1364
VECTOR2I m_pos
Definition: footprint.h:958
std::vector< wxString > m_netTiePadGroups
Definition: footprint.h:985
PAD * GetPad(const VECTOR2I &aPosition, LSET aLayerMask=LSET::AllLayersMask())
Get a pad at aPosition on aLayerMask in the footprint.
Definition: footprint.cpp:1516
void Add3DModel(FP_3DMODEL *a3DModel)
Add a3DModel definition to the end of the 3D model list.
Definition: footprint.cpp:1582
void SetValue(const wxString &aValue)
Definition: footprint.h:583
GROUPS m_groups
Definition: footprint.h:955
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
Definition: footprint.cpp:1259
PCB_FIELD & Reference()
Definition: footprint.h:593
const PCB_FIELD & Value() const
The const versions to keep the compiler happy.
Definition: footprint.h:597
wxString GetReferenceAsString() const
Definition: footprint.h:565
wxString m_sheetfile
Definition: footprint.h:997
void GetContextualTextVars(wxArrayString *aVars) const
Return the list of system text vars for this footprint.
Definition: footprint.cpp:633
SHAPE_POLY_SET m_courtyard_cache_front
Definition: footprint.h:1008
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
Removes an item from the container.
Definition: footprint.cpp:724
void AutoPositionFields()
Position Reference and Value fields at the top and bottom of footprint's bounding box.
Definition: footprint.cpp:2244
wxString m_keywords
Definition: footprint.h:994
const PCB_FIELD & Reference() const
Definition: footprint.h:598
void ClearAllNets()
Clear (i.e.
Definition: footprint.cpp:715
void SetZoneConnection(ZONE_CONNECTION aType)
Definition: footprint.h:274
bool HasThroughHolePads() const
Definition: footprint.cpp:2964
void BuildCourtyardCaches(OUTLINE_ERROR_HANDLER *aErrorHandler=nullptr)
Build complex polygons of the courtyard areas from graphic items on the courtyard layers.
Definition: footprint.cpp:2492
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Test to see if this object is on the given layer.
Definition: footprint.cpp:1333
wxString GetFieldText(const wxString &aFieldName) const
Search for a field named aFieldName and returns text associated with this field.
Definition: footprint.cpp:309
EDA_ANGLE m_orient
Definition: footprint.h:957
bool HitTestAccurate(const VECTOR2I &aPosition, int aAccuracy=0) const
Test if a point is inside the bounding polygon of the footprint.
Definition: footprint.cpp:1439
bool IsNetTie() const
Definition: footprint.h:284
wxString GetClass() const override
Return the class name.
Definition: footprint.h:819
const PCB_FIELDS & Fields() const
Definition: footprint.h:186
const PADS & Pads() const
Definition: footprint.h:189
void IncrementReference(int aDelta)
Bump the current reference by aDelta.
Definition: footprint.cpp:2272
int GetFileFormatVersionAtLoad() const
Definition: footprint.h:732
KIID m_link
Definition: footprint.h:1001
void RemoveField(const wxString &aFieldName)
Remove a user field from the footprint.
Definition: footprint.cpp:345
GROUPS & Groups()
Definition: footprint.h:197
wxString GetFilters() const
Definition: footprint.h:251
void SetSheetname(const wxString &aSheetname)
Definition: footprint.h:246
const wxArrayString * GetInitialComments() const
Return the initial comments block or NULL if none, without transfer of ownership.
Definition: footprint.h:898
KIID GetLink() const
Definition: footprint.h:797
bool IsConflicting() const
Definition: footprint.cpp:627
std::vector< FP_3DMODEL > & Models()
Definition: footprint.h:202
PCB_FIELDS & Fields()
Definition: footprint.h:185
static const wxChar * StringLibNameInvalidChars(bool aUserReadable)
Test for validity of the name in a library of the footprint ( no spaces, dir separators ....
Definition: footprint.cpp:1878
void SetLibDescription(const wxString &aDesc)
Definition: footprint.h:237
void Flip(const VECTOR2I &aCentre, bool aFlipLeftRight) override
Flip this object, i.e.
Definition: footprint.cpp:1937
const wxString & GetValue() const
Definition: footprint.h:578
double GetArea(int aPadding=0) const
Definition: footprint.cpp:882
const PCB_FIELDS & GetFields() const
Definition: footprint.h:653
void SetNeedsPlaced(bool needsPlaced)
Definition: footprint.h:398
wxString m_filters
Definition: footprint.h:998
ZONE_CONNECTION GetZoneConnection() const
Definition: footprint.h:275
const wxString & GetReference() const
Definition: footprint.h:556
void CheckNetTiePadGroups(const std::function< void(const wxString &)> &aErrorHandler)
Sanity check net-tie pad groups.
Definition: footprint.cpp:2931
void SetFPIDAsString(const wxString &aFPID)
Definition: footprint.h:234
void SetBoardOnly(bool aIsBoardOnly=true)
Definition: footprint.h:687
const std::vector< FP_3DMODEL > & Models() const
Definition: footprint.h:203
PCB_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: footprint.cpp:260
timestamp_t m_lastEditTime
Definition: footprint.h:999
const SHAPE_POLY_SET & GetCourtyard(PCB_LAYER_ID aLayer) const
Used in DRC to test the courtyard area (a complex polygon).
Definition: footprint.cpp:2480
int GetFlag() const
Definition: footprint.h:282
wxString m_sheetname
Definition: footprint.h:996
virtual void ViewGetLayers(int aLayers[], int &aCount) const override
Return the all the layers within the VIEW the object is painted on.
Definition: footprint.cpp:1759
int m_fileFormatVersionAtLoad
Definition: footprint.h:962
const KIID_PATH & GetPath() const
Definition: footprint.h:242
wxString GetKeywords() const
Definition: footprint.h:239
bool operator==(const BOARD_ITEM &aOther) const override
Definition: footprint.cpp:2976
void CheckFootprintAttributes(const std::function< void(const wxString &)> &aErrorHandler)
Test if footprint attributes for type (SMD/Through hole/Other) match the expected type based on the p...
Definition: footprint.cpp:2668
PADS m_pads
Definition: footprint.h:953
virtual void swapData(BOARD_ITEM *aImage) override
Definition: footprint.cpp:2956
wxString GetNextPadNumber(const wxString &aLastPadName) const
Return the next available pad number in the footprint.
Definition: footprint.cpp:2224
bool IsPlaced() const
Definition: footprint.h:388
int m_courtyard_cache_timestamp
Definition: footprint.h:1010
int m_boundingBoxCacheTimeStamp
Definition: footprint.h:975
VECTOR2I GetPosition() const override
Definition: footprint.h:206
DRAWINGS & GraphicalItems()
Definition: footprint.h:191
PCB_FIELDS m_fields
Definition: footprint.h:951
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
Definition: footprint.cpp:1432
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider) const override
Return a user-visible description string of this item.
Definition: footprint.cpp:1678
PAD * FindPadByNumber(const wxString &aPadNumber, PAD *aSearchAfterMe=nullptr) const
Return a PAD with a matching number.
Definition: footprint.cpp:1496
int GetLocalSolderMaskMargin() const
Definition: footprint.h:254
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: footprint.cpp:981
VECTOR3D m_Offset
3D model offset (mm)
Definition: footprint.h:98
double m_Opacity
Definition: footprint.h:99
VECTOR3D m_Rotation
3D model rotation (degrees)
Definition: footprint.h:97
FP_3DMODEL()
Definition: footprint.h:86
VECTOR3D m_Scale
3D model scaling factor (dimensionless)
Definition: footprint.h:96
wxString m_Filename
The 3D shape filename in 3D library.
Definition: footprint.h:100
bool m_Show
Include model in rendering.
Definition: footprint.h:101
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:206
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:68
Definition: kiid.h:49
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:51
UTF8 Format() const
Definition: lib_id.cpp:118
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition: richio.h:93
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:556
static LSET AllLayersMask()
Definition: lset.cpp:817
EDA_MSG_PANEL items for displaying messages.
Definition: msgpanel.h:54
Definition: pad.h:59
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
Represent a set of closed polygons.
An abstract shape on 2D plane.
Definition: shape.h:126
Handle a list of polygons defining a copper zone.
Definition: zone.h:72
const std::function< void(const wxString &msg, BOARD_ITEM *itemA, BOARD_ITEM *itemB, const VECTOR2I &pt)> OUTLINE_ERROR_HANDLER
std::vector< ZONE * > ZONES
Definition: eagle_plugin.h:44
#define _(s)
@ DEGREES_T
Definition: eda_angle.h:31
INSPECT_RESULT
Definition: eda_item.h:42
const INSPECTOR_FUNC & INSPECTOR
Definition: eda_item.h:78
INCLUDE_NPTH_T
Definition: footprint.h:60
@ INCLUDE_NPTH
Definition: footprint.h:62
@ DO_NOT_INCLUDE_NPTH
Definition: footprint.h:61
FOOTPRINT_ATTR_T
The set of attributes allowed within a FOOTPRINT, using FOOTPRINT::SetAttributes() and FOOTPRINT::Get...
Definition: footprint.h:71
@ FP_SMD
Definition: footprint.h:73
@ FP_DNP
Definition: footprint.h:80
@ FP_ALLOW_MISSING_COURTYARD
Definition: footprint.h:79
@ FP_EXCLUDE_FROM_POS_FILES
Definition: footprint.h:74
@ FP_BOARD_ONLY
Definition: footprint.h:76
@ FP_EXCLUDE_FROM_BOM
Definition: footprint.h:75
@ FP_JUST_ADDED
Definition: footprint.h:77
@ FP_THROUGH_HOLE
Definition: footprint.h:72
@ FP_ALLOW_SOLDERMASK_BRIDGES
Definition: footprint.h:78
#define FP_is_PLACED
In autoplace: footprint automatically placed.
Definition: footprint.h:360
#define FP_is_LOCKED
footprint LOCKED: no autoplace allowed
Definition: footprint.h:359
#define FP_PADS_are_LOCKED
Definition: footprint.h:362
#define FP_to_PLACE
In autoplace: footprint waiting for autoplace.
Definition: footprint.h:361
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
uint32_t timestamp_t
timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the ti...
Definition: kiid.h:46
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
Definition: layer_ids.h:148
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ B_Cu
Definition: layer_ids.h:96
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:247
bool operator()(const BOARD_ITEM *itemA, const BOARD_ITEM *itemB) const
Definition: footprint.cpp:3047
bool operator()(const PAD *aFirst, const PAD *aSecond) const
Definition: footprint.cpp:3124
bool operator()(const PAD *aFirst, const PAD *aSecond) const
Definition: footprint.cpp:3152
bool operator()(const ZONE *aFirst, const ZONE *aSecond) const
Definition: footprint.cpp:3207
MANDATORY_FIELD_T
The set of all field indices assuming an array like sequence that a SCH_COMPONENT or LIB_PART can hol...
@ FOOTPRINT_FIELD
Field Name Module PCB, i.e. "16DIP300".
@ VALUE_FIELD
Field Value of part, i.e. "3.3K".
@ REFERENCE_FIELD
Field Reference of part, i.e. "IC21".
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition: typeinfo.h:86
ZONE_CONNECTION
How pads are covered by copper in zone.
Definition: zones.h:49