Schematic symbol object. More...

#include <sch_symbol.h>

Inheritance diagram for SCH_SYMBOL:

Public Member Functions
	SCH_SYMBOL ()

	SCH_SYMBOL (const LIB_SYMBOL &aSymbol, const LIB_ID &aLibId, const SCH_SHEET_PATH aSheet, int aUnit, int aConvert=0, const VECTOR2I &aPosition=VECTOR2I(0, 0), EDA_ITEM aParent=nullptr)
	Create schematic symbol from library symbol object. More...

	SCH_SYMBOL (const LIB_SYMBOL &aSymbol, const SCH_SHEET_PATH aSheet, const PICKED_SYMBOL &aSel, const VECTOR2I &aPosition=VECTOR2I(0, 0), EDA_ITEM aParent=nullptr)

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

bool	IsMissingLibSymbol () const
	Check to see if the library symbol is set to the dummy library symbol. More...

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

bool	GetInstance (SYMBOL_INSTANCE_REFERENCE &aInstance, const KIID_PATH &aSheetPath) const

void	SetDefaultInstance (const SYMBOL_INSTANCE_REFERENCE &aInstance)

void	RemoveInstance (const SCH_SHEET_PATH &aInstancePath)

const SYMBOL_INSTANCE_REFERENCE &	GetDefaultInstance () const

void	SetInstanceToDefault (const SCH_SHEET_PATH &aInstance)

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_ID &	GetLibId () 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

wxString	GetKeyWords () const

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

bool	HasUnitDisplayName (int aUnit)
	Return true if the given unit aUnit has a display name set. More...

wxString	GetUnitDisplayName (int aUnit)
	Return the display name for a given unit 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)

TRANSFORM &	GetTransform ()

const TRANSFORM &	GetTransform () 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 () const
	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, bool aResetPrefix)
	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 BOX2I	GetBoundingBox () const override
	Return the orthogonal bounding box of this object for display purposes. More...

BOX2I	GetBodyBoundingBox () const
	Return a bounding box for the symbol body but not the pins or fields. More...

BOX2I	GetBodyAndPinsBoundingBox () const
	Return a bounding box for the symbol body and pins but not the fields. More...

SCH_FIELD *	GetField (MANDATORY_FIELD_T aFieldType)
	Return a mandatory field in this symbol. More...

const SCH_FIELD *	GetField (MANDATORY_FIELD_T aFieldNdx) const

SCH_FIELD *	GetFieldById (int aFieldId)
	Return a field in this symbol. More...

