KiCad PCB EDA Suite
SCH_SYMBOL Class Reference

Schematic symbol object. More...

#include <sch_symbol.h>

Inheritance diagram for SCH_SYMBOL:
SCH_ITEM EDA_ITEM KIGFX::VIEW_ITEM INSPECTABLE

Public Member Functions

 SCH_SYMBOL (const wxPoint &pos=wxPoint(0, 0), SCH_ITEM *aParent=nullptr)
 
 SCH_SYMBOL (const LIB_SYMBOL &aSymbol, const LIB_ID &aLibId, const SCH_SHEET_PATH *aSheet, int unit=0, int convert=0, const wxPoint &pos=wxPoint(0, 0))
 Create schematic symbol from library symbol object. More...
 
 SCH_SYMBOL (const LIB_SYMBOL &aSymbol, const SCH_SHEET_PATH *aSheet, const PICKED_SYMBOL &aSel, const wxPoint &pos=wxPoint(0, 0))
 
 SCH_SYMBOL (const SCH_SYMBOL &aSymbol)
 Clone aSymbol into a new schematic symbol object. More...
 
 ~SCH_SYMBOL ()
 
wxString GetClass () const override
 Return the class name. More...
 
const std::vector< SYMBOL_INSTANCE_REFERENCE > & GetInstanceReferences ()
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Return the layers the item is drawn on (which may be more than its "home" layer) More...
 
bool IsMovableFromAnchorPoint () const override
 Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor. More...
 
void SetLibId (const LIB_ID &aName)
 
const LIB_IDGetLibId () const
 
void SetSchSymbolLibraryName (const wxString &aName)
 The name of the symbol in the schematic library symbol list. More...
 
wxString GetSchSymbolLibraryName () const
 
bool UseLibIdLookup () const
 
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef ()
 
const std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef () const
 
void SetLibSymbol (LIB_SYMBOL *aLibSymbol)
 Set this schematic symbol library symbol reference to aLibSymbol. More...
 
wxString GetDescription () const
 Return information about the aliased parts. More...
 
wxString GetDatasheet () const
 Return the documentation text for the given part alias. More...
 
int GetUnit () const
 
void UpdatePins ()
 Updates the cache of SCH_PIN objects for each pin. More...
 
void SetUnit (int aUnit)
 Change the unit number to aUnit. More...
 
void UpdateUnit (int aUnit)
 Change the unit number to aUnit without setting any internal flags. More...
 
int GetConvert () const
 
void SetConvert (int aConvert)
 
wxString GetPrefix () const
 
void SetPrefix (const wxString &aPrefix)
 
TRANSFORMGetTransform ()
 
const TRANSFORMGetTransform () const
 
void SetTransform (const TRANSFORM &aTransform)
 
int GetUnitCount () const
 Return the number of units per package of the symbol. More...
 
void SetOrientation (int aOrientation)
 Compute the new transform matrix based on aOrientation for the symbol which is applied to the current transform. More...
 
int GetOrientation ()
 Get the display symbol orientation. More...
 
void GetContextualTextVars (wxArrayString *aVars) const
 Return the list of system text vars & fields for this symbol. More...
 
bool ResolveTextVar (wxString *token, int aDepth=0) const
 Resolve any references to system tokens supported by the symbol. More...
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
void ClearAnnotation (const SCH_SHEET_PATH *aSheetPath)
 Clear exiting symbol annotation. More...
 
bool AddSheetPathReferenceEntryIfMissing (const KIID_PATH &aSheetPath)
 Add an instance to the alternate references list (m_instanceReferences), if this entry does not already exist. More...
 
bool ReplaceInstanceSheetPath (const KIID_PATH &aOldSheetPath, const KIID_PATH &aNewSheetPath)
 Replace aOldSheetPath with aNewSheetPath in the instance list. More...
 
const EDA_RECT GetBoundingBox () const override
 Return the orthogonal bounding box of this object for display purposes. More...
 
EDA_RECT GetBodyBoundingBox () const
 Return a bounding box for the symbol body but not the pins or fields. More...
 
EDA_RECT GetBodyAndPinsBoundingBox () const
 Return a bounding box for the symbol body and pins but not the fields. More...
 
SCH_FIELDGetField (MANDATORY_FIELD_T aFieldType)
 Return a mandatory field in this symbol. More...
 
const SCH_FIELDGetField (MANDATORY_FIELD_T aFieldNdx) const
 
SCH_FIELDGetFieldById (int aFieldId)
 Return a field in this symbol. More...
 
wxString GetFieldText (const wxString &aFieldName, SCH_EDIT_FRAME *aFrame) const
 Search for a field named aFieldName and returns text associated with this field. More...
 
void GetFields (std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
 Populate a std::vector with SCH_FIELDs. More...
 
std::vector< SCH_FIELD > & GetFields ()
 Return a vector of fields from the symbol. More...
 
const std::vector< SCH_FIELD > & GetFields () const
 
SCH_FIELDAddField (const SCH_FIELD &aField)
 Add a field to the symbol. More...
 
void RemoveField (const wxString &aFieldName)
 Remove a user field from the symbol. More...
 
SCH_FIELDFindField (const wxString &aFieldName, bool aIncludeDefaultFields=true)
 Search for a SCH_FIELD with aFieldName. More...
 
void SetFields (const SCH_FIELDS &aFields)
 Set multiple schematic fields. More...
 
void UpdateFields (const SCH_SHEET_PATH *aPath, bool aUpdateStyle, bool aUpdateRef, bool aUpdateOtherFields, bool aResetRef, bool aResetOtherFields)
 Restore fields to the original library values. More...
 
int GetFieldCount () const
 Return the number of fields in this symbol. More...
 
void AutoplaceFields (SCH_SCREEN *aScreen, bool aManual) override
 Automatically orient all the fields in the symbol. More...
 
void RunOnChildren (const std::function< void(SCH_ITEM *)> &aFunction) override
 
SCH_PINGetPin (const wxString &number) const
 Find a symbol pin by number. More...
 
void GetLibPins (std::vector< LIB_PIN * > &aPinsList) const
 Populate a vector with all the pins from the library object. More...
 
SCH_PINGetPin (LIB_PIN *aLibPin)
 
std::vector< SCH_PIN * > GetPins (const SCH_SHEET_PATH *aSheet=nullptr) const
 Retrieve a list of the SCH_PINs for the given sheet path. More...
 
std::vector< std::unique_ptr< SCH_PIN > > & GetRawPins ()
 
void Print (const RENDER_SETTINGS *aSettings, const wxPoint &aOffset) override
 Print a symbol. More...
 
void SwapData (SCH_ITEM *aItem) override
 Swap the internal data structures aItem with the schematic item. More...
 
const wxString GetRef (const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
 Return the reference for the given sheet path. More...
 
void SetRef (const SCH_SHEET_PATH *aSheet, const wxString &aReference)
 Set the reference for the given sheet path for this symbol. More...
 
bool IsAnnotated (const SCH_SHEET_PATH *aSheet)
 Check if the symbol has a valid annotation (reference) for the given sheet path. More...
 
void AddHierarchicalReference (const KIID_PATH &aPath, const wxString &aRef, int aUnit, const wxString &aValue=wxEmptyString, const wxString &aFootprint=wxEmptyString)
 Add a full hierarchical reference to this symbol. More...
 
int GetUnitSelection (const SCH_SHEET_PATH *aSheet) const
 Return the instance-specific unit selection for the given sheet path. More...
 
void SetUnitSelection (const SCH_SHEET_PATH *aSheet, int aUnitSelection)
 Set the selected unit of this symbol on one sheet. More...
 
void SetUnitSelection (int aUnitSelection)
 Set the selected unit of this symbol for all sheets. More...
 
const wxString GetValue (const SCH_SHEET_PATH *sheet, bool aResolve) const
 Return the instance-specific value for the given sheet path. More...
 
void SetValue (const SCH_SHEET_PATH *sheet, const wxString &aValue)
 
void SetValue (const wxString &aValue)
 Set the value for all instances (the default GUI behavior). More...
 
const wxString GetFootprint (const SCH_SHEET_PATH *sheet, bool aResolve) const
 Return the instance-specific footprint assignment for the given sheet path. More...
 
void SetFootprint (const SCH_SHEET_PATH *sheet, const wxString &aFootprint)
 
void SetFootprint (const wxString &aFootprint)
 Set the value for all instances (the default GUI behavior). More...
 
void Move (const wxPoint &aMoveVector) override
 Move the item by aMoveVector to a new position. More...
 
void MirrorHorizontally (int aCenter) override
 Mirror item horizontally about aCenter. More...
 
void MirrorVertically (int aCenter) override
 Mirror item vertically about aCenter. More...
 
void Rotate (const wxPoint &aCenter) override
 Rotate the item around aCenter 90 degrees in the clockwise direction. More...
 
bool Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const override
 Compare the item against the search criteria in aSearchData. More...
 
void GetEndPoints (std::vector< DANGLING_END_ITEM > &aItemList) override
 Add the schematic item end points to aItemList if the item has end points. More...
 
bool UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemList, const SCH_SHEET_PATH *aPath=nullptr) override
 Test if the symbol's dangling state has changed for all pins. More...
 
wxPoint GetPinPhysicalPosition (const LIB_PIN *Pin) const
 
bool IsConnectable () const override
 
bool CanConnect (const SCH_ITEM *aItem) const override
 
bool IsInNetlist () const
 
std::vector< wxPoint > GetConnectionPoints () const override
 Add all the connection points for this item to aPoints. More...
 
SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
 May be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
LIB_ITEMGetDrawItem (const wxPoint &aPosition, KICAD_T aType=TYPE_NOT_INIT)
 Return the symbol library item at aPosition that is part of this symbol. More...
 
wxString GetSelectMenuText (EDA_UNITS aUnits) const override
 Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAPS GetMenuImage () const override
 Return a pointer to an image to be used in menus. More...
 
bool operator< (const SCH_ITEM &aItem) const override
 
bool operator== (const SCH_SYMBOL &aSymbol) const
 
bool operator!= (const SCH_SYMBOL &aSymbol) const
 
SCH_SYMBOLoperator= (const SCH_ITEM &aItem)
 
bool IsReplaceable () const override
 Override this method in any derived object that supports test find and replace. More...
 
wxPoint GetPosition () const override
 
void SetPosition (const wxPoint &aPosition) override
 
bool HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
 Test if aPosition is contained within or on the bounding box of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Test if aRect intersects or is contained within the bounding box of an item. More...
 
void Plot (PLOTTER *aPlotter) const override
 Plot the schematic item to aPlotter. More...
 
EDA_ITEMClone () const override
 Create a duplicate of this item with linked list members set to NULL. More...
 
void ClearBrightenedPins ()
 
bool HasBrightenedPins ()
 
bool GetIncludeInBom () const
 
void SetIncludeInBom (bool aIncludeInBom)
 
bool GetIncludeOnBoard () const
 
void SetIncludeOnBoard (bool aIncludeOnBoard)
 
bool IsPointClickableAnchor (const wxPoint &aPos) const override
 
SCH_ITEMDuplicate (bool doClone=false) const
 Routine to create a new copy of given item. More...
 
wxPoint & GetStoredPos ()
 
void SetStoredPos (const wxPoint &aPos)
 
SCHEMATICSchematic () const
 Searches the item hierarchy to find a SCHEMATIC. More...
 
virtual bool IsLocked () const
 
virtual void SetLocked (bool aLocked)
 Set the 'lock' status to aLocked for of this item. More...
 
virtual bool IsHypertext () const
 Allow items to support hypertext actions when hovered/clicked. More...
 
virtual void DoHypertextMenu (EDA_DRAW_FRAME *aFrame)
 
SCH_LAYER_ID GetLayer () const
 Return the layer this item is on. More...
 
void SetLayer (SCH_LAYER_ID aLayer)
 Set the layer this item is on. More...
 
virtual int GetPenWidth () const
 
virtual bool IsDangling () const
 
void ClearConnections ()
 Clears all of the connection items from the list. More...
 
bool IsConnected (const wxPoint &aPoint) const
 Test the item to see if it is connected to aPoint. More...
 
SCH_CONNECTIONConnection (const SCH_SHEET_PATH *aSheet=nullptr) const
 Retrieve the connection associated with this object in the given sheet. More...
 
SCH_ITEM_SETConnectedItems (const SCH_SHEET_PATH &aPath)
 Retrieve the set of items connected to this item on the given sheet. More...
 
void AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
 Add a connection link between this item and another. More...
 
SCH_CONNECTIONInitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
 Create a new connection object associated with this object. More...
 
virtual bool ConnectionPropagatesTo (const EDA_ITEM *aItem) const
 Return true if this item should propagate connection info to aItem. More...
 
bool IsConnectivityDirty ()
 
void SetConnectivityDirty (bool aDirty=true)
 
NETCLASSPTR NetClass (const SCH_SHEET_PATH *aSheet=nullptr) const
 
FIELDS_AUTOPLACED GetFieldsAutoplaced () const
 Return whether the fields have been automatically placed. More...
 
void SetFieldsAutoplaced ()
 
void ClearFieldsAutoplaced ()
 
void AutoAutoplaceFields (SCH_SCREEN *aScreen)
 Autoplace fields only if correct to do so automatically. More...
 
virtual bool HasLineStroke () const
 Check if this schematic item has line stoke properties. More...
 
virtual STROKE_PARAMS GetStroke () const
 
virtual void SetStroke (const STROKE_PARAMS &aStroke)
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
KICAD_T Type () const
 Returns the type of object. More...
 
EDA_ITEMGetParent () const
 
virtual void SetParent (EDA_ITEM *aParent)
 
bool IsModified () const
 
bool IsNew () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsEntered () const
 
bool IsResized () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (EDA_ITEM_FLAGS type) const
 
void SetState (EDA_ITEM_FLAGS type, bool state)
 
EDA_ITEM_FLAGS GetStatus () const
 
void SetStatus (EDA_ITEM_FLAGS aStatus)
 
void SetFlags (EDA_ITEM_FLAGS aMask)
 
void ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
EDA_ITEM_FLAGS GetFlags () const
 
bool HasFlag (EDA_ITEM_FLAGS aFlag) const
 
EDA_ITEM_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[]) const
 Check whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
bool IsForceVisible () const
 
virtual const wxPoint GetFocusPosition () const
 Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
 
virtual bool Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
 Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual const BOX2I ViewBBox () const override
 Return the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Draw the parts of the object belonging to layer aLayer. More...
 
virtual double ViewGetLOD (int aLayer, VIEW *aView) const
 Return the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
bool Set (PROPERTY_BASE *aProperty, wxAny &aValue)
 
template<typename T >
bool Set (PROPERTY_BASE *aProperty, T aValue)
 
template<typename T >
bool Set (const wxString &aProperty, T aValue)
 
wxAny Get (PROPERTY_BASE *aProperty)
 
template<typename T >
Get (PROPERTY_BASE *aProperty)
 
template<typename T >
boost::optional< T > Get (const wxString &aProperty)
 

Static Public Member Functions

static bool ClassOf (const EDA_ITEM *aItem)
 
static bool IsReferenceStringValid (const wxString &aReferenceString)
 Test for an acceptable reference string. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 This changes first parameter to avoid the DList and use the main queue instead. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Change first parameter to avoid the DList and use std::vector instead. More...
 
static bool Replace (const wxFindReplaceData &aSearchData, wxString &aText)
 Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Public Attributes

const KIID m_Uuid
 

Protected Member Functions

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

Protected Attributes

SCH_LAYER_ID m_layer
 
EDA_ITEMS m_connections
 
FIELDS_AUTOPLACED m_fieldsAutoplaced
 
wxPoint m_storedPos
 
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SETm_connected_items
 Store pointers to other items that are connected to this one, per sheet. More...
 
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
 Store connectivity information, per sheet. More...
 
bool m_connectivity_dirty
 
EDA_ITEM_FLAGS m_status
 
EDA_ITEMm_parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
EDA_ITEM_FLAGS m_flags
 

Private Member Functions

EDA_RECT doGetBoundingBox (bool aIncludePins, bool aIncludeFields) const
 
bool doIsConnected (const wxPoint &aPosition) const override
 Provide the object specific test to see if it is connected to aPosition. More...
 
void Init (const wxPoint &pos=wxPoint(0, 0))
 

Private Attributes

wxPoint m_pos
 
LIB_ID m_lib_id
 Name and library the symbol was loaded from, i.e. 74xx:74LS00. More...
 
int m_unit
 The unit for multiple part per package symbols. More...
 
int m_convert
 The alternate body style for symbols that have more than one body style defined. More...
 
wxString m_prefix
 C, R, U, Q etc - the first character(s) which typically indicate what the symbol is. More...
 
wxString m_schLibSymbolName
 The name used to look up a symbol in the symbol library embedded in a schematic. More...
 
TRANSFORM m_transform
 The rotation/mirror transformation matrix. More...
 
