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 KIGFX::VIEW_ITEM

Public Member Functions

 LIB_PART (const wxString &aName, PART_LIB *aLibrary=NULL)
 
 LIB_PART (LIB_PART &aPart, PART_LIB *aLibrary=NULL)
 
virtual ~LIB_PART ()
 
PART_SPTR SharedPtr ()
 
virtual wxString GetClass () const override
 Function GetClass returns the class name. More...
 
virtual void SetName (const wxString &aName)
 
const wxString & GetName () const
 
const LIB_IDGetLibId () const
 
void SetLibId (const LIB_ID &aLibId)
 
const wxString GetLibraryName ()
 
PART_LIBGetLib ()
 
void SetLib (PART_LIB *aLibrary)
 
wxArrayString GetAliasNames (bool aIncludeRoot=true) const
 
size_t GetAliasCount () const
 
LIB_ALIASGetAlias (size_t aIndex)
 
LIB_ALIASGetAlias (const wxString &aName)
 
timestamp_t GetDateLastEdition () const
 
void AddAlias (const wxString &aName)
 Add an alias aName to the part. More...
 
bool HasAlias (const wxString &aName) const
 Test if alias aName is in part alias list. More...
 
void SetAliases (const wxArrayString &aAliasList)
 
void RemoveAlias (const wxString &aName)
 
LIB_ALIASRemoveAlias (LIB_ALIAS *aAlias)
 
void RemoveAllAliases ()
 
wxArrayString & GetFootprints ()
 
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 SaveDateAndTime (OUTPUTFORMATTER &aFormatter)
 Write the date and time of part to aFile in the format: "Ti yy/mm/jj hh:mm:ss". More...
 
bool LoadDateAndTime (char *aLine)
 
bool Save (OUTPUTFORMATTER &aFormatter)
 Write the data structures out to aFormatter in the part library "*.lib" format. 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 withing this part. More...
 
LIB_FIELDFindField (const wxString &aFieldName)
 Findd a field within this part matching aFieldName and returns it or NULL if not found. More...
 
LIB_FIELDGetField (int aId)
 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...
 
void Draw (EDA_DRAW_PANEL *aPanel, wxDC *aDc, const wxPoint &aOffset, int aMulti, int aConvert, const PART_DRAW_OPTIONS &aOpts)
 Draw 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, EDA_DRAW_PANEL *aPanel=NULL, wxDC *aDc=NULL)
 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...
 
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 ClearStatus ()
 Clears the status flag all draw objects in this part. More...
 
int SelectItems (EDA_RECT &aRect, int aUnit, int aConvert, bool aSyncPinEdit)
 Checks all draw objects of part to see if they are with block. More...
 
void ClearSelectedItems ()
 Clears all the draw items marked by a block select. More...
 
void DeleteSelectedItems ()
 Deletes the select draw items marked by a block select. More...
 
void MoveSelectedItems (const wxPoint &aOffset)
 Move the selected draw items marked by a block select. More...
 
void CopySelectedItems (const wxPoint &aOffset)
 Make a copy of the selected draw items marked by a block select. More...
 
void MirrorSelectedItemsH (const wxPoint &aCenter)
 Horizontally (X axis) mirror selected draw items about a point. More...
 
void MirrorSelectedItemsV (const wxPoint &aCenter)
 Vertically (Y axis) mirror selected draw items about a point. More...
 
void RotateSelectedItems (const wxPoint &aCenter)
 Rotate CCW selected draw items about a point. More...
 
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...
 
void SetUnitCount (int count)
 Set the units per part count. More...
 
int GetUnitCount () const
 
bool IsMulti () const
 
void SetConversion (bool aSetConvert)
 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 ()
 
bool operator== (const LIB_PART *aPart) const
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (timestamp_t aNewTimeStamp)
 
timestamp_t GetTimeStamp () const
 
EDA_ITEMNext () const
 
EDA_ITEMBack () const
 
EDA_ITEMGetParent () const
 
DHEADGetList () const
 
void SetNext (EDA_ITEM *aNext)
 
void SetBack (EDA_ITEM *aBack)
 
void SetParent (EDA_ITEM *aParent)
 
void SetList (DHEAD *aList)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
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
 
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...
 
virtual void GetMsgPanelInfo (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) const
 Function HitTest tests if aPosition is contained within or on the bounding area of an item. More...
 
virtual EDA_ITEMClone () const
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
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 its member data. More...
 
virtual wxString GetSelectMenuText () 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, wxPoint *aFindLocation)
 Function Matches compares the item against the search criteria in aSearchData. More...
 
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...
 
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 ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. 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
 

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...
 
static SEARCH_RESULT IterateForward (EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes. 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...
 

Protected Member Functions

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

Protected Attributes

EDA_ITEMPnext
 next in linked list More...
 
EDA_ITEMPback
 previous in linked list More...
 
DHEADm_List
 which DLIST I am on. More...
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
timestamp_t m_TimeStamp
 Time stamp used for logical links. More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Private Member Functions

void deleteAllFields ()
 

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...
 
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...
 
LIB_ALIASES m_aliases
 List of alias object pointers associated with the part. More...
 
PART_LIBm_library
 Library the part belongs to if any. 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 209 of file class_libentry.h.

Constructor & Destructor Documentation

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

Definition at line 168 of file class_libentry.cpp.

References DATASHEET, 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(), and VALUE.

Referenced by LIB_EDIT_FRAME::TempCopyComponent().

168  :
169  EDA_ITEM( LIB_PART_T ),
170  m_me( this, null_deleter() )
171 {
172  m_dateLastEdition = 0;
173  m_unitCount = 1;
174  m_pinNameOffset = 40;
176  m_unitsLocked = false;
177  m_showPinNumbers = true;
178  m_showPinNames = true;
179 
180  // Add the MANDATORY_FIELDS in RAM only. These are assumed to be present
181  // when the field editors are invoked.
186 
187  SetLib( aLibrary );
188  SetName( aName );
189 }
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.
void push_back(T *aItem)
Definition: multivector.h:169
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType)
Definition: base_struct.cpp:65
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
virtual void SetName(const wxString &aName)
bool m_showPinNames
Determines if part pin names are visible.
#define VALUE
PART_SPTR m_me
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
LIB_PART::LIB_PART ( LIB_PART aPart,
PART_LIB aLibrary = NULL 
)

Definition at line 192 of file class_libentry.cpp.

References EDA_ITEM::Clone(), i, EDA_ITEM::IsNew(), m_aliases, m_dateLastEdition, m_drawings, m_FootprintList, m_libId, m_library, m_options, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), and EDA_ITEM::SetParent().

192  :
193  EDA_ITEM( aPart ),
194  m_me( this, null_deleter() )
195 {
196  LIB_ITEM* newItem;
197 
198  m_library = aLibrary;
200  m_unitCount = aPart.m_unitCount;
206  m_options = aPart.m_options;
207  m_libId = aPart.m_libId;
208 
209  for( LIB_ITEM& oldItem : aPart.m_drawings )
210  {
211  if( oldItem.IsNew() )
212  continue;
213 
214  newItem = (LIB_ITEM*) oldItem.Clone();
215  newItem->SetParent( this );
216  m_drawings.push_back( newItem );
217  }
218 
219  for( size_t i = 0; i < aPart.m_aliases.size(); i++ )
220  {
221  LIB_ALIAS* alias = new LIB_ALIAS( *aPart.m_aliases[i], this );
222  m_aliases.push_back( alias );
223  }
224 }
timestamp_t m_dateLastEdition
Date of the last modification.
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
bool m_showPinNumbers
Determines if part pin numbers are visible.
bool IsNew() const
Definition: base_struct.h:227
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
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...
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
int m_pinNameOffset
The offset in mils to draw the pin name.
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:224
void push_back(T *aItem)
Definition: multivector.h:169
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:65
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
size_t i
Definition: json11.cpp:597
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 ...
LIB_PART::~LIB_PART ( )
virtual

Definition at line 227 of file class_libentry.cpp.

References GetChars(), m_aliases, and traceSchLibMem.

228 {
229  wxLogTrace( traceSchLibMem,
230  wxT( "%s: destroying symbol with alias list count of %llu" ),
231  GetChars( wxString::FromAscii( __WXFUNCTION__ ) ),
232  (long long unsigned) m_aliases.size() );
233 
234  // If the part is being deleted directly rather than through the library,
235  // delete all of the aliases.
236  while( m_aliases.size() )
237  {
238  LIB_ALIAS* alias = m_aliases.back();
239  m_aliases.pop_back();
240  delete alias;
241  }
242 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
const wxChar *const traceSchLibMem
Flag to enable schematic library memory deletion debug output.
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:92

Member Function Documentation

void LIB_PART::AddAlias ( const wxString &  aName)

Add an alias aName to the part.

Duplicate alias names are not added to the alias list. Debug builds will raise an assertion. Release builds will fail silently.

Parameters
aName- Name of alias to add.

Definition at line 1375 of file class_libentry.cpp.

References GetName(), HasAlias(), and m_aliases.

1376 {
1377  wxCHECK_RET( !HasAlias( aName ),
1378  wxT( "Symbol <" ) + GetName() + wxT( "> already has an alias <" ) +
1379  aName + wxT( ">. Bad programmer." ) );
1380 
1381  m_aliases.push_back( new LIB_ALIAS( aName, this ) );
1382 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
bool HasAlias(const wxString &aName) const
Test if alias aName is in part alias list.
const wxString & GetName() const
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 575 of file class_libentry.cpp.

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

Referenced by LIB_EDIT_FRAME::CreateImagePins(), dummy(), LIB_EDIT_FRAME::LoadOneSymbol(), LIB_EDIT_FRAME::pasteClipboard(), and LIB_EDIT_FRAME::PlacePin().

576 {
577  wxASSERT( aItem != NULL );
578 
579  m_drawings.push_back( aItem );
580 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
void push_back(T *aItem)
Definition: multivector.h:169
EDA_ITEM* EDA_ITEM::Back ( ) const
inlineinherited

Definition at line 218 of file base_struct.h.

References EDA_ITEM::Pback.

Referenced by DHEAD::insert(), and DHEAD::remove().

218 { return Pback; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:176
void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 244 of file base_struct.h.

References BRIGHTENED, EDA_ITEM::ClearFlags(), and EDA_ITEM::SetModified().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::disambiguationMenu().

244 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:133
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:265
void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 265 of file base_struct.h.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_Move_Pad(), Abort_MoveOrCopyModule(), Abort_MoveTrack(), Abort_Zone_Create_Outline(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveAndEditTarget(), abortMoveBitmap(), AbortMoveDimensionText(), abortMoveItem(), AbortMoveTextModule(), AbortPinMove(), SCH_SCREEN::addConnectedItemsToBlock(), SCH_EDIT_FRAME::addCurrentItemToList(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearHighlighted(), DRAG_LIST::ClearList(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::End_Edge(), FOOTPRINT_EDIT_FRAME::End_Edge_Module(), PCB_EDIT_FRAME::End_Move_Zone_Corner_Or_Outlines(), PCB_EDIT_FRAME::End_Zone(), EraseDragList(), PCB_EDIT_FRAME::Exchange_Module(), ExitSheet(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), MarkItemsInBloc(), MirrorX(), MirrorY(), moveBitmap(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnRotateItem(), SCH_EDIT_FRAME::OnSelectUnit(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_FIELD::Place(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDIT_FRAME::PlaceDimensionText(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::PlacePad(), PCB_EDIT_FRAME::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_BASE_FRAME::PlaceTexteModule(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), BOARD_COMMIT::Revert(), PCB_BASE_FRAME::Rotate_Module(), RotateListOfItems(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::savePin(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), SCH_EDIT_FRAME::SetRepeatItem(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

265 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 243 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

243 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:132
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:265
void EDA_ITEM::ClearSelected ( )
inlineinherited
void LIB_PART::ClearSelectedItems ( )

Clears all the draw items marked by a block select.

Definition at line 996 of file class_libentry.cpp.

References m_drawings.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd(), and LIB_EDIT_FRAME::LoadOneSymbol().

997 {
998  for( LIB_ITEM& item : m_drawings )
999  {
1000  item.m_Flags = 0;
1001  }
1002 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
void LIB_PART::ClearStatus ( )

Clears the status flag all draw objects in this part.

Definition at line 940 of file class_libentry.cpp.

References m_drawings.

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

941 {
942  for( LIB_ITEM& item : m_drawings )
943  {
944  item.m_Flags = 0;
945  }
946 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
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 D_PAD, SCH_COMPONENT, MODULE, ZONE_CONTAINER, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, SCH_GLOBALLABEL, TRACK, SCH_LABEL, DRAWSEGMENT, LIB_FIELD, DIMENSION, TEXTE_MODULE, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, SCH_LINE, SCH_BUS_BUS_ENTRY, LIB_ARC, TEXTE_PCB, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, LIB_TEXT, EDGE_MODULE, LIB_POLYLINE, LIB_RECTANGLE, LIB_BEZIER, LIB_CIRCLE, SCH_MARKER, SCH_NO_CONNECT, PCB_TARGET, SCH_JUNCTION, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 124 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by PCB_EDIT_FRAME::Block_Duplicate(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), CopyMarkedItems(), CopySelectedItems(), LIB_EDIT_FRAME::copySelectedItems(), BOARD::Duplicate(), DuplicateStruct(), SCH_SCREEN::ExtractWires(), EDA_ITEM::HitTest(), LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), new_clone(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::pasteClipboard(), SCH_EDIT_FRAME::RepeatDrawItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SetConversion(), SCH_EDIT_FRAME::SetRepeatItem(), SCH_EDIT_FRAME::SetUndoItem(), SetUnitCount(), and COMMIT::Stage().

125 {
126  wxCHECK_MSG( false, NULL, wxT( "Clone not implemented in derived class " ) + GetClass() +
127  wxT( ". Bad programmer!" ) );
128 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void LIB_PART::CopySelectedItems ( const wxPoint aOffset)

Make a copy of the selected draw items marked by a block select.

Fields are not copied. Only part body items are copied. Copying fields would result in duplicate fields which does not make sense in this context.

Definition at line 1029 of file class_libentry.cpp.

References EDA_ITEM::Clone(), LIB_FIELD_T, m_drawings, MoveSelectedItems(), SELECTED, and EDA_ITEM::SetFlags().

Referenced by LIB_EDIT_FRAME::HandleBlockPlace().

1030 {
1031  std::vector< LIB_ITEM* > tmp;
1032 
1033  for( LIB_ITEM& item : m_drawings )
1034  {
1035  // We *do not* copy fields because they are unique for the whole component
1036  // so skip them (do not duplicate) if they are flagged selected.
1037  if( item.Type() == LIB_FIELD_T )
1038  item.ClearFlags( SELECTED );
1039 
1040  if( !item.IsSelected() )
1041  continue;
1042 
1043  item.ClearFlags( SELECTED );
1044  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1045  newItem->SetFlags( SELECTED );
1046 
1047  // When push_back elements in buffer, a memory reallocation can happen
1048  // and will break pointers.
1049  // So, push_back later.
1050  tmp.push_back( newItem );
1051  }
1052 
1053  for( auto item : tmp )
1054  m_drawings.push_back( item );
1055 
1056  MoveSelectedItems( aOffset );
1057 }
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
#define SELECTED
Definition: base_struct.h:116
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:264
void MoveSelectedItems(const wxPoint &aOffset)
Move the selected draw items marked by a block select.
void LIB_PART::deleteAllFields ( )
private

Definition at line 771 of file class_libentry.cpp.

References LIB_FIELD_T, and m_drawings.

Referenced by SetFields().

772 {
773  m_drawings[ LIB_FIELD_T ].clear();
774 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
void LIB_PART::DeleteSelectedItems ( )

Deletes the select draw items marked by a block select.

The name and reference field will not be deleted. They are the minimum drawing items required for any part. Their properties can be changed but the cannot be removed.

Definition at line 1005 of file class_libentry.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::erase(), LIB_FIELD_T, m_drawings, and SELECTED.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd().

1006 {
1008 
1009  // We *do not* remove the 2 mandatory fields: reference and value
1010  // so skip them (do not remove) if they are flagged selected.
1011  // Skip also not visible items.
1012  // But I think fields must not be deleted by a block delete command or other global command
1013  // because they are not really graphic items
1014  while( item != m_drawings.end() )
1015  {
1016  if( item->Type() == LIB_FIELD_T )
1017  {
1018  item->ClearFlags( SELECTED );
1019  }
1020 
1021  if( !item->IsSelected() )
1022  ++item;
1023  else
1024  item = m_drawings.erase( item );
1025  }
1026 }
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 SELECTED
Definition: base_struct.h:116
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
void LIB_PART::Draw ( EDA_DRAW_PANEL aPanel,
wxDC *  aDc,
const wxPoint aOffset,
int  aMulti,
int  aConvert,
const PART_DRAW_OPTIONS aOpts 
)

Draw part.

Parameters
aPanel- Window to draw on. Can be NULL if not available.
aDc- Device context to draw on.
aOffset- Position of part.
aMulti- unit if multiple units per part.
aConvert- Component conversion (DeMorgan) if available.
aOpts- Drawing options

Definition at line 317 of file class_libentry.cpp.

References PART_DRAW_OPTIONS::color, PART_DRAW_OPTIONS::draw_hidden_fields, PART_DRAW_OPTIONS::draw_mode, PART_DRAW_OPTIONS::draw_visible_fields, FILLED_WITH_BG_BODYCOLOR, EDA_DRAW_PANEL::GetClipBox(), GetGRForceBlackPenState(), EDA_DRAW_PANEL::GetScreen(), GetUnitBoundingBox(), GRLine(), GRRect(), GRSetDrawMode(), IS_MOVED, IsPower(), LIB_PIN::IsPowerConnection(), LIB_FIELD::IsVisible(), LIB_FIELD_T, LIB_PIN_T, LIGHTMAGENTA, m_drawings, BASE_SCREEN::m_IsPrinting, EDA_RECT::Move(), PART_DRAW_OPTIONS::only_selected, PIN_DANGLING_HIDDEN, PIN_DRAW_DANGLING, PIN_DRAW_ELECTRICAL_TYPE_NAME, PIN_DRAW_TEXTS, PART_DRAW_OPTIONS::PinIsDangling(), EDA_RECT::RevertYAxis(), PART_DRAW_OPTIONS::show_elec_type, PART_DRAW_OPTIONS::show_pin_text, PART_DRAW_OPTIONS::transform, TRANSFORM::TransformCoordinate(), wxPoint::x, and wxPoint::y.

Referenced by SCH_COMPONENT::Draw(), DrawMovingBlockOutlines(), LIB_EDIT_FRAME::PrintPage(), LIB_VIEW_FRAME::RedrawActiveWindow(), LIB_EDIT_FRAME::RedrawComponent(), DIALOG_RESCUE_EACH::renderPreview(), and DIALOG_CHOOSE_COMPONENT::RenderPreview().

319 {
320  BASE_SCREEN* screen = aPanel ? aPanel->GetScreen() : NULL;
321 
322  GRSetDrawMode( aDc, aOpts.draw_mode );
323 
324  /* draw background for filled items using background option
325  * Solid lines will be drawn after the background
326  * Note also, background is not drawn when:
327  * printing in black and white
328  * If the color is not the default color (aColor != -1 )
329  */
330  if( ! ( screen && screen->m_IsPrinting && GetGRForceBlackPenState() )
331  && ( aOpts.color == COLOR4D::UNSPECIFIED ) )
332  {
333  for( LIB_ITEM& drawItem : m_drawings )
334  {
335  if( drawItem.m_Fill != FILLED_WITH_BG_BODYCOLOR )
336  continue;
337 
338  if( aOpts.only_selected && !drawItem.IsSelected() )
339  continue;
340 
341  // Do not draw an item while moving (the cursor handler does that)
342  if( drawItem.m_Flags & IS_MOVED )
343  continue;
344 
345  // Do not draw items not attached to the current part
346  if( aMulti && drawItem.m_Unit && ( drawItem.m_Unit != aMulti ) )
347  continue;
348 
349  if( aConvert && drawItem.m_Convert && ( drawItem.m_Convert != aConvert ) )
350  continue;
351 
352  if( drawItem.Type() == LIB_FIELD_T )
353  continue;
354 
355  if( drawItem.Type() == LIB_FIELD_T ) // TODO dead code?
356  {
357  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
358  aOpts.draw_mode, (void*) NULL, aOpts.transform );
359  }
360 
361  // Now, draw only the background for items with
362  // m_Fill == FILLED_WITH_BG_BODYCOLOR:
363  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
364  aOpts.draw_mode, (void*) false, aOpts.transform );
365  }
366  }
367 
368  // Track the index into the dangling pins list
369  size_t pin_index = 0;
370 
371  for( LIB_ITEM& drawItem : m_drawings )
372  {
373  if( aOpts.only_selected && !drawItem.IsSelected() )
374  continue;
375 
376  // Do not draw an item while moving (the cursor handler does that)
377  if( drawItem.m_Flags & IS_MOVED )
378  continue;
379 
380  // Do not draw items not attached to the current part
381  if( aMulti && drawItem.m_Unit && ( drawItem.m_Unit != aMulti ) )
382  continue;
383 
384  if( aConvert && drawItem.m_Convert && ( drawItem.m_Convert != aConvert ) )
385  continue;
386 
387  if( drawItem.Type() == LIB_FIELD_T )
388  {
389  LIB_FIELD& field = dynamic_cast<LIB_FIELD&>( drawItem );
390 
391  if( field.IsVisible() && !aOpts.draw_visible_fields )
392  continue;
393 
394  if( !field.IsVisible() && !aOpts.draw_hidden_fields )
395  continue;
396  }
397 
398  if( drawItem.Type() == LIB_PIN_T )
399  {
400  LIB_PIN& pin = dynamic_cast<LIB_PIN&>( drawItem );
401 
402  uintptr_t flags = 0;
403  if( aOpts.show_pin_text )
404  flags |= PIN_DRAW_TEXTS;
405 
406  if( aOpts.show_elec_type )
408 
409  if( aOpts.PinIsDangling( pin_index ) )
410  flags |= PIN_DRAW_DANGLING;
411 
412  if( pin.IsPowerConnection() && IsPower() )
413  flags |= PIN_DANGLING_HIDDEN;
414 
415  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
416  aOpts.draw_mode, (void*) flags, aOpts.transform );
417 
418  ++pin_index;
419  }
420  else if( drawItem.Type() == LIB_FIELD_T )
421  {
422  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
423  aOpts.draw_mode, (void*) NULL, aOpts.transform );
424  }
425  else
426  {
427  bool forceNoFill = drawItem.m_Fill == FILLED_WITH_BG_BODYCOLOR;
428  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
429  aOpts.draw_mode, (void*) forceNoFill,
430  aOpts.transform );
431  }
432  }
433 
434  // Enable this to draw the anchor of the component.
435 #if 0
436  int len = aDc->DeviceToLogicalXRel( 3 );
437  EDA_RECT* const clipbox = aPanel ? aPanel->GetClipBox() : NULL;
438 
439  GRLine( clipbox, aDc, aOffset.x, aOffset.y - len, aOffset.x,
440  aOffset.y + len, 0, aOpts.color );
441  GRLine( clipbox, aDc, aOffset.x - len, aOffset.y, aOffset.x + len,
442  aOffset.y, 0, aOpts.color );
443 #endif
444 
445  /* Enable this to draw the bounding box around the component to validate
446  * the bounding box calculations. */
447 #if 0
448  EDA_RECT bBox = GetUnitBoundingBox( aMulti, aConvert );
449  bBox.RevertYAxis();
450  bBox = aOpts.transform.TransformCoordinate( bBox );
451  bBox.Move( aOffset );
452  GRRect( aPanel ? aPanel->GetClipBox() : NULL, aDc, bBox, 0, LIGHTMAGENTA );
453 #endif
454 }
const EDA_RECT GetUnitBoundingBox(int aUnit, int aConvert) const
Get the bounding box for the symbol.
bool PinIsDangling(size_t aPin) const
void Move(const wxPoint &aMoveVector)
Function Move moves the rectangle by the aMoveVector.
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:318
bool IsPower() const
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
void RevertYAxis()
Function RevertYAxis Mirror the rectangle from the X axis (negate Y pos and size) ...
Definition: eda_rect.h:144
bool draw_hidden_fields
Whether to draw "hidden" fields.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:1098
Class BASE_SCREEN handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:76
EDA_RECT * GetClipBox()
void GRLine(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color, wxPenStyle aStyle)
Definition: gr_basic.cpp:380
bool m_IsPrinting
Definition: base_screen.h:220
GR_DRAWMODE draw_mode
Device context drawing mode, see wxDC.
COLOR4D color
Color to draw part in.
bool IsVisible() const
Definition: lib_field.h:164
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool show_pin_text
Whether to show pin texts.
BASE_SCREEN * GetScreen()
Definition: draw_panel.cpp:193
bool only_selected
Draws only the body items that are selected, for block moves.
bool show_elec_type
Whether to show the pin electrical type.
bool IsPowerConnection() const
Return whether this pin forms an implicit power connection: i.e., is hidden and of type POWER_IN...
Definition: lib_pin.h:367
bool draw_visible_fields
Whether to draw "visible" fields.
bool GetGRForceBlackPenState(void)
Function GetGRForceBlackPenState.
Definition: gr_basic.cpp:309
TRANSFORM transform
Coordinate adjustment settings.
#define IS_MOVED
Item being moved.
Definition: base_struct.h:108
LIB_FIELD * LIB_PART::FindField ( const wxString &  aFieldName)

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

Definition at line 838 of file class_libentry.cpp.

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

839 {
840  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
841  {
842  LIB_FIELD* field = ( LIB_FIELD* ) &item;
843 
844  if( field->GetName() == aFieldName )
845  return field;
846  }
847 
848  return NULL;
849 }
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_draw_item.h:66
wxString GetName(bool aTranslate=true) const
Returns the field name.
Definition: lib_field.cpp:432
LIB_ALIAS * LIB_PART::GetAlias ( const wxString &  aName)

Definition at line 1351 of file class_libentry.cpp.

References GetName(), i, and m_aliases.

1352 {
1353  wxCHECK2_MSG( !aName.IsEmpty(), return NULL,
1354  wxT( "Cannot get alias with an empty name. Bad programmer!" ) );
1355 
1356  for( size_t i = 0; i < m_aliases.size(); i++ )
1357  {
1358  if( aName == m_aliases[i]->GetName() )
1359  return m_aliases[i];
1360  }
1361 
1362  return NULL;
1363 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
size_t i
Definition: json11.cpp:597
const wxString & GetName() const
wxArrayString LIB_PART::GetAliasNames ( bool  aIncludeRoot = true) const

Definition at line 1230 of file class_libentry.cpp.

References m_aliases.

Referenced by SCH_LEGACY_PLUGIN_CACHE::AddSymbol(), SCH_LEGACY_PLUGIN_CACHE::DeleteSymbol(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::initDlg(), NETLIST_EXPORTER_GENERIC::makeLibParts(), SCH_LEGACY_PLUGIN_CACHE::saveSymbol(), SetAliases(), and LIB_EDIT_FRAME::UpdateAliasSelectList().

1231 {
1232  wxArrayString names;
1233 
1234  LIB_ALIASES::const_iterator it;
1235 
1236  for( it=m_aliases.begin(); it != m_aliases.end(); ++it )
1237  {
1238  if( !aIncludeRoot && (*it)->IsRoot() )
1239  continue;
1240 
1241  names.Add( (*it)->GetName() );
1242  }
1243 
1244  return names;
1245 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
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 741 of file class_libentry.cpp.

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

Referenced by SCH_COMPONENT::GetBodyBoundingBox().

742 {
743  EDA_RECT bBox;
744  bool initialized = false;
745 
746  for( const LIB_ITEM& item : m_drawings )
747  {
748  if( ( item.m_Unit > 0 ) && ( ( m_unitCount > 1 ) && ( aUnit > 0 )
749  && ( aUnit != item.m_Unit ) ) )
750  continue;
751 
752  if( item.m_Convert > 0 && ( ( aConvert > 0 ) && ( aConvert != item.m_Convert ) ) )
753  continue;
754 
755  if( item.Type() == LIB_FIELD_T )
756  continue;
757 
758  if( initialized )
759  bBox.Merge( item.GetBoundingBox() );
760  else
761  {
762  bBox = item.GetBoundingBox();
763  initialized = true;
764  }
765  }
766 
767  return bBox;
768 }
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_draw_item.h:66
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
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 334 of file class_libentry.h.

References Save.

335  {
336  return GetUnitBoundingBox( 0, 0 );
337  }
const EDA_RECT GetUnitBoundingBox(int aUnit, int aConvert) const
Get the bounding box for the symbol.
virtual wxString LIB_PART::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 253 of file class_libentry.h.

References LIB_ALIAS::GetName(), and LIB_ALIAS::SetName().

254  {
255  return wxT( "LIB_PART" );
256  }
timestamp_t LIB_PART::GetDateLastEdition ( ) const
inline

Definition at line 279 of file class_libentry.h.

Referenced by SCH_LEGACY_PLUGIN_CACHE::saveSymbol().

279 { return m_dateLastEdition; }
timestamp_t m_dateLastEdition
Date of the last modification.
LIB_ITEMS_CONTAINER& LIB_PART::GetDrawItems ( )
inline

Return a reference to the draw item list.

Returns
LIB_ITEMS_CONTAINER& - Reference to the draw item object container.

Definition at line 661 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::copySelectedItems(), LIB_EDIT_FRAME::LoadOneSymbol(), LIB_EDIT_FRAME::locateItem(), LIB_EDIT_FRAME::SaveOneSymbol(), and SCH_LEGACY_PLUGIN_CACHE::saveSymbol().

662  {
663  return m_drawings;
664  }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
LIB_FIELD * LIB_PART::GetField ( int  aId)

Return pointer to the requested field.

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

Definition at line 824 of file class_libentry.cpp.

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

Referenced by GetFields(), GetFootprintField(), GetReferenceField(), GetValueField(), SCH_EAGLE_PLUGIN::loadInstance(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), LIB_EDIT_FRAME::RedrawComponent(), and DIALOG_CHOOSE_COMPONENT::ShowFootprintFor().

825 {
826  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
827  {
828  LIB_FIELD* field = ( LIB_FIELD* ) &item;
829 
830  if( field->GetId() == aId )
831  return field;
832  }
833 
834  return NULL;
835 }
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_draw_item.h:66
int GetId() const
Definition: lib_field.h:138
void LIB_PART::GetFields ( LIB_FIELDS aList)

Return a list of fields withing this part.

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

Parameters
aList- List to add fields to

Definition at line 792 of file class_libentry.cpp.

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

Referenced by DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), SCH_EAGLE_PLUGIN::loadInstance(), NETLIST_EXPORTER_GENERIC::makeLibParts(), SCH_LEGACY_PLUGIN_CACHE::saveSymbol(), and ALIAS_INFO_GENERATOR::SetHtmlFieldTable().

793 {
794  LIB_FIELD* field;
795 
796  // The only caller of this function is the library field editor, so it
797  // establishes policy here.
798 
799  // Grab the MANDATORY_FIELDS first, in expected order given by
800  // enum NumFieldType
801  for( int id=0; id<MANDATORY_FIELDS; ++id )
802  {
803  field = GetField( id );
804 
805  // the MANDATORY_FIELDS are exactly that in RAM.
806  wxASSERT( field );
807 
808  aList.push_back( *field );
809  }
810 
811  // Now grab all the rest of fields.
812  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
813  {
814  field = ( LIB_FIELD* ) &item;
815 
816  if( (unsigned) field->GetId() < MANDATORY_FIELDS )
817  continue; // was added above
818 
819  aList.push_back( *field );
820  }
821 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
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_draw_item.h:66
int GetId() const
Definition: lib_field.h:138
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 266 of file base_struct.h.

References EDA_ITEM::m_Flags.

Referenced by AbortMoveAndEditTarget(), SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForBitmap(), AddMenusForBusEntry(), AddMenusForComponent(), AddMenusForComponentField(), AddMenusForEditComponent(), AddMenusForGLabel(), AddMenusForHierchicalSheet(), AddMenusForHLabel(), AddMenusForLabel(), AddMenusForSheetPin(), AddMenusForText(), SCH_EDIT_FRAME::BeginSegment(), SCH_EDIT_FRAME::ChangeTextOrient(), Collect_TrackSegmentsToDrag(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_EDIT_FRAME::copySelectedItems(), LIB_EDIT_FRAME::CreatePin(), PCB_EDIT_FRAME::createPopUpMenuForFootprints(), PCB_EDIT_FRAME::createPopUpMenuForFpPads(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), PCB_EDIT_FRAME::createPopUpMenuForTexts(), PCB_EDIT_FRAME::createPopupMenuForTracks(), PCB_EDIT_FRAME::createPopUpMenuForZones(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteItem(), SCH_EDIT_FRAME::DeleteItemsInList(), SCH_EDIT_FRAME::DeleteJunction(), BOARD::Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), SCH_EDIT_FRAME::GeneralControl(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_SCREEN::GetConnection(), InitialiseDragParameters(), EDA_DRAW_FRAME::isBusy(), Magnetize(), SCH_EDIT_FRAME::MirrorImage(), SCH_EDIT_FRAME::MirrorSheet(), moveBitmap(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyBeginRoute(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), EDA_DRAW_PANEL::OnMouseEvent(), SCH_EDIT_FRAME::OnMoveItem(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_EDIT_FRAME::OrientComponent(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_EDIT_FRAME::RotateField(), SCH_EDIT_FRAME::RotateHierarchicalSheet(), SCH_EDIT_FRAME::RotateImage(), PCB_BASE_FRAME::RotateTextModule(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SCREEN::SelectBlockItems(), SCH_EDIT_FRAME::SetBusEntryShape(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

266 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
LIB_FIELD & LIB_PART::GetFootprintField ( )

Return reference to the footprint field.

Definition at line 868 of file class_libentry.cpp.

References FOOTPRINT, and GetField().

Referenced by CMP_TREE_NODE_LIB_ID::Update().

869 {
870  LIB_FIELD* field = GetField( FOOTPRINT );
871  wxASSERT( field != NULL );
872  return *field;
873 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Field object used in symbol libraries.
Definition: lib_field.h:59
Field Name Module PCB, i.e. "16DIP300".
wxArrayString& LIB_PART::GetFootprints ( )
inline
PART_LIB* LIB_PART::GetLib ( )
inline

Definition at line 267 of file class_libentry.h.

Referenced by LIB_MANAGER::LIB_BUFFER::CreateBuffer(), PART_LIB::FindAlias(), and LIB_ALIAS::GetLib().

267 { return m_library; }
PART_LIB * m_library
Library the part belongs to if any.
const wxString LIB_PART::GetLibraryName ( )

Definition at line 245 of file class_libentry.cpp.

References PART_LIB::GetName(), and m_library.

Referenced by LIB_ALIAS::GetLibraryName(), and RemoveDrawItem().

246 {
247  if( m_library )
248  return m_library->GetName();
249 
250  return wxString( _( "none" ) );
251 }
PART_LIB * m_library
Library the part belongs to if any.
const wxString GetName() const
Return the file name without path or extension.
DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited
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 D_PAD, SCH_COMPONENT, MODULE, ZONE_CONTAINER, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, SCH_GLOBALLABEL, TRACK, DRAWSEGMENT, SCH_LABEL, LIB_FIELD, DIMENSION, TEXTE_MODULE, SCH_SHEET_PIN, SCH_BUS_BUS_ENTRY, SCH_TEXT, SCH_FIELD, SCH_LINE, LIB_ARC, SCH_BUS_WIRE_ENTRY, TEXTE_PCB, LIB_TEXT, SCH_BITMAP, EDGE_MODULE, LIB_POLYLINE, MARKER_PCB, LIB_RECTANGLE, LIB_CIRCLE, PCB_TARGET, SCH_MARKER, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 281 of file base_struct.cpp.

References dummy_xpm, EDA_ITEM::GetClass(), i, operator<<(), wxPoint::x, and wxPoint::y.

Referenced by SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SELECTION_TOOL::disambiguationMenu(), EDA_ITEM::HitTest(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

282 {
283  return dummy_xpm;
284 }
static const BITMAP_OPAQUE dummy_xpm[1]
Definition: base_struct.cpp:57
virtual void EDA_ITEM::GetMsgPanelInfo ( std::vector< MSG_PANEL_ITEM > &  aList)
inlinevirtualinherited

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Note
This method replaces DisplayInfo() so that KiCad objects no longer have any knowledge of wxWidgets UI objects.
Parameters
aListis the list to populate.

Reimplemented in BOARD, D_PAD, MODULE, SCH_SHEET, SCH_COMPONENT, GERBER_DRAW_ITEM, LIB_ITEM, NETINFO_ITEM, TRACK, DIMENSION, SCH_TEXT, DRAWSEGMENT, TEXTE_MODULE, LIB_FIELD, LIB_PIN, EDGE_MODULE, MARKER_PCB, LIB_BEZIER, LIB_ARC, ZONE_CONTAINER, LIB_TEXT, TEXTE_PCB, SCH_MARKER, LIB_POLYLINE, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 288 of file base_struct.h.

Referenced by SCH_EDIT_FRAME::LocateItem(), EDA_DRAW_FRAME::SetMsgPanel(), and PCB_BASE_FRAME::UpdateMsgPanel().

289  {
290  }
const wxString & LIB_PART::GetName ( ) const

Definition at line 286 of file class_libentry.cpp.

References dummy(), and m_aliases.

Referenced by AddAlias(), SCH_LEGACY_PLUGIN_CACHE::AddSymbol(), SCH_EDIT_FRAME::CreateArchiveLibrary(), LIB_MANAGER::LIB_BUFFER::CreateBuffer(), LIB_EDIT_FRAME::DisplayCmpDoc(), GetAlias(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), HasAlias(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::initDlg(), LIB_ALIAS::IsRoot(), LIB_EDIT_FRAME::LIB_EDIT_FRAME(), LIB_EDIT_FRAME::LoadOneLibraryPartAux(), NETLIST_EXPORTER_GENERIC::makeLibParts(), LIB_EDIT_FRAME::OnEditComponentProperties(), LIB_EDIT_FRAME::OnExportPart(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick(), LIB_EDIT_FRAME::OnPasteDuplicatePart(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), DIALOG_CHOOSE_COMPONENT::OnSchViewPaint(), SCH_EDIT_FRAME::OnSelectUnit(), LIB_EDIT_FRAME::OnUpdateViewDoc(), LIB_VIEW_FRAME::RedrawActiveWindow(), RemoveAlias(), RemoveDrawItem(), PART_LIB::ReplacePart(), LIB_EDIT_FRAME::SaveOneSymbol(), SCH_COMPONENT::SCH_COMPONENT(), LIB_EDIT_FRAME::SetCurPart(), ALIAS_INFO_GENERATOR::SetHtmlAliasOf(), SetName(), LIB_FIELD::SetText(), SCH_REFERENCE_LIST::SortByReferenceOnly(), LIB_MANAGER::UpdatePart(), and LIB_MANAGER::UpdatePartAfterRename().

287 {
288  static wxString dummy;
289 
290  wxCHECK_MSG( m_aliases.size(), dummy, "no aliases defined for symbol" );
291 
292  return m_aliases[0]->GetName();
293 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
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 583 of file class_libentry.cpp.

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

584 {
585  if( m_drawings.empty( aType ) )
586  return NULL;
587 
588  if( aItem == NULL )
589  return &( *( m_drawings.begin( aType ) ) );
590 
591  // Search for the last item, assume aItem is of type aType
592  wxASSERT( ( aType == TYPE_NOT_INIT ) || ( aType == aItem->Type() ) );
594 
595  while( ( it != m_drawings.end( aType ) ) && ( aItem != &( *it ) ) )
596  ++it;
597 
598  // Search the next item
599  if( it != m_drawings.end( aType ) )
600  {
601  ++it;
602 
603  if( it != m_drawings.end( aType ) )
604  return &( *it );
605  }
606 
607  return NULL;
608 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:183
bool empty(int aType=UNDEFINED_TYPE)
Definition: multivector.h:224
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:189
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
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 496 of file class_libentry.h.

References LIB_PIN_T.

Referenced by LIB_EDIT_FRAME::deleteItem(), NETLIST_EXPORTER::findAllUnitsOfComponent(), LIB_EDIT_FRAME::GlobalSetPins(), LIB_EDIT_FRAME::PlacePin(), LIB_PIN::SetConversion(), LIB_PIN::SetPartNumber(), and LIB_EDIT_FRAME::StartMovePin().

497  {
498  return (LIB_PIN*) GetNextDrawItem( (LIB_ITEM*) aItem, LIB_PIN_T );
499  }
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_draw_item.h:66
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 637 of file class_libentry.cpp.

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

638 {
639  LIB_PINS pinList;
640 
641  GetPins( pinList, aUnit, aConvert );
642 
643  for( size_t i = 0; i < pinList.size(); i++ )
644  {
645  wxASSERT( pinList[i]->Type() == LIB_PIN_T );
646 
647  if( aNumber == pinList[i]->GetNumber() )
648  return pinList[i];
649  }
650 
651  return NULL;
652 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_draw_item.h:60
size_t i
Definition: json11.cpp:597
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 611 of file class_libentry.cpp.

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

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::DataViewModel::DataViewModel(), LIB_PIN::EnableEditMode(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), GetPin(), NETLIST_EXPORTER_GENERIC::makeLibParts(), LIB_EDIT_FRAME::OnCheckComponent(), 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().

612 {
613  if( m_drawings.empty( LIB_PIN_T ) )
614  return;
615 
616  /* Notes:
617  * when aUnit == 0: no unit filtering
618  * when aConvert == 0: no convert (shape selection) filtering
619  * when .m_Unit == 0, the body item is common to units
620  * when .m_Convert == 0, the body item is common to shapes
621  */
622  for( LIB_ITEM& item : m_drawings[ LIB_PIN_T ] )
623  {
624  // Unit filtering:
625  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
626  continue;
627 
628  // Shape filtering:
629  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
630  continue;
631 
632  aList.push_back( (LIB_PIN*) &item );
633  }
634 }
bool empty(int aType=UNDEFINED_TYPE)
Definition: multivector.h:224
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
LIB_FIELD & LIB_PART::GetReferenceField ( )

Return reference to the reference designator field.

Definition at line 860 of file class_libentry.cpp.

References GetField(), and REFERENCE.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), SCH_LEGACY_PLUGIN_CACHE::saveSymbol(), and SCH_COMPONENT::SCH_COMPONENT().

861 {
862  LIB_FIELD* field = GetField( REFERENCE );
863  wxASSERT( field != NULL );
864  return *field;
865 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Field object used in symbol libraries.
Definition: lib_field.h:59
Field Reference of part, i.e. "IC21".
wxString EDA_ITEM::GetSelectMenuText ( ) 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 D_PAD, SCH_COMPONENT, MODULE, ZONE_CONTAINER, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, DELETED_SCH_ITEM, GERBER_DRAW_ITEM, SCH_GLOBALLABEL, TRACK, DRAWSEGMENT, SCH_LABEL, LIB_FIELD, DIMENSION, TEXTE_MODULE, SCH_SHEET_PIN, SCH_TEXT, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_LINE, LIB_ARC, SCH_BUS_WIRE_ENTRY, TEXTE_PCB, LIB_TEXT, SCH_BITMAP, EDGE_MODULE, LIB_POLYLINE, MARKER_PCB, LIB_RECTANGLE, LIB_CIRCLE, PCB_TARGET, SCH_MARKER, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 174 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::disambiguationMenu(), DRC::fillMarker(), SCH_FIND_COLLECTOR::GetText(), EDA_ITEM::HitTest(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

175 {
176  wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
177  GetClass() );
178 
179  return wxString( wxT( "Undefined menu text for " ) + GetClass() );
180 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 261 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format(), and GERBER_DRAW_ITEM::HitTest().

261 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:172
static int LIB_PART::GetSubpartFirstId ( )
inlinestatic

Definition at line 704 of file class_libentry.h.

Referenced by SCH_EDIT_FRAME::LoadProjectFile(), and SCH_EDIT_FRAME::OnPreferencesOptions().

704 { return m_subpartFirstId; }
static int m_subpartFirstId
the ascii char value to calculate the subpart symbol id from the part number: only &#39;A&#39;...
static int LIB_PART::GetSubpartIdSeparator ( )
inlinestatic

Definition at line 697 of file class_libentry.h.

Referenced by SCH_EDIT_FRAME::LoadProjectFile(), and SCH_EDIT_FRAME::OnPreferencesOptions().

697 { return m_subpartIdSeparator; }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
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 711 of file class_libentry.cpp.

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

Referenced by LIB_VIEW_FRAME::BestZoom(), LIB_EDIT_FRAME::BestZoom(), Draw(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), DIALOG_RESCUE_EACH::renderPreview(), and DIALOG_CHOOSE_COMPONENT::RenderPreview().

712 {
713  EDA_RECT bBox;
714  bool initialized = false;
715 
716  for( const LIB_ITEM& item : m_drawings )
717  {
718  if( ( item.m_Unit > 0 ) && ( ( m_unitCount > 1 ) && ( aUnit > 0 )
719  && ( aUnit != item.m_Unit ) ) )
720  continue;
721 
722  if( item.m_Convert > 0 && ( ( aConvert > 0 ) && ( aConvert != item.m_Convert ) ) )
723  continue;
724 
725  if ( ( item.Type() == LIB_FIELD_T ) && !( ( LIB_FIELD& ) item ).IsVisible() )
726  continue;
727 
728  if( initialized )
729  bBox.Merge( item.GetBoundingBox() );
730  else
731  {
732  bBox = item.GetBoundingBox();
733  initialized = true;
734  }
735  }
736 
737  return bBox;
738 }
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_draw_item.h:66
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
LIB_FIELD & LIB_PART::GetValueField ( )

Return reference to the value field.

Definition at line 852 of file class_libentry.cpp.

References GetField(), and VALUE.

Referenced by DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick(), SCH_LEGACY_PLUGIN_CACHE::saveSymbol(), and SetName().

853 {
854  LIB_FIELD* field = GetField( VALUE );
855  wxASSERT( field != NULL );
856  return *field;
857 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Field object used in symbol libraries.
Definition: lib_field.h:59
#define VALUE
bool LIB_PART::HasAlias ( const wxString &  aName) const

Test if alias aName is in part alias list.

Alias name comparisons are case insensitive.

Parameters
aName- Name of alias.
Returns
True if alias name in alias list.

Definition at line 1248 of file class_libentry.cpp.

References GetName(), i, and m_aliases.

Referenced by AddAlias(), LIB_EDIT_FRAME::EditField(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick(), and SetAliases().

1249 {
1250  wxCHECK2_MSG( !aName.IsEmpty(), return false,
1251  wxT( "Cannot get alias with an empty name, bad programmer." ) );
1252 
1253  for( size_t i = 0; i < m_aliases.size(); i++ )
1254  {
1255  if( aName == m_aliases[i]->GetName() )
1256  return true;
1257  }
1258 
1259  return false;
1260 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
size_t i
Definition: json11.cpp:597
const wxString & GetName() const
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 928 of file class_libentry.cpp.

References m_drawings.

Referenced by AddMenusForEditComponent(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyOptionsToPanel(), LIB_EDIT_FRAME::EditGraphicSymbol(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), LIB_VIEW_FRAME::onUpdateAlternateBodyStyleButton(), LIB_EDIT_FRAME::OnUpdateDeMorganConvert(), LIB_EDIT_FRAME::OnUpdateDeMorganNormal(), LIB_VIEW_FRAME::onUpdateNormalBodyStyleButton(), SetConversion(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::SetUnsetConvert().

929 {
930  for( const LIB_ITEM& item : m_drawings )
931  {
932  if( item.m_Convert > 1 )
933  return true;
934  }
935 
936  return false;
937 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
virtual bool EDA_ITEM::HitTest ( const wxPoint aPosition) const
inlinevirtualinherited

Function HitTest tests if aPosition is contained within or on the bounding area of an item.

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
Returns
True if aPosition is within or on the item bounding area.

Reimplemented in D_PAD, MODULE, VIA, SCH_ITEM, BOARD_ITEM, GERBER_DRAW_ITEM, ZONE_CONTAINER, TRACK, LIB_ITEM, DIMENSION, DRAWSEGMENT, TEXTE_MODULE, LIB_FIELD, LIB_PIN, MARKER_PCB, LIB_ARC, TEXTE_PCB, PCB_TARGET, LIB_TEXT, LIB_BEZIER, LIB_POLYLINE, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 299 of file base_struct.h.

References EDA_ITEM::Clone(), EDA_ITEM::GetBoundingBox(), EDA_ITEM::GetClass(), EDA_ITEM::GetMenuImage(), EDA_ITEM::GetSelectMenuText(), EDA_ITEM::IterateForward(), and EDA_ITEM::Visit().

Referenced by LIB_ITEM::HitTest(), BOARD_ITEM::HitTest(), GERBER_COLLECTOR::Inspect(), and SCH_COLLECTOR::Inspect().

300  {
301  return false; // derived classes should override this function
302  }
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 235 of file base_struct.h.

References BRIGHTENED.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::GERBVIEW_PAINTER::draw(), and KIGFX::PCB_RENDER_SETTINGS::GetColor().

235 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:133
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
bool EDA_ITEM::IsDragging ( ) const
inlineinherited
bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 234 of file base_struct.h.

References HIGHLIGHTED.

234 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:132
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 228 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

228 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:105
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
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 684 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::OnUpdateSyncPinEdit(), LIB_EDIT_FRAME::SetCurPart(), LIB_EDIT_FRAME::SynchronizePins(), and CMP_TREE_NODE_LIB_ID::Update().

684 { return m_unitCount > 1; }
int m_unitCount
Number of units (parts) per package.
bool EDA_ITEM::IsNew ( ) const
inlineinherited

Definition at line 227 of file base_struct.h.

References IS_NEW.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), Abort_Zone_Create_Outline(), AbortBuildDimension(), AbortMoveAndEditTarget(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), AbortSymbolTraceOn(), SCH_EDIT_FRAME::addCurrentItemToList(), SCH_EDIT_FRAME::addJunctionMenuEntries(), AddMenusForBus(), AddMenusForWire(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteCurrentSegment(), LIB_ARC::drawEditGraphics(), LIB_ARC::drawGraphic(), DrawMovePin(), SCH_EDIT_FRAME::EditSheetPin(), LIB_PIN::EnableEditMode(), LIB_EDIT_FRAME::EndDrawGraphicItem(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), LIB_PART(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnHotKey(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_EDIT_FRAME::PlacePin(), PCB_EDIT_FRAME::PlaceTarget(), SCH_EDIT_FRAME::PrepareMoveItem(), SCH_EDIT_FRAME::ReSizeSheet(), ShowClearance(), PCB_EDIT_FRAME::StartMoveTextePcb(), PCB_EDIT_FRAME::SwitchLayer(), and DIALOG_LABEL_EDITOR::TextPropertiesAccept().

227 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:109
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
bool LIB_PART::IsNormal ( ) const
inline

Definition at line 360 of file class_libentry.h.

References ENTRY_NORMAL.

Referenced by AddMenusForEditComponent().

360 { return m_options == ENTRY_NORMAL; }
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
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_FIELD, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 455 of file base_struct.h.

References EDA_ITEM::operator<().

Referenced by EDA_ITEM::Matches(), and EDA_ITEM::Replace().

455 { return false; }
bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 233 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

233 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:110
bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 232 of file base_struct.h.

References SELECTED.

Referenced by SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForPin(), KIGFX::PCB_PAINTER::draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), LIB_BEZIER::drawGraphic(), LIB_TEXT::drawGraphic(), LIB_ARC::drawGraphic(), LIB_FIELD::drawGraphic(), DrawMovingBlockOutlines(), LIB_PIN::DrawPinElectricalTypeName(), LIB_PIN::DrawPinSymbol(), LIB_PIN::DrawPinTexts(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), LIB_EDIT_FRAME::GlobalSetPins(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), MirrorMarkedItems(), MoveMarkedItems(), MoveMarkedItemsExactly(), LIB_TEXT::Plot(), RotateMarkedItems(), SELECTION_TOOL::SanitizeSelection(), GERBVIEW_SELECTION_TOOL::select(), SELECTION_TOOL::select(), SCH_SCREEN::SelectBlockItems(), GERBVIEW_SELECTION_TOOL::toggleSelection(), SELECTION_TOOL::toggleSelection(), GERBVIEW_SELECTION_TOOL::unselect(), and SELECTION_TOOL::unselect().

232 { return m_Flags & SELECTED; }
#define SELECTED
Definition: base_struct.h:116
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 231 of file base_struct.h.

References IS_WIRE_IMAGE.

Referenced by abortMoveItem(), and SCH_FIELD::Draw().

231 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:113
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
SEARCH_RESULT EDA_ITEM::IterateForward ( EDA_ITEM listStart,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
staticinherited

Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes.

Parameters
listStartThe first in a list of EDA_ITEMs to iterate over.
inspectorIs an INSPECTOR to call on each object that is one of the requested scanTypes.
testDataIs an aid to testFunc, and should be sufficient to allow it to fully determine if an item meets the match criteria, but it may also be used to collect output.
scanTypesA KICAD_T array that is EOT terminated, and provides both the order and interest level of of the types of objects to be iterated over.
Returns
SEARCH_RESULT SEARCH_QUIT if the called INSPECTOR returned SEARCH_QUIT, else SCAN_CONTINUE;

Definition at line 131 of file base_struct.cpp.

References EDA_ITEM::Pnext, SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Visit().

Referenced by SCH_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::Collect(), SCH_TYPE_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::GetItem(), EDA_ITEM::HitTest(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and BOARD::Visit().

135 {
136  EDA_ITEM* p = listStart;
137 
138  for( ; p; p = p->Pnext )
139  {
140  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
141  return SEARCH_QUIT;
142  }
143 
144  return SEARCH_CONTINUE;
145 }
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...
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:162
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:175
bool LIB_PART::LoadDateAndTime ( char *  aLine)

Definition at line 896 of file class_libentry.cpp.

References m_dateLastEdition, and min.

897 {
898  int year, mon, day, hour, min, sec;
899 
900  year = mon = day = hour = min = sec = 0;
901  strtok( aLine, " \r\t\n" );
902  strtok( NULL, " \r\t\n" );
903 
904  if( sscanf( aLine, "%d/%d/%d %d:%d:%d", &year, &mon, &day, &hour, &min, &sec ) != 6 )
905  return false;
906 
907  m_dateLastEdition = ( sec & 63 ) + ( ( min & 63 ) << 6 ) +
908  ( ( hour & 31 ) << 12 ) + ( ( day & 31 ) << 17 ) +
909  ( ( mon & 15 ) << 22 ) + ( ( year - 1990 ) << 26 );
910 
911  return true;
912 }
timestamp_t m_dateLastEdition
Date of the last modification.
#define min(a, b)
Definition: auxiliary.h:85
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 1099 of file class_libentry.cpp.

References m_drawings, and TYPE_NOT_INIT.

Referenced by LocateDrawItem().

1101 {
1102  for( LIB_ITEM& item : m_drawings )
1103  {
1104  if( ( aUnit && item.m_Unit && ( aUnit != item.m_Unit) )
1105  || ( aConvert && item.m_Convert && ( aConvert != item.m_Convert ) )
1106  || ( ( item.Type() != aType ) && ( aType != TYPE_NOT_INIT ) ) )
1107  continue;
1108 
1109  if( item.HitTest( aPoint ) )
1110  return &item;
1111  }
1112 
1113  return NULL;
1114 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
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 1117 of file class_libentry.cpp.

References DefaultTransform, and LocateDrawItem().

1119 {
1120  /* we use LocateDrawItem( int aUnit, int convert, KICAD_T type, const
1121  * wxPoint& pt ) to search items.
1122  * because this function uses DefaultTransform as orient/mirror matrix
1123  * we temporary copy aTransform in DefaultTransform
1124  */
1125  LIB_ITEM* item;
1126  TRANSFORM transform = DefaultTransform;
1127  DefaultTransform = aTransform;
1128 
1129  item = LocateDrawItem( aUnit, aConvert, aType, aPoint );
1130 
1131  // Restore matrix
1132  DefaultTransform = transform;
1133 
1134  return item;
1135 }
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM DefaultTransform
Definition: eeschema.cpp:58
LIB_ITEM * LocateDrawItem(int aUnit, int aConvert, KICAD_T aType, const wxPoint &aPoint)
Locate a draw object.
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 369 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

369 { m_unitsLocked = aLockUnits; }
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
virtual bool EDA_ITEM::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData,
wxPoint aFindLocation 
)
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.
aFindLocationA pointer to a wxPoint object to store the location of matched item. The pointer can be NULL if it is not used.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, SCH_TEXT, LIB_PIN, and SCH_MARKER.

Definition at line 411 of file base_struct.h.

References EDA_ITEM::Replace().

Referenced by SCH_FIND_COLLECTOR::Inspect(), SCH_MARKER::Matches(), LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), SCH_SHEET::Matches(), and EDA_ITEM::Sort().

412  {
413  return false;
414  }
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 183 of file base_struct.cpp.

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

184 {
185  wxString text = aText;
186  wxString searchText = aSearchData.GetFindString();
187 
188  // Don't match if searching for replaceable item and the item doesn't support text replace.
189  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
190  return false;
191 
192  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
193  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
194 
195  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
196  {
197  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
198  return text.Matches( searchText );
199 
200  return text.MakeUpper().Matches( searchText.MakeUpper() );
201  }
202 
203  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
204  return aText.Find( searchText ) != wxNOT_FOUND;
205 
206  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
207 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:455
Perform search using simple wild card matching (* & ?).
Perform a search for a item that has replaceable text.
void LIB_PART::MirrorSelectedItemsH ( const wxPoint aCenter)

Horizontally (X axis) mirror selected draw items about a point.

Parameters
aCenter- Center point to mirror around.

Definition at line 1060 of file class_libentry.cpp.

References m_drawings.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd(), and LIB_EDIT_FRAME::HandleBlockPlace().

1061 {
1062  for( LIB_ITEM& item : m_drawings )
1063  {
1064  if( !item.IsSelected() )
1065  continue;
1066 
1067  item.MirrorHorizontal( aCenter );
1068  item.m_Flags = 0;
1069  }
1070 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
void LIB_PART::MirrorSelectedItemsV ( const wxPoint aCenter)

Vertically (Y axis) mirror selected draw items about a point.

Parameters
aCenter- Center point to mirror around.

Definition at line 1073 of file class_libentry.cpp.

References m_drawings.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd(), and LIB_EDIT_FRAME::HandleBlockPlace().

1074 {
1075  for( LIB_ITEM& item : m_drawings )
1076  {
1077  if( !item.IsSelected() )
1078  continue;
1079 
1080  item.MirrorVertical( aCenter );
1081  item.m_Flags = 0;
1082  }
1083 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
void LIB_PART::MoveSelectedItems ( const wxPoint aOffset)

Move the selected draw items marked by a block select.

Definition at line 983 of file class_libentry.cpp.

References m_drawings.

Referenced by CopySelectedItems(), LIB_EDIT_FRAME::HandleBlockPlace(), and LIB_EDIT_FRAME::pasteClipboard().

984 {
985  for( LIB_ITEM& item : m_drawings )
986  {
987  if( !item.IsSelected() )
988  continue;
989 
990  item.SetOffset( aOffset );
991  item.m_Flags = 0;
992  }
993 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
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 240 of file base_struct.cpp.

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

Referenced by EDA_ITEM::IsReplaceable(), and LIB_ALIAS::operator==().

241 {
242  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
243  GetChars( GetClass() ) ) );
244 
245  return false;
246 }
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:92
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
bool LIB_PART::operator== ( const LIB_PART aPart) const
inline

Definition at line 764 of file class_libentry.h.

764 { return this == aPart; }
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 655 of file class_libentry.cpp.

References GetPins().

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

657 {
658  LIB_PINS thisPinList;
659  GetPins( thisPinList, /* aUnit */ 0, /* aConvert */ 0 );
660 
661  for( LIB_PIN* eachThisPin : thisPinList )
662  {
663  wxASSERT( eachThisPin );
664  LIB_PINS otherPinList;
665  aOtherPart.GetPins( otherPinList, /* aUnit */ 0, /* aConvert */ 0 );
666  bool foundMatch = false;
667 
668  for( LIB_PIN* eachOtherPin : otherPinList )
669  {
670  wxASSERT( eachOtherPin );
671  // Same position?
672  if( eachThisPin->GetPosition() != eachOtherPin->GetPosition() )
673  continue;
674 
675  // Same number?
676  if( aTestNums && ( eachThisPin->GetNumber() != eachOtherPin->GetNumber() ))
677  continue;
678 
679  // Same name?
680  if( aTestNames && ( eachThisPin->GetName() != eachOtherPin->GetName() ))
681  continue;
682 
683  // Same electrical type?
684  if( aTestType && ( eachThisPin->GetType() != eachOtherPin->GetType() ))
685  continue;
686 
687  // Same orientation?
688  if( aTestOrientation && ( eachThisPin->GetOrientation() != eachOtherPin->GetOrientation() ))
689  continue;
690 
691  // Same length?
692  if( aTestLength && ( eachThisPin->GetLength() != eachOtherPin->GetLength() ))
693  continue;
694 
695  foundMatch = true;
696  }
697 
698  if( !foundMatch )
699  {
700  // This means there was not an identical (according to the arguments)
701  // pin at the same position in the other component.
702  return true;
703  }
704  }
705 
706  // The loop never gave up, so no conflicts were found.
707  return false;
708 }
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_draw_item.h:60
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 457 of file class_libentry.cpp.

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

Referenced by LIB_EDIT_FRAME::SVG_PlotComponent().

459 {
460  wxASSERT( aPlotter != NULL );
461 
462  aPlotter->SetColor( GetLayerColor( LAYER_DEVICE ) );
463  bool fill = aPlotter->GetColorMode();
464 
465  // draw background for filled items using background option
466  // Solid lines will be drawn after the background
467  for( LIB_ITEM& item : m_drawings )
468  {
469  // Lib Fields are not plotted here, because this plot function
470  // is used to plot schematic items, which have they own fields
471  if( item.Type() == LIB_FIELD_T )
472  continue;
473 
474  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
475  continue;
476 
477  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
478  continue;
479 
480  if( item.m_Fill == FILLED_WITH_BG_BODYCOLOR )
481  item.Plot( aPlotter, aOffset, fill, aTransform );
482  }
483 
484  // Not filled items and filled shapes are now plotted
485  // (plot only items which are not already plotted)
486  for( LIB_ITEM& item : m_drawings )
487  {
488  if( item.Type() == LIB_FIELD_T )
489  continue;
490 
491  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
492  continue;
493 
494  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
495  continue;
496 
497  if( item.m_Fill != FILLED_WITH_BG_BODYCOLOR )
498  item.Plot( aPlotter, aOffset, fill, aTransform );
499  }
500 }
virtual void SetColor(COLOR4D color)=0
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:167
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
bool GetColorMode() const
Definition: plotter.h:130
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 503 of file class_libentry.cpp.

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

Referenced by LIB_EDIT_FRAME::SVG_PlotComponent().

505 {
506  wxASSERT( aPlotter != NULL );
507 
508  aPlotter->SetColor( GetLayerColor( LAYER_FIELDS ) );
509  bool fill = aPlotter->GetColorMode();
510 
511  for( LIB_ITEM& item : m_drawings )
512  {
513  if( item.Type() != LIB_FIELD_T )
514  continue;
515 
516  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
517  continue;
518 
519  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
520  continue;
521 
522  // The reference is a special case: we should change the basic text
523  // to add '?' and the part id
524  LIB_FIELD& field = (LIB_FIELD&) item;
525  wxString tmp = field.GetShownText();
526  if( field.GetId() == REFERENCE )
527  {
528  wxString text = field.GetFullText( aUnit );
529  field.SetText( text );
530  }
531  item.Plot( aPlotter, aOffset, fill, aTransform );
532  field.SetText( tmp );
533  }
534 }
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.
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:356
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:167
Field Reference of part, i.e. "IC21".
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
virtual wxString GetShownText() const
Returns the string actually shown after processing of the base text.
Definition: eda_text.h:133
void SetText(const wxString &aText) override
Sets the field text to aText.
Definition: lib_field.cpp:502
int GetId() const
Definition: lib_field.h:138
bool GetColorMode() const
Definition: plotter.h:130
void LIB_PART::RemoveAlias ( const wxString &  aName)

Definition at line 1296 of file class_libentry.cpp.

References GetAlias().

Referenced by SCH_LEGACY_PLUGIN_CACHE::DeleteAlias(), SCH_LEGACY_PLUGIN_CACHE::removeAlias(), and LIB_ALIAS::~LIB_ALIAS().

1297 {
1298  LIB_ALIAS* a = GetAlias( aName );
1299 
1300  if( a )
1301  RemoveAlias( a );
1302 }
Part library alias object definition.
LIB_ALIAS * GetAlias(size_t aIndex)
void RemoveAlias(const wxString &aName)
LIB_ALIAS * LIB_PART::RemoveAlias ( LIB_ALIAS aAlias)

Definition at line 1305 of file class_libentry.cpp.

References GetChars(), LIB_ALIAS::GetName(), GetName(), LIB_ALIAS::IsRoot(), m_aliases, m_me, SetName(), and traceSchLibMem.

1306 {
1307  wxCHECK_MSG( aAlias, NULL, wxT( "Cannot remove alias by NULL pointer." ) );
1308 
1309  LIB_ALIAS* nextAlias = NULL;
1310 
1311  LIB_ALIASES::iterator it = find( m_aliases.begin(), m_aliases.end(), aAlias );
1312 
1313  if( it != m_aliases.end() )
1314  {
1315  bool rename = aAlias->IsRoot();
1316 
1317  wxLogTrace( traceSchLibMem,
1318  wxT( "%s: symbol:'%s', alias:'%s', alias count %llu, reference count %ld." ),
1319  GetChars( wxString::FromAscii( __WXFUNCTION__ ) ),
1320  GetChars( GetName() ),
1321  GetChars( aAlias->GetName() ),
1322  (long long unsigned) m_aliases.size(),
1323  m_me.use_count() );
1324 
1325  it = m_aliases.erase( it );
1326 
1327  if( !m_aliases.empty() )
1328  {
1329  if( it == m_aliases.end() )
1330  it = m_aliases.begin();
1331 
1332  nextAlias = *it;
1333 
1334  if( rename )
1335  SetName( nextAlias->GetName() );
1336  }
1337  }
1338 
1339  return nextAlias;
1340 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
bool IsRoot() const
const wxChar *const traceSchLibMem
Flag to enable schematic library memory deletion debug output.
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:92
const wxString & GetName() const
const wxString & GetName() const
virtual void SetName(const wxString &aName)
PART_SPTR m_me
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
void LIB_PART::RemoveAllAliases ( )

Definition at line 1343 of file class_libentry.cpp.

References m_aliases.

Referenced by RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), and LIB_EDIT_FRAME::SaveOneSymbol().

1344 {
1345  // Remove all of the aliases except the root alias.
1346  while( m_aliases.size() > 1 )
1347  m_aliases.pop_back();
1348 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
void LIB_PART::RemoveDrawItem ( LIB_ITEM aItem,
EDA_DRAW_PANEL aPanel = NULL,
wxDC *  aDc = NULL 
)

Remove draw aItem from list.

Parameters
aItem- Draw item to remove from list.
aPanel- Panel to remove part from.
aDc- Device context to remove part from.

Definition at line 537 of file class_libentry.cpp.

References DefaultTransform, LIB_ITEM::Draw(), g_XorMode, GetChars(), LIB_FIELD::GetId(), GetLibraryName(), LIB_FIELD::GetName(), GetName(), i, LIB_FIELD_T, m_drawings, MANDATORY_FIELDS, EDA_ITEM::SetModified(), and EDA_ITEM::Type().

Referenced by LIB_EDIT_FRAME::deleteItem(), LIB_PIN::SetConversion(), and LIB_PIN::SetPartNumber().

538 {
539  wxASSERT( aItem != NULL );
540 
541  // none of the MANDATORY_FIELDS may be removed in RAM, but they may be
542  // omitted when saving to disk.
543  if( aItem->Type() == LIB_FIELD_T )
544  {
545  LIB_FIELD* field = (LIB_FIELD*) aItem;
546 
547  if( field->GetId() < MANDATORY_FIELDS )
548  {
549  wxLogWarning( _(
550  "An attempt was made to remove the %s field from component %s in library %s." ),
551  GetChars( field->GetName() ), GetChars( GetName() ),
552  GetChars( GetLibraryName() ) );
553  return;
554  }
555  }
556 
557  LIB_ITEMS& items = m_drawings[ aItem->Type() ];
558 
559  for( LIB_ITEMS::iterator i = items.begin(); i != items.end(); i++ )
560  {
561  if( *i == aItem )
562  {
563  if( aDc != NULL )
564  aItem->Draw( aPanel, aDc, wxPoint( 0, 0 ), COLOR4D::UNSPECIFIED,
565  g_XorMode, NULL, DefaultTransform );
566 
567  items.erase( i );
568  SetModified();
569  break;
570  }
571  }
572 }
GR_DRAWMODE g_XorMode
Definition: gr_basic.cpp:73
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
void SetModified()
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.
LIB_ITEMS_CONTAINER::ITEM_PTR_VECTOR LIB_ITEMS
int GetId() const
Definition: lib_field.h:138
wxString GetName(bool aTranslate=true) const
Returns the field name.
Definition: lib_field.cpp:432
const wxString GetLibraryName()
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:92
TRANSFORM DefaultTransform
Definition: eeschema.cpp:58
virtual void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, COLOR4D aColor, GR_DRAWMODE aDrawMode, void *aData, const TRANSFORM &aTransform)
Draw an item.
size_t i
Definition: json11.cpp:597
const wxString & GetName() const
void LIB_PART::RemoveDuplicateDrawItems ( )

Remove duplicate draw items from list.

Definition at line 922 of file class_libentry.cpp.

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

Referenced by LIB_EDIT_FRAME::LoadOneSymbol().

923 {
924  m_drawings.unique();
925 }
void unique()
Remove duplicate elements in list.
Definition: multivector.h:238
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
wxString &  aText 
)
inherited

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

References GetChars(), EDA_ITEM::GetClass(), EDA_ITEM::IsReplaceable(), and traceFindReplace.

Referenced by EDA_ITEM::Matches(), SCH_TEXT::Replace(), SCH_FIELD::Replace(), SCH_SHEET_PIN::Replace(), SCH_SHEET::Replace(), and SCH_FIND_COLLECTOR::ReplaceItem().

211 {
212  wxCHECK_MSG( IsReplaceable(), false,
213  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
214 
215  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
216 
217  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
218  aSearchData.GetFindString() :
219  aSearchData.GetFindString().Upper() );
220 
221  if( result == wxNOT_FOUND )
222  return false;
223 
224  wxString prefix = aText.Left( result );
225  wxString suffix;
226 
227  if( aSearchData.GetFindString().length() + result < aText.length() )
228  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
229 
230  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
231  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
232  GetChars( suffix ) );
233 
234  aText = prefix + aSearchData.GetReplaceString() + suffix;
235 
236  return true;
237 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:455
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:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
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_SHEET, SCH_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 443 of file base_struct.h.

443 { return false; }
void LIB_PART::RotateSelectedItems ( const wxPoint aCenter)

Rotate CCW selected draw items about a point.

Parameters
aCenter- Center point to mirror around.

Definition at line 1086 of file class_libentry.cpp.

References m_drawings.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd(), and LIB_EDIT_FRAME::HandleBlockPlace().

1087 {
1088  for( LIB_ITEM& item : m_drawings )
1089  {
1090  if( !item.IsSelected() )
1091  continue;
1092 
1093  item.Rotate( aCenter );
1094  item.m_Flags = 0;
1095  }
1096 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
bool LIB_PART::Save ( OUTPUTFORMATTER aFormatter)

Write the data structures out to aFormatter in the part library "*.lib" format.

Parameters
aFormatterA reference to an OUTPUTFORMATTER to write to.
Returns
True if success writing else false.
bool LIB_PART::SaveDateAndTime ( OUTPUTFORMATTER aFormatter)

Write the date and time of part to aFile in the format: "Ti yy/mm/jj hh:mm:ss".

Parameters
aFormatterA reference to an OUTPUTFORMATTER object containing the output format to write to.
Returns
True if the date and time were successfully written to aFormatter.

Definition at line 876 of file class_libentry.cpp.

References m_dateLastEdition, min, and OUTPUTFORMATTER::Print().

877 {
878  int year, mon, day, hour, min, sec;
879 
880  if( m_dateLastEdition == 0 )
881  return true;
882 
883  sec = m_dateLastEdition & 63;
884  min = ( m_dateLastEdition >> 6 ) & 63;
885  hour = ( m_dateLastEdition >> 12 ) & 31;
886  day = ( m_dateLastEdition >> 17 ) & 31;
887  mon = ( m_dateLastEdition >> 22 ) & 15;
888  year = ( m_dateLastEdition >> 26 ) + 1990;
889 
890  aFormatter.Print( 0, "Ti %d/%d/%d %d:%d:%d\n", year, mon, day, hour, min, sec );
891 
892  return true;
893 }
timestamp_t m_dateLastEdition
Date of the last modification.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
#define min(a, b)
Definition: auxiliary.h:85
int LIB_PART::SelectItems ( EDA_RECT aRect,
int  aUnit,
int  aConvert,
bool  aSyncPinEdit 
)

Checks all draw objects of part to see if they are with block.

Use this method to mark draw objects as selected during block functions.

Parameters
aRect- The bounding rectangle to test in draw items are inside.
aUnit- The current unit number to test against.
aConvert- Are the draw items being selected a conversion.
aSyncPinEdit- Enable pin selection in other units.
Returns
The number of draw objects found inside the block select rectangle.

Definition at line 949 of file class_libentry.cpp.

References LIB_PIN_T, m_drawings, m_unitsLocked, and SELECTED.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd().

950 {
951  int itemCount = 0;
952 
953  for( LIB_ITEM& item : m_drawings )
954  {
955  item.ClearFlags( SELECTED );
956 
957  if( ( item.m_Unit && item.m_Unit != aUnit )
958  || ( item.m_Convert && item.m_Convert != aConvert ) )
959  {
960  if( item.Type() != LIB_PIN_T )
961  continue;
962 
963  // Specific rules for pins:
964  // - do not select pins in other units when synchronized pin edit mode is disabled
965  // - do not select pins in other units when units are not interchangeable
966  // - in other cases verify if the pin belongs to the requested unit
967  if( !aSyncPinEdit || m_unitsLocked
968  || ( item.m_Convert && item.m_Convert != aConvert ) )
969  continue;
970  }
971 
972  if( item.Inside( aRect ) )
973  {
974  item.SetFlags( SELECTED );
975  itemCount++;
976  }
977  }
978 
979  return itemCount;
980 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
#define SELECTED
Definition: base_struct.h:116
void LIB_PART::SetAliases ( const wxArrayString &  aAliasList)

Definition at line 1263 of file class_libentry.cpp.

References GetAliasNames(), HasAlias(), i, m_aliases, and m_library.

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

1264 {
1265  wxCHECK_RET( !m_library,
1266  wxT( "Symbol aliases cannot be changed when they are owned by a library." ) );
1267  wxCHECK_RET( !aAliasList.IsEmpty(), wxT( "Alias list cannot be empty" ) );
1268 
1269  if( aAliasList == GetAliasNames() )
1270  return;
1271 
1272  // Add names not existing in the current component alias list.
1273  for( size_t i = 0; i < aAliasList.GetCount(); i++ )
1274  {
1275  if( HasAlias( aAliasList[ i ] ) )
1276  continue;
1277 
1278  m_aliases.push_back( new LIB_ALIAS( aAliasList[ i ], this ) );
1279  }
1280 
1281  // Remove names in the current component that are not in the new alias list.
1282  LIB_ALIASES::iterator it = m_aliases.begin();
1283 
1284  while( it != m_aliases.end() )
1285  {
1286  int index = aAliasList.Index( (*it)->GetName(), false );
1287 
1288  if( index != wxNOT_FOUND || (*it)->IsRoot() )
1289  ++it;
1290  else
1291  it = m_aliases.erase( it );
1292  }
1293 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
PART_LIB * m_library
Library the part belongs to if any.
bool HasAlias(const wxString &aName) const
Test if alias aName is in part alias list.
wxArrayString GetAliasNames(bool aIncludeRoot=true) const
size_t i
Definition: json11.cpp:597
void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 223 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

223 { Pback = aBack; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:176
void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 240 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::disambiguationMenu().

240 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:264
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:133
void LIB_PART::SetConversion ( bool  aSetConvert)

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.

Definition at line 1185 of file class_libentry.cpp.

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(), i, LIB_PIN_T, LIB_ITEM::m_Convert, and m_drawings.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::SetUnsetConvert().

1186 {
1187  if( aSetConvert == HasConversion() )
1188  return;
1189 
1190  // Duplicate items to create the converted shape
1191  if( aSetConvert )
1192  {
1193  std::vector< LIB_ITEM* > tmp; // Temporarily store the duplicated pins here.
1194 
1195  for( LIB_ITEM& item : m_drawings )
1196  {
1197  // Only pins are duplicated.
1198  if( item.Type() != LIB_PIN_T )
1199  continue;
1200 
1201  if( item.m_Convert == 1 )
1202  {
1203  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1204  newItem->m_Convert = 2;
1205  tmp.push_back( newItem );
1206  }
1207  }
1208 
1209  // Transfer the new pins to the LIB_PART.
1210  for( unsigned i = 0; i < tmp.size(); i++ )
1211  m_drawings.push_back( tmp[i] );
1212  }
1213  else
1214  {
1215  // Delete converted shape items because the converted shape does
1216  // not exist
1217  LIB_ITEMS_CONTAINER::ITERATOR i = m_drawings.begin();
1218 
1219  while( i != m_drawings.end() )
1220  {
1221  if( i->m_Convert > 1 )
1222  i = m_drawings.erase( i );
1223  else
1224  ++i;
1225  }
1226  }
1227 }
bool HasConversion() const
Test if part has more than one body conversion type (DeMorgan).
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
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
size_t i
Definition: json11.cpp:597
int m_Convert
Shape identification for alternate body styles.
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 777 of file class_libentry.cpp.

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

Referenced by DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick().

778 {
779  deleteAllFields();
780 
781  for( unsigned i=0; i<aFields.size(); ++i )
782  {
783  // drawings is a ptr_vector, new and copy an object on the heap.
784  LIB_FIELD* field = new LIB_FIELD( aFields[i] );
785 
786  field->SetParent( this );
787  m_drawings.push_back( field );
788  }
789 }
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
void deleteAllFields()
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:224
void push_back(T *aItem)
Definition: multivector.h:169
size_t i
Definition: json11.cpp:597
void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 264 of file base_struct.h.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_SCREEN::addConnectedItemsToBlock(), PCB_BASE_FRAME::AddModuleToBoard(), AddSegmentToDragList(), PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::BeginMoveDimensionText(), PCB_EDIT_FRAME::BeginMoveTarget(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), CopySelectedItems(), LIB_EDIT_FRAME::copySelectedItems(), SCH_EDIT_FRAME::CreateBusBusEntry(), SCH_EDIT_FRAME::CreateBusWireEntry(), SCH_EDIT_FRAME::CreateNewImage(), SCH_EDIT_FRAME::CreateNewText(), LIB_EDIT_FRAME::CreatePin(), SCH_EDIT_FRAME::CreateSheet(), SCH_EDIT_FRAME::CreateSheetPin(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), SCH_EDIT_FRAME::DeleteItem(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), SCH_EDIT_FRAME::Load_Component(), SCH_SCREEN::MarkConnections(), MarkItemsInBloc(), moveBitmap(), SCH_EDIT_FRAME::MoveImage(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::OnEditPin(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnSelectUnit(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), PCB_EDIT_FRAME::Other_Layer_Route(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PrepareMoveItem(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_EDIT_FRAME::ReSizeSheet(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_SCREEN::SelectBlockItems(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), BLOCK_SELECTOR::SetFlags(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::Start_Move_DrawItem(), FOOTPRINT_EDIT_FRAME::Start_Move_EdgeMod(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), PCB_EDIT_FRAME::Start_Move_Zone_Drag_Outline_Edge(), PCB_EDIT_FRAME::Start_Move_Zone_Outlines(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), PCB_BASE_FRAME::StartMovePad(), LIB_EDIT_FRAME::StartMovePin(), PCB_BASE_FRAME::StartMoveTexteModule(), PCB_EDIT_FRAME::StartMoveTextePcb(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

264 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:186
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 276 of file base_struct.h.

Referenced by SCH_EDIT_FRAME::OnFindSchematicItem(), and SCH_EDIT_FRAME::updateFindReplaceView().

276 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:183
void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 239 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

239 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:264
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:132
void LIB_PART::SetLib ( PART_LIB aLibrary)
inline

Definition at line 269 of file class_libentry.h.

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

269 { m_library = aLibrary; }
PART_LIB * m_library
Library the part belongs to if any.
void LIB_PART::SetLibId ( const LIB_ID aLibId)
inline

Definition at line 263 of file class_libentry.h.

References LIB_ALIAS::GetLibraryName().

Referenced by RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction().

263 { m_libId = aLibId; }
LIB_ID m_libId
void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 225 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), DHEAD::remove(), and SwapItemData().

225 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:177
void EDA_ITEM::SetModified ( )
inherited
void LIB_PART::SetName ( const wxString &  aName)
virtual

Definition at line 296 of file class_libentry.cpp.

References GetName(), EDA_TEXT::GetText(), GetValueField(), m_aliases, m_libId, LIB_ID::SetLibItemName(), and LIB_FIELD::SetText().

Referenced by SCH_EDIT_FRAME::CreateArchiveLibrary(), LIB_EDIT_FRAME::EditField(), LIB_EDIT_FRAME::fixDuplicateAliases(), LIB_PART(), DIALOG_CHOOSE_COMPONENT::OnSchViewPaint(), RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), LIB_VIEW_FRAME::RedrawActiveWindow(), RemoveAlias(), and LIB_FIELD::SetText().

297 {
298  // The LIB_ALIAS that is the LIB_PART name has to be created so create it.
299  if( m_aliases.empty() )
300  m_aliases.push_back( new LIB_ALIAS( aName, this ) );
301  else
302  m_aliases[0]->SetName( aName );
303 
304  // LIB_ALIAS validates the name, reuse it instead of validating the name again
305  wxString validatedName( m_aliases[0]->GetName() );
306  m_libId.SetLibItemName( validatedName, false );
307 
308  LIB_FIELD& valueField = GetValueField();
309 
310  // LIB_FIELD::SetText() calls LIB_PART::SetName(),
311  // the following if-clause is to break an infinite loop
312  if( valueField.GetText() != validatedName )
313  valueField.SetText( validatedName );
314 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_FIELD & GetValueField()
Return reference to the value field.
void SetText(const wxString &aText) override
Sets the field text to aText.
Definition: lib_field.cpp:502
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:128
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:232
const wxString & GetName() const
void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 222 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

222 { Pnext = aNext; }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:175
void LIB_PART::SetNormal ( )
inline

Definition at line 363 of file class_libentry.h.

References ENTRY_NORMAL.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

363 { m_options = ENTRY_NORMAL; }
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
void LIB_PART::SetOffset ( const wxPoint aOffset)

Move the part aOffset.

Parameters
aOffset- Offset displacement.

Definition at line 915 of file class_libentry.cpp.

References m_drawings.

916 {
917  for( LIB_ITEM& item : m_drawings )
918  item.SetOffset( aOffset );
919 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlineinherited

Definition at line 224 of file base_struct.h.

Referenced by MODULE::Add(), BOARD::Add(), BOARD_NETLIST_UPDATER::addNewComponent(), LIB_FIELD::Copy(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), SCH_EDIT_FRAME::CreateSheet(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::Exchange_Module(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), DIALOG_FOOTPRINT_FP_EDITOR::initModeditProperties(), DIALOG_FOOTPRINT_BOARD_EDITOR::InitModeditProperties(), LIB_PART(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnEditReference(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnEditValue(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), MODULE::operator=(), SCH_COMPONENT::operator=(), PCB_PARSER::parseMODULE_unchecked(), LIB_EDIT_FRAME::pasteClipboard(), PCBNEW_CONTROL::PasteItemsFromClipboard(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), BOARD_NETLIST_UPDATER::replaceComponent(), BOARD::ReplaceNetlist(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), SCH_COMPONENT::SCH_COMPONENT(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SetFields(), SetSchItemParent(), PCB_EDIT_FRAME::StartMoveModule(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

224 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:179
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 742 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

742 { m_pinNameOffset = aOffset; }
int m_pinNameOffset
The offset in mils to draw the pin name.
void LIB_PART::SetPower ( )
inline

Definition at line 362 of file class_libentry.h.

References ENTRY_POWER.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

362 { m_options = ENTRY_POWER; }
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
void EDA_ITEM::SetSelected ( )
inlineinherited

Definition at line 238 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by LIB_EDIT_FRAME::pasteClipboard(), GERBVIEW_SELECTION_TOOL::selectVisually(), and SELECTION_TOOL::selectVisually().

238 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:116
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:264
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 751 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

751 { m_showPinNames = aShow; }
bool m_showPinNames
Determines if part pin names are visible.
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 760 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

760 { m_showPinNumbers = aShow; }
bool m_showPinNumbers
Determines if part pin numbers are visible.
void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited
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 1385 of file class_libentry.cpp.

References m_subpartFirstId, and m_subpartIdSeparator.

Referenced by SCH_EDIT_FRAME::LoadProjectFile(), and SCH_EDIT_FRAME::OnPreferencesOptions().

1386 {
1387  m_subpartFirstId = 'A';
1389 
1390  if( aSep == '.' || aSep == '-' || aSep == '_' )
1391  m_subpartIdSeparator = aSep;
1392 
1393  if( aFirstId == '1' && aSep != 0 )
1394  m_subpartFirstId = aFirstId;
1395 }
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 &#39;A&#39;...
void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 214 of file base_struct.h.

Referenced by PCB_BASE_FRAME::AddModuleToBoard(), BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::CreateSheet(), Diagnose(), DuplicateItemsInList(), DuplicateStruct(), EDIT_TOOL::editFootprintInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), DIALOG_FOOTPRINT_BOARD_EDITOR::GotoModuleEditor(), EDA_ITEM::initVars(), BOARD::InsertArea(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), EDA_ITEM::operator=(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseDIMENSION(), SCH_EDIT_FRAME::PasteListOfItems(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), BOARD::ReplaceNetlist(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), SwapItemData(), TestDuplicateSheetNames(), and DIALOG_ERC::TestErc().

214 { m_TimeStamp = aNewTimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:180
void LIB_PART::SetUnitCount ( int  count)

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
count- Number of units per package.

Definition at line 1138 of file class_libentry.cpp.

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(), i, m_drawings, LIB_ITEM::m_Unit, and m_unitCount.

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::ChangeNbUnitsPerPackage(), and LIB_EDIT_FRAME::OnCreateNewPart().

1139 {
1140  if( m_unitCount == aCount )
1141  return;
1142 
1143  if( aCount < m_unitCount )
1144  {
1146 
1147  while( i != m_drawings.end() )
1148  {
1149  if( i->m_Unit > aCount )
1150  i = m_drawings.erase( i );
1151  else
1152  ++i;
1153  }
1154  }
1155  else
1156  {
1157  int prevCount = m_unitCount;
1158 
1159  // Temporary storage for new items, as adding new items directly to
1160  // m_drawings may cause the buffer reallocation which invalidates the
1161  // iterators
1162  std::vector< LIB_ITEM* > tmp;
1163 
1164  for( LIB_ITEM& item : m_drawings )
1165  {
1166  if( item.m_Unit != 1 )
1167  continue;
1168 
1169  for( int j = prevCount + 1; j <= aCount; j++ )
1170  {
1171  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1172  newItem->m_Unit = j;
1173  tmp.push_back( newItem );
1174  }
1175  }
1176 
1177  for( auto item : tmp )
1178  m_drawings.push_back( item );
1179  }
1180 
1181  m_unitCount = aCount;
1182 }
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:183
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
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.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:189
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
size_t i
Definition: json11.cpp:597
void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 237 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

Referenced by moveItemWithMouseCursor().

237 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:264
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:113
PART_SPTR LIB_PART::SharedPtr ( )
inline

Definition at line 247 of file class_libentry.h.

Referenced by SCH_COMPONENT::Resolve(), SCH_COMPONENT::SCH_COMPONENT(), and SCH_COMPONENT::SetLibId().

248  {
249  // clone a shared pointer
250  return m_me;
251  }
PART_SPTR m_me
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
bool LIB_PART::ShowPinNames ( )
inline

Definition at line 753 of file class_libentry.h.

Referenced by LIB_PIN::drawGraphic(), LIB_PIN::GetBoundingBox(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::InitBasicPanel(), and SCH_LEGACY_PLUGIN_CACHE::saveSymbol().

753 { return m_showPinNames; }
bool m_showPinNames
Determines if part pin names are visible.
bool LIB_PART::ShowPinNumbers ( )
inline

Definition at line 762 of file class_libentry.h.

Referenced by LIB_PIN::drawGraphic(), LIB_PIN::GetBoundingBox(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::InitBasicPanel(), and SCH_LEGACY_PLUGIN_CACHE::saveSymbol().

762 { return m_showPinNumbers; }
bool m_showPinNumbers
Determines if part pin numbers are visible.
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 474 of file base_struct.h.

References EDA_ITEM::Matches(), EDA_ITEM::operator=(), EDA_ITEM::ViewBBox(), and EDA_ITEM::ViewGetLayers().

Referenced by PART_LIB::GetEntryTypePowerNames().

474 { return *aLeft < *aRight; }
static int* LIB_PART::SubpartFirstIdPtr ( )
inlinestatic

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

Definition at line 708 of file class_libentry.h.

Referenced by SCH_EDIT_FRAME::GetProjectFileParametersList().

708 { return &m_subpartFirstId; }
static int m_subpartFirstId
the ascii char value to calculate the subpart symbol id from the part number: only &#39;A&#39;...
static int* LIB_PART::SubpartIdSeparatorPtr ( )
inlinestatic

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

Definition at line 702 of file class_libentry.h.

Referenced by SCH_EDIT_FRAME::GetProjectFileParametersList().

702 { return &m_subpartIdSeparator; }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
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 prpebd the sub ref by the separator symbol (if any) Note: this is a static function.

Definition at line 254 of file class_libentry.cpp.

References m_subpartFirstId, and m_subpartIdSeparator.

Referenced by AddMenusForEditComponent(), SCH_REFERENCE_LIST::CheckAnnotation(), CMP_TREE_NODE_UNIT::CMP_TREE_NODE_UNIT(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyOptionsToPanel(), LIB_FIELD::GetFullText(), SCH_FIELD::GetFullyQualifiedText(), SCH_FIELD::Matches(), TestMultiunitFootprints(), and LIB_EDIT_FRAME::UpdatePartSelectList().

255 {
256  wxString subRef;
257 
258  if( m_subpartIdSeparator != 0 && aAddSeparator )
259  subRef << wxChar( m_subpartIdSeparator );
260 
261  if( m_subpartFirstId >= '0' && m_subpartFirstId <= '9' )
262  subRef << aUnit;
263  else
264  {
265  // use letters as notation. To allow more than 26 units, the sub ref
266  // use one letter if letter = A .. Z or a ... z, and 2 letters otherwise
267  // first letter is expected to be 'A' or 'a' (i.e. 26 letters are available)
268  int u;
269  aUnit -= 1; // Unit number starts to 1. now to 0.
270 
271  while( aUnit >= 26 ) // more than one letter are needed
272  {
273  u = aUnit / 26;
274  subRef << wxChar( m_subpartFirstId + u -1 );
275  aUnit %= 26;
276  }
277 
278  u = m_subpartFirstId + aUnit;
279  subRef << wxChar( u );
280  }
281 
282  return subRef;
283 }
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 &#39;A&#39;...
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 209 of file base_struct.h.

References EDA_ITEM::m_StructType.

Referenced by Abort_Move_ModuleOutline(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), MODULE::Add(), CN_CLUSTER::Add(), BOARD::Add(), CN_CONNECTIVITY_ALGO::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), SCH_SCREEN::addConnectedItemsToBlock(), POINT_EDITOR::addCorner(), POINT_EDITOR::addCornerCondition(), SCH_EDIT_FRAME::addCurrentItemToList(), AddMenusForComponent(), AddMenusForEditComponent(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PCB_EDIT_FRAME::Attribut_Track(), PCB_EDIT_FRAME::Autoroute(), PCB_EDIT_FRAME::Begin_Route(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Duplicate(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Block_Rotate(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), calcArea(), calcMaxArea(), SCH_NO_CONNECT::CanConnect(), SCH_JUNCTION::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(), DIALOG_EXCHANGE_FOOTPRINTS::changeSameFootprints(), SCH_SCREENS::ChangeSymbolLibNickname(), SCH_EDIT_FRAME::CheckListConnections(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), TEXTE_PCB::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), TRACK::ClassOf(), NETINFO_ITEM::ClassOf(), MODULE::ClassOf(), D_PAD::ClassOf(), BOARD::ClassOf(), VIA::ClassOf(), SCH_SHEET::CleanupSheet(), Collect_TrackSegmentsToDrag(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), SCH_SHEET::ComponentCount(), GRID_HELPER::computeAnchors(), SCH_SCREEN::CountConnectedItems(), SCH_SHEET::CountSheets(), MODULE::CoverageRatio(), LIB_EDIT_FRAME::CreateGraphicItem(), CINFO3D_VISU::createLayers(), BOARD::CreateLockPoint(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), PCB_EDIT_FRAME::createPopupMenuForTracks(), CreateRoutesSection(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), D_PAD::D_PAD(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_SCREENS::DeleteAllMarkers(), SCH_SCREEN::DeleteItem(), LIB_EDIT_FRAME::deleteItem(), SCH_EDIT_FRAME::DeleteItem(), DeleteNullTrackSegments(), PYTHON_ACTION_PLUGINS::deregister_action(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_ERC::DisplayERC_MarkersList(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DrawMovePin(), DrawMovingBlockOutlines(), drawPickedItems(), CN_ITEM::Dump(), BOARD::Duplicate(), MODULE::Duplicate(), PCB_EDIT_FRAME::duplicateItems(), DuplicateItemsInList(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditSymbolText(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::EraseRedundantTrack(), ExitSheet(), SCH_SCREEN::ExtractWires(), DRC::fillMarker(), find_vias_and_tracks_at(), SCH_EDIT_FRAME::FindComponentAndItem(), NETLIST_EXPORTER::findNextComponent(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), SCH_SHEET_PATH::FindNextItem(), SCH_SHEET_LIST::FindNextItem(), SCH_SHEET_PATH::FindPreviousItem(), SCH_SHEET_LIST::FindPreviousItem(), EDIT_TOOL::FootprintFilter(), FootprintWriteShape(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), getAnchorPoint(), TRACK::GetBestInsertPoint(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_SCREEN::GetConnection(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstTrack(), GetFirstVia(), SCH_SCREEN::GetHierarchicalItems(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), BOARD_CONNECTED_ITEM::GetNetClass(), CONNECTIVITY_DATA::GetNetItems(), GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), SCH_SCREEN::GetPin(), GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), SELECTION::GetTopLeftItem(), LIB_EDIT_FRAME::GlobalSetPins(), SELECTION_TOOL::guessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), SCH_EDIT_FRAME::ImportSheetPin(), DIALOG_LABEL_EDITOR::InitDialog(), ROUTER_TOOL::InlineDrag(), SCH_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), SCH_FIND_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), CN_ANCHOR::IsDangling(), SCH_TEXT::IsDanglingStateChanged(), SCH_COLLECTOR::IsNode(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_EDIT_FRAME::LocateAndShowItem(), SCH_EDIT_FRAME::LocateItem(), SCH_SHEET::LocatePathOfScreen(), Magnetize(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), MarkItemsInBloc(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), TRACKS_CLEANER::MergeCollinearTracks(), SCH_LINE::MergeOverlap(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), moveItemWithMouseCursor(), MoveMarkedItems(), MoveMarkedItemsExactly(), ROUTER_TOOL::NeighboringSegmentFilter(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDuplicateItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItemExact(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyRotateItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), OrCell_Trace(), SCH_EDIT_FRAME::OrientComponent(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::PasteItemsFromClipboard(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), LIB_EDIT_FRAME::PlacePin(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_EDIT_FRAME::PrepareMoveItem(), GAL_ARRAY_CREATOR::prePushAction(), PCB_EDIT_FRAME::PrintPage(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), RedrawWhileMovingCursor(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), BOARD::Remove(), CN_CONNECTIVITY_ALGO::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), RemoveDrawItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), SCH_SHEET::RemovePin(), FOOTPRINT_EDIT_FRAME::RemoveStruct(), PCB_EDIT_FRAME::RemoveStruct(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SCREEN::ReplaceWires(), GERBVIEW_SELECTION_TOOL::RequestSelection(), SELECTION_TOOL::RequestSelection(), PCB_EDIT_FRAME::Reset_All_Tracks_And_Vias_To_Netclass_Values(), PCB_BASE_FRAME::ResetTextSize(), SCH_EDIT_FRAME::ReSizeSheet(), BOARD_COMMIT::Revert(), SCH_EDIT_FRAME::RotateField(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), CN_CONNECTIVITY_ALGO::searchConnections(), SCH_SHEET::SearchHierarchy(), SELECTION_TOOL::select(), SELECTION_TOOL::selectable(), SCH_SCREEN::SelectBlockItems(), PCB_EDIT_FRAME::SelectHighLight(), SELECTION_TOOL::selectVisually(), ITEM_PICKER::SetItem(), SetSchItemParent(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Show_1_Ratsnest(), Show_MoveNode(), ShowClearance(), ShowNewTrackWhenMovingCursor(), SortByTimeStamp(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), LIB_EDIT_FRAME::StartMoveDrawSymbol(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), SCH_NO_CONNECT::SwapData(), SCH_JUNCTION::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_FIELD::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), DIMENSION::SwapData(), DRAWSEGMENT::SwapData(), TRACK::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), VIA::SwapData(), ZONE_CONTAINER::SwapData(), MODULE::SwapData(), D_PAD::SwapData(), SwapItemData(), PCB_EDIT_FRAME::SwitchLayer(), TestDuplicateSheetNames(), TRACKS_CLEANER::testTrackEndpointDangling(), TEXTE_MODULE::TEXTE_MODULE(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), TraceSegmentPcb(), SELECTION_TOOL::unselectVisually(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), POINT_EDITOR::updateItem(), POINT_EDITOR::updatePoints(), PCB_BRIGHT_BOX::ViewDraw(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), EDA_ITEM::Visit(), SCH_SHEET::Visit(), and SCH_COMPONENT::Visit().

210  {
211  return m_StructType;
212  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it...
Definition: base_struct.h:171
bool LIB_PART::UnitsLocked ( ) const
inline

Check whether part units are interchangeable.

Returns
False when interchangeable, true otherwise.

Definition at line 375 of file class_libentry.h.

References TYPE_NOT_INIT.

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyOptionsToPanel(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::InitBasicPanel(), SCH_REFERENCE::IsUnitsLocked(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), LIB_EDIT_FRAME::OnEditComponentProperties(), LIB_EDIT_FRAME::OnUpdateSyncPinEdit(), SCH_LEGACY_PLUGIN_CACHE::saveSymbol(), LIB_EDIT_FRAME::SetCurPart(), and LIB_EDIT_FRAME::SynchronizePins().

375 { return m_unitsLocked; }
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
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 D_PAD, MODULE, EDIT_POINTS, GERBER_DRAW_ITEM, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, MARKER_PCB, KIGFX::WORKSHEET_VIEWITEM, ROUTER_PREVIEW_ITEM, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, BRIGHT_BOX, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 266 of file base_struct.cpp.

References EDA_ITEM::GetBoundingBox().

Referenced by SELECTION_TOOL::selectable(), SELECTION_TOOL::selectMultiple(), EDA_ITEM::Sort(), BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), BRIGHT_BOX::ViewDraw(), and COMMON_TOOLS::ZoomFitScreen().

267 {
268  // Basic fallback
269  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
270  VECTOR2I( GetBoundingBox().GetSize() ) );
271 }
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
BOX2< VECTOR2I > BOX2I
Definition: box2.h:468
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
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, KIGFX::WORKSHEET_VIEWITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::ORIGIN_VIEWITEM, 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.

References KIGFX::VIEW_ITEM::ViewGetLayers().

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

117  {}
void EDA_ITEM::ViewGetLayers ( int  aLayers[],
int &  aCount 
) const
overridevirtualinherited

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[]

Implements KIGFX::VIEW_ITEM.

Reimplemented in D_PAD, MODULE, EDIT_POINTS, VIA, BOARD_ITEM, GERBER_DRAW_ITEM, TRACK, TEXTE_MODULE, ZONE_CONTAINER, MARKER_PCB, KIGFX::WORKSHEET_VIEWITEM, ROUTER_PREVIEW_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, BRIGHT_BOX, KIGFX::RATSNEST_VIEWITEM, and KIGFX::PREVIEW::RULER_ITEM.

Definition at line 274 of file base_struct.cpp.

Referenced by EDA_ITEM::Sort().

275 {
276  // Basic fallback
277  aCount = 1;
278  aLayers[0] = 0;
279 }
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 D_PAD, MODULE, VIA, GERBER_DRAW_ITEM, TRACK, TEXTE_MODULE, and EDGE_MODULE.

Definition at line 140 of file view_item.h.

Referenced by KIGFX::VIEW::drawItem::operator()().

141  {
142  // By default always show the item
143  return 0;
144  }
SEARCH_RESULT EDA_ITEM::Visit ( INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
virtualinherited

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 in BOARD, MODULE, SCH_COMPONENT, SCH_SHEET, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 150 of file base_struct.cpp.

References EOT, EDA_ITEM::GetClass(), SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Type().

Referenced by SCH_SHEET::CanConnect(), GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), EDA_ITEM::HitTest(), and EDA_ITEM::IterateForward().

151 {
152  KICAD_T stype;
153 
154 #if 0 && defined(DEBUG)
155  std::cout << GetClass().mb_str() << ' ';
156 #endif
157 
158  for( const KICAD_T* p = scanTypes; (stype = *p) != EOT; ++p )
159  {
160  // If caller wants to inspect my type
161  if( stype == Type() )
162  {
163  if( SEARCH_QUIT == inspector( this, testData ) )
164  return SEARCH_QUIT;
165 
166  break;
167  }
168  }
169 
170  return SEARCH_CONTINUE;
171 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
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
virtual wxString GetClass() const =0
Function GetClass returns the class name.

Member Data Documentation

LIB_ALIASES LIB_PART::m_aliases
private

List of alias object pointers associated with the part.

Definition at line 225 of file class_libentry.h.

Referenced by AddAlias(), GetAlias(), GetAliasNames(), GetName(), HasAlias(), LIB_PART(), RemoveAlias(), RemoveAllAliases(), SetAliases(), SetName(), and ~LIB_PART().

timestamp_t LIB_PART::m_dateLastEdition
private

Date of the last modification.

Definition at line 219 of file class_libentry.h.

Referenced by LIB_PART(), LoadDateAndTime(), and SaveDateAndTime().

STATUS_FLAGS EDA_ITEM::m_Flags
protectedinherited

Flag bits for editing and other uses.

Definition at line 186 of file base_struct.h.

Referenced by LIB_CIRCLE::BeginEdit(), LIB_RECTANGLE::BeginEdit(), LIB_POLYLINE::BeginEdit(), LIB_TEXT::BeginEdit(), LIB_ARC::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_CIRCLE::calcEdit(), LIB_POLYLINE::calcEdit(), LIB_RECTANGLE::calcEdit(), LIB_TEXT::calcEdit(), LIB_ARC::calcEdit(), LIB_FIELD::calcEdit(), LIB_TEXT::Clone(), LIB_CIRCLE::ContinueEdit(), LIB_RECTANGLE::ContinueEdit(), LIB_POLYLINE::ContinueEdit(), LIB_TEXT::ContinueEdit(), LIB_ARC::ContinueEdit(), LIB_FIELD::ContinueEdit(), SCH_LINE::Draw(), TRACK::Draw(), DRAWSEGMENT::Draw(), MODULE::Draw(), SEGZONE::Draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), LIB_BEZIER::drawGraphic(), LIB_ARC::drawGraphic(), DRAWSEGMENT::DRAWSEGMENT(), LIB_CIRCLE::EndEdit(), LIB_RECTANGLE::EndEdit(), LIB_POLYLINE::EndEdit(), LIB_TEXT::EndEdit(), LIB_ARC::EndEdit(), LIB_ITEM::EndEdit(), LIB_FIELD::EndEdit(), EDA_ITEM::GetFlags(), TRACK::GetMsgPanelInfoBase_Common(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), GERBER_DRAW_ITEM::HitTest(), SCH_COMPONENT::HitTest(), LIB_ITEM::InEditMode(), EDA_ITEM::initVars(), SCH_ITEM::IsConnected(), SCH_LINE::Move(), EDA_ITEM::operator=(), SCH_COMPONENT::SCH_COMPONENT(), LIB_PIN::SetConversion(), LIB_PIN::SetLength(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), LIB_PIN::SetType(), and LIB_PIN::SetVisible().

wxArrayString LIB_PART::m_FootprintList
private

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

Definition at line 223 of file class_libentry.h.

Referenced by LIB_PART().

bool EDA_ITEM::m_forceVisible
protectedinherited

Set to true to override the visibility setting of the item.

Definition at line 183 of file base_struct.h.

Referenced by SCH_FIELD::Draw(), EDA_ITEM::initVars(), and EDA_ITEM::operator=().

LIB_ID LIB_PART::m_libId
private

Definition at line 212 of file class_libentry.h.

Referenced by LIB_PART(), and SetName().

PART_LIB* LIB_PART::m_library
private

Library the part belongs to if any.

Definition at line 227 of file class_libentry.h.

Referenced by GetLibraryName(), LIB_PART(), and SetAliases().

DHEAD* EDA_ITEM::m_List
protectedinherited

which DLIST I am on.

Definition at line 177 of file base_struct.h.

Referenced by EDA_ITEM::GetList(), and EDA_ITEM::initVars().

LIBRENTRYOPTIONS LIB_PART::m_options
private

Special part features such as POWER or NORMAL.)

Definition at line 220 of file class_libentry.h.

Referenced by LIB_PART().

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 213 of file class_libentry.h.

Referenced by LIB_PART().

bool LIB_PART::m_showPinNames
private

Determines if part pin names are visible.

Definition at line 217 of file class_libentry.h.

Referenced by LIB_PART().

bool LIB_PART::m_showPinNumbers
private

Determines if part pin numbers are visible.

Definition at line 218 of file class_libentry.h.

Referenced by LIB_PART().

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 232 of file class_libentry.h.

Referenced by SetSubpartIdNotation(), and SubReference().

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 229 of file class_libentry.h.

Referenced by SetSubpartIdNotation(), and SubReference().

int LIB_PART::m_unitCount
private

Number of units (parts) per package.

Definition at line 221 of file class_libentry.h.

Referenced by GetBodyBoundingBox(), GetUnitBoundingBox(), LIB_PART(), and SetUnitCount().

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 215 of file class_libentry.h.

Referenced by LIB_PART(), and SelectItems().

EDA_ITEM* EDA_ITEM::Pback
protectedinherited

previous in linked list

Definition at line 176 of file base_struct.h.

Referenced by SCH_LINE::Back(), TRACK::Back(), BOARD_ITEM::Back(), EDA_ITEM::Back(), EDA_ITEM::initVars(), and TRACK::SetBack().


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