wxString	GetFieldText (const wxString &aFieldName) 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_FIELD *	AddField (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_FIELD *	FindField (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_PIN *	GetPin (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...

std::vector< LIB_PIN * >	GetLibPins () const
	Return a vector with all the pins from the library object. More...

SCH_PIN *	GetPin (LIB_PIN *aLibPin) const

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< SCH_PIN * >	GetAllPins () const
	Retrieve all SCH_PINs (from all sheets) More...

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

void	Print (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset) override
	Print a symbol. More...

void	PrintBackground (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset) override
	Print only the background parts of a symbol (if any) 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...

void	AddHierarchicalReference (const SYMBOL_INSTANCE_REFERENCE &aInstance)

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 VECTOR2I &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 VECTOR2I &aCenter) override
	Rotate the item around aCenter 90 degrees in the clockwise direction. More...

bool	Matches (const EDA_SEARCH_DATA &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...

VECTOR2I	GetPinPhysicalPosition (const LIB_PIN *Pin) const

bool	IsConnectable () const override

bool	CanConnect (const SCH_ITEM *aItem) const override

bool	IsInNetlist () const

std::vector< VECTOR2I >	GetConnectionPoints () const override
	Add all the connection points for this item to aPoints. More...

INSPECT_RESULT	Visit (INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes) override
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...

LIB_ITEM *	GetDrawItem (const VECTOR2I &aPosition, KICAD_T aType=TYPE_NOT_INIT)
	Return the symbol library item at aPosition that is part of this symbol. More...

wxString	GetSelectMenuText (UNITS_PROVIDER *aUnitsProvider) 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_SYMBOL &	operator= (const SCH_ITEM &aItem)

bool	IsReplaceable () const override
	Override this method in any derived object that supports test find and replace. More...

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &aPosition) override

bool	HitTest (const VECTOR2I &aPosition, int aAccuracy=0) const override
	Test if aPosition is inside or on the boundary of this item. More...

bool	HitTest (const BOX2I &aRect, bool aContained, int aAccuracy=0) const override
	Test if aRect intersects this item. More...

void	Plot (PLOTTER *aPlotter, bool aBackground) const override
	Plot the schematic item to aPlotter. More...

void	PlotPins (PLOTTER *aPlotter) const
	Plot just the symbol pins. More...

EDA_ITEM *	Clone () 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	GetDNP () const

void	SetDNP (bool aDNP)

bool	IsPointClickableAnchor (const VECTOR2I &aPos) const override

bool	IsType (const std::vector< KICAD_T > &aScanTypes) const override
	Check whether the item is one of the listed types. More...

SCH_ITEM *	Duplicate (bool doClone=false) const
	Routine to create a new copy of given item. More...

VECTOR2I &	GetStoredPos ()

void	SetStoredPos (const VECTOR2I &aPos)

SCHEMATIC *	Schematic () 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	DoHypertextAction (EDA_DRAW_FRAME *aFrame) const

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

const wxString &	GetDefaultFont () const

bool	RenderAsBitmap (double aWorldScale) const override

virtual bool	IsDangling () const

void	ClearConnections ()
	Clears all of the connection items from the list. More...

bool	IsConnected (const VECTOR2I &aPoint) const
	Test the item to see if it is connected to aPoint. More...

SCH_CONNECTION *	Connection (const SCH_SHEET_PATH *aSheet=nullptr) const
	Retrieve the connection associated with this object in the given sheet. More...

SCH_ITEM_SET &	ConnectedItems (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_CONNECTION *	InitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
	Create a new connection object associated with this object. More...

SCH_CONNECTION *	GetOrInitConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)

virtual bool	ConnectionPropagatesTo (const EDA_ITEM *aItem) const
	Return true if this item should propagate connection info to aItem. More...

bool	IsConnectivityDirty () const

void	SetConnectivityDirty (bool aDirty=true)

virtual void	SetLastResolvedState (const SCH_ITEM *aItem)

std::shared_ptr< NETCLASS >	GetEffectiveNetClass (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 void	ClearCaches ()

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_ITEM *	GetParent () 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

bool	IsRollover () 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 ()

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

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 VECTOR2I	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...

virtual VECTOR2I	GetSortPosition () const
	Return the coordinates that should be used for sorting this element visually compared to other elements. More...

wxString	GetTypeDesc ()
	Return a translated description of the type for this EDA_ITEM for display in user facing messages. More...

virtual bool	Replace (const EDA_SEARCH_DATA &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) const

template<typename T >
T	Get (PROPERTY_BASE *aProperty) const

template<typename T >
std::optional< T >	Get (const wxString &aProperty) const

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 INSPECT_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
	This changes first parameter to avoid the DList and use the main queue instead. More...

template<class T >
static INSPECT_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
	Change first parameter to avoid the DList and use std::vector instead. More...

static bool	Replace (const EDA_SEARCH_DATA &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 EDA_SEARCH_DATA &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

VECTOR2I	m_storedPos

std::map< SCH_SHEET_PATH, SCH_ITEM_SET, SHEET_PATH_CMP >	m_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_ITEM *	m_parent
	Linked list: Link (parent struct) More...

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

Private Member Functions
BOX2I	doGetBoundingBox (bool aIncludePins, bool aIncludeFields) const

bool	doIsConnected (const VECTOR2I &aPosition) const override
	Provide the object specific test to see if it is connected to aPosition. More...

void	Init (const VECTOR2I &pos=VECTOR2I(0, 0))

Private Attributes
VECTOR2I	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. More...

std::vector< SCH_FIELD >	m_fields
	Variable length list of fields. More...

std::unique_ptr< LIB_SYMBOL >	m_part
	a flattened copy of the LIB_SYMBOL from the PROJECT's libraries. More...

std::vector< std::unique_ptr< SCH_PIN > >	m_pins
	a SCH_PIN for every LIB_PIN (all units) More...

std::unordered_map< LIB_PIN *, unsigned >	m_pinMap
	library pin pointer : SCH_PIN's index More...

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

bool	m_DNP
	True if symbol is set to 'Do Not Populate'. More...

std::vector< SYMBOL_INSTANCE_REFERENCE >	m_instanceReferences

SYMBOL_INSTANCE_REFERENCE	m_defaultInstance
	The default instance data for this symbol. More...

KICAD_T	m_structType
	Run time identification, keep private so it can never be changed after a ctor sets it. More...

VIEW_ITEM_DATA *	m_viewPrivData

Detailed Description

Schematic symbol object.

Definition at line 79 of file sch_symbol.h.

Constructor & Destructor Documentation

◆ SCH_SYMBOL() [1/4]

SCH_SYMBOL::SCH_SYMBOL ( )

Definition at line 100 of file sch_symbol.cpp.

 :
 SCH_ITEM( nullptr, SCH_SYMBOL_T )
{
 m_DNP = false;
 Init( VECTOR2I( 0, 0 ) );
}

References Init(), and m_DNP.

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	aUnit,
		int	aConvert = `0`,
		const VECTOR2I &	aPosition = `VECTOR2I( 0, 0 )`,
		EDA_ITEM *	aParent = `nullptr`
	)

Create schematic symbol from library symbol object.

Parameters

aSymbol	is the library symbol to create schematic symbol from.
aLibId	is the LIB_ID of alias to create.
aSheet	is the schematic sheet the symbol is place into.
aUnit	is unit for symbols that have multiple parts per package.
aConvert	is the alternate body style for the schematic symbols.
aPosition	is the position of the symbol.

Definition at line 108 of file sch_symbol.cpp.

 :
 SCH_ITEM( aParent, SCH_SYMBOL_T )
{
 Init( aPosition );
 
 m_unit = aUnit;
 m_convert = aConvert;
 m_lib_id = aLibId;
 
 std::unique_ptr< LIB_SYMBOL > part;
 
 part = aSymbol.Flatten();
 part->SetParent();
 SetLibSymbol( part.release() );
 
 // Copy fields from the library symbol
 UpdateFields( aSheet,
 true, /* update style */
 false, /* update ref */
 false, /* update other fields */
 true, /* reset ref */
 true /* reset other fields */ );
 
 m_prefix = UTIL::GetRefDesPrefix( m_part->GetReferenceField().GetText() );
 
 // Set initial default symbol instance data from library symbol and initial unit.
 m_defaultInstance.m_Unit = -1;
 
 if( aSheet )
 {
 SetRef( aSheet, UTIL::GetRefDesUnannotated( m_prefix ) );
 
 // Value and footprint name are stored in the SCH_SHEET_PATH path manager,
 // if aSheet != nullptr, not in the symbol itself.
 // Copy them to the currently displayed field texts
 SetValue( GetValue( aSheet, false ) );
 SetFootprint( GetFootprint( aSheet, false ) );
 }
 
 // Inherit the include in bill of materials and board netlist settings from library symbol.
 m_inBom = aSymbol.GetIncludeInBom();
 m_onBoard = aSymbol.GetIncludeOnBoard();
 m_DNP = false;
 
}

References LIB_SYMBOL::Flatten(), GetFootprint(), LIB_SYMBOL::GetIncludeInBom(), LIB_SYMBOL::GetIncludeOnBoard(), UTIL::GetRefDesPrefix(), UTIL::GetRefDesUnannotated(), GetValue(), Init(), m_convert, m_defaultInstance, m_DNP, m_inBom, m_lib_id, m_onBoard, m_part, m_prefix, SYMBOL_INSTANCE_REFERENCE::m_Unit, 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 VECTOR2I &	aPosition = `VECTOR2I( 0, 0 )`,
		EDA_ITEM *	aParent = `nullptr`
	)

Definition at line 157 of file sch_symbol.cpp.

 :
 SCH_SYMBOL( aSymbol, aSel.LibId, aSheet, aSel.Unit, aSel.Convert, aPosition, aParent )
{
 // Set any fields that were modified as part of the symbol selection
 for( const std::pair<int, wxString>& i : aSel.Fields )
 {
 SCH_FIELD* field = GetFieldById( i.first );
 
 if( field )
 field->SetText( i.second );
 }
}

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

aSymbol is the schematic symbol to clone.

Definition at line 173 of file sch_symbol.cpp.

 :
 SCH_ITEM( aSymbol )
{
 m_parent = aSymbol.m_parent;
 m_pos = aSymbol.m_pos;
 m_unit = aSymbol.m_unit;
 m_convert = aSymbol.m_convert;
 m_lib_id = aSymbol.m_lib_id;
 m_isInNetlist = aSymbol.m_isInNetlist;
 m_inBom = aSymbol.m_inBom;
 m_onBoard = aSymbol.m_onBoard;
 m_DNP = aSymbol.m_DNP;
 
 if( aSymbol.m_part )
 SetLibSymbol( new LIB_SYMBOL( *aSymbol.m_part.get() ) );
 
 const_cast<KIID&>( m_Uuid ) = aSymbol.m_Uuid;
 
 m_transform = aSymbol.m_transform;
 m_prefix = aSymbol.m_prefix;
 m_instanceReferences = aSymbol.m_instanceReferences;
 m_fields = aSymbol.m_fields;
 
 // Re-parent the fields, which before this had aSymbol as parent
 for( SCH_FIELD& field : m_fields )
 field.SetParent( this );
 
 m_fieldsAutoplaced = aSymbol.m_fieldsAutoplaced;
 m_schLibSymbolName = aSymbol.m_schLibSymbolName;
 m_defaultInstance = aSymbol.m_defaultInstance;
}

References m_convert, m_defaultInstance, m_DNP, 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 112 of file sch_symbol.h.

112{ }

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 193 of file sch_item.cpp.

{
 SCH_ITEM_SET& set = m_connected_items[ aSheet ];
 
 // The vector elements are small, so reserve 1k at a time to prevent re-allocations
 if( set.size() == set.capacity() )
 set.reserve( set.size() + 4096 );
 
 set.emplace_back( aItem );
}

References SCH_ITEM::m_connected_items.

Referenced by SCH_LABEL_BASE::UpdateDanglingState(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ AddField()

SCH_FIELD * SCH_SYMBOL::AddField ( const SCH_FIELD & aField )

Add a field to the symbol.

Parameters

aField is the field to add to this symbol.

Returns: the newly inserted field.

Definition at line 938 of file sch_symbol.cpp.

{
 int newNdx = m_fields.size();
 
 m_fields.push_back( aField );
 return &m_fields[newNdx];
}

References m_fields.

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

◆ AddHierarchicalReference() [1/2]

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

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

Definition at line 525 of file sch_symbol.cpp.

{
 // Search for an existing path and remove it if found (should not occur)
 for( unsigned ii = 0; ii < m_instanceReferences.size(); ii++ )
 {
 if( m_instanceReferences[ii].m_Path == aPath )
 {
 wxLogTrace( traceSchSheetPaths, "Removing symbol instance:\n"
 " sheet path %s\n"
 " reference %s, unit %d from symbol %s.",
 aPath.AsString(),
 m_instanceReferences[ii].m_Reference,
 m_instanceReferences[ii].m_Unit,
 m_Uuid.AsString() );
 
 m_instanceReferences.erase( m_instanceReferences.begin() + ii );
 ii--;
 }
 }
 
 SYMBOL_INSTANCE_REFERENCE instance;
 instance.m_Path = aPath;
 instance.m_Reference = aRef;
 instance.m_Unit = aUnit;
 instance.m_Value = aValue;
 instance.m_Footprint = aFootprint;
 
 wxLogTrace( traceSchSheetPaths,
 "Adding symbol '%s' instance:\n"
 " sheet path '%s'\n"
 " reference '%s'\n"
 " unit %d\n"
 " value '%s'\n"
 " footprint '%s'",
 m_Uuid.AsString(),
 aPath.AsString(),
 aRef,
 aUnit,
 aValue,
 aFootprint );
 
 m_instanceReferences.push_back( instance );
 
 // This should set the default instance to the first saved instance data for each symbol
 // when importing sheets.
 if( m_instanceReferences.size() == 1 )
 {
 m_fields[ REFERENCE_FIELD ].SetText( aRef );
 m_fields[ VALUE_FIELD ].SetText( aValue );
 m_unit = aUnit;
 m_fields[ FOOTPRINT_FIELD ].SetText( aFootprint );
 }
}

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

Referenced by SCH_SHEET_PATH::AddNewSymbolInstances(), AddSheetPathReferenceEntryIfMissing(), SetFootprint(), SetInstanceToDefault(), SCH_SCREEN::SetLegacySymbolInstanceData(), SetRef(), SetUnitSelection(), SetValue(), and SCH_SHEET_LIST::UpdateSymbolInstances().

◆ AddHierarchicalReference() [2/2]

void SCH_SYMBOL::AddHierarchicalReference ( const SYMBOL_INSTANCE_REFERENCE & aInstance )

Definition at line 582 of file sch_symbol.cpp.

{
 // Search for an existing path and remove it if found (should not occur)
 for( unsigned ii = 0; ii < m_instanceReferences.size(); ii++ )
 {
 if( m_instanceReferences[ii].m_Path == aInstance.m_Path )
 {
 wxLogTrace( traceSchSheetPaths, "Removing symbol instance:\n"
 " sheet path %s\n"
 " reference %s, unit %d from symbol %s.",
 aInstance.m_Path.AsString(),
 m_instanceReferences[ii].m_Reference,
 m_instanceReferences[ii].m_Unit,
 m_Uuid.AsString() );
 
 m_instanceReferences.erase( m_instanceReferences.begin() + ii );
 ii--;
 }
 }
 
 SYMBOL_INSTANCE_REFERENCE instance = aInstance;
 
 wxLogTrace( traceSchSheetPaths,
 "Adding symbol '%s' instance:\n"
 " sheet path '%s'\n"
 " reference '%s'\n"
 " unit %d\n"
 " value '%s'\n"
 " footprint '%s'",
 m_Uuid.AsString(),
 instance.m_Path.AsString(),
 instance.m_Reference,
 instance.m_Unit,
 instance.m_Value,
 instance.m_Footprint );
 
 m_instanceReferences.push_back( instance );
 
 // This should set the default instance to the first saved instance data for each symbol
 // when importing sheets.
 if( m_instanceReferences.size() == 1 )
 {
 m_fields[ REFERENCE_FIELD ].SetText( instance.m_Reference );
 m_fields[ VALUE_FIELD ].SetText( instance.m_Value );
 m_unit = instance.m_Unit;
 m_fields[ FOOTPRINT_FIELD ].SetText( instance.m_Footprint );
 }
}

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

◆ 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

aSheetPath is 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 1335 of file sch_symbol.cpp.

{
 // An empty sheet path is illegal, at a minimum the root sheet UUID must be present.
 wxCHECK( aSheetPath.size() > 0, false );
 
 for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
 {
 // if aSheetPath is found, nothing to do:
 if( instance.m_Path == aSheetPath )
 return false;
 }
 
 // This entry does not exist: add it, with its last-used reference
 AddHierarchicalReference( aSheetPath, m_fields[REFERENCE_FIELD].GetText(), m_unit );
 return true;
}

References AddHierarchicalReference(), EDA_UNIT_UTILS::GetText(), 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

aScreen is the SCH_SCREEN associated with the current instance of the symbol.

Definition at line 436 of file sch_item.h.

 {
 if( GetFieldsAutoplaced() )
 AutoplaceFields( aScreen, GetFieldsAutoplaced() == FIELDS_AUTOPLACED_MANUAL );
 }

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

Referenced by DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), SCH_SHEET::SCH_SHEET(), SCH_EDIT_FRAME::SelectUnit(), and DIALOG_LABEL_PROPERTIES::TransferDataFromWindow().

◆ AutoplaceFields()

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

overridevirtual

Automatically orient all the fields in the symbol.

Parameters

aScreen	is the SCH_SCREEN associated with the current instance of the symbol. This can be NULL when aManual is false.
aManual	should 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 739 of file autoplace_fields.cpp.

{
 if( aManual )
 wxASSERT_MSG( aScreen, "A SCH_SCREEN pointer must be given for manual autoplacement" );
 
 AUTOPLACER autoplacer( this, aScreen );
 autoplacer.DoAutoplace( aManual );
 m_fieldsAutoplaced = ( aManual ? FIELDS_AUTOPLACED_MANUAL : FIELDS_AUTOPLACED_AUTO );
}

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

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), and SCH_DRAWING_TOOLS::PlaceSymbol().

◆ CanConnect()

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

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 680 of file sch_symbol.h.

 {
 return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
 ( aItem->Type() == SCH_NO_CONNECT_T ) ||
 ( aItem->Type() == SCH_JUNCTION_T ) ||
 ( aItem->Type() == SCH_SYMBOL_T ) ||
 ( aItem->Type() == SCH_DIRECTIVE_LABEL_T ) ||
 ( aItem->Type() == SCH_LABEL_T ) ||
 ( aItem->Type() == SCH_HIER_LABEL_T ) ||
 ( aItem->Type() == SCH_GLOBAL_LABEL_T );
 }

References SCH_ITEM::GetLayer(), LAYER_WIRE, SCH_DIRECTIVE_LABEL_T, 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 114 of file sch_symbol.h.

 {
 return aItem && SCH_SYMBOL_T == aItem->Type();
 }

References SCH_SYMBOL_T, and EDA_ITEM::Type().

◆ ClearAnnotation()

void SCH_SYMBOL::ClearAnnotation	(	const SCH_SHEET_PATH *	aSheetPath,
		bool	aResetPrefix
	)

Clear exiting symbol annotation.

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

Parameters

	aSheetPath	is the hierarchical path of the symbol to clear or remove all annotations for this symbol if NULL.
[in]	aResetPrefix	The annotation prefix ('R', 'U', etc.) should be reset to the symbol library prefix.

Definition at line 1291 of file sch_symbol.cpp.

{
 if( aSheetPath )
 {
 KIID_PATH path = aSheetPath->Path();
 
 for( SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
 {
 if( instance.m_Path == path )
 {
 if( instance.m_Reference.IsEmpty() || aResetPrefix )
 instance.m_Reference = UTIL::GetRefDesUnannotated( m_prefix );
 else
 instance.m_Reference = UTIL::GetRefDesUnannotated( instance.m_Reference );
 }
 }
 }
 else
 {
 for( SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
 {
 if( instance.m_Reference.IsEmpty() || aResetPrefix)
 instance.m_Reference = UTIL::GetRefDesUnannotated( m_prefix );
 else
 instance.m_Reference = UTIL::GetRefDesUnannotated( instance.m_Reference );
 }
 }
 
 for( std::unique_ptr<SCH_PIN>& pin : m_pins )
 pin->ClearDefaultNetName( aSheetPath );
 
 // These 2 changes do not work in complex hierarchy.
 // When a clear annotation is made, the calling function must call a
 // UpdateAllScreenReferences for the active sheet.
 // But this call cannot made here.
 wxString currentReference = m_fields[REFERENCE_FIELD].GetText();
 
 if( currentReference.IsEmpty() || aResetPrefix )
 m_fields[REFERENCE_FIELD].SetText( UTIL::GetRefDesUnannotated( m_prefix ) );
 else
 m_fields[REFERENCE_FIELD].SetText( UTIL::GetRefDesUnannotated( currentReference ) );
}

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(), SCH_DRAWING_TOOLS::PlaceSymbol(), and SCH_EDITOR_CONTROL::updatePastedSymbol().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 122 of file eda_item.h.

122{ ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:143

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:66

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ ClearBrightenedPins()

void SCH_SYMBOL::ClearBrightenedPins ( )

Definition at line 2232 of file sch_symbol.cpp.

{
 for( auto& pin : m_pins )
 pin->ClearBrightened();
}

References m_pins, and pin.

Referenced by SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ ClearCaches()

void SCH_ITEM::ClearCaches ( )

virtualinherited

Reimplemented in SCH_FIELD.

Definition at line 251 of file sch_item.cpp.

{
 auto clearTextCaches =
 []( SCH_ITEM* aItem )
 {
 EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( aItem );
 
 if( text )
 {
 text->ClearBoundingBoxCache();
 text->ClearRenderCache();
 }
 };
 
 clearTextCaches( this );
 
 RunOnChildren( clearTextCaches );
}

References SCH_ITEM::RunOnChildren(), and text.

◆ 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 372 of file sch_item.h.

372{ m_connections.clear(); }

SCH_ITEM::m_connections

EDA_ITEMS m_connections

Definition: sch_item.h:492

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 160 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

References EDA_ITEM::ClearFlags(), and EDA_ITEM::GetEditFlags().

Referenced by BOARD::Add(), FOOTPRINT::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )

inlineinherited

Definition at line 427 of file sch_item.h.

427{ m_fieldsAutoplaced = FIELDS_AUTOPLACED_NO; }

FIELDS_AUTOPLACED_NO

@ FIELDS_AUTOPLACED_NO

Definition: sch_item.h:56

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_LABEL_BASE::SCH_LABEL_BASE(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 143 of file eda_item.h.

143{ m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:498

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildCourtyardCaches(), 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(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE_ON_MOVE::Init(), EE_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetIsShownAsBitmap(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 121 of file eda_item.h.

121{ ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Item was manually selected by the user.

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL::LIB_SYMBOL(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 155 of file eda_item.h.

 {
 ClearFlags( CANDIDATE | SELECTED_BY_DRAG | IS_LINKED | SKIP_STRUCT | DO_NOT_DRAW );
 }

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, IS_LINKED, SELECTED_BY_DRAG, and SKIP_STRUCT.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

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 236 of file sch_symbol.cpp.

{
 return new SCH_SYMBOL( *this );
}

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 187 of file sch_item.cpp.

{
 return m_connected_items[ aSheet ];
}

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE::FindWireSegmentNetNameRecursive(), 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 146 of file sch_item.cpp.

{
 if( !IsConnectable() )
 return nullptr;
 
 wxCHECK_MSG( !IsConnectivityDirty(), nullptr,
 wxT( "Shouldn't be asking for connection if connectivity is dirty!" ) );
 
 if( !aSheet )
 aSheet = &Schematic()->CurrentSheet();
 
 auto it = m_connection_map.find( *aSheet );
 
 if( it == m_connection_map.end() )
 return nullptr;
 else
 return it->second;
}

References SCHEMATIC::CurrentSheet(), SCH_ITEM::IsConnectable(), SCH_ITEM::IsConnectivityDirty(), 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(), CONNECTION_GRAPH::GetBusesNeedingMigration(), SCH_ITEM::GetEffectiveNetClass(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), SCH_ITEM::GetOrInitConnection(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_TEXT::Plot(), SCH_LABEL_BASE::Print(), SCH_EDIT_FRAME::RecalculateConnections(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_LABEL_BASE::ResolveTextVar(), 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, SCH_LINE, and SCH_PIN.

Definition at line 411 of file sch_item.h.

411{ return true; }

◆ doGetBoundingBox()

BOX2I SCH_SYMBOL::doGetBoundingBox	(	bool	aIncludePins,
		bool	aIncludeFields
	)		const

private

Definition at line 1577 of file sch_symbol.cpp.

{
 BOX2I bBox;
 
 if( m_part )
 bBox = m_part->GetBodyBoundingBox( m_unit, m_convert, aIncludePins, false );
 else
 bBox = dummy()->GetBodyBoundingBox( m_unit, m_convert, aIncludePins, false );
 
 int x0 = bBox.GetX();
 int xm = bBox.GetRight();
 
 // We must reverse Y values, because matrix orientation
 // suppose Y axis normal for the library items coordinates,
 // m_transform reverse Y values, but bBox is already reversed!
 int y0 = -bBox.GetY();
 int ym = -bBox.GetBottom();
 
 // Compute the real Boundary box (rotated, mirrored ...)
 int x1 = m_transform.x1 * x0 + m_transform.y1 * y0;
 int y1 = m_transform.x2 * x0 + m_transform.y2 * y0;
 int x2 = m_transform.x1 * xm + m_transform.y1 * ym;
 int y2 = m_transform.x2 * xm + m_transform.y2 * ym;
 
 bBox.SetX( x1 );
 bBox.SetY( y1 );
 bBox.SetWidth( x2 - x1 );
 bBox.SetHeight( y2 - y1 );
 bBox.Normalize();
 
 bBox.Offset( m_pos );
 
 if( aIncludeFields )
 {
 for( const SCH_FIELD& field : m_fields )
 {
 if( field.IsVisible() )
  bBox.Merge( field.GetBoundingBox() );
 }
 }
 
 return bBox;
}

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

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

◆ DoHypertextAction()

virtual void SCH_ITEM::DoHypertextAction ( EDA_DRAW_FRAME * aFrame ) const

inlinevirtualinherited

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 241 of file sch_item.h.

241{ }

◆ doIsConnected()

bool SCH_SYMBOL::doIsConnected ( const VECTOR2I & 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

aPosition is a reference to a VECTOR2I object containing the test position.

Returns: True if connection to aPosition exists.

Reimplemented from SCH_ITEM.

Definition at line 2088 of file sch_symbol.cpp.

{
 VECTOR2I new_pos = m_transform.InverseTransform().TransformCoordinate( aPosition - m_pos );
 
 for( const auto& pin : m_pins )
 {
 if( pin->GetType() == ELECTRICAL_PINTYPE::PT_NC )
 continue;
 
 // Collect only pins attached to the current unit and convert.
 // others are not associated to this symbol instance
 int pin_unit = pin->GetLibPin()->GetUnit();
 int pin_convert = pin->GetLibPin()->GetConvert();
 
 if( pin_unit > 0 && pin_unit != GetUnit() )
 continue;
 
 if( pin_convert > 0 && pin_convert != GetConvert() )
 continue;
 
 if( pin->GetLocalPosition() == new_pos )
 return true;
 }
 
 return false;
}

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 93 of file sch_item.cpp.

{
 SCH_ITEM* newItem = (SCH_ITEM*) Clone();
 
 if( !doClone )
 const_cast<KIID&>( newItem->m_Uuid ) = KIID();
 
 newItem->ClearFlags( SELECTED | BRIGHTENED );
 
 newItem->RunOnChildren(
 []( SCH_ITEM* aChild )
 {
 aChild->ClearFlags( SELECTED | BRIGHTENED );
 } );
 
 return newItem;
}

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

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

◆ FindField()

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

Search for a SCH_FIELD with aFieldName.

Parameters

aFieldName	is the name of the field to find.
aIncludeDefaultFields	searches the library symbol default fields if true.

Returns: the field if found or NULL if the field was not found.

Definition at line 960 of file sch_symbol.cpp.

{
 unsigned start = aIncludeDefaultFields ? 0 : MANDATORY_FIELDS;
 
 for( unsigned i = start; i < m_fields.size(); ++i )
 {
 if( aFieldName == m_fields[i].GetName( false ) )
  return &m_fields[i];
 }
 
 return nullptr;
}

References m_fields, and MANDATORY_FIELDS.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_SHEET_LIST::MigrateSimModelNameFields(), DIALOG_CHANGE_SYMBOLS::processSymbol(), NETLIST_EXPORTER_SPICE::readLibraryField(), NETLIST_EXPORTER_SPICE::readNameField(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and UpdateFields().

◆ Get() [1/3]

template<typename T >

std::optional< T > INSPECTABLE::Get ( const wxString & aProperty ) const

inlineinherited

Definition at line 104 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 std::optional<T> ret;
 
 if( prop )
 {
 const void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
 if( object )
 ret = prop->get<T>( object );
 }
 
 return ret;
 }

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 return object ? aProperty->getter( object ) : wxAny();
 }

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(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( !object )
 throw std::runtime_error( "Could not cast INSPECTABLE to the requested type" );
 
 return aProperty->get<T>( object );
 }

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

◆ GetAllPins()

std::vector< SCH_PIN * > SCH_SYMBOL::GetAllPins ( ) const

Retrieve all SCH_PINs (from all sheets)

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

◆ GetBodyAndPinsBoundingBox()

BOX2I SCH_SYMBOL::GetBodyAndPinsBoundingBox ( ) const

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

Definition at line 1628 of file sch_symbol.cpp.

{
 return doGetBoundingBox( true, false );
}

References doGetBoundingBox().

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

◆ GetBodyBoundingBox()

BOX2I SCH_SYMBOL::GetBodyBoundingBox ( ) const

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

Definition at line 1622 of file sch_symbol.cpp.

{
 return doGetBoundingBox( false, false );
}

References doGetBoundingBox().

Referenced by AUTOPLACER::AUTOPLACER(), KIGFX::SCH_PAINTER::draw(), EE_SELECTION_TOOL::GuessSelectionCandidates(), and HitTest().

◆ GetBoundingBox()

const BOX2I 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 1634 of file sch_symbol.cpp.

{
 return doGetBoundingBox( true, true );
}

References doGetBoundingBox().

Referenced by SCH_EDITOR_CONTROL::FindSymbolAndItem(), and Plot().

◆ GetClass()

wxString SCH_SYMBOL::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 119 of file sch_symbol.h.

 {
 return wxT( "SCH_SYMBOL" );
 }

Referenced by operator=().

◆ GetConnectionPoints()

std::vector< VECTOR2I > 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

aPoints is the list of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 1861 of file sch_symbol.cpp.

{
 std::vector<VECTOR2I> retval;
 
 for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
 {
 // Collect only pins attached to the current unit and convert.
 // others are not associated to this symbol instance
 int pin_unit = pin->GetLibPin()->GetUnit();
 int pin_convert = pin->GetLibPin()->GetConvert();
 
 if( pin_unit > 0 && pin_unit != GetUnit() )
 continue;
 
 if( pin_convert > 0 && pin_convert != GetConvert() )
 continue;
 
 retval.push_back( m_transform.TransformCoordinate( pin->GetLocalPosition() ) + m_pos );
 }
 
 return retval;
}

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 1151 of file sch_symbol.cpp.

{
 for( int i = 0; i < MANDATORY_FIELDS; ++i )
 aVars->push_back( m_fields[i].GetCanonicalName().Upper() );
 
 for( size_t i = MANDATORY_FIELDS; i < m_fields.size(); ++i )
 aVars->push_back( m_fields[i].GetName() );
 
 aVars->push_back( wxT( "FOOTPRINT_LIBRARY" ) );
 aVars->push_back( wxT( "FOOTPRINT_NAME" ) );
 aVars->push_back( wxT( "UNIT" ) );
 aVars->push_back( wxT( "SYMBOL_LIBRARY" ) );
 aVars->push_back( wxT( "SYMBOL_NAME" ) );
 aVars->push_back( wxT( "SYMBOL_DESCRIPTION" ) );
 aVars->push_back( wxT( "SYMBOL_KEYWORDS" ) );
 aVars->push_back( wxT( "EXCLUDE_FROM_BOM" ) );
 aVars->push_back( wxT( "EXCLUDE_FROM_BOARD" ) );
 aVars->push_back( wxT( "DNP" ) );
}

References m_fields, and MANDATORY_FIELDS.

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

◆ GetConvert()

int SCH_SYMBOL::GetConvert ( ) const

inline

◆ GetDatasheet()

wxString SCH_SYMBOL::GetDatasheet ( ) const

Return the documentation text for the given part alias.

Definition at line 332 of file sch_symbol.cpp.

{
 if( m_part )
 return m_part->GetDatasheetField().GetText();
 
 return wxEmptyString;
}

References m_part.

Referenced by UpdateFields().

◆ GetDefaultFont()

const wxString & SCH_ITEM::GetDefaultFont ( ) const

inherited

Definition at line 286 of file sch_item.cpp.

{
 EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
 
 return cfg->m_Appearance.default_font;
}

References EESCHEMA_SETTINGS::APPEARANCE::default_font, EESCHEMA_SETTINGS::m_Appearance, and Pgm().

Referenced by SCH_FIELD::GetDrawFont(), SCH_TEXT::GetDrawFont(), and SCH_TEXTBOX::GetDrawFont().

◆ GetDefaultInstance()

const SYMBOL_INSTANCE_REFERENCE & SCH_SYMBOL::GetDefaultInstance ( ) const

inline

Definition at line 154 of file sch_symbol.h.

154{ return m_defaultInstance; }

References m_defaultInstance.

Referenced by SCH_SCREEN::AllSymbolDefaultInstancesNotSet(), and SCH_SEXPR_PLUGIN::saveSymbol().

◆ GetDescription()

wxString SCH_SYMBOL::GetDescription ( ) const

Returns: the associated LIB_SYMBOL's description field (or wxEmptyString).

Definition at line 314 of file sch_symbol.cpp.

{
 if( m_part )
 return m_part->GetDescription();
 
 return wxEmptyString;
}

References m_part.

Referenced by NETLIST_EXPORTER_XML::makeSymbols(), and ResolveTextVar().

◆ GetDNP()

bool SCH_SYMBOL::GetDNP ( ) const

inline

Definition at line 757 of file sch_symbol.h.

757{ return m_DNP; }

References m_DNP.

Referenced by KIGFX::SCH_PAINTER::draw(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_FIELD::Plot(), Plot(), PlotPins(), Print(), PrintBackground(), ResolveTextVar(), SCH_SEXPR_PLUGIN::saveSymbol(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetDrawItem()

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

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

Parameters

aPosition	is the schematic position of the symbol library object.
aType	is 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 1885 of file sch_symbol.cpp.

{
 if( m_part )
 {
 // Calculate the position relative to the symbol.
 VECTOR2I libPosition = aPosition - m_pos;
 
 return m_part->LocateDrawItem( m_unit, m_convert, aType, libPosition, m_transform );
 }
 
 return nullptr;
}

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 147 of file eda_item.h.

 {
 constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
 | IS_CHANGED | IS_WIRE_IMAGE | STRUCT_DELETED );
 
 return m_flags & mask;
 }

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

◆ GetEffectiveNetClass()

std::shared_ptr< NETCLASS > SCH_ITEM::GetEffectiveNetClass ( const SCH_SHEET_PATH * aSheet = nullptr ) const

inherited

Definition at line 166 of file sch_item.cpp.

{
 static std::shared_ptr<NETCLASS> nullNetclass = std::make_shared<NETCLASS>( wxEmptyString );
 
 SCHEMATIC* schematic = Schematic();
 
 if( schematic )
 {
 std::shared_ptr<NET_SETTINGS>& netSettings = schematic->Prj().GetProjectFile().m_NetSettings;
 SCH_CONNECTION* connection = Connection( aSheet );
 
 if( connection )
 return netSettings->GetEffectiveNetClass( connection->Name() );
 else
 return netSettings->m_DefaultNetClass;
 }
 
 return nullNetclass;
}

References SCH_ITEM::Connection(), PROJECT::GetProjectFile(), PROJECT_FILE::m_NetSettings, SCH_CONNECTION::Name(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

Referenced by SCH_BUS_ENTRY_BASE::GetBusEntryColor(), SCH_LINE::GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_FIELD::GetFieldColor(), SCH_JUNCTION::GetJunctionColor(), SCH_LABEL_BASE::GetLabelColor(), SCH_LINE::GetLineColor(), SCH_BUS_ENTRY_BASE::GetLineStyle(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), and SCH_LABEL_BASE::ResolveTextVar().

◆ 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

aItemList is the list of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 1787 of file sch_symbol.cpp.

{
 for( auto& pin : m_pins )
 {
 LIB_PIN* lib_pin = pin->GetLibPin();
 
 if( lib_pin->GetUnit() && m_unit && ( m_unit != lib_pin->GetUnit() ) )
 continue;
 
 DANGLING_END_ITEM item( PIN_END, lib_pin, GetPinPhysicalPosition( lib_pin ), this );
 aItemList.push_back( item );
 }
}

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

◆ GetField() [1/2]

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

Definition at line 898 of file sch_symbol.cpp.

{
 return &m_fields[aFieldType];
}

References m_fields.

◆ GetField() [2/2]

SCH_FIELD * SCH_SYMBOL::GetField ( MANDATORY_FIELD_T aFieldType )

Return a mandatory field in this symbol.

Note: If you need to fetch a user field, use GetFieldById.

Parameters

aFieldType is one of the mandatory field types (REFERENCE_FIELD, VALUE_FIELD, etc.).

Returns: is the field at aFieldType or NULL if the field does not exist.

Definition at line 892 of file sch_symbol.cpp.

{
 return &m_fields[aFieldType];
}

References m_fields.

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), NETLIST_EXPORTER_XML::addSymbolFields(), SIM_PLOT_FRAME::AddTuner(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_EDIT_TOOL::EditField(), GetFootprint(), GetRef(), GetSelectMenuText(), GetValue(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), Plot(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), SCH_SCREEN::SetLegacySymbolInstanceData(), SetRef(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_SHEET::SymbolCount(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_EDITOR_CONTROL::updatePastedSymbol(), SCH_SHEET_LIST::UpdateSymbolInstances(), Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

◆ GetFieldById()

SCH_FIELD * SCH_SYMBOL::GetFieldById ( int aFieldId )

Return a field in this symbol.

Parameters

aFieldId is 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 904 of file sch_symbol.cpp.

{
 for( size_t ii = 0; ii < m_fields.size(); ++ii )
 {
 if( m_fields[ii].GetId() == aFieldId )
 return &m_fields[ii];
 }
 
 return nullptr;
}

References m_fields.

Referenced by SCH_SYMBOL(), UpdateFields(), and SIM_PLOT_FRAME::UpdateTunerValue().

◆ GetFieldCount()

int SCH_SYMBOL::GetFieldCount ( ) const

inline

Return the number of fields in this symbol.

Definition at line 476 of file sch_symbol.h.

476{ return (int)m_fields.size(); }

References m_fields.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_SHEET_LIST::MigrateSimModelNameFields(), operator==(), SCH_ALTIUM_PLUGIN::ParseParameter(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), UpdateFields(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetFields() [1/3]

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

inline

Return a vector of fields from the symbol.

Definition at line 421 of file sch_symbol.h.

421{ return m_fields; }

References m_fields.

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

◆ GetFields() [2/3]

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

inline

Definition at line 422 of file sch_symbol.h.

422{ return m_fields; }

References m_fields.

◆ GetFields() [3/3]

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

Populate a std::vector with SCH_FIELDs.

Parameters

aVector	is the vector to populate.
aVisibleOnly	is used to add only the fields that are visible and contain text.

Definition at line 928 of file sch_symbol.cpp.

{
 for( SCH_FIELD& field : m_fields )
 {
 if( !aVisibleOnly || ( field.IsVisible() && !field.IsVoid() ) )
 aVector.push_back( &field );
 }
}

References m_fields.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SIM_PLOT_FRAME::AddTuner(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), AUTOPLACER::AUTOPLACER(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), NETLIST_EXPORTER_XML::makeSymbols(), operator==(), DIALOG_CHANGE_SYMBOLS::processSymbol(), NETLIST_EXPORTER_SPICE::readModel(), NETLIST_EXPORTER_SPICE::readNameField(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), 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().

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const

inlineinherited

Return whether the fields have been automatically placed.

Definition at line 424 of file sch_item.h.

424{ return m_fieldsAutoplaced; }

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 ) const

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

Parameters

aFieldName is the name of the field

Definition at line 916 of file sch_symbol.cpp.

{
 for( const SCH_FIELD& field : m_fields )
 {
 if( aFieldName == field.GetName() || aFieldName == field.GetCanonicalName() )
 return field.GetText();
 }
 
 return wxEmptyString;
}

References m_fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), and SCH_ALTIUM_PLUGIN::ParseParameter().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 144 of file eda_item.h.

144{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), collidesWithArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), LIB_SYMBOL::LIB_SYMBOL(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD_TOOL::RecombinePad(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 256 of file eda_item.h.

256{ return GetPosition(); }

EDA_ITEM::GetPosition

virtual VECTOR2I GetPosition() const

Definition: eda_item.h:249

References EDA_ITEM::GetPosition().

Referenced by 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 833 of file sch_symbol.cpp.

{
 KIID_PATH path = sheet->Path();
 
 for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
 {
 if( instance.m_Path == path && !instance.m_Footprint.IsEmpty() )
 {
 // This can only be an override from an Update Schematic from PCB, and therefore
 // will always be fully resolved.
 return instance.m_Footprint;
 }
 }
 
 if( !aResolve )
 return GetField( FOOTPRINT_FIELD )->GetText();
 
 return GetField( FOOTPRINT_FIELD )->GetShownText();
}

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(), netList(), 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 751 of file sch_symbol.h.

751{ return m_inBom; }

References m_inBom.

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

◆ GetIncludeOnBoard()

bool SCH_SYMBOL::GetIncludeOnBoard ( ) const

inline

Definition at line 754 of file sch_symbol.h.

754{ return m_onBoard; }

References m_onBoard.

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

◆ GetInstance()

bool SCH_SYMBOL::GetInstance	(	SYMBOL_INSTANCE_REFERENCE &	aInstance,
		const KIID_PATH &	aSheetPath
	)		const

Definition at line 487 of file sch_symbol.cpp.

{
 for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
 {
 if( instance.m_Path == aSheetPath )
 {
 aInstance = instance;
 return true;
 }
 }
 
 return false;
}

References m_instanceReferences.

Referenced by SCH_SHEET_PATH::AddNewSymbolInstances().

◆ GetInstanceReferences()

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

inline

Definition at line 139 of file sch_symbol.h.

 {
 return m_instanceReferences;
 }

References m_instanceReferences.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_SHEET_PATH::AddNewSymbolInstances(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SCREEN::SetAllSymbolDefaultInstances(), and SCH_SCREEN::SetLegacySymbolInstanceData().

◆ GetKeyWords()

wxString SCH_SYMBOL::GetKeyWords ( ) const

Returns: the associated LIB_SYMBOL's keywords field (or wxEmptyString).

Definition at line 323 of file sch_symbol.cpp.

{
 if( m_part )
 return m_part->GetKeyWords();
 
 return wxEmptyString;
}

References m_part.

Referenced by ResolveTextVar().

◆ GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 246 of file sch_item.h.

246{ return m_layer; }

SCH_ITEM::m_layer

SCH_LAYER_ID m_layer

Definition: sch_item.h:491

References SCH_ITEM::m_layer.

Referenced by SCH_ITEM::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL_BASE::CanConnect(), SCH_LINE::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_SHEET::CanConnect(), CanConnect(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), DIALOG_IMAGE_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_SCREEN::doIsJunction(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_EDIT_TOOL::Init(), SCH_LINE::IsBus(), SCH_LINE::IsGraphicLine(), SCH_LINE::IsWire(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_LINE::operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_JUNCTION::Plot(), SCH_LINE::Plot(), SCH_JUNCTION::Print(), SCH_LINE::Print(), SCH_LEGACY_PLUGIN::saveBusEntry(), SCH_LEGACY_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveText(), SCH_EDIT_FRAME::TrimWire(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ GetLibId()

const LIB_ID & SCH_SYMBOL::GetLibId ( ) const

inline

Definition at line 178 of file sch_symbol.h.

178{ return m_lib_id; }

References m_lib_id.

Referenced by SCH_SCREEN::Append(), SCH_SCREENS::ChangeSymbolLibNickname(), CollectOtherUnits(), SCH_REFERENCE::CompareLibName(), SCH_EDIT_FRAME::CreateArchiveLibrary(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SEXPR_PLUGIN::Format(), SCH_SCREENS::GetLibNicknames(), GetMsgPanelInfo(), GetSelectMenuText(), SYMBOL_CANDIDATE::GetStringLibId(), SCH_SCREENS::HasNoFullyDefinedLibIds(), DIALOG_CHANGE_SYMBOLS::isMatch(), NETLIST_EXPORTER_XML::makeSymbols(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_TOOL::Properties(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_EDIT_FRAME::SelectUnit(), sort_by_libid(), SYMBOL_CANDIDATE::SYMBOL_CANDIDATE(), ERC_TESTER::TestLibSymbolIssues(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), and DIALOG_CHANGE_SYMBOLS::updateFieldsList().

◆ GetLibPins() [1/2]

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

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

Returns: List of the pins

Definition at line 1072 of file sch_symbol.cpp.

{
 std::vector<LIB_PIN*> pinList;
 
 GetLibPins( pinList );
 return pinList;
}

References GetLibPins().

Referenced by GetLibPins().

◆ GetLibPins() [2/2]

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

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

Parameters

aPinsList is the list to populate with all of the pins.

Definition at line 1065 of file sch_symbol.cpp.

{
 if( m_part )
 m_part->GetPins( aPinsList, m_unit, m_convert );
}

References m_convert, m_part, and m_unit.

Referenced by DIALOG_SIM_MODEL< T >::DIALOG_SIM_MODEL().

◆ GetLibSymbolRef() [1/2]

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

inline

Definition at line 195 of file sch_symbol.h.

195{ return m_part; }

References m_part.

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_SHEET_PATH::AddNewSymbolInstances(), SCH_SCREEN::AllSymbolDefaultInstancesNotSet(), SCH_SHEET_LIST::AnnotatePowerSymbols(), SCH_SCREEN::Append(), SCH_SHEET_PATH::AppendMultiUnitSymbol(), SCH_SHEET_PATH::AppendSymbol(), SCH_EDIT_FRAME::ConvertPart(), NETLIST_EXPORTER_BASE::CreatePinList(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SCH_SCREEN::GetPin(), highlightNet(), SCH_FIELD::IsReplaceable(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), NETLIST_EXPORTER_XML::makeSymbols(), DIALOG_SYMBOL_PROPERTIES::onUpdateEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::onUpdateEditSymbol(), SCH_DRAWING_TOOLS::PlaceSymbol(), ERC_TESTER::TestLibSymbolIssues(), SYMBOL_UNIT_MENU::update(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ GetLibSymbolRef() [2/2]

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

inline

Definition at line 196 of file sch_symbol.h.

196{ return m_part; }

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 1719 of file sch_symbol.cpp.

{
 return BITMAPS::add_component;
}

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

aList is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 1640 of file sch_symbol.cpp.

{
 wxString msg;
 
 SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( aFrame );
 SCH_SHEET_PATH* currentSheet = schframe ? &schframe->GetCurrentSheet() : nullptr;
 
 // part and alias can differ if alias is not the root
 if( m_part )
 {
 if( m_part.get() != dummy() )
 {
 if( m_part->IsPower() )
 {
 aList.emplace_back( _( "Power symbol" ), GetValue( currentSheet, true ) );
 }
 else
 {
 aList.emplace_back( _( "Reference" ), GetRef( currentSheet ) );
 aList.emplace_back( _( "Value" ), GetValue( currentSheet, true ) );
 aList.emplace_back( _( "Name" ), UnescapeString( GetLibId().GetLibItemName() ) );
 }
 
#if 0 // Display symbol flags, for debug only
 aList.emplace_back( _( "flags" ), wxString::Format( "%X", GetEditFlags() ) );
#endif
 
 if( !m_part->IsRoot() )
 {
  msg = _( "Missing parent" );
 
 std::shared_ptr< LIB_SYMBOL > parent = m_part->GetParent().lock();
 
 if( parent )
 msg = parent->GetName();
 
 aList.emplace_back( _( "Alias of" ), UnescapeString( msg ) );
 }
 else if( !m_lib_id.GetLibNickname().empty() )
 {
 aList.emplace_back( _( "Library" ), m_lib_id.GetLibNickname() );
 }
 else
 {
 aList.emplace_back( _( "Library" ), _( "Undefined!!!" ) );
 }
 
 // Display the current associated footprint, if exists.
 msg = GetFootprint( currentSheet, true );
 
 if( msg.IsEmpty() )
 msg = _( "<Unknown>" );
 
 aList.emplace_back( _( "Footprint" ), msg );
 
 // Display description of the symbol, and keywords found in lib
 aList.emplace_back( _( "Description" ), m_part->GetDescription() );
 aList.emplace_back( _( "Keywords" ), m_part->GetKeyWords() );
 }
 }
 else
 {
 aList.emplace_back( _( "Reference" ), GetRef( currentSheet ) );
 
 aList.emplace_back( _( "Value" ), GetValue( currentSheet, true ) );
 aList.emplace_back( _( "Name" ), GetLibId().GetLibItemName() );
 
 wxString libNickname = GetLibId().GetLibNickname();
 
 if( libNickname.empty() )
 msg = _( "No library defined!" );
 else
 msg.Printf( _( "Symbol not found in %s!" ), libNickname );
 
 aList.emplace_back( _( "Library" ), msg );
  }
}

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 ( ) const

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 1508 of file sch_symbol.cpp.

{
 int rotate_values[] =
 {
 SYM_ORIENT_0,
 SYM_ORIENT_90,
 SYM_ORIENT_180,
 SYM_ORIENT_270,
 SYM_MIRROR_X + SYM_ORIENT_0,
 SYM_MIRROR_X + SYM_ORIENT_90,
 SYM_MIRROR_X + SYM_ORIENT_270,
 SYM_MIRROR_Y,
 SYM_MIRROR_Y + SYM_ORIENT_0,
 SYM_MIRROR_Y + SYM_ORIENT_90,
 SYM_MIRROR_Y + SYM_ORIENT_180,
 SYM_MIRROR_Y + SYM_ORIENT_270
 };
 
 // Try to find the current transform option:
 TRANSFORM transform = m_transform;
 SCH_SYMBOL temp( *this );
 
 for( int type_rotate : rotate_values )
 {
 temp.SetOrientation( type_rotate );
 
 if( transform == temp.GetTransform() )
 return type_rotate;
 }
 
 // Error: orientation not found in list (should not happen)
 wxFAIL_MSG( "Schematic symbol orientation matrix internal error." );
 
 return SYM_NORMAL;
}

References GetTransform(), 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(), SCH_SCREEN::GetLabelOrientationForPoint(), AUTOPLACER::getPreferredSides(), orientLabel(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_EDIT_TOOL::Swap(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetOrInitConnection()

SCH_CONNECTION * SCH_ITEM::GetOrInitConnection	(	const SCH_SHEET_PATH &	aPath,
		CONNECTION_GRAPH *	aGraph
	)

inherited

Definition at line 228 of file sch_item.cpp.

{
 if( !IsConnectable() )
 return nullptr;
 
 SetConnectivityDirty( false );
 
 SCH_CONNECTION* connection = Connection( &aSheet );
 
 if( connection )
 return connection;
 else
 return InitializeConnection( aSheet, aGraph );
}

References SCH_ITEM::Connection(), SCH_ITEM::InitializeConnection(), SCH_ITEM::IsConnectable(), and SCH_ITEM::SetConnectivityDirty().

◆ GetParent()

EDA_ITEM * EDA_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 99 of file eda_item.h.

99{ return m_parent; }

References EDA_ITEM::m_parent.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::editFieldText(), SCH_FIELD::GetFieldColor(), getInferredSymbols(), SCH_PIN::GetParentSymbol(), EE_SELECTION_TOOL::highlight(), highlightNet(), SCH_FIELD::HitTest(), SCH_PIN::IsStacked(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), BOARD_COMMIT::parentObject(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_EDITOR_CONTROL::ReplaceAll(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_ITEM::Schematic(), SCH_SCREEN::Schematic(), SCH_SHEET::SearchHierarchy(), PCB_SELECTION_TOOL::select(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), EE_SELECTION_TOOL::unhighlight(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), EE_TOOL_BASE< T >::updateItem(), and SCH_BASE_FRAME::UpdateItem().

◆ GetPenWidth()

virtual int SCH_ITEM::GetPenWidth ( ) const

inlinevirtualinherited

Returns: the size of the "pen" that be used to draw or plot this item

Reimplemented in SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_DIRECTIVE_LABEL, SCH_LINE, SCH_NO_CONNECT, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 263 of file sch_item.h.

263{ return 0; }

Referenced by EE_RTREE::contains(), KIGFX::SCH_PAINTER::draw(), SCH_BUS_ENTRY_BASE::GetBoundingBox(), KIGFX::SCH_PAINTER::getLineWidth(), SCH_BUS_ENTRY_BASE::HitTest(), EE_RTREE::insert(), SCH_BUS_ENTRY_BASE::Plot(), SCH_BUS_ENTRY_BASE::Print(), and EE_RTREE::remove().

◆ GetPin() [1/2]

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

Find a symbol pin by number.

Parameters

number is the number of the pin to find.

Returns: Pin object if found, otherwise NULL.

Definition at line 1053 of file sch_symbol.cpp.

{
 for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
 {
 if( pin->GetNumber() == aNumber )
 return pin.get();
 }
 
 return nullptr;
}

References m_pins, and pin.

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

◆ GetPin() [2/2]

SCH_PIN * SCH_SYMBOL::GetPin ( LIB_PIN * aLibPin ) const

Definition at line 1081 of file sch_symbol.cpp.

{
 wxASSERT( m_pinMap.count( aLibPin ) );
 return m_pins[ m_pinMap.at( aLibPin ) ].get();
}

References m_pinMap, and m_pins.

◆ GetPinPhysicalPosition()

VECTOR2I SCH_SYMBOL::GetPinPhysicalPosition ( const LIB_PIN * Pin ) const

Definition at line 1852 of file sch_symbol.cpp.

{
 wxCHECK_MSG( Pin != nullptr && Pin->Type() == LIB_PIN_T, VECTOR2I( 0, 0 ),
 wxT( "Cannot get physical position of pin." ) );
 
 return m_transform.TransformCoordinate( Pin->GetPosition() ) + m_pos;
}

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 1088 of file sch_symbol.cpp.

{
 std::vector<SCH_PIN*> pins;
 
 if( aSheet == nullptr )
 {
 wxCHECK_MSG( Schematic(), pins, "Can't call GetPins on a symbol with no schematic" );
 
 aSheet = &Schematic()->CurrentSheet();
 }
 
 int unit = GetUnitSelection( aSheet );
 
 for( const std::unique_ptr<SCH_PIN>& p : m_pins )
 {
 if( unit && p->GetLibPin()->GetUnit() && ( p->GetLibPin()->GetUnit() != unit ) )
 continue;
 
 pins.push_back( p.get() );
 }
 
 return pins;
}

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

Referenced by NETLIST_EXPORTER_BASE::CreatePinList(), AUTOPLACER::fieldBoxPlacement(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), findSymbolsAndPins(), SCH_SCREEN::GetLabelOrientationForPoint(), highlightNet(), SCH_EDITOR_CONTROL::Paste(), AUTOPLACER::pinsOnSide(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), ERC_TESTER::TestNoConnectPins(), ERC_TESTER::TestOffGridEndpoints(), CONNECTION_GRAPH::updateItemConnectivity(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ GetPosition()

VECTOR2I SCH_SYMBOL::GetPosition ( ) const

inlineoverridevirtual

◆ GetPrefix()

wxString SCH_SYMBOL::GetPrefix ( ) const

inline

Definition at line 277 of file sch_symbol.h.

277{ return m_prefix; }

References m_prefix.

Referenced by SCH_SCREEN::AllSymbolDefaultInstancesNotSet(), and SCH_LEGACY_PLUGIN::saveSymbol().

◆ GetRawPins()

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

inline

Definition at line 537 of file sch_symbol.h.

537{ return m_pins; }

References m_pins.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), and SCH_SEXPR_PLUGIN::saveSymbol().

◆ 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 632 of file sch_symbol.cpp.

{
 KIID_PATH path = sheet->Path();
 wxString ref;
 wxString subRef;
 
 for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
 {
 if( instance.m_Path == path )
 {
 ref = instance.m_Reference;
 subRef = LIB_SYMBOL::SubReference( instance.m_Unit );
 break;
 }
 }
 
 // If it was not found in m_Paths array, then see if it is in m_Field[REFERENCE] -- if so,
 // use this as a default for this path. This will happen if we load a version 1 schematic
 // file. It will also mean that multiple instances of the same sheet by default all have
 // the same symbol references, but perhaps this is best.
 if( ref.IsEmpty() && !GetField( REFERENCE_FIELD )->GetText().IsEmpty() )
 {
 const_cast<SCH_SYMBOL*>( this )->SetRef( sheet, GetField( REFERENCE_FIELD )->GetText() );
 ref = GetField( REFERENCE_FIELD )->GetText();
 }
 
 if( ref.IsEmpty() )
 ref = UTIL::GetRefDesUnannotated( m_prefix );
 
 if( aIncludeUnit && GetUnitCount() > 1 )
 ref += subRef;
 
 return ref;
}

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

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), SCH_SHEET_PATH::AppendMultiUnitSymbol(), SCH_SHEET_PATH::AppendSymbol(), TEST_SCH_REFERENCE_LIST_FIXTURE::checkAnnotation(), 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_EDIT_SYMBOLS_LIBID::initDlg(), DIALOG_CHANGE_SYMBOLS::isMatch(), TEST_SCH_REFERENCE_LIST_FIXTURE::loadTestCase(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_FIELD::Matches(), SCH_SHEET_LIST::MigrateSimModelNameFields(), netList(), SCH_EDITOR_CONTROL::Paste(), NETLIST_EXPORTER_SPICE::readRefName(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SCH_REFERENCE_LIST::ReannotateByOptions(), 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_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ GetSchSymbolLibraryName()

wxString SCH_SYMBOL::GetSchSymbolLibraryName ( ) const

Definition at line 296 of file sch_symbol.cpp.

{
 if( !m_schLibSymbolName.IsEmpty() )
 return m_schLibSymbolName;
 else
 return m_lib_id.Format();
}

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 ( UNITS_PROVIDER * aUnitsProvider ) 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 1899 of file sch_symbol.cpp.

{
 return wxString::Format( _( "Symbol %s [%s]" ),
 GetField( REFERENCE_FIELD )->GetShownText(),
 UnescapeString( GetLibId().GetLibItemName() ) );
}

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

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

Return the coordinates that should be used for sorting this element visually compared to other elements.

For instance, for lines the midpoint might be a better sorting point than either end.

Returns: X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 265 of file eda_item.h.

265{ return GetPosition(); }

References EDA_ITEM::GetPosition().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 126 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 139 of file eda_item.h.

139{ return m_status; }

References EDA_ITEM::m_status.

◆ GetStoredPos()

VECTOR2I & SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 209 of file sch_item.h.

209{ return m_storedPos; }

SCH_ITEM::m_storedPos

VECTOR2I m_storedPos

Definition: sch_item.h:494

References SCH_ITEM::m_storedPos.

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 457 of file sch_item.h.

457{ wxCHECK( false, STROKE_PARAMS() ); }

STROKE_PARAMS

Simple container to manage line stroke parameters.

Definition: stroke_params.h:88

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ GetTransform() [1/2]

TRANSFORM & SCH_SYMBOL::GetTransform ( )

inline

◆ GetTransform() [2/2]

const TRANSFORM & SCH_SYMBOL::GetTransform ( ) const

inline

Definition at line 282 of file sch_symbol.h.

282{ return m_transform; }

References m_transform.

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( )

inherited

Return a translated description of the type for this EDA_ITEM for display in user facing messages.

Definition at line 301 of file eda_item.cpp.

{
 //@see EDA_ITEM_DESC for definition of ENUM_MAP<KICAD_T>
 wxString typeDescr = ENUM_MAP<KICAD_T>::Instance().ToString( Type() );
 
 return wxGetTranslation( typeDescr );
}

References ENUM_MAP< T >::Instance(), and EDA_ITEM::Type().

Referenced by PROPERTIES_PANEL::update().

◆ GetUnit()

int SCH_SYMBOL::GetUnit ( ) const

inline

Definition at line 231 of file sch_symbol.h.

231{ return m_unit; }

References m_unit.

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), doIsConnected(), KIGFX::SCH_PAINTER::draw(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), GetConnectionPoints(), SCH_SCREEN::GetPin(), SCH_FIELD::GetShownText(), IsPointClickableAnchor(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCH_FIELD::Matches(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), SCH_DRAWING_TOOLS::PlaceSymbol(), Plot(), PlotPins(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_TOOL::Properties(), CONNECTION_GRAPH::Recalculate(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), SYMBOL_UNIT_MENU::update(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and Visit().

◆ 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 429 of file sch_symbol.cpp.

{
 if( m_part )
 return m_part->GetUnitCount();
 
 return 0;
}

References m_part.

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

◆ GetUnitDisplayName()

wxString SCH_SYMBOL::GetUnitDisplayName ( int aUnit )

Return the display name for a given unit aUnit.

Returns: the display name of a unit if set, or the ordinal name of the unit otherwise.

Definition at line 438 of file sch_symbol.cpp.

{
 wxCHECK( m_part, ( wxString::Format( _( "Unit %s" ), LIB_SYMBOL::SubReference( aUnit ) ) ) );
 
 return m_part->GetUnitDisplayName( aUnit );
}

References _, Format(), m_part, and LIB_SYMBOL::SubReference().

Referenced by 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 725 of file sch_symbol.cpp.

{
 KIID_PATH path = aSheet->Path();
 
 for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
 {
 if( instance.m_Path == path )
 return instance.m_Unit;
 }
 
 // If it was not found in m_Paths array, then use m_unit. This will happen if we load a
 // version 1 schematic file.
 return m_unit;
}

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

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), KIGFX::SCH_PAINTER::draw(), GetPins(), CONNECTION_GRAPH::Recalculate(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), 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 767 of file sch_symbol.cpp.

{
 KIID_PATH path = sheet->Path();
 
 for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
 {
 if( instance.m_Path == path && !instance.m_Value.IsEmpty() )
 {
 // This can only be overridden by a new value but if we are resolving,
 // make sure that the symbol returns the fully resolved text
 if( aResolve )
 {
 SCH_SYMBOL new_sym( *this );
 new_sym.GetField( VALUE_FIELD )->SetText( instance.m_Value );
 return new_sym.GetField( VALUE_FIELD )->GetShownText();
 }
 
 return instance.m_Value;
 }
 }
 
 if( !aResolve )
 return GetField( VALUE_FIELD )->GetText();
 
 return GetField( VALUE_FIELD )->GetShownText();
}

References GetField(), SCH_FIELD::GetShownText(), EDA_TEXT::GetText(), m_instanceReferences, SCH_SHEET_PATH::Path(), path, EDA_TEXT::SetText(), 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_SHEET_LIST::MigrateSimModelNameFields(), netList(), SCH_FIELD::Replace(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SYMBOL(), SCH_SHEET_PATH::UpdateAllScreenReferences(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ HasBrightenedPins()

bool SCH_SYMBOL::HasBrightenedPins ( )

Definition at line 2220 of file sch_symbol.cpp.

{
 for( const auto& pin : m_pins )
 {
 if( pin->IsBrightened() )
 return true;
 }
 
 return false;
}

References m_pins, and pin.

Referenced by SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 145 of file eda_item.h.

145{ return ( m_flags & aFlag ) == aFlag; }

References EDA_ITEM::m_flags.

Referenced by GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), SCH_MOVE_TOOL::Main(), SCH_SCREEN::MarkConnections(), SCH_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::orthoLineDrag(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< T >::saveCopyInUndoList().

◆ 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_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 455 of file sch_item.h.

455{ return false; }

Referenced by SCH_EDIT_TOOL::Init(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ HasUnitDisplayName()

bool SCH_SYMBOL::HasUnitDisplayName ( int aUnit )

Return true if the given unit aUnit has a display name set.

Returns: true if the display name of a unit is set, otherwise false.

Definition at line 446 of file sch_symbol.cpp.

{
 wxCHECK( m_part, false );
 
 return m_part->HasUnitDisplayName( aUnit );
}

References m_part.

Referenced by DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ HitTest() [1/2]

bool SCH_SYMBOL::HitTest	(	const BOX2I &	aRect,
		bool	aContained,
		int	aAccuracy = `0`
	)		const

overridevirtual

Test if aRect intersects this item.

Parameters

aRect	A reference to a BOX2I object containing the rectangle to test.
aContained	Set to true to test for containment instead of an intersection.
aAccuracy	Increase aRect by this amount.

Returns: True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 2072 of file sch_symbol.cpp.

{
 if( m_flags & STRUCT_DELETED || m_flags & SKIP_STRUCT )
 return false;
 
 BOX2I rect = aRect;
 
 rect.Inflate( aAccuracy / 2 );
 
 if( aContained )
 return rect.Contains( GetBodyBoundingBox() );
 
 return rect.Intersects( GetBodyBoundingBox() );
}

References BOX2< Vec >::Contains(), GetBodyBoundingBox(), BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), EDA_ITEM::m_flags, SKIP_STRUCT, and STRUCT_DELETED.

◆ HitTest() [2/2]

bool SCH_SYMBOL::HitTest	(	const VECTOR2I &	aPosition,
		int	aAccuracy = `0`
	)		const

overridevirtual

Test if aPosition is inside or on the boundary of this item.

Parameters

aPosition	A reference to a VECTOR2I object containing the coordinates to test.
aAccuracy	Increase the item bounding box by this amount.

Returns: True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 2060 of file sch_symbol.cpp.

{
 BOX2I bBox = GetBodyBoundingBox();
 bBox.Inflate( aAccuracy / 2 );
 
 if( bBox.Contains( aPosition ) )
 return true;
 
 return false;
}

References BOX2< Vec >::Contains(), GetBodyBoundingBox(), and BOX2< Vec >::Inflate().

◆ Init()

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

private

Definition at line 206 of file sch_symbol.cpp.

{
 m_layer = LAYER_DEVICE;
 m_pos = pos;
 m_unit = 1; // In multi unit chip - which unit to draw.
 m_convert = LIB_ITEM::LIB_CONVERT::BASE; // De Morgan Handling
 
 // The rotation/mirror transformation matrix. pos normal
 m_transform = TRANSFORM();
 
 // construct only the mandatory fields, which are the first 4 only.
 for( int i = 0; i < MANDATORY_FIELDS; ++i )
 {
 m_fields.emplace_back( pos, i, this, TEMPLATE_FIELDNAME::GetDefaultFieldName( i ) );
 
 if( i == REFERENCE_FIELD )
 m_fields.back().SetLayer( LAYER_REFERENCEPART );
 else if( i == VALUE_FIELD )
 m_fields.back().SetLayer( LAYER_VALUEPART );
 else
 m_fields.back().SetLayer( LAYER_FIELDS );
 }
 
 m_prefix = wxString( wxT( "U" ) );
 m_isInNetlist = true;
 m_inBom = true;
 m_onBoard = true;
}

References TEMPLATE_FIELDNAME::GetDefaultFieldName(), LAYER_DEVICE, LAYER_FIELDS, LAYER_REFERENCEPART, LAYER_VALUEPART, m_convert, m_fields, m_inBom, m_isInNetlist, SCH_ITEM::m_layer, 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

aPath is the sheet path to initialize.

Definition at line 205 of file sch_item.cpp.

{
 SetConnectivityDirty( false );
 
 SCH_CONNECTION* connection = Connection( &aSheet );
 
 if( connection )
 {
 connection->Reset();
 }
 else
 {
 connection = new SCH_CONNECTION( this );
 m_connection_map.insert( std::make_pair( aSheet, connection ) );
 }
 
 connection->SetGraph( aGraph );
 connection->SetSheet( aSheet );
 return connection;
}

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

Referenced by SCH_ITEM::GetOrInitConnection().

◆ 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

aSheet is the sheet path to test.

Returns: true if the symbol exists on that sheet and has a valid reference.

Definition at line 711 of file sch_symbol.cpp.

{
 KIID_PATH path = aSheet->Path();
 
 for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
 {
 if( instance.m_Path == path )
 return instance.m_Reference.Last() != '?';
 }
 
 return false;
}

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()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

110{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), SCH_EDIT_FRAME::FocusOnItem(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::setDeviceColors(), SCH_EDITOR_CONTROL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ 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 678 of file sch_symbol.h.

678{ return true; }

◆ IsConnected()

bool SCH_ITEM::IsConnected ( const VECTOR2I & aPoint ) const

inherited

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

Parameters

aPoint is a reference to a VECTOR2I object containing the coordinates to test.

Returns: True if connection to aPoint exists.

Definition at line 137 of file sch_item.cpp.

{
 if(( m_flags & STRUCT_DELETED ) || ( m_flags & SKIP_STRUCT ) )
 return false;
 
 return doIsConnected( aPosition );
}

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

Referenced by SCH_SCREEN::doIsJunction(), SCH_MOVE_TOOL::getConnectedItems(), SCH_SCREEN::IsTerminalPoint(), and SCH_SCREEN::MarkConnections().

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( ) const

inlineinherited

Definition at line 413 of file sch_item.h.

413{ return m_connectivity_dirty; }

SCH_ITEM::m_connectivity_dirty

bool m_connectivity_dirty

Definition: sch_item.h:503

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_ITEM::Connection(), KIGFX::SCH_PAINTER::draw(), SCH_BUS_ENTRY_BASE::GetBusEntryColor(), SCH_LINE::GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_FIELD::GetFieldColor(), SCH_JUNCTION::GetJunctionColor(), SCH_LABEL_BASE::GetLabelColor(), SCH_LINE::GetLineColor(), SCH_BUS_ENTRY_BASE::GetLineStyle(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), and highlightNet().

◆ IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LABEL_BASE, SCH_LINE, and SCH_PIN.

Definition at line 342 of file sch_item.h.

342{ return false; }

Referenced by SCH_EDIT_TOOL::ChangeTextType(), and KIGFX::SCH_PAINTER::draw().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 105 of file eda_item.h.

105{ return m_flags & IS_DRAGGING; }

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 108 of file eda_item.h.

108{ return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:73

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 203 of file eda_item.h.

203{ return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:497

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, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 239 of file sch_item.h.

239{ return false; }

Referenced by SCH_ITEM::RenderAsBitmap().

◆ IsInNetlist()

bool SCH_SYMBOL::IsInNetlist ( ) const

Returns: true if the symbol is in netlist.

Definition at line 2116 of file sch_symbol.cpp.

{
 return m_isInNetlist;
}

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

229{ return false; }

◆ IsMissingLibSymbol()

bool SCH_SYMBOL::IsMissingLibSymbol ( ) const

Check to see if the library symbol is set to the dummy library symbol.

When the library symbol is missing (which technically should not happen now that the library symbols are cached in the schematic file), a dummy library symbol is substituted for the missing symbol as an indicator that something is amiss. The dummy symbol cannot be edited so a check for this symbol must be performed before attempting to edit the library symbol with the library editor or it will crash KiCad.

See also: dummy()

Returns: true if the library symbol is missing or false if it is valid.

Definition at line 242 of file sch_symbol.cpp.

{
 if( !m_part )
 return true;
 
 return false;
}

References m_part.

Referenced by SCH_EDITOR_CONTROL::EditWithSymbolEditor(), and SCH_EDIT_TOOL::Properties().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

102{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

bool SCH_SYMBOL::IsMovableFromAnchorPoint ( ) const

overridevirtual

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.; We now use this to keep poorly-formed symbols from getting dragged off-grid. If the symbol contains off-grid pins we will not allow it to be moved from its anchor.

Reimplemented from SCH_ITEM.

Definition at line 265 of file sch_symbol.cpp.

{
 // If a symbol's anchor is not grid-aligned to its pins then moving from the anchor is
 // going to end up moving the symbol's pins off-grid.
 
 // The minimal grid size allowed to place a pin is 25 mils
 const int min_grid_size = schIUScale.MilsToIU( 25 );
 
 for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
 {
 if( ( ( pin->GetPosition().x - m_pos.x ) % min_grid_size ) != 0 )
 return false;
 
 if( ( ( pin->GetPosition().y - m_pos.y ) % min_grid_size ) != 0 )
 return false;
 }
 
 return true;
}

References m_pins, m_pos, EDA_IU_SCALE::MilsToIU(), pin, schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

104{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), LIB_PIN::CalcEdit(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Swap().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

103{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

◆ IsPointClickableAnchor()

bool SCH_SYMBOL::IsPointClickableAnchor ( const VECTOR2I & 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 2239 of file sch_symbol.cpp.

{
 for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
 {
 int pin_unit = pin->GetLibPin()->GetUnit();
 int pin_convert = pin->GetLibPin()->GetConvert();
 
 if( pin_unit > 0 && pin_unit != GetUnit() )
 continue;
 
 if( pin_convert > 0 && pin_convert != GetConvert() )
 continue;
 
 if( pin->IsPointClickableAnchor( aPos ) )
 return true;
 }
 
 return false;
}

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

aReferenceString is the reference string to validate

Returns: true if reference string is valid.

Definition at line 668 of file sch_symbol.cpp.

{
 return !UTIL::GetRefDesPrefix( aReferenceString ).IsEmpty();
}

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 722 of file sch_symbol.h.

722{ return true; }

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 109 of file eda_item.h.

109{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 112 of file eda_item.h.

 {
 return ( m_flags & ( IS_ROLLOVER | IS_MOVING ) ) == IS_ROLLOVER;
 }

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

107{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 175 of file eda_item.h.

175{ return m_flags & IS_SHOWN_AS_BITMAP; }

IS_SHOWN_AS_BITMAP

#define IS_SHOWN_AS_BITMAP

Definition: eda_item_flags.h:55

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsType()

bool SCH_ITEM::IsType ( const std::vector< KICAD_T > & aScanTypes ) const

inlineoverridevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

Returns: true if the item type is contained in the list aScanTypes

Reimplemented from EDA_ITEM.

Reimplemented in SCH_LABEL_BASE, and SCH_LINE.

Definition at line 162 of file sch_item.h.

 {
 if( EDA_ITEM::IsType( aScanTypes ) )
 return true;
 
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == SCH_ITEM_LOCATE_WIRE_T && m_layer == LAYER_WIRE )
 return true;
 
 if ( scanType == SCH_ITEM_LOCATE_BUS_T && m_layer == LAYER_BUS )
 return true;
 
 if ( scanType == SCH_ITEM_LOCATE_GRAPHIC_LINE_T
 && Type() == SCH_LINE_T && m_layer == LAYER_NOTES )
 {
 return true;
 }
 }
 
 return false;
 }

References EDA_ITEM::IsType(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, SCH_ITEM::m_layer, SCH_ITEM_LOCATE_BUS_T, SCH_ITEM_LOCATE_GRAPHIC_LINE_T, SCH_ITEM_LOCATE_WIRE_T, SCH_LINE_T, and EDA_ITEM::Type().

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_FRAME::AutoRotateItem(), SCH_FIELD::IsType(), SCH_LABEL_BASE::IsType(), SCH_LINE::IsType(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

106{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >

static INSPECT_RESULT EDA_ITEM::IterateForward	(	std::deque< T > &	aList,
		INSPECTOR	inspector,
		void *	testData,
		const std::vector< KICAD_T > &	scanTypes
	)

inlinestaticinherited

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

Definition at line 302 of file eda_item.h.

 {
 for( const auto& it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector,
 testData,
 scanTypes ) == INSPECT_RESULT::QUIT )
 {
 return INSPECT_RESULT::QUIT;
 }
 }
 
 return INSPECT_RESULT::CONTINUE;
 }

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

static INSPECT_RESULT EDA_ITEM::IterateForward	(	std::vector< T > &	aList,
		INSPECTOR	inspector,
		void *	testData,
		const std::vector< KICAD_T > &	scanTypes
	)

inlinestaticinherited

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

Definition at line 322 of file eda_item.h.

 {
 for( const auto& it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector,
 testData,
 scanTypes ) == INSPECT_RESULT::QUIT )
 {
 return INSPECT_RESULT::QUIT;
 }
 }
 
 return INSPECT_RESULT::CONTINUE;
 }

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

◆ Matches() [1/2]

bool SCH_SYMBOL::Matches	(	const EDA_SEARCH_DATA &	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

aSearchData	A reference to a wxFindReplaceData object containing the search criteria.
aAuxData	A 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 1780 of file sch_symbol.cpp.

{
 // Symbols are searchable via the child field and pin item text.
 return false;
}

Referenced by SCH_DRAWING_TOOLS::PlaceSymbol().

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

aText	A reference to a wxString object containing the string to test.
aSearchData	The criteria to search against.

Returns: True if aText matches the search criteria in aSearchData.

Definition at line 117 of file eda_item.cpp.

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 
 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( aSearchData.searchAndReplace && !IsReplaceable() )
 return false;
 
 if( !aSearchData.matchCase )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 return false;
 
 ii = next;
 next += searchText.length();
 
 bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 
 if( startOK && endOK )
 return true;
 else
 ii++;
 }
 
 return false;
 }
 else if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

References EDA_SEARCH_DATA::findString, EDA_ITEM::IsReplaceable(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::searchAndReplace, text, WHOLEWORD, and WILDCARD.

◆ MirrorHorizontally()

void SCH_SYMBOL::MirrorHorizontally ( int aCenter )

overridevirtual

Mirror item horizontally about aCenter.

Implements SCH_ITEM.

Definition at line 1725 of file sch_symbol.cpp.

{
 int dx = m_pos.x;
 
 SetOrientation( SYM_MIRROR_Y );
 MIRROR( m_pos.x, aCenter );
 dx -= m_pos.x; // dx,0 is the move vector for this transform
 
 for( SCH_FIELD& field : m_fields )
 {
 // Move the fields to the new position because the symbol itself has moved.
 VECTOR2I pos = field.GetTextPos();
 pos.x -= dx;
 field.SetTextPos( pos );
 }
}

References m_fields, m_pos, MIRROR(), SetOrientation(), SYM_MIRROR_Y, and VECTOR2< T >::x.

◆ MirrorVertically()

void SCH_SYMBOL::MirrorVertically ( int aCenter )

overridevirtual

Mirror item vertically about aCenter.

Implements SCH_ITEM.

Definition at line 1743 of file sch_symbol.cpp.

{
 int dy = m_pos.y;
 
 SetOrientation( SYM_MIRROR_X );
 MIRROR( m_pos.y, aCenter );
 dy -= m_pos.y; // 0,dy is the move vector for this transform
 
 for( SCH_FIELD& field : m_fields )
 {
 // Move the fields to the new position because the symbol itself has moved.
 VECTOR2I pos = field.GetTextPos();
 pos.y -= dy;
 field.SetTextPos( pos );
 }
}

References m_fields, m_pos, MIRROR(), SetOrientation(), SYM_MIRROR_X, and VECTOR2< T >::y.

◆ Move()

void SCH_SYMBOL::Move ( const VECTOR2I & aMoveVector )

inlineoverridevirtual

Move the item by aMoveVector to a new position.

Implements SCH_ITEM.

Definition at line 642 of file sch_symbol.h.

 {
 if( aMoveVector == VECTOR2I( 0, 0 ) )
 return;
 
 m_pos += aMoveVector;
 
 for( SCH_FIELD& field : m_fields )
 field.Move( aMoveVector );
 
 SetModified();
 }

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

Referenced by SetPosition().

◆ operator!=()

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

Definition at line 2016 of file sch_symbol.cpp.

{
 return !( *this == aSymbol );
}

◆ 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 231 of file eda_item.cpp.

{
 wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
 GetClass() ) );
 
 return false;
}

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 1979 of file sch_symbol.cpp.

{
 if( Type() != aItem.Type() )
 return Type() < aItem.Type();
 
 auto symbol = static_cast<const SCH_SYMBOL*>( &aItem );
 
 BOX2I rect = GetBodyAndPinsBoundingBox();
 
 if( rect.GetArea() != symbol->GetBodyAndPinsBoundingBox().GetArea() )
 return rect.GetArea() < symbol->GetBodyAndPinsBoundingBox().GetArea();
 
 if( m_pos.x != symbol->m_pos.x )
 return m_pos.x < symbol->m_pos.x;
 
 if( m_pos.y != symbol->m_pos.y )
 return m_pos.y < symbol->m_pos.y;
 
 return m_Uuid < aItem.m_Uuid; // Ensure deterministic sort
}

References BOX2< Vec >::GetArea(), GetBodyAndPinsBoundingBox(), m_pos, EDA_ITEM::m_Uuid, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ operator=()

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

Definition at line 2022 of file sch_symbol.cpp.

{
 wxCHECK_MSG( Type() == aItem.Type(), *this,
 wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
 GetClass() );
 
 if( &aItem != this )
 {
 SCH_ITEM::operator=( aItem );
 
 SCH_SYMBOL* c = (SCH_SYMBOL*) &aItem;
 
 m_lib_id = c->m_lib_id;
 
 LIB_SYMBOL* libSymbol = c->m_part ? new LIB_SYMBOL( *c->m_part.get() ) : nullptr;
 
 m_part.reset( libSymbol );
 m_pos = c->m_pos;
 m_unit = c->m_unit;
 m_convert = c->m_convert;
 m_transform = c->m_transform;
 
 m_instanceReferences = c->m_instanceReferences;
 m_defaultInstance = c->m_defaultInstance;
 
 m_fields = c->m_fields; // std::vector's assignment operator
 
 // Reparent fields after assignment to new symbol.
 for( SCH_FIELD& field : m_fields )
 field.SetParent( this );
 
 UpdatePins();
 }
 
 return *this;
}

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

◆ operator==()

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

Definition at line 2001 of file sch_symbol.cpp.

{
 if( GetFieldCount() != aSymbol.GetFieldCount() )
 return false;
 
 for( int i = VALUE_FIELD; i < GetFieldCount(); i++ )
 {
 if( GetFields()[i].GetText().Cmp( aSymbol.GetFields()[i].GetText() ) != 0 )
 return false;
 }
 
 return true;
}

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

◆ Plot()

void SCH_SYMBOL::Plot	(	PLOTTER *	aPlotter,
		bool	aBackground
	)		const

overridevirtual

Plot the schematic item to aPlotter.

Parameters

aPlotter	is the PLOTTER object to plot to.
aBackground	a poor-man's Z-order. The routine will get called twice, first with aBackground true and then with aBackground false.

Reimplemented from SCH_ITEM.

Definition at line 2122 of file sch_symbol.cpp.

{
 if( aBackground )
 return;
 
 if( m_part )
 {
 LIB_PINS libPins;
 m_part->GetPins( libPins, GetUnit(), GetConvert() );
 
 // Copy the source so we can re-orient and translate it.
 LIB_SYMBOL tempSymbol( *m_part );
 LIB_PINS tempPins;
 tempSymbol.GetPins( tempPins, GetUnit(), GetConvert() );
 
 // Copy the pin info from the symbol to the temp pins
 for( unsigned i = 0; i < tempPins.size(); ++ i )
 {
 SCH_PIN* symbolPin = GetPin( libPins[ i ] );
 LIB_PIN* tempPin = tempPins[ i ];
 
 tempPin->SetName( symbolPin->GetShownName() );
 tempPin->SetType( symbolPin->GetType() );
 tempPin->SetShape( symbolPin->GetShape() );
 
 if( symbolPin->IsDangling() )
 tempPin->SetFlags( IS_DANGLING );
 }
 
 TRANSFORM temp = GetTransform();
 aPlotter->StartBlock( nullptr );
 
 for( bool local_background : { true, false } )
 {
 tempSymbol.Plot( aPlotter, GetUnit(), GetConvert(), local_background, m_pos, temp,
 GetDNP() );
 
 for( SCH_FIELD field : m_fields )
 field.Plot( aPlotter, local_background );
 }
 
 // Plot attributes to a hypertext menu
 std::vector<wxString> properties;
 
 for( const SCH_FIELD& field : GetFields() )
 {
 properties.emplace_back( wxString::Format( wxT( "!%s = %s" ),
 field.GetName(),
 field.GetShownText() ) );
 }
 
 properties.emplace_back( wxString::Format( wxT( "!%s = %s" ),
 _( "Description" ),
 m_part->GetDescription() ) );
 
 properties.emplace_back( wxString::Format( wxT( "!%s = %s" ),
 _( "Keywords" ),
 m_part->GetKeyWords() ) );
 
 aPlotter->HyperlinkMenu( GetBoundingBox(), properties );
 
 aPlotter->EndBlock( nullptr );
 
 if( !m_part->IsPower() )
 aPlotter->Bookmark( GetBoundingBox(), GetField( REFERENCE_FIELD )->GetShownText(), _("Symbols") );
 }
}

References _, PLOTTER::Bookmark(), PLOTTER::EndBlock(), Format(), GetBoundingBox(), GetConvert(), GetDNP(), GetField(), GetFields(), GetPin(), LIB_SYMBOL::GetPins(), SCH_PIN::GetShape(), SCH_PIN::GetShownName(), GetTransform(), SCH_PIN::GetType(), GetUnit(), PLOTTER::HyperlinkMenu(), IS_DANGLING, SCH_PIN::IsDangling(), m_fields, m_part, m_pos, LIB_SYMBOL::Plot(), REFERENCE_FIELD, EDA_ITEM::SetFlags(), LIB_PIN::SetName(), LIB_PIN::SetShape(), LIB_PIN::SetType(), and PLOTTER::StartBlock().

◆ PlotPins()

void SCH_SYMBOL::PlotPins ( PLOTTER * aPlotter ) const

Plot just the symbol pins.

This is separated to match the GAL display order. The pins are ALSO plotted with the symbol group. This replotting allows us to ensure that they are shown above other elements in the schematic.

Parameters

aPlotter is the PLOTTER object used to plot pins.

Definition at line 2191 of file sch_symbol.cpp.

{
 if( m_part )
 {
 LIB_PINS libPins;
 m_part->GetPins( libPins, GetUnit(), GetConvert() );
 
 // Copy the source to stay const
 LIB_SYMBOL tempSymbol( *m_part );
 LIB_PINS tempPins;
 tempSymbol.GetPins( tempPins, GetUnit(), GetConvert() );
 
 TRANSFORM transform = GetTransform();
 
 // Copy the pin info from the symbol to the temp pins
 for( unsigned i = 0; i < tempPins.size(); ++ i )
 {
 SCH_PIN* symbolPin = GetPin( libPins[ i ] );
 LIB_PIN* tempPin = tempPins[ i ];
 
 tempPin->SetName( symbolPin->GetShownName() );
 tempPin->SetType( symbolPin->GetType() );
 tempPin->SetShape( symbolPin->GetShape() );
 tempPin->Plot( aPlotter, false, m_pos, transform, GetDNP() );
 }
 }
}

References GetConvert(), GetDNP(), GetPin(), LIB_SYMBOL::GetPins(), SCH_PIN::GetShape(), SCH_PIN::GetShownName(), GetTransform(), SCH_PIN::GetType(), GetUnit(), m_part, m_pos, LIB_PIN::Plot(), LIB_PIN::SetName(), LIB_PIN::SetShape(), and LIB_PIN::SetType().

◆ Print()

void SCH_SYMBOL::Print	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset
	)

overridevirtual

Print a symbol.

Parameters

aSettings	Render settings controlling output
aOffset	is the drawing offset (usually VECTOR2I(0,0), but can be different when moving an object)

Implements SCH_ITEM.

Definition at line 466 of file sch_symbol.cpp.

{
 LIB_SYMBOL_OPTIONS opts;
 opts.transform = m_transform;
 opts.draw_visible_fields = false;
 opts.draw_hidden_fields = false;
 
 if( m_part )
 {
 m_part->Print( aSettings, m_pos + aOffset, m_unit, m_convert, opts, GetDNP() );
 }
 else // Use dummy() part if the actual cannot be found.
 {
 dummy()->Print( aSettings, m_pos + aOffset, 0, 0, opts, GetDNP() );
 }
 
 for( SCH_FIELD& field : m_fields )
 field.Print( aSettings, aOffset );
}

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

◆ PrintBackground()

void SCH_SYMBOL::PrintBackground	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset
	)

overridevirtual

Print only the background parts of a symbol (if any)

Parameters

aSettings	Render settings controlling output
aOffset	is the drawing offset (usually VECTOR2I(0,0), but can be different when moving an object)

Reimplemented from SCH_ITEM.

Definition at line 454 of file sch_symbol.cpp.

{
 LIB_SYMBOL_OPTIONS opts;
 opts.transform = m_transform;
 opts.draw_visible_fields = false;
 opts.draw_hidden_fields = false;
 
 if( m_part )
 m_part->PrintBackground( aSettings, m_pos + aOffset, m_unit, m_convert, opts, GetDNP() );
}

References LIB_SYMBOL_OPTIONS::draw_hidden_fields, LIB_SYMBOL_OPTIONS::draw_visible_fields, GetDNP(), m_convert, m_part, m_pos, m_transform, m_unit, and LIB_SYMBOL_OPTIONS::transform.

◆ RemoveField()

void SCH_SYMBOL::RemoveField ( const wxString & aFieldName )

Remove a user field from the symbol.

Parameters

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

Definition at line 947 of file sch_symbol.cpp.

{
 for( unsigned i = MANDATORY_FIELDS; i < m_fields.size(); ++i )
 {
 if( aFieldName == m_fields[i].GetName( false ) )
 {
 m_fields.erase( m_fields.begin() + i );
 return;
 }
 }
}

References m_fields, and MANDATORY_FIELDS.

Referenced by DIALOG_CHANGE_SYMBOLS::processSymbol().

◆ RemoveInstance()

void SCH_SYMBOL::RemoveInstance ( const SCH_SHEET_PATH & aInstancePath )

Definition at line 503 of file sch_symbol.cpp.

{
 // Search for an existing path and remove it if found (should not occur)
 for( unsigned ii = 0; ii < m_instanceReferences.size(); ii++ )
 {
 if( m_instanceReferences[ii].m_Path == aInstancePath.Path() )
 {
 wxLogTrace( traceSchSheetPaths, "Removing symbol instance:\n"
 " sheet path %s\n"
 " reference %s, unit %d from symbol %s.",
 aInstancePath.Path().AsString(),
 m_instanceReferences[ii].m_Reference,
 m_instanceReferences[ii].m_Unit,
 m_Uuid.AsString() );
 
 m_instanceReferences.erase( m_instanceReferences.begin() + ii );
 ii--;
 }
 }
}

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

Referenced by SCH_SHEET_PATH::RemoveSymbolInstances().

◆ RenderAsBitmap()

bool SCH_ITEM::RenderAsBitmap ( double aWorldScale ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 294 of file sch_item.cpp.

{
 if( IsHypertext() )
 return false;
 
 if( const EDA_TEXT* text = dynamic_cast<const EDA_TEXT*>( this ) )
 return text->GetTextHeight() * aWorldScale < BITMAP_FONT_SIZE_THRESHOLD;
 
 return false;
}

References BITMAP_FONT_SIZE_THRESHOLD, SCH_ITEM::IsHypertext(), and text.

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

◆ Replace() [1/2]

virtual bool EDA_ITEM::Replace	(	const EDA_SEARCH_DATA &	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

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxData	A 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 LIB_TEXTBOX, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 409 of file eda_item.h.

 {
 return false;
 }

◆ Replace() [2/2]

bool EDA_ITEM::Replace	(	const EDA_SEARCH_DATA &	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

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aText	A reference to a wxString object containing the text to be replaced.

Returns: True if aText was modified, otherwise false.

Definition at line 168 of file eda_item.cpp.

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 wxString result;
 bool replaced = false;
 
 if( !aSearchData.matchCase )
 {
 text = text.Upper();
 searchText = searchText.Upper();
 }
 
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 {
 result += aText.Mid( ii, wxString::npos );
 break;
 }
 
 if( next > ii )
 result += aText.Mid( ii, next - ii );
 
 ii = next;
 next += searchText.length();
 
 bool startOK;
 bool endOK;
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 }
 else
 {
 startOK = true;
 endOK = true;
 }
 
 if( startOK && endOK )
 {
 result += aSearchData.replaceString;
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }
 
 aText = result;
 return replaced;
}

References EDA_SEARCH_DATA::findString, EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::replaceString, text, and WHOLEWORD.

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

◆ ReplaceInstanceSheetPath()

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

Replace aOldSheetPath with aNewSheetPath in the instance list.

Parameters

aOldSheetPath	is a KIID_PATH object of an existing path in the instance list.
aNewSheetPath	is 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 1353 of file sch_symbol.cpp.

{
 auto it = std::find_if( m_instanceReferences.begin(), m_instanceReferences.end(),
 [ aOldSheetPath ]( SYMBOL_INSTANCE_REFERENCE& r )->bool
 {
 return aOldSheetPath == r.m_Path;
 }
 );
 
 if( it != m_instanceReferences.end() )
 {
 wxLogTrace( traceSchSheetPaths,
 "Replacing sheet path %s\n with sheet path %s\n for symbol %s.",
 aOldSheetPath.AsString(), aNewSheetPath.AsString(), m_Uuid.AsString() );
 
 it->m_Path = aNewSheetPath;
 return true;
 }
 
 wxLogTrace( traceSchSheetPaths,
 "Could not find sheet path %s\n to replace with sheet path %s\n for symbol %s.",
 aOldSheetPath.AsString(), aNewSheetPath.AsString(), m_Uuid.AsString() );
 
 return false;
}

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

aDepth a counter to limit recursion and circular references.

Definition at line 1172 of file sch_symbol.cpp.

{
 SCHEMATIC* schematic = Schematic();
 
 // SCH_SYMOL object has no context outside a schematic.
 if( !schematic )
 return false;
 
 for( int i = 0; i < MANDATORY_FIELDS; ++i )
 {
 if( token->IsSameAs( m_fields[ i ].GetCanonicalName().Upper() ) )
 {
 if( i == REFERENCE_FIELD )
 *token = GetRef( &schematic->CurrentSheet(), true );
 else if( i == VALUE_FIELD )
 *token = GetValue( &schematic->CurrentSheet(), true );
 else if( i == FOOTPRINT_FIELD )
 *token = GetFootprint( &schematic->CurrentSheet(), true );
 else
 *token = m_fields[ i ].GetShownText( aDepth + 1 );
 
 return true;
 }
 }
 
 for( size_t i = MANDATORY_FIELDS; i < m_fields.size(); ++i )
 {
 if( token->IsSameAs( m_fields[ i ].GetName() )
 || token->IsSameAs( m_fields[ i ].GetName().Upper() ) )
 {
 *token = m_fields[ i ].GetShownText( aDepth + 1 );
 return true;
 }
 }
 
 for( const TEMPLATE_FIELDNAME& templateFieldname :
 schematic->Settings().m_TemplateFieldNames.GetTemplateFieldNames() )
 {
 if( token->IsSameAs( templateFieldname.m_Name )
 || token->IsSameAs( templateFieldname.m_Name.Upper() ) )
 {
 // If we didn't find it in the fields list then it isn't set on this symbol.
 // Just return an empty string.
 *token = wxEmptyString;
 return true;
 }
 }
 
 if( token->IsSameAs( wxT( "FOOTPRINT_LIBRARY" ) ) )
 {
 wxString footprint;
 
 footprint = GetFootprint( &schematic->CurrentSheet(), true );
 
 wxArrayString parts = wxSplit( footprint, ':' );
 
 *token = parts[ 0 ];
 return true;
 }
 else if( token->IsSameAs( wxT( "FOOTPRINT_NAME" ) ) )
 {
 wxString footprint;
 
 footprint = GetFootprint( &schematic->CurrentSheet(), true );
 
 wxArrayString parts = wxSplit( footprint, ':' );
 
 *token = parts[ std::min( 1, (int) parts.size() - 1 ) ];
 return true;
 }
 else if( token->IsSameAs( wxT( "UNIT" ) ) )
 {
 int unit;
 
 unit = GetUnitSelection( &schematic->CurrentSheet() );
 
 *token = LIB_SYMBOL::SubReference( unit );
 return true;
 }
 else if( token->IsSameAs( wxT( "SYMBOL_LIBRARY" ) ) )
 {
 *token = m_lib_id.GetLibNickname();
 return true;
 }
 else if( token->IsSameAs( wxT( "SYMBOL_NAME" ) ) )
 {
 *token = m_lib_id.GetLibItemName();
 return true;
 }
 else if( token->IsSameAs( wxT( "SYMBOL_DESCRIPTION" ) ) )
 {
 *token = GetDescription();
 return true;
 }
 else if( token->IsSameAs( wxT( "SYMBOL_KEYWORDS" ) ) )
 {
 *token = GetKeyWords();
 return true;
 }
 else if( token->IsSameAs( wxT( "EXCLUDE_FROM_BOM" ) ) )
 {
 *token = this->GetIncludeInBom() ? wxT( "" ) : _( "Excluded from BOM" );
 return true;
 }
 else if( token->IsSameAs( wxT( "EXCLUDE_FROM_BOARD" ) ) )
 {
 *token = this->GetIncludeOnBoard() ? wxT( "" ) : _( "Excluded from board" );
 return true;
 }
 else if( token->IsSameAs( wxT( "DNP" ) ) )
 {
 *token = this->GetDNP() ? wxT( "" ) : _( "DNP" );
 return true;
 }
 
 return false;
}

References _, SCHEMATIC::CurrentSheet(), FOOTPRINT_FIELD, GetDescription(), GetDNP(), GetFootprint(), GetIncludeInBom(), GetIncludeOnBoard(), GetKeyWords(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), GetRef(), TEMPLATES::GetTemplateFieldNames(), GetUnitSelection(), GetValue(), m_fields, m_lib_id, 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 VECTOR2I & aCenter )

overridevirtual

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

Implements SCH_ITEM.

Definition at line 1761 of file sch_symbol.cpp.

{
 VECTOR2I prev = m_pos;
 
 RotatePoint( m_pos, aCenter, ANGLE_90 );
 
 SetOrientation( SYM_ROTATE_COUNTERCLOCKWISE );
 
 for( SCH_FIELD& field : m_fields )
 {
 // Move the fields to the new position because the symbol itself has moved.
 VECTOR2I pos = field.GetTextPos();
 pos.x -= prev.x - m_pos.x;
 pos.y -= prev.y - m_pos.y;
 field.SetTextPos( pos );
 }
}

References ANGLE_90, m_fields, m_pos, RotatePoint(), SetOrientation(), SYM_ROTATE_COUNTERCLOCKWISE, VECTOR2< T >::x, and VECTOR2< T >::y.

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 1043 of file sch_symbol.cpp.

{
 for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
 aFunction( pin.get() );
 
 for( SCH_FIELD& field : m_fields )
 aFunction( &field );
}

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 112 of file sch_item.cpp.

{
 EDA_ITEM* parent = GetParent();
 
 while( parent )
 {
 if( parent->Type() == SCHEMATIC_T )
 return static_cast<SCHEMATIC*>( parent );
 else
 parent = parent->GetParent();
 }
 
 return nullptr;
}

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

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_SHEET::findSelf(), SCH_MARKER::GetColorLayer(), SCH_ITEM::GetEffectiveNetClass(), SCH_JUNCTION::getEffectiveShape(), SCH_LABEL_BASE::GetIntersheetRefs(), SCH_LABEL_BASE::GetLabelBoxExpansion(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_NO_CONNECT::GetPenWidth(), SCH_SHAPE::GetPenWidth(), SCH_SHEET::GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), GetPins(), SCH_MARKER::GetSeverity(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_PIN::HitTest(), SCH_SHEET::IsRootSheet(), SCH_LABEL_BASE::IsType(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), DIALOG_TEXT_PROPERTIES::onScintillaCharAdded(), SCH_LABEL_BASE::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), ResolveTextVar(), SetFootprint(), SetRef(), SetValue(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), and SCH_MARKER::ViewGetLayers().

◆ Set() [1/3]

template<typename T >

bool INSPECTABLE::Set	(	const wxString &	aProperty,
		T	aValue
	)

inlineinherited

Definition at line 66 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 void* object = nullptr;
 
 if( prop )
 {
 object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
 if( object )
 prop->set<T>( object, aValue );
 }
 
 return object != nullptr;
 }

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

◆ Set() [2/3]

template<typename T >

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		T	aValue
	)

inlineinherited

Definition at line 54 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( object )
 aProperty->set<T>( object, aValue );
 
 return object != nullptr;
 }

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( object )
 aProperty->setter( object, aValue );
 
 return object != nullptr;
 }

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

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

119{ SetFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool aDirty = true )

inlineinherited

Definition at line 415 of file sch_item.h.

415{ m_connectivity_dirty = aDirty; }

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::BreakSegment(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_ITEM::GetOrInitConnection(), SCH_ITEM::InitializeConnection(), SCH_LINE::MergeOverlap(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ SetConvert()

void SCH_SYMBOL::SetConvert ( int aConvert )

Definition at line 406 of file sch_symbol.cpp.

{
 if( m_convert != aConvert )
 {
 m_convert = aConvert;
 
 // The convert may have a different pin layout so the update the pin map.
 UpdatePins();
 SetModified();
 }
}

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

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

◆ SetDefaultInstance()

void SCH_SYMBOL::SetDefaultInstance ( const SYMBOL_INSTANCE_REFERENCE & aInstance )

inline

Definition at line 147 of file sch_symbol.h.

 {
 m_defaultInstance = aInstance;
 }

References m_defaultInstance.

Referenced by SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SCREEN::SetAllSymbolDefaultInstances(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetDNP()

void SCH_SYMBOL::SetDNP ( bool aDNP )

inline

Definition at line 758 of file sch_symbol.h.

758{ m_DNP = aDNP; }

References m_DNP.

Referenced by DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetFields()

void SCH_SYMBOL::SetFields ( const SCH_FIELDS & aFields )

inline

Set multiple schematic fields.

Parameters

aFields are the fields to set in this symbol.

Definition at line 455 of file sch_symbol.h.

 {
 m_fields = aFields; // vector copying, length is changed possibly
 }

References m_fields.

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )

inlineinherited

Definition at line 426 of file sch_item.h.

426{ m_fieldsAutoplaced = FIELDS_AUTOPLACED_AUTO; }

References FIELDS_AUTOPLACED_AUTO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_SEXPR_PARSER::parseSchText().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 142 of file eda_item.h.

142{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

◆ SetFootprint() [1/2]

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

Definition at line 854 of file sch_symbol.cpp.

{
 if( sheet == nullptr )
 {
 // Set all instances to new footprint value
 for( SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
 instance.m_Footprint = aFootprint;
 
 m_fields[ FOOTPRINT_FIELD ].SetText( aFootprint );
 return;
 }
 
 KIID_PATH path = sheet->Path();
 bool found = false;
 
 // check to see if it is already there before inserting it
 for( SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
 {
 if( instance.m_Path == path )
 {
 found = true;
 instance.m_Footprint = aFootprint;
 break;
 }
 }
 
 // didn't find it; better add it
 if( !found )
 {
 AddHierarchicalReference( path, UTIL::GetRefDesUnannotated( m_prefix ), m_unit,
 wxEmptyString, aFootprint );
 }
 
 if( Schematic() && *sheet == Schematic()->CurrentSheet() )
 m_fields[ FOOTPRINT_FIELD ].SetText( aFootprint );
}

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

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_EDIT_FRAME::PutDataInPreviousState(), 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 635 of file sch_symbol.h.

 {
 SetFootprint( nullptr, aFootprint );
 }

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

aEnable True 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 201 of file eda_item.h.

201{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetIncludeInBom()

void SCH_SYMBOL::SetIncludeInBom ( bool aIncludeInBom )

inline

Definition at line 752 of file sch_symbol.h.

752{ m_inBom = aIncludeInBom; }

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 755 of file sch_symbol.h.

755{ m_onBoard = aIncludeOnBoard; }

References m_onBoard.

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

◆ SetInstanceToDefault()

void SCH_SYMBOL::SetInstanceToDefault ( const SCH_SHEET_PATH & aInstance )

Definition at line 2260 of file sch_symbol.cpp.

{
 KIID_PATH path = aInstance.Path();
 
 for( SYMBOL_INSTANCE_REFERENCE& instance: m_instanceReferences )
 {
 if( instance.m_Path == path )
 {
 instance.m_Reference = m_defaultInstance.m_Reference;
 instance.m_Unit = m_defaultInstance.m_Unit;
 instance.m_Value = m_defaultInstance.m_Value;
 instance.m_Footprint = m_defaultInstance.m_Footprint;
 return;
 }
 }
 
 // It's a new instance so add it.
 AddHierarchicalReference( path, m_defaultInstance.m_Reference, m_defaultInstance.m_Unit,
 m_defaultInstance.m_Value, m_defaultInstance.m_Footprint );
}

References AddHierarchicalReference(), m_defaultInstance, SYMBOL_INSTANCE_REFERENCE::m_Footprint, m_instanceReferences, SYMBOL_INSTANCE_REFERENCE::m_Reference, SYMBOL_INSTANCE_REFERENCE::m_Unit, SYMBOL_INSTANCE_REFERENCE::m_Value, SCH_SHEET_PATH::Path(), and path.

Referenced by SCH_SHEET_PATH::SetSymbolInstancesToDefault().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 167 of file eda_item.h.

 {
 if( aBitmap )
 SetFlags( IS_SHOWN_AS_BITMAP );
 else
 ClearFlags( IS_SHOWN_AS_BITMAP );
 }

References EDA_ITEM::ClearFlags(), IS_SHOWN_AS_BITMAP, and EDA_ITEM::SetFlags().

◆ SetLastResolvedState()

virtual void SCH_ITEM::SetLastResolvedState ( const SCH_ITEM * aItem )

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, and SCH_LINE.

Definition at line 417 of file sch_item.h.

417{ }

Referenced by SCH_EDITOR_CONTROL::Paste().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID aLayer )

inlineinherited

Set the layer this item is on.

Parameters

aLayer The layer number.

Definition at line 253 of file sch_item.h.

253{ m_layer = aLayer; }

References SCH_ITEM::m_layer.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadGraphicStaightSegment(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_NO_CONNECT::SCH_NO_CONNECT(), SCH_SHAPE::SCH_SHAPE(), and SCH_FIELD::SetId().

◆ SetLibId()

void SCH_SYMBOL::SetLibId ( const LIB_ID & aName )

Definition at line 286 of file sch_symbol.cpp.

{
 if( m_lib_id != aLibId )
 {
 m_lib_id = aLibId;
 SetModified();
 }
}

References m_lib_id, and EDA_ITEM::SetModified().

Referenced by SCH_SCREENS::ChangeSymbolLibNickname(), 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

aLibSymbol is the library symbol to associate with this schematic symbol.

Definition at line 305 of file sch_symbol.cpp.

{
 wxCHECK2( ( aLibSymbol == nullptr ) || ( aLibSymbol->IsRoot() ), aLibSymbol = nullptr );
 
 m_part.reset( aLibSymbol );
 UpdatePins();
}

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 234 of file sch_item.h.

234{}

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 64 of file eda_item.cpp.

{
 SetFlags( IS_CHANGED );
 
 // If this a child object, then the parent modification state also needs to be set.
 if( m_parent )
 m_parent->SetModified();
}

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(), PCB_PARSER::parseZONE(), 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

aOrientation is the orientation to apply to the transform.

Definition at line 1381 of file sch_symbol.cpp.

{
 TRANSFORM temp = TRANSFORM();
 bool transform = false;
 
 switch( aOrientation )
 {
 case SYM_ORIENT_0:
 case SYM_NORMAL: // default transform matrix
 m_transform.x1 = 1;
 m_transform.y2 = -1;
 m_transform.x2 = m_transform.y1 = 0;
 break;
 
 case SYM_ROTATE_COUNTERCLOCKWISE: // Rotate + (incremental rotation)
 temp.x1 = temp.y2 = 0;
 temp.y1 = 1;
 temp.x2 = -1;
 transform = true;
 break;
 
 case SYM_ROTATE_CLOCKWISE: // Rotate - (incremental rotation)
 temp.x1 = temp.y2 = 0;
 temp.y1 = -1;
 temp.x2 = 1;
 transform = true;
 break;
 
 case SYM_MIRROR_Y: // Mirror Y (incremental rotation)
 temp.x1 = -1;
 temp.y2 = 1;
 temp.y1 = temp.x2 = 0;
 transform = true;
 break;
 
 case SYM_MIRROR_X: // Mirror X (incremental rotation)
 temp.x1 = 1;
 temp.y2 = -1;
 temp.y1 = temp.x2 = 0;
 transform = true;
 break;
 
 case SYM_ORIENT_90:
 SetOrientation( SYM_ORIENT_0 );
 SetOrientation( SYM_ROTATE_COUNTERCLOCKWISE );
 break;
 
 case SYM_ORIENT_180:
 SetOrientation( SYM_ORIENT_0 );
 SetOrientation( SYM_ROTATE_COUNTERCLOCKWISE );
 SetOrientation( SYM_ROTATE_COUNTERCLOCKWISE );
 break;
 
 case SYM_ORIENT_270:
 SetOrientation( SYM_ORIENT_0 );
 SetOrientation( SYM_ROTATE_CLOCKWISE );
 break;
 
 case ( SYM_ORIENT_0 + SYM_MIRROR_X ):
 SetOrientation( SYM_ORIENT_0 );
 SetOrientation( SYM_MIRROR_X );
 break;
 
 case ( SYM_ORIENT_0 + SYM_MIRROR_Y ):
 SetOrientation( SYM_ORIENT_0 );
 SetOrientation( SYM_MIRROR_Y );
 break;
 
 case ( SYM_ORIENT_90 + SYM_MIRROR_X ):
 SetOrientation( SYM_ORIENT_90 );
 SetOrientation( SYM_MIRROR_X );
 break;
 
 case ( SYM_ORIENT_90 + SYM_MIRROR_Y ):
 SetOrientation( SYM_ORIENT_90 );
 SetOrientation( SYM_MIRROR_Y );
 break;
 
 case ( SYM_ORIENT_180 + SYM_MIRROR_X ):
 SetOrientation( SYM_ORIENT_180 );
 SetOrientation( SYM_MIRROR_X );
 break;
 
 case ( SYM_ORIENT_180 + SYM_MIRROR_Y ):
 SetOrientation( SYM_ORIENT_180 );
 SetOrientation( SYM_MIRROR_Y );
 break;
 
 case ( SYM_ORIENT_270 + SYM_MIRROR_X ):
 SetOrientation( SYM_ORIENT_270 );
 SetOrientation( SYM_MIRROR_X );
 break;
 
 case ( SYM_ORIENT_270 + SYM_MIRROR_Y ):
 SetOrientation( SYM_ORIENT_270 );
 SetOrientation( SYM_MIRROR_Y );
 break;
 
 default:
 transform = false;
 wxFAIL_MSG( "Invalid schematic symbol orientation type." );
 break;
 }
 
 if( transform )
 {
 /* The new matrix transform is the old matrix transform modified by the
 * requested transformation, which is the temp transform (rot,
 * mirror ..) in order to have (in term of matrix transform):
 * transform coord = new_m_transform * coord
 * where transform coord is the coord modified by new_m_transform from
 * the initial value coord.
 * new_m_transform is computed (from old_m_transform and temp) to
 * have:
 * transform coord = old_m_transform * temp
 */
 TRANSFORM newTransform;
 
 newTransform.x1 = m_transform.x1 * temp.x1 + m_transform.x2 * temp.y1;
 newTransform.y1 = m_transform.y1 * temp.x1 + m_transform.y2 * temp.y1;
 newTransform.x2 = m_transform.x1 * temp.x2 + m_transform.x2 * temp.y2;
 newTransform.y2 = m_transform.y1 * temp.x2 + m_transform.y2 * temp.y2;
 m_transform = newTransform;
 }
}

References m_transform, SetOrientation(), 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(), SetOrientation(), SCH_EDIT_TOOL::Swap(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and PCB_DIMENSION_BASE.

Definition at line 100 of file eda_item.h.

100{ m_parent = aParent; }

References EDA_ITEM::m_parent.

◆ SetPosition()

void SCH_SYMBOL::SetPosition ( const VECTOR2I & aPosition )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 725 of file sch_symbol.h.

725{ Move( aPosition - m_pos ); }

SCH_SYMBOL::Move

void Move(const VECTOR2I &aMoveVector) override

Move the item by aMoveVector to a new position.

Definition: sch_symbol.h:642

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 279 of file sch_symbol.h.

279{ m_prefix = aPrefix; }

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

aSheet	is the hierarchical path of the reference.
aReference	is the new reference for the symbol.

Definition at line 674 of file sch_symbol.cpp.

{
 KIID_PATH path = sheet->Path();
 bool found = false;
 
 // check to see if it is already there before inserting it
 for( SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
 {
 if( instance.m_Path == path )
 {
 found = true;
 instance.m_Reference = ref;
 break;
 }
 }
 
 if( !found )
 AddHierarchicalReference( path, ref, m_unit, GetField( VALUE_FIELD )->GetText(),
 GetField( FOOTPRINT_FIELD )->GetText() );
 
 for( std::unique_ptr<SCH_PIN>& pin : m_pins )
 pin->ClearDefaultNetName( sheet );
 
 if( Schematic() && *sheet == Schematic()->CurrentSheet() )
 m_fields[ REFERENCE_FIELD ].SetText( ref );
 
 // Reinit the m_prefix member if needed
 m_prefix = UTIL::GetRefDesPrefix( ref );
 
 if( m_prefix.IsEmpty() )
 m_prefix = wxT( "U" );
 
 // Power symbols have references starting with # and are not included in netlists
 m_isInNetlist = ! ref.StartsWith( wxT( "#" ) );
}

References AddHierarchicalReference(), FOOTPRINT_FIELD, GetField(), UTIL::GetRefDesPrefix(), EDA_UNIT_UTILS::GetText(), m_fields, m_instanceReferences, m_isInNetlist, m_pins, m_prefix, m_unit, SCH_SHEET_PATH::Path(), path, pin, REFERENCE_FIELD, SCH_ITEM::Schematic(), and VALUE_FIELD.

Referenced by SCH_REFERENCE::Annotate(), BACK_ANNOTATE::applyChangelist(), GetRef(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_FIELD::Replace(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SYMBOL(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), UpdateFields(), and SCH_EDITOR_CONTROL::updatePastedSymbol().

◆ SetSchSymbolLibraryName()

void SCH_SYMBOL::SetSchSymbolLibraryName ( const wxString & aName )

inline

The name of the symbol in the schematic library symbol list.

Note: See SCH_SCREEN::m_libSymbols

The name of the schematic symbol list entry can vary from the item name in the LIB_ID object because the library symbol may have changed so a new name has to be generated but the original symbol library link has to be preserved in order to update it from the library at some point in the future. If this name is empty, then the library item name from LIB_ID is used.

Definition at line 191 of file sch_symbol.h.

191{ m_schLibSymbolName = aName; }

References m_schLibSymbolName.

Referenced by SCH_SCREEN::Append(), and DIALOG_CHANGE_SYMBOLS::processSymbol().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

118{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), SCH_LINE::MergeOverlap(), DS_PROXY_UNDO_ITEM::Restore(), EE_TOOL_BASE< T >::saveCopyInUndoList(), and GERBVIEW_SELECTION_TOOL::selectVisually().

◆ SetState()

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

inlineinherited

Definition at line 131 of file eda_item.h.

 {
 if( state )
 m_status |= type; // state = ON or OFF
 else
 m_status &= ~type;
 }

References EDA_ITEM::m_status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 140 of file eda_item.h.

140{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( const VECTOR2I & aPos )

inlineinherited

Definition at line 210 of file sch_item.h.

210{ m_storedPos = aPos; }

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::Main().

◆ SetStroke()

virtual void SCH_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 459 of file sch_item.h.

459{ wxCHECK( false, /* void */ ); }

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ SetTransform()

void SCH_SYMBOL::SetTransform ( const TRANSFORM & aTransform )

Definition at line 419 of file sch_symbol.cpp.

{
 if( m_transform != aTransform )
 {
 m_transform = aTransform;
 SetModified();
 }
}

References m_transform, and EDA_ITEM::SetModified().

◆ SetUnit()

void SCH_SYMBOL::SetUnit ( int aUnit )

Change the unit number to aUnit.

This has meaning only for symbols made up of multiple units per package.

Note: This also set the modified flag bit

Parameters

aUnit is the new unit to select.

Definition at line 390 of file sch_symbol.cpp.

{
 if( m_unit != aUnit )
 {
 UpdateUnit( aUnit );
 

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCH_SYMBOL() [1/4]

◆ SCH_SYMBOL() [2/4]

◆ SCH_SYMBOL() [3/4]

◆ SCH_SYMBOL() [4/4]

◆ ~SCH_SYMBOL()

Member Function Documentation

◆ AddConnectionTo()

◆ AddField()

◆ AddHierarchicalReference() [1/2]

◆ AddHierarchicalReference() [2/2]

◆ AddSheetPathReferenceEntryIfMissing()

◆ AutoAutoplaceFields()

◆ AutoplaceFields()

◆ CanConnect()

◆ ClassOf()

◆ ClearAnnotation()

◆ ClearBrightened()

◆ ClearBrightenedPins()

◆ ClearCaches()

◆ ClearConnections()

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ ConnectedItems()

◆ Connection()

◆ ConnectionPropagatesTo()

◆ doGetBoundingBox()

◆ DoHypertextAction()

◆ doIsConnected()

◆ Duplicate()

◆ FindField()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAllPins()

◆ GetBodyAndPinsBoundingBox()

◆ GetBodyBoundingBox()

◆ GetBoundingBox()

◆ GetClass()

◆ GetConnectionPoints()

◆ GetContextualTextVars()

◆ GetConvert()

◆ GetDatasheet()

◆ GetDefaultFont()

◆ GetDefaultInstance()

◆ GetDescription()

◆ GetDNP()

◆ GetDrawItem()

◆ GetEditFlags()

◆ GetEffectiveNetClass()

◆ GetEndPoints()

◆ GetField() [1/2]

◆ GetField() [2/2]

◆ GetFieldById()

◆ GetFieldCount()

◆ GetFields() [1/3]

◆ GetFields() [2/3]

◆ GetFields() [3/3]

◆ GetFieldsAutoplaced()

◆ GetFieldText()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFootprint()

◆ GetIncludeInBom()

◆ GetIncludeOnBoard()

◆ GetInstance()

◆ GetInstanceReferences()