KiCad PCB EDA Suite
LIB_PART Class Reference

Define a library symbol object. More...

#include <class_libentry.h>

Inheritance diagram for LIB_PART:
EDA_ITEM LIB_TREE_ITEM KIGFX::VIEW_ITEM

Public Member Functions

 LIB_PART (const wxString &aName, LIB_PART *aParent=nullptr, PART_LIB *aLibrary=nullptr)
 
 LIB_PART (const LIB_PART &aPart, PART_LIB *aLibrary=NULL)
 Copy constructor. More...
 
virtual ~LIB_PART ()
 
PART_SPTR SharedPtr ()
 
void SetParent (LIB_PART *aParent=nullptr)
 
PART_REFGetParent ()
 
virtual wxString GetClass () const override
 Function GetClass returns 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
 
PART_LIBGetLib ()
 
void SetLib (PART_LIB *aLibrary)
 
timestamp_t GetDateLastEdition () const
 
wxArrayString GetFootprints () const
 
void SetFootprintFilters (const wxArrayString &aFootprintFilters)
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns 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
 Function GetBoundingBox returns 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 part units. More...
 
bool UnitsLocked () const
 Check whether part 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 (LIB_FIELDS &aList)
 Return a list of fields within this part. More...
 
LIB_FIELDFindField (const wxString &aFieldName)
 Find a field within this part matching aFieldName and returns it or NULL if not found. More...
 
const LIB_FIELDFindField (const wxString &aFieldName) const
 
LIB_FIELDGetField (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 (RENDER_SETTINGS *aSettings, const wxPoint &aOffset, int aMulti, int aConvert, const PART_DRAW_OPTIONS &aOpts)
 Print part. More...
 
void Plot (PLOTTER *aPlotter, int aUnit, int aConvert, const wxPoint &aOffset, const TRANSFORM &aTransform)
 Plot lib part to plotter. More...
 
void PlotLibFields (PLOTTER *aPlotter, int aUnit, int aConvert, const wxPoint &aOffset, const TRANSFORM &aTransform)
 Plot Lib Fields only of the part to plotter. More...
 
void AddDrawItem (LIB_ITEM *aItem)
 Add a new draw aItem to the draw object list. More...
 
void RemoveDrawItem (LIB_ITEM *aItem)
 Remove draw aItem from list. More...
 
LIB_ITEMGetNextDrawItem (LIB_ITEM *aItem=NULL, KICAD_T aType=TYPE_NOT_INIT)
 Return the next draw object pointer. More...
 
size_t GetPinCount () const
 
LIB_PINGetNextPin (LIB_PIN *aItem=NULL)
 Return the next pin object from the draw list. More...
 
void GetPins (LIB_PINS &aList, int aUnit=0, int aConvert=0)
 Return a list of pin object pointers from the draw item list. More...
 
LIB_PINGetPin (const wxString &aNumber, int aUnit=0, int aConvert=0)
 Return pin object with the requested pin aNumber. More...
 
bool PinsConflictWith (LIB_PART &aOtherPart, bool aTestNums, bool aTestNames, bool aTestType, bool aTestOrientation, bool aTestLength)
 Return true if this part's pins do not match another part's pins. More...
 
void SetOffset (const wxPoint &aOffset)
 Move the part aOffset. More...
 
void RemoveDuplicateDrawItems ()
 Remove duplicate draw items from list. More...
 
bool HasConversion () const
 Test if part has more than one body conversion type (DeMorgan). More...
 
void ClearTempFlags ()
 Clears the status flag all draw objects in this part. 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...
 
SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
 Function Visit 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 part 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 part. More...
 
void SetPinNameOffset (int aOffset)
 Set the offset in mils of the pin name text from the pin symbol. More...
 
int GetPinNameOffset ()
 
void SetShowPinNames (bool aShow)
 Set or clear the pin name visibility flag. More...
 
bool ShowPinNames ()
 
void SetShowPinNumbers (bool aShow)
 Set or clear the pin number visibility flag. More...
 
bool ShowPinNumbers ()
 
int Compare (const LIB_PART &aRhs) const
 Comparison test that can be used for operators. More...
 
bool operator== (const LIB_PART *aPart) const
 
bool operator== (const LIB_PART &aPart) const
 
bool operator!= (const LIB_PART &aPart) const
 
const LIB_PARToperator= (const LIB_PART &aPart)
 
std::unique_ptr< LIB_PARTFlatten () const
 Return a flattened symbol inheritance to the caller. More...
 
std::vector< struct PART_UNITSGetUnitDrawItems ()
 Return a list of LIB_ITEM objects separated by unit and convert number. More...
 
std::vector< struct PART_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
 Function Type() More...
 
EDA_ITEMGetParent () const
 
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 IsResized () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool HasFlag (STATUS_FLAGS aFlag)
 
STATUS_FLAGS GetEditFlags () const
 
virtual bool IsType (const KICAD_T aScanTypes[]) const
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag 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)
 Function GetMsgPanelInfo populates 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
 Function HitTest tests 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
 Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
 
virtual const wxPoint GetPosition () const
 
virtual const wxPoint GetFocusPosition () const
 Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
 
virtual EDA_ITEMClone () const
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
virtual wxString GetSelectMenuText (EDA_UNITS aUnits) const
 Function GetSelectMenuText returns 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 BITMAP_DEF GetMenuImage () const
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData)
 Function Matches compares the item against the search criteria in aSearchData. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Function IsReplaceable. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 

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[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
static bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs 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)
 Function Sort is a 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, wxFindReplaceData &aSearchData)
 Function Matches compares aText against search criteria in aSearchData. More...
 

Protected Attributes

STATUS_FLAGS m_Status
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
STATUS_FLAGS m_Flags
 

Private Member Functions

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

Private Attributes

PART_SPTR m_me
 < http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared More...
 
PART_REF m_parent
 Use for inherited symbols. More...
 
LIB_ID m_libId
 
int m_pinNameOffset
 The offset in mils to draw the pin name. More...
 
bool m_unitsLocked
 True if part has multiple units and changing one unit does not automatically change another unit. More...
 
bool m_showPinNames
 Determines if part pin names are visible. More...
 
bool m_showPinNumbers
 Determines if part pin numbers are visible. More...
 
timestamp_t m_dateLastEdition
 Date of the last modification. More...
 
LIBRENTRYOPTIONS m_options
 Special part features such as POWER or NORMAL.) More...
 
int m_unitCount
 Number of units (parts) per package. More...
 
LIB_ITEMS_CONTAINER m_drawings
 Drawing items of this part. More...
 
wxArrayString m_FootprintList
 List of suitable footprint names for the part (wild card names accepted). More...
 
PART_LIBm_library
 Library the part belongs to if any. More...
 
wxString m_name
 Symbol name. More...
 
wxString m_description
 documentation for info More...
 
wxString m_keyWords
 keyword list (used for search for parts by keyword) 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 part 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 part library file (.lib). Library symbols are different from schematic symbols.

Definition at line 97 of file class_libentry.h.

Constructor & Destructor Documentation

◆ LIB_PART() [1/2]

LIB_PART::LIB_PART ( const wxString &  aName,
LIB_PART aParent = nullptr,
PART_LIB aLibrary = nullptr 
)

Definition at line 88 of file class_libentry.cpp.

88  :
90  m_me( this, null_deleter() )
91 {
93  m_unitCount = 1;
96  m_unitsLocked = false;
97  m_showPinNumbers = true;
98  m_showPinNames = true;
99 
100  // Add the MANDATORY_FIELDS in RAM only. These are assumed to be present
101  // when the field editors are invoked.
102  m_drawings[LIB_FIELD_T].reserve( 4 );
107 
108  SetName( aName );
109 
110  if( aParent )
111  SetParent( aParent );
112 
113  SetLib( aLibrary );
114 }
timestamp_t m_dateLastEdition
Date of the last modification.
void SetLib(PART_LIB *aLibrary)
name of datasheet
bool m_showPinNumbers
Determines if part pin numbers are visible.
int m_unitCount
Number of units (parts) per package.
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit.
int m_pinNameOffset
The offset in mils to draw the pin name.
#define VALUE
void push_back(T *aItem)
Definition: multivector.h:169
void SetParent(LIB_PART *aParent=nullptr)
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType)
Definition: base_struct.cpp:57
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared
#define DEFAULT_PIN_NAME_OFFSET
The offset of the pin name string from the end of the pin in mils.
Definition: lib_pin.h:43
virtual void SetName(const wxString &aName)
bool m_showPinNames
Determines if part pin names are visible.
PART_SPTR m_me
< http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared

References DATASHEET, DEFAULT_PIN_NAME_OFFSET, ENTRY_NORMAL, FOOTPRINT, LIB_FIELD_T, m_dateLastEdition, m_drawings, m_options, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), REFERENCE, SetLib(), SetName(), SetParent(), and VALUE.

Referenced by Flatten(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), LIB_MANAGER::PART_BUFFER::PART_BUFFER(), LIB_MANAGER::RevertPart(), LIB_MANAGER::LIB_BUFFER::SaveBuffer(), LIB_MANAGER::SaveLibrary(), and LIB_MANAGER::UpdatePart().

◆ LIB_PART() [2/2]

LIB_PART::LIB_PART ( const LIB_PART aPart,
PART_LIB aLibrary = NULL 
)

Copy constructor.

Definition at line 117 of file class_libentry.cpp.

117  :
118  EDA_ITEM( aPart ),
119  m_me( this, null_deleter() )
120 {
121  LIB_ITEM* newItem;
122 
123  m_library = aLibrary;
124  m_name = aPart.m_name;
125  m_FootprintList = wxArrayString( aPart.m_FootprintList );
126  m_unitCount = aPart.m_unitCount;
132  m_options = aPart.m_options;
133  m_libId = aPart.m_libId;
135  m_keyWords = aPart.m_keyWords;
136 
137  ClearSelected();
138 
139  for( const LIB_ITEM& oldItem : aPart.m_drawings )
140  {
141  if( ( oldItem.GetFlags() & ( IS_NEW | STRUCT_DELETED ) ) != 0 )
142  continue;
143 
144  try
145  {
146  newItem = (LIB_ITEM*) oldItem.Clone();
147  newItem->ClearSelected();
148  newItem->SetParent( this );
149  m_drawings.push_back( newItem );
150  }
151  catch( ... )
152  {
153  wxFAIL_MSG( "Failed to clone LIB_ITEM." );
154  }
155  }
156 
157  PART_SPTR parent = aPart.m_parent.lock();
158 
159  if( parent )
160  SetParent( parent.get() );
161 }
timestamp_t m_dateLastEdition
Date of the last modification.
bool m_showPinNumbers
Determines if part pin numbers are visible.
void ClearSelected()
Definition: base_struct.h:211
int m_unitCount
Number of units (parts) per package.
PART_LIB * m_library
Library the part belongs to if any.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit.
virtual void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:196
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
#define IS_NEW
New item, just created.
Definition: base_struct.h:117
int m_pinNameOffset
The offset in mils to draw the pin name.
PART_REF m_parent
Use for inherited symbols.
wxString m_name
Symbol name.
void push_back(T *aItem)
Definition: multivector.h:169
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
void SetParent(LIB_PART *aParent=nullptr)
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
wxArrayString m_FootprintList
List of suitable footprint names for the part (wild card names accepted).
LIB_ID m_libId
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType)
Definition: base_struct.cpp:57
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared
wxString m_keyWords
keyword list (used for search for parts by keyword)
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:234
bool m_showPinNames
Determines if part pin names are visible.
wxString m_description
documentation for info
PART_SPTR m_me
< http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared

References EDA_ITEM::ClearSelected(), EDA_ITEM::Clone(), EDA_ITEM::GetFlags(), IS_NEW, m_dateLastEdition, m_description, m_drawings, m_FootprintList, m_keyWords, 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(), SetParent(), EDA_ITEM::SetParent(), and STRUCT_DELETED.

◆ ~LIB_PART()

LIB_PART::~LIB_PART ( )
virtual

Definition at line 164 of file class_libentry.cpp.

165 {
166 }

Member Function Documentation

◆ AddDrawItem()

void LIB_PART::AddDrawItem ( LIB_ITEM aItem)

Add a new draw aItem to the draw object list.

Parameters
aItem- New draw object to add to part.

Definition at line 605 of file class_libentry.cpp.