SCH_FIELDS m_fields
 Variable length list of fields. More...
 
std::unique_ptr< LIB_SYMBOLm_part
 
std::vector< std::unique_ptr< SCH_PIN > > m_pins
 
std::unordered_map< LIB_PIN *, unsigned > m_pinMap
 
bool m_isInNetlist
 True if the symbol should appear in the netlist. More...
 
bool m_inBom
 True to include in bill of materials export. More...
 
bool m_onBoard
 True to include in netlist when updating board. More...
 
std::vector< SYMBOL_INSTANCE_REFERENCEm_instanceReferences
 

Detailed Description

Schematic symbol object.

Definition at line 78 of file sch_symbol.h.

Constructor & Destructor Documentation

◆ SCH_SYMBOL() [1/4]

SCH_SYMBOL::SCH_SYMBOL ( const wxPoint &  pos = wxPoint( 0, 0 ),
SCH_ITEM aParent = nullptr 
)

Definition at line 98 of file sch_symbol.cpp.

98  :
99  SCH_ITEM( aParent, SCH_SYMBOL_T )
100 {
101  Init( aPos );
102 }
void Init(const wxPoint &pos=wxPoint(0, 0))
Definition: sch_symbol.cpp:194
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:47

References Init().

Referenced by Clone().

◆ SCH_SYMBOL() [2/4]

SCH_SYMBOL::SCH_SYMBOL ( const LIB_SYMBOL aSymbol,
const LIB_ID aLibId,
const SCH_SHEET_PATH aSheet,
int  unit = 0,
int  convert = 0,
const wxPoint &  pos = wxPoint( 0, 0 ) 
)

Create schematic symbol from library symbol object.

Parameters
aSymbolis the library symbol to create schematic symbol from.
aLibIdis the LIB_ID of alias to create.
aSheetis the schematic sheet the symbol is place into.
unitis unit for symbols that have multiple parts per package.
convertis the alternate body style for the schematic symbols.
posis the position of the symbol.
setNewItemFlagis used to set the symbol IS_NEW and IS_MOVING flags.

Definition at line 105 of file sch_symbol.cpp.

106  :
107  SCH_ITEM( nullptr, SCH_SYMBOL_T )
108 {
109  Init( pos );
110 
111  m_unit = unit;
112  m_convert = convert;
113  m_lib_id = aLibId;
114 
115  std::unique_ptr< LIB_SYMBOL > part;
116 
117  part = aSymbol.Flatten();
118  part->SetParent();
119  SetLibSymbol( part.release() );
120 
121  // Copy fields from the library symbol
122  UpdateFields( aSheet,
123  true, /* update style */
124  false, /* update ref */
125  false, /* update other fields */
126  true, /* reset ref */
127  true /* reset other fields */ );
128 
129  m_prefix = UTIL::GetRefDesPrefix( m_part->GetReferenceField().GetText() );
130 
131  if( aSheet )
132  {
134 
135  // Value and footprint name are stored in the SCH_SHEET_PATH path manager,
136  // if aSheet != nullptr, not in the symbol itself.
137  // Copy them to the currently displayed field texts
138  SetValue( GetValue( aSheet, false ) );
139  SetFootprint( GetFootprint( aSheet, false ) );
140  }
141 
142  // Inherit the include in bill of materials and board netlist settings from library symbol.
143  m_inBom = aSymbol.GetIncludeInBom();
144  m_onBoard = aSymbol.GetIncludeOnBoard();
145 }
void UpdateFields(const SCH_SHEET_PATH *aPath, bool aUpdateStyle, bool aUpdateRef, bool aUpdateOtherFields, bool aResetRef, bool aResetOtherFields)
Restore fields to the original library values.
Definition: sch_symbol.cpp:757
wxString GetRefDesUnannotated(const wxString &aSource)
Return an unannotated refdes from either a prefix or an existing refdes.
wxString m_prefix
C, R, U, Q etc - the first character(s) which typically indicate what the symbol is.
Definition: sch_symbol.h:683
void SetValue(const SCH_SHEET_PATH *sheet, const wxString &aValue)
Definition: sch_symbol.cpp:594
bool GetIncludeOnBoard() const
Definition: lib_symbol.h:593
void SetFootprint(const SCH_SHEET_PATH *sheet, const wxString &aFootprint)
Definition: sch_symbol.cpp:645
void SetLibSymbol(LIB_SYMBOL *aLibSymbol)
Set this schematic symbol library symbol reference to aLibSymbol.
Definition: sch_symbol.cpp:257
std::unique_ptr< LIB_SYMBOL > Flatten() const
Return a flattened symbol inheritance to the caller.
Definition: lib_symbol.cpp:331
void Init(const wxPoint &pos=wxPoint(0, 0))
Definition: sch_symbol.cpp:194
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:679
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:680
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700
const wxString GetValue(const SCH_SHEET_PATH *sheet, bool aResolve) const
Return the instance-specific value for the given sheet path.
Definition: sch_symbol.cpp:573
bool m_onBoard
True to include in netlist when updating board.
Definition: sch_symbol.h:707
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_symbol.h:678
bool m_inBom
True to include in bill of materials export.
Definition: sch_symbol.h:706
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
Definition: sch_symbol.cpp:481
wxString GetRefDesPrefix(const wxString &aRefDes)
Get the (non-numeric) prefix from a refdes - e.g.
const wxString GetFootprint(const SCH_SHEET_PATH *sheet, bool aResolve) const
Return the instance-specific footprint assignment for the given sheet path.
Definition: sch_symbol.cpp:624
bool GetIncludeInBom() const
Definition: lib_symbol.h:585
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:47

References convert, LIB_SYMBOL::Flatten(), GetFootprint(), LIB_SYMBOL::GetIncludeInBom(), LIB_SYMBOL::GetIncludeOnBoard(), UTIL::GetRefDesPrefix(), UTIL::GetRefDesUnannotated(), GetValue(), Init(), m_convert, m_inBom, m_lib_id, m_onBoard, m_part, m_prefix, m_unit, SetFootprint(), SetLibSymbol(), SetRef(), SetValue(), and UpdateFields().

◆ SCH_SYMBOL() [3/4]

SCH_SYMBOL::SCH_SYMBOL ( const LIB_SYMBOL aSymbol,
const SCH_SHEET_PATH aSheet,
const PICKED_SYMBOL aSel,
const wxPoint &  pos = wxPoint( 0, 0 ) 
)

Definition at line 148 of file sch_symbol.cpp.

149  :
150  SCH_SYMBOL( aSymbol, aSel.LibId, aSheet, aSel.Unit, aSel.Convert, pos )
151 {
152  // Set any fields that were modified as part of the symbol selection
153  for( const std::pair<int, wxString>& i : aSel.Fields )
154  {
155  SCH_FIELD* field = GetFieldById( i.first );
156 
157  if( field )
158  field->SetText( i.second );
159  }
160 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
SCH_SYMBOL(const wxPoint &pos=wxPoint(0, 0), SCH_ITEM *aParent=nullptr)
Definition: sch_symbol.cpp:98
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:114
LIB_ID LibId
Definition: sch_screen.h:82
SCH_FIELD * GetFieldById(int aFieldId)
Return a field in this symbol.
Definition: sch_symbol.cpp:687
std::vector< std::pair< int, wxString > > Fields
Definition: sch_screen.h:86

References PICKED_SYMBOL::Fields, GetFieldById(), and EDA_TEXT::SetText().

◆ SCH_SYMBOL() [4/4]

SCH_SYMBOL::SCH_SYMBOL ( const SCH_SYMBOL aSymbol)

Clone aSymbol into a new schematic symbol object.

All fields are copied as is except for the linked list management pointers which are set to NULL, and the SCH_FIELD's m_Parent pointers which are set to the new object.

Parameters
aSymbolis the schematic symbol to clone.

Definition at line 163 of file sch_symbol.cpp.

163  :
164  SCH_ITEM( aSymbol )
165 {
166  m_parent = aSymbol.m_parent;
167  m_pos = aSymbol.m_pos;
168  m_unit = aSymbol.m_unit;
169  m_convert = aSymbol.m_convert;
170  m_lib_id = aSymbol.m_lib_id;
171  m_isInNetlist = aSymbol.m_isInNetlist;
172  m_inBom = aSymbol.m_inBom;
173  m_onBoard = aSymbol.m_onBoard;
174 
175  if( aSymbol.m_part )
176  SetLibSymbol( new LIB_SYMBOL( *aSymbol.m_part.get() ) );
177 
178  const_cast<KIID&>( m_Uuid ) = aSymbol.m_Uuid;
179 
180  m_transform = aSymbol.m_transform;
181  m_prefix = aSymbol.m_prefix;
183  m_fields = aSymbol.m_fields;
184 
185  // Re-parent the fields, which before this had aSymbol as parent
186  for( SCH_FIELD& field : m_fields )
187  field.SetParent( this );
188 
191 }
bool m_isInNetlist
True if the symbol should appear in the netlist.
Definition: sch_symbol.h:705
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:479
wxString m_prefix
C, R, U, Q etc - the first character(s) which typically indicate what the symbol is.
Definition: sch_symbol.h:683
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
Define a library symbol object.
Definition: lib_symbol.h:96
void SetLibSymbol(LIB_SYMBOL *aLibSymbol)
Set this schematic symbol library symbol reference to aLibSymbol.
Definition: sch_symbol.cpp:257
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:483
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:679
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:680
wxString m_schLibSymbolName
The name used to look up a symbol in the symbol library embedded in a schematic.
Definition: sch_symbol.h:695
wxPoint m_pos
Definition: sch_symbol.h:677
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700
bool m_onBoard
True to include in netlist when updating board.
Definition: sch_symbol.h:707
const KIID m_Uuid
Definition: eda_item.h:475
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_symbol.h:678
bool m_inBom
True to include in bill of materials export.
Definition: sch_symbol.h:706
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:697
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:711
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:47

References m_convert, m_fields, SCH_ITEM::m_fieldsAutoplaced, m_inBom, m_instanceReferences, m_isInNetlist, m_lib_id, m_onBoard, EDA_ITEM::m_parent, m_part, m_pos, m_prefix, m_schLibSymbolName, m_transform, m_unit, EDA_ITEM::m_Uuid, and SetLibSymbol().

◆ ~SCH_SYMBOL()

SCH_SYMBOL::~SCH_SYMBOL ( )
inline

Definition at line 111 of file sch_symbol.h.

111 { }

Member Function Documentation

◆ AddConnectionTo()

void SCH_ITEM::AddConnectionTo ( const SCH_SHEET_PATH aPath,
SCH_ITEM aItem 
)
inherited

Add a connection link between this item and another.

Definition at line 170 of file sch_item.cpp.

171 {
172  m_connected_items[ aSheet ].insert( aItem );
173 }
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SET > m_connected_items
Store pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:488

References SCH_ITEM::m_connected_items.

Referenced by SCH_TEXT::UpdateDanglingState().

◆ AddField()

SCH_FIELD * SCH_SYMBOL::AddField ( const SCH_FIELD aField)

Add a field to the symbol.

Parameters
aFieldis the field to add to this symbol.
Returns
the newly inserted field.

Definition at line 721 of file sch_symbol.cpp.

722 {
723  int newNdx = m_fields.size();
724 
725  m_fields.push_back( aField );
726  return &m_fields[newNdx];
727 }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698

References m_fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_ALTIUM_PLUGIN::ParseParameter(), DIALOG_CHANGE_SYMBOLS::processSymbol(), and UpdateFields().

◆ AddHierarchicalReference()

void SCH_SYMBOL::AddHierarchicalReference ( const KIID_PATH aPath,
const wxString &  aRef,
int  aUnit,
const wxString &  aValue = wxEmptyString,
const wxString &  aFootprint = wxEmptyString 
)

Add a full hierarchical reference to this symbol.

Parameters
aPathis the hierarchical path (/&ltsheet timestamp&gt/&ltsymbol timestamp&gt like /05678E50/A23EF560).
aRefis the local reference like C45, R56.
aUnitis the unit selection used for symbols with multiple units per package.
aValueis the value used for this instance.
aFootprintis the footprint used for this instance (which might have different hole spacing or other board-specific changes from other instances).

Definition at line 400 of file sch_symbol.cpp.

403 {
404  // Search for an existing path and remove it if found (should not occur)
405  for( unsigned ii = 0; ii < m_instanceReferences.size(); ii++ )
406  {
407  if( m_instanceReferences[ii].m_Path == aPath )
408  {
409  wxLogTrace( traceSchSheetPaths, "Removing symbol instance:\n"
410  " sheet path %s\n"
411  " reference %s, unit %d from symbol %s.",
412  aPath.AsString(),
413  m_instanceReferences[ii].m_Reference,
414  m_instanceReferences[ii].m_Unit,
415  m_Uuid.AsString() );
416 
417  m_instanceReferences.erase( m_instanceReferences.begin() + ii );
418  ii--;
419  }
420  }
421 
422  SYMBOL_INSTANCE_REFERENCE instance;
423  instance.m_Path = aPath;
424  instance.m_Reference = aRef;
425  instance.m_Unit = aUnit;
426  instance.m_Value = aValue;
427  instance.m_Footprint = aFootprint;
428 
429  wxLogTrace( traceSchSheetPaths, "Adding symbol instance:\n"
430  " sheet path %s\n"
431  " reference %s, unit %d to symbol %s.",
432  aPath.AsString(),
433  aRef,
434  aUnit,
435  m_Uuid.AsString() );
436 
437  m_instanceReferences.push_back( instance );
438 }
const wxChar *const traceSchSheetPaths
Flag to enable debug output of schematic symbol sheet path manipulation code.
wxString AsString() const
Definition: kiid.cpp:218
A simple container for schematic symbol instance information.
const KIID m_Uuid
Definition: eda_item.h:475
wxString AsString() const
Definition: kiid.cpp:277
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:711

References KIID::AsString(), KIID_PATH::AsString(), SYMBOL_INSTANCE_REFERENCE::m_Footprint, m_instanceReferences, SYMBOL_INSTANCE_REFERENCE::m_Path, SYMBOL_INSTANCE_REFERENCE::m_Reference, SYMBOL_INSTANCE_REFERENCE::m_Unit, EDA_ITEM::m_Uuid, SYMBOL_INSTANCE_REFERENCE::m_Value, and traceSchSheetPaths.

Referenced by AddSheetPathReferenceEntryIfMissing(), SetFootprint(), SetRef(), SetUnitSelection(), SetValue(), and SCH_SHEET_LIST::UpdateSymbolInstances().

◆ AddSheetPathReferenceEntryIfMissing()

bool SCH_SYMBOL::AddSheetPathReferenceEntryIfMissing ( const KIID_PATH aSheetPath)

Add an instance to the alternate references list (m_instanceReferences), if this entry does not already exist.

Do nothing if already exists. In symbol lists shared by more than one sheet path, an entry for each sheet path must exist to manage references.

Parameters
aSheetPathis the candidate sheet path of the sheet containing the symbol not the full symbol sheet path.
Returns
false if the alternate reference was existing, true if added.

Definition at line 1057 of file sch_symbol.cpp.

1058 {
1059  // a empty sheet path is illegal:
1060  wxCHECK( aSheetPath.size() > 0, false );
1061 
1062  wxString reference_path;
1063 
1064  for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
1065  {
1066  // if aSheetPath is found, nothing to do:
1067  if( instance.m_Path == aSheetPath )
1068  return false;
1069  }
1070 
1071  // This entry does not exist: add it, with its last-used reference
1072  AddHierarchicalReference( aSheetPath, m_fields[REFERENCE_FIELD].GetText(), m_unit );
1073  return true;
1074 }
Field Reference of part, i.e. "IC21".
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:679
A simple container for schematic symbol instance information.
void AddHierarchicalReference(const KIID_PATH &aPath, const wxString &aRef, int aUnit, const wxString &aValue=wxEmptyString, const wxString &aFootprint=wxEmptyString)
Add a full hierarchical reference to this symbol.
Definition: sch_symbol.cpp:400
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:711

References AddHierarchicalReference(), m_fields, m_instanceReferences, m_unit, and REFERENCE_FIELD.

Referenced by SCH_SCREEN::EnsureAlternateReferencesExist().

◆ AutoAutoplaceFields()

void SCH_ITEM::AutoAutoplaceFields ( SCH_SCREEN aScreen)
inlineinherited

Autoplace fields only if correct to do so automatically.

Fields that have been moved by hand are not automatically placed.

Parameters
aScreenis the SCH_SCREEN associated with the current instance of the symbol.

Definition at line 430 of file sch_item.h.

431  {
432  if( GetFieldsAutoplaced() )
434  }
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition: sch_item.h:418
virtual void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Definition: sch_item.h:436

References SCH_ITEM::AutoplaceFields(), FIELDS_AUTOPLACED_MANUAL, and SCH_ITEM::GetFieldsAutoplaced().

Referenced by SCH_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), and SCH_EDIT_FRAME::SelectUnit().

◆ AutoplaceFields()

void SCH_SYMBOL::AutoplaceFields ( SCH_SCREEN aScreen,
bool  aManual 
)
overridevirtual

Automatically orient all the fields in the symbol.

Parameters
aScreenis the SCH_SCREEN associated with the current instance of the symbol. This can be NULL when aManual is false.
aManualshould be true if the autoplace was manually initiated (e.g. by a hotkey or a menu item). Some more 'intelligent' routines will be used that would be annoying if done automatically during moves.

Reimplemented from SCH_ITEM.

Definition at line 677 of file autoplace_fields.cpp.

678 {
679  if( aManual )
680  wxASSERT_MSG( aScreen, "A SCH_SCREEN pointer must be given for manual autoplacement" );
681 
682  AUTOPLACER autoplacer( this, aScreen );
683  autoplacer.DoAutoplace( aManual );
685 }
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:483

References AUTOPLACER::DoAutoplace(), FIELDS_AUTOPLACED_AUTO, FIELDS_AUTOPLACED_MANUAL, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_DRAWING_TOOLS::PlaceSymbol().

◆ CanConnect()

bool SCH_SYMBOL::CanConnect ( const SCH_ITEM aItem) const
inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 602 of file sch_symbol.h.

603  {
604  return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
605  ( aItem->Type() == SCH_NO_CONNECT_T ) ||
606  ( aItem->Type() == SCH_JUNCTION_T ) ||
607  ( aItem->Type() == SCH_SYMBOL_T ) ||
608  ( aItem->Type() == SCH_LABEL_T ) ||
609  ( aItem->Type() == SCH_HIER_LABEL_T ) ||
610  ( aItem->Type() == SCH_GLOBAL_LABEL_T );
611  }
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:257
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References SCH_ITEM::GetLayer(), LAYER_WIRE, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_SYMBOL_T, and EDA_ITEM::Type().

◆ ClassOf()

static bool SCH_SYMBOL::ClassOf ( const EDA_ITEM aItem)
inlinestatic

Definition at line 113 of file sch_symbol.h.

114  {
115  return aItem && SCH_SYMBOL_T == aItem->Type();
116  }
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References SCH_SYMBOL_T, and EDA_ITEM::Type().

◆ ClearAnnotation()

void SCH_SYMBOL::ClearAnnotation ( const SCH_SHEET_PATH aSheetPath)

Clear exiting symbol annotation.

For example, IC23 would be changed to IC? and unit number would be reset.

Parameters
aSheetPathis the hierarchical path of the symbol to clear or remove all annotations for this symbol if NULL.

Definition at line 1025 of file sch_symbol.cpp.

1026 {
1027  // Build a reference with no annotation, i.e. a reference ending with a single '?'
1028  wxString defRef = UTIL::GetRefDesUnannotated( m_prefix );
1029 
1030  if( aSheetPath )
1031  {
1032  KIID_PATH path = aSheetPath->Path();
1033 
1035  {
1036  if( instance.m_Path == path )
1037  instance.m_Reference = defRef;
1038  }
1039  }
1040  else
1041  {
1043  instance.m_Reference = defRef;
1044  }
1045 
1046  for( std::unique_ptr<SCH_PIN>& pin : m_pins )
1047  pin->ClearDefaultNetName( aSheetPath );
1048 
1049  // These 2 changes do not work in complex hierarchy.
1050  // When a clear annotation is made, the calling function must call a
1051  // UpdateAllScreenReferences for the active sheet.
1052  // But this call cannot made here.
1053  m_fields[REFERENCE_FIELD].SetText( defRef ); //for drawing.
1054 }
Field Reference of part, i.e. "IC21".
wxString m_prefix
C, R, U, Q etc - the first character(s) which typically indicate what the symbol is.
Definition: sch_symbol.h:683
wxString GetRefDesUnannotated(const wxString &aSource)
Return an unannotated refdes from either a prefix or an existing refdes.
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:702
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
A simple container for schematic symbol instance information.
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:711

References UTIL::GetRefDesUnannotated(), m_fields, m_instanceReferences, m_pins, m_prefix, SCH_SHEET_PATH::Path(), path, pin, and REFERENCE_FIELD.

Referenced by SCH_SCREEN::ClearAnnotation(), SCH_EDIT_FRAME::DeleteAnnotation(), and SCH_EDITOR_CONTROL::updatePastedSymbol().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

◆ ClearBrightenedPins()

void SCH_SYMBOL::ClearBrightenedPins ( )

Definition at line 1875 of file sch_symbol.cpp.

1876 {
1877  for( auto& pin : m_pins )
1878  pin->ClearBrightened();
1879 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:702

References m_pins, and pin.

Referenced by SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ ClearConnections()

void SCH_ITEM::ClearConnections ( )
inlineinherited

Clears all of the connection items from the list.

The vector release method is used to prevent the item pointers from being deleted. Do not use the vector erase method on the connection list.

Definition at line 370 of file sch_item.h.

370 { m_connections.clear(); }
EDA_ITEMS m_connections
Definition: sch_item.h:482

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )
inlineinherited

◆ ClearFlags()

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

Definition at line 154 of file eda_item.h.

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

References EDA_ITEM::m_flags.

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

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 166 of file eda_item.h.

167  {
169  DO_NOT_DRAW );
170  }
#define DO_NOT_DRAW
Used to disable draw function.
#define STARTPOINT
When a line is selected, these flags indicate which.
#define ENDPOINT
ends. (Used to support dragging.)
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
#define CANDIDATE
flag indicating that the structure is connected
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:154
#define SKIP_STRUCT
flag indicating that the structure should be ignored
#define TEMP_SELECTED
flag indicating that the structure has already selected

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, ENDPOINT, IS_LINKED, SKIP_STRUCT, STARTPOINT, and TEMP_SELECTED.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 143 of file view_item.h.

144  {
145  m_viewPrivData = nullptr;
146  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:151

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * SCH_SYMBOL::Clone ( ) const
overridevirtual

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

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

Returns
A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 223 of file sch_symbol.cpp.

224 {
225  return new SCH_SYMBOL( *this );
226 }
SCH_SYMBOL(const wxPoint &pos=wxPoint(0, 0), SCH_ITEM *aParent=nullptr)
Definition: sch_symbol.cpp:98

References SCH_SYMBOL().

◆ ConnectedItems()

SCH_ITEM_SET & SCH_ITEM::ConnectedItems ( const SCH_SHEET_PATH aPath)
inherited

Retrieve the set of items connected to this item on the given sheet.

Definition at line 164 of file sch_item.cpp.

165 {
166  return m_connected_items[ aSheet ];
167 }
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SET > m_connected_items
Store pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:488

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), CONNECTION_GRAPH::updateItemConnectivity(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ Connection()

SCH_CONNECTION * SCH_ITEM::Connection ( const SCH_SHEET_PATH aSheet = nullptr) const
inherited

Retrieve the connection associated with this object in the given sheet.

Note
The returned value can be nullptr.

Definition at line 131 of file sch_item.cpp.

132 {
133  if( !aSheet )
134  aSheet = &Schematic()->CurrentSheet();
135 
136  auto it = m_connection_map.find( *aSheet );
137 
138  if( it == m_connection_map.end() )
139  return nullptr;
140  else
141  return it->second;
142 }
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Store connectivity information, per sheet.
Definition: sch_item.h:491
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:121

References SCHEMATIC::CurrentSheet(), SCH_ITEM::m_connection_map, and SCH_ITEM::Schematic().

Referenced by CONNECTION_SUBGRAPH::Absorb(), CONNECTION_SUBGRAPH::AddItem(), CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_ITEM::NetClass(), SCH_TEXT::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_EDIT_FRAME::RecalculateConnections(), CONNECTION_SUBGRAPH::ResolveDrivers(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), BUS_UNFOLD_MENU::update(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ ConnectionPropagatesTo()

virtual bool SCH_ITEM::ConnectionPropagatesTo ( const EDA_ITEM aItem) const
inlinevirtualinherited

Return true if this item should propagate connection info to aItem.

Reimplemented in SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 407 of file sch_item.h.

407 { return true; }

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

◆ doGetBoundingBox()

EDA_RECT SCH_SYMBOL::doGetBoundingBox ( bool  aIncludePins,
bool  aIncludeFields 
) const
private

Definition at line 1301 of file sch_symbol.cpp.

1302 {
1303  EDA_RECT bBox;
1304 
1305  if( m_part )
1306  bBox = m_part->GetBodyBoundingBox( m_unit, m_convert, aIncludePins );
1307  else
1308  bBox = dummy()->GetBodyBoundingBox( m_unit, m_convert, aIncludePins );
1309 
1310  int x0 = bBox.GetX();
1311  int xm = bBox.GetRight();
1312 
1313  // We must reverse Y values, because matrix orientation
1314  // suppose Y axis normal for the library items coordinates,
1315  // m_transform reverse Y values, but bBox is already reversed!
1316  int y0 = -bBox.GetY();
1317  int ym = -bBox.GetBottom();
1318 
1319  // Compute the real Boundary box (rotated, mirrored ...)
1320  int x1 = m_transform.x1 * x0 + m_transform.y1 * y0;
1321  int y1 = m_transform.x2 * x0 + m_transform.y2 * y0;
1322  int x2 = m_transform.x1 * xm + m_transform.y1 * ym;
1323  int y2 = m_transform.x2 * xm + m_transform.y2 * ym;
1324 
1325  bBox.SetX( x1 );
1326  bBox.SetY( y1 );
1327  bBox.SetWidth( x2 - x1 );
1328  bBox.SetHeight( y2 - y1 );
1329  bBox.Normalize();
1330 
1331  bBox.Offset( m_pos );
1332 
1333  if( aIncludeFields )
1334  {
1335  for( const SCH_FIELD& field : m_fields )
1336  {
1337  if( field.IsVisible() )
1338  bBox.Merge( field.GetBoundingBox() );
1339  }
1340  }
1341 
1342  return bBox;
1343 }
void Offset(int dx, int dy)
Definition: eda_rect.h:147
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
void Merge(const EDA_RECT &aRect)
Modify the position and size of the rectangle in order to contain aRect.
Definition: eda_rect.cpp:432
int y2
Definition: transform.h:51
int GetX() const
Definition: eda_rect.h:98
int x2
Definition: transform.h:50
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
int x1
Definition: transform.h:48
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:679
int GetBottom() const
Definition: eda_rect.h:114
const EDA_RECT GetBodyBoundingBox(int aUnit, int aConvert, bool aIncludePins) const
Get the symbol bounding box excluding fields.
Definition: lib_symbol.cpp:864
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:72
int y1
Definition: transform.h:49
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:680
void SetHeight(int val)
Definition: eda_rect.h:176
int GetRight() const
Definition: eda_rect.h:111
wxPoint m_pos
Definition: sch_symbol.h:677
void SetX(int val)
Definition: eda_rect.h:158
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700
void SetWidth(int val)
Definition: eda_rect.h:170
void SetY(int val)
Definition: eda_rect.h:164
void Normalize()
Ensures that the height ant width are positive.
Definition: eda_rect.cpp:35
Handle the component boundary box.
Definition: eda_rect.h:42
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:697
int GetY() const
Definition: eda_rect.h:99

References dummy(), LIB_SYMBOL::GetBodyBoundingBox(), EDA_RECT::GetBottom(), EDA_RECT::GetRight(), EDA_RECT::GetX(), EDA_RECT::GetY(), m_convert, m_fields, m_part, m_pos, m_transform, m_unit, EDA_RECT::Merge(), EDA_RECT::Normalize(), EDA_RECT::Offset(), EDA_RECT::SetHeight(), EDA_RECT::SetWidth(), EDA_RECT::SetX(), EDA_RECT::SetY(), TRANSFORM::x1, TRANSFORM::x2, TRANSFORM::y1, and TRANSFORM::y2.

Referenced by GetBodyAndPinsBoundingBox(), GetBodyBoundingBox(), and GetBoundingBox().

◆ DoHypertextMenu()

virtual void SCH_ITEM::DoHypertextMenu ( EDA_DRAW_FRAME aFrame)
inlinevirtualinherited

Reimplemented in SCH_FIELD.

Definition at line 252 of file sch_item.h.

252 { }

◆ doIsConnected()

bool SCH_SYMBOL::doIsConnected ( const wxPoint &  aPosition) const
overrideprivatevirtual

Provide the object specific test to see if it is connected to aPosition.

Note
Override this function if the derived object can be connect to another object such as a wire, bus, or junction. Do not override this function for objects that cannot have connections. The default will always return false. This functions is call through the public function IsConnected() which performs tests common to all schematic items before calling the item specific connection testing.
Parameters
aPositionis a reference to a wxPoint object containing the test position.
Returns
True if connection to aPosition exists.

Reimplemented from SCH_ITEM.

Definition at line 1812 of file sch_symbol.cpp.

1813 {
1814  wxPoint new_pos = m_transform.InverseTransform().TransformCoordinate( aPosition - m_pos );
1815 
1816  for( const auto& pin : m_pins )
1817  {
1818  if( pin->GetType() == ELECTRICAL_PINTYPE::PT_NC )
1819  continue;
1820 
1821  // Collect only pins attached to the current unit and convert.
1822  // others are not associated to this symbol instance
1823  int pin_unit = pin->GetLibPin()->GetUnit();
1824  int pin_convert = pin->GetLibPin()->GetConvert();
1825 
1826  if( pin_unit > 0 && pin_unit != GetUnit() )
1827  continue;
1828 
1829  if( pin_convert > 0 && pin_convert != GetConvert() )
1830  continue;
1831 
1832  if( pin->GetLocalPosition() == new_pos )
1833  return true;
1834  }
1835 
1836  return false;
1837 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:702
TRANSFORM InverseTransform() const
Calculate the Inverse mirror/rotation transform.
Definition: transform.cpp:57
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
wxPoint m_pos
Definition: sch_symbol.h:677
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:697
int GetUnit() const
Definition: sch_symbol.h:195
not connected (must be left open)
int GetConvert() const
Definition: sch_symbol.h:223

References GetConvert(), GetUnit(), TRANSFORM::InverseTransform(), m_pins, m_pos, m_transform, pin, PT_NC, and TRANSFORM::TransformCoordinate().

◆ Duplicate()

SCH_ITEM * SCH_ITEM::Duplicate ( bool  doClone = false) const
inherited

Routine to create a new copy of given item.

The new object is not put in draw list (not linked).

Parameters
doClone(default = false) indicates unique values (such as timestamp and sheet name) should be duplicated. Use only for undo/redo operations.

Definition at line 78 of file sch_item.cpp.

79 {
80  SCH_ITEM* newItem = (SCH_ITEM*) Clone();
81 
82  if( !doClone )
83  const_cast<KIID&>( newItem->m_Uuid ) = KIID();
84 
85  newItem->ClearFlags( SELECTED | BRIGHTENED );
86 
87  newItem->RunOnChildren(
88  []( SCH_ITEM* aChild )
89  {
90  aChild->ClearFlags( SELECTED | BRIGHTENED );
91  } );
92 
93  return newItem;
94 }
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:83
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction)
Definition: sch_item.h:438
Definition: kiid.h:44
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:154
#define SELECTED
const KIID m_Uuid
Definition: eda_item.h:475
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182
#define BRIGHTENED
item is drawn with a bright contour

References BRIGHTENED, EDA_ITEM::ClearFlags(), EDA_ITEM::Clone(), EDA_ITEM::m_Uuid, SCH_ITEM::RunOnChildren(), and SELECTED.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ FindField()

SCH_FIELD * SCH_SYMBOL::FindField ( const wxString &  aFieldName,
bool  aIncludeDefaultFields = true 
)

Search for a SCH_FIELD with aFieldName.

Parameters
aFieldNameis the name of the field to find.
aIncludeDefaultFieldssearches the library symbol default fields if true.
Returns
the field if found or NULL if the field was not found.

Definition at line 743 of file sch_symbol.cpp.

744 {
745  unsigned start = aIncludeDefaultFields ? 0 : MANDATORY_FIELDS;
746 
747  for( unsigned i = start; i < m_fields.size(); ++i )
748  {
749  if( aFieldName == m_fields[i].GetName( false ) )
750  return &m_fields[i];
751  }
752 
753  return nullptr;
754 }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.

References m_fields, and MANDATORY_FIELDS.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), NETLIST_EXPORTER_PSPICE::GetSpiceField(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), DIALOG_CHANGE_SYMBOLS::processSymbol(), and UpdateFields().

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 86 of file inspectable.h.

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

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

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

◆ Get() [2/3]

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

Definition at line 95 of file inspectable.h.

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

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

◆ Get() [3/3]

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

Definition at line 104 of file inspectable.h.

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

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

◆ GetBodyAndPinsBoundingBox()

EDA_RECT SCH_SYMBOL::GetBodyAndPinsBoundingBox ( ) const

Return a bounding box for the symbol body and pins but not the fields.

Definition at line 1352 of file sch_symbol.cpp.

1353 {
1354  return doGetBoundingBox( true, false );
1355 }
EDA_RECT doGetBoundingBox(bool aIncludePins, bool aIncludeFields) const

References doGetBoundingBox().

Referenced by AUTOPLACER::AUTOPLACER(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), and operator<().

◆ GetBodyBoundingBox()

EDA_RECT SCH_SYMBOL::GetBodyBoundingBox ( ) const

Return a bounding box for the symbol body but not the pins or fields.

Definition at line 1346 of file sch_symbol.cpp.

1347 {
1348  return doGetBoundingBox( false, false );
1349 }
EDA_RECT doGetBoundingBox(bool aIncludePins, bool aIncludeFields) const

References doGetBoundingBox().

Referenced by HitTest().

◆ GetBoundingBox()

const EDA_RECT SCH_SYMBOL::GetBoundingBox ( ) const
overridevirtual

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

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

Reimplemented from EDA_ITEM.

Definition at line 1358 of file sch_symbol.cpp.

1359 {
1360  return doGetBoundingBox( true, true );
1361 }
EDA_RECT doGetBoundingBox(bool aIncludePins, bool aIncludeFields) const

References doGetBoundingBox().

Referenced by SCH_EDITOR_CONTROL::FindSymbolAndItem(), and AUTOPLACER::getPossibleCollisions().

◆ GetClass()

wxString SCH_SYMBOL::GetClass ( ) const
inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 118 of file sch_symbol.h.

119  {
120  return wxT( "SCH_SYMBOL" );
121  }

Referenced by operator=().

◆ GetConnectionPoints()

std::vector< wxPoint > SCH_SYMBOL::GetConnectionPoints ( ) const
overridevirtual

Add all the connection points for this item to aPoints.

Not all schematic items have connection points so the default method does nothing.

Parameters
aPointsis the list of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 1584 of file sch_symbol.cpp.

1585 {
1586  std::vector<wxPoint> retval;
1587 
1588  for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
1589  {
1590  // Collect only pins attached to the current unit and convert.
1591  // others are not associated to this symbol instance
1592  int pin_unit = pin->GetLibPin()->GetUnit();
1593  int pin_convert = pin->GetLibPin()->GetConvert();
1594 
1595  if( pin_unit > 0 && pin_unit != GetUnit() )
1596  continue;
1597 
1598  if( pin_convert > 0 && pin_convert != GetConvert() )
1599  continue;
1600 
1601  retval.push_back( m_transform.TransformCoordinate( pin->GetLocalPosition() ) + m_pos );
1602  }
1603 
1604  return retval;
1605 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:702
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
wxPoint m_pos
Definition: sch_symbol.h:677
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:697
int GetUnit() const
Definition: sch_symbol.h:195
int GetConvert() const
Definition: sch_symbol.h:223

References GetConvert(), GetUnit(), m_pins, m_pos, m_transform, pin, and TRANSFORM::TransformCoordinate().

◆ GetContextualTextVars()

void SCH_SYMBOL::GetContextualTextVars ( wxArrayString *  aVars) const

Return the list of system text vars & fields for this symbol.

Definition at line 928 of file sch_symbol.cpp.

929 {
930  for( int i = 0; i < MANDATORY_FIELDS; ++i )
931  aVars->push_back( m_fields[i].GetCanonicalName().Upper() );
932 
933  for( size_t i = MANDATORY_FIELDS; i < m_fields.size(); ++i )
934  aVars->push_back( m_fields[i].GetName() );
935 
936  aVars->push_back( wxT( "FOOTPRINT_LIBRARY" ) );
937  aVars->push_back( wxT( "FOOTPRINT_NAME" ) );
938  aVars->push_back( wxT( "UNIT" ) );
939 }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.

References m_fields, and MANDATORY_FIELDS.

Referenced by DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), and DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded().

◆ GetConvert()

◆ GetDatasheet()

wxString SCH_SYMBOL::GetDatasheet ( ) const

Return the documentation text for the given part alias.

Definition at line 275 of file sch_symbol.cpp.

276 {
277  if( m_part )
278  return m_part->GetDatasheetField().GetText();
279 
280  return wxEmptyString;
281 }
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700

References m_part.

Referenced by UpdateFields().

◆ GetDescription()

wxString SCH_SYMBOL::GetDescription ( ) const

Return information about the aliased parts.

Definition at line 266 of file sch_symbol.cpp.

267 {
268  if( m_part )
269  return m_part->GetDescription();
270 
271  return wxEmptyString;
272 }
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700

References m_part.

Referenced by NETLIST_EXPORTER_XML::makeSymbols().

◆ GetDrawItem()

LIB_ITEM * SCH_SYMBOL::GetDrawItem ( const wxPoint &  aPosition,
KICAD_T  aType = TYPE_NOT_INIT 
)

Return the symbol library item at aPosition that is part of this symbol.

Parameters
aPositionis the schematic position of the symbol library object.
aTypeis the type of symbol library object to find or any if set to TYPE_NOT_INIT.
Returns
is the symbol library object if found otherwise NULL.

Definition at line 1608 of file sch_symbol.cpp.

1609 {
1610  if( m_part )
1611  {
1612  // Calculate the position relative to the symbol.
1613  wxPoint libPosition = aPosition - m_pos;
1614 
1615  return m_part->LocateDrawItem( m_unit, m_convert, aType, libPosition, m_transform );
1616  }
1617 
1618  return nullptr;
1619 }
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:679
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:680
wxPoint m_pos
Definition: sch_symbol.h:677
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:697

References m_convert, m_part, m_pos, m_transform, and m_unit.

Referenced by SCH_SCREEN::GetPin().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 158 of file eda_item.h.

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

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

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

◆ GetEndPoints()

void SCH_SYMBOL::GetEndPoints ( std::vector< DANGLING_END_ITEM > &  aItemList)
overridevirtual

Add the schematic item end points to aItemList if the item has end points.

The default version doesn't do anything since many of the schematic object cannot be tested for dangling ends. If you add a new schematic item that can have a dangling end ( no connect ), override this method to provide the correct end points.

Parameters
aItemListis the list of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 1510 of file sch_symbol.cpp.

1511 {
1512  for( auto& pin : m_pins )
1513  {
1514  LIB_PIN* lib_pin = pin->GetLibPin();
1515 
1516  if( lib_pin->GetUnit() && m_unit && ( m_unit != lib_pin->GetUnit() ) )
1517  continue;
1518 
1519  DANGLING_END_ITEM item( PIN_END, lib_pin, GetPinPhysicalPosition( lib_pin ), this );
1520  aItemList.push_back( item );
1521  }
1522 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:702
wxPoint GetPinPhysicalPosition(const LIB_PIN *Pin) const
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:679
int GetUnit() const
Definition: lib_item.h:258
Helper class used to store the state of schematic items that can be connected to other schematic item...
Definition: sch_item.h:79

References GetPinPhysicalPosition(), LIB_ITEM::GetUnit(), m_pins, m_unit, pin, and PIN_END.

◆ GetField() [1/2]

SCH_FIELD * SCH_SYMBOL::GetField ( MANDATORY_FIELD_T  aFieldType)

◆ GetField() [2/2]

const SCH_FIELD * SCH_SYMBOL::GetField ( MANDATORY_FIELD_T  aFieldNdx) const

Definition at line 681 of file sch_symbol.cpp.

682 {
683  return &m_fields[aFieldType];
684 }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698

References m_fields.

◆ GetFieldById()

SCH_FIELD * SCH_SYMBOL::GetFieldById ( int  aFieldId)

Return a field in this symbol.

Parameters
aFieldIdis the id of the field requested. Note that this id ONLY SOMETIMES equates to the field's position in the vector.
Returns
is the field at aFieldType or NULL if the field does not exist.

Definition at line 687 of file sch_symbol.cpp.

688 {
689  for( size_t ii = 0; ii < m_fields.size(); ++ii )
690  {
691  if( m_fields[ii].GetId() == aFieldId )
692  return &m_fields[ii];
693  }
694 
695  return nullptr;
696 }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698

References m_fields.

Referenced by SCH_SYMBOL(), and UpdateFields().

◆ GetFieldCount()

◆ GetFields() [1/3]

void SCH_SYMBOL::GetFields ( std::vector< SCH_FIELD * > &  aVector,
bool  aVisibleOnly 
)

Populate a std::vector with SCH_FIELDs.

Parameters
aVectoris the vector to populate.
aVisibleOnlyis used to add only the fields that are visible and contain text.

Definition at line 711 of file sch_symbol.cpp.

712 {
713  for( SCH_FIELD& field : m_fields )
714  {
715  if( !aVisibleOnly || ( field.IsVisible() && !field.IsVoid() ) )
716  aVector.push_back( &field );
717  }
718 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698

References m_fields.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), AUTOPLACER::AUTOPLACER(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDITOR_CONTROL::nextMatch(), operator==(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), EE_SELECTION_TOOL::selectMultiple(), ERC_TESTER::TestTextVars(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_CHANGE_SYMBOLS::updateFieldsList(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetFields() [2/3]

std::vector<SCH_FIELD>& SCH_SYMBOL::GetFields ( )
inline

Return a vector of fields from the symbol.

Definition at line 369 of file sch_symbol.h.

369 { return m_fields; }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698

References m_fields.

Referenced by operator==().

◆ GetFields() [3/3]

const std::vector<SCH_FIELD>& SCH_SYMBOL::GetFields ( ) const
inline

Definition at line 370 of file sch_symbol.h.

370 { return m_fields; }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698

References m_fields.

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const
inlineinherited

Return whether the fields have been automatically placed.

Definition at line 418 of file sch_item.h.

418 { return m_fieldsAutoplaced; }
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:483

References SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_ITEM::AutoAutoplaceFields(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), and EE_POINT_EDITOR::updateParentItem().

◆ GetFieldText()

wxString SCH_SYMBOL::GetFieldText ( const wxString &  aFieldName,
SCH_EDIT_FRAME aFrame 
) const

Search for a field named aFieldName and returns text associated with this field.

Parameters
aFieldNameis the name of the field

Definition at line 699 of file sch_symbol.cpp.

700 {
701  for( const SCH_FIELD& field : m_fields )
702  {
703  if( aFieldName == field.GetName() || aFieldName == field.GetCanonicalName() )
704  return field.GetText();
705  }
706 
707  return wxEmptyString;
708 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698

References m_fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn().

◆ GetFlags()

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

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

Reimplemented in BOARD, PCB_TRACK, and PCB_SHAPE.

Definition at line 259 of file eda_item.h.

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

References EDA_ITEM::GetPosition().

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

◆ GetFootprint()

const wxString SCH_SYMBOL::GetFootprint ( const SCH_SHEET_PATH sheet,
bool  aResolve 
) const

Return the instance-specific footprint assignment for the given sheet path.

Definition at line 624 of file sch_symbol.cpp.

625 {
626  KIID_PATH path = sheet->Path();
627 
628  for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
629  {
630  if( instance.m_Path == path && !instance.m_Footprint.IsEmpty() )
631  {
632  // This can only be an override from an Update Schematic from PCB, and therefore
633  // will always be fully resolved.
634  return instance.m_Footprint;
635  }
636  }
637 
638  if( !aResolve )
639  return GetField( FOOTPRINT_FIELD )->GetText();
640 
642 }
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:675
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_field.cpp:105
A simple container for schematic symbol instance information.
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:711
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133
Field Name Module PCB, i.e. "16DIP300".

References FOOTPRINT_FIELD, GetField(), SCH_FIELD::GetShownText(), EDA_TEXT::GetText(), m_instanceReferences, SCH_SHEET_PATH::Path(), and path.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), GetMsgPanelInfo(), SCH_FIELD::Replace(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SYMBOL(), SCH_SHEET_PATH::UpdateAllScreenReferences(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ GetIncludeInBom()

bool SCH_SYMBOL::GetIncludeInBom ( ) const
inline

Definition at line 662 of file sch_symbol.h.

662 { return m_inBom; }
bool m_inBom
True to include in bill of materials export.
Definition: sch_symbol.h:706

References m_inBom.

Referenced by NETLIST_EXPORTER_XML::makeListOfNets(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_SEXPR_PLUGIN::saveSymbol(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetIncludeOnBoard()

bool SCH_SYMBOL::GetIncludeOnBoard ( ) const
inline

◆ GetInstanceReferences()

const std::vector<SYMBOL_INSTANCE_REFERENCE>& SCH_SYMBOL::GetInstanceReferences ( )
inline

Definition at line 123 of file sch_symbol.h.

124  {
125  return m_instanceReferences;
126  }
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:711

References m_instanceReferences.

Referenced by DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), and SCH_LEGACY_PLUGIN::saveSymbol().

◆ GetLayer()

◆ GetLibId()

◆ GetLibPins()

void SCH_SYMBOL::GetLibPins ( std::vector< LIB_PIN * > &  aPinsList) const

Populate a vector with all the pins from the library object.

Parameters
aPinsListis the list to populate with all of the pins.

Definition at line 852 of file sch_symbol.cpp.

853 {
854  if( m_part )
855  m_part->GetPins( aPinsList, m_unit, m_convert );
856 }
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:679
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:680
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700

References m_convert, m_part, and m_unit.

◆ GetLibSymbolRef() [1/2]

◆ GetLibSymbolRef() [2/2]

const std::unique_ptr< LIB_SYMBOL >& SCH_SYMBOL::GetLibSymbolRef ( ) const
inline

Definition at line 165 of file sch_symbol.h.

165 { return m_part; }
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700

References m_part.

◆ GetMenuImage()

BITMAPS SCH_SYMBOL::GetMenuImage ( ) const
overridevirtual

Return 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 from EDA_ITEM.

Definition at line 1440 of file sch_symbol.cpp.

1441 {
1442  return BITMAPS::add_component;
1443 }

References add_component.

◆ GetMsgPanelInfo()

void SCH_SYMBOL::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters
aListis the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 1364 of file sch_symbol.cpp.

1365 {
1366  wxString msg;
1367 
1368  SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( aFrame );
1369  SCH_SHEET_PATH* currentSheet = schframe ? &schframe->GetCurrentSheet() : nullptr;
1370 
1371  // part and alias can differ if alias is not the root
1372  if( m_part )
1373  {
1374  if( m_part.get() != dummy() )
1375  {
1376  aList.emplace_back( _( "Reference" ), GetRef( currentSheet ) );
1377 
1378  msg = m_part->IsPower() ? _( "Power symbol" ) : _( "Value" );
1379  aList.emplace_back( msg, GetValue( currentSheet, true ) );
1380 
1381 #if 0 // Display symbol flags, for debug only
1382  aList.emplace_back( _( "flags" ), wxString::Format( "%X", GetEditFlags() ) );
1383 #endif
1384 
1385  // Display symbol reference in library and library
1386  aList.emplace_back( _( "Name" ), UnescapeString( GetLibId().GetLibItemName() ) );
1387 
1388  if( !m_part->IsRoot() )
1389  {
1390  msg = _( "Missing parent" );
1391 
1392  std::shared_ptr< LIB_SYMBOL > parent = m_part->GetParent().lock();
1393 
1394  if( parent )
1395  msg = parent->GetName();
1396 
1397  aList.emplace_back( _( "Alias of" ), UnescapeString( msg ) );
1398  }
1399  else if( !m_lib_id.GetLibNickname().empty() )
1400  {
1401  aList.emplace_back( _( "Library" ), m_lib_id.GetLibNickname() );
1402  }
1403  else
1404  {
1405  aList.emplace_back( _( "Library" ), _( "Undefined!!!" ) );
1406  }
1407 
1408  // Display the current associated footprint, if exists.
1409  msg = GetFootprint( currentSheet, true );
1410 
1411  if( msg.IsEmpty() )
1412  msg = _( "<Unknown>" );
1413 
1414  aList.emplace_back( _( "Footprint" ), msg );
1415 
1416  // Display description of the symbol, and keywords found in lib
1417  aList.emplace_back( _( "Description" ), m_part->GetDescription() );
1418  aList.emplace_back( _( "Keywords" ), m_part->GetKeyWords() );
1419  }
1420  }
1421  else
1422  {
1423  aList.emplace_back( _( "Reference" ), GetRef( currentSheet ) );
1424 
1425  aList.emplace_back( _( "Value" ), GetValue( currentSheet, true ) );
1426  aList.emplace_back( _( "Name" ), GetLibId().GetLibItemName() );
1427 
1428  wxString libNickname = GetLibId().GetLibNickname();
1429 
1430  if( libNickname.empty() )
1431  msg = _( "No library defined!" );
1432  else
1433  msg.Printf( _( "Symbol not found in %s!" ), libNickname );
1434 
1435  aList.emplace_back( _( "Library" ), msg );
1436  }
1437 }
Schematic editor (Eeschema) main window.
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:441
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:72
#define _(s)
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:90
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700
EDA_ITEM_FLAGS GetEditFlags() const
Definition: eda_item.h:158
const wxString GetValue(const SCH_SHEET_PATH *sheet, bool aResolve) const
Return the instance-specific value for the given sheet path.
Definition: sch_symbol.cpp:573
wxString UnescapeString(const wxString &aSource)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_symbol.h:678
SCH_SHEET_PATH & GetCurrentSheet() const
const wxString GetFootprint(const SCH_SHEET_PATH *sheet, bool aResolve) const
Return the instance-specific footprint assignment for the given sheet path.
Definition: sch_symbol.cpp:624
const LIB_ID & GetLibId() const
Definition: sch_symbol.h:147
bool empty() const
Definition: utf8.h:103

References _, dummy(), UTF8::empty(), Format(), SCH_EDIT_FRAME::GetCurrentSheet(), EDA_ITEM::GetEditFlags(), GetFootprint(), GetLibId(), LIB_ID::GetLibNickname(), GetRef(), GetValue(), m_lib_id, m_part, and UnescapeString().

◆ GetOrientation()

int SCH_SYMBOL::GetOrientation ( )

Get the display symbol orientation.

Because there are different ways to have a given orientation/mirror, the orientation/mirror is not necessary what the user does. For example: a mirrorV then a mirrorH returns no mirror but a rotate. This function finds a rotation and a mirror value SYM_MIRROR_X because this is the first mirror option tested. This can differs from the orientation made by an user. A SYM_MIRROR_Y is returned as a SYM_MIRROR_X with an orientation 180 because they are equivalent.

See also
SYMBOL_ORIENTATION_T
Returns
the orientation and mirror of the symbol.

Definition at line 1232 of file sch_symbol.cpp.

1233 {
1234  int rotate_values[] =
1235  {
1236  SYM_ORIENT_0,
1237  SYM_ORIENT_90,
1243  SYM_MIRROR_Y,
1248  };
1249 
1250  // Try to find the current transform option:
1251  TRANSFORM transform = m_transform;
1252 
1253  for( int type_rotate : rotate_values )
1254  {
1255  SetOrientation( type_rotate );
1256 
1257  if( transform == m_transform )
1258  return type_rotate;
1259  }
1260 
1261  // Error: orientation not found in list (should not happen)
1262  wxFAIL_MSG( "Schematic symbol orientation matrix internal error." );
1263  m_transform = transform;
1264 
1265  return SYM_NORMAL;
1266 }
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:697

References m_transform, SetOrientation(), SYM_MIRROR_X, SYM_MIRROR_Y, SYM_NORMAL, SYM_ORIENT_0, SYM_ORIENT_180, SYM_ORIENT_270, and SYM_ORIENT_90.

Referenced by KIGFX::SCH_PAINTER::draw(), AUTOPLACER::getPreferredSides(), orientLabel(), SCH_SEXPR_PLUGIN::saveSymbol(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetParent()

◆ GetPenWidth()

virtual int SCH_ITEM::GetPenWidth ( ) const
inlinevirtualinherited

◆ GetPin() [1/2]

SCH_PIN * SCH_SYMBOL::GetPin ( const wxString &  number) const

Find a symbol pin by number.

Parameters
numberis the number of the pin to find.
Returns
Pin object if found, otherwise NULL.

Definition at line 840 of file sch_symbol.cpp.

841 {
842  for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
843  {
844  if( pin->GetNumber() == aNumber )
845  return pin.get();
846  }
847 
848  return nullptr;
849 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:702

References m_pins, and pin.

Referenced by BACK_ANNOTATE::applyChangelist(), KIGFX::SCH_PAINTER::draw(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetPin() [2/2]

SCH_PIN * SCH_SYMBOL::GetPin ( LIB_PIN aLibPin)

Definition at line 859 of file sch_symbol.cpp.

860 {
861  wxASSERT( m_pinMap.count( aLibPin ) );
862  return m_pins[ m_pinMap.at( aLibPin ) ].get();
863 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:702
std::unordered_map< LIB_PIN *, unsigned > m_pinMap
Definition: sch_symbol.h:703

References m_pinMap, and m_pins.

◆ GetPinPhysicalPosition()

wxPoint SCH_SYMBOL::GetPinPhysicalPosition ( const LIB_PIN Pin) const

Definition at line 1575 of file sch_symbol.cpp.

1576 {
1577  wxCHECK_MSG( Pin != nullptr && Pin->Type() == LIB_PIN_T, wxPoint( 0, 0 ),
1578  wxT( "Cannot get physical position of pin." ) );
1579 
1580  return m_transform.TransformCoordinate( Pin->GetPosition() ) + m_pos;
1581 }
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
wxPoint m_pos
Definition: sch_symbol.h:677
wxPoint GetPosition() const override
Definition: lib_pin.h:210
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:697
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References LIB_PIN::GetPosition(), LIB_PIN_T, m_pos, m_transform, TRANSFORM::TransformCoordinate(), and EDA_ITEM::Type().

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_EAGLE_PLUGIN::checkConnections(), GetEndPoints(), and SCH_SCREEN::GetPin().

◆ GetPins()

std::vector< SCH_PIN * > SCH_SYMBOL::GetPins ( const SCH_SHEET_PATH aSheet = nullptr) const

Retrieve a list of the SCH_PINs for the given sheet path.

Since a symbol can have a different unit on a different instance of a sheet, this list returns the subset of pins that exist on a given sheet.

Returns
a vector of pointers (non-owning) to SCH_PINs

Definition at line 866 of file sch_symbol.cpp.

867 {
868  std::vector<SCH_PIN*> pins;
869 
870  if( aSheet == nullptr )
871  {
872  wxCHECK_MSG( Schematic(), pins, "Can't call GetPins on a symbol with no schematic" );
873 
874  aSheet = &Schematic()->CurrentSheet();
875  }
876 
877  int unit = GetUnitSelection( aSheet );
878 
879  for( const auto& p : m_pins )
880  {
881  if( unit && p->GetLibPin()->GetUnit() && ( p->GetLibPin()->GetUnit() != unit ) )
882  continue;
883 
884  pins.push_back( p.get() );
885  }
886 
887  return pins;
888 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:702
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
int GetUnitSelection(const SCH_SHEET_PATH *aSheet) const
Return the instance-specific unit selection for the given sheet path.
Definition: sch_symbol.cpp:531
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:121

References SCHEMATIC::CurrentSheet(), GetUnitSelection(), m_pins, and SCH_ITEM::Schematic().

Referenced by NETLIST_EXPORTER_BASE::CreatePinList(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), SCH_EDITOR_CONTROL::nextMatch(), SCH_EDITOR_CONTROL::Paste(), AUTOPLACER::pinsOnSide(), SCH_SEXPR_PLUGIN::saveSymbol(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), ERC_TESTER::TestNoConnectPins(), CONNECTION_GRAPH::updateItemConnectivity(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ GetPosition()

◆ GetPrefix()

wxString SCH_SYMBOL::GetPrefix ( ) const
inline

Definition at line 227 of file sch_symbol.h.

227 { return m_prefix; }
wxString m_prefix
C, R, U, Q etc - the first character(s) which typically indicate what the symbol is.
Definition: sch_symbol.h:683

References m_prefix.

Referenced by SCH_LEGACY_PLUGIN::saveSymbol().

◆ GetRawPins()

std::vector<std::unique_ptr<SCH_PIN> >& SCH_SYMBOL::GetRawPins ( )
inline

Definition at line 470 of file sch_symbol.h.

470 { return m_pins; }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:702

References m_pins.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ GetRef()

const wxString SCH_SYMBOL::GetRef ( const SCH_SHEET_PATH aSheet,
bool  aIncludeUnit = false 
) const

Return the reference for the given sheet path.

Returns
the reference for the sheet.

Definition at line 441 of file sch_symbol.cpp.

442 {
443  KIID_PATH path = sheet->Path();
444  wxString ref;
445 
446  for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
447  {
448  if( instance.m_Path == path )
449  {
450  ref = instance.m_Reference;
451  break;
452  }
453  }
454 
455  // If it was not found in m_Paths array, then see if it is in m_Field[REFERENCE] -- if so,
456  // use this as a default for this path. This will happen if we load a version 1 schematic
457  // file. It will also mean that multiple instances of the same sheet by default all have
458  // the same symbol references, but perhaps this is best.
459  if( ref.IsEmpty() && !GetField( REFERENCE_FIELD )->GetText().IsEmpty() )
460  {
461  const_cast<SCH_SYMBOL*>( this )->SetRef( sheet, GetField( REFERENCE_FIELD )->GetText() );
462  ref = GetField( REFERENCE_FIELD )->GetText();
463  }
464 
465  if( ref.IsEmpty() )
467 
468  if( aIncludeUnit && GetUnitCount() > 1 )
469  ref += LIB_SYMBOL::SubReference( GetUnit() );
470 
471  return ref;
472 }
Field Reference of part, i.e. "IC21".
wxString m_prefix
C, R, U, Q etc - the first character(s) which typically indicate what the symbol is.
Definition: sch_symbol.h:683
wxString GetRefDesUnannotated(const wxString &aSource)
Return an unannotated refdes from either a prefix or an existing refdes.
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:675
int GetUnitCount() const
Return the number of units per package of the symbol.
Definition: sch_symbol.cpp:370
static wxString SubReference(int aUnit, bool aAddSeparator=true)
Definition: lib_symbol.cpp:444
A simple container for schematic symbol instance information.
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:711
int GetUnit() const
Definition: sch_symbol.h:195
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133

References GetField(), UTIL::GetRefDesUnannotated(), EDA_TEXT::GetText(), GetUnit(), GetUnitCount(), m_instanceReferences, m_prefix, SCH_SHEET_PATH::Path(), path, REFERENCE_FIELD, and LIB_SYMBOL::SubReference().

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), SCH_SHEET_PATH::AppendMultiUnitSymbol(), SCH_SHEET_PATH::AppendSymbol(), SCHEMATIC::ConvertKIIDsToRefs(), SCHEMATIC::ConvertRefsToKIIDs(), NETLIST_EXPORTER_BASE::CreatePinList(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), NETLIST_EXPORTER_BASE::findNextSymbol(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_PIN::GetDefaultNetName(), SCH_PIN::GetMsgPanelInfo(), GetMsgPanelInfo(), DIALOG_CHANGE_SYMBOLS::isMatch(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_FIELD::Matches(), SCH_EDITOR_CONTROL::Paste(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), SCH_REFERENCE_LIST::ReannotateDuplicates(), SCH_FIELD::Replace(), SCHEMATIC::ResolveCrossReference(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), ERC_TESTER::TestMultiunitFootprints(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

◆ GetSchSymbolLibraryName()

wxString SCH_SYMBOL::GetSchSymbolLibraryName ( ) const

Definition at line 248 of file sch_symbol.cpp.

249 {
250  if( !m_schLibSymbolName.IsEmpty() )
251  return m_schLibSymbolName;
252  else
253  return m_lib_id.Format();
254 }
wxString m_schLibSymbolName
The name used to look up a symbol in the symbol library embedded in a schematic.
Definition: sch_symbol.h:695
UTF8 Format() const
Definition: lib_id.cpp:116
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_symbol.h:678

References LIB_ID::Format(), m_lib_id, and m_schLibSymbolName.

Referenced by SCH_SCREEN::Append(), NETLIST_EXPORTER_BASE::findNextSymbol(), SCH_SEXPR_PLUGIN::Format(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDITOR_CONTROL::Paste(), SCH_SCREEN::Remove(), and SCH_SEXPR_PLUGIN::saveSymbol().

◆ GetSelectMenuText()

wxString SCH_SYMBOL::GetSelectMenuText ( EDA_UNITS  aUnits) const
overridevirtual

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

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

Returns
The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 1622 of file sch_symbol.cpp.

1623 {
1624  return wxString::Format( _( "Symbol %s [%s]" ),
1625  GetField( REFERENCE_FIELD )->GetShownText(),
1626  UnescapeString( GetLibId().GetLibItemName() ) );
1627 }
Field Reference of part, i.e. "IC21".
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:675
#define _(s)
wxString UnescapeString(const wxString &aSource)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
const LIB_ID & GetLibId() const
Definition: sch_symbol.h:147

References _, Format(), GetField(), GetLibId(), REFERENCE_FIELD, and UnescapeString().

Referenced by Matches().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS  type) const
inlineinherited

Definition at line 137 of file eda_item.h.

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

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 150 of file eda_item.h.

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

References EDA_ITEM::m_status.

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 220 of file sch_item.h.

220 { return m_storedPos; }
wxPoint m_storedPos
Definition: sch_item.h:484

References SCH_ITEM::m_storedPos.

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const
inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 449 of file sch_item.h.

449 { wxCHECK( false, STROKE_PARAMS() ); }
Simple container to manage line stroke parameters.
Definition: sch_item.h:140

Referenced by DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataToWindow().

◆ GetTransform() [1/2]

◆ GetTransform() [2/2]

const TRANSFORM& SCH_SYMBOL::GetTransform ( ) const
inline

Definition at line 232 of file sch_symbol.h.

232 { return m_transform; }
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:697

References m_transform.

◆ GetUnit()

◆ GetUnitCount()

int SCH_SYMBOL::GetUnitCount ( void  ) const

Return the number of units per package of the symbol.

Returns
the number of units per package or zero if the library entry cannot be found.

Definition at line 370 of file sch_symbol.cpp.

371 {
372  if( m_part )
373  return m_part->GetUnitCount();
374 
375  return 0;
376 }
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700

References m_part.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), GetRef(), SCH_FIELD::GetShownText(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_FIELD::Matches(), SCH_DRAWING_TOOLS::PlaceSymbol(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetUnitSelection()

int SCH_SYMBOL::GetUnitSelection ( const SCH_SHEET_PATH aSheet) const

Return the instance-specific unit selection for the given sheet path.

Definition at line 531 of file sch_symbol.cpp.

532 {
533  KIID_PATH path = aSheet->Path();
534 
535  for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
536  {
537  if( instance.m_Path == path )
538  return instance.m_Unit;
539  }
540 
541  // If it was not found in m_Paths array, then use m_unit. This will happen if we load a
542  // version 1 schematic file.
543  return m_unit;
544 }
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:679
A simple container for schematic symbol instance information.
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:711

References m_instanceReferences, m_unit, SCH_SHEET_PATH::Path(), and path.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), KIGFX::SCH_PAINTER::draw(), GetPins(), SCH_EDIT_FRAME::mapExistingAnnotation(), ResolveTextVar(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_REFERENCE::SCH_REFERENCE(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

◆ GetValue()

const wxString SCH_SYMBOL::GetValue ( const SCH_SHEET_PATH sheet,
bool  aResolve 
) const

Return the instance-specific value for the given sheet path.

Definition at line 573 of file sch_symbol.cpp.

574 {
575  KIID_PATH path = sheet->Path();
576 
577  for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
578  {
579  if( instance.m_Path == path && !instance.m_Value.IsEmpty() )
580  {
581  // This can only be an override from an Update Schematic from PCB, and therefore
582  // will always be fully resolved.
583  return instance.m_Value;
584  }
585  }
586 
587  if( !aResolve )
588  return GetField( VALUE_FIELD )->GetText();
589 
590  return GetField( VALUE_FIELD )->GetShownText();
591 }
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:675
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_field.cpp:105
Field Value of part, i.e. "3.3K".
A simple container for schematic symbol instance information.
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:711
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133

References GetField(), SCH_FIELD::GetShownText(), EDA_TEXT::GetText(), m_instanceReferences, SCH_SHEET_PATH::Path(), path, and VALUE_FIELD.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), SCH_PIN::GetMsgPanelInfo(), GetMsgPanelInfo(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_FIELD::Replace(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SYMBOL(), SCH_SHEET_PATH::UpdateAllScreenReferences(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

◆ HasBrightenedPins()

bool SCH_SYMBOL::HasBrightenedPins ( )

Definition at line 1863 of file sch_symbol.cpp.

1864 {
1865  for( const auto& pin : m_pins )
1866  {
1867  if( pin->IsBrightened() )
1868  return true;
1869  }
1870 
1871  return false;
1872 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:702

References m_pins, and pin.

Referenced by SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ HasFlag()

◆ HasLineStroke()

virtual bool SCH_ITEM::HasLineStroke ( ) const
inlinevirtualinherited

Check if this schematic item has line stoke properties.

See also
STROKE_PARAMS
Returns
true if this schematic item support line stroke properties. Otherwise, false.

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 447 of file sch_item.h.

447 { return false; }

Referenced by EE_SELECTION::AllItemsHaveLineStroke(), and SCH_EDIT_TOOL::Properties().

◆ HitTest() [1/2]

bool SCH_SYMBOL::HitTest ( const wxPoint &  aPosition,
int  aAccuracy = 0 
) const
overridevirtual

Test if aPosition is contained within or on the bounding box of an item.

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
aAccuracyIncrease the item bounding box by this amount.
Returns
True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 1784 of file sch_symbol.cpp.

1785 {
1786  EDA_RECT bBox = GetBodyBoundingBox();
1787  bBox.Inflate( aAccuracy );
1788 
1789  if( bBox.Contains( aPosition ) )
1790  return true;
1791 
1792  return false;
1793 }
bool Contains(const wxPoint &aPoint) const
Definition: eda_rect.cpp:57
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the pins or fields.
Handle the component boundary box.
Definition: eda_rect.h:42
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Inflate the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:364

References EDA_RECT::Contains(), GetBodyBoundingBox(), and EDA_RECT::Inflate().

◆ HitTest() [2/2]

bool SCH_SYMBOL::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
overridevirtual

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

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

Reimplemented from EDA_ITEM.

Definition at line 1796 of file sch_symbol.cpp.

1797 {
1799  return false;
1800 
1801  EDA_RECT rect = aRect;
1802 
1803  rect.Inflate( aAccuracy );
1804 
1805  if( aContained )
1806  return rect.Contains( GetBodyBoundingBox() );
1807 
1808  return rect.Intersects( GetBodyBoundingBox() );
1809 }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
bool Contains(const wxPoint &aPoint) const
Definition: eda_rect.cpp:57
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the pins or fields.
#define STRUCT_DELETED
flag indication structures to be erased
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Handle the component boundary box.
Definition: eda_rect.h:42
bool Intersects(const EDA_RECT &aRect) const
Test for a common area between rectangles.
Definition: eda_rect.cpp:150
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Inflate the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:364

References EDA_RECT::Contains(), GetBodyBoundingBox(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), EDA_ITEM::m_flags, SKIP_STRUCT, and STRUCT_DELETED.

◆ Init()

void SCH_SYMBOL::Init ( const wxPoint &  pos = wxPoint( 0, 0 ))
private

Definition at line 194 of file sch_symbol.cpp.

195 {
196  m_pos = pos;
197  m_unit = 1; // In multi unit chip - which unit to draw.
198  m_convert = LIB_ITEM::LIB_CONVERT::BASE; // De Morgan Handling
199 
200  // The rotation/mirror transformation matrix. pos normal
202 
203  // construct only the mandatory fields, which are the first 4 only.
204  for( int i = 0; i < MANDATORY_FIELDS; ++i )
205  {
206  m_fields.emplace_back( pos, i, this, TEMPLATE_FIELDNAME::GetDefaultFieldName( i ) );
207 
208  if( i == REFERENCE_FIELD )
209  m_fields.back().SetLayer( LAYER_REFERENCEPART );
210  else if( i == VALUE_FIELD )
211  m_fields.back().SetLayer( LAYER_VALUEPART );
212  else
213  m_fields.back().SetLayer( LAYER_FIELDS );
214  }
215 
216  m_prefix = wxString( wxT( "U" ) );
217  m_isInNetlist = true;
218  m_inBom = true;
219  m_onBoard = true;
220 }
bool m_isInNetlist
True if the symbol should appear in the netlist.
Definition: sch_symbol.h:705
Field Reference of part, i.e. "IC21".
wxString m_prefix
C, R, U, Q etc - the first character(s) which typically indicate what the symbol is.
Definition: sch_symbol.h:683
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:679
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:680
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
Field Value of part, i.e. "3.3K".
wxPoint m_pos
Definition: sch_symbol.h:677
static const wxString GetDefaultFieldName(int aFieldNdx, bool aTranslate=true)
Return a default symbol field name for field aFieldNdx for all components.
bool m_onBoard
True to include in netlist when updating board.
Definition: sch_symbol.h:707
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
bool m_inBom
True to include in bill of materials export.
Definition: sch_symbol.h:706
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:697

References TEMPLATE_FIELDNAME::GetDefaultFieldName(), LAYER_FIELDS, LAYER_REFERENCEPART, LAYER_VALUEPART, m_convert, m_fields, m_inBom, m_isInNetlist, m_onBoard, m_pos, m_prefix, m_transform, m_unit, MANDATORY_FIELDS, REFERENCE_FIELD, and VALUE_FIELD.

Referenced by SCH_SYMBOL().

◆ InitializeConnection()

SCH_CONNECTION * SCH_ITEM::InitializeConnection ( const SCH_SHEET_PATH aPath,
CONNECTION_GRAPH aGraph 
)
inherited

Create a new connection object associated with this object.

Parameters
aPathis the sheet path to initialize.

Definition at line 176 of file sch_item.cpp.

178 {
179  SCH_CONNECTION* connection = Connection( &aSheet );
180 
181  if( connection )
182  {
183  connection->Reset();
184  }
185  else
186  {
187  connection = new SCH_CONNECTION( this );
188  m_connection_map.insert( std::make_pair( aSheet, connection ) );
189  }
190 
191  connection->SetGraph( aGraph );
192  connection->SetSheet( aSheet );
193  return connection;
194 }
void SetSheet(SCH_SHEET_PATH aSheet)
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:131
void Reset()
Clears connectivity information.
void SetGraph(CONNECTION_GRAPH *aGraph)
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Store connectivity information, per sheet.
Definition: sch_item.h:491
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).

References SCH_ITEM::Connection(), SCH_ITEM::m_connection_map, SCH_CONNECTION::Reset(), SCH_CONNECTION::SetGraph(), and SCH_CONNECTION::SetSheet().

◆ IsAnnotated()

bool SCH_SYMBOL::IsAnnotated ( const SCH_SHEET_PATH aSheet)

Check if the symbol has a valid annotation (reference) for the given sheet path.

Parameters
aSheetis the sheet path to test.
Returns
true if the symbol exists on that sheet and has a valid reference.

Definition at line 517 of file sch_symbol.cpp.

518 {
519  KIID_PATH path = aSheet->Path();
520 
521  for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
522  {
523  if( instance.m_Path == path )
524  return instance.m_Reference.Last() != '?';
525  }
526 
527  return false;
528 }
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
A simple container for schematic symbol instance information.
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:711

References m_instanceReferences, SCH_SHEET_PATH::Path(), and path.

Referenced by SCH_EDIT_FRAME::mapExistingAnnotation(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ IsBrightened()

◆ IsConnectable()

bool SCH_SYMBOL::IsConnectable ( ) const
inlineoverridevirtual
Returns
true if the schematic item can connect to another schematic item.

Reimplemented from SCH_ITEM.

Definition at line 600 of file sch_symbol.h.

600 { return true; }

◆ IsConnected()

bool SCH_ITEM::IsConnected ( const wxPoint &  aPoint) const
inherited

Test the item to see if it is connected to aPoint.

Parameters
aPointis a reference to a wxPoint object containing the coordinates to test.
Returns
True if connection to aPoint exists.

Definition at line 122 of file sch_item.cpp.

123 {
124  if(( m_flags & STRUCT_DELETED ) || ( m_flags & SKIP_STRUCT ) )
125  return false;
126 
127  return doIsConnected( aPosition );
128 }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
#define STRUCT_DELETED
flag indication structures to be erased
#define SKIP_STRUCT
flag indicating that the structure should be ignored
virtual bool doIsConnected(const wxPoint &aPosition) const
Provide the object specific test to see if it is connected to aPosition.
Definition: sch_item.h:478

References SCH_ITEM::doIsConnected(), EDA_ITEM::m_flags, SKIP_STRUCT, and STRUCT_DELETED.

Referenced by SCH_SCREEN::IsJunctionNeeded(), and SCH_SCREEN::IsTerminalPoint().

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( )
inlineinherited

Definition at line 409 of file sch_item.h.

409 { return m_connectivity_dirty; }
bool m_connectivity_dirty
Definition: sch_item.h:493

References SCH_ITEM::m_connectivity_dirty.

◆ IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const
inlinevirtualinherited

Reimplemented in SCH_TEXT, SCH_LINE, SCH_BUS_ENTRY_BASE, and SCH_PIN.

Definition at line 340 of file sch_item.h.

340 { return false; }

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 121 of file eda_item.h.

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

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const
inlineinherited

Definition at line 124 of file eda_item.h.

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

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 206 of file eda_item.h.

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

References EDA_ITEM::m_forceVisible.

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

◆ IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const
inlinevirtualinherited

Allow items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD.

Definition at line 250 of file sch_item.h.

250 { return false; }

◆ IsInNetlist()

bool SCH_SYMBOL::IsInNetlist ( ) const
Returns
true if the symbol is in netlist.

Definition at line 1840 of file sch_symbol.cpp.

1841 {
1842  return m_isInNetlist;
1843 }
bool m_isInNetlist
True if the symbol should appear in the netlist.
Definition: sch_symbol.h:705

References m_isInNetlist.

Referenced by AUTOPLACER::AUTOPLACER().

◆ IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const
inlinevirtualinherited
Returns
true if the object is locked, else false.

Definition at line 240 of file sch_item.h.

240 { return false; }

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 118 of file eda_item.h.

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

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

bool SCH_SYMBOL::IsMovableFromAnchorPoint ( ) const
inlineoverridevirtual

Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor.

Usually return true for small items (labels, junctions) and false for items which can be large (hierarchical sheets, symbols).

Note
We used to try and be smart about this and return false for symbols in case they are big. However, this annoyed some users and we now have a preference which controls warping on move in general, so this was switched to true for symbols.
Returns
true for a symbol.

Reimplemented from SCH_ITEM.

Definition at line 143 of file sch_symbol.h.

143 { return true; }

◆ IsMoving()

◆ IsNew()

◆ IsPointClickableAnchor()

bool SCH_SYMBOL::IsPointClickableAnchor ( const wxPoint &  aPos) const
overridevirtual
Returns
true if the given point can start drawing (usually means the anchor is unused/free/dangling).

Reimplemented from SCH_ITEM.

Definition at line 1882 of file sch_symbol.cpp.

1883 {
1884  for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
1885  {
1886  int pin_unit = pin->GetLibPin()->GetUnit();
1887  int pin_convert = pin->GetLibPin()->GetConvert();
1888 
1889  if( pin_unit > 0 && pin_unit != GetUnit() )
1890  continue;
1891 
1892  if( pin_convert > 0 && pin_convert != GetConvert() )
1893  continue;
1894 
1895  if( pin->IsPointClickableAnchor( aPos ) )
1896  return true;
1897  }
1898 
1899  return false;
1900 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:702
int GetUnit() const
Definition: sch_symbol.h:195
int GetConvert() const
Definition: sch_symbol.h:223

References GetConvert(), GetUnit(), m_pins, and pin.

◆ IsReferenceStringValid()

bool SCH_SYMBOL::IsReferenceStringValid ( const wxString &  aReferenceString)
static

Test for an acceptable reference string.

An acceptable reference string must support unannotation i.e starts by letter

Parameters
aReferenceStringis the reference string to validate
Returns
true if reference string is valid.

Definition at line 475 of file sch_symbol.cpp.

476 {
477  return !UTIL::GetRefDesPrefix( aReferenceString ).IsEmpty();
478 }
wxString GetRefDesPrefix(const wxString &aRefDes)
Get the (non-numeric) prefix from a refdes - e.g.

References UTIL::GetRefDesPrefix().

Referenced by DIALOG_FIELD_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::Validate(), and DIALOG_SYMBOL_PROPERTIES::Validate().

◆ IsReplaceable()

bool SCH_SYMBOL::IsReplaceable ( ) const
inlineoverridevirtual

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 from EDA_ITEM.

Definition at line 642 of file sch_symbol.h.

642 { return true; }

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 125 of file eda_item.h.

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

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 123 of file eda_item.h.

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

References EDA_ITEM::m_flags, and SELECTED.

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

◆ IsType()

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

Check whether the item is one of the listed types.

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

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

Definition at line 183 of file eda_item.h.

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

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 122 of file eda_item.h.

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

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

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

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

Definition at line 295 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

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

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

Definition at line 314 of file eda_item.h.

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

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

◆ Matches() [1/2]

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

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

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

Definition at line 118 of file eda_item.cpp.

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

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

◆ Matches() [2/2]

bool SCH_SYMBOL::Matches ( const wxFindReplaceData &  aSearchData,
void *  aAuxData 
) const
overridevirtual

Compare the item against the search criteria in aSearchData.

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

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

Reimplemented from EDA_ITEM.

Definition at line 1501 of file sch_symbol.cpp.

1502 {
1503  wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText( EDA_UNITS::MILLIMETRES ) );
1504 
1505  // Symbols are searchable via the child field and pin item text.
1506  return false;
1507 }
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Return the text to display to be used in the selection clarification context menu when multiple items...
const wxChar *const traceFindItem
Flag to enable find debug tracing.

References GetSelectMenuText(), MILLIMETRES, and traceFindItem.

◆ MirrorHorizontally()

void SCH_SYMBOL::MirrorHorizontally ( int  aCenter)
overridevirtual

Mirror item horizontally about aCenter.

Implements SCH_ITEM.

Definition at line 1446 of file sch_symbol.cpp.

1447 {
1448  int dx = m_pos.x;
1449 
1451  MIRROR( m_pos.x, aCenter );
1452  dx -= m_pos.x; // dx,0 is the move vector for this transform
1453 
1454  for( SCH_FIELD& field : m_fields )
1455  {
1456  // Move the fields to the new position because the symbol itself has moved.
1457  wxPoint pos = field.GetTextPos();
1458  pos.x -= dx;
1459  field.SetTextPos( pos );
1460  }
1461 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:40
wxPoint m_pos
Definition: sch_symbol.h:677

References m_fields, m_pos, MIRROR(), SetOrientation(), and SYM_MIRROR_Y.

◆ MirrorVertically()

void SCH_SYMBOL::MirrorVertically ( int  aCenter)
overridevirtual

Mirror item vertically about aCenter.

Implements SCH_ITEM.

Definition at line 1464 of file sch_symbol.cpp.

1465 {
1466  int dy = m_pos.y;
1467 
1469  MIRROR( m_pos.y, aCenter );
1470  dy -= m_pos.y; // dy,0 is the move vector for this transform
1471 
1472  for( SCH_FIELD& field : m_fields )
1473  {
1474  // Move the fields to the new position because the symbol itself has moved.
1475  wxPoint pos = field.GetTextPos();
1476  pos.y -= dy;
1477  field.SetTextPos( pos );
1478  }
1479 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:40
wxPoint m_pos
Definition: sch_symbol.h:677

References m_fields, m_pos, MIRROR(), SetOrientation(), and SYM_MIRROR_X.

◆ Move()

void SCH_SYMBOL::Move ( const wxPoint &  aMoveVector)
inlineoverridevirtual

Move the item by aMoveVector to a new position.

Implements SCH_ITEM.

Definition at line 564 of file sch_symbol.h.

565  {
566  if( aMoveVector == wxPoint( 0, 0 ) )
567  return;
568 
569  m_pos += aMoveVector;
570 
571  for( SCH_FIELD& field : m_fields )
572  field.Move( aMoveVector );
573 
574  SetModified();
575  }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
void SetModified()
Definition: eda_item.cpp:65
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
wxPoint m_pos
Definition: sch_symbol.h:677

References m_fields, m_pos, and EDA_ITEM::SetModified().

Referenced by SetPosition().

◆ NetClass()

NETCLASSPTR SCH_ITEM::NetClass ( const SCH_SHEET_PATH aSheet = nullptr) const
inherited

Definition at line 145 of file sch_item.cpp.

146 {
147  if( m_connection_map.size() )
148  {
149  SCH_CONNECTION* connection = Connection( aSheet );
150 
151  if( connection )
152  {
153  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
154  const wxString& netclassName = netSettings.GetNetclassName( connection->Name() );
155 
156  return netSettings.m_NetClasses.Find( netclassName );
157  }
158  }
159 
160  return nullptr;
161 }
NETCLASSPTR Find(const wxString &aName) const
Search this container for a NETCLASS given by aName.
Definition: netclass.cpp:132
const wxString & GetNetclassName(const wxString &aNetName) const
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:145
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
NET_SETTINGS & NetSettings()
Definition: project_file.h:94
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:131
NETCLASSES m_NetClasses
Definition: net_settings.h:40
wxString Name(bool aIgnoreSheet=false) const
NET_SETTINGS stores various net-related settings in a project context.
Definition: net_settings.h:32
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Store connectivity information, per sheet.
Definition: sch_item.h:491
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
Definition: schematic.h:75
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).

References SCH_ITEM::Connection(), NETCLASSES::Find(), NET_SETTINGS::GetNetclassName(), PROJECT::GetProjectFile(), SCH_ITEM::m_connection_map, NET_SETTINGS::m_NetClasses, SCH_CONNECTION::Name(), PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

Referenced by SCH_LINE::GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_JUNCTION::GetJunctionColor(), SCH_LINE::GetLineColor(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), and SCH_BUS_ENTRY_BASE::GetStrokeStyle().

◆ operator!=()

bool SCH_SYMBOL::operator!= ( const SCH_SYMBOL aSymbol) const

Definition at line 1741 of file sch_symbol.cpp.

1742 {
1743  return !( *this == aSymbol );
1744 }

◆ operator<() [1/2]

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

Test if another item is less than this object.

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

Definition at line 171 of file eda_item.cpp.

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

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

◆ operator<() [2/2]

bool SCH_SYMBOL::operator< ( const SCH_ITEM aItem) const
overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1704 of file sch_symbol.cpp.

1705 {
1706  if( Type() != aItem.Type() )
1707  return Type() < aItem.Type();
1708 
1709  auto symbol = static_cast<const SCH_SYMBOL*>( &aItem );
1710 
1712 
1713  if( rect.GetArea() != symbol->GetBodyAndPinsBoundingBox().GetArea() )
1714  return rect.GetArea() < symbol->GetBodyAndPinsBoundingBox().GetArea();
1715 
1716  if( m_pos.x != symbol->m_pos.x )
1717  return m_pos.x < symbol->m_pos.x;
1718 
1719  if( m_pos.y != symbol->m_pos.y )
1720  return m_pos.y < symbol->m_pos.y;
1721 
1722  return m_Uuid < aItem.m_Uuid; // Ensure deterministic sort
1723 }
EDA_RECT GetBodyAndPinsBoundingBox() const
Return a bounding box for the symbol body and pins but not the fields.
wxPoint m_pos
Definition: sch_symbol.h:677
double GetArea() const
Return the area of the rectangle.
Definition: eda_rect.cpp:483
const KIID m_Uuid
Definition: eda_item.h:475
Handle the component boundary box.
Definition: eda_rect.h:42
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References EDA_RECT::GetArea(), GetBodyAndPinsBoundingBox(), m_pos, EDA_ITEM::m_Uuid, and EDA_ITEM::Type().

◆ operator=()

SCH_SYMBOL & SCH_SYMBOL::operator= ( const SCH_ITEM aItem)

Definition at line 1747 of file sch_symbol.cpp.

1748 {
1749  wxCHECK_MSG( Type() == aItem.Type(), *this,
1750  wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
1751  GetClass() );
1752 
1753  if( &aItem != this )
1754  {
1755  SCH_ITEM::operator=( aItem );
1756 
1757  SCH_SYMBOL* c = (SCH_SYMBOL*) &aItem;
1758 
1759  m_lib_id = c->m_lib_id;
1760 
1761  LIB_SYMBOL* libSymbol = c->m_part ? new LIB_SYMBOL( *c->m_part.get() ) : nullptr;
1762 
1763  m_part.reset( libSymbol );
1764  m_pos = c->m_pos;
1765  m_unit = c->m_unit;
1766  m_convert = c->m_convert;
1767  m_transform = c->m_transform;
1768 
1770 
1771  m_fields = c->m_fields; // std::vector's assignment operator
1772 
1773  // Reparent fields after assignment to new symbol.
1774  for( SCH_FIELD& field : m_fields )
1775  field.SetParent( this );
1776 
1777  UpdatePins();
1778  }
1779 
1780  return *this;
1781 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
Define a library symbol object.
Definition: lib_symbol.h:96
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:679
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:680
void UpdatePins()
Updates the cache of SCH_PIN objects for each pin.
Definition: sch_symbol.cpp:284
wxPoint m_pos
Definition: sch_symbol.h:677
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700
wxString GetClass() const override
Return the class name.
Definition: sch_symbol.h:118
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Assign the members of aItem to another object.
Definition: eda_item.cpp:180
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_symbol.h:678
Schematic symbol object.
Definition: sch_symbol.h:78
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:697
virtual wxString GetClass() const override
Return the class name.
Definition: sch_item.h:191
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:711
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References GetClass(), SCH_ITEM::GetClass(), m_convert, m_fields, m_instanceReferences, m_lib_id, m_part, m_pos, m_transform, m_unit, EDA_ITEM::operator=(), EDA_ITEM::Type(), and UpdatePins().

◆ operator==()

bool SCH_SYMBOL::operator== ( const SCH_SYMBOL aSymbol) const

Definition at line 1726 of file sch_symbol.cpp.

1727 {
1728  if( GetFieldCount() != aSymbol.GetFieldCount() )
1729  return false;
1730 
1731  for( int i = VALUE_FIELD; i < GetFieldCount(); i++ )
1732  {
1733  if( GetFields()[i].GetText().Cmp( aSymbol.GetFields()[i].GetText() ) != 0 )
1734  return false;
1735  }
1736 
1737  return true;
1738 }
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with SCH_FIELDs.
Definition: sch_symbol.cpp:711
Field Value of part, i.e. "3.3K".
int GetFieldCount() const
Return the number of fields in this symbol.
Definition: sch_symbol.h:424
std::vector< SCH_FIELD > & GetFields()
Return a vector of fields from the symbol.
Definition: sch_symbol.h:369

References GetFieldCount(), GetFields(), and VALUE_FIELD.

◆ Plot()

void SCH_SYMBOL::Plot ( PLOTTER aPlotter) const
overridevirtual

Plot the schematic item to aPlotter.

Parameters
aPlotteris the PLOTTER object to plot to.

Reimplemented from SCH_ITEM.

Definition at line 1846 of file sch_symbol.cpp.

1847 {
1848  if( m_part )
1849  {
1850  TRANSFORM temp = GetTransform();
1851  aPlotter->StartBlock( nullptr );
1852 
1853  m_part->Plot( aPlotter, GetUnit(), GetConvert(), m_pos, temp );
1854 
1855  for( SCH_FIELD field : m_fields )
1856  field.Plot( aPlotter );
1857 
1858  aPlotter->EndBlock( nullptr );
1859  }
1860 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
virtual void EndBlock(void *aData)
calling this function allows one to define the end of a group of drawing items for instance in SVG or...
Definition: plotter.h:496
virtual void StartBlock(void *aData)
calling this function allows one to define the beginning of a group of drawing items,...
Definition: plotter.h:487
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
TRANSFORM & GetTransform()
Definition: sch_symbol.h:231
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
wxPoint m_pos
Definition: sch_symbol.h:677
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700
int GetUnit() const
Definition: sch_symbol.h:195
int GetConvert() const
Definition: sch_symbol.h:223

References PLOTTER::EndBlock(), GetConvert(), GetTransform(), GetUnit(), m_fields, m_part, m_pos, and PLOTTER::StartBlock().

◆ Print()

void SCH_SYMBOL::Print ( const RENDER_SETTINGS aSettings,
const wxPoint &  aOffset 
)
overridevirtual

Print a symbol.

Parameters
aDCis the device context (can be null).
aOffsetis the drawing offset (usually wxPoint(0,0), but can be different when moving an object)

Implements SCH_ITEM.

Definition at line 379 of file sch_symbol.cpp.

380 {
381  LIB_SYMBOL_OPTIONS opts;
382  opts.transform = m_transform;
383  opts.draw_visible_fields = false;
384  opts.draw_hidden_fields = false;
385 
386  if( m_part )
387  {
388  m_part->Print( aSettings, m_pos + aOffset, m_unit, m_convert, opts );
389  }
390  else // Use dummy() part if the actual cannot be found.
391  {
392  dummy()->Print( aSettings, m_pos + aOffset, 0, 0, opts );
393  }
394 
395  for( SCH_FIELD& field : m_fields )
396  field.Print( aSettings, aOffset );
397 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
bool draw_visible_fields
Definition: lib_symbol.h:65
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:679
TRANSFORM transform
Definition: lib_symbol.h:64
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:72
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:680
wxPoint m_pos
Definition: sch_symbol.h:677
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700
void Print(const RENDER_SETTINGS *aSettings, const wxPoint &aOffset, int aMulti, int aConvert, const LIB_SYMBOL_OPTIONS &aOpts)
Print symbol.
Definition: lib_symbol.cpp:476
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:697

References LIB_SYMBOL_OPTIONS::draw_hidden_fields, LIB_SYMBOL_OPTIONS::draw_visible_fields, dummy(), m_convert, m_fields, m_part, m_pos, m_transform, m_unit, LIB_SYMBOL::Print(), and LIB_SYMBOL_OPTIONS::transform.

◆ RemoveField()

void SCH_SYMBOL::RemoveField ( const wxString &  aFieldName)

Remove a user field from the symbol.

Parameters
aFieldNameis the user fieldName to remove. Attempts to remove a mandatory field or a non-existant field are silently ignored.

Definition at line 730 of file sch_symbol.cpp.

731 {
732  for( unsigned i = MANDATORY_FIELDS; i < m_fields.size(); ++i )
733  {
734  if( aFieldName == m_fields[i].GetName( false ) )
735  {
736  m_fields.erase( m_fields.begin() + i );
737  return;
738  }
739  }
740 }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.

References m_fields, and MANDATORY_FIELDS.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), and DIALOG_CHANGE_SYMBOLS::processSymbol().

◆ Replace() [1/2]

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

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

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

Definition at line 145 of file eda_item.cpp.

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

References traceFindReplace.

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

◆ Replace() [2/2]

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

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

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

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

Reimplemented in SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 392 of file eda_item.h.

393  {
394  return false;
395  }

◆ ReplaceInstanceSheetPath()

bool SCH_SYMBOL::ReplaceInstanceSheetPath ( const KIID_PATH aOldSheetPath,
const KIID_PATH aNewSheetPath 
)

Replace aOldSheetPath with aNewSheetPath in the instance list.

Parameters
aOldSheetPathis a KIID_PATH object of an existing path in the instance list.
aNewSheetPathis a KIID_PATH object of the path to replace the existing path.
Returns
true if aOldSheetPath was found and replaced or false if aOldSheetPath was not found in the instance list.

Definition at line 1077 of file sch_symbol.cpp.

1079 {
1080  auto it = std::find_if( m_instanceReferences.begin(), m_instanceReferences.end(),
1081  [ aOldSheetPath ]( SYMBOL_INSTANCE_REFERENCE& r )->bool
1082  {
1083  return aOldSheetPath == r.m_Path;
1084  }
1085  );
1086 
1087  if( it != m_instanceReferences.end() )
1088  {
1089  wxLogTrace( traceSchSheetPaths,
1090  "Replacing sheet path %s\n with sheet path %s\n for symbol %s.",
1091  aOldSheetPath.AsString(), aNewSheetPath.AsString(), m_Uuid.AsString() );
1092 
1093  it->m_Path = aNewSheetPath;
1094  return true;
1095  }
1096 
1097  wxLogTrace( traceSchSheetPaths,
1098  "Could not find sheet path %s\n to replace with sheet path %s\n for symbol %s.",
1099  aOldSheetPath.AsString(), aNewSheetPath.AsString(), m_Uuid.AsString() );
1100 
1101  return false;
1102 }
const wxChar *const traceSchSheetPaths
Flag to enable debug output of schematic symbol sheet path manipulation code.
wxString AsString() const
Definition: kiid.cpp:218
A simple container for schematic symbol instance information.
E_SERIE r
Definition: eserie.cpp:41
const KIID m_Uuid
Definition: eda_item.h:475
wxString AsString() const
Definition: kiid.cpp:277
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:711

References KIID::AsString(), KIID_PATH::AsString(), m_instanceReferences, EDA_ITEM::m_Uuid, r, and traceSchSheetPaths.

◆ ResolveTextVar()

bool SCH_SYMBOL::ResolveTextVar ( wxString *  token,
int  aDepth = 0 
) const

Resolve any references to system tokens supported by the symbol.

Parameters
aDeptha counter to limit recursion and circular references.

Definition at line 942 of file sch_symbol.cpp.

943 {
944  SCHEMATIC* schematic = Schematic();
945 
946  // SCH_SYMOL object has no context outside a schematic.
947  wxCHECK( schematic, false );
948 
949  for( int i = 0; i < MANDATORY_FIELDS; ++i )
950  {
951  if( token->IsSameAs( m_fields[ i ].GetCanonicalName().Upper() ) )
952  {
953  if( i == REFERENCE_FIELD )
954  *token = GetRef( &schematic->CurrentSheet(), true );
955  else if( i == VALUE_FIELD )
956  *token = GetValue( &schematic->CurrentSheet(), true );
957  else if( i == FOOTPRINT_FIELD )
958  *token = GetFootprint( &schematic->CurrentSheet(), true );
959  else
960  *token = m_fields[ i ].GetShownText( aDepth + 1 );
961 
962  return true;
963  }
964  }
965 
966  for( size_t i = MANDATORY_FIELDS; i < m_fields.size(); ++i )
967  {
968  if( token->IsSameAs( m_fields[ i ].GetName() )
969  || token->IsSameAs( m_fields[ i ].GetName().Upper() ) )
970  {
971  *token = m_fields[ i ].GetShownText( aDepth + 1 );
972  return true;
973  }
974  }
975 
976  for( const TEMPLATE_FIELDNAME& templateFieldname :
978  {
979  if( token->IsSameAs( templateFieldname.m_Name )
980  || token->IsSameAs( templateFieldname.m_Name.Upper() ) )
981  {
982  // If we didn't find it in the fields list then it isn't set on this symbol.
983  // Just return an empty string.
984  *token = wxEmptyString;
985  return true;
986  }
987  }
988 
989  if( token->IsSameAs( wxT( "FOOTPRINT_LIBRARY" ) ) )
990  {
991  wxString footprint;
992 
993  footprint = GetFootprint( &schematic->CurrentSheet(), true );
994 
995  wxArrayString parts = wxSplit( footprint, ':' );
996 
997  *token = parts[ 0 ];
998  return true;
999  }
1000  else if( token->IsSameAs( wxT( "FOOTPRINT_NAME" ) ) )
1001  {
1002  wxString footprint;
1003 
1004  footprint = GetFootprint( &schematic->CurrentSheet(), true );
1005 
1006  wxArrayString parts = wxSplit( footprint, ':' );
1007 
1008  *token = parts[ std::min( 1, (int) parts.size() - 1 ) ];
1009  return true;
1010  }
1011  else if( token->IsSameAs( wxT( "UNIT" ) ) )
1012  {
1013  int unit;
1014 
1015  unit = GetUnitSelection( &schematic->CurrentSheet() );
1016 
1017  *token = LIB_SYMBOL::SubReference( unit );
1018  return true;
1019  }
1020 
1021  return false;
1022 }
Field Reference of part, i.e. "IC21".
Holds all the data relating to one schematic.
Definition: schematic.h:59
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:167
TEMPLATES m_TemplateFieldNames
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
static wxString SubReference(int aUnit, bool aAddSeparator=true)
Definition: lib_symbol.cpp:444
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:441
Field Value of part, i.e. "3.3K".
int GetUnitSelection(const SCH_SHEET_PATH *aSheet) const
Return the instance-specific unit selection for the given sheet path.
Definition: sch_symbol.cpp:531
const wxString GetValue(const SCH_SHEET_PATH *sheet, bool aResolve) const
Return the instance-specific value for the given sheet path.
Definition: sch_symbol.cpp:573
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
Hold a name of a symbol's field, field value, and default visibility.
const wxString GetFootprint(const SCH_SHEET_PATH *sheet, bool aResolve) const
Return the instance-specific footprint assignment for the given sheet path.
Definition: sch_symbol.cpp:624
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:121
const TEMPLATE_FIELDNAMES & GetTemplateFieldNames()
Return a template field name list for read only access.
Field Name Module PCB, i.e. "16DIP300".

References SCHEMATIC::CurrentSheet(), FOOTPRINT_FIELD, GetFootprint(), GetRef(), TEMPLATES::GetTemplateFieldNames(), GetUnitSelection(), GetValue(), m_fields, SCHEMATIC_SETTINGS::m_TemplateFieldNames, MANDATORY_FIELDS, REFERENCE_FIELD, SCH_ITEM::Schematic(), SCHEMATIC::Settings(), LIB_SYMBOL::SubReference(), and VALUE_FIELD.

Referenced by SCH_FIELD::GetShownText(), and SCHEMATIC::ResolveCrossReference().

◆ Rotate()

void SCH_SYMBOL::Rotate ( const wxPoint &  aCenter)
overridevirtual

Rotate the item around aCenter 90 degrees in the clockwise direction.

Implements SCH_ITEM.

Definition at line 1482 of file sch_symbol.cpp.

1483 {
1484  wxPoint prev = m_pos;
1485 
1486  RotatePoint( &m_pos, aCenter, 900 );
1487 
1489 
1490  for( SCH_FIELD& field : m_fields )
1491  {
1492  // Move the fields to the new position because the symbol itself has moved.
1493  wxPoint pos = field.GetTextPos();
1494  pos.x -= prev.x - m_pos.x;
1495  pos.y -= prev.y - m_pos.y;
1496  field.SetTextPos( pos );
1497  }
1498 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:229
wxPoint m_pos
Definition: sch_symbol.h:677

References m_fields, m_pos, RotatePoint(), SetOrientation(), and SYM_ROTATE_COUNTERCLOCKWISE.

Referenced by SCH_EDIT_TOOL::Rotate().

◆ RunOnChildren()

void SCH_SYMBOL::RunOnChildren ( const std::function< void(SCH_ITEM *)> &  aFunction)
overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 830 of file sch_symbol.cpp.

831 {
832  for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
833  aFunction( pin.get() );
834 
835  for( SCH_FIELD& field : m_fields )
836  aFunction( &field );
837 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:702
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698

References m_fields, m_pins, and pin.

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const
inherited

Searches the item hierarchy to find a SCHEMATIC.

Every SCH_ITEM that lives on a SCH_SCREEN should be parented to either that screen or another SCH_ITEM on the same screen (for example, pins to their symbols).

Every SCH_SCREEN should be parented to the SCHEMATIC.

Note
This hierarchy is not the same as the sheet hierarchy!
Returns
the parent schematic this item lives on, or nullptr.

Definition at line 97 of file sch_item.cpp.

98 {
99  EDA_ITEM* parent = GetParent();
100 
101  while( parent )
102  {
103  if( parent->Type() == SCHEMATIC_T )
104  return static_cast<SCHEMATIC*>( parent );
105  else
106  parent = parent->GetParent();
107  }
108 
109  return nullptr;
110 }
EDA_ITEM * GetParent() const
Definition: eda_item.h:115
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References EDA_ITEM::GetParent(), SCHEMATIC_T, and EDA_ITEM::Type().

Referenced by SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_FIELD::DoHypertextMenu(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::getEffectiveShape(), SCH_TEXT::GetLabelBoxExpansion(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_NO_CONNECT::GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_SHEET::GetPenWidth(), GetPins(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_PIN::HitTest(), SCH_GLOBALLABEL::HitTest(), inheritNetclass(), SCH_SHEET::IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), SCH_GLOBALLABEL::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_SHEET::ResolveTextVar(), ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), and SCH_MARKER::ViewGetLayers().

◆ Set() [1/3]

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

Definition at line 42 of file inspectable.h.

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

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

◆ Set() [2/3]

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

Definition at line 55 of file inspectable.h.

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

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

◆ Set() [3/3]

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

Definition at line 68 of file inspectable.h.

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

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

◆ SetBrightened()

◆ SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool  aDirty = true)
inlineinherited

Definition at line 411 of file sch_item.h.

411 { m_connectivity_dirty = aDirty; }
bool m_connectivity_dirty
Definition: sch_item.h:493

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetConvert()

void SCH_SYMBOL::SetConvert ( int  aConvert)

Definition at line 347 of file sch_symbol.cpp.

348 {
349  if( m_convert != aConvert )
350  {
351  m_convert = aConvert;
352 
353  // The convert may have a different pin layout so the update the pin map.
354  UpdatePins();
355  SetModified();
356  }
357 }
void SetModified()
Definition: eda_item.cpp:65
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:680
void UpdatePins()
Updates the cache of SCH_PIN objects for each pin.
Definition: sch_symbol.cpp:284

References m_convert, EDA_ITEM::SetModified(), and UpdatePins().

Referenced by SCH_EDIT_FRAME::ConvertPart(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetFields()

void SCH_SYMBOL::SetFields ( const SCH_FIELDS aFields)
inline

Set multiple schematic fields.

Parameters
aFieldsare the fields to set in this symbol.

Definition at line 403 of file sch_symbol.h.

404  {
405  m_fields = aFields; // vector copying, length is changed possibly
406  }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698

References m_fields.

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )
inlineinherited

Definition at line 420 of file sch_item.h.

References FIELDS_AUTOPLACED_AUTO, and SCH_ITEM::m_fieldsAutoplaced.

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS  aMask)
inlineinherited

Definition at line 153 of file eda_item.h.

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

References EDA_ITEM::m_flags.

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

◆ SetFootprint() [1/2]

void SCH_SYMBOL::SetFootprint ( const SCH_SHEET_PATH sheet,
const wxString &  aFootprint 
)

Definition at line 645 of file sch_symbol.cpp.

646 {
647  if( sheet == nullptr )
648  {
649  // Clear instance overrides and set primary field value
651  instance.m_Footprint = wxEmptyString;
652 
653  m_fields[ FOOTPRINT_FIELD ].SetText( aFootprint );
654  return;
655  }
656 
657  KIID_PATH path = sheet->Path();
658 
659  // check to see if it is already there before inserting it
661  {
662  if( instance.m_Path == path )
663  {
664  instance.m_Footprint = aFootprint;
665  return;
666  }
667  }
668 
669  // didn't find it; better add it
671  wxEmptyString, aFootprint );
672 }
wxString m_prefix
C, R, U, Q etc - the first character(s) which typically indicate what the symbol is.
Definition: sch_symbol.h:683
wxString GetRefDesUnannotated(const wxString &aSource)
Return an unannotated refdes from either a prefix or an existing refdes.
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:698
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:679
A simple container for schematic symbol instance information.
void AddHierarchicalReference(const KIID_PATH &aPath, const wxString &aRef, int aUnit, const wxString &aValue=wxEmptyString, const wxString &aFootprint=wxEmptyString)
Add a full hierarchical reference to this symbol.
Definition: sch_symbol.cpp:400
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:711
Field Name Module PCB, i.e. "16DIP300".

References AddHierarchicalReference(), FOOTPRINT_FIELD, UTIL::GetRefDesUnannotated(), m_fields, m_instanceReferences, m_prefix, m_unit, SCH_SHEET_PATH::Path(), and path.

Referenced by BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_ALTIUM_PLUGIN::ParseImplementation(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_FIELD::Replace(), SCH_SYMBOL(), SetFootprint(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), UpdateFields(), and SCH_EDITOR_CONTROL::updatePastedSymbol().

◆ SetFootprint() [2/2]

void SCH_SYMBOL::SetFootprint ( const wxString &  aFootprint)
inline

Set the value for all instances (the default GUI behavior).

Definition at line 557 of file sch_symbol.h.

558  {
559  SetFootprint( nullptr, aFootprint );
560  }
void SetFootprint(const SCH_SHEET_PATH *sheet, const wxString &aFootprint)
Definition: sch_symbol.cpp:645

References SetFootprint().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

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

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

Definition at line 204 of file eda_item.h.

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

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetIncludeInBom()

void SCH_SYMBOL::SetIncludeInBom ( bool  aIncludeInBom)
inline

Definition at line 663 of file sch_symbol.h.

663 { m_inBom = aIncludeInBom; }
bool m_inBom
True to include in bill of materials export.
Definition: sch_symbol.h:706

References m_inBom.

Referenced by DIALOG_CHANGE_SYMBOLS::processSymbol(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetIncludeOnBoard()

void SCH_SYMBOL::SetIncludeOnBoard ( bool  aIncludeOnBoard)
inline

Definition at line 666 of file sch_symbol.h.

666 { m_onBoard = aIncludeOnBoard; }
bool m_onBoard
True to include in netlist when updating board.
Definition: sch_symbol.h:707

References m_onBoard.

Referenced by DIALOG_CHANGE_SYMBOLS::processSymbol(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID  aLayer)
inlineinherited

◆ SetLibId()

void SCH_SYMBOL::SetLibId ( const LIB_ID aName)

Definition at line 238 of file sch_symbol.cpp.

239 {
240  if( m_lib_id != aLibId )
241  {
242  m_lib_id = aLibId;
243  SetModified();
244  }
245 }
void SetModified()
Definition: eda_item.cpp:65
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_symbol.h:678

References m_lib_id, and EDA_ITEM::SetModified().

Referenced by SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), DIALOG_CHANGE_SYMBOLS::processSymbol(), and DIALOG_SYMBOL_REMAP::remapSymbolToLibTable().

◆ SetLibSymbol()

void SCH_SYMBOL::SetLibSymbol ( LIB_SYMBOL aLibSymbol)

Set this schematic symbol library symbol reference to aLibSymbol.

The schematic symbol object owns aLibSymbol and the pin list will be updated accordingly. The LIB_SYMBOL object can be null to clear the library symbol link as well as the pin map. If the LIB_SYMBOL object is not null, it must be a root symbol. Otherwise an assertion will be raised in debug builds and the library symbol will be cleared. The new file format will no longer require a cache library so all library symbols must be valid.

Note
This is the only way to publicly set the library symbol for a schematic symbol except for the ctors that take a LIB_SYMBOL reference. All previous public resolvers have been deprecated.
Parameters
aLibSymbolis the library symbol to associate with this schematic symbol.

Definition at line 257 of file sch_symbol.cpp.

258 {
259  wxCHECK2( ( aLibSymbol == nullptr ) || ( aLibSymbol->IsRoot() ), aLibSymbol = nullptr );
260 
261  m_part.reset( aLibSymbol );
262  UpdatePins();
263 }
void UpdatePins()
Updates the cache of SCH_PIN objects for each pin.
Definition: sch_symbol.cpp:284
std::unique_ptr< LIB_SYMBOL > m_part
Definition: sch_symbol.h:700
bool IsRoot() const override
For symbols derived from other symbols, IsRoot() indicates no derivation.
Definition: lib_symbol.h:171

References LIB_SYMBOL::IsRoot(), m_part, and UpdatePins().

Referenced by SCH_SCREEN::Append(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EDITOR_CONTROL::Paste(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), and SCH_SYMBOL().

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

Set the 'lock' status to aLocked for of this item.

Definition at line 245 of file sch_item.h.

245 {}

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

Definition at line 65 of file eda_item.cpp.

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

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

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

◆ SetOrientation()

void SCH_SYMBOL::SetOrientation ( int  aOrientation)

Compute the new transform matrix based on aOrientation for the symbol which is applied to the current transform.

Parameters
aOrientationis the orientation to apply to the transform.

Definition at line 1105 of file sch_symbol.cpp.

1106 {
1107  TRANSFORM temp = TRANSFORM();
1108  bool transform = false;
1109 
1110  switch( aOrientation )
1111  {
1112  case SYM_ORIENT_0:
1113  case SYM_NORMAL: // default transform matrix
1114  m_transform.x1 = 1;
1115  m_transform.y2 = -1;
1116  m_transform.x2 = m_transform.y1 = 0;
1117  break;
1118 
1119  case SYM_ROTATE_COUNTERCLOCKWISE: // Rotate + (incremental rotation)
1120  temp.x1 = temp.y2 = 0;
1121  temp.y1 = 1;
1122  temp.x2 = -1;
1123  transform = true;
1124  break;
1125 
1126  case SYM_ROTATE_CLOCKWISE: // Rotate - (incremental rotation)
1127  temp.x1 = temp.y2 = 0;
1128  temp.y1 = -1;
1129  temp.x2 = 1;
1130  transform = true;
1131  break;
1132 
1133  case SYM_MIRROR_Y: // Mirror Y (incremental rotation)
1134  temp.x1 = -1;
1135  temp.y2 = 1;
1136  temp.y1 = temp.x2 = 0;
1137  transform = true;
1138  break;
1139 
1140  case SYM_MIRROR_X: // Mirror X (incremental rotation)
1141  temp.x1 = 1;
1142  temp.y2 = -1;
1143  temp.y1 = temp.x2 = 0;
1144  transform = true;
1145  break;
1146 
1147  case SYM_ORIENT_90:
1150  break;
1151 
1152  case SYM_ORIENT_180:
1156  break;
1157 
1158  case SYM_ORIENT_270:
1161  break;
1162 
1163  case ( SYM_ORIENT_0 + SYM_MIRROR_X ):
1166  break;
1167 
1168  case ( SYM_ORIENT_0 + SYM_MIRROR_Y ):
1171  break;
1172 
1173  case ( SYM_ORIENT_90 + SYM_MIRROR_X ):
1176  break;
1177 
1178  case ( SYM_ORIENT_90 + SYM_MIRROR_Y ):
1181  break;
1182 
1183  case ( SYM_ORIENT_180 + SYM_MIRROR_X ):
1186  break;
1187 
1188  case ( SYM_ORIENT_180 + SYM_MIRROR_Y ):
1191  break;
1192 
1193  case ( SYM_ORIENT_270 + SYM_MIRROR_X ):
1196  break;
1197 
1198  case ( SYM_ORIENT_270 + SYM_MIRROR_Y ):
1201  break;
1202 
1203  default:
1204  transform = false;
1205  wxFAIL_MSG( "Invalid schematic symbol orientation type." );
1206  break;
1207  }
1208 
1209  if( transform )
1210  {
1211  /* The new matrix transform is the old matrix transform modified by the
1212  * requested transformation, which is the temp transform (rot,
1213  * mirror ..) in order to have (in term of matrix transform):
1214  * transform coord = new_m_transform * coord
1215  * where transform coord is the coord modified by new_m_transform from
1216  * the initial value coord.
1217  * new_m_transform is computed (from old_m_transform and temp) to
1218  * have:
1219  * transform coord = old_m_transform * temp
1220  */
1221  TRANSFORM newTransform;
1222 
1223  newTransform.x1 = m_transform.x1 * temp.x1 + m_transform.x2 * temp.y1;
1224  newTransform.y1 = m_transform.y1 * temp.x1 + m_transform.y2 * temp.y1;
1225  newTransform.x2 = m_transform.x1 * temp.x2 + m_transform.x2 * temp.y2;
1226  newTransform.y2 = m_transform.y1 * temp.x2 + m_transform.y2 * temp.y2;
1227  m_transform = newTransform;
1228  }
1229 }
int y2
Definition: transform.h:51
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
int x2
Definition: transform.h:50
int x1
Definition: transform.h:48
int y1
Definition: transform.h:49
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:697

References m_transform, SYM_MIRROR_X, SYM_MIRROR_Y, SYM_NORMAL, SYM_ORIENT_0, SYM_ORIENT_180, SYM_ORIENT_270, SYM_ORIENT_90, SYM_ROTATE_CLOCKWISE, SYM_ROTATE_COUNTERCLOCKWISE, TRANSFORM::x1, TRANSFORM::x2, TRANSFORM::y1, and TRANSFORM::y2.

Referenced by GetOrientation(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_EDIT_TOOL::Mirror(), MirrorHorizontally(), MirrorVertically(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), Rotate(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Reimplemented in PCB_DIMENSION_BASE.

Definition at line 116 of file eda_item.h.

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

References EDA_ITEM::m_parent.

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

◆ SetPosition()

void SCH_SYMBOL::SetPosition ( const wxPoint &  aPosition)
inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 645 of file sch_symbol.h.

645 { Move( aPosition - m_pos ); }
wxPoint m_pos
Definition: sch_symbol.h:677
void Move(const wxPoint &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_symbol.h:564

References m_pos, and Move().

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), and SCH_DRAWING_TOOLS::PlaceSymbol().

◆ SetPrefix()

void SCH_SYMBOL::SetPrefix ( const wxString &  aPrefix)
inline

Definition at line 229 of file sch_symbol.h.

229 { m_prefix = aPrefix; }
wxString m_prefix
C, R, U, Q etc - the first character(s) which typically indicate what the symbol is.
Definition: sch_symbol.h:683

References m_prefix.

◆ SetRef()

void SCH_SYMBOL::SetRef ( const SCH_SHEET_PATH aSheet,
const wxString &  aReference 
)

Set the reference for the given sheet path for this symbol.

Parameters
aSheetis the hierarchical path of the reference.
aReferenceis the new reference for the symbol.

Definition at line 481 of file sch_symbol.cpp.

482 {
483  KIID_PATH path = sheet->Path();
484  bool notInArray = true;
485 
486  // check to see if it is already there before inserting it
488  {
489  if( instance.m_Path == path )
490  {
491  instance.m_Reference = ref;
492  notInArray = false;
493  }
494  }
495 
496  if( notInArray )
498 
499  for( std::unique_ptr<SCH_PIN>& pin : m_pins )
500  pin->ClearDefaultNetName( sheet );
501 
503 
504  rf->SetText( ref ); // for drawing.
505 
506  // Reinit the m_prefix member if needed
508 
509  if( m_prefix.IsEmpty() )
510  m_prefix = wxT( "U" );
511 
512  // Power symbols have references starting with # and are not included in netlists
513  m_isInNetlist = ! ref.StartsWith( wxT( "#" ) );
514 }
bool m_isInNetlist
True if the symbol should appear in the netlist.
Definition: sch_symbol.h:705
Field Reference of part, i.e. "IC21".
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
wxString m_prefix
C, R, U, Q etc - the first character(s) which typically indicate what the symbol is.
Definition: sch_symbol.h:683
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:675
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:702
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:679
virtual void SetTe