KiCad PCB EDA Suite
LIB_SYMBOL Class Reference

Define a library symbol object. More...

#include <lib_symbol.h>

Inheritance diagram for LIB_SYMBOL:
EDA_ITEM LIB_TREE_ITEM KIGFX::VIEW_ITEM INSPECTABLE

Public Member Functions

 LIB_SYMBOL (const wxString &aName, LIB_SYMBOL *aParent=nullptr, SYMBOL_LIB *aLibrary=nullptr)
 
 LIB_SYMBOL (const LIB_SYMBOL &aSymbol, SYMBOL_LIB *aLibrary=nullptr)
 
virtual ~LIB_SYMBOL ()
 http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared More...
 
LIB_SYMBOL_SPTR SharedPtr () const
 
virtual LIB_SYMBOLDuplicate () const
 Create a copy of a LIB_SYMBOL and assigns unique KIIDs to the copy and its children. More...
 
void SetParent (LIB_SYMBOL *aParent=nullptr)
 
LIB_SYMBOL_REFGetParent ()
 
const LIB_SYMBOL_REFGetParent () const
 
virtual wxString GetClass () const override
 Return the class name. More...
 
virtual void SetName (const wxString &aName)
 
wxString GetName () const override
 
LIB_ID GetLibId () const override
 
void SetLibId (const LIB_ID &aLibId)
 
wxString GetLibNickname () const override
 
void SetDescription (const wxString &aDescription)
 
wxString GetDescription () override
 
void SetKeyWords (const wxString &aKeyWords)
 
wxString GetKeyWords () const
 
wxString GetSearchText () override
 
bool IsRoot () const override
 For symbols derived from other symbols, IsRoot() indicates no derivation. More...
 
bool IsAlias () const
 
const wxString GetLibraryName () const
 
SYMBOL_LIBGetLib () const
 
void SetLib (SYMBOL_LIB *aLibrary)
 
timestamp_t GetLastModDate () const
 
void SetFPFilters (const wxArrayString &aFilters)
 
wxArrayString GetFPFilters () const
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Return the all the layers within the VIEW the object is painted on. More...
 
const EDA_RECT GetUnitBoundingBox (int aUnit, int aConvert) const
 Get the bounding box for the symbol. More...
 
const EDA_RECT GetBodyBoundingBox (int aUnit, int aConvert) const
 Get the symbol bounding box excluding fields. More...
 
const EDA_RECT GetBoundingBox () const override
 Return the orthogonal bounding box of this object for display purposes. More...
 
bool IsPower () const
 
bool IsNormal () const
 
void SetPower ()
 
void SetNormal ()
 
void LockUnits (bool aLockUnits)
 Set interchangeable the property for symbol units. More...
 
bool UnitsLocked () const
 Check whether symbol units are interchangeable. More...
 
void SetFields (const std::vector< LIB_FIELD > &aFieldsList)
 Overwrite all the existing fields in this symbol with fields supplied in aFieldsList. More...
 
void GetFields (std::vector< LIB_FIELD * > &aList)
 Return a list of fields within this symbol. More...
 
void GetFields (std::vector< LIB_FIELD > &aList)
 
void AddField (LIB_FIELD *aField)
 Add a field. More...
 
LIB_FIELDFindField (const wxString &aFieldName)
 Find a field within this symbol matching aFieldName and returns it or NULL if not found. More...
 
const LIB_FIELDFindField (const wxString &aFieldName) const
 
LIB_FIELDGetFieldById (int aId) const
 Return pointer to the requested field. More...
 
LIB_FIELDGetValueField ()
 Return reference to the value field. More...
 
LIB_FIELDGetReferenceField ()
 Return reference to the reference designator field. More...
 
LIB_FIELDGetFootprintField ()
 Return reference to the footprint field. More...
 
LIB_FIELDGetDatasheetField ()
 Return reference to the datasheet field. More...
 
void Print (const RENDER_SETTINGS *aSettings, const wxPoint &aOffset, int aMulti, int aConvert, const LIB_SYMBOL_OPTIONS &aOpts)
 Print symbol. More...
 
void Plot (PLOTTER *aPlotter, int aUnit, int aConvert, const wxPoint &aOffset, const TRANSFORM &aTransform) const
 Plot lib symbol to plotter. More...
 
void PlotLibFields (PLOTTER *aPlotter, int aUnit, int aConvert, const wxPoint &aOffset, const TRANSFORM &aTransform)
 Plot Lib Fields only of the symbol to plotter. More...
 
void AddDrawItem (LIB_ITEM *aItem, bool aSort=true)
 Add a new draw aItem to the draw object list and sort according to aSort. More...
 
void RemoveDrawItem (LIB_ITEM *aItem)
 Remove draw aItem from list. More...
 
LIB_ITEMGetNextDrawItem (const LIB_ITEM *aItem=nullptr, KICAD_T aType=TYPE_NOT_INIT)
 Return the next draw object pointer. More...
 
size_t GetPinCount () const
 
size_t GetFieldCount () const
 
LIB_PINGetNextPin (LIB_PIN *aItem=nullptr)
 Return the next pin object from the draw list. More...
 
void GetPins (LIB_PINS &aList, int aUnit=0, int aConvert=0) const
 Return a list of pin object pointers from the draw item list. More...
 
LIB_PINGetPin (const wxString &aNumber, int aUnit=0, int aConvert=0) const
 Return pin object with the requested pin aNumber. More...
 
bool PinsConflictWith (const LIB_SYMBOL &aOtherSymbol, bool aTestNums, bool aTestNames, bool aTestType, bool aTestOrientation, bool aTestLength) const
 Return true if this symbol's pins do not match another symbol's pins. More...
 
void SetOffset (const wxPoint &aOffset)
 Move the symbol aOffset. More...
 
void RemoveDuplicateDrawItems ()
 Remove duplicate draw items from list. More...
 
bool HasConversion () const
 Test if symbol has more than one body conversion type (DeMorgan). More...
 
void ClearTempFlags ()
 Clears the status flag all draw objects in this symbol. More...
 
void ClearEditFlags ()
 
LIB_ITEMLocateDrawItem (int aUnit, int aConvert, KICAD_T aType, const wxPoint &aPoint)
 Locate a draw object. More...
 
LIB_ITEMLocateDrawItem (int aUnit, int aConvert, KICAD_T aType, const wxPoint &aPoint, const TRANSFORM &aTransform)
 Locate a draw object (overlaid) More...
 
LIB_ITEMS_CONTAINERGetDrawItems ()
 Return a reference to the draw item list. More...
 
const LIB_ITEMS_CONTAINERGetDrawItems () const
 
SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
 May be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
void SetUnitCount (int aCount, bool aDuplicateDrawItems=true)
 Set the units per symbol count. More...
 
int GetUnitCount () const override
 For items with units, return the number of units. More...
 
wxString GetUnitReference (int aUnit) override
 Return an identifier for aUnit for symbols with units. More...
 
bool IsMulti () const
 
void SetConversion (bool aSetConvert, bool aDuplicatePins=true)
 Set or clear the alternate body style (DeMorgan) for the symbol. More...
 
void SetPinNameOffset (int aOffset)
 Set the offset in mils of the pin name text from the pin symbol. More...
 
int GetPinNameOffset () const
 
void SetShowPinNames (bool aShow)
 Set or clear the pin name visibility flag. More...
 
bool ShowPinNames () const
 
void SetShowPinNumbers (bool aShow)
 Set or clear the pin number visibility flag. More...
 
bool ShowPinNumbers () const
 
void SetIncludeInBom (bool aIncludeInBom)
 Set or clear the include in schematic bill of materials flag. More...
 
bool GetIncludeInBom () const
 
void SetIncludeOnBoard (bool aIncludeOnBoard)
 Set or clear include in board netlist flag. More...
 
bool GetIncludeOnBoard () const
 
int Compare (const LIB_SYMBOL &aRhs) const
 Comparison test that can be used for operators. More...
 
bool operator== (const LIB_SYMBOL *aSymbol) const
 
bool operator== (const LIB_SYMBOL &aSymbol) const
 
bool operator!= (const LIB_SYMBOL &aSymbol) const
 
const LIB_SYMBOLoperator= (const LIB_SYMBOL &aSymbol)
 
std::unique_ptr< LIB_SYMBOLFlatten () const
 Return a flattened symbol inheritance to the caller. More...
 
std::vector< struct LIB_SYMBOL_UNITSGetUnitDrawItems ()
 Return a list of LIB_ITEM objects separated by unit and convert number. More...
 
std::vector< struct LIB_SYMBOL_UNITSGetUniqueUnits ()
 Return a list of unit numbers that are unique to this symbol. More...
 
std::vector< LIB_ITEM * > GetUnitItems (int aUnit, int aConvert)
 Return a list of item pointers for aUnit and aConvert for this symbol. More...
 
KICAD_T Type () const
 Returns the type of object. More...
 
virtual void SetParent (EDA_ITEM *aParent)
 
bool IsModified () const
 
bool IsNew () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsEntered () const
 
bool IsResized () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (EDA_ITEM_FLAGS type) const
 
void SetState (EDA_ITEM_FLAGS type, bool state)
 
EDA_ITEM_FLAGS GetStatus () const
 
void SetStatus (EDA_ITEM_FLAGS aStatus)
 
void SetFlags (EDA_ITEM_FLAGS aMask)
 
void ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
EDA_ITEM_FLAGS GetFlags () const
 
bool HasFlag (EDA_ITEM_FLAGS aFlag) const
 
EDA_ITEM_FLAGS GetEditFlags () const
 
virtual bool IsType (const KICAD_T aScanTypes[]) const
 Check whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
bool IsForceVisible () const
 
virtual void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
 Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
virtual bool HitTest (const wxPoint &aPosition, int aAccuracy=0) const
 Test if aPosition is contained within or on the bounding box of an item. More...
 
virtual bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const
 Test if aRect intersects or is contained within the bounding box of an item. More...
 
virtual wxPoint GetPosition () const
 
virtual void SetPosition (const wxPoint &aPos)
 
virtual const wxPoint GetFocusPosition () const
 Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
 
virtual EDA_ITEMClone () const
 Create a duplicate of this item with linked list members set to NULL. More...
 
virtual wxString GetSelectMenuText (EDA_UNITS aUnits) const
 Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
virtual BITMAPS GetMenuImage () const
 Return a pointer to an image to be used in menus. More...
 
virtual bool Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const
 Compare the item against the search criteria in aSearchData. More...
 
virtual bool Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
 Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Override this method in any derived object that supports test find and replace. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual const BOX2I ViewBBox () const override
 Return the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Draw the parts of the object belonging to layer aLayer. More...
 
virtual double ViewGetLOD (int aLayer, VIEW *aView) const
 Return the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
bool Set (PROPERTY_BASE *aProperty, wxAny &aValue)
 
template<typename T >
bool Set (PROPERTY_BASE *aProperty, T aValue)
 
template<typename T >
bool Set (const wxString &aProperty, T aValue)
 
wxAny Get (PROPERTY_BASE *aProperty)
 
template<typename T >
Get (PROPERTY_BASE *aProperty)
 
template<typename T >
boost::optional< T > Get (const wxString &aProperty)
 

Static Public Member Functions

static wxString SubReference (int aUnit, bool aAddSeparator=true)
 
static int GetSubpartIdSeparator ()
 
static int * SubpartIdSeparatorPtr ()
 Return a reference to m_subpartIdSeparator, only for read/save setting functions. More...
 
static int GetSubpartFirstId ()
 
static int * SubpartFirstIdPtr ()
 Return a reference to m_subpartFirstId, only for read/save setting functions. More...
 
static void SetSubpartIdNotation (int aSep, int aFirstId)
 Set the separator char between the subpart id and the reference 0 (no separator) or '. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 This changes first parameter to avoid the DList and use the main queue instead. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Change first parameter to avoid the DList and use std::vector instead. More...
 
static bool Replace (const wxFindReplaceData &aSearchData, wxString &aText)
 Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Public Attributes

const KIID m_Uuid
 

Protected Member Functions

bool Matches (const wxString &aText, const wxFindReplaceData &aSearchData) const
 Compare aText against search criteria in aSearchData. More...
 

Protected Attributes

EDA_ITEM_FLAGS m_status
 
bool m_forceVisible
 
EDA_ITEM_FLAGS m_flags
 

Private Member Functions

void deleteAllFields ()
 
virtual void SetParent (EDA_ITEM *aParent)
 

Private Attributes

LIB_SYMBOL_SPTR m_me
 
LIB_SYMBOL_REF m_parent
 Use for inherited symbols. More...
 
LIB_ID m_libId
 
timestamp_t m_lastModDate
 
int m_unitCount
 Number of units (parts) per package. More...
 
bool m_unitsLocked
 True if symbol has multiple units and changing one unit does not automatically change another unit. More...
 
int m_pinNameOffset
 The offset in mils to draw the pin name. More...
 
bool m_showPinNames
 
bool m_showPinNumbers
 
bool m_includeInBom
 
bool m_includeOnBoard
 
LIBRENTRYOPTIONS m_options
 Special symbol features such as POWER or NORMAL.) More...
 
LIB_ITEMS_CONTAINER m_drawings
 
SYMBOL_LIBm_library
 
wxString m_name
 
wxString m_description
 
wxString m_keyWords
 Search keywords. More...
 
wxArrayString m_fpFilters
 List of suitable footprint names for the symbol (wild card names accepted). More...
 

Static Private Attributes

static int m_subpartIdSeparator = 0
 the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or U1.A or U1-A More...
 
static int m_subpartFirstId = 'A'
 the ASCII char value to calculate the subpart symbol id from the symbol number: only 'A', 'a' or '1' can be used, other values have no sense. More...
 

Detailed Description

Define a library symbol object.

A library symbol object is typically saved and loaded in a symbol library file (.lib). Library symbols are different from schematic symbols.

Definition at line 96 of file lib_symbol.h.

Constructor & Destructor Documentation

◆ LIB_SYMBOL() [1/2]

LIB_SYMBOL::LIB_SYMBOL ( const wxString &  aName,
LIB_SYMBOL aParent = nullptr,
SYMBOL_LIB aLibrary = nullptr 
)

Definition at line 82 of file lib_symbol.cpp.

82  :
84  m_me( this, null_deleter() ),
85  m_includeInBom( true ),
86  m_includeOnBoard( true )
87 {
88  m_lastModDate = 0;
89  m_unitCount = 1;
92  m_unitsLocked = false;
93  m_showPinNumbers = true;
94  m_showPinNames = true;
95 
96  // Add the MANDATORY_FIELDS in RAM only. These are assumed to be present
97  // when the field editors are invoked.
98  m_drawings[LIB_FIELD_T].reserve( 4 );
103 
104  SetName( aName );
105 
106  if( aParent )
107  SetParent( aParent );
108 
109  SetLib( aLibrary );
110 }
Field Reference of part, i.e. "IC21".
bool m_showPinNumbers
Definition: lib_symbol.h:674
bool m_showPinNames
Definition: lib_symbol.h:673
Field object used in symbol libraries.
Definition: lib_field.h:59
void SetLib(SYMBOL_LIB *aLibrary)
Definition: lib_symbol.h:177
name of datasheet
timestamp_t m_lastModDate
Definition: lib_symbol.h:665
Field Value of part, i.e. "3.3K".
bool m_unitsLocked
True if symbol has multiple units and changing one unit does not automatically change another unit.
Definition: lib_symbol.h:668
void push_back(T *aItem)
Definition: multivector.h:174
virtual void SetName(const wxString &aName)
Definition: lib_symbol.cpp:314
bool m_includeOnBoard
Definition: lib_symbol.h:677
void SetParent(LIB_SYMBOL *aParent=nullptr)
Definition: lib_symbol.cpp:323
#define DEFAULT_PIN_NAME_OFFSET
The intersheets references prefix string.
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType)
Definition: eda_item.cpp:37
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared
Definition: lib_symbol.cpp:74
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
bool m_includeInBom
Definition: lib_symbol.h:676
LIB_SYMBOL_SPTR m_me
Definition: lib_symbol.h:662
int m_pinNameOffset
The offset in mils to draw the pin name.
Definition: lib_symbol.h:671
LIBRENTRYOPTIONS m_options
Special symbol features such as POWER or NORMAL.)
Definition: lib_symbol.h:678
int m_unitCount
Number of units (parts) per package.
Definition: lib_symbol.h:667
Field Name Module PCB, i.e. "16DIP300".

References DATASHEET_FIELD, DEFAULT_PIN_NAME_OFFSET, ENTRY_NORMAL, FOOTPRINT_FIELD, LIB_FIELD_T, m_drawings, m_lastModDate, m_options, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), REFERENCE_FIELD, SetLib(), SetName(), SetParent(), and VALUE_FIELD.

Referenced by Duplicate(), and Flatten().

◆ LIB_SYMBOL() [2/2]

LIB_SYMBOL::LIB_SYMBOL ( const LIB_SYMBOL aSymbol,
SYMBOL_LIB aLibrary = nullptr 
)

Definition at line 113 of file lib_symbol.cpp.

113  :
114  EDA_ITEM( aSymbol ),
115  m_me( this, null_deleter() )
116 {
117  LIB_ITEM* newItem;
118 
119  m_library = aLibrary;
120  m_name = aSymbol.m_name;
121  m_fpFilters = wxArrayString( aSymbol.m_fpFilters );
122  m_unitCount = aSymbol.m_unitCount;
123  m_unitsLocked = aSymbol.m_unitsLocked;
126  m_includeInBom = aSymbol.m_includeInBom;
128  m_showPinNames = aSymbol.m_showPinNames;
129  m_lastModDate = aSymbol.m_lastModDate;
130  m_options = aSymbol.m_options;
131  m_libId = aSymbol.m_libId;
132  m_description = aSymbol.m_description;
133  m_keyWords = aSymbol.m_keyWords;
134 
135  ClearSelected();
136 
137  for( const LIB_ITEM& oldItem : aSymbol.m_drawings )
138  {
139  if( ( oldItem.GetFlags() & ( IS_NEW | STRUCT_DELETED ) ) != 0 )
140  continue;
141 
142  try
143  {
144  newItem = (LIB_ITEM*) oldItem.Clone();
145  newItem->ClearSelected();
146  newItem->SetParent( this );
147  m_drawings.push_back( newItem );
148  }
149  catch( ... )
150  {
151  wxFAIL_MSG( "Failed to clone LIB_ITEM." );
152  }
153  }
154 
155  LIB_SYMBOL_SPTR parent = aSymbol.m_parent.lock();
156 
157  if( parent )
158  SetParent( parent.get() );
159 }
bool m_showPinNumbers
Definition: lib_symbol.h:674
bool m_showPinNames
Definition: lib_symbol.h:673
#define IS_NEW
New item, just created.
void ClearSelected()
Definition: eda_item.h:132
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition: lib_symbol.h:42
wxString m_description
Definition: lib_symbol.h:684
wxString m_name
Definition: lib_symbol.h:683
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:116
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:83
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
timestamp_t m_lastModDate
Definition: lib_symbol.h:665
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663
bool m_unitsLocked
True if symbol has multiple units and changing one unit does not automatically change another unit.
Definition: lib_symbol.h:668
void push_back(T *aItem)
Definition: multivector.h:174
bool m_includeOnBoard
Definition: lib_symbol.h:677
#define STRUCT_DELETED
flag indication structures to be erased
void SetParent(LIB_SYMBOL *aParent=nullptr)
Definition: lib_symbol.cpp:323
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType)
Definition: eda_item.cpp:37
EDA_ITEM_FLAGS GetFlags() const
Definition: eda_item.h:155
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared
Definition: lib_symbol.cpp:74
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
bool m_includeInBom
Definition: lib_symbol.h:676
LIB_SYMBOL_SPTR m_me
Definition: lib_symbol.h:662
int m_pinNameOffset
The offset in mils to draw the pin name.
Definition: lib_symbol.h:671
wxArrayString m_fpFilters
List of suitable footprint names for the symbol (wild card names accepted).
Definition: lib_symbol.h:686
LIB_ID m_libId
Definition: lib_symbol.h:664
wxString m_keyWords
Search keywords.
Definition: lib_symbol.h:685
LIBRENTRYOPTIONS m_options
Special symbol features such as POWER or NORMAL.)
Definition: lib_symbol.h:678
int m_unitCount
Number of units (parts) per package.
Definition: lib_symbol.h:667
SYMBOL_LIB * m_library
Definition: lib_symbol.h:682

References EDA_ITEM::ClearSelected(), EDA_ITEM::Clone(), EDA_ITEM::GetFlags(), IS_NEW, m_description, m_drawings, m_fpFilters, m_includeInBom, m_includeOnBoard, m_keyWords, m_lastModDate, m_libId, m_library, m_name, m_options, m_parent, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), EDA_ITEM::SetParent(), SetParent(), and STRUCT_DELETED.

◆ ~LIB_SYMBOL()

LIB_SYMBOL::~LIB_SYMBOL ( )
virtual

Member Function Documentation

◆ AddDrawItem()

void LIB_SYMBOL::AddDrawItem ( LIB_ITEM aItem,
bool  aSort = true 
)

◆ AddField()

void LIB_SYMBOL::AddField ( LIB_FIELD aField)

Add a field.

Takes ownership of the pointer.

Definition at line 882 of file lib_symbol.cpp.

883 {
884  AddDrawItem( aField );
885 }
void AddDrawItem(LIB_ITEM *aItem, bool aSort=true)
Add a new draw aItem to the draw object list and sort according to aSort.
Definition: lib_symbol.cpp:653

References AddDrawItem().

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

◆ ClearEditFlags()

void LIB_SYMBOL::ClearEditFlags ( )

Definition at line 1050 of file lib_symbol.cpp.

1051 {
1052  for( LIB_ITEM& item : m_drawings )
1053  item.ClearEditFlags();
1054 }
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References m_drawings.

Referenced by SYMBOL_EDIT_FRAME::SaveCopyInUndoList().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 154 of file eda_item.h.

154 { m_flags &= ~aMask; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

◆ ClearTempFlags()

void LIB_SYMBOL::ClearTempFlags ( )

Clears the status flag all draw objects in this symbol.

Definition at line 1043 of file lib_symbol.cpp.

1044 {
1045  for( LIB_ITEM& item : m_drawings )
1046  item.ClearTempFlags();
1047 }
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References m_drawings.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreatePin(), and SYMBOL_EDIT_FRAME::SaveCopyInUndoList().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 148 of file view_item.h.

149  {
150  m_viewPrivData = nullptr;
151  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:156

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::OnDestroy().

◆ Clone()

EDA_ITEM * EDA_ITEM::Clone ( ) const
virtualinherited

Create a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns
A clone of the item.

Reimplemented in FP_ZONE, ZONE, SCH_SYMBOL, PAD, FOOTPRINT, PCB_DIM_CENTER, PCB_DIM_LEADER, SCH_HIERLABEL, PCB_DIM_ORTHOGONAL, PCB_VIA, SCH_SHEET, PCB_DIM_ALIGNED, SCH_GLOBALLABEL, PCB_SHAPE, SCH_LABEL, PCB_ARC, SCH_TEXT, SCH_LINE, LIB_PIN, FP_TEXT, SCH_BUS_BUS_ENTRY, PCB_TRACK, SCH_FIELD, SCH_SHEET_PIN, LIB_FIELD, SCH_BUS_WIRE_ENTRY, FP_SHAPE, PCB_TEXT, SCH_BITMAP, PCB_GROUP, LIB_ARC, LIB_TEXT, SCH_JUNCTION, SCH_NO_CONNECT, SCH_MARKER, LIB_POLYLINE, PCB_TARGET, LIB_BEZIER, LIB_CIRCLE, LIB_RECTANGLE, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 83 of file eda_item.cpp.

84 {
85  wxCHECK_MSG( false, nullptr, wxT( "Clone not implemented in derived class " ) + GetClass() +
86  wxT( ". Bad programmer!" ) );
87 }
virtual wxString GetClass() const =0
Return the class name.

References EDA_ITEM::GetClass().

Referenced by DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), PCB_DIMENSION_BASE::GetEffectiveShape(), LIB_SYMBOL(), new_clone(), operator=(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), SetConversion(), SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), COMMIT::Stage(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ Compare()

int LIB_SYMBOL::Compare ( const LIB_SYMBOL aRhs) const

Comparison test that can be used for operators.

Parameters
aRhsis the right hand side symbol used for comparison.
Returns
-1 if this symbol is less than aRhs 1 if this symbol is greater than aRhs 0 if this symbol is the same as aRhs

Definition at line 213 of file lib_symbol.cpp.

214 {
215  if( m_me == aRhs.m_me )
216  return 0;
217 
218  int retv = m_name.Cmp( aRhs.m_name );
219 
220  if( retv )
221  return retv;
222 
223  retv = m_libId.compare( aRhs.m_libId );
224 
225  if( retv )
226  return retv;
227 
228  if( m_parent.lock() < aRhs.m_parent.lock() )
229  return -1;
230 
231  if( m_parent.lock() > aRhs.m_parent.lock() )
232  return 1;
233 
234  if( m_options != aRhs.m_options )
235  return ( m_options == ENTRY_NORMAL ) ? -1 : 1;
236 
237  if( m_unitCount != aRhs.m_unitCount )
238  return m_unitCount - aRhs.m_unitCount;
239 
240  if( m_drawings.size() != aRhs.m_drawings.size() )
241  return m_drawings.size() - aRhs.m_drawings.size();
242 
245 
246  while( lhsItemIt != m_drawings.end() )
247  {
248  const LIB_ITEM* lhsItem = static_cast<const LIB_ITEM*>( &(*lhsItemIt) );
249  const LIB_ITEM* rhsItem = static_cast<const LIB_ITEM*>( &(*rhsItemIt) );
250 
251  wxCHECK( lhsItem && rhsItem, lhsItem - rhsItem );
252 
253  if( lhsItem->Type() != rhsItem->Type() )
254  return lhsItem->Type() - rhsItem->Type();
255 
256  retv = lhsItem->compare( *rhsItem );
257 
258  if( retv )
259  return retv;
260 
261  ++lhsItemIt;
262  ++rhsItemIt;
263  }
264 
265  if( m_fpFilters.GetCount() != aRhs.m_fpFilters.GetCount() )
266  return m_fpFilters.GetCount() - aRhs.m_fpFilters.GetCount();
267 
268  for( size_t i = 0; i < m_fpFilters.GetCount(); i++ )
269  {
270  retv = m_fpFilters[i].Cmp( aRhs.m_fpFilters[i] );
271 
272  if( retv )
273  return retv;
274  }
275 
276  retv = m_description.Cmp( aRhs.m_description );
277 
278  if( retv )
279  return retv;
280 
281  retv = m_keyWords.Cmp( aRhs.m_keyWords );
282 
283  if( retv )
284  return retv;
285 
286  if( m_pinNameOffset != aRhs.m_pinNameOffset )
287  return m_pinNameOffset - aRhs.m_pinNameOffset;
288 
289  if( m_unitsLocked != aRhs.m_unitsLocked )
290  return ( m_unitsLocked ) ? 1 : -1;
291 
292  if( m_showPinNames != aRhs.m_showPinNames )
293  return ( m_showPinNames ) ? 1 : -1;
294 
295  if( m_showPinNumbers != aRhs.m_showPinNumbers )
296  return ( m_showPinNumbers ) ? 1 : -1;
297 
298  if( m_includeInBom != aRhs.m_includeInBom )
299  return ( m_includeInBom ) ? 1 : -1;
300 
301  if( m_includeOnBoard != aRhs.m_includeOnBoard )
302  return ( m_includeOnBoard ) ? 1 : -1;
303 
304  return 0;
305 }
bool m_showPinNumbers
Definition: lib_symbol.h:674
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:188
bool m_showPinNames
Definition: lib_symbol.h:673
wxString m_description
Definition: lib_symbol.h:684
wxString m_name
Definition: lib_symbol.h:683
int compare(const LIB_ID &aLibId) const
Compare the contents of LIB_ID objects by performing a std::string comparison of the library nickname...
Definition: lib_id.cpp:158
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:194
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663
bool m_unitsLocked
True if symbol has multiple units and changing one unit does not automatically change another unit.
Definition: lib_symbol.h:668
bool m_includeOnBoard
Definition: lib_symbol.h:677
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
bool m_includeInBom
Definition: lib_symbol.h:676
ITERATOR_BASE< const LIB_ITEM, const MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::const_iterator > CONST_ITERATOR
Definition: multivector.h:167
LIB_SYMBOL_SPTR m_me
Definition: lib_symbol.h:662
int m_pinNameOffset
The offset in mils to draw the pin name.
Definition: lib_symbol.h:671
wxArrayString m_fpFilters
List of suitable footprint names for the symbol (wild card names accepted).
Definition: lib_symbol.h:686
LIB_ID m_libId
Definition: lib_symbol.h:664
wxString m_keyWords
Search keywords.
Definition: lib_symbol.h:685
int m_unitCount
Number of units (parts) per package.
Definition: lib_symbol.h:667
LIBRENTRYOPTIONS m_options
Special symbol features such as POWER or NORMAL.)
Definition: lib_symbol.h:678
virtual int compare(const LIB_ITEM &aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags=LIB_ITEM::COMPARE_FLAGS::NORMAL) const
Provide the draw object specific comparison called by the == and < operators.
Definition: lib_item.cpp:74
size_t size(int aType=UNDEFINED_TYPE) const
Definition: multivector.h:225
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), LIB_ID::compare(), LIB_ITEM::compare(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), ENTRY_NORMAL, m_description, m_drawings, m_fpFilters, m_includeInBom, m_includeOnBoard, m_keyWords, m_libId, m_me, m_name, m_options, m_parent, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::size(), and EDA_ITEM::Type().

Referenced by BOOST_AUTO_TEST_CASE(), operator!=(), and operator==().

◆ deleteAllFields()

void LIB_SYMBOL::deleteAllFields ( )
private

Definition at line 876 of file lib_symbol.cpp.

877 {
879 }
void clear(int aType=UNDEFINED_TYPE)
Definition: multivector.h:212
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::clear(), LIB_FIELD_T, and m_drawings.

Referenced by SetFields().

◆ Duplicate()

virtual LIB_SYMBOL* LIB_SYMBOL::Duplicate ( ) const
inlinevirtual

Create a copy of a LIB_SYMBOL and assigns unique KIIDs to the copy and its children.

Definition at line 112 of file lib_symbol.h.

113  {
114  LIB_SYMBOL* dupe = new LIB_SYMBOL( *this, m_library );
115  const_cast<KIID&>( dupe->m_Uuid ) = KIID();
116 
117  for( LIB_ITEM& item : dupe->m_drawings )
118  const_cast<KIID&>( item.m_Uuid ) = KIID();
119 
120  return dupe;
121  }
Define a library symbol object.
Definition: lib_symbol.h:96
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
Definition: kiid.h:44
const KIID m_Uuid
Definition: eda_item.h:475
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
LIB_SYMBOL(const wxString &aName, LIB_SYMBOL *aParent=nullptr, SYMBOL_LIB *aLibrary=nullptr)
Definition: lib_symbol.cpp:82
SYMBOL_LIB * m_library
Definition: lib_symbol.h:682

References LIB_SYMBOL(), m_drawings, m_library, and EDA_ITEM::m_Uuid.

◆ FindField() [1/2]

LIB_FIELD * LIB_SYMBOL::FindField ( const wxString &  aFieldName)

Find a field within this symbol matching aFieldName and returns it or NULL if not found.

Definition at line 953 of file lib_symbol.cpp.

954 {
955  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
956  {
957  if( static_cast<LIB_FIELD*>( &item )->GetCanonicalName() == aFieldName )
958  return static_cast<LIB_FIELD*>( &item );
959  }
960 
961  return nullptr;
962 }
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References LIB_FIELD_T, and m_drawings.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), and FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable().

◆ FindField() [2/2]

const LIB_FIELD * LIB_SYMBOL::FindField ( const wxString &  aFieldName) const

Definition at line 965 of file lib_symbol.cpp.

966 {
967  for( const LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
968  {
969  if( static_cast<const LIB_FIELD*>( &item )->GetCanonicalName() == aFieldName )
970  return static_cast<const LIB_FIELD*>( &item );
971  }
972 
973  return nullptr;
974 }
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References LIB_FIELD_T, and m_drawings.

◆ Flatten()

std::unique_ptr< LIB_SYMBOL > LIB_SYMBOL::Flatten ( ) const

Return a flattened symbol inheritance to the caller.

If the symbol does not inherit from another symbol, a copy of the symbol is returned.

Returns
a flattened symbol on the heap

Definition at line 332 of file lib_symbol.cpp.

333 {
334  std::unique_ptr< LIB_SYMBOL > retv;
335 
336  if( IsAlias() )
337  {
338  LIB_SYMBOL_SPTR parent = m_parent.lock();
339 
340  wxCHECK_MSG( parent, retv,
341  wxString::Format( "Parent of derived symbol '%s' undefined", m_name ) );
342 
343  // Copy the parent.
344  retv.reset( new LIB_SYMBOL( *parent.get() ) );
345 
346  retv->SetName( m_name );
347 
348  // Now add the inherited part mandatory field (this) information.
349  for( int i = 0; i < MANDATORY_FIELDS; i++ )
350  {
351  wxString tmp = GetFieldById( i )->GetText();
352 
353  // If the field isn't defined then inherit the parent field value.
354  if( tmp.IsEmpty() )
355  retv->GetFieldById( i )->SetText( parent->GetFieldById( i )->GetText() );
356  else
357  *retv->GetFieldById( i ) = *GetFieldById( i );
358  }
359 
360  // Grab all the rest of derived symbol fields.
361  for( const LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
362  {
363  const LIB_FIELD* aliasField = dynamic_cast<const LIB_FIELD*>( &item );
364 
365  wxCHECK2( aliasField, continue );
366 
367  // Mandatory fields were already resolved.
368  if( aliasField->IsMandatory() )
369  continue;
370 
371  LIB_FIELD* newField = new LIB_FIELD( *aliasField );
372  newField->SetParent( retv.get() );
373 
374  LIB_FIELD* parentField = retv->FindField( aliasField->GetName() );
375 
376  if( !parentField ) // Derived symbol field does not exist in parent symbol.
377  {
378  retv->AddDrawItem( newField );
379  }
380  else // Derived symbol field overrides the parent symbol field.
381  {
382  retv->RemoveDrawItem( parentField );
383  retv->AddDrawItem( newField );
384  }
385  }
386 
387  retv->SetKeyWords( m_keyWords.IsEmpty() ? parent->GetKeyWords() : m_keyWords );
388  retv->SetDescription( m_description.IsEmpty() ? parent->GetDescription() : m_description );
389  retv->SetFPFilters( m_fpFilters.IsEmpty() ? parent->GetFPFilters() : m_fpFilters );
390  }
391  else
392  {
393  retv.reset( new LIB_SYMBOL( *this ) );
394  }
395 
396  return retv;
397 }
Field object used in symbol libraries.
Definition: lib_field.h:59
bool IsAlias() const
Definition: lib_symbol.h:172
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition: lib_symbol.h:42
wxString m_description
Definition: lib_symbol.h:684
wxString m_name
Definition: lib_symbol.h:683
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:116
wxString GetName(bool aUseDefaultName=true) const
Return the field name.
Definition: lib_field.cpp:363
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
LIB_FIELD * GetFieldById(int aId) const
Return pointer to the requested field.
Definition: lib_symbol.cpp:939
LIB_SYMBOL(const wxString &aName, LIB_SYMBOL *aParent=nullptr, SYMBOL_LIB *aLibrary=nullptr)
Definition: lib_symbol.cpp:82
wxArrayString m_fpFilters
List of suitable footprint names for the symbol (wild card names accepted).
Definition: lib_symbol.h:686
wxString m_keyWords
Search keywords.
Definition: lib_symbol.h:685
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133
bool IsMandatory() const
Definition: lib_field.cpp:451

References Format(), GetFieldById(), LIB_FIELD::GetName(), EDA_TEXT::GetText(), IsAlias(), LIB_FIELD::IsMandatory(), LIB_FIELD_T, LIB_SYMBOL(), m_description, m_drawings, m_fpFilters, m_keyWords, m_name, m_parent, MANDATORY_FIELDS, and EDA_ITEM::SetParent().

Referenced by SCH_SCREEN::Append(), SYMBOL_EDIT_FRAME::CopySymbolToClipboard(), SCH_EDIT_FRAME::CreateArchiveLibrary(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDIT_FRAME::ExportSymbol(), SYMBOL_EDIT_FRAME::GetDocumentExtents(), RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCH_SYMBOL::SCH_SYMBOL(), ERC_TESTER::TestLibSymbolIssues(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_CHANGE_SYMBOLS::updateFieldsList(), and SCH_SCREEN::UpdateSymbolLinks().

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 86 of file inspectable.h.

87  {
89  TYPE_ID thisType = TYPE_HASH( *this );
90  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
91  return object ? aProperty->getter( object ) : wxAny();
92  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
virtual wxAny getter(void *aObject) const =0
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_BASE::getter(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [2/3]

template<typename T >
T INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 95 of file inspectable.h.

96  {
98  TYPE_ID thisType = TYPE_HASH( *this );
99  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
100  return object ? aProperty->get<T>( object ) : T();
101  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
T get(void *aObject)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Get() [3/3]

template<typename T >
boost::optional<T> INSPECTABLE::Get ( const wxString &  aProperty)
inlineinherited

Definition at line 104 of file inspectable.h.

105  {
107  TYPE_ID thisType = TYPE_HASH( *this );
108  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
109  boost::optional<T> ret = T();
110 
111  if( prop )
112  {
113  void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
114 
115  if( object )
116  ret = prop->get<T>( object );
117  }
118 
119  return ret;
120  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
T get(void *aObject)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ GetBodyBoundingBox()

const EDA_RECT LIB_SYMBOL::GetBodyBoundingBox ( int  aUnit,
int  aConvert 
) const

Get the symbol bounding box excluding fields.

Returns
the symbol bounding box ( in user coordinates ) without fields
Parameters
aUnit= unit selection = 0, or 1..n
aConvert= 0, 1 or 2 If aUnit == 0, unit is not used if aConvert == 0 Convert is non used Fields are not taken in account

Definition at line 851 of file lib_symbol.cpp.

852 {
853  EDA_RECT bbox;
854 
855  for( const LIB_ITEM& item : m_drawings )
856  {
857  if( item.m_unit > 0 && aUnit > 0 && aUnit != item.m_unit )
858  continue;
859 
860  if( item.m_convert > 0 && aConvert > 0 && aConvert != item.m_convert )
861  continue;
862 
863  if( item.Type() == LIB_FIELD_T )
864  continue;
865 
866  if( item.Type() == LIB_PIN_T )
867  bbox.Merge( static_cast<const LIB_PIN&>( item ).GetBoundingBox( false, true ) );
868  else
869  bbox.Merge( item.GetBoundingBox() );
870  }
871 
872  return bbox;
873 }
void Merge(const EDA_RECT &aRect)
Modify the position and size of the rectangle in order to contain aRect.
Definition: eda_rect.cpp:432
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
Handle the component boundary box.
Definition: eda_rect.h:42

References LIB_FIELD_T, LIB_PIN_T, m_drawings, and EDA_RECT::Merge().

Referenced by SCH_SYMBOL::GetBodyBoundingBox().

◆ GetBoundingBox()

const EDA_RECT LIB_SYMBOL::GetBoundingBox ( ) const
inlineoverridevirtual

Return the orthogonal bounding box of this object for display purposes.

This box should be an enclosing perimeter for visible components of this object, and the units should be in the pcb or schematic coordinate system. It is OK to overestimate the size by a few counts.

Reimplemented from EDA_ITEM.

Definition at line 220 of file lib_symbol.h.

221  {
222  return GetUnitBoundingBox( 0, 0 );
223  }
const EDA_RECT GetUnitBoundingBox(int aUnit, int aConvert) const
Get the bounding box for the symbol.
Definition: lib_symbol.cpp:805

References GetUnitBoundingBox().

◆ GetClass()

virtual wxString LIB_SYMBOL::GetClass ( ) const
inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 127 of file lib_symbol.h.

128  {
129  return wxT( "LIB_SYMBOL" );
130  }

◆ GetDatasheetField()

LIB_FIELD & LIB_SYMBOL::GetDatasheetField ( )

Return reference to the datasheet field.

Definition at line 1001 of file lib_symbol.cpp.

1002 {
1004  wxASSERT( field != nullptr );
1005  return *field;
1006 }
Field object used in symbol libraries.
Definition: lib_field.h:59
name of datasheet
LIB_FIELD * GetFieldById(int aId) const
Return pointer to the requested field.
Definition: lib_symbol.cpp:939

References DATASHEET_FIELD, and GetFieldById().

Referenced by SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), SYMBOL_VIEWER_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), and EE_INSPECTION_TOOL::ShowDatasheet().

◆ GetDescription()

wxString LIB_SYMBOL::GetDescription ( )
inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 142 of file lib_symbol.h.

143  {
144  if( m_description.IsEmpty() && IsAlias() )
145  {
146  if( LIB_SYMBOL_SPTR parent = m_parent.lock() )
147  return parent->GetDescription();
148  }
149 
150  return m_description;
151  }
bool IsAlias() const
Definition: lib_symbol.h:172
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition: lib_symbol.h:42
wxString m_description
Definition: lib_symbol.h:684
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663

References IsAlias(), m_description, and m_parent.

Referenced by SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), GetSearchText(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SCH_SEXPR_PLUGIN_CACHE::saveDcmInfoAsFields(), FOOTPRINT_INFO_GENERATOR::SetHtmlDesc(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and SYMBOL_VIEWER_FRAME::updatePreviewSymbol().

◆ GetDrawItems() [1/2]

◆ GetDrawItems() [2/2]

const LIB_ITEMS_CONTAINER& LIB_SYMBOL::GetDrawItems ( ) const
inline

Definition at line 474 of file lib_symbol.h.

474 { return m_drawings; }
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References m_drawings.

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 158 of file eda_item.h.

159  {
160  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
162 
163  return m_flags & mask;
164  }
#define IS_NEW
New item, just created.
#define IS_RESIZING
Item being resized.
#define IS_DRAGGING
Item being dragged.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
#define IS_MOVING
Item being moved.
#define STRUCT_DELETED
flag indication structures to be erased
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.

References IS_DRAGGING, IS_MOVING, IS_NEW, IS_PASTED, IS_RESIZING, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SYMBOL::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetFieldById()

LIB_FIELD * LIB_SYMBOL::GetFieldById ( int  aId) const

Return pointer to the requested field.

Parameters
aId- Id of field to return.
Returns
The field if found, otherwise NULL.

Definition at line 939 of file lib_symbol.cpp.

940 {
941  for( const LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
942  {
943  LIB_FIELD* field = ( LIB_FIELD* ) &item;
944 
945  if( field->GetId() == aId )
946  return field;
947  }
948 
949  return nullptr;
950 }
Field object used in symbol libraries.
Definition: lib_field.h:59
int GetId() const
Definition: lib_field.h:115
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References LIB_FIELD::GetId(), LIB_FIELD_T, and m_drawings.

Referenced by SYMBOL_EDIT_FRAME::CreateNewSymbol(), Flatten(), GetDatasheetField(), GetFields(), GetFootprintField(), GetReferenceField(), GetValueField(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), DIALOG_CHANGE_SYMBOLS::processSymbol(), and DIALOG_CHOOSE_SYMBOL::ShowFootprintFor().

◆ GetFieldCount()

size_t LIB_SYMBOL::GetFieldCount ( ) const
inline

Definition at line 361 of file lib_symbol.h.

361 { return m_drawings.size( LIB_FIELD_T ); }
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
size_t size(int aType=UNDEFINED_TYPE) const
Definition: multivector.h:225

References LIB_FIELD_T, m_drawings, and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::size().

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary().

◆ GetFields() [1/2]

void LIB_SYMBOL::GetFields ( std::vector< LIB_FIELD * > &  aList)

Return a list of fields within this symbol.

Parameters
aList- List to add fields to

Definition at line 905 of file lib_symbol.cpp.

906 {
907  // Grab the MANDATORY_FIELDS first, in expected order given by enum MANDATORY_FIELD_T
908  for( int id = 0; id < MANDATORY_FIELDS; ++id )
909  aList.push_back( GetFieldById( id ) );
910 
911  // Now grab all the rest of fields.
912  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
913  {
914  LIB_FIELD* field = static_cast<LIB_FIELD*>( &item );
915 
916  if( !field->IsMandatory() )
917  aList.push_back( field );
918  }
919 }
Field object used in symbol libraries.
Definition: lib_field.h:59
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
LIB_FIELD * GetFieldById(int aId) const
Return pointer to the requested field.
Definition: lib_symbol.cpp:939
bool IsMandatory() const
Definition: lib_field.cpp:451

References GetFieldById(), LIB_FIELD::IsMandatory(), LIB_FIELD_T, m_drawings, and MANDATORY_FIELDS.

Referenced by DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_UPDATE_SYMBOL_FIELDS::updateFieldsList().

◆ GetFields() [2/2]

void LIB_SYMBOL::GetFields ( std::vector< LIB_FIELD > &  aList)

Definition at line 922 of file lib_symbol.cpp.

923 {
924  // Grab the MANDATORY_FIELDS first, in expected order given by enum MANDATORY_FIELD_T
925  for( int id = 0; id < MANDATORY_FIELDS; ++id )
926  aList.push_back( *GetFieldById( id ) );
927 
928  // Now grab all the rest of fields.
929  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
930  {
931  LIB_FIELD* field = static_cast<LIB_FIELD*>( &item );
932 
933  if( !field->IsMandatory() )
934  aList.push_back( *field );
935  }
936 }
Field object used in symbol libraries.
Definition: lib_field.h:59
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
LIB_FIELD * GetFieldById(int aId) const
Return pointer to the requested field.
Definition: lib_symbol.cpp:939
bool IsMandatory() const
Definition: lib_field.cpp:451

References GetFieldById(), LIB_FIELD::IsMandatory(), LIB_FIELD_T, m_drawings, and MANDATORY_FIELDS.

◆ GetFlags()

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

Similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 259 of file eda_item.h.

259 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: eda_item.h:252

References EDA_ITEM::GetPosition().

Referenced by PCB_BASE_FRAME::FocusOnItem(), and SCH_EDIT_FRAME::FocusOnItem().

◆ GetFootprintField()

LIB_FIELD & LIB_SYMBOL::GetFootprintField ( )

Return reference to the footprint field.

Definition at line 993 of file lib_symbol.cpp.

994 {
996  wxASSERT( field != nullptr );
997  return *field;
998 }
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_FIELD * GetFieldById(int aId) const
Return pointer to the requested field.
Definition: lib_symbol.cpp:939
Field Name Module PCB, i.e. "16DIP300".

References FOOTPRINT_FIELD, and GetFieldById().

Referenced by GetSearchText(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary().

◆ GetFPFilters()

wxArrayString LIB_SYMBOL::GetFPFilters ( ) const
inline

Definition at line 183 of file lib_symbol.h.

184  {
185  if( m_fpFilters.IsEmpty() && IsAlias() )
186  {
187  if( LIB_SYMBOL_SPTR parent = m_parent.lock() )
188  return parent->GetFPFilters();
189  }
190 
191  return m_fpFilters;
192  }
bool IsAlias() const
Definition: lib_symbol.h:172
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition: lib_symbol.h:42
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663
wxArrayString m_fpFilters
List of suitable footprint names for the symbol (wild card names accepted).
Definition: lib_symbol.h:686

References IsAlias(), m_fpFilters, and m_parent.

Referenced by DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_SEXPR_PLUGIN_CACHE::saveDcmInfoAsFields(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetIncludeInBom()

bool LIB_SYMBOL::GetIncludeInBom ( ) const
inline

◆ GetIncludeOnBoard()

bool LIB_SYMBOL::GetIncludeOnBoard ( ) const
inline

◆ GetKeyWords()

wxString LIB_SYMBOL::GetKeyWords ( ) const
inline

Definition at line 155 of file lib_symbol.h.

156  {
157  if( m_keyWords.IsEmpty() && IsAlias() )
158  {
159  if( LIB_SYMBOL_SPTR parent = m_parent.lock() )
160  return parent->GetKeyWords();
161  }
162 
163  return m_keyWords;
164  }
bool IsAlias() const
Definition: lib_symbol.h:172
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition: lib_symbol.h:42
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663
wxString m_keyWords
Search keywords.
Definition: lib_symbol.h:685

References IsAlias(), m_keyWords, and m_parent.

Referenced by SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), GetSearchText(), SCH_SEXPR_PLUGIN_CACHE::saveDcmInfoAsFields(), FOOTPRINT_INFO_GENERATOR::SetHtmlKeywords(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and SYMBOL_VIEWER_FRAME::updatePreviewSymbol().

◆ GetLastModDate()

timestamp_t LIB_SYMBOL::GetLastModDate ( ) const
inline

Definition at line 179 of file lib_symbol.h.

179 { return m_lastModDate; }
timestamp_t m_lastModDate
Definition: lib_symbol.h:665

References m_lastModDate.

Referenced by SCH_LEGACY_PLUGIN_CACHE::SaveSymbol().

◆ GetLib()

SYMBOL_LIB* LIB_SYMBOL::GetLib ( ) const
inline

Definition at line 176 of file lib_symbol.h.

176 { return m_library; }
SYMBOL_LIB * m_library
Definition: lib_symbol.h:682

References m_library.

Referenced by SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::CreateBuffer(), and SYMBOL_LIB::FindSymbol().

◆ GetLibId()

◆ GetLibNickname()

wxString LIB_SYMBOL::GetLibNickname ( ) const
inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 138 of file lib_symbol.h.

138 { return GetLibraryName(); }
const wxString GetLibraryName() const
Definition: lib_symbol.cpp:400

References GetLibraryName().

Referenced by SYMBOL_EDIT_FRAME::IsSymbolFromLegacyLibrary().

◆ GetLibraryName()

const wxString LIB_SYMBOL::GetLibraryName ( ) const

Definition at line 400 of file lib_symbol.cpp.

401 {
402  if( m_library )
403  return m_library->GetName();
404 
405  return m_libId.GetLibNickname();
406 }
const wxString GetName() const
Return the file name without path or extension.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:90
LIB_ID m_libId
Definition: lib_symbol.h:664
SYMBOL_LIB * m_library
Definition: lib_symbol.h:682

References LIB_ID::GetLibNickname(), SYMBOL_LIB::GetName(), m_libId, and m_library.

Referenced by GetLibNickname().

◆ GetMenuImage()

BITMAPS EDA_ITEM::GetMenuImage ( ) const
virtualinherited

◆ GetMsgPanelInfo()

◆ GetName()

wxString LIB_SYMBOL::GetName ( void  ) const
inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 133 of file lib_symbol.h.

133 { return m_name; }
wxString m_name
Definition: lib_symbol.h:683

References m_name.

Referenced by SCH_SEXPR_PLUGIN_CACHE::AddSymbol(), SCH_LEGACY_PLUGIN_CACHE::AddSymbol(), SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), SYMBOL_EDIT_FRAME::DuplicateSymbol(), SYMBOL_EDIT_FRAME::ensureUniqueName(), SYMBOL_EDIT_FRAME::ExportSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), SYMBOL_LIB::GetSymbols(), SCH_LEGACY_PLUGIN_CACHE::Load(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), CADSTAR_SCH_ARCHIVE_LOADER::loadPartsLibrary(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), operator<(), SCH_SEXPR_PARSER::ParseLib(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SYMBOL_LIB::RemoveSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), SYMBOL_LIB::ReplaceSymbol(), SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SYMBOL_EDIT_FRAME::saveSymbolAs(), SYMBOL_EDIT_FRAME::SetCurSymbol(), FOOTPRINT_INFO_GENERATOR::SetHtmlName(), SYMBOL_EDIT_FRAME::SyncLibraries(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), SYMBOL_EDIT_FRAME::UpdateAfterSymbolProperties(), FP_TREE_SYNCHRONIZING_ADAPTER::updateLibrary(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), and SYMBOL_LIBRARY_MANAGER::UpdateSymbol().

◆ GetNextDrawItem()

LIB_ITEM * LIB_SYMBOL::GetNextDrawItem ( const LIB_ITEM aItem = nullptr,
KICAD_T  aType = TYPE_NOT_INIT 
)

Return the next draw object pointer.

Parameters
aItem- Pointer to the current draw item. Setting item NULL with return the first item of type in the list.
aType- type of searched item (filter). if TYPE_NOT_INIT search for all items types
Returns
- The next drawing object in the list if found, otherwise NULL.

Definition at line 664 of file lib_symbol.cpp.

665 {
666  if( aItem == nullptr )
667  {
669 
670  return (it1 != m_drawings.end( aType ) ) ? &( *( m_drawings.begin( aType ) ) ) : nullptr;
671  }
672 
673  // Search for the last item, assume aItem is of type aType
674  wxASSERT( ( aType == TYPE_NOT_INIT ) || ( aType == aItem->Type() ) );
676 
677  while( ( it != m_drawings.end( aType ) ) && ( aItem != &( *it ) ) )
678  ++it;
679 
680  // Search the next item
681  if( it != m_drawings.end( aType ) )
682  {
683  ++it;
684 
685  if( it != m_drawings.end( aType ) )
686  return &( *it );
687  }
688 
689  return nullptr;
690 }
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:188
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:194
ITERATOR_BASE< LIB_ITEM, MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::iterator > ITERATOR
The const iterator.
Definition: multivector.h:164
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), m_drawings, EDA_ITEM::Type(), and TYPE_NOT_INIT.

Referenced by BOOST_AUTO_TEST_CASE(), and GetNextPin().

◆ GetNextPin()

LIB_PIN* LIB_SYMBOL::GetNextPin ( LIB_PIN aItem = nullptr)
inline

Return the next pin object from the draw list.

This is just a pin object specific version of GetNextDrawItem().

Parameters
aItem- Pointer to the previous pin item, or NULL to get the first pin in the draw object list.
Returns
- The next pin object in the list if found, otherwise NULL.

Definition at line 372 of file lib_symbol.h.

373  {
374  return (LIB_PIN*) GetNextDrawItem( (LIB_ITEM*) aItem, LIB_PIN_T );
375  }
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_ITEM * GetNextDrawItem(const LIB_ITEM *aItem=nullptr, KICAD_T aType=TYPE_NOT_INIT)
Return the next draw object pointer.
Definition: lib_symbol.cpp:664

References GetNextDrawItem(), and LIB_PIN_T.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), DIALOG_LIB_EDIT_PIN_TABLE::TransferDataFromWindow(), and DIALOG_LIB_EDIT_PIN_TABLE::TransferDataToWindow().

◆ GetParent() [1/2]

◆ GetParent() [2/2]

const LIB_SYMBOL_REF& LIB_SYMBOL::GetParent ( void  ) const
inline

Definition at line 125 of file lib_symbol.h.

125 { return m_parent; }
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663

References m_parent.

◆ GetPin()

LIB_PIN * LIB_SYMBOL::GetPin ( const wxString &  aNumber,
int  aUnit = 0,
int  aConvert = 0 
) const

Return pin object with the requested pin aNumber.

Parameters
aNumber- Number of the pin to find.
aUnit- Unit of the symbol to find. Set to 0 if a specific unit number is not required.
aConvert- Alternate body style filter (DeMorgan). Set to 0 if no alternate body style is required.
Returns
The pin object if found. Otherwise NULL.

Definition at line 720 of file lib_symbol.cpp.

721 {
722  LIB_PINS pinList;
723 
724  GetPins( pinList, aUnit, aConvert );
725 
726  for( size_t i = 0; i < pinList.size(); i++ )
727  {
728  wxASSERT( pinList[i]->Type() == LIB_PIN_T );
729 
730  if( aNumber == pinList[i]->GetNumber() )
731  return pinList[i];
732  }
733 
734  return nullptr;
735 }
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0) const
Return a list of pin object pointers from the draw item list.
Definition: lib_symbol.cpp:693
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:55
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References GetPins(), LIB_PIN_T, and EDA_ITEM::Type().

◆ GetPinCount()

size_t LIB_SYMBOL::GetPinCount ( ) const
inline

Definition at line 359 of file lib_symbol.h.

359 { return m_drawings.size( LIB_PIN_T ); }
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
size_t size(int aType=UNDEFINED_TYPE) const
Definition: multivector.h:225

References LIB_PIN_T, m_drawings, and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::size().

◆ GetPinNameOffset()

◆ GetPins()

void LIB_SYMBOL::GetPins ( LIB_PINS aList,
int  aUnit = 0,
int  aConvert = 0 
) const

Return a list of pin object pointers from the draw item list.

Note pin objects are owned by the draw list of the symbol. Deleting any of the objects will leave list in a unstable state and will likely segfault when the list is destroyed.

Parameters
aList- Pin list to place pin object pointers into.
aUnit- Unit number of pin to add to list. Set to 0 to get pins from any symbol unit.
aConvert- Convert number of pin to add to list. Set to 0 to get pins from any convert of symbol.

Definition at line 693 of file lib_symbol.cpp.

694 {
695  /* Notes:
696  * when aUnit == 0: no unit filtering
697  * when aConvert == 0: no convert (shape selection) filtering
698  * when m_unit == 0, the body item is common to units
699  * when m_convert == 0, the body item is common to shapes
700  */
701 
702  LIB_SYMBOL_SPTR parent = m_parent.lock();
703  const LIB_ITEMS_CONTAINER& drawItems = parent ? parent->m_drawings : m_drawings;
704 
705  for( const LIB_ITEM& item : drawItems[LIB_PIN_T] )
706  {
707  // Unit filtering:
708  if( aUnit && item.m_unit && ( item.m_unit != aUnit ) )
709  continue;
710 
711  // Shape filtering:
712  if( aConvert && item.m_convert && ( item.m_convert != aConvert ) )
713  continue;
714 
715  aList.push_back( (LIB_PIN*) &item );
716  }
717 }
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition: lib_symbol.h:42
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663
void push_back(T *aItem)
Definition: multivector.h:174
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References LIB_PIN_T, m_drawings, m_parent, and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back().

Referenced by EE_INSPECTION_TOOL::CheckSymbol(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), GetPin(), PinsConflictWith(), and DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector().

◆ GetPosition()

virtual wxPoint EDA_ITEM::GetPosition ( ) const
inlinevirtualinherited

Reimplemented in SCH_SYMBOL, PCB_VIA, DELETED_BOARD_ITEM, SCH_SHEET, DS_DRAW_ITEM_BITMAP, DS_DRAW_ITEM_TEXT, PCB_ARC, BOARD, DS_DRAW_ITEM_PAGE, SCH_TEXT, DS_DRAW_ITEM_RECT, SCH_LINE, LIB_PIN, SCH_FIELD, FOOTPRINT, PAD, DS_DRAW_ITEM_POLYPOLYGONS, LIB_FIELD, GERBER_DRAW_ITEM, DS_DRAW_ITEM_LINE, SCH_BITMAP, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_GROUP, ZONE, SCH_NO_CONNECT, KIGFX::ORIGIN_VIEWITEM, SCH_BUS_ENTRY_BASE, SCH_MARKER, PCB_TRACK, LIB_TEXT, SCH_JUNCTION, FP_TEXT, LIB_POLYLINE, NETINFO_ITEM, SCH_PIN, PCB_TEXT, LIB_BEZIER, LIB_ARC, LIB_RECTANGLE, PCB_MARKER, LIB_CIRCLE, and PCB_TARGET.

Definition at line 252 of file eda_item.h.

252 { return wxPoint(); }

Referenced by EE_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), SCH_EDIT_FRAME::DeleteJunction(), KIGFX::PCB_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), PCB_SELECTION_TOOL::findCallback(), GERBVIEW_SELECTION::GetCenter(), EDA_ITEM::GetFocusPosition(), SCH_FIELD::GetParentPosition(), SCH_SCREEN::GetSheets(), PCB_SELECTION::GetTopLeftItem(), EE_SELECTION::GetTopLeftItem(), BOARD_ITEM::GetX(), BOARD_ITEM::GetY(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_ITEM::operator<(), PL_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::PositionRelative(), BACK_ANNOTATE::processNetNameChange(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), PCB_SELECTION_TOOL::selectConnectedTracks(), RC_ITEM::ShowReport(), TransformItem(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), PL_EDIT_TOOL::updateModificationPoint(), and EE_POINT_EDITOR::updatePoints().

◆ GetReferenceField()

LIB_FIELD & LIB_SYMBOL::GetReferenceField ( )

Return reference to the reference designator field.

Definition at line 985 of file lib_symbol.cpp.

986 {
988  wxASSERT( field != nullptr );
989  return *field;
990 }
Field Reference of part, i.e. "IC21".
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_FIELD * GetFieldById(int aId) const
Return pointer to the requested field.
Definition: lib_symbol.cpp:939

References GetFieldById(), and REFERENCE_FIELD.

Referenced by SYMBOL_EDIT_FRAME::CreateNewSymbol(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), and SCH_LEGACY_PLUGIN_CACHE::SaveSymbol().

◆ GetSearchText()

wxString LIB_SYMBOL::GetSearchText ( )
overridevirtual

Reimplemented from LIB_TREE_ITEM.

Definition at line 49 of file lib_symbol.cpp.

50 {
51  // Matches are scored by offset from front of string, so inclusion of this spacer
52  // discounts matches found after it.
53  static const wxString discount( wxT( " " ) );
54 
55  wxString text = GetKeyWords() + discount + GetDescription();
56  wxString footprint = GetFootprintField().GetText();
57 
58  if( !footprint.IsEmpty() )
59  {
60  text += discount + footprint;
61  }
62 
63  return text;
64 }
LIB_FIELD & GetFootprintField()
Return reference to the footprint field.
Definition: lib_symbol.cpp:993
wxString GetKeyWords() const
Definition: lib_symbol.h:155
wxString GetDescription() override
Definition: lib_symbol.h:142
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133

References GetDescription(), GetFootprintField(), GetKeyWords(), EDA_TEXT::GetText(), and text.

◆ GetSelectMenuText()

wxString EDA_ITEM::GetSelectMenuText ( EDA_UNITS  aUnits) const
virtualinherited

Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

The default version of this function raises an assertion in the debug mode and returns a string to indicate that it was not overridden to provide the object specific text.

Returns
The menu text string.

Reimplemented in ZONE, SCH_SYMBOL, PAD, FOOTPRINT, BOARD, SCH_HIERLABEL, PCB_VIA, SCH_GLOBALLABEL, DELETED_BOARD_ITEM, SCH_SHEET, DS_DRAW_ITEM_BITMAP, DS_DRAW_ITEM_TEXT, PCB_SHAPE, SCH_LABEL, DS_DRAW_ITEM_PAGE, GERBER_DRAW_ITEM, PCB_DIMENSION_BASE, SCH_TEXT, DS_DRAW_ITEM_RECT, LIB_PIN, FP_TEXT, SCH_LINE, SCH_BUS_BUS_ENTRY, PCB_TRACK, PCB_GROUP, SCH_FIELD, DS_DRAW_ITEM_POLYPOLYGONS, SCH_SHEET_PIN, LIB_FIELD, SCH_BUS_WIRE_ENTRY, FP_SHAPE, DS_DRAW_ITEM_LINE, PCB_TEXT, SCH_BITMAP, LIB_ARC, LIB_TEXT, LIB_POLYLINE, SCH_NO_CONNECT, SCH_MARKER, PCB_MARKER, PCB_TARGET, SCH_JUNCTION, LIB_CIRCLE, LIB_RECTANGLE, SCH_PIN, and DELETED_SHEET_ITEM.

Definition at line 109 of file eda_item.cpp.

110 {
111  wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
112  GetClass() );
113 
114  return wxString( wxT( "Undefined menu text for " ) + GetClass() );
115 }
virtual wxString GetClass() const =0
Return the class name.

References EDA_ITEM::GetClass().

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), DIALOG_GROUP_PROPERTIES::DoAddMember(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), DRC_ENGINE::EvalRules(), BOARD_INSPECTION_TOOL::getItemDescription(), PCB_MARKER::GetMsgPanelInfo(), RC_TREE_MODEL::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), RC_ITEM::ShowReport(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS  type) const
inlineinherited

Definition at line 137 of file eda_item.h.

138  {
139  return m_status & type;
140  }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:478

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 150 of file eda_item.h.

150 { return m_status; }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:478

References EDA_ITEM::m_status.

◆ GetSubpartFirstId()

static int LIB_SYMBOL::GetSubpartFirstId ( )
inlinestatic

Definition at line 520 of file lib_symbol.h.

520 { return m_subpartFirstId; }
static int m_subpartFirstId
the ASCII char value to calculate the subpart symbol id from the symbol number: only 'A',...
Definition: lib_symbol.h:692

References m_subpartFirstId.

Referenced by SCH_EDIT_FRAME::LoadProjectSettings(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), and PANEL_SETUP_FORMATTING::TransferDataToWindow().

◆ GetSubpartIdSeparator()

static int LIB_SYMBOL::GetSubpartIdSeparator ( )
inlinestatic

Definition at line 514 of file lib_symbol.h.

514 { return m_subpartIdSeparator; }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
Definition: lib_symbol.h:689

References m_subpartIdSeparator.

Referenced by SCH_EDIT_FRAME::LoadProjectSettings(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), and PANEL_SETUP_FORMATTING::TransferDataToWindow().

◆ GetUniqueUnits()

std::vector< struct LIB_SYMBOL_UNITS > LIB_SYMBOL::GetUniqueUnits ( )

Return a list of unit numbers that are unique to this symbol.

If the symbol is inherited (alias), the unique units of the parent symbol are returned. When comparing pins, the pin number is ignored.

Returns
a list of unique unit numbers and their associated draw items.

Definition at line 1289 of file lib_symbol.cpp.

1290 {
1291  int unitNum;
1292  size_t i;
1293  struct LIB_SYMBOL_UNITS unit;
1294  std::vector<LIB_ITEM*> compareDrawItems;
1295  std::vector<LIB_ITEM*> currentDrawItems;
1296  std::vector<struct LIB_SYMBOL_UNITS> uniqueUnits;
1297 
1298  // The first unit is guaranteed to be unique so always include it.
1299  unit.m_unit = 1;
1300  unit.m_convert = 1;
1301  unit.m_items = GetUnitItems( 1, 1 );
1302 
1303  // There are no unique units if there are no draw items other than fields.
1304  if( unit.m_items.size() == 0 )
1305  return uniqueUnits;
1306 
1307  uniqueUnits.emplace_back( unit );
1308 
1309  if( ( GetUnitCount() == 1 || UnitsLocked() ) && !HasConversion() )
1310  return uniqueUnits;
1311 
1312  currentDrawItems = unit.m_items;
1313 
1314  for( unitNum = 2; unitNum <= GetUnitCount(); unitNum++ )
1315  {
1316  compareDrawItems = GetUnitItems( unitNum, 1 );
1317 
1318  wxCHECK2_MSG( compareDrawItems.size() != 0, continue,
1319  "Multiple unit symbol defined with empty units." );
1320 
1321  if( currentDrawItems.size() != compareDrawItems.size() )
1322  {
1323  unit.m_unit = unitNum;
1324  unit.m_convert = 1;
1325  unit.m_items = compareDrawItems;
1326  uniqueUnits.emplace_back( unit );
1327  }
1328  else
1329  {
1330  for( i = 0; i < currentDrawItems.size(); i++ )
1331  {
1332  if( currentDrawItems[i]->compare( *compareDrawItems[i],
1333  LIB_ITEM::COMPARE_FLAGS::UNIT ) != 0 )
1334  {
1335  unit.m_unit = unitNum;
1336  unit.m_convert = 1;
1337  unit.m_items = compareDrawItems;
1338  uniqueUnits.emplace_back( unit );
1339  }
1340  }
1341  }
1342  }
1343 
1344  if( HasConversion() )
1345  {
1346  currentDrawItems = GetUnitItems( 1, 2 );
1347 
1348  if( ( GetUnitCount() == 1 || UnitsLocked() ) )
1349  {
1350  unit.m_unit = 1;
1351  unit.m_convert = 2;
1352  unit.m_items = currentDrawItems;
1353  uniqueUnits.emplace_back( unit );
1354 
1355  return uniqueUnits;
1356  }
1357 
1358  for( unitNum = 2; unitNum <= GetUnitCount(); unitNum++ )
1359  {
1360  compareDrawItems = GetUnitItems( unitNum, 2 );
1361 
1362  wxCHECK2_MSG( compareDrawItems.size() != 0, continue,
1363  "Multiple unit symbol defined with empty units." );
1364 
1365  if( currentDrawItems.size() != compareDrawItems.size() )
1366  {
1367  unit.m_unit = unitNum;
1368  unit.m_convert = 2;
1369  unit.m_items = compareDrawItems;
1370  uniqueUnits.emplace_back( unit );
1371  }
1372  else
1373  {
1374  for( i = 0; i < currentDrawItems.size(); i++ )
1375  {
1376  if( currentDrawItems[i]->compare( *compareDrawItems[i],
1377  LIB_ITEM::COMPARE_FLAGS::UNIT ) != 0 )
1378  {
1379  unit.m_unit = unitNum;
1380  unit.m_convert = 2;
1381  unit.m_items = compareDrawItems;
1382  uniqueUnits.emplace_back( unit );
1383  }
1384  }
1385  }
1386  }
1387  }
1388 
1389  return uniqueUnits;
1390 }
bool HasConversion() const
Test if symbol has more than one body conversion type (DeMorgan).
int GetUnitCount() const override
For items with units, return the number of units.
int m_unit
The unit number.
Definition: lib_symbol.h:84
bool UnitsLocked() const
Check whether symbol units are interchangeable.
Definition: lib_symbol.h:241
std::vector< LIB_ITEM * > GetUnitItems(int aUnit, int aConvert)
Return a list of item pointers for aUnit and aConvert for this symbol.

References GetUnitCount(), GetUnitItems(), HasConversion(), LIB_SYMBOL_UNITS::m_convert, LIB_SYMBOL_UNITS::m_items, LIB_SYMBOL_UNITS::m_unit, and UnitsLocked().

◆ GetUnitBoundingBox()

const EDA_RECT LIB_SYMBOL::GetUnitBoundingBox ( int  aUnit,
int  aConvert 
) const

Get the bounding box for the symbol.

Returns
the symbol bounding box ( in user coordinates )
Parameters
aUnit= unit selection = 0, or 1..n
aConvert= 0, 1 or 2 If aUnit == 0, unit is not used if aConvert == 0 Convert is non used Invisible fields are not taken in account

Definition at line 805 of file lib_symbol.cpp.

806 {
807  EDA_RECT bBox;
808  bool initialized = false;
809 
810  for( const LIB_ITEM& item : m_drawings )
811  {
812  if( item.m_unit > 0
813  && m_unitCount > 1
814  && aUnit > 0
815  && aUnit != item.m_unit )
816  {
817  continue;
818  }
819 
820  if( item.m_convert > 0 && aConvert > 0 && aConvert != item.m_convert )
821  continue;
822 
823  if ( ( item.Type() == LIB_FIELD_T ) && !( ( LIB_FIELD& ) item ).IsVisible() )
824  continue;
825 
826  if( initialized )
827  bBox.Merge( item.GetBoundingBox() );
828  else
829  {
830  bBox = item.GetBoundingBox();
831  initialized = true;
832  }
833  }
834 
835  return bBox;
836 }
void Merge(const EDA_RECT &aRect)
Modify the position and size of the rectangle in order to contain aRect.
Definition: eda_rect.cpp:432
Field object used in symbol libraries.
Definition: lib_field.h:59
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
Handle the component boundary box.
Definition: eda_rect.h:42
int m_unitCount
Number of units (parts) per package.
Definition: lib_symbol.h:667

References LIB_FIELD_T, m_drawings, m_unitCount, and EDA_RECT::Merge().

Referenced by SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), and GetBoundingBox().

◆ GetUnitCount()

◆ GetUnitDrawItems()

std::vector< struct LIB_SYMBOL_UNITS > LIB_SYMBOL::GetUnitDrawItems ( )

Return a list of LIB_ITEM objects separated by unit and convert number.

Note
This does not include LIB_FIELD objects since they are not associated with unit and/or convert numbers.

Definition at line 1254 of file lib_symbol.cpp.

1255 {
1256  std::vector<struct LIB_SYMBOL_UNITS> units;
1257 
1258  for( LIB_ITEM& item : m_drawings )
1259  {
1260  if( item.Type() == LIB_FIELD_T )
1261  continue;
1262 
1263  int unit = item.GetUnit();
1264  int convert = item.GetConvert();
1265 
1266  auto it = std::find_if( units.begin(), units.end(),
1267  [unit, convert] ( const auto& a ) {
1268  return a.m_unit == unit && a.m_convert == convert;
1269  } );
1270 
1271  if( it == units.end() )
1272  {
1273  struct LIB_SYMBOL_UNITS newUnit;
1274  newUnit.m_unit = item.GetUnit();
1275  newUnit.m_convert = item.GetConvert();
1276  newUnit.m_items.push_back( &item );
1277  units.emplace_back( newUnit );
1278  }
1279  else
1280  {
1281  it->m_items.push_back( &item );
1282  }
1283  }
1284 
1285  return units;
1286 }
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
int m_unit
The unit number.
Definition: lib_symbol.h:84
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References convert, LIB_FIELD_T, LIB_SYMBOL_UNITS::m_convert, m_drawings, LIB_SYMBOL_UNITS::m_items, and LIB_SYMBOL_UNITS::m_unit.

Referenced by SCH_SEXPR_PLUGIN_CACHE::SaveSymbol().

◆ GetUnitItems()

std::vector< LIB_ITEM * > LIB_SYMBOL::GetUnitItems ( int  aUnit,
int  aConvert 
)

Return a list of item pointers for aUnit and aConvert for this symbol.

Note
LIB_FIELD objects are not included.
Parameters
aUnitis the unit number of the item, -1 includes all units.
aConvertis the alternate body styple of the item, -1 includes all body styles.
Returns
a list of unit items.

Definition at line 1235 of file lib_symbol.cpp.

1236 {
1237  std::vector<LIB_ITEM*> unitItems;
1238 
1239  for( LIB_ITEM& item : m_drawings )
1240  {
1241  if( item.Type() == LIB_FIELD_T )
1242  continue;
1243 
1244  if( ( aConvert == -1 && item.GetUnit() == aUnit )
1245  || ( aUnit == -1 && item.GetConvert() == aConvert )
1246  || ( aUnit == item.GetUnit() && aConvert == item.GetConvert() ) )
1247  unitItems.push_back( &item );
1248  }
1249 
1250  return unitItems;
1251 }
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References LIB_FIELD_T, and m_drawings.

Referenced by GetUniqueUnits().

◆ GetUnitReference()

wxString LIB_SYMBOL::GetUnitReference ( int  aUnit)
overridevirtual

Return an identifier for aUnit for symbols with units.

Reimplemented from LIB_TREE_ITEM.

Definition at line 308 of file lib_symbol.cpp.

309 {
310  return LIB_SYMBOL::SubReference( aUnit, false );
311 }
static wxString SubReference(int aUnit, bool aAddSeparator=true)
Definition: lib_symbol.cpp:445

References SubReference().

◆ GetValueField()

LIB_FIELD & LIB_SYMBOL::GetValueField ( )

Return reference to the value field.

Definition at line 977 of file lib_symbol.cpp.

978 {
979  LIB_FIELD* field = GetFieldById( VALUE_FIELD );
980  wxASSERT( field != nullptr );
981  return *field;
982 }
Field object used in symbol libraries.
Definition: lib_field.h:59
Field Value of part, i.e. "3.3K".
LIB_FIELD * GetFieldById(int aId) const
Return pointer to the requested field.
Definition: lib_symbol.cpp:939

References GetFieldById(), and VALUE_FIELD.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), and SetName().

◆ HasConversion()

bool LIB_SYMBOL::HasConversion ( ) const

Test if symbol has more than one body conversion type (DeMorgan).

Returns
True if symbol has more than one conversion.

Definition at line 1022 of file lib_symbol.cpp.

1023 {
1024  for( const LIB_ITEM& item : m_drawings )
1025  {
1026  if( item.m_convert > LIB_ITEM::LIB_CONVERT::BASE )
1027  return true;
1028  }
1029 
1030  if( LIB_SYMBOL_SPTR parent = m_parent.lock() )
1031  {
1032  for( const LIB_ITEM& item : parent->GetDrawItems() )
1033  {
1034  if( item.m_convert > LIB_ITEM::LIB_CONVERT::BASE )
1035  return true;
1036  }
1037  }
1038 
1039  return false;
1040 }
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition: lib_symbol.h:42
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References m_drawings, and m_parent.

Referenced by EE_INSPECTION_TOOL::CheckSymbol(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), GetUniqueUnits(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SetConversion(), SYMBOL_VIEWER_FRAME::setupUIConditions(), DIALOG_LIB_EDIT_DRAW_ITEM::TransferDataToWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_LIB_SYMBOL_PROPERTIES::Validate().

◆ HasFlag()

◆ HitTest() [1/2]

virtual bool EDA_ITEM::HitTest ( const wxPoint &  aPosition,
int  aAccuracy = 0 
) const
inlinevirtualinherited

◆ HitTest() [2/2]

virtual bool EDA_ITEM::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
inlinevirtualinherited

Test if aRect intersects or is contained within the bounding box of an item.

Parameters
aRectA reference to a EDA_RECT object containing the rectangle to test.
aContainedSet to true to test for containment instead of an intersection.
aAccuracyIncrease aRect by this amount.
Returns
True if aRect contains or intersects the item bounding box.

Reimplemented in SCH_SYMBOL, PAD, ZONE, FOOTPRINT, PCB_VIA, SCH_SHEET, DS_DRAW_ITEM_BITMAP, DS_DRAW_ITEM_TEXT, PCB_ARC, PCB_SHAPE, SCH_TEXT, PCB_DIMENSION_BASE, DS_DRAW_ITEM_RECT, SCH_LINE, GERBER_DRAW_ITEM, FP_TEXT, SCH_FIELD, PCB_TRACK, DS_DRAW_ITEM_POLYPOLYGONS, LIB_PIN, LIB_ITEM, PCB_GROUP, SCH_BITMAP, PCB_TEXT, SCH_JUNCTION, SCH_NO_CONNECT, SCH_BUS_ENTRY_BASE, DS_DRAW_ITEM_BASE, PCB_TARGET, LIB_POLYLINE, LIB_BEZIER, LIB_TEXT, LIB_ARC, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 238 of file eda_item.h.

239  {
240  return false; // derived classes should override this function
241  }

◆ IsAlias()

◆ IsBrightened()

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 121 of file eda_item.h.

121 { return m_flags & IS_DRAGGING; }
#define IS_DRAGGING
Item being dragged.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const
inlineinherited

Definition at line 124 of file eda_item.h.

124 { return m_flags & ENTERED; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
#define ENTERED
indicates a group has been entered

References ENTERED, and EDA_ITEM::m_flags.

Referenced by KIGFX::PCB_PAINTER::draw().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 206 of file eda_item.h.

206 { return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:480

References EDA_ITEM::m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_FIELD::Print().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 118 of file eda_item.h.

118 { return m_flags & IS_CHANGED; }
#define IS_CHANGED
Item was edited, and modified.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

◆ IsMulti()

bool LIB_SYMBOL::IsMulti ( ) const
inline
Returns
true if the symbol has multiple units per symbol. When true, the reference has a sub reference to identify symbol.

Definition at line 501 of file lib_symbol.h.

501 { return m_unitCount > 1; }
int m_unitCount
Number of units (parts) per package.
Definition: lib_symbol.h:667

References m_unitCount.

Referenced by SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SYMBOL_EDIT_FRAME::setupUIConditions(), and SYMBOL_EDIT_FRAME::SynchronizePins().

◆ IsNew()

◆ IsNormal()

bool LIB_SYMBOL::IsNormal ( ) const

Definition at line 427 of file lib_symbol.cpp.

428 {
429  if( LIB_SYMBOL_SPTR parent = m_parent.lock() )
430  return parent->m_options == ENTRY_NORMAL;
431 
432  return m_options == ENTRY_NORMAL;
433 }
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition: lib_symbol.h:42
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663
LIBRENTRYOPTIONS m_options
Special symbol features such as POWER or NORMAL.)
Definition: lib_symbol.h:678

References ENTRY_NORMAL, m_options, and m_parent.

◆ IsPower()

bool LIB_SYMBOL::IsPower ( ) const

Definition at line 409 of file lib_symbol.cpp.

410 {
411  if( LIB_SYMBOL_SPTR parent = m_parent.lock() )
412  return parent->m_options == ENTRY_POWER;
413 
414  return m_options == ENTRY_POWER;
415 }
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition: lib_symbol.h:42
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663
LIBRENTRYOPTIONS m_options
Special symbol features such as POWER or NORMAL.)
Definition: lib_symbol.h:678

References ENTRY_POWER, m_options, and m_parent.

Referenced by SCH_SHEET_LIST::AnnotatePowerSymbols(), EE_INSPECTION_TOOL::CheckSymbol(), SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), LIB_PIN::IsPowerConnection(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

Override this method in any derived object that supports test find and replace.

Returns
True if the item has replaceable text that can be modified using the find and replace dialog.

Reimplemented in SCH_SYMBOL, SCH_SHEET, SCH_LABEL, SCH_TEXT, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 403 of file eda_item.h.

403 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 125 of file eda_item.h.

125 { return m_flags & IS_RESIZING; }
#define IS_RESIZING
Item being resized.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsRoot()

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 123 of file eda_item.h.

123 { return m_flags & SELECTED; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
#define SELECTED

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), KIGFX::SCH_PAINTER::getTextThickness(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), RENDER_3D_LEGACY::renderFootprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), and GERBVIEW_SELECTION_TOOL::unselect().

◆ IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[]) const
inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters
aScanTypesList of item types
Returns
true if the item type is contained in the list aScanTypes

Reimplemented in PCB_VIA, SCH_LABEL, PCB_DIMENSION_BASE, PAD, SCH_FIELD, FP_TEXT, SCH_LINE, PCB_SHAPE, FP_SHAPE, and PCB_TEXT.

Definition at line 183 of file eda_item.h.

184  {
185  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
186  return true;
187 
188  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
189  {
190  if( m_structType == *p )
191  return true;
192  }
193 
194  return false;
195  }
search types array terminator (End Of Types)
Definition: typeinfo.h:81
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
KICAD_T m_structType
Run time identification, keep private so it can never be changed after a ctor sets it.
Definition: eda_item.h:488

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by ROUTER_TOOL::CanInlineDrag(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), PCB_SHAPE::IsType(), SCH_LINE::IsType(), FP_TEXT::IsType(), SCH_FIELD::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), SCH_BASE_FRAME::UpdateItem(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 122 of file eda_item.h.

122 { return m_flags & IS_WIRE_IMAGE; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >
static SEARCH_RESULT EDA_ITEM::IterateForward ( std::deque< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
inlinestaticinherited

This changes first parameter to avoid the DList and use the main queue instead.

Definition at line 295 of file eda_item.h.

299  {
300  for( auto it : aList )
301  {
302  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
304  return SEARCH_RESULT::QUIT;
305  }
306 
308  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:93

References CONTINUE, QUIT, and EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >
static SEARCH_RESULT EDA_ITEM::IterateForward ( std::vector< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
inlinestaticinherited

Change first parameter to avoid the DList and use std::vector instead.

Definition at line 314 of file eda_item.h.

316  {
317  for( auto it : aList )
318  {
319  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
321  return SEARCH_RESULT::QUIT;
322  }
323 
325  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:93

References CONTINUE, QUIT, and EDA_ITEM::Visit().

◆ LocateDrawItem() [1/2]

LIB_ITEM * LIB_SYMBOL::LocateDrawItem ( int  aUnit,
int  aConvert,
KICAD_T  aType,
const wxPoint &  aPoint 
)

Locate a draw object.

Parameters
aUnit- Unit number of draw item.
aConvert- Body style of draw item.
aType- Draw object type, set to 0 to search for any type.
aPoint- Coordinate for hit testing.
Returns
The draw object if found. Otherwise NULL.

Definition at line 1057 of file lib_symbol.cpp.

1059 {
1060  for( LIB_ITEM& item : m_drawings )
1061  {
1062  if( ( aUnit && item.m_unit && aUnit != item.m_unit )
1063  || ( aConvert && item.m_convert && aConvert != item.m_convert )
1064  || ( item.Type() != aType && aType != TYPE_NOT_INIT ) )
1065  {
1066  continue;
1067  }
1068 
1069  if( item.HitTest( aPoint ) )
1070  return &item;
1071  }
1072 
1073  return nullptr;
1074 }
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References m_drawings, and TYPE_NOT_INIT.

Referenced by LocateDrawItem().

◆ LocateDrawItem() [2/2]

LIB_ITEM * LIB_SYMBOL::LocateDrawItem ( int  aUnit,
int  aConvert,
KICAD_T  aType,
const wxPoint &  aPoint,
const TRANSFORM aTransform 
)

Locate a draw object (overlaid)

Parameters
aUnit- Unit number of draw item.
aConvert- Body style of draw item.
aType- Draw object type, set to 0 to search for any type.
aPoint- Coordinate for hit testing.
aTransform= the transform matrix
Returns
The draw object if found. Otherwise NULL.

Definition at line 1077 of file lib_symbol.cpp.

1079 {
1080  /* we use LocateDrawItem( int aUnit, int convert, KICAD_T type, const
1081  * wxPoint& pt ) to search items.
1082  * because this function uses DefaultTransform as orient/mirror matrix
1083  * we temporary copy aTransform in DefaultTransform
1084  */
1085  LIB_ITEM* item;
1086  TRANSFORM transform = DefaultTransform;
1087  DefaultTransform = aTransform;
1088 
1089  item = LocateDrawItem( aUnit, aConvert, aType, aPoint );
1090 
1091  // Restore matrix
1092  DefaultTransform = transform;
1093 
1094  return item;
1095 }
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
LIB_ITEM * LocateDrawItem(int aUnit, int aConvert, KICAD_T aType, const wxPoint &aPoint)
Locate a draw object.
TRANSFORM DefaultTransform
Definition: eeschema.cpp:56

References DefaultTransform, and LocateDrawItem().

◆ LockUnits()

void LIB_SYMBOL::LockUnits ( bool  aLockUnits)
inline

Set interchangeable the property for symbol units.

Parameters
aLockUnitswhen true then units are set as not interchangeable.

Definition at line 235 of file lib_symbol.h.

235 { m_unitsLocked = aLockUnits; }
bool m_unitsLocked
True if symbol has multiple units and changing one unit does not automatically change another unit.
Definition: lib_symbol.h:668

References m_unitsLocked.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ Matches() [1/2]

virtual bool EDA_ITEM::Matches ( const wxFindReplaceData &  aSearchData,
void *  aAuxData 
) const
inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

The base class returns false since many of the objects derived from EDA_ITEM do not have any text to search.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_SYMBOL, SCH_SHEET, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, ZONE, SCH_PIN, SCH_MARKER, PCB_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 365 of file eda_item.h.

366  {
367  return false;
368  }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), PCB_TEXT::Matches(), FP_TEXT::Matches(), PCB_MARKER::Matches(), SCH_MARKER::Matches(), SCH_PIN::Matches(), ZONE::Matches(), SCH_SHEET_PIN::Matches(), SCH_FIELD::Matches(), SCH_TEXT::Matches(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), and SCH_EDITOR_CONTROL::UpdateFind().

◆ Matches() [2/2]

bool EDA_ITEM::Matches ( const wxString &  aText,
const wxFindReplaceData &  aSearchData 
) const
protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters
aTextA reference to a wxString object containing the string to test.
aSearchDataThe criteria to search against.
Returns
True if aText matches the search criteria in aSearchData.

Definition at line 118 of file eda_item.cpp.

119 {
120  wxString text = aText;
121  wxString searchText = aSearchData.GetFindString();
122 
123  // Don't match if searching for replaceable item and the item doesn't support text replace.
124  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
125  return false;
126 
127  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
128  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
129 
130  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
131  {
132  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
133  return text.Matches( searchText );
134 
135  return text.MakeUpper().Matches( searchText.MakeUpper() );
136  }
137 
138  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
139  return aText.Find( searchText ) != wxNOT_FOUND;
140 
141  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
142 }
virtual bool IsReplaceable() const
Override this method in any derived object that supports test find and replace.
Definition: eda_item.h:403

References FR_MATCH_WILDCARD, FR_SEARCH_REPLACE, EDA_ITEM::IsReplaceable(), and text.

◆ operator!=()

bool LIB_SYMBOL::operator!= ( const LIB_SYMBOL aSymbol) const
inline

Definition at line 608 of file lib_symbol.h.

608 { return Compare( aSymbol ) != 0; }
int Compare(const LIB_SYMBOL &aRhs) const
Comparison test that can be used for operators.
Definition: lib_symbol.cpp:213

References Compare().

◆ operator<()

bool EDA_ITEM::operator< ( const EDA_ITEM aItem) const
inherited

Test if another item is less than this object.

Parameters
aItem- Item to compare against.
Returns
- True if aItem is less than the item.

Definition at line 171 of file eda_item.cpp.

172 {
173  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
174  GetClass() ) );
175 
176  return false;
177 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
virtual wxString GetClass() const =0
Return the class name.

References Format(), and EDA_ITEM::GetClass().

◆ operator=()

const LIB_SYMBOL & LIB_SYMBOL::operator= ( const LIB_SYMBOL aSymbol)

Definition at line 167 of file lib_symbol.cpp.

168 {
169  if( &aSymbol == this )
170  return aSymbol;
171 
172  LIB_ITEM* newItem;
173 
174  m_library = aSymbol.m_library;
175  m_name = aSymbol.m_name;
176  m_fpFilters = wxArrayString( aSymbol.m_fpFilters );
177  m_unitCount = aSymbol.m_unitCount;
178  m_unitsLocked = aSymbol.m_unitsLocked;
181  m_showPinNames = aSymbol.m_showPinNames;
182  m_includeInBom = aSymbol.m_includeInBom;
184  m_lastModDate = aSymbol.m_lastModDate;
185  m_options = aSymbol.m_options;
186  m_libId = aSymbol.m_libId;
187  m_description = aSymbol.m_description;
188  m_keyWords = aSymbol.m_keyWords;
189 
190  m_drawings.clear();
191 
192  for( const LIB_ITEM& oldItem : aSymbol.m_drawings )
193  {
194  if( ( oldItem.GetFlags() & ( IS_NEW | STRUCT_DELETED ) ) != 0 )
195  continue;
196 
197  newItem = (LIB_ITEM*) oldItem.Clone();
198  newItem->SetParent( this );
199  m_drawings.push_back( newItem );
200  }
201 
202  m_drawings.sort();
203 
204  LIB_SYMBOL_SPTR parent = aSymbol.m_parent.lock();
205 
206  if( parent )
207  SetParent( parent.get() );
208 
209  return *this;
210 }
bool m_showPinNumbers
Definition: lib_symbol.h:674
bool m_showPinNames
Definition: lib_symbol.h:673
#define IS_NEW
New item, just created.
void clear(int aType=UNDEFINED_TYPE)
Definition: multivector.h:212
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition: lib_symbol.h:42
void sort()
Definition: multivector.h:247
wxString m_description
Definition: lib_symbol.h:684
wxString m_name
Definition: lib_symbol.h:683
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:116
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:83
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
timestamp_t m_lastModDate
Definition: lib_symbol.h:665
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663
bool m_unitsLocked
True if symbol has multiple units and changing one unit does not automatically change another unit.
Definition: lib_symbol.h:668
void push_back(T *aItem)
Definition: multivector.h:174
bool m_includeOnBoard
Definition: lib_symbol.h:677
#define STRUCT_DELETED
flag indication structures to be erased
void SetParent(LIB_SYMBOL *aParent=nullptr)
Definition: lib_symbol.cpp:323
EDA_ITEM_FLAGS GetFlags() const
Definition: eda_item.h:155
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
bool m_includeInBom
Definition: lib_symbol.h:676
int m_pinNameOffset
The offset in mils to draw the pin name.
Definition: lib_symbol.h:671
wxArrayString m_fpFilters
List of suitable footprint names for the symbol (wild card names accepted).
Definition: lib_symbol.h:686
LIB_ID m_libId
Definition: lib_symbol.h:664
wxString m_keyWords
Search keywords.
Definition: lib_symbol.h:685
LIBRENTRYOPTIONS m_options
Special symbol features such as POWER or NORMAL.)
Definition: lib_symbol.h:678
int m_unitCount
Number of units (parts) per package.
Definition: lib_symbol.h:667
SYMBOL_LIB * m_library
Definition: lib_symbol.h:682

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::clear(), EDA_ITEM::Clone(), EDA_ITEM::GetFlags(), IS_NEW, m_description, m_drawings, m_fpFilters, m_includeInBom, m_includeOnBoard, m_keyWords, m_lastModDate, m_libId, m_library, m_name, m_options, m_parent, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), EDA_ITEM::SetParent(), SetParent(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::sort(), and STRUCT_DELETED.

◆ operator==() [1/2]

bool LIB_SYMBOL::operator== ( const LIB_SYMBOL aSymbol) const
inline

Definition at line 606 of file lib_symbol.h.

606 { return this == aSymbol; }

◆ operator==() [2/2]

bool LIB_SYMBOL::operator== ( const LIB_SYMBOL aSymbol) const
inline

Definition at line 607 of file lib_symbol.h.

607 { return Compare( aSymbol ) == 0; }
int Compare(const LIB_SYMBOL &aRhs) const
Comparison test that can be used for operators.
Definition: lib_symbol.cpp:213

References Compare().

◆ PinsConflictWith()

bool LIB_SYMBOL::PinsConflictWith ( const LIB_SYMBOL aOtherSymbol,
bool  aTestNums,
bool  aTestNames,
bool  aTestType,
bool  aTestOrientation,
bool  aTestLength 
) const

Return true if this symbol's pins do not match another symbol's pins.

This is used to detect whether the project cache is out of sync with the system libs.

Parameters
aOtherSymbol- The other library symbol to test
aTestNums- Whether two pins at the same point must have the same number.
aTestNames- Whether two pins at the same point must have the same name.
aTestType- Whether two pins at the same point must have the same electrical type.
aTestOrientation- Whether two pins at the same point must have the same orientation.
aTestLength- Whether two pins at the same point must have the same length.

Definition at line 738 of file lib_symbol.cpp.

740 {
741  LIB_PINS thisPinList;
742  GetPins( thisPinList, /* aUnit */ 0, /* aConvert */ 0 );
743 
744  for( const LIB_PIN* eachThisPin : thisPinList )
745  {
746  wxASSERT( eachThisPin );
747  LIB_PINS otherPinList;
748  aOtherPart.GetPins( otherPinList, /* aUnit */ 0, /* aConvert */ 0 );
749  bool foundMatch = false;
750 
751  for( const LIB_PIN* eachOtherPin : otherPinList )
752  {
753  wxASSERT( eachOtherPin );
754 
755  // Same unit?
756  if( eachThisPin->GetUnit() != eachOtherPin->GetUnit() )
757  continue;
758 
759  // Same body stype?
760  if( eachThisPin->GetConvert() != eachOtherPin->GetConvert() )
761  continue;
762 
763  // Same position?
764  if( eachThisPin->GetPosition() != eachOtherPin->GetPosition() )
765  continue;
766 
767  // Same number?
768  if( aTestNums && ( eachThisPin->GetNumber() != eachOtherPin->GetNumber() ) )
769  continue;
770 
771  // Same name?
772  if( aTestNames && ( eachThisPin->GetName() != eachOtherPin->GetName() ) )
773  continue;
774 
775  // Same electrical type?
776  if( aTestType && ( eachThisPin->GetType() != eachOtherPin->GetType() ) )
777  continue;
778 
779  // Same orientation?
780  if( aTestOrientation
781  && ( eachThisPin->GetOrientation() != eachOtherPin->GetOrientation() ) )
782  continue;
783 
784  // Same length?
785  if( aTestLength && ( eachThisPin->GetLength() != eachOtherPin->GetLength() ) )
786  continue;
787 
788  foundMatch = true;
789  break; // Match found so search is complete.
790  }
791 
792  if( !foundMatch )
793  {
794  // This means there was not an identical (according to the arguments)
795  // pin at the same position in the other symbol.
796  return true;
797  }
798  }
799 
800  // The loop never gave up, so no conflicts were found.
801  return false;
802 }
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0) const
Return a list of pin object pointers from the draw item list.
Definition: lib_symbol.cpp:693
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:55

References GetPins().

Referenced by RESCUE_CACHE_CANDIDATE::FindRescues(), and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues().

◆ Plot()

void LIB_SYMBOL::Plot ( PLOTTER aPlotter,
int  aUnit,
int  aConvert,
const wxPoint &  aOffset,
const TRANSFORM aTransform 
) const

Plot lib symbol to plotter.

Lib Fields not are plotted here, because this plot function is used to plot schematic items, which have they own fields

Parameters
aPlotter- Plotter object to plot to.
aUnit- Symbol symbol to plot.
aConvert- Symbol alternate body style to plot.
aOffset- Distance to shift the plot coordinates.
aTransform- Symbol plot transform matrix.

Definition at line 544 of file lib_symbol.cpp.

546 {
547  wxASSERT( aPlotter != nullptr );
548 
549  aPlotter->SetColor( aPlotter->RenderSettings()->GetLayerColor( LAYER_DEVICE ) );
550  bool fill = aPlotter->GetColorMode();
551 
552  // draw background for filled items using background option
553  // Solid lines will be drawn after the background
554  for( const LIB_ITEM& item : m_drawings )
555  {
556  // Lib Fields are not plotted here, because this plot function
557  // is used to plot schematic items, which have they own fields
558  if( item.Type() == LIB_FIELD_T )
559  continue;
560 
561  if( aUnit && item.m_unit && ( item.m_unit != aUnit ) )
562  continue;
563 
564  if( aConvert && item.m_convert && ( item.m_convert != aConvert ) )
565  continue;
566 
567  if( item.m_fill == FILL_TYPE::FILLED_WITH_BG_BODYCOLOR )
568  item.Plot( aPlotter, aOffset, fill, aTransform );
569  }
570 
571  // Not filled items and filled shapes are now plotted
572  // Items that have BG fills only get re-stroked to ensure the edges are in the foreground
573  for( const LIB_ITEM& item : m_drawings )
574  {
575  if( item.Type() == LIB_FIELD_T )
576  continue;
577 
578  if( aUnit && item.m_unit && ( item.m_unit != aUnit ) )
579  continue;
580 
581  if( aConvert && item.m_convert && ( item.m_convert != aConvert ) )
582  continue;
583 
584  item.Plot( aPlotter, aOffset,
585  fill && ( item.m_fill != FILL_TYPE::FILLED_WITH_BG_BODYCOLOR ), aTransform );
586  }
587 }
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
virtual void SetColor(const COLOR4D &color)=0
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:156
bool GetColorMode() const
Definition: plotter.h:153

References FILLED_WITH_BG_BODYCOLOR, PLOTTER::GetColorMode(), KIGFX::RENDER_SETTINGS::GetLayerColor(), LAYER_DEVICE, LIB_FIELD_T, m_drawings, PLOTTER::RenderSettings(), and PLOTTER::SetColor().

Referenced by SYMBOL_EDIT_FRAME::SVGPlotSymbol().

◆ PlotLibFields()

void LIB_SYMBOL::PlotLibFields ( PLOTTER aPlotter,
int  aUnit,
int  aConvert,
const wxPoint &  aOffset,
const TRANSFORM aTransform 
)

Plot Lib Fields only of the symbol to plotter.

is used to plot the full lib symbol, outside the schematic

Parameters
aPlotter- Plotter object to plot to.
aUnit- Symbol to plot.
aConvert- Symbol alternate body style to plot.
aOffset- Distance to shift the plot coordinates.
aTransform- Symbol plot transform matrix.

Definition at line 590 of file lib_symbol.cpp.

592 {
593  wxASSERT( aPlotter != nullptr );
594 
595  aPlotter->SetColor( aPlotter->RenderSettings()->GetLayerColor( LAYER_FIELDS ) );
596  bool fill = aPlotter->GetColorMode();
597 
598  for( LIB_ITEM& item : m_drawings )
599  {
600  if( item.Type() != LIB_FIELD_T )
601  continue;
602 
603  if( aUnit && item.m_unit && ( item.m_unit != aUnit ) )
604  continue;
605 
606  if( aConvert && item.m_convert && ( item.m_convert != aConvert ) )
607  continue;
608 
609  LIB_FIELD& field = (LIB_FIELD&) item;
610 
611  // The reference is a special case: we should change the basic text
612  // to add '?' and the part id
613  wxString tmp = field.GetShownText();
614 
615  if( field.GetId() == REFERENCE_FIELD )
616  {
617  wxString text = field.GetFullText( aUnit );
618  field.SetText( text );
619  }
620 
621  item.Plot( aPlotter, aOffset, fill, aTransform );
622  field.SetText( tmp );
623  }
624 }
Field Reference of part, i.e. "IC21".
Field object used in symbol libraries.
Definition: lib_field.h:59
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
int GetId() const
Definition: lib_field.h:115
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:114
virtual void SetColor(const COLOR4D &color)=0
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:156
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:295
virtual wxString GetShownText(int aDepth=0) const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:141
bool GetColorMode() const
Definition: plotter.h:153

References PLOTTER::GetColorMode(), LIB_FIELD::GetFullText(), LIB_FIELD::GetId(), KIGFX::RENDER_SETTINGS::GetLayerColor(), EDA_TEXT::GetShownText(), LAYER_FIELDS, LIB_FIELD_T, m_drawings, REFERENCE_FIELD, PLOTTER::RenderSettings(), PLOTTER::SetColor(), EDA_TEXT::SetText(), and text.

Referenced by SYMBOL_EDIT_FRAME::SVGPlotSymbol().

◆ Print()

void LIB_SYMBOL::Print ( const RENDER_SETTINGS aSettings,
const wxPoint &  aOffset,
int  aMulti,
int  aConvert,
const LIB_SYMBOL_OPTIONS aOpts 
)

Print symbol.

Parameters
aOffset- Position of symbol.
aMulti- unit if multiple units per symbol.
aConvert- Symbol conversion (DeMorgan) if available.
aOpts- Drawing options

Definition at line 477 of file lib_symbol.cpp.

479 {
480  /* draw background for filled items using background option
481  * Solid lines will be drawn after the background
482  * Note also, background is not drawn when printing in black and white
483  */
484  if( !GetGRForceBlackPenState() )
485  {
486  for( LIB_ITEM& drawItem : m_drawings )
487  {
488  if( drawItem.m_fill != FILL_TYPE::FILLED_WITH_BG_BODYCOLOR )
489  continue;
490 
491  // Do not draw items not attached to the current part
492  if( aMulti && drawItem.m_unit && ( drawItem.m_unit != aMulti ) )
493  continue;
494 
495  if( aConvert && drawItem.m_convert && ( drawItem.m_convert != aConvert ) )
496  continue;
497 
498  if( drawItem.Type() == LIB_FIELD_T )
499  continue;
500 
501  // Now, draw only the background for items with
502  // m_fill == FILLED_WITH_BG_BODYCOLOR:
503  drawItem.Print( aSettings, aOffset, (void*) false, aOpts.transform );
504  }
505  }
506 
507  for( LIB_ITEM& drawItem : m_drawings )
508  {
509  // Do not draw items not attached to the current part
510  if( aMulti && drawItem.m_unit && ( drawItem.m_unit != aMulti ) )
511  continue;
512 
513  if( aConvert && drawItem.m_convert && ( drawItem.m_convert != aConvert ) )
514  continue;
515 
516  if( drawItem.Type() == LIB_FIELD_T )
517  {
518  LIB_FIELD& field = static_cast<LIB_FIELD&>( drawItem );
519 
520  if( field.IsVisible() && !aOpts.draw_visible_fields )
521  continue;
522 
523  if( !field.IsVisible() && !aOpts.draw_hidden_fields )
524  continue;
525  }
526 
527  if( drawItem.Type() == LIB_PIN_T )
528  {
529  drawItem.Print( aSettings, aOffset, (void*) &aOpts, aOpts.transform );
530  }
531  else if( drawItem.Type() == LIB_FIELD_T )
532  {
533  drawItem.Print( aSettings, aOffset, (void*) nullptr, aOpts.transform );
534  }
535  else
536  {
537  bool forceNoFill = drawItem.m_fill == FILL_TYPE::FILLED_WITH_BG_BODYCOLOR;
538  drawItem.Print( aSettings, aOffset, (void*) forceNoFill, aOpts.transform );
539  }
540  }
541 }
Field object used in symbol libraries.
Definition: lib_field.h:59
bool draw_visible_fields
Definition: lib_symbol.h:65
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
TRANSFORM transform
Definition: lib_symbol.h:64
virtual bool IsVisible() const
Definition: eda_text.h:186
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
bool GetGRForceBlackPenState(void)
Definition: gr_basic.cpp:196

References LIB_SYMBOL_OPTIONS::draw_hidden_fields, LIB_SYMBOL_OPTIONS::draw_visible_fields, FILLED_WITH_BG_BODYCOLOR, GetGRForceBlackPenState(), EDA_TEXT::IsVisible(), LIB_FIELD_T, LIB_PIN_T, m_drawings, and LIB_SYMBOL_OPTIONS::transform.

Referenced by SCH_SYMBOL::Print(), and SYMBOL_EDIT_FRAME::PrintPage().

◆ RemoveDrawItem()

void LIB_SYMBOL::RemoveDrawItem ( LIB_ITEM aItem)

Remove draw aItem from list.

Parameters
aItem- Draw item to remove from list.

Definition at line 627 of file lib_symbol.cpp.

628 {
629  wxASSERT( aItem != nullptr );
630 
631  // none of the MANDATORY_FIELDS may be removed in RAM, but they may be
632  // omitted when saving to disk.
633  if( aItem->Type() == LIB_FIELD_T )
634  {
635  if( static_cast<LIB_FIELD*>( aItem )->IsMandatory() )
636  return;
637  }
638 
639  LIB_ITEMS& items = m_drawings[ aItem->Type() ];
640 
641  for( LIB_ITEMS::iterator i = items.begin(); i != items.end(); i++ )
642  {
643  if( &*i == aItem )
644  {
645  items.erase( i );
646  SetModified();
647  break;
648  }
649  }
650 }
void SetModified()
Definition: eda_item.cpp:65
LIB_ITEMS_CONTAINER::ITEM_PTR_VECTOR LIB_ITEMS
Definition: lib_symbol.h:48
ITERATOR erase(const ITERATOR &aIterator)
Definition: multivector.h:179
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::erase(), LIB_FIELD_T, m_drawings, EDA_ITEM::SetModified(), and EDA_ITEM::Type().

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), and DIALOG_LIB_EDIT_PIN_TABLE::TransferDataFromWindow().

◆ RemoveDuplicateDrawItems()

void LIB_SYMBOL::RemoveDuplicateDrawItems ( )

Remove duplicate draw items from list.

Definition at line 1016 of file lib_symbol.cpp.

1017 {
1018  m_drawings.unique();
1019 }
void unique()
Remove duplicate elements in list.
Definition: multivector.h:256
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References m_drawings, and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::unique().

◆ Replace() [1/2]

bool EDA_ITEM::Replace ( const wxFindReplaceData &  aSearchData,
wxString &  aText 
)
staticinherited

Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aTextA reference to a wxString object containing the text to be replaced.
Returns
True if aText was modified, otherwise false.

Definition at line 145 of file eda_item.cpp.

146 {
147  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
148 
149  int result = searchString.Find( ( aSearchData.GetFlags() & wxFR_MATCHCASE ) ?
150  aSearchData.GetFindString() :
151  aSearchData.GetFindString().Upper() );
152 
153  if( result == wxNOT_FOUND )
154  return false;
155 
156  wxString prefix = aText.Left( result );
157  wxString suffix;
158 
159  if( aSearchData.GetFindString().length() + result < aText.length() )
160  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
161 
162  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
163  aText, prefix, aSearchData.GetReplaceString(), suffix );
164 
165  aText = prefix + aSearchData.GetReplaceString() + suffix;
166 
167  return true;
168 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.

References traceFindReplace.

Referenced by SCH_FIELD::Replace(), EDA_TEXT::Replace(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

◆ Replace() [2/2]

virtual bool EDA_ITEM::Replace ( const wxFindReplaceData &  aSearchData,
void *  aAuxData = nullptr 
)
inlinevirtualinherited

Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item text was modified, otherwise false.

Reimplemented in SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 392 of file eda_item.h.

393  {
394  return false;
395  }

◆ Set() [1/3]

bool INSPECTABLE::Set ( PROPERTY_BASE aProperty,
wxAny &  aValue 
)
inlineinherited

Definition at line 42 of file inspectable.h.

43  {
45  TYPE_ID thisType = TYPE_HASH( *this );
46  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
47 
48  if( object )
49  aProperty->setter( object, aValue );
50 
51  return object != nullptr;
52  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
virtual void setter(void *aObject, wxAny &aValue)=0
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::setter(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by isCoupledDiffPair().

◆ Set() [2/3]

template<typename T >
bool INSPECTABLE::Set ( PROPERTY_BASE aProperty,
aValue 
)
inlineinherited

Definition at line 55 of file inspectable.h.

56  {
58  TYPE_ID thisType = TYPE_HASH( *this );
59  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
60 
61  if( object )
62  aProperty->set<T>( object, aValue );
63 
64  return object != nullptr;
65  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
void set(void *aObject, T aValue)
Definition: property.h:261
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [3/3]

template<typename T >
bool INSPECTABLE::Set ( const wxString &  aProperty,
aValue 
)
inlineinherited

Definition at line 68 of file inspectable.h.

69  {
71  TYPE_ID thisType = TYPE_HASH( *this );
72  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
73  void* object = nullptr;
74 
75  if( prop )
76  {
77  object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
78 
79  if( object )
80  prop->set<T>( object, aValue );
81  }
82 
83  return object != nullptr;
84  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
void set(void *aObject, T aValue)
Definition: property.h:261
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ SetBrightened()

◆ SetConversion()

void LIB_SYMBOL::SetConversion ( bool  aSetConvert,
bool  aDuplicatePins = true 
)

Set or clear the alternate body style (DeMorgan) for the symbol.

If the symbol already has an alternate body style set and a asConvert if false, all of the existing draw items for the alternate body style are remove. If the alternate body style is not set and asConvert is true, than the base draw items are duplicated and added to the symbol.

Parameters
aSetConvert- Set or clear the symbol alternate body style.
aDuplicatePins- Duplicate all pins from original body style if true.

Definition at line 1172 of file lib_symbol.cpp.

1173 {
1174  if( aSetConvert == HasConversion() )
1175  return;
1176 
1177  // Duplicate items to create the converted shape
1178  if( aSetConvert )
1179  {
1180  if( aDuplicatePins )
1181  {
1182  std::vector< LIB_ITEM* > tmp; // Temporarily store the duplicated pins here.
1183 
1184  for( LIB_ITEM& item : m_drawings )
1185  {
1186  // Only pins are duplicated.
1187  if( item.Type() != LIB_PIN_T )
1188  continue;
1189 
1190  if( item.m_convert == 1 )
1191  {
1192  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1193  newItem->m_convert = 2;
1194  tmp.push_back( newItem );
1195  }
1196  }
1197 
1198  // Transfer the new pins to the LIB_SYMBOL.
1199  for( unsigned i = 0; i < tmp.size(); i++ )
1200  m_drawings.push_back( tmp[i] );
1201  }
1202  }
1203  else
1204  {
1205  // Delete converted shape items because the converted shape does
1206  // not exist
1208 
1209  while( i != m_drawings.end() )
1210  {
1211  if( i->m_convert > 1 )
1212  i = m_drawings.erase( i );
1213  else
1214  ++i;
1215  }
1216  }
1217 
1218  m_drawings.sort();
1219 }
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:188
void sort()
Definition: multivector.h:247
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:83
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:194
bool HasConversion() const
Test if symbol has more than one body conversion type (DeMorgan).
void push_back(T *aItem)
Definition: multivector.h:174
int m_convert
Shape identification for alternate body styles.
Definition: lib_item.h:320
ITERATOR erase(const ITERATOR &aIterator)
Definition: multivector.h:179
ITERATOR_BASE< LIB_ITEM, MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::iterator > ITERATOR
The const iterator.
Definition: multivector.h:164
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), EDA_ITEM::Clone(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::erase(), HasConversion(), LIB_PIN_T, LIB_ITEM::m_convert, m_drawings, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::sort().

Referenced by SYMBOL_EDIT_FRAME::CreateNewSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetDescription()

◆ SetFields()

void LIB_SYMBOL::SetFields ( const std::vector< LIB_FIELD > &  aFieldsList)

Overwrite all the existing fields in this symbol with fields supplied in aFieldsList.

The only known caller of this function is the library symbol field editor, and it establishes needed behavior.

Parameters
aFieldsListis a set of fields to import, removing all previous fields.

Definition at line 888 of file lib_symbol.cpp.

889 {
890  deleteAllFields();
891 
892  for( unsigned i=0; i<aFields.size(); ++i )
893  {
894  // drawings is a ptr_vector, new and copy an object on the heap.
895  LIB_FIELD* field = new LIB_FIELD( aFields[i] );
896 
897  field->SetParent( this );
898  m_drawings.push_back( field );
899  }
900 
901  m_drawings.sort();
902 }
Field object used in symbol libraries.
Definition: lib_field.h:59
void sort()
Definition: multivector.h:247
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:116
void push_back(T *aItem)
Definition: multivector.h:174
void deleteAllFields()
Definition: lib_symbol.cpp:876
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References deleteAllFields(), m_drawings, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), EDA_ITEM::SetParent(), and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::sort().

Referenced by DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS  aMask)
inlineinherited

Definition at line 153 of file eda_item.h.

153 { m_flags |= aMask; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

References EDA_ITEM::m_flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SCH_MOVE_TOOL::AlignElements(), PCB_CONTROL::AppendBoard(), FOOTPRINT::BuildPolyCourtyards(), SCH_EDIT_TOOL::ChangeTextType(), GRAPHICS_CLEANER::cleanupSegments(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), PCB_SELECTION_TOOL::EnterGroup(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_MOVE_TOOL::getConnectedDragItems(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EE_SELECTION_TOOL::Main(), TRACKS_CLEANER::mergeCollinearSegments(), SYMBOL_EDITOR_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), EE_SELECTION_TOOL::narrowSelection(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseJunction(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParseNoERC(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_ALTIUM_PLUGIN::ParseWire(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible.

Parameters
aEnableTrue forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 204 of file eda_item.h.

204 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: eda_item.h:480

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetFPFilters()

void LIB_SYMBOL::SetFPFilters ( const wxArrayString &  aFilters)
inline

Definition at line 181 of file lib_symbol.h.

181 { m_fpFilters = aFilters; }
wxArrayString m_fpFilters
List of suitable footprint names for the symbol (wild card names accepted).
Definition: lib_symbol.h:686

References m_fpFilters.

Referenced by BOOST_AUTO_TEST_CASE(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetIncludeInBom()

void LIB_SYMBOL::SetIncludeInBom ( bool  aIncludeInBom)
inline

Set or clear the include in schematic bill of materials flag.

Parameters
aIncludeInBomtrue to include symbol in schematic bill of material

Definition at line 584 of file lib_symbol.h.

584 { m_includeInBom = aIncludeInBom; }
bool m_includeInBom
Definition: lib_symbol.h:676

References m_includeInBom.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetIncludeOnBoard()

void LIB_SYMBOL::SetIncludeOnBoard ( bool  aIncludeOnBoard)
inline

Set or clear include in board netlist flag.

Parameters
aIncludeOnBoardtrue to include symbol in the board netlist

Definition at line 592 of file lib_symbol.h.

592 { m_includeOnBoard = aIncludeOnBoard; }
bool m_includeOnBoard
Definition: lib_symbol.h:677

References m_includeOnBoard.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetKeyWords()

void LIB_SYMBOL::SetKeyWords ( const wxString &  aKeyWords)
inline

◆ SetLib()

void LIB_SYMBOL::SetLib ( SYMBOL_LIB aLibrary)
inline

Definition at line 177 of file lib_symbol.h.

177 { m_library = aLibrary; }
SYMBOL_LIB * m_library
Definition: lib_symbol.h:682

References m_library.

Referenced by LEGACY_RESCUER::AddSymbol(), SYMBOL_LIB::FindSymbol(), LIB_SYMBOL(), and SYMBOL_LIB::LoadLibrary().

◆ SetLibId()

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

Definition at line 65 of file eda_item.cpp.

66 {
68 
69  // If this a child object, then the parent modification state also needs to be set.
70  if( m_parent )
72 }
#define IS_CHANGED
Item was edited, and modified.
void SetModified()
Definition: eda_item.cpp:65
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:479
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:153

References IS_CHANGED, EDA_ITEM::m_parent, EDA_ITEM::SetFlags(), and EDA_ITEM::SetModified().

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_SYMBOL::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), RemoveDrawItem(), SCH_SYMBOL::SetConvert(), SCH_SYMBOL::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_SYMBOL::SetTransform(), and SCH_SYMBOL::SetUnit().

◆ SetName()

void LIB_SYMBOL::SetName ( const wxString &  aName)
virtual

Definition at line 314 of file lib_symbol.cpp.

315 {
316  m_name = aName;
317  m_libId.SetLibItemName( aName );
318 
319  GetValueField().SetText( aName );
320 }
LIB_FIELD & GetValueField()
Return reference to the value field.
Definition: lib_symbol.cpp:977
wxString m_name
Definition: lib_symbol.h:683
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:114
int SetLibItemName(const UTF8 &aLibItemName)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:108
LIB_ID m_libId
Definition: lib_symbol.h:664

References GetValueField(), m_libId, m_name, LIB_ID::SetLibItemName(), and EDA_TEXT::SetText().

Referenced by SCH_SCREEN::Append(), BOOST_AUTO_TEST_CASE(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SYMBOL_EDIT_FRAME::ensureUniqueName(), LIB_SYMBOL(), SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SYMBOL_EDIT_FRAME::saveSymbolAs(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), SYMBOL_EDIT_FRAME::UpdateAfterSymbolProperties(), and DIALOG_LIB_EDIT_ONE_FIELD::UpdateField().

◆ SetNormal()

void LIB_SYMBOL::SetNormal ( )

Definition at line 436 of file lib_symbol.cpp.

437 {
438  if( LIB_SYMBOL_SPTR parent = m_parent.lock() )
439  parent->m_options = ENTRY_NORMAL;
440 
442 }
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition: lib_symbol.h:42
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663
LIBRENTRYOPTIONS m_options
Special symbol features such as POWER or NORMAL.)
Definition: lib_symbol.h:678

References ENTRY_NORMAL, m_options, and m_parent.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetOffset()

void LIB_SYMBOL::SetOffset ( const wxPoint &  aOffset)

Move the symbol aOffset.

Parameters
aOffset- Offset displacement.

Definition at line 1009 of file lib_symbol.cpp.

1010 {
1011  for( LIB_ITEM& item : m_drawings )
1012  item.Offset( aOffset );
1013 }
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References m_drawings.

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor().

◆ SetParent() [1/3]

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Reimplemented in PCB_DIMENSION_BASE.

Definition at line 116 of file eda_item.h.

116 { m_parent = aParent; }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:479

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), PCB_EDIT_FRAME::ExchangeFootprint(), Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), FOOTPRINT::operator=(), operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SetFields(), PCB_DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_SHEET::SwapData(), SCH_GLOBALLABEL::SwapData(), SCH_SYMBOL::SwapData(), and SwapItemData().

◆ SetParent() [2/3]

◆ SetParent() [3/3]

virtual void EDA_ITEM::SetParent
inlineprivate

Definition at line 116 of file eda_item.h.

116 { m_parent = aParent; }
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663

◆ SetPinNameOffset()

void LIB_SYMBOL::SetPinNameOffset ( int  aOffset)
inline

Set the offset in mils of the pin name text from the pin symbol.

Set the offset to 0 to draw the pin name above the pin symbol.

Parameters
aOffset- The offset in mils.

Definition at line 560 of file lib_symbol.h.

560 { m_pinNameOffset = aOffset; }
int m_pinNameOffset
The offset in mils to draw the pin name.
Definition: lib_symbol.h:671

References m_pinNameOffset.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetPosition()

◆ SetPower()

void LIB_SYMBOL::SetPower ( )

Definition at line 418 of file lib_symbol.cpp.

419 {
420  if( LIB_SYMBOL_SPTR parent = m_parent.lock() )
421  parent->m_options = ENTRY_POWER;
422 
424 }
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition: lib_symbol.h:42
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition: lib_symbol.h:663
LIBRENTRYOPTIONS m_options
Special symbol features such as POWER or NORMAL.)
Definition: lib_symbol.h:678

References ENTRY_POWER, m_options, and m_parent.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetSelected()

◆ SetShowPinNames()

void LIB_SYMBOL::SetShowPinNames ( bool  aShow)
inline

◆ SetShowPinNumbers()

void LIB_SYMBOL::SetShowPinNumbers ( bool  aShow)
inline

◆ SetState()

void EDA_ITEM::SetState ( EDA_ITEM_FLAGS  type,
bool  state 
)
inlineinherited

Definition at line 142 of file eda_item.h.

143  {
144  if( state )
145  m_status |= type; // state = ON or OFF
146  else
147  m_status &= ~type;
148  }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:478

References EDA_ITEM::m_status.

Referenced by LEGACY_PLUGIN::loadTrackList(), TRACKS_CLEANER::mergeCollinearSegments(), and BOARD_ITEM::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS  aStatus)
inlineinherited

Definition at line 151 of file eda_item.h.

151 { m_status = aStatus; }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:478

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetSubpartIdNotation()

void LIB_SYMBOL::SetSubpartIdNotation ( int  aSep,
int  aFirstId 
)
static

Set the separator char between the subpart id and the reference 0 (no separator) or '.

' , '-' and '_' and the ascii char value to calculate the subpart symbol id from the symbol number: 'A' or '1' only are allowed. (to print U1.A or U1.1) if this is a digit, a number is used as id symbol Note also if the subpart symbol is a digit, the separator cannot be null.

Parameters
aSep= the separator symbol (0 (no separator) or '.' , '-' and '_')
aFirstId= the Id of the first symbol ('A' or '1')

Definition at line 1222 of file lib_symbol.cpp.

1223 {
1224  m_subpartFirstId = 'A';
1226 
1227  if( aSep == '.' || aSep == '-' || aSep == '_' )
1228  m_subpartIdSeparator = aSep;
1229 
1230  if( aFirstId == '1' && aSep != 0 )
1231  m_subpartFirstId = aFirstId;
1232 }
static int m_subpartFirstId
the ASCII char value to calculate the subpart symbol id from the symbol number: only 'A',...
Definition: lib_symbol.h:692
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
Definition: lib_symbol.h:689

References m_subpartFirstId, and m_subpartIdSeparator.

Referenced by SCH_EDIT_FRAME::LoadProjectSettings(), and PANEL_SETUP_FORMATTING::TransferDataFromWindow().

◆ SetUnitCount()

void LIB_SYMBOL::SetUnitCount ( int  aCount,
bool  aDuplicateDrawItems = true 
)

Set the units per symbol count.

If the count is greater than the current count, then the all of the current draw items are duplicated for each additional symbol. If the count is less than the current count, all draw objects for units greater that count are removed from the symbol.

Parameters
aCount- Number of units per package.
aDuplicateDrawItemsCreate duplicate draw items of unit 1 for each additionl unit.

Definition at line 1115 of file lib_symbol.cpp.

1116 {
1117  if( m_unitCount == aCount )
1118  return;
1119 
1120  if( aCount < m_unitCount )
1121  {
1123 
1124  while( i != m_drawings.end() )
1125  {
1126  if( i->m_unit > aCount )
1127  i = m_drawings.erase( i );
1128  else
1129  ++i;
1130  }
1131  }
1132  else if( aDuplicateDrawItems )
1133  {
1134  int prevCount = m_unitCount;
1135 
1136  // Temporary storage for new items, as adding new items directly to
1137  // m_drawings may cause the buffer reallocation which invalidates the
1138  // iterators
1139  std::vector< LIB_ITEM* > tmp;
1140 
1141  for( LIB_ITEM& item : m_drawings )
1142  {
1143  if( item.m_unit != 1 )
1144  continue;
1145 
1146  for( int j = prevCount + 1; j <= aCount; j++ )
1147  {
1148  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1149  newItem->m_unit = j;
1150  tmp.push_back( newItem );
1151  }
1152  }
1153 
1154  for( auto item : tmp )
1155  m_drawings.push_back( item );
1156  }
1157 
1158  m_drawings.sort();
1159  m_unitCount = aCount;
1160 }
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:188
void sort()
Definition: multivector.h:247
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:83
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:194
int m_unit
Unit identification for multiple parts per package.
Definition: lib_item.h:314
void push_back(T *aItem)
Definition: multivector.h:174
ITERATOR erase(const ITERATOR &aIterator)
Definition: multivector.h:179
ITERATOR_BASE< LIB_ITEM, MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::iterator > ITERATOR
The const iterator.
Definition: multivector.h:164
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680
int m_unitCount
Number of units (parts) per package.
Definition: lib_symbol.h:667

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), EDA_ITEM::Clone(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::erase(), m_drawings, LIB_ITEM::m_unit, m_unitCount, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::sort().

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadPartsLibrary(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 128 of file eda_item.h.

128 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:153
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ SharedPtr()

◆ ShowPinNames()

◆ ShowPinNumbers()

◆ Sort()

static bool EDA_ITEM::Sort ( const EDA_ITEM aLeft,
const EDA_ITEM aRight 
)
inlinestaticinherited

Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters
aLeftThe left hand item to compare.
aRightThe right hand item to compare.
Returns
True if aLeft is less than aRight.

Definition at line 421 of file eda_item.h.

421 { return *aLeft < *aRight; }

◆ SubpartFirstIdPtr()

static int* LIB_SYMBOL::SubpartFirstIdPtr ( )
inlinestatic

Return a reference to m_subpartFirstId, only for read/save setting functions.

Definition at line 525 of file lib_symbol.h.

525 { return &m_subpartFirstId; }
static int m_subpartFirstId
the ASCII char value to calculate the subpart symbol id from the symbol number: only 'A',...
Definition: lib_symbol.h:692

References m_subpartFirstId.

Referenced by SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ SubpartIdSeparatorPtr()

static int* LIB_SYMBOL::SubpartIdSeparatorPtr ( )
inlinestatic

Return a reference to m_subpartIdSeparator, only for read/save setting functions.

Definition at line 519 of file lib_symbol.h.

519 { return &m_subpartIdSeparator; }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
Definition: lib_symbol.h:689

References m_subpartIdSeparator.

Referenced by SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ SubReference()

wxString LIB_SYMBOL::SubReference ( int  aUnit,
bool  aAddSeparator = true 
)
static
Returns
the sub reference for symbol having multiple units per symbol. The sub reference identify the symbol (or unit)
Parameters
aUnit= the symbol identifier ( 1 to max count)
aAddSeparator= true (default) to prepend the sub ref by the separator symbol (if any) Note: this is a static function.

Definition at line 445 of file lib_symbol.cpp.

446 {
447  wxString subRef;
448 
449  if( m_subpartIdSeparator != 0 && aAddSeparator )
450  subRef << wxChar( m_subpartIdSeparator );
451 
452  if( m_subpartFirstId >= '0' && m_subpartFirstId <= '9' )
453  subRef << aUnit;
454  else
455  {
456  // use letters as notation. To allow more than 26 units, the sub ref
457  // use one letter if letter = A .. Z or a ... z, and 2 letters otherwise
458  // first letter is expected to be 'A' or 'a' (i.e. 26 letters are available)
459  int u;
460  aUnit -= 1; // Unit number starts to 1. now to 0.
461 
462  while( aUnit >= 26 ) // more than one letter are needed
463  {
464  u = aUnit / 26;
465  subRef << wxChar( m_subpartFirstId + u -1 );
466  aUnit %= 26;
467  }
468 
469  u = m_subpartFirstId + aUnit;
470  subRef << wxChar( u );
471  }
472 
473  return subRef;
474 }
static int m_subpartFirstId
the ASCII char value to calculate the subpart symbol id from the symbol number: only 'A',...
Definition: lib_symbol.h:692
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
Definition: lib_symbol.h:689

References m_subpartFirstId, and m_subpartIdSeparator.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), SCH_REFERENCE_LIST::CheckAnnotation(), SCH_REFERENCE::GetFullRef(), LIB_FIELD::GetFullText(), SCH_SYMBOL::GetRef(), SCH_FIELD::GetShownText(), GetUnitReference(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_FIELD::Matches(), SYMBOL_EDIT_FRAME::RebuildSymbolUnitsList(), SCH_SYMBOL::ResolveTextVar(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), and SYMBOL_UNIT_MENU::update().

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Returns the type of object.

This attribute should never be changed after a ctor sets it, so there is no public "setter" method.

Returns
the type of object.

Definition at line 113 of file eda_item.h.

113 { return m_structType; }
KICAD_T m_structType
Run time identification, keep private so it can never be changed after a ctor sets it.
Definition: eda_item.h:488

References EDA_ITEM::m_structType.

Referenced by KIGFX::PCB_VIEW::Add(), FOOTPRINT::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), PCB_POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), SCH_SCREEN::Append(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), PNS::TOPOLOGY::AssembleTuningPath(), CONNECTION_GRAPH::buildConnectionGraph(), DIALOG_NET_INSPECTOR::buildNewItem(), SCH_SCREENS::buildScreenList(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), PCB_POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SYMBOL::CanConnect(), CN_VISITOR::checkZoneItemConnection(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), SCH_PIN::ClassOf(), PCB_TEXT::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), SCH_NO_CONNECT::ClassOf(), PCB_MARKER::ClassOf(), FP_SHAPE::ClassOf(), PCB_TARGET::ClassOf(), SCH_LINE::ClassOf(), PCB_SHAPE::ClassOf(), PCB_GROUP::ClassOf(), SCH_FIELD::ClassOf(), FP_TEXT::ClassOf(), SCH_SHEET::ClassOf(), NETINFO_ITEM::ClassOf(), ZONE::ClassOf(), SCH_SHEET_PIN::ClassOf(), SCH_BITMAP::ClassOf(), PCB_TRACK::ClassOf(), PAD::ClassOf(), SCH_SYMBOL::ClassOf(), SCH_SCREEN::ClassOf(), FOOTPRINT::ClassOf(), SCH_TEXT::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), BOARD::ClassOf(), PCB_ARC::ClassOf(), SCH_LABEL::ClassOf(), PCB_VIA::ClassOf(), SCH_GLOBALLABEL::ClassOf(), PCB_DIM_ALIGNED::ClassOf(), PCB_DIM_ORTHOGONAL::ClassOf(), SCH_HIERLABEL::ClassOf(), PCB_DIM_LEADER::ClassOf(), PCB_DIM_CENTER::ClassOf(), TRACKS_CLEANER::cleanup(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_ITEM::compare(), Compare(), EE_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createLayers(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), ZONE_CREATE_HELPER::createNewZone(), BOARD_ADAPTER::createTrack(), SCH_SCREEN::DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDIT_TOOL::DoDelete(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), APPEARANCE_CONTROLS::doesBoardItemNeedRebuild(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawVia(), CONNECTION_SUBGRAPH::driverName(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_ITEM_DESC::EDA_ITEM_DESC(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), DRC_ENGINE::EvalRules(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), NETLIST_EXPORTER_BASE::findNextSymbol(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), PCB_BASE_FRAME::FocusOnItem(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), FP_TEXT::FP_TEXT(), PCB_POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), PCB_TRACK::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetContextualTextVars(), FOOTPRINT::GetCoverageArea(), CONNECTION_GRAPH::getDefaultConnection(), getDrilledHoleShape(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), PCB_TRACK::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTIVITY_DATA::GetNetItems(), GetNextDrawItem(), PCB_SHAPE::GetParentFootprint(), GetPin(), SCH_SYMBOL::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_TRACK::GetSelectMenuText(), DRC_ENGINE::GetShape(), PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), CONVERT_TOOL::getStartEndPoints(), getTopLevelGroup(), GROUP_TOOL::Group(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::highlightNet(), highlightNet(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), DRC_RTREE::Insert(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFootprintCourtyard(), insideFrontCourtyard(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), ARRAY_CREATOR::Invoke(), isCopper(), CN_ANCHOR::IsDangling(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), PNS_KICAD_IFACE::IsFlashedOnLayer(), CADSTAR_PCB_ARCHIVE_LOADER::isFootprint(), SCH_FIELD::IsHypertext(), isKeepoutZone(), DRC_ENGINE::IsNetTie(), PCB_TRACK::IsNull(), SCH_LINE::IsParallel(), isPlated(), SCH_FIELD::IsReplaceable(), PNS::ROUTER::isStartingPointRoutable(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), PCB_SELECTION_TOOL::itemPassesFilter(), CONVERT_TOOL::LinesToPoly(), CLIPBOARD_IO::Load(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), EE_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), NETLIST_EXPORTER_XML::makeListOfNets(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromSegs(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_FIELD::Matches(), memberOf(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), PCB_SHAPE::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_TEXT::operator<(), SCH_FIELD::operator<(), SCH_LINE::operator<(), SCH_SHEET::operator<(), SCH_ITEM::operator<(), SCH_SYMBOL::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_SYMBOL::operator=(), PAD::PAD(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), CONVERT_TOOL::PolyToLines(), POSITION_RELATIVE_TOOL::PositionRelative(), SCH_FIELD::Print(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), SCH_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshSelection(), KIGFX::PCB_VIEW::Remove(), EE_RTREE::remove(), FOOTPRINT::Remove(), CN_CONNECTIVITY_ALGO::Remove(), SCH_SCREEN::Remove(), BOARD::Remove(), PCB_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCornerCondition(), RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), PCB_SELECTION_TOOL::RequestSelection(), SCHEMATIC::ResolveCrossReference(), PCB_PARSER::resolveGroups(), DS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), SCH_SEXPR_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_SEXPR_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_SEXPR_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_SEXPR_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), CLIPBOARD_IO::SaveSelection(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SCREEN::Schematic(), SCH_ITEM::Schematic(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectConnectedTracks(), PCB_POINT_EDITOR::setAltConstraint(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_SHEET_PIN::SwapData(), SCH_FIELD::SwapData(), PCB_GROUP::SwapData(), PCB_TEXT::SwapData(), PCB_TRACK::SwapData(), SCH_SHEET::SwapData(), PCB_ARC::SwapData(), PCB_DIM_ALIGNED::SwapData(), PCB_DIM_ORTHOGONAL::SwapData(), SCH_SYMBOL::SwapData(), PCB_VIA::SwapData(), PCB_DIM_LEADER::SwapData(), PCB_DIM_CENTER::SwapData(), FOOTPRINT::SwapData(), PAD::SwapData(), ZONE::SwapData(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), ERC_TESTER::TestMultUnitPinConflicts(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), PCB_TRACK::TransformShapeWithClearanceToPolygon(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), SCH_TEXT::UpdateDanglingState(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), SCH_BASE_FRAME::UpdateItem(), CONNECTION_GRAPH::updateItemConnectivity(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updateParentItem(), SCH_EDITOR_CONTROL::updatePastedSheet(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), PCB_GROUP::Visit(), PCB_TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_GLOBALLABEL::Visit(), SCH_SHEET::Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and NETLIST_EXPORTER_CADSTAR::writeListOfNets().

◆ UnitsLocked()

bool LIB_SYMBOL::UnitsLocked ( ) const
inline

Check whether symbol units are interchangeable.

Returns
False when interchangeable, true otherwise.

Definition at line 241 of file lib_symbol.h.

241 { return m_unitsLocked; }
bool m_unitsLocked
True if symbol has multiple units and changing one unit does not automatically change another unit.
Definition: lib_symbol.h:668

References m_unitsLocked.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GetUniqueUnits(), SCH_REFERENCE::IsUnitsLocked(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::SynchronizePins(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

Return the bounding box of the item covering all its layers.

Returns
the current bounding box.

Implements KIGFX::VIEW_ITEM.

Reimplemented in PAD, FOOTPRINT, PCB_DIM_CENTER, EDIT_POINTS, PCB_SHAPE, PCB_DIMENSION_BASE, GERBER_DRAW_ITEM, FP_TEXT, PCB_TRACK, DS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, PCB_MARKER, MY_DRAWING, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::POLYGON_ITEM, RATSNEST_VIEW_ITEM, KIGFX::PREVIEW::RULER_ITEM, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 194 of file eda_item.cpp.

195 {
196  // Basic fallback
197  EDA_RECT bbox = GetBoundingBox();
198 
199  return BOX2I( bbox.GetOrigin(), bbox.GetSize() );
200 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:506
const wxPoint GetOrigin() const
Definition: eda_rect.h:101
Handle the component boundary box.
Definition: eda_rect.h:42
virtual const EDA_RECT GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition: eda_item.cpp:75
const wxSize GetSize() const
Definition: eda_rect.h:91

References EDA_ITEM::GetBoundingBox(), EDA_RECT::GetOrigin(), and EDA_RECT::GetSize().

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), PCB_DIMENSION_BASE::ViewBBox(), and PCB_SHAPE::ViewBBox().

◆ ViewDraw()

virtual void KIGFX::VIEW_ITEM::ViewDraw ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

An alternative way for drawing objects if there is no #PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters
aLayeris the current drawing layer.
aViewis a pointer to the VIEW device we are drawing on.

Reimplemented in EDIT_POINTS, DS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, MY_DRAWING, KIGFX::VIEW_OVERLAY, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, and RATSNEST_VIEW_ITEM.

Definition at line 111 of file view_item.h.

112  {}

Referenced by KIGFX::VIEW::draw(), and KIGFX::VIEW::updateItemGeometry().

◆ ViewGetLayers()

void LIB_SYMBOL::ViewGetLayers ( int  aLayers[],
int &  aCount 
) const
overridevirtual

Return the all the layers within the VIEW the object is painted on.

For instance, a PAD spans zero or more copper layers and a few technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called for each of the layers returned by ViewGetLayers(), depending on the rendering order.

Parameters
aLayers[]is the output layer index array.
aCountis the number of layer indices in aLayers[].

Reimplemented from EDA_ITEM.

Definition at line 839 of file lib_symbol.cpp.

840 {
841  aCount = 6;
842  aLayers[0] = LAYER_DEVICE;
843  aLayers[1] = LAYER_DEVICE_BACKGROUND;
844  aLayers[2] = LAYER_REFERENCEPART;
845  aLayers[3] = LAYER_VALUEPART;
846  aLayers[4] = LAYER_FIELDS;
847  aLayers[5] = LAYER_SELECTION_SHADOWS;
848 }

References LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LAYER_FIELDS, LAYER_REFERENCEPART, LAYER_SELECTION_SHADOWS, and LAYER_VALUEPART.

◆ ViewGetLOD()

virtual double KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Return the level of detail (LOD) of the item.

A level of detail is the minimal VIEW scale that is sufficient for an item to be shown on a given layer.

Parameters
aLayeris the current drawing layer.
aViewis a pointer to the VIEW device we are drawing on.
Returns
the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in FP_ZONE, PAD, FOOTPRINT, PCB_VIA, GERBER_DRAW_ITEM, FP_TEXT, PCB_TRACK, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 137 of file view_item.h.

138  {
139  // By default always show the item
140  return 0.0;
141  }

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), EE_GRID_HELPER::queryVisible(), PCB_GRID_HELPER::queryVisible(), and PCB_SELECTION_TOOL::Selectable().

◆ viewPrivData()

◆ Visit()

SEARCH_RESULT LIB_SYMBOL::Visit ( INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
overridevirtual

May be re-implemented for each derived class in order to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in scanTypes[], and may use IterateForward() to do so on lists of such data.

Parameters
inspectorAn INSPECTOR instance to use in the inspection.
testDataArbitrary data used by the inspector.
scanTypesWhich# KICAD_T types are of interest and the order is significant too, terminated by EOT.
Returns
SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else #SCAN_CONTINUE, and determined by the inspector.

Reimplemented from EDA_ITEM.

Definition at line 1098 of file lib_symbol.cpp.

1100 {
1101  // The part itself is never inspected, only its children
1102  for( LIB_ITEM& item : m_drawings )
1103  {
1104  if( item.IsType( aFilterTypes ) )
1105  {
1106  if( aInspector( &item, aTestData ) == SEARCH_RESULT::QUIT )
1107  return SEARCH_RESULT::QUIT;
1108  }
1109  }
1110 
1111  return SEARCH_RESULT::CONTINUE;
1112 }
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
LIB_ITEMS_CONTAINER m_drawings
Definition: lib_symbol.h:680

References CONTINUE, m_drawings, and QUIT.

Member Data Documentation

◆ m_description

wxString LIB_SYMBOL::m_description
private

Definition at line 684 of file lib_symbol.h.

Referenced by Compare(), Flatten(), GetDescription(), LIB_SYMBOL(), operator=(), and SetDescription().

◆ m_drawings

◆ m_flags

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

◆ m_fpFilters

wxArrayString LIB_SYMBOL::m_fpFilters
private

List of suitable footprint names for the symbol (wild card names accepted).

Definition at line 686 of file lib_symbol.h.

Referenced by Compare(), Flatten(), GetFPFilters(), LIB_SYMBOL(), operator=(), and SetFPFilters().

◆ m_includeInBom

bool LIB_SYMBOL::m_includeInBom
private

Definition at line 676 of file lib_symbol.h.

Referenced by Compare(), GetIncludeInBom(), LIB_SYMBOL(), operator=(), and SetIncludeInBom().

◆ m_includeOnBoard

bool LIB_SYMBOL::m_includeOnBoard
private

Definition at line 677 of file lib_symbol.h.

Referenced by Compare(), GetIncludeOnBoard(), LIB_SYMBOL(), operator=(), and SetIncludeOnBoard().

◆ m_keyWords

wxString LIB_SYMBOL::m_keyWords
private

Search keywords.

Definition at line 685 of file lib_symbol.h.

Referenced by Compare(), Flatten(), GetKeyWords(), LIB_SYMBOL(), operator=(), and SetKeyWords().

◆ m_lastModDate

timestamp_t LIB_SYMBOL::m_lastModDate
private

Definition at line 665 of file lib_symbol.h.

Referenced by GetLastModDate(), LIB_SYMBOL(), and operator=().

◆ m_libId

LIB_ID LIB_SYMBOL::m_libId
private

Definition at line 664 of file lib_symbol.h.

Referenced by Compare(), GetLibId(), GetLibraryName(), LIB_SYMBOL(), operator=(), SetLibId(), and SetName().

◆ m_library

SYMBOL_LIB* LIB_SYMBOL::m_library
private

Definition at line 682 of file lib_symbol.h.

Referenced by Duplicate(), GetLib(), GetLibraryName(), LIB_SYMBOL(), operator=(), and SetLib().

◆ m_me

LIB_SYMBOL_SPTR LIB_SYMBOL::m_me
private

Definition at line 662 of file lib_symbol.h.

Referenced by Compare(), and SharedPtr().

◆ m_name

wxString LIB_SYMBOL::m_name
private

Definition at line 683 of file lib_symbol.h.

Referenced by Compare(), Flatten(), GetName(), LIB_SYMBOL(), operator=(), and SetName().

◆ m_options

LIBRENTRYOPTIONS LIB_SYMBOL::m_options
private

Special symbol features such as POWER or NORMAL.)

Definition at line 678 of file lib_symbol.h.

Referenced by Compare(), IsNormal(), IsPower(), LIB_SYMBOL(), operator=(), SetNormal(), and SetPower().

◆ m_parent

◆ m_pinNameOffset

int LIB_SYMBOL::m_pinNameOffset
private

The offset in mils to draw the pin name.

Set to 0 to draw the pin name above the pin.

Definition at line 671 of file lib_symbol.h.

Referenced by Compare(), GetPinNameOffset(), LIB_SYMBOL(), operator=(), and SetPinNameOffset().

◆ m_showPinNames

bool LIB_SYMBOL::m_showPinNames
private

Definition at line 673 of file lib_symbol.h.

Referenced by Compare(), LIB_SYMBOL(), operator=(), SetShowPinNames(), and ShowPinNames().

◆ m_showPinNumbers

bool LIB_SYMBOL::m_showPinNumbers
private

Definition at line 674 of file lib_symbol.h.

Referenced by Compare(), LIB_SYMBOL(), operator=(), SetShowPinNumbers(), and ShowPinNumbers().

◆ m_status

◆ m_subpartFirstId

int LIB_SYMBOL::m_subpartFirstId = 'A'
staticprivate

the ASCII char value to calculate the subpart symbol id from the symbol number: only 'A', 'a' or '1' can be used, other values have no sense.

Definition at line 692 of file lib_symbol.h.

Referenced by GetSubpartFirstId(), SetSubpartIdNotation(), SubpartFirstIdPtr(), and SubReference().

◆ m_subpartIdSeparator

int LIB_SYMBOL::m_subpartIdSeparator = 0
staticprivate

the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or U1.A or U1-A

Definition at line 689 of file lib_symbol.h.

Referenced by GetSubpartIdSeparator(), SetSubpartIdNotation(), SubpartIdSeparatorPtr(), and SubReference().

◆ m_unitCount

int LIB_SYMBOL::m_unitCount
private

Number of units (parts) per package.

Definition at line 667 of file lib_symbol.h.

Referenced by Compare(), GetUnitBoundingBox(), GetUnitCount(), IsMulti(), LIB_SYMBOL(), operator=(), and SetUnitCount().

◆ m_unitsLocked

bool LIB_SYMBOL::m_unitsLocked
private

True if symbol has multiple units and changing one unit does not automatically change another unit.

Definition at line 668 of file lib_symbol.h.

Referenced by Compare(), LIB_SYMBOL(), LockUnits(), operator=(), and UnitsLocked().

◆ m_Uuid