606 {
607  if( !aItem )
608  return;
609 
610  m_drawings.push_back( aItem );
611 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
void push_back(T *aItem)
Definition: multivector.h:169

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

Referenced by BOOST_AUTO_TEST_CASE(), LIB_PIN_TOOL::CreateImagePins(), LIB_DRAWING_TOOLS::DrawShape(), dummy(), KIGFX::dummy(), LIB_EDIT_FRAME::LoadOneSymbol(), LIB_EDIT_TOOL::Paste(), LIB_PIN_TOOL::PlacePin(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), DIALOG_LIB_EDIT_PIN_TABLE::TransferDataFromWindow(), and LIB_DRAWING_TOOLS::TwoClickPlace().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

◆ ClearEditFlags()

void LIB_PART::ClearEditFlags ( )

Definition at line 977 of file class_libentry.cpp.

978 {
979  for( LIB_ITEM& item : m_drawings )
980  item.ClearEditFlags();
981 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61

References m_drawings.

Referenced by LIB_EDIT_FRAME::SaveCopyInUndoList().

◆ ClearFlags()

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

Definition at line 233 of file base_struct.h.

233 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceModule(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::RollbackPartFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

◆ ClearTempFlags()

void LIB_PART::ClearTempFlags ( )

Clears the status flag all draw objects in this part.

Definition at line 970 of file class_libentry.cpp.

971 {
972  for( LIB_ITEM& item : m_drawings )
973  item.ClearTempFlags();
974 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61

References m_drawings.

Referenced by LIB_PIN_TOOL::CreatePin(), and LIB_EDIT_FRAME::SaveCopyInUndoList().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 153 of file view_item.h.

154  {
156  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:161
#define NULL

References KIGFX::VIEW_ITEM::m_viewPrivData, and NULL.

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

◆ Clone()

EDA_ITEM * EDA_ITEM::Clone ( ) const
virtualinherited

Function Clone creates 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 MODULE_ZONE_CONTAINER, ZONE_CONTAINER, SCH_COMPONENT, MODULE, SCH_SHEET, D_PAD, SCH_HIERLABEL, LIB_PIN, VIA, SCH_GLOBALLABEL, SCH_LABEL, ARC, SCH_TEXT, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, SCH_LINE, TRACK, SCH_BUS_BUS_ENTRY, SCH_SHEET_PIN, SCH_FIELD, LIB_FIELD, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, EDGE_MODULE, LIB_ARC, TEXTE_PCB, SCH_NO_CONNECT, SCH_JUNCTION, LIB_POLYLINE, SCH_MARKER, LIB_TEXT, PCB_TARGET, LIB_BEZIER, LIB_CIRCLE, LIB_RECTANGLE, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 108 of file base_struct.cpp.

109 {
110  wxCHECK_MSG( false, NULL, wxT( "Clone not implemented in derived class " ) + GetClass() +
111  wxT( ". Bad programmer!" ) );
112 }
#define NULL
virtual wxString GetClass() const =0
Function GetClass returns the class name.

References EDA_ITEM::GetClass(), and NULL.

Referenced by LIB_DRAWING_TOOLS::DrawShape(), LIB_EDIT_TOOL::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), new_clone(), operator=(), LIB_EDIT_TOOL::Paste(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SetConversion(), SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), COMMIT::Stage(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ Compare()

int LIB_PART::Compare ( const LIB_PART 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 211 of file class_libentry.cpp.

212 {
213  if( m_me == aRhs.m_me )
214  return 0;
215 
216  int retv = m_name.Cmp( aRhs.m_name );
217 
218  if( retv )
219  return retv;
220 
221  retv = m_libId.compare( aRhs.m_libId );
222 
223  if( retv )
224  return retv;
225 
226  if( m_parent.lock() < aRhs.m_parent.lock() )
227  return -1;
228 
229  if( m_parent.lock() > aRhs.m_parent.lock() )
230  return 1;
231 
232  if( m_options != aRhs.m_options )
233  return ( m_options == ENTRY_NORMAL ) ? -1 : 1;
234 
235  if( m_unitCount != aRhs.m_unitCount )
236  return m_unitCount - aRhs.m_unitCount;
237 
238  if( m_drawings.size() != aRhs.m_drawings.size() )
239  return m_drawings.size() - aRhs.m_drawings.size();
240 
243 
244  while( lhsItem != m_drawings.end() )
245  {
246  if( lhsItem->Type() != rhsItem->Type() )
247  return lhsItem->Type() - rhsItem->Type();
248 
249  retv = lhsItem->compare( *rhsItem );
250 
251  if( retv )
252  return retv;
253 
254  ++lhsItem;
255  ++rhsItem;
256  }
257 
258  if( m_FootprintList.GetCount() != aRhs.m_FootprintList.GetCount() )
259  return m_FootprintList.GetCount() - aRhs.m_FootprintList.GetCount();
260 
261  for( size_t i = 0; i < m_FootprintList.GetCount(); i++ )
262  {
263  retv = m_FootprintList[i].Cmp( aRhs.m_FootprintList[i] );
264 
265  if( retv )
266  return retv;
267  }
268 
269  retv = m_description.Cmp( aRhs.m_description );
270 
271  if( retv )
272  return retv;
273 
274  retv = m_keyWords.Cmp( aRhs.m_keyWords );
275 
276  if( retv )
277  return retv;
278 
279  if( m_pinNameOffset != aRhs.m_pinNameOffset )
280  return m_pinNameOffset - aRhs.m_pinNameOffset;
281 
282  if( m_unitsLocked != aRhs.m_unitsLocked )
283  return ( m_unitsLocked ) ? 1 : -1;
284 
285  if( m_showPinNames != aRhs.m_showPinNames )
286  return ( m_showPinNames ) ? 1 : -1;
287 
288  if( m_showPinNumbers != aRhs.m_showPinNumbers )
289  return ( m_showPinNumbers ) ? 1 : -1;
290 
291  return 0;
292 }
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:183
bool m_showPinNumbers
Determines if part pin numbers are visible.
int m_unitCount
Number of units (parts) per package.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
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:316
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit.
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:189
int m_pinNameOffset
The offset in mils to draw the pin name.
PART_REF m_parent
Use for inherited symbols.
wxString m_name
Symbol name.
wxArrayString m_FootprintList
List of suitable footprint names for the part (wild card names accepted).
LIB_ID m_libId
ITERATOR_BASE< const LIB_ITEM, const MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::const_iterator > CONST_ITERATOR
The const iterator
Definition: multivector.h:162
wxString m_keyWords
keyword list (used for search for parts by keyword)
bool m_showPinNames
Determines if part pin names are visible.
wxString m_description
documentation for info
size_t size(int aType=UNDEFINED_TYPE) const
Definition: multivector.h:220
PART_SPTR m_me
< http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared

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

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

◆ deleteAllFields()

void LIB_PART::deleteAllFields ( )
private

Definition at line 816 of file class_libentry.cpp.

817 {
819 }
void clear(int aType=UNDEFINED_TYPE)
Definition: multivector.h:207
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.

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

Referenced by SetFields().

◆ FindField() [1/2]

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

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

Definition at line 880 of file class_libentry.cpp.

881 {
882  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
883  {
884  if( static_cast<LIB_FIELD*>( &item )->GetCanonicalName() == aFieldName )
885  return static_cast<LIB_FIELD*>( &item );
886  }
887 
888  return NULL;
889 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
#define NULL

References LIB_FIELD_T, m_drawings, and NULL.

Referenced by SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), and FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable().

◆ FindField() [2/2]

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

Definition at line 892 of file class_libentry.cpp.

893 {
894  for( const LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
895  {
896  if( static_cast<const LIB_FIELD*>( &item )->GetCanonicalName() == aFieldName )
897  return static_cast<const LIB_FIELD*>( &item );
898  }
899 
900  return NULL;
901 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
#define NULL

References LIB_FIELD_T, m_drawings, and NULL.

◆ Flatten()

std::unique_ptr< LIB_PART > LIB_PART::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 321 of file class_libentry.cpp.

322 {
323  std::unique_ptr< LIB_PART > retv;
324 
325  if( IsAlias() )
326  {
327  PART_SPTR parent = m_parent.lock();
328 
329  wxCHECK_MSG( parent, retv,
330  wxString::Format( "Parent of derived symbol '%s' undefined", m_name ) );
331 
332  // Copy the parent.
333  retv.reset( new LIB_PART( *parent.get() ) );
334 
335  retv->SetName( m_name );
336 
337  // Now add the inherited part mandatory field (this) information.
338  for( int i = 0; i < MANDATORY_FIELDS; i++ )
339  {
340  wxString tmp = GetField( i )->GetText();
341 
342  // If the field isn't defined then inherit the parent field value.
343  if( tmp.IsEmpty() )
344  retv->GetField( i )->SetText( parent->GetField( i )->GetText() );
345  else
346  *retv->GetField( i ) = *GetField( i );
347  }
348 
349  // Grab all the rest of derived symbol fields.
350  for( const LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
351  {
352  const LIB_FIELD* aliasField = dynamic_cast<const LIB_FIELD*>( &item );
353 
354  wxCHECK2( aliasField, continue );
355 
356  // Mandatory fields were already resolved.
357  if( aliasField->IsMandatory() )
358  continue;
359 
360  LIB_FIELD* newField = new LIB_FIELD( *aliasField );
361  newField->SetParent( retv.get() );
362 
363  LIB_FIELD* parentField = retv->FindField( aliasField->GetName() );
364 
365  if( !parentField ) // Derived symbol field does not exist in parent symbol.
366  {
367  retv->AddDrawItem( newField );
368  }
369  else // Derived symbol field overrides the parent symbol field.
370  {
371  retv->RemoveDrawItem( parentField );
372  retv->AddDrawItem( newField );
373  }
374  }
375 
376  retv->SetKeyWords( m_keyWords );
377  retv->SetDescription( m_description );
378  }
379  else
380  {
381  retv.reset( new LIB_PART( *this ) );
382  }
383 
384  return retv;
385 }
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
virtual void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:196
wxString GetName(bool aUseDefaultName=true) const
Returns the field name.
Definition: lib_field.cpp:366
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
PART_REF m_parent
Use for inherited symbols.
wxString m_name
Symbol name.
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
LIB_PART(const wxString &aName, LIB_PART *aParent=nullptr, PART_LIB *aLibrary=nullptr)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
bool IsAlias() const
wxString m_keyWords
keyword list (used for search for parts by keyword)
LIB_FIELD * GetField(int aId) const
Return pointer to the requested field.
wxString m_description
documentation for info
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:126
bool IsMandatory() const
Definition: lib_field.cpp:456

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

Referenced by SCH_EDIT_FRAME::CreateArchiveLibrary(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_FRAME::ExportPart(), LIB_EDIT_FRAME::GetDocumentExtents(), RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), DIALOG_EDIT_COMPONENTS_LIBID::revertChanges(), SCH_COMPONENT::SCH_COMPONENT(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), and SCH_SCREEN::UpdateSymbolLinks().

◆ GetBodyBoundingBox()

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

Get the symbol bounding box excluding fields.

Returns
the part 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 793 of file class_libentry.cpp.

794 {
795  EDA_RECT bbox;
796 
797  for( const LIB_ITEM& item : m_drawings )
798  {
799  if( ( item.m_Unit > 0 ) && ( ( m_unitCount > 1 ) && ( aUnit > 0 )
800  && ( aUnit != item.m_Unit ) ) )
801  continue;
802 
803  if( item.m_Convert > 0 && ( ( aConvert > 0 ) && ( aConvert != item.m_Convert ) ) )
804  continue;
805 
806  if( item.Type() == LIB_FIELD_T )
807  continue;
808 
809  bbox.Merge( item.GetBoundingBox() );
810  }
811 
812  return bbox;
813 }
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect.
int m_unitCount
Number of units (parts) per package.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

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

Referenced by SCH_COMPONENT::GetBodyBoundingBox().

◆ GetBoundingBox()

const EDA_RECT LIB_PART::GetBoundingBox ( ) const
inlineoverridevirtual

Function GetBoundingBox returns 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 227 of file class_libentry.h.

228  {
229  return GetUnitBoundingBox( 0, 0 );
230  }
const EDA_RECT GetUnitBoundingBox(int aUnit, int aConvert) const
Get the bounding box for the symbol.

References GetUnitBoundingBox().

◆ GetClass()

virtual wxString LIB_PART::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 153 of file class_libentry.h.

154  {
155  return wxT( "LIB_PART" );
156  }

◆ GetDatasheetField()

LIB_FIELD & LIB_PART::GetDatasheetField ( )

Return reference to the datasheet field.

Definition at line 928 of file class_libentry.cpp.

929 {
930  LIB_FIELD* field = GetField( DATASHEET );
931  wxASSERT( field != NULL );
932  return *field;
933 }
name of datasheet
Field object used in symbol libraries.
Definition: lib_field.h:59
#define NULL
LIB_FIELD * GetField(int aId) const
Return pointer to the requested field.

References DATASHEET, GetField(), and NULL.

Referenced by LIB_EDIT_FRAME::DisplayCmpDoc(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), EE_INSPECTION_TOOL::ShowDatasheet(), LIB_VIEW_FRAME::SyncToolbars(), and DIALOG_UPDATE_FIELDS::updateFields().

◆ GetDateLastEdition()

timestamp_t LIB_PART::GetDateLastEdition ( ) const
inline

Definition at line 193 of file class_libentry.h.

193 { return m_dateLastEdition; }
timestamp_t m_dateLastEdition
Date of the last modification.

References m_dateLastEdition.

Referenced by SCH_LEGACY_PLUGIN_CACHE::SaveSymbol().

◆ GetDescription()

◆ GetDrawItems()

LIB_ITEMS_CONTAINER& LIB_PART::GetDrawItems ( )
inline

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 237 of file base_struct.h.

238  {
239  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
241 
242  return m_Flags & mask;
243  }
#define IS_NEW
New item, just created.
Definition: base_struct.h:117
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:119
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:121
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:118
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
Definition: base_struct.h:130
#define IS_MOVED
Item being moved.
Definition: base_struct.h:116

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_PASTED, IS_RESIZED, IS_WIRE_IMAGE, EDA_ITEM::m_Flags, and STRUCT_DELETED.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditWithLibEdit(), SCH_COMPONENT::GetMsgPanelInfo(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_EDIT_PIN::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ GetField()

LIB_FIELD * LIB_PART::GetField ( 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 866 of file class_libentry.cpp.

867 {
868  for( const LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
869  {
870  LIB_FIELD* field = ( LIB_FIELD* ) &item;
871 
872  if( field->GetId() == aId )
873  return field;
874  }
875 
876  return NULL;
877 }
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
int GetId() const
Definition: lib_field.h:138
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
#define NULL

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

Referenced by LIB_EDIT_FRAME::CreateNewPart(), Flatten(), GetDatasheetField(), GetFields(), GetFootprintField(), GetReferenceField(), GetValueField(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), and DIALOG_CHOOSE_COMPONENT::ShowFootprintFor().

◆ GetFields()

void LIB_PART::GetFields ( LIB_FIELDS aList)

Return a list of fields within this part.

Parameters
aList- List to add fields to

Definition at line 837 of file class_libentry.cpp.

838 {
839  LIB_FIELD* field;
840 
841  // Grab the MANDATORY_FIELDS first, in expected order given by
842  // enum NumFieldType
843  for( int id=0; id<MANDATORY_FIELDS; ++id )
844  {
845  field = GetField( id );
846 
847  // the MANDATORY_FIELDS are exactly that in RAM.
848  wxASSERT( field );
849 
850  aList.push_back( *field );
851  }
852 
853  // Now grab all the rest of fields.
854  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
855  {
856  field = ( LIB_FIELD* ) &item;
857 
858  if( field->IsMandatory() )
859  continue; // was added above
860 
861  aList.push_back( *field );
862  }
863 }
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
LIB_FIELD * GetField(int aId) const
Return pointer to the requested field.
bool IsMandatory() const
Definition: lib_field.cpp:456

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

Referenced by SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataToWindow().

◆ GetFlags()

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in DRAWSEGMENT, and TRACK.

Definition at line 344 of file base_struct.h.

344 { return GetPosition(); }
virtual const wxPoint GetPosition() const
Definition: base_struct.h:337

References EDA_ITEM::GetPosition().

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

◆ GetFootprintField()

LIB_FIELD & LIB_PART::GetFootprintField ( )

Return reference to the footprint field.

Definition at line 920 of file class_libentry.cpp.

921 {
922  LIB_FIELD* field = GetField( FOOTPRINT );
923  wxASSERT( field != NULL );
924  return *field;
925 }
Field object used in symbol libraries.
Definition: lib_field.h:59
Field Name Module PCB, i.e. "16DIP300".
#define NULL
LIB_FIELD * GetField(int aId) const
Return pointer to the requested field.

References FOOTPRINT, GetField(), and NULL.

Referenced by GetSearchText().

◆ GetFootprints()

wxArrayString LIB_PART::GetFootprints ( ) const
inline

Definition at line 195 of file class_libentry.h.

195 { return m_FootprintList; }
wxArrayString m_FootprintList
List of suitable footprint names for the part (wild card names accepted).

References m_FootprintList.

Referenced by DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_SEXPR_PLUGIN_CACHE::saveDcmInfoAsFields(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataToWindow().

◆ GetKeyWords()

wxString LIB_PART::GetKeyWords ( ) const
inline

◆ GetLib()

PART_LIB* LIB_PART::GetLib ( )
inline

Definition at line 190 of file class_libentry.h.

190 { return m_library; }
PART_LIB * m_library
Library the part belongs to if any.

References m_library.

Referenced by LIB_MANAGER::LIB_BUFFER::CreateBuffer(), and PART_LIB::FindPart().

◆ GetLibId()

◆ GetLibNickname()

wxString LIB_PART::GetLibNickname ( ) const
inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 164 of file class_libentry.h.

164 { return GetLibraryName(); }
const wxString GetLibraryName() const

References GetLibraryName().

◆ GetLibraryName()

const wxString LIB_PART::GetLibraryName ( ) const

Definition at line 388 of file class_libentry.cpp.

389 {
390  if( m_library )
391  return m_library->GetName();
392 
393  return m_libId.GetLibNickname();
394 }
const wxString GetName() const
Return the file name without path or extension.
PART_LIB * m_library
Library the part belongs to if any.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
LIB_ID m_libId

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

Referenced by GetLibNickname().

◆ GetMenuImage()

BITMAP_DEF EDA_ITEM::GetMenuImage ( ) const
virtualinherited

Function GetMenuImage returns a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns
The menu image associated with the item.

Reimplemented in ZONE_CONTAINER, SCH_COMPONENT, MODULE, SCH_SHEET, D_PAD, SCH_HIERLABEL, LIB_PIN, VIA, SCH_GLOBALLABEL, SCH_LABEL, SCH_TEXT, GERBER_DRAW_ITEM, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, TRACK, SCH_BUS_BUS_ENTRY, SCH_LINE, SCH_SHEET_PIN, LIB_FIELD, SCH_FIELD, SCH_BUS_WIRE_ENTRY, EDGE_MODULE, SCH_BITMAP, LIB_ARC, TEXTE_PCB, LIB_POLYLINE, SCH_NO_CONNECT, LIB_TEXT, SCH_MARKER, PCB_TARGET, SCH_JUNCTION, MARKER_PCB, LIB_CIRCLE, and LIB_RECTANGLE.

Definition at line 233 of file base_struct.cpp.

234 {
235  return dummy_xpm;
236 }
static const BITMAP_OPAQUE dummy_xpm[1]
Definition: base_struct.cpp:54

References dummy_xpm.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), and SELECTION_TOOL::doSelectionMenu().

◆ GetMsgPanelInfo()

virtual void EDA_ITEM::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
inlinevirtualinherited

◆ GetName()

wxString LIB_PART::GetName ( void  ) const
inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 159 of file class_libentry.h.

159 { return m_name; }
wxString m_name
Symbol name.

References m_name.

Referenced by SCH_SEXPR_PLUGIN_CACHE::AddSymbol(), SCH_LEGACY_PLUGIN_CACHE::AddSymbol(), LIB_EDIT_FRAME::DisplayCmpDoc(), LIB_EDIT_FRAME::DuplicatePart(), LIB_EDIT_TOOL::editSymbolProperties(), LIB_EDIT_FRAME::ensureUniqueName(), LIB_EDIT_FRAME::ExportPart(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), LIB_MANAGER::GetBufferedPart(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_LEGACY_PLUGIN_CACHE::Load(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), LIB_EDIT_FRAME::LoadOneLibraryPartAux(), operator<(), SCH_SEXPR_PARSER::ParseLib(), PART_LIB::RemovePart(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PART_LIB::ReplacePart(), LIB_MANAGER::LIB_BUFFER::SaveBuffer(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), LIB_EDIT_FRAME::SetCurPart(), FOOTPRINT_INFO_GENERATOR::SetHtmlName(), LIB_EDIT_FRAME::SyncLibraries(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataToWindow(), LIB_EDIT_FRAME::UpdateAfterSymbolProperties(), DIALOG_UPDATE_FIELDS::updateFields(), FP_TREE_SYNCHRONIZING_ADAPTER::updateLibrary(), LIB_MANAGER::UpdatePart(), LIB_MANAGER::UpdatePartAfterRename(), and LIB_VIEW_FRAME::updatePreviewSymbol().

◆ GetNextDrawItem()

LIB_ITEM * LIB_PART::GetNextDrawItem ( LIB_ITEM aItem = NULL,
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 614 of file class_libentry.cpp.

615 {
616  if( aItem == NULL )
617  {
619 
620  return (it1 != m_drawings.end( aType ) ) ? &( *( m_drawings.begin( aType ) ) ) : nullptr;
621  }
622 
623  // Search for the last item, assume aItem is of type aType
624  wxASSERT( ( aType == TYPE_NOT_INIT ) || ( aType == aItem->Type() ) );
626 
627  while( ( it != m_drawings.end( aType ) ) && ( aItem != &( *it ) ) )
628  ++it;
629 
630  // Search the next item
631  if( it != m_drawings.end( aType ) )
632  {
633  ++it;
634 
635  if( it != m_drawings.end( aType ) )
636  return &( *it );
637  }
638 
639  return NULL;
640 }
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:183
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:189
#define NULL
ITERATOR_BASE< LIB_ITEM, MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::iterator > ITERATOR
The non-const iterator
Definition: multivector.h:160
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

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

Referenced by BOOST_AUTO_TEST_CASE(), and GetNextPin().

◆ GetNextPin()

LIB_PIN* LIB_PART::GetNextPin ( LIB_PIN aItem = NULL)
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 370 of file class_libentry.h.

371  {
372  return (LIB_PIN*) GetNextDrawItem( (LIB_ITEM*) aItem, LIB_PIN_T );
373  }
LIB_ITEM * GetNextDrawItem(LIB_ITEM *aItem=NULL, KICAD_T aType=TYPE_NOT_INIT)
Return the next draw object pointer.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61

References GetNextDrawItem(), and LIB_PIN_T.

Referenced by LIB_EDIT_TOOL::DoDelete(), LIB_MOVE_TOOL::Main(), LIB_PIN_TOOL::PlacePin(), LIB_PIN_TOOL::PushPinProperties(), LIB_PIN::SetConversion(), LIB_PIN::SetPartNumber(), DIALOG_LIB_EDIT_PIN_TABLE::TransferDataFromWindow(), and DIALOG_LIB_EDIT_PIN_TABLE::TransferDataToWindow().

◆ GetParent() [1/2]

◆ GetParent() [2/2]

◆ GetPin()

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

Return pin object with the requested pin aNumber.

Parameters
aNumber- Number of the pin to find.
aUnit- Unit of the part 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 666 of file class_libentry.cpp.

667 {
668  LIB_PINS pinList;
669 
670  GetPins( pinList, aUnit, aConvert );
671 
672  for( size_t i = 0; i < pinList.size(); i++ )
673  {
674  wxASSERT( pinList[i]->Type() == LIB_PIN_T );
675 
676  if( aNumber == pinList[i]->GetNumber() )
677  return pinList[i];
678  }
679 
680  return NULL;
681 }
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:55
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
#define NULL
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

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

◆ GetPinCount()

size_t LIB_PART::GetPinCount ( ) const
inline

Definition at line 359 of file class_libentry.h.

359 { return m_drawings.size( LIB_PIN_T ); }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
size_t size(int aType=UNDEFINED_TYPE) const
Definition: multivector.h:220

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

◆ GetPinNameOffset()

◆ GetPins()

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

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

Note pin objects are owned by the draw list of the part. 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 part unit.
aConvert- Convert number of pin to add to list. Set to 0 to get pins from any convert of part.

Definition at line 643 of file class_libentry.cpp.

644 {
645  /* Notes:
646  * when aUnit == 0: no unit filtering
647  * when aConvert == 0: no convert (shape selection) filtering
648  * when .m_Unit == 0, the body item is common to units
649  * when .m_Convert == 0, the body item is common to shapes
650  */
651  for( LIB_ITEM& item : m_drawings[ LIB_PIN_T ] )
652  {
653  // Unit filtering:
654  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
655  continue;
656 
657  // Shape filtering:
658  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
659  continue;
660 
661  aList.push_back( (LIB_PIN*) &item );
662  }
663 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61

References LIB_PIN_T, and m_drawings.

Referenced by EE_INSPECTION_TOOL::checkPart(), KIGFX::SCH_PAINTER::draw(), LIB_PIN::EnableEditMode(), GetPin(), PinsConflictWith(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), LIB_PIN::SetLength(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), LIB_PIN::SetType(), and LIB_PIN::SetVisible().

◆ GetPosition()

virtual const wxPoint EDA_ITEM::GetPosition ( ) const
inlinevirtualinherited

Reimplemented in SCH_COMPONENT, SCH_SHEET, LIB_PIN, VIA, WS_DRAW_ITEM_BITMAP, SCH_TEXT, BOARD, WS_DRAW_ITEM_TEXT, ARC, WS_DRAW_ITEM_PAGE, WS_DRAW_ITEM_RECT, SCH_LINE, MODULE, GERBER_DRAW_ITEM, SCH_FIELD, LIB_FIELD, WS_DRAW_ITEM_POLYPOLYGONS, D_PAD, SCH_BITMAP, WS_DRAW_ITEM_LINE, DRAWSEGMENT, SCH_BUS_ENTRY_BASE, DIMENSION, SCH_NO_CONNECT, TRACK, KIGFX::ORIGIN_VIEWITEM, NETINFO_ITEM, SCH_MARKER, SCH_JUNCTION, TEXTE_MODULE, LIB_POLYLINE, LIB_ARC, ZONE_CONTAINER, LIB_TEXT, SCH_PIN, LIB_BEZIER, TEXTE_PCB, LIB_RECTANGLE, LIB_CIRCLE, MARKER_PCB, and PCB_TARGET.

Definition at line 337 of file base_struct.h.

337 { return wxPoint(); }

Referenced by GRID_HELPER::computeAnchors(), SCH_EDIT_FRAME::DeleteJunction(), KIGFX::PCB_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckNoConnects(), SELECTION_TOOL::findCallback(), GERBVIEW_SELECTION::GetCenter(), BOARD_ITEM::GetCenter(), EDA_ITEM::GetFocusPosition(), SCH_FIELD::GetParentPosition(), POSITION_RELATIVE_TOOL::GetSelectionAnchorPosition(), SCH_SCREEN::GetSheets(), PCBNEW_SELECTION::GetTopLeftItem(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), LIB_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_ITEM::operator<(), PL_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), PCBNEW_CONTROL::placeBoardItems(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), SELECTION_TOOL::selectConnectedTracks(), RC_ITEM::ShowReport(), DRC::testDisabledLayers(), TransformItem(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), LIB_MOVE_TOOL::updateModificationPoint(), PL_EDIT_TOOL::updateModificationPoint(), and EE_POINT_EDITOR::updatePoints().

◆ GetReferenceField()

LIB_FIELD & LIB_PART::GetReferenceField ( )

Return reference to the reference designator field.

Definition at line 912 of file class_libentry.cpp.

913 {
914  LIB_FIELD* field = GetField( REFERENCE );
915  wxASSERT( field != NULL );
916  return *field;
917 }
Field object used in symbol libraries.
Definition: lib_field.h:59
Field Reference of part, i.e. "IC21".
#define NULL
LIB_FIELD * GetField(int aId) const
Return pointer to the requested field.

References GetField(), NULL, and REFERENCE.

Referenced by LIB_EDIT_FRAME::CreateNewPart(), and SCH_LEGACY_PLUGIN_CACHE::SaveSymbol().

◆ GetSearchText()

wxString LIB_PART::GetSearchText ( )
overridevirtual

Reimplemented from LIB_TREE_ITEM.

Definition at line 55 of file class_libentry.cpp.

56 {
57  // Matches are scored by offset from front of string, so inclusion of this spacer
58  // discounts matches found after it.
59  static const wxString discount( wxT( " " ) );
60 
61  wxString text = GetKeyWords() + discount + GetDescription();
62  wxString footprint = GetFootprintField().GetText();
63 
64  if( !footprint.IsEmpty() )
65  {
66  text += discount + footprint;
67  }
68 
69  return text;
70 }
LIB_FIELD & GetFootprintField()
Return reference to the footprint field.
wxString GetKeyWords() const
wxString GetDescription() override
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:126

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

◆ GetSelectMenuText()

wxString EDA_ITEM::GetSelectMenuText ( EDA_UNITS  aUnits) const
virtualinherited

Function GetSelectMenuText returns 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_CONTAINER, SCH_COMPONENT, BOARD, MODULE, SCH_SHEET, D_PAD, SCH_HIERLABEL, LIB_PIN, VIA, SCH_GLOBALLABEL, SCH_LABEL, WS_DRAW_ITEM_BITMAP, SCH_TEXT, WS_DRAW_ITEM_TEXT, GERBER_DRAW_ITEM, DRAWSEGMENT, WS_DRAW_ITEM_PAGE, DIMENSION, WS_DRAW_ITEM_RECT, TEXTE_MODULE, TRACK, SCH_BUS_BUS_ENTRY, SCH_LINE, SCH_SHEET_PIN, LIB_FIELD, SCH_FIELD, WS_DRAW_ITEM_POLYPOLYGONS, SCH_BUS_WIRE_ENTRY, WS_DRAW_ITEM_LINE, EDGE_MODULE, LIB_ARC, SCH_BITMAP, TEXTE_PCB, LIB_POLYLINE, SCH_NO_CONNECT, LIB_TEXT, PCB_TARGET, SCH_MARKER, MARKER_PCB, LIB_CIRCLE, LIB_RECTANGLE, SCH_JUNCTION, SCH_PIN, DELETED_BOARD_ITEM, and DELETED_SHEET_ITEM.

Definition at line 134 of file base_struct.cpp.

135 {
136  wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
137  GetClass() );
138 
139  return wxString( wxT( "Undefined menu text for " ) + GetClass() );
140 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.

References EDA_ITEM::GetClass().

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), MARKER_PCB::GetMsgPanelInfo(), RC_TREE_MODEL::GetValue(), DRC_ITEM::ShowHtml(), RC_ITEM::ShowReport(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 216 of file base_struct.h.

217  {
218  return m_Status & type;
219  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by TRACK::GetMsgPanelInfoBase_Common(), and TRACK::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 229 of file base_struct.h.

229 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ GetSubpartFirstId()

static int LIB_PART::GetSubpartFirstId ( )
inlinestatic

Definition at line 517 of file class_libentry.h.

517 { return m_subpartFirstId; }
static int m_subpartFirstId
the ASCII char value to calculate the subpart symbol id from the part number: only 'A',...

References m_subpartFirstId.

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

◆ GetSubpartIdSeparator()

static int LIB_PART::GetSubpartIdSeparator ( )
inlinestatic

Definition at line 511 of file class_libentry.h.

511 { return m_subpartIdSeparator; }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...

References m_subpartIdSeparator.

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

◆ GetUniqueUnits()

std::vector< struct PART_UNITS > LIB_PART::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 1210 of file class_libentry.cpp.

1211 {
1212  int unitNum;
1213  size_t i;
1214  struct PART_UNITS unit;
1215  std::vector<LIB_ITEM*> compareDrawItems;
1216  std::vector<LIB_ITEM*> currentDrawItems;
1217  std::vector<struct PART_UNITS> uniqueUnits;
1218 
1219  // The first unit is guarenteed to be unique so always include it.
1220  unit.m_unit = 1;
1221  unit.m_convert = 1;
1222  unit.m_items = GetUnitItems( 1, 1 );
1223 
1224  // There are no unique units if there are no draw items other than fields.
1225  if( unit.m_items.size() == 0 )
1226  return uniqueUnits;
1227 
1228  uniqueUnits.emplace_back( unit );
1229 
1230  if( ( GetUnitCount() == 1 || UnitsLocked() ) && !HasConversion() )
1231  return uniqueUnits;
1232 
1233  currentDrawItems = unit.m_items;
1234 
1235  for( unitNum = 2; unitNum <= GetUnitCount(); unitNum++ )
1236  {
1237  compareDrawItems = GetUnitItems( unitNum, 1 );
1238 
1239  wxCHECK2_MSG( compareDrawItems.size() != 0, continue,
1240  "Multiple unit symbol defined with empty units." );
1241 
1242  if( currentDrawItems.size() != compareDrawItems.size() )
1243  {
1244  unit.m_unit = unitNum;
1245  unit.m_convert = 1;
1246  unit.m_items = compareDrawItems;
1247  uniqueUnits.emplace_back( unit );
1248  }
1249  else
1250  {
1251  for( i = 0; i < currentDrawItems.size(); i++ )
1252  {
1253  if( currentDrawItems[i]->compare( *compareDrawItems[i],
1255  {
1256  unit.m_unit = unitNum;
1257  unit.m_convert = 1;
1258  unit.m_items = compareDrawItems;
1259  uniqueUnits.emplace_back( unit );
1260  }
1261  }
1262  }
1263  }
1264 
1265  if( HasConversion() )
1266  {
1267  currentDrawItems = GetUnitItems( 1, 2 );
1268 
1269  if( ( GetUnitCount() == 1 || UnitsLocked() ) )
1270  {
1271  unit.m_unit = 1;
1272  unit.m_convert = 2;
1273  unit.m_items = currentDrawItems;
1274  uniqueUnits.emplace_back( unit );
1275 
1276  return uniqueUnits;
1277  }
1278 
1279  for( unitNum = 2; unitNum <= GetUnitCount(); unitNum++ )
1280  {
1281  compareDrawItems = GetUnitItems( unitNum, 2 );
1282 
1283  wxCHECK2_MSG( compareDrawItems.size() != 0, continue,
1284  "Multiple unit symbol defined with empty units." );
1285 
1286  if( currentDrawItems.size() != compareDrawItems.size() )
1287  {
1288  unit.m_unit = unitNum;
1289  unit.m_convert = 2;
1290  unit.m_items = compareDrawItems;
1291  uniqueUnits.emplace_back( unit );
1292  }
1293  else
1294  {
1295  for( i = 0; i < currentDrawItems.size(); i++ )
1296  {
1297  if( currentDrawItems[i]->compare( *compareDrawItems[i],
1299  {
1300  unit.m_unit = unitNum;
1301  unit.m_convert = 2;
1302  unit.m_items = compareDrawItems;
1303  uniqueUnits.emplace_back( unit );
1304  }
1305  }
1306  }
1307  }
1308  }
1309 
1310  return uniqueUnits;
1311 }
#define UNIT
bool HasConversion() const
Test if part has more than one body conversion type (DeMorgan).
int m_unit
The unit number.
std::vector< LIB_ITEM * > GetUnitItems(int aUnit, int aConvert)
Return a list of item pointers for aUnit and aConvert for this symbol.
int GetUnitCount() const override
For items with units, return the number of units.
bool UnitsLocked() const
Check whether part units are interchangeable.

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

◆ GetUnitBoundingBox()

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

Get the bounding box for the symbol.

Returns
the part 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 751 of file class_libentry.cpp.

752 {
753  EDA_RECT bBox;
754  bool initialized = false;
755 
756  for( const LIB_ITEM& item : m_drawings )
757  {
758  if( ( item.m_Unit > 0 ) && ( ( m_unitCount > 1 ) && ( aUnit > 0 )
759  && ( aUnit != item.m_Unit ) ) )
760  continue;
761 
762  if( item.m_Convert > 0 && ( ( aConvert > 0 ) && ( aConvert != item.m_Convert ) ) )
763  continue;
764 
765  if ( ( item.Type() == LIB_FIELD_T ) && !( ( LIB_FIELD& ) item ).IsVisible() )
766  continue;
767 
768  if( initialized )
769  bBox.Merge( item.GetBoundingBox() );
770  else
771  {
772  bBox = item.GetBoundingBox();
773  initialized = true;
774  }
775  }
776 
777  return bBox;
778 }
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect.
int m_unitCount
Number of units (parts) per package.
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

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

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

◆ GetUnitCount()

int LIB_PART::GetUnitCount ( ) const
overridevirtual

◆ GetUnitDrawItems()

std::vector< struct PART_UNITS > LIB_PART::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 1175 of file class_libentry.cpp.

1176 {
1177  std::vector<struct PART_UNITS> units;
1178 
1179  for( LIB_ITEM& item : m_drawings )
1180  {
1181  if( item.Type() == LIB_FIELD_T )
1182  continue;
1183 
1184  int unit = item.GetUnit();
1185  int convert = item.GetConvert();
1186 
1187  auto it = std::find_if( units.begin(), units.end(),
1188  [unit, convert] ( const auto& a ) {
1189  return a.m_unit == unit && a.m_convert == convert;
1190  } );
1191 
1192  if( it == units.end() )
1193  {
1194  struct PART_UNITS newUnit;
1195  newUnit.m_unit = item.GetUnit();
1196  newUnit.m_convert = item.GetConvert();
1197  newUnit.m_items.push_back( &item );
1198  units.emplace_back( newUnit );
1199  }
1200  else
1201  {
1202  it->m_items.push_back( &item );
1203  }
1204  }
1205 
1206  return units;
1207 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
int m_unit
The unit number.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61

References LIB_FIELD_T, PART_UNITS::m_convert, m_drawings, PART_UNITS::m_items, and PART_UNITS::m_unit.

Referenced by SCH_SEXPR_PLUGIN_CACHE::SaveSymbol().

◆ GetUnitItems()

std::vector< LIB_ITEM * > LIB_PART::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 1156 of file class_libentry.cpp.

1157 {
1158  std::vector<LIB_ITEM*> unitItems;
1159 
1160  for( LIB_ITEM& item : m_drawings )
1161  {
1162  if( item.Type() == LIB_FIELD_T )
1163  continue;
1164 
1165  if( ( aConvert == -1 && item.GetUnit() == aUnit )
1166  || ( aUnit == -1 && item.GetConvert() == aConvert )
1167  || ( aUnit == item.GetUnit() && aConvert == item.GetConvert() ) )
1168  unitItems.push_back( &item );
1169  }
1170 
1171  return unitItems;
1172 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61

References LIB_FIELD_T, and m_drawings.

Referenced by GetUniqueUnits().

◆ GetUnitReference()

wxString LIB_PART::GetUnitReference ( int  aUnit)
overridevirtual

Return an identifier for aUnit for symbols with units.

Reimplemented from LIB_TREE_ITEM.

Definition at line 295 of file class_libentry.cpp.

296 {
297  return LIB_PART::SubReference( aUnit, false );
298 }
static wxString SubReference(int aUnit, bool aAddSeparator=true)

References SubReference().

◆ GetValueField()

LIB_FIELD & LIB_PART::GetValueField ( )

Return reference to the value field.

Definition at line 904 of file class_libentry.cpp.

905 {
906  LIB_FIELD* field = GetField( VALUE );
907  wxASSERT( field != NULL );
908  return *field;
909 }
Field object used in symbol libraries.
Definition: lib_field.h:59
#define VALUE
#define NULL
LIB_FIELD * GetField(int aId) const
Return pointer to the requested field.

References GetField(), NULL, and VALUE.

Referenced by SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), and SetName().

◆ HasConversion()

bool LIB_PART::HasConversion ( ) const

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

Returns
True if part has more than one conversion.

Definition at line 949 of file class_libentry.cpp.

950 {
951  for( const LIB_ITEM& item : m_drawings )
952  {
953  if( item.m_Convert > LIB_ITEM::LIB_CONVERT::BASE )
954  return true;
955  }
956 
957  if( PART_SPTR parent = m_parent.lock() )
958  {
959  for( const LIB_ITEM& item : parent->GetDrawItems() )
960  {
961  if( item.m_Convert > LIB_ITEM::LIB_CONVERT::BASE )
962  return true;
963  }
964  }
965 
966  return false;
967 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
PART_REF m_parent
Use for inherited symbols.
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART

References m_drawings, and m_parent.

Referenced by EE_INSPECTION_TOOL::checkPart(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), GetUniqueUnits(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnBrowseLibrary(), LIB_EDIT_FRAME::RollbackPartFromUndo(), SetConversion(), LIB_VIEW_FRAME::SyncToolbars(), DIALOG_LIB_EDIT_DRAW_ITEM::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataToWindow(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::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

Function HitTest tests 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_COMPONENT, SCH_SHEET, D_PAD, MODULE, VIA, ZONE_CONTAINER, WS_DRAW_ITEM_BITMAP, SCH_TEXT, ARC, WS_DRAW_ITEM_TEXT, GERBER_DRAW_ITEM, DRAWSEGMENT, DIMENSION, SCH_LINE, TEXTE_MODULE, LIB_ITEM, SCH_FIELD, TRACK, WS_DRAW_ITEM_POLYPOLYGONS, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_NO_CONNECT, TEXTE_PCB, SCH_JUNCTION, WS_DRAW_ITEM_BASE, PCB_TARGET, LIB_POLYLINE, LIB_ARC, LIB_BEZIER, LIB_TEXT, and LIB_CIRCLE.

Definition at line 321 of file base_struct.h.

322  {
323  return false; // derived classes should override this function
324  }

◆ IsAlias()

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 201 of file base_struct.h.

201 { return m_Flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:119
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References IS_DRAGGED, and EDA_ITEM::m_Flags.

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), and KIGFX::SCH_PAINTER::setDeviceColors().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 286 of file base_struct.h.

286 { return m_forceVisible; }
bool m_forceVisible
Definition: base_struct.h:175

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 198 of file base_struct.h.

198 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:113
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

◆ IsMulti()

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

Definition at line 498 of file class_libentry.h.

498 { return m_unitCount > 1; }
int m_unitCount
Number of units (parts) per package.

References m_unitCount.

Referenced by SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), LIB_EDIT_FRAME::SetCurPart(), LIB_EDIT_FRAME::SynchronizePins(), and LIB_EDIT_FRAME::SyncToolbars().

◆ IsNew()

◆ IsNormal()

bool LIB_PART::IsNormal ( ) const
inline

Definition at line 233 of file class_libentry.h.

233 { return m_options == ENTRY_NORMAL; }
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)

References ENTRY_NORMAL, and m_options.

◆ IsPower()

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

Function IsReplaceable.

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_COMPONENT, SCH_SHEET, SCH_LABEL, SCH_TEXT, SCH_SHEET_PIN, and SCH_FIELD.

Definition at line 501 of file base_struct.h.

501 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 204 of file base_struct.h.

204 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:118

References IS_RESIZED, and EDA_ITEM::m_Flags.

Referenced by KIGFX::SCH_PAINTER::setDeviceColors().

◆ IsRoot()

◆ IsSelected()

◆ IsType()

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

Function IsType Checks 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 SCH_LABEL, VIA, DIMENSION, D_PAD, DRAWSEGMENT, TEXTE_MODULE, SCH_FIELD, SCH_LINE, EDGE_MODULE, and TEXTE_PCB.

Definition at line 262 of file base_struct.h.

263  {
264  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
265  return true;
266 
267  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
268  {
269  if( m_StructType == *p )
270  return true;
271  }
272 
273  return false;
274  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:170
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78

References EOT, EDA_ITEM::m_StructType, and SCH_LOCATE_ANY_T.

Referenced by GetRule(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), TEXTE_PCB::IsType(), EDGE_MODULE::IsType(), SCH_LINE::IsType(), SCH_FIELD::IsType(), TEXTE_MODULE::IsType(), DRAWSEGMENT::IsType(), D_PAD::IsType(), DIMENSION::IsType(), VIA::IsType(), SCH_LABEL::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 202 of file base_struct.h.

202 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:121
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

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

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

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

Definition at line 383 of file base_struct.h.

387  {
388  for( auto it : aList )
389  {
390  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
392  return SEARCH_RESULT::QUIT;
393  }
394 
396  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...

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

Referenced by GERBER_FILE_IMAGE::Visit(), and BOARD::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

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use std::vector instead

Definition at line 404 of file base_struct.h.

406  {
407  for( auto it : aList )
408  {
409  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
411  return SEARCH_RESULT::QUIT;
412  }
413 
415  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...

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

◆ LocateDrawItem() [1/2]

LIB_ITEM * LIB_PART::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 984 of file class_libentry.cpp.

986 {
987  for( LIB_ITEM& item : m_drawings )
988  {
989  if( ( aUnit && item.m_Unit && ( aUnit != item.m_Unit) )
990  || ( aConvert && item.m_Convert && ( aConvert != item.m_Convert ) )
991  || ( ( item.Type() != aType ) && ( aType != TYPE_NOT_INIT ) ) )
992  continue;
993 
994  if( item.HitTest( aPoint ) )
995  return &item;
996  }
997 
998  return NULL;
999 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
#define NULL

References m_drawings, NULL, and TYPE_NOT_INIT.

Referenced by LocateDrawItem().

◆ LocateDrawItem() [2/2]

LIB_ITEM * LIB_PART::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 1002 of file class_libentry.cpp.

1004 {
1005  /* we use LocateDrawItem( int aUnit, int convert, KICAD_T type, const
1006  * wxPoint& pt ) to search items.
1007  * because this function uses DefaultTransform as orient/mirror matrix
1008  * we temporary copy aTransform in DefaultTransform
1009  */
1010  LIB_ITEM* item;
1011  TRANSFORM transform = DefaultTransform;
1012  DefaultTransform = aTransform;
1013 
1014  item = LocateDrawItem( aUnit, aConvert, aType, aPoint );
1015 
1016  // Restore matrix
1017  DefaultTransform = transform;
1018 
1019  return item;
1020 }
TRANSFORM DefaultTransform
The base class for drawable items used by schematic library components.
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.

References DefaultTransform, and LocateDrawItem().

◆ LockUnits()

void LIB_PART::LockUnits ( bool  aLockUnits)
inline

Set interchangeable the property for part units.

Parameters
aLockUnitswhen true then units are set as not interchangeable.

Definition at line 242 of file class_libentry.h.

242 { m_unitsLocked = aLockUnits; }
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit.

References m_unitsLocked.

Referenced by BOOST_AUTO_TEST_CASE(), LIB_EDIT_FRAME::CreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

◆ Matches() [1/2]

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

Function Matches compares 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_COMPONENT, SCH_SHEET, SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, LIB_PIN, SCH_PIN, TEXTE_MODULE, SCH_MARKER, MARKER_PCB, and TEXTE_PCB.

Definition at line 457 of file base_struct.h.

458  {
459  return false;
460  }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), TEXTE_PCB::Matches(), MARKER_PCB::Matches(), SCH_MARKER::Matches(), TEXTE_MODULE::Matches(), LIB_PIN::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

◆ Matches() [2/2]

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

Function Matches compares 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 143 of file base_struct.cpp.

144 {
145  wxString text = aText;
146  wxString searchText = aSearchData.GetFindString();
147 
148  // Don't match if searching for replaceable item and the item doesn't support text replace.
149  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
150  return false;
151 
152  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
153  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
154 
155  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
156  {
157  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
158  return text.Matches( searchText );
159 
160  return text.MakeUpper().Matches( searchText.MakeUpper() );
161  }
162 
163  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
164  return aText.Find( searchText ) != wxNOT_FOUND;
165 
166  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
167 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:501

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

◆ operator!=()

bool LIB_PART::operator!= ( const LIB_PART aPart) const
inline

Definition at line 588 of file class_libentry.h.

588 { return Compare( aPart ) != 0; }
int Compare(const LIB_PART &aRhs) const
Comparison test that can be used for operators.

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 197 of file base_struct.cpp.

198 {
199  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
200  GetChars( GetClass() ) ) );
201 
202  return false;
203 }
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:153
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

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

◆ operator=()

const LIB_PART & LIB_PART::operator= ( const LIB_PART aPart)

Definition at line 169 of file class_libentry.cpp.

170 {
171  if( &aPart == this )
172  return aPart;
173 
174  LIB_ITEM* newItem;
175 
176  m_library = aPart.m_library;
177  m_name = aPart.m_name;
178  m_FootprintList = wxArrayString( aPart.m_FootprintList );
179  m_unitCount = aPart.m_unitCount;
185  m_options = aPart.m_options;
186  m_libId = aPart.m_libId;
188  m_keyWords = aPart.m_keyWords;
189 
190  m_drawings.clear();
191 
192  for( const LIB_ITEM& oldItem : aPart.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  PART_SPTR parent = aPart.m_parent.lock();
203 
204  if( parent )
205  SetParent( parent.get() );
206 
207  return *this;
208 }
timestamp_t m_dateLastEdition
Date of the last modification.
bool m_showPinNumbers
Determines if part pin numbers are visible.
int m_unitCount
Number of units (parts) per package.
PART_LIB * m_library
Library the part belongs to if any.
void clear(int aType=UNDEFINED_TYPE)
Definition: multivector.h:207
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit.
virtual void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:196
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
#define IS_NEW
New item, just created.
Definition: base_struct.h:117
int m_pinNameOffset
The offset in mils to draw the pin name.
PART_REF m_parent
Use for inherited symbols.
wxString m_name
Symbol name.
void push_back(T *aItem)
Definition: multivector.h:169
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
void SetParent(LIB_PART *aParent=nullptr)
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
wxArrayString m_FootprintList
List of suitable footprint names for the part (wild card names accepted).
LIB_ID m_libId
wxString m_keyWords
keyword list (used for search for parts by keyword)
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:234
bool m_showPinNames
Determines if part pin names are visible.
wxString m_description
documentation for info

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::clear(), EDA_ITEM::Clone(), EDA_ITEM::GetFlags(), IS_NEW, m_dateLastEdition, m_description, m_drawings, m_FootprintList, m_keyWords, 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(), SetParent(), EDA_ITEM::SetParent(), and STRUCT_DELETED.

◆ operator==() [1/2]

bool LIB_PART::operator== ( const LIB_PART aPart) const
inline

Definition at line 586 of file class_libentry.h.

586 { return this == aPart; }

◆ operator==() [2/2]

bool LIB_PART::operator== ( const LIB_PART aPart) const
inline

Definition at line 587 of file class_libentry.h.

587 { return Compare( aPart ) == 0; }
int Compare(const LIB_PART &aRhs) const
Comparison test that can be used for operators.

References Compare().

◆ PinsConflictWith()

bool LIB_PART::PinsConflictWith ( LIB_PART aOtherPart,
bool  aTestNums,
bool  aTestNames,
bool  aTestType,
bool  aTestOrientation,
bool  aTestLength 
)

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

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

Parameters
aOtherPart- The other library part 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 684 of file class_libentry.cpp.

686 {
687  LIB_PINS thisPinList;
688  GetPins( thisPinList, /* aUnit */ 0, /* aConvert */ 0 );
689 
690  for( LIB_PIN* eachThisPin : thisPinList )
691  {
692  wxASSERT( eachThisPin );
693  LIB_PINS otherPinList;
694  aOtherPart.GetPins( otherPinList, /* aUnit */ 0, /* aConvert */ 0 );
695  bool foundMatch = false;
696 
697  for( LIB_PIN* eachOtherPin : otherPinList )
698  {
699  wxASSERT( eachOtherPin );
700 
701  // Same unit?
702  if( eachThisPin->GetUnit() != eachOtherPin->GetUnit() )
703  continue;
704 
705  // Same body stype?
706  if( eachThisPin->GetConvert() != eachOtherPin->GetConvert() )
707  continue;
708 
709  // Same position?
710  if( eachThisPin->GetPosition() != eachOtherPin->GetPosition() )
711  continue;
712 
713  // Same number?
714  if( aTestNums && ( eachThisPin->GetNumber() != eachOtherPin->GetNumber() ) )
715  continue;
716 
717  // Same name?
718  if( aTestNames && ( eachThisPin->GetName() != eachOtherPin->GetName() ) )
719  continue;
720 
721  // Same electrical type?
722  if( aTestType && ( eachThisPin->GetType() != eachOtherPin->GetType() ) )
723  continue;
724 
725  // Same orientation?
726  if( aTestOrientation
727  && ( eachThisPin->GetOrientation() != eachOtherPin->GetOrientation() ) )
728  continue;
729 
730  // Same length?
731  if( aTestLength && ( eachThisPin->GetLength() != eachOtherPin->GetLength() ) )
732  continue;
733 
734  foundMatch = true;
735  break; // Match found so seach is complete.
736  }
737 
738  if( !foundMatch )
739  {
740  // This means there was not an identical (according to the arguments)
741  // pin at the same position in the other component.
742  return true;
743  }
744  }
745 
746  // The loop never gave up, so no conflicts were found.
747  return false;
748 }
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:55
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.

References GetPins().

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

◆ Plot()

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

Plot lib part 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- Component part to plot.
aConvert- Component alternate body style to plot.
aOffset- Distance to shift the plot coordinates.
aTransform- Component plot transform matrix.

Definition at line 496 of file class_libentry.cpp.

498 {
499  wxASSERT( aPlotter != NULL );
500 
501  aPlotter->SetColor( aPlotter->RenderSettings()->GetLayerColor( LAYER_DEVICE ) );
502  bool fill = aPlotter->GetColorMode();
503 
504  // draw background for filled items using background option
505  // Solid lines will be drawn after the background
506  for( LIB_ITEM& item : m_drawings )
507  {
508  // Lib Fields are not plotted here, because this plot function
509  // is used to plot schematic items, which have they own fields
510  if( item.Type() == LIB_FIELD_T )
511  continue;
512 
513  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
514  continue;
515 
516  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
517  continue;
518 
519  if( item.m_Fill == FILLED_WITH_BG_BODYCOLOR )
520  item.Plot( aPlotter, aOffset, fill, aTransform );
521  }
522 
523  // Not filled items and filled shapes are now plotted
524  // Items that have BG fills only get re-stroked to ensure the edges are in the foreground
525  for( LIB_ITEM& item : m_drawings )
526  {
527  if( item.Type() == LIB_FIELD_T )
528  continue;
529 
530  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
531  continue;
532 
533  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
534  continue;
535 
536  item.Plot( aPlotter, aOffset, fill && ( item.m_Fill != FILLED_WITH_BG_BODYCOLOR ),
537  aTransform );
538  }
539 }
virtual void SetColor(COLOR4D color)=0
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
#define NULL
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:147
bool GetColorMode() const
Definition: plotter.h:144

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

Referenced by LIB_EDIT_FRAME::SVG_PlotComponent().

◆ PlotLibFields()

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

Plot Lib Fields only of the part to plotter.

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

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

Definition at line 542 of file class_libentry.cpp.

544 {
545  wxASSERT( aPlotter != NULL );
546 
547  aPlotter->SetColor( aPlotter->RenderSettings()->GetLayerColor( LAYER_FIELDS ) );
548  bool fill = aPlotter->GetColorMode();
549 
550  for( LIB_ITEM& item : m_drawings )
551  {
552  if( item.Type() != LIB_FIELD_T )
553  continue;
554 
555  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
556  continue;
557 
558  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
559  continue;
560 
561  LIB_FIELD& field = (LIB_FIELD&) item;
562 
563  // The reference is a special case: we should change the basic text
564  // to add '?' and the part id
565  wxString tmp = field.GetShownText();
566 
567  if( field.GetId() == REFERENCE )
568  {
569  wxString text = field.GetFullText( aUnit );
570  field.SetText( text );
571  }
572 
573  item.Plot( aPlotter, aOffset, fill, aTransform );
574  field.SetText( tmp );
575  }
576 }
virtual void SetColor(COLOR4D color)=0
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
int GetId() const
Definition: lib_field.h:138
Field Reference of part, i.e. "IC21".
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:116
#define NULL
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:147
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:298
virtual wxString GetShownText(int aDepth=0) const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:133
bool GetColorMode() const
Definition: plotter.h:144

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

Referenced by LIB_EDIT_FRAME::SVG_PlotComponent().

◆ Print()

void LIB_PART::Print ( RENDER_SETTINGS aSettings,
const wxPoint aOffset,
int  aMulti,
int  aConvert,
const PART_DRAW_OPTIONS aOpts 
)

Print part.

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

Definition at line 429 of file class_libentry.cpp.

431 {
432  /* draw background for filled items using background option
433  * Solid lines will be drawn after the background
434  * Note also, background is not drawn when printing in black and white
435  */
436  if( !GetGRForceBlackPenState() )
437  {
438  for( LIB_ITEM& drawItem : m_drawings )
439  {
440  if( drawItem.m_Fill != FILLED_WITH_BG_BODYCOLOR )
441  continue;
442 
443  // Do not draw items not attached to the current part
444  if( aMulti && drawItem.m_Unit && ( drawItem.m_Unit != aMulti ) )
445  continue;
446 
447  if( aConvert && drawItem.m_Convert && ( drawItem.m_Convert != aConvert ) )
448  continue;
449 
450  if( drawItem.Type() == LIB_FIELD_T )
451  continue;
452 
453  // Now, draw only the background for items with
454  // m_Fill == FILLED_WITH_BG_BODYCOLOR:
455  drawItem.Print( aSettings, aOffset, (void*) false, aOpts.transform );
456  }
457  }
458 
459  for( LIB_ITEM& drawItem : m_drawings )
460  {
461  // Do not draw items not attached to the current part
462  if( aMulti && drawItem.m_Unit && ( drawItem.m_Unit != aMulti ) )
463  continue;
464 
465  if( aConvert && drawItem.m_Convert && ( drawItem.m_Convert != aConvert ) )
466  continue;
467 
468  if( drawItem.Type() == LIB_FIELD_T )
469  {
470  LIB_FIELD& field = static_cast<LIB_FIELD&>( drawItem );
471 
472  if( field.IsVisible() && !aOpts.draw_visible_fields )
473  continue;
474 
475  if( !field.IsVisible() && !aOpts.draw_hidden_fields )
476  continue;
477  }
478 
479  if( drawItem.Type() == LIB_PIN_T )
480  {
481  drawItem.Print( aSettings, aOffset, (void*) &aOpts, aOpts.transform );
482  }
483  else if( drawItem.Type() == LIB_FIELD_T )
484  {
485  drawItem.Print( aSettings, aOffset, (void*) NULL, aOpts.transform );
486  }
487  else
488  {
489  bool forceNoFill = drawItem.m_Fill == FILLED_WITH_BG_BODYCOLOR;
490  drawItem.Print( aSettings, aOffset, (void*) forceNoFill, aOpts.transform );
491  }
492  }
493 }
bool IsVisible() const
Definition: eda_text.h:185
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
#define NULL
bool GetGRForceBlackPenState(void)
Function GetGRForceBlackPenState.
Definition: gr_basic.cpp:211

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

Referenced by SCH_COMPONENT::Print(), and LIB_EDIT_FRAME::PrintPage().

◆ RemoveDrawItem()

void LIB_PART::RemoveDrawItem ( LIB_ITEM aItem)

Remove draw aItem from list.

Parameters
aItem- Draw item to remove from list.

Definition at line 579 of file class_libentry.cpp.

580 {
581  wxASSERT( aItem != NULL );
582 
583  // none of the MANDATORY_FIELDS may be removed in RAM, but they may be
584  // omitted when saving to disk.
585  if( aItem->Type() == LIB_FIELD_T )
586  {
587  if( static_cast<LIB_FIELD*>( aItem )->IsMandatory() )
588  return;
589  }
590 
591  LIB_ITEMS& items = m_drawings[ aItem->Type() ];
592 
593  for( LIB_ITEMS::iterator i = items.begin(); i != items.end(); i++ )
594  {
595  if( *i == aItem )
596  {
597  items.erase( i );
598  SetModified();
599  break;
600  }
601  }
602 }
void SetModified()
Definition: base_struct.cpp:85
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
LIB_ITEMS_CONTAINER::ITEM_PTR_VECTOR LIB_ITEMS
#define NULL
ITERATOR erase(const ITERATOR &aIterator)
Definition: multivector.h:174
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

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

Referenced by BOOST_AUTO_TEST_CASE(), LIB_EDIT_TOOL::DoDelete(), LIB_PIN::SetConversion(), LIB_PIN::SetPartNumber(), and DIALOG_LIB_EDIT_PIN_TABLE::TransferDataFromWindow().

◆ RemoveDuplicateDrawItems()

void LIB_PART::RemoveDuplicateDrawItems ( )

Remove duplicate draw items from list.

Definition at line 943 of file class_libentry.cpp.

944 {
945  m_drawings.unique();
946 }
void unique()
Remove duplicate elements in list.
Definition: multivector.h:251
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.

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

Referenced by LIB_EDIT_FRAME::LoadOneSymbol().

◆ Replace() [1/2]

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

Helper function used in search and replace dialog Function Replace performs 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 170 of file base_struct.cpp.

171 {
172  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
173 
174  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
175  aSearchData.GetFindString() :
176  aSearchData.GetFindString().Upper() );
177 
178  if( result == wxNOT_FOUND )
179  return false;
180 
181  wxString prefix = aText.Left( result );
182  wxString suffix;
183 
184  if( aSearchData.GetFindString().length() + result < aText.length() )
185  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
186 
187  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
188  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
189  GetChars( suffix ) );
190 
191  aText = prefix + aSearchData.GetReplaceString() + suffix;
192 
193  return true;
194 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:153

References GetChars(), and traceFindReplace.

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

◆ Replace() [2/2]

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

Function Replace performs 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_SHEET_PIN, and SCH_FIELD.

Definition at line 489 of file base_struct.h.

489 { return false; }

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

◆ SetConversion()

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

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

If the part 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 part.

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

Definition at line 1095 of file class_libentry.cpp.

1096 {
1097  if( aSetConvert == HasConversion() )
1098  return;
1099 
1100  // Duplicate items to create the converted shape
1101  if( aSetConvert )
1102  {
1103  if( aDuplicatePins )
1104  {
1105  std::vector< LIB_ITEM* > tmp; // Temporarily store the duplicated pins here.
1106 
1107  for( LIB_ITEM& item : m_drawings )
1108  {
1109  // Only pins are duplicated.
1110  if( item.Type() != LIB_PIN_T )
1111  continue;
1112 
1113  if( item.m_Convert == 1 )
1114  {
1115  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1116  newItem->m_Convert = 2;
1117  tmp.push_back( newItem );
1118  }
1119  }
1120 
1121  // Transfer the new pins to the LIB_PART.
1122  for( unsigned i = 0; i < tmp.size(); i++ )
1123  m_drawings.push_back( tmp[i] );
1124  }
1125  }
1126  else
1127  {
1128  // Delete converted shape items because the converted shape does
1129  // not exist
1131 
1132  while( i != m_drawings.end() )
1133  {
1134  if( i->m_Convert > 1 )
1135  i = m_drawings.erase( i );
1136  else
1137  ++i;
1138  }
1139  }
1140 }
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:183
bool HasConversion() const
Test if part has more than one body conversion type (DeMorgan).
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:189
void push_back(T *aItem)
Definition: multivector.h:169
ITERATOR erase(const ITERATOR &aIterator)
Definition: multivector.h:174
ITERATOR_BASE< LIB_ITEM, MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::iterator > ITERATOR
The non-const iterator
Definition: multivector.h:160
int m_Convert
Shape identification for alternate body styles.
Definition: lib_item.h:87

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, and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back().

Referenced by LIB_EDIT_FRAME::CreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

◆ SetDescription()

void LIB_PART::SetDescription ( const wxString &  aDescription)
inline

Definition at line 166 of file class_libentry.h.

167  {
168  m_description = aDescription;
169  }
wxString m_description
documentation for info

References m_description.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

◆ SetFields()

void LIB_PART::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 part field editor, and it establishes needed behavior.

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

Definition at line 822 of file class_libentry.cpp.

823 {
824  deleteAllFields();
825 
826  for( unsigned i=0; i<aFields.size(); ++i )
827  {
828  // drawings is a ptr_vector, new and copy an object on the heap.
829  LIB_FIELD* field = new LIB_FIELD( aFields[i] );
830 
831  field->SetParent( this );
832  m_drawings.push_back( field );
833  }
834 }
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
virtual void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:196
void deleteAllFields()
void push_back(T *aItem)
Definition: multivector.h:169

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

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 232 of file base_struct.h.

232 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), PCBNEW_CONTROL::AppendBoard(), SCH_EDIT_TOOL::ChangeTextType(), GRAPHICS_CLEANER::cleanupSegments(), TRACKS_CLEANER::cleanupSegments(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), LIB_PIN_TOOL::CreatePin(), SCH_EDIT_FRAME::CreateSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), EDIT_POINTS_FACTORY::Make(), TRACKS_CLEANER::mergeCollinearSegments(), LIB_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SELECTION_TOOL::selectConnectedTracks(), EE_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetFootprintFilters()

void LIB_PART::SetFootprintFilters ( const wxArrayString &  aFootprintFilters)
inline

Definition at line 196 of file class_libentry.h.

197  {
198  m_FootprintList = aFootprintFilters;
199  }
wxArrayString m_FootprintList
List of suitable footprint names for the part (wild card names accepted).

References m_FootprintList.

Referenced by BOOST_AUTO_TEST_CASE(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

Function SetForceVisible is used to set and cleag 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 284 of file base_struct.h.

284 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: base_struct.h:175

References EDA_ITEM::m_forceVisible.

◆ SetKeyWords()

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

Definition at line 173 of file class_libentry.h.

174  {
175  m_keyWords = aKeyWords;
176  }
wxString m_keyWords
keyword list (used for search for parts by keyword)

References m_keyWords.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

◆ SetLib()

void LIB_PART::SetLib ( PART_LIB aLibrary)
inline

Definition at line 191 of file class_libentry.h.

191 { m_library = aLibrary; }
PART_LIB * m_library
Library the part belongs to if any.

References m_library.

Referenced by LEGACY_RESCUER::AddPart(), PART_LIB::FindPart(), LIB_PART(), and PART_LIB::LoadLibrary().

◆ SetLibId()

◆ SetModified()

◆ SetName()

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

Definition at line 301 of file class_libentry.cpp.

302 {
303  wxString validatedName = LIB_ID::FixIllegalChars( aName, LIB_ID::ID_SCH );
304 
305  m_name = validatedName;
306  m_libId.SetLibItemName( validatedName, false );
307 
308  GetValueField().SetText( validatedName );
309 }
LIB_FIELD & GetValueField()
Return reference to the value field.
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:116
wxString m_name
Symbol name.
LIB_ID m_libId
int SetLibItemName(const UTF8 &aLibItemName, bool aTestForRev=true)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:206
static UTF8 FixIllegalChars(const UTF8 &aLibItemName, LIB_ID_TYPE aType, bool aLib=false)
Replace illegal LIB_ID item name characters with underscores '_'.
Definition: lib_id.cpp:352

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

Referenced by BOOST_AUTO_TEST_CASE(), LIB_EDIT_TOOL::editFieldProperties(), LIB_EDIT_FRAME::ensureUniqueName(), LIB_PART(), LIB_EDIT_FRAME::savePartAs(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow(), LIB_EDIT_FRAME::UpdateAfterSymbolProperties(), and DIALOG_LIB_EDIT_ONE_FIELD::UpdateField().

◆ SetNormal()

void LIB_PART::SetNormal ( )
inline

Definition at line 236 of file class_libentry.h.

236 { m_options = ENTRY_NORMAL; }
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)

References ENTRY_NORMAL, and m_options.

Referenced by BOOST_AUTO_TEST_CASE(), LIB_EDIT_FRAME::CreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

◆ SetOffset()

void LIB_PART::SetOffset ( const wxPoint aOffset)

Move the part aOffset.

Parameters
aOffset- Offset displacement.

Definition at line 936 of file class_libentry.cpp.

937 {
938  for( LIB_ITEM& item : m_drawings )
939  item.Offset( aOffset );
940 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61

References m_drawings.

Referenced by LIB_DRAWING_TOOLS::PlaceAnchor().

◆ SetParent() [1/3]

virtual void EDA_ITEM::SetParent
inlineprivate

Definition at line 196 of file base_struct.h.

196 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174

◆ SetParent() [2/3]

void LIB_PART::SetParent ( LIB_PART aParent = nullptr)

Definition at line 312 of file class_libentry.cpp.

313 {
314  if( aParent )
315  m_parent = aParent->SharedPtr();
316  else
317  m_parent.reset();
318 }
PART_REF m_parent
Use for inherited symbols.
PART_SPTR SharedPtr()

References m_parent, and SharedPtr().

Referenced by LIB_EDIT_FRAME::CreateNewPart(), LIB_EDIT_FRAME::DuplicatePart(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), LIB_PART(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), operator=(), LIB_MANAGER::LIB_BUFFER::SaveBuffer(), and LIB_MANAGER::SaveLibrary().

◆ SetParent() [3/3]

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Definition at line 196 of file base_struct.h.

196 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174

References EDA_ITEM::m_Parent.

Referenced by MODULE::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), SCH_SHEET::AddPin(), LIB_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), LIB_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), Flatten(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), LIB_PART(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), MODULE::operator=(), operator=(), PCB_PARSER::parseMODULE_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), LIB_EDIT_TOOL::Paste(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteModuleItemsToModEdit(), SCH_DRAWING_TOOLS::PlaceComponent(), PCB_EDITOR_CONTROL::PlaceModule(), 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(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), SwapItemData(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary().

◆ SetPinNameOffset()

void LIB_PART::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 556 of file class_libentry.h.

556 { m_pinNameOffset = aOffset; }
int m_pinNameOffset
The offset in mils to draw the pin name.

References m_pinNameOffset.

Referenced by BOOST_AUTO_TEST_CASE(), LIB_EDIT_FRAME::CreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

◆ SetPower()

void LIB_PART::SetPower ( )
inline

Definition at line 235 of file class_libentry.h.

235 { m_options = ENTRY_POWER; }
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)

References ENTRY_POWER, and m_options.

Referenced by BOOST_AUTO_TEST_CASE(), LIB_EDIT_FRAME::CreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

◆ SetSelected()

◆ SetShowPinNames()

void LIB_PART::SetShowPinNames ( bool  aShow)
inline

Set or clear the pin name visibility flag.

Parameters
aShow- True to make the part pin names visible.

Definition at line 564 of file class_libentry.h.

564 { m_showPinNames = aShow; }
bool m_showPinNames
Determines if part pin names are visible.

References m_showPinNames.

Referenced by BOOST_AUTO_TEST_CASE(), LIB_EDIT_FRAME::CreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

◆ SetShowPinNumbers()

void LIB_PART::SetShowPinNumbers ( bool  aShow)
inline

Set or clear the pin number visibility flag.

Parameters
aShow- True to make the part pin numbers visible.

Definition at line 572 of file class_libentry.h.

572 { m_showPinNumbers = aShow; }
bool m_showPinNumbers
Determines if part pin numbers are visible.

References m_showPinNumbers.

Referenced by BOOST_AUTO_TEST_CASE(), LIB_EDIT_FRAME::CreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

◆ SetState()

void EDA_ITEM::SetState ( int  type,
int  state 
)
inlineinherited

Definition at line 221 of file base_struct.h.

222  {
223  if( state )
224  m_Status |= type; // state = ON or OFF
225  else
226  m_Status &= ~type;
227  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 230 of file base_struct.h.

230 { m_Status = aStatus; }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetSubpartIdNotation()

void LIB_PART::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 part 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 part ('A' or '1')

Definition at line 1143 of file class_libentry.cpp.

1144 {
1145  m_subpartFirstId = 'A';
1147 
1148  if( aSep == '.' || aSep == '-' || aSep == '_' )
1149  m_subpartIdSeparator = aSep;
1150 
1151  if( aFirstId == '1' && aSep != 0 )
1152  m_subpartFirstId = aFirstId;
1153 }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
static int m_subpartFirstId
the ASCII char value to calculate the subpart symbol id from the part number: only 'A',...

References m_subpartFirstId, and m_subpartIdSeparator.

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

◆ SetUnitCount()

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

Set the units per part count.

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

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

Definition at line 1039 of file class_libentry.cpp.

1040 {
1041  if( m_unitCount == aCount )
1042  return;
1043 
1044  if( aCount < m_unitCount )
1045  {
1047 
1048  while( i != m_drawings.end() )
1049  {
1050  if( i->m_Unit > aCount )
1051  i = m_drawings.erase( i );
1052  else
1053  ++i;
1054  }
1055  }
1056  else if( aDuplicateDrawItems )
1057  {
1058  int prevCount = m_unitCount;
1059 
1060  // Temporary storage for new items, as adding new items directly to
1061  // m_drawings may cause the buffer reallocation which invalidates the
1062  // iterators
1063  std::vector< LIB_ITEM* > tmp;
1064 
1065  for( LIB_ITEM& item : m_drawings )
1066  {
1067  if( item.m_Unit != 1 )
1068  continue;
1069 
1070  for( int j = prevCount + 1; j <= aCount; j++ )
1071  {
1072  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1073  newItem->m_Unit = j;
1074  tmp.push_back( newItem );
1075  }
1076  }
1077 
1078  for( auto item : tmp )
1079  m_drawings.push_back( item );
1080  }
1081 
1082  m_unitCount = aCount;
1083 }
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:183
int m_unitCount
Number of units (parts) per package.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
int m_Unit
Unit identification for multiple parts per package.
Definition: lib_item.h:81
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:189
void push_back(T *aItem)
Definition: multivector.h:169
ITERATOR erase(const ITERATOR &aIterator)
Definition: multivector.h:174
ITERATOR_BASE< LIB_ITEM, MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::iterator > ITERATOR
The non-const iterator
Definition: multivector.h:160

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, and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back().

Referenced by BOOST_AUTO_TEST_CASE(), LIB_EDIT_FRAME::CreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 207 of file base_struct.h.

207 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:232
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:121

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ SharedPtr()

PART_SPTR LIB_PART::SharedPtr ( )
inline

Definition at line 141 of file class_libentry.h.

141 { return m_me; }
PART_SPTR m_me
< http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared

References m_me.

Referenced by PART_LIB::AddPart(), SCH_SEXPR_PLUGIN_CACHE::DeleteSymbol(), SCH_LEGACY_PLUGIN_CACHE::DeleteSymbol(), LIB_VIEW_FRAME::GetDocumentExtents(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), and SetParent().

◆ ShowPinNames()

bool LIB_PART::ShowPinNames ( )
inline

◆ ShowPinNumbers()

bool LIB_PART::ShowPinNumbers ( )
inline

◆ Sort()

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

Function Sort is a 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 520 of file base_struct.h.

520 { return *aLeft < *aRight; }

◆ SubpartFirstIdPtr()

static int* LIB_PART::SubpartFirstIdPtr ( )
inlinestatic

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

Definition at line 521 of file class_libentry.h.

521 { return &m_subpartFirstId; }
static int m_subpartFirstId
the ASCII char value to calculate the subpart symbol id from the part number: only 'A',...

References m_subpartFirstId.

Referenced by SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ SubpartIdSeparatorPtr()

static int* LIB_PART::SubpartIdSeparatorPtr ( )
inlinestatic

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

Definition at line 516 of file class_libentry.h.

516 { return &m_subpartIdSeparator; }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...

References m_subpartIdSeparator.

Referenced by SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ SubReference()

wxString LIB_PART::SubReference ( int  aUnit,
bool  aAddSeparator = true 
)
static
Returns
the sub reference for part having multiple units per part. The sub reference identify the part (or unit)
Parameters
aUnit= the part 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 397 of file class_libentry.cpp.

398 {
399  wxString subRef;
400 
401  if( m_subpartIdSeparator != 0 && aAddSeparator )
402  subRef << wxChar( m_subpartIdSeparator );
403 
404  if( m_subpartFirstId >= '0' && m_subpartFirstId <= '9' )
405  subRef << aUnit;
406  else
407  {
408  // use letters as notation. To allow more than 26 units, the sub ref
409  // use one letter if letter = A .. Z or a ... z, and 2 letters otherwise
410  // first letter is expected to be 'A' or 'a' (i.e. 26 letters are available)
411  int u;
412  aUnit -= 1; // Unit number starts to 1. now to 0.
413 
414  while( aUnit >= 26 ) // more than one letter are needed
415  {
416  u = aUnit / 26;
417  subRef << wxChar( m_subpartFirstId + u -1 );
418  aUnit %= 26;
419  }
420 
421  u = m_subpartFirstId + aUnit;
422  subRef << wxChar( u );
423  }
424 
425  return subRef;
426 }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
static int m_subpartFirstId
the ASCII char value to calculate the subpart symbol id from the part number: only 'A',...

References m_subpartFirstId, and m_subpartIdSeparator.

Referenced by SCH_EDIT_FRAME::AnnotateComponents(), SCH_REFERENCE_LIST::CheckAnnotation(), SCH_REFERENCE::GetFullRef(), LIB_FIELD::GetFullText(), SCH_COMPONENT::GetRef(), SCH_FIELD::GetShownText(), GetUnitReference(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_FIELD::Matches(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnBrowseLibrary(), LIB_EDIT_FRAME::RebuildSymbolUnitsList(), SCH_COMPONENT::ResolveTextVar(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), and SYMBOL_UNIT_MENU::update().

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

returns the type of object. This attribute should never be changed after a constructor sets it, so there is no public "setter" method.

Returns
KICAD_T - the type of object.

Definition at line 193 of file base_struct.h.

193 { return m_StructType; }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:170

References EDA_ITEM::m_StructType.

Referenced by MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), 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(), CONNECTION_GRAPH::buildConnectionGraph(), SCH_SCREENS::buildScreenList(), calcArea(), calcMaxArea(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_EDIT_TOOL::ChangeTextType(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), TEXTE_PCB::ClassOf(), MARKER_PCB::ClassOf(), SCH_NO_CONNECT::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), SCH_PIN::ClassOf(), EDGE_MODULE::ClassOf(), SCH_LINE::ClassOf(), PCB_TARGET::ClassOf(), SCH_FIELD::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), ZONE_CONTAINER::ClassOf(), SCH_BITMAP::ClassOf(), D_PAD::ClassOf(), DIMENSION::ClassOf(), TRACK::ClassOf(), NETINFO_ITEM::ClassOf(), SCH_SHEET_PIN::ClassOf(), MODULE::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_SCREEN::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), SCH_TEXT::ClassOf(), SCH_SHEET::ClassOf(), BOARD::ClassOf(), ARC::ClassOf(), SCH_LABEL::ClassOf(), VIA::ClassOf(), SCH_GLOBALLABEL::ClassOf(), SCH_HIERLABEL::ClassOf(), TRACKS_CLEANER::cleanupSegments(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_ITEM::compare(), LIB_PIN::compare(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), DIALOG_TEXT_PROPERTIES::convertKIIDsToReferences(), DIALOG_LABEL_EDITOR::convertKIIDsToReferences(), MODULE::CoverageRatio(), BOARD_ADAPTER::createLayers(), PCB_BASE_FRAME::CreateNewModule(), SCH_DRAWING_TOOLS::createNewText(), BOARD_ADAPTER::createNewTrack(), D_PAD::D_PAD(), SCH_SCREEN::DeleteItem(), 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::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(), DRC::doTrackDrc(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), MODULE::DuplicateItem(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckLabels(), NETLIST_EXPORTER::findNextComponent(), PCB_BASE_FRAME::FocusOnItem(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), TRACK::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetContextualTextVars(), CONNECTION_GRAPH::getDefaultConnection(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), TEXTE_PCB::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), EE_SELECTION_TOOL::GuessSelectionCandidates(), SELECTION_TOOL::GuessSelectionCandidates(), hash_eda(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), highlightNet(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_FIELD::IsReplaceable(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), SELECTION_TOOL::itemPassesFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_FIELD::Matches(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_JUNCTION::operator<(), SCH_BUS_ENTRY_BASE::operator<(), SCH_FIELD::operator<(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_TEXT::operator<(), SCH_ITEM::operator<(), SCH_SHEET::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), SCH_FIELD::Print(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), SCH_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshItem(), SCH_BASE_FRAME::RefreshSelection(), EE_RTREE::remove(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), SCH_SCREEN::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), WS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), DRC_TEXTVAR_TESTER::RunDRC(), 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(), 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(), SELECTION_TOOL::select(), EE_SELECTION_TOOL::Selectable(), SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectConnectedTracks(), 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(), TEXTE_PCB::SwapData(), TRACK::SwapData(), DIMENSION::SwapData(), ARC::SwapData(), SCH_SHEET::SwapData(), VIA::SwapData(), SCH_COMPONENT::SwapData(), D_PAD::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), SwapItemData(), TEXTE_MODULE::TEXTE_MODULE(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), SCH_TEXT::UpdateDanglingState(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), EE_POINT_EDITOR::updateItem(), PL_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), CONNECTION_GRAPH::updateItemConnectivity(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_SHEET::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ UnitsLocked()

bool LIB_PART::UnitsLocked ( ) const
inline

Check whether part units are interchangeable.

Returns
False when interchangeable, true otherwise.

Definition at line 248 of file class_libentry.h.

248 { return m_unitsLocked; }
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit.

References m_unitsLocked.

Referenced by LIB_EDIT_TOOL::editSymbolProperties(), GetUniqueUnits(), SCH_REFERENCE::IsUnitsLocked(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), LIB_EDIT_FRAME::LoadPart(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), LIB_EDIT_FRAME::SetCurPart(), LIB_EDIT_FRAME::SynchronizePins(), LIB_EDIT_FRAME::SyncToolbars(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataToWindow().

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

Function ViewBBox() returns the bounding box of the item covering all its layers.

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

Reimplemented in MODULE, D_PAD, EDIT_POINTS, GERBER_DRAW_ITEM, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, TRACK, ROUTER_PREVIEW_ITEM, MARKER_PCB, KIGFX::WS_PROXY_VIEW_ITEM, MY_DRAWING, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, and BRIGHT_BOX.

Definition at line 218 of file base_struct.cpp.

219 {
220  // Basic fallback
221  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
222  VECTOR2I( GetBoundingBox().GetSize() ) );
223 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:521
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: base_struct.cpp:95

References EDA_ITEM::GetBoundingBox().

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), and BRIGHT_BOX::ViewDraw().

◆ ViewDraw()

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

Function ViewDraw() Draws the parts of the object belonging to layer aLayer.

viewDraw() is an alternative way for drawing objects if 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
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on

Reimplemented in EDIT_POINTS, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::WS_PROXY_VIEW_ITEM, KIGFX::PREVIEW::SELECTION_AREA, MY_DRAWING, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::VIEW_OVERLAY, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, BRIGHT_BOX, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, and PCB_BRIGHT_BOX.

Definition at line 116 of file view_item.h.

117  {}

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

◆ ViewGetLayers()

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

Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on.

For instance, a D_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[]output layer index array
aCountnumber of layer indices in aLayers[]

Reimplemented from EDA_ITEM.

Definition at line 781 of file class_libentry.cpp.

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

◆ ViewGetLOD()

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

Function ViewGetLOD() Returns 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
aLayercurrent drawing layer
aViewpointer 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 MODULE_ZONE_CONTAINER, MODULE, D_PAD, VIA, GERBER_DRAW_ITEM, TEXTE_MODULE, TRACK, and EDGE_MODULE.

Definition at line 140 of file view_item.h.

141  {
142  // By default always show the item
143  return 0;
144  }

Referenced by KIGFX::VIEW::drawItem::operator()(), GRID_HELPER::queryVisible(), and SELECTION_TOOL::Selectable().

◆ viewPrivData()

◆ Visit()

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

Function Visit 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 1023 of file class_libentry.cpp.

1024 {
1025  // The part itself is never inspected, only its children
1026  for( LIB_ITEM& item : m_drawings )
1027  {
1028  if( item.IsType( aFilterTypes ) )
1029  {
1030  if( aInspector( &item, aTestData ) == SEARCH_RESULT::QUIT )
1031  return SEARCH_RESULT::QUIT;
1032  }
1033  }
1034 
1035  return SEARCH_RESULT::CONTINUE;
1036 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61

References CONTINUE, m_drawings, and QUIT.

Member Data Documentation

◆ m_dateLastEdition

timestamp_t LIB_PART::m_dateLastEdition
private

Date of the last modification.

Definition at line 111 of file class_libentry.h.

Referenced by GetDateLastEdition(), LIB_PART(), and operator=().

◆ m_description

wxString LIB_PART::m_description
private

documentation for info

Definition at line 119 of file class_libentry.h.

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

◆ m_drawings

◆ m_Flags

◆ m_FootprintList

wxArrayString LIB_PART::m_FootprintList
private

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

Definition at line 115 of file class_libentry.h.

Referenced by Compare(), GetFootprints(), LIB_PART(), operator=(), and SetFootprintFilters().

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

◆ m_keyWords

wxString LIB_PART::m_keyWords
private

keyword list (used for search for parts by keyword)

Definition at line 120 of file class_libentry.h.

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

◆ m_libId

LIB_ID LIB_PART::m_libId
private

Definition at line 103 of file class_libentry.h.

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

◆ m_library

PART_LIB* LIB_PART::m_library
private

Library the part belongs to if any.

Definition at line 117 of file class_libentry.h.

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

◆ m_me

◆ m_name

wxString LIB_PART::m_name
private

Symbol name.

Definition at line 118 of file class_libentry.h.

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

◆ m_options

LIBRENTRYOPTIONS LIB_PART::m_options
private

Special part features such as POWER or NORMAL.)

Definition at line 112 of file class_libentry.h.

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

◆ m_parent

PART_REF LIB_PART::m_parent
private

Use for inherited symbols.

Definition at line 101 of file class_libentry.h.

Referenced by Compare(), Flatten(), GetParent(), GetUnitCount(), HasConversion(), IsAlias(), IsRoot(), LIB_PART(), operator=(), and SetParent().

◆ m_Parent

◆ m_pinNameOffset

int LIB_PART::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 105 of file class_libentry.h.

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

◆ m_showPinNames

bool LIB_PART::m_showPinNames
private

Determines if part pin names are visible.

Definition at line 109 of file class_libentry.h.

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

◆ m_showPinNumbers

bool LIB_PART::m_showPinNumbers
private

Determines if part pin numbers are visible.

Definition at line 110 of file class_libentry.h.

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

◆ m_Status

STATUS_FLAGS EDA_ITEM::m_Status
protectedinherited

◆ m_subpartFirstId

int LIB_PART::m_subpartFirstId = 'A'
staticprivate

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

Definition at line 125 of file class_libentry.h.

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

◆ m_subpartIdSeparator

int LIB_PART::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 122 of file class_libentry.h.

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

◆ m_unitCount

int LIB_PART::m_unitCount
private

Number of units (parts) per package.

Definition at line 113 of file class_libentry.h.

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

◆ m_unitsLocked

bool LIB_PART::m_unitsLocked
private

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

Definition at line 107 of file class_libentry.h.

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

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid
inherited

Definition at line 162 of file base_struct.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddHierarchicalReference(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), DIALOG_LABEL_EDITOR::convertReferencesToKIIDs(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), PAD_TOOL::EditPad(), PCB_EDIT_FRAME::Exchange_Module(), PAD_TOOL::explodePad(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), BOARD::GetItem(), SCH_SHEET::GetMsgPanelInfo(), SCH_REFERENCE::GetPath(), SCH_COMPONENT::GetRef(), SCH_MARKER::GetUUID(), MARKER_PCB::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadComponent(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), LEGACY_PLUGIN::loadTrackList(), NETLIST_EXPORTER_GENERIC::makeComponents(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), PCB_PARSER::parseDIMENSION(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_COMPONENT::ReplaceInstanceSheetPath(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_COMPONENT::SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), RC_ITEM::SetItems(), SwapItemData(), DIALOG_SCH_SHEET_PROPS::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().


The documentation for this class was generated from the following files: