Schematic symbol object. More...

#include <sch_symbol.h>

Inheritance diagram for SCH_SYMBOL:

Public Types
enum class	PASSTHROUGH_MODE { DEFAULT , BLOCK , FORCE }

enum	COMPARE_FLAGS : int { UNIT = 1 << 0 , POSITION = 1 << 1 , UUID = 1 << 2 , MISSING_FIELDS = 1 << 3 , EXTRA_FIELDS = 1 << 4 , FIELD_TEXT = 1 << 5 , FIELD_VISIBILITY = 1 << 6 , FIELD_SIZE_AND_STYLE = 1 << 7 , FIELD_POSITIONS = 1 << 8 , PIN_VISIBILITIES = 1 << 9 , PIN_ALT_DEFS = 1 << 10 , EXCLUDE_FROM_SIM = 1 << 11 , EXCLUDE_FROM_BOARD = 1 << 12 , DNP = 1 << 13 , EXCLUDE_FROM_BOM = 1 << 15 , EXCLUDE_FROM_POS_FILES = 1 << 16 , IDENTITY = 1 << 17 }
	The list of flags used by various compare functions. More...

Public Member Functions
	SCH_SYMBOL ()

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

	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.

	~SCH_SYMBOL ()

wxString	GetClass () const override
	Return the class name.

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

const std::vector< SCH_SYMBOL_INSTANCE > &	GetInstances () const

bool	GetInstance (SCH_SYMBOL_INSTANCE &aInstance, const KIID_PATH &aSheetPath, bool aTestFromEnd=false) const

void	RemoveInstance (const SCH_SHEET_PATH &aInstancePath)

void	RemoveInstance (const KIID_PATH &aInstancePath)

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.

void	SetLibId (const LIB_ID &aName)

const LIB_ID &	GetLibId () const override

wxString	GetSymbolIDAsString () const

void	SetSchSymbolLibraryName (const wxString &aName)
	The name of the symbol in the schematic library symbol list.

wxString	GetSchSymbolLibraryName () const

bool	UseLibIdLookup () const

std::unique_ptr< LIB_SYMBOL > &	GetLibSymbolRef ()

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

bool	HasEffectiveAssociatedFootprint () const

void	SetLibSymbol (LIB_SYMBOL *aLibSymbol)
	Set this schematic symbol library symbol reference to aLibSymbol.

wxString	GetDescription () const override

wxString	GetShownDescription (RESOLUTION_CONTEXT aContext, int aDepth=0) const override

wxString	GetKeyWords () const override

wxString	GetShownKeyWords (RESOLUTION_CONTEXT aContext, int aDepth=0) const override

wxString	GetDatasheet () const
	Return the documentation text for the given part alias.

void	UpdatePins ()
	Updates the cache of SCH_PIN objects for each pin.

wxString	GetUnitDisplayName (int aUnit, bool aLabel) const override
	Return the display name for a given unit aUnit.

wxString	GetBodyStyleDescription (int aBodyStyle, bool aLabel) const override

void	SetBodyStyle (int aBodyStyle) override

wxString	GetPrefix () const

void	SetPrefix (const wxString &aPrefix)

void	UpdatePrefix ()
	Set the prefix based on the current reference designator.

wxString	SubReference (int aUnit, bool aAddSeparator=true) const

int	GetUnitCount () const override
	Return the number of units per package of the symbol.

bool	IsMultiUnit () const override

int	GetBodyStyleCount () const override
	Return the number of body styles of the symbol.

bool	IsMultiBodyStyle () const override

bool	HasDeMorganBodyStyles () const override

void	SetOrientation (int aOrientation)
	Compute the new transform matrix based on aOrientation for the symbol which is applied to the current transform.

int	GetOrientation () const override
	Get the display symbol orientation.

void	SetOrientationProp (SYMBOL_ORIENTATION_PROP aAngle)
	Orientation/mirroring access for property manager.

SYMBOL_ORIENTATION_PROP	GetOrientationProp () const

void	SetMirrorX (bool aMirror)

bool	GetMirrorX () const

void	SetMirrorY (bool aMirror)

bool	GetMirrorY () const

void	GetContextualTextVars (wxArrayString *aVars) const
	Return the list of system text vars & fields for this symbol.

bool	ResolveTextVar (const SCH_SHEET_PATH aPath, wxString token, int aDepth=0) const
	Resolve any references to system tokens supported by the symbol.

bool	ResolveTextVar (const SCH_SHEET_PATH aPath, wxString token, const wxString &aVariantName, int aDepth=0) const
	Resolve any references to system tokens supported by the symbol with variant support.

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.

void	ClearAnnotation (const SCH_SHEET_PATH *aSheetPath, bool aResetPrefix)
	Clear exiting symbol annotation.

bool	AddSheetPathReferenceEntryIfMissing (const KIID_PATH &aSheetPath)
	Add an instance to the alternate references list (m_instances), if this entry does not already exist.

bool	SetInstanceProjectName (const KIID_PATH &aSheetPath, const wxString &aProjectName)
	Set the owning project of the instance stored for aSheetPath.

const BOX2I	GetBoundingBox () const override
	Return the orthogonal bounding box of this object for display purposes.

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

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

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

const SCH_FIELD *	GetField (FIELD_T aFieldNdx) const

SCH_FIELD *	GetField (const wxString &aFieldName)
	Return a field in this symbol.

const SCH_FIELD *	GetField (const wxString &aFieldName) const

void	GetFields (std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly) const override
	Populate a std::vector with SCH_FIELDs, sorted in ordinal order.

std::vector< SCH_FIELD > &	GetFields ()
	Return a reference to the vector holding the symbol's fields.

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

std::vector< PROPERTY_BASE * >	GetDynamicProperties () const override
	Return dynamically-computed properties specific to this object instance (e.g.

std::vector< PROPERTY_BASE * >	GetDynamicProperties (const SCH_SHEET_PATH *aPath) const

SCH_FIELD *	AddField (const SCH_FIELD &aField)
	Add a field to the symbol.

void	RemoveField (const wxString &aFieldName)
	Remove a user field from the symbol.

void	RemoveField (SCH_FIELD *aField)

SCH_FIELD *	FindFieldCaseInsensitive (const wxString &aFieldName)
	Search for a SCH_FIELD with aFieldName.

const SCH_FIELD *	FindFieldCaseInsensitive (const wxString &aFieldName) const

const wxString	GetRef (const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override

const wxString	GetValue (const SCH_SHEET_PATH *aPath, RESOLUTION_CONTEXT aContext, const wxString &aVariantName=wxEmptyString) const override

void	SetValueFieldText (const wxString &aValue, const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString)

const wxString	GetFootprintFieldText (const SCH_SHEET_PATH *aPath, RESOLUTION_CONTEXT aContext, const wxString &aVariantName=wxEmptyString) const

void	SetFootprintFieldText (const wxString &aFootprint)

wxString	GetRefProp () const

void	SetRefProp (const wxString &aRef)

wxString	GetValueProp () const

void	SetValueProp (const wxString &aValue)

int	GetUnitProp () const

void	SetFieldText (const wxString &aFieldName, const wxString &aFieldText, const SCH_SHEET_PATH *aPath=nullptr, const wxString &aVariantName=wxEmptyString)

wxString	GetFieldText (const wxString &aFieldName, const SCH_SHEET_PATH *aPath=nullptr, const wxString &aVariantName=wxEmptyString) const

void	SetUnitProp (int aUnit)

wxString	GetBodyStyleProp () const override

void	SetBodyStyleProp (const wxString &aBodyStyle) override

void	UpdateFields (const SCH_SHEET_PATH *aPath, bool aUpdateStyle, bool aUpdateRef, bool aUpdateOtherFields, bool aResetRef, bool aResetOtherFields)
	Restore fields to the original library values.

void	SyncOtherUnits (const SCH_SHEET_PATH &aSourceSheet, SCH_COMMIT &aCommit, PROPERTY_BASE *aProperty, const wxString &aVariantName=wxEmptyString)
	Keep fields other than the reference, include/exclude flags, and alternate pin assignments in sync in multi-unit parts.

int	GetNextFieldOrdinal () const
	Return the next ordinal for a user field for this symbol.

void	AutoplaceFields (SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo) override
	Automatically orient all the fields in the symbol.

void	RunOnChildren (const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode) override

void	ClearCaches () override

SCH_PIN *	GetPin (const wxString &number) const
	Find a symbol pin by number.

SCH_PIN *	GetPinByEffectivePadNumber (const wxString &aPadNumber, const SCH_SHEET_PATH *aSheet, const wxString &aVariantName=wxEmptyString) const
	Find the pin whose effective footprint pad number (issue #2282) is aPadNumber on aSheet, expanding bracketed stacked targets.

std::vector< SCH_PIN * >	GetPinsByNumber (const wxString &aNumber) const
	Find all symbol pins with the given number.

std::vector< SCH_PIN * >	GetLibPins () const
	Populate a vector with all the pins from the library object that match the current unit and bodyStyle.

std::vector< SCH_PIN * >	GetAllLibPins () const

size_t	GetFullPinCount () const

SCH_PIN *	GetPin (SCH_PIN *aLibPin) const

const SCH_PIN *	GetPin (const VECTOR2I &aPosition) const
	Return the SCH_PIN object found at aPosition.

std::vector< const SCH_PIN * >	GetPins (const SCH_SHEET_PATH *aSheet) const
	Retrieve a list of the SCH_PINs for the given sheet path.

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

std::vector< SCH_PIN * >	GetGraphicalPins (int aUnit, int aBodyStyle) const override

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

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

void	SetRef (const SCH_SHEET_PATH *aSheet, const wxString &aReference)
	Set the reference for the given sheet path for this symbol.

bool	IsAnnotated (const SCH_SHEET_PATH *aSheet) const
	Check if the symbol has a valid annotation (reference) for the given sheet path.

void	AddHierarchicalReference (const KIID_PATH &aPath, const wxString &aRef, int aUnit)
	Add a full hierarchical reference to this symbol.

void	AddHierarchicalReference (const SCH_SYMBOL_INSTANCE &aInstance)

int	GetUnitSelection (const SCH_SHEET_PATH *aSheet) const
	Return the instance-specific unit selection for the given sheet path.

void	SetUnitSelection (const SCH_SHEET_PATH *aSheet, int aUnitSelection)
	Set the selected unit of this symbol on one sheet.

void	SetUnitSelection (int aUnitSelection)
	Set the selected unit of this symbol for all sheets.

virtual void	SetDNP (bool aEnable, const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) override

virtual bool	GetDNP (const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const override
	Set or clear the 'Do Not Populate' flag.

bool	GetDNPProp () const

void	SetDNPProp (bool aEnable)

void	SetPinMapOverride (const PIN_MAP_INSTANCE_OVERRIDE &aOverride, const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString)
	Set the per-instance pin-to-pad map override (issue #2282).

PIN_MAP_INSTANCE_OVERRIDE	GetPinMapOverride (const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const

void	SetExcludedFromBOM (bool aEnable, const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) override
	Set or clear the exclude from schematic bill of materials flag.

bool	GetExcludedFromBOM (const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const override

bool	GetExcludedFromBOMProp () const

void	SetExcludedFromBOMProp (bool aEnable)

void	SetExcludedFromSim (bool aEnable, const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) override
	Set or clear the exclude from simulation flag.

bool	GetExcludedFromSim (const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const override

bool	GetExcludedFromSimProp () const

void	SetExcludedFromSimProp (bool aEnable)

void	SetExcludedFromBoard (bool aEnable, const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) override

bool	GetExcludedFromBoard (const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const override

bool	GetExcludedFromBoardProp () const

void	SetExcludedFromBoardProp (bool aEnable)

void	SetExcludedFromPosFiles (bool aEnable, const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) override

bool	GetExcludedFromPosFiles (const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const override

bool	GetExcludedFromPosFilesProp () const

void	SetExcludedFromPosFilesProp (bool aEnable)

EMBEDDED_FILES *	GetEmbeddedFiles () override
	SCH_SYMBOLs don't currently support embedded files, but their LIB_SYMBOL counterparts do.

void	Move (const VECTOR2I &aMoveVector) override
	Move the item by aMoveVector to a new position.

void	MirrorHorizontally (int aCenter) override
	Mirror item horizontally about aCenter.

void	MirrorVertically (int aCenter) override
	Mirror item vertically about aCenter.

void	Rotate (const VECTOR2I &aCenter, bool aRotateCCW) override
	Rotate the item around aCenter 90 degrees in the clockwise direction.

bool	Matches (const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
	Compare the item against the search criteria in aSearchData.

void	GetEndPoints (std::vector< DANGLING_END_ITEM > &aItemList) override
	Add the schematic item end points to aItemList if the item has end points.

bool	UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemListByType, std::vector< DANGLING_END_ITEM > &aItemListByPos, const SCH_SHEET_PATH *aPath=nullptr) override
	Test if the symbol's dangling state has changed for all pins.

VECTOR2I	GetPinPhysicalPosition (const SCH_PIN *Pin) const

bool	IsConnectable () const override

bool	HasConnectivityChanges (const SCH_ITEM aItem, const SCH_SHEET_PATH aInstance=nullptr) const override
	Check if aItem has connectivity changes against this object.

bool	CanConnect (const SCH_ITEM *aItem) const override

bool	DoNetList () const

PASSTHROUGH_MODE	GetPassthroughMode () const

void	SetPassthroughMode (PASSTHROUGH_MODE aMode)

const wxString &	GetNetChainName () const

void	SetNetChainName (wxString aName) noexcept

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

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.

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

wxString	GetItemDescription (UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
	Return a user-visible description string of this item.

BITMAPS	GetMenuImage () const override
	Return a pointer to an image to be used in menus.

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_SYMBOL &aItem)

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

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &aPosition) override

int	GetX () const

void	SetX (int aX)

int	GetY () const

void	SetY (int aY)

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

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

bool	HitTest (const SHAPE_LINE_CHAIN &aPoly, bool aContained) const override
	Test if aPoly intersects this item.

void	Plot (PLOTTER *aPlotter, bool aBackground, const SCH_PLOT_OPTS &aPlotOpts, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aDimmed) override
	Plot the item to aPlotter.

void	PlotPins (PLOTTER *aPlotter, bool aDnp) const
	Plot just the symbol pins.

void	PlotLocalPowerIconShape (PLOTTER *aPlotter) const
	Plot the local power pin indicator icon shape.

void	PlotDNP (PLOTTER *aPlotter) const
	Plot the red 'X' over the symbol.

EDA_ITEM *	Clone () const override
	Create a duplicate of this item with linked list members set to NULL.

void	Serialize (google::protobuf::Any &aContainer) const override
	Serializes this object to the given Any message.

bool	Deserialize (const google::protobuf::Any &aContainer) override
	Deserializes the given protobuf message into this object.

void	Serialize (kiapi::schematic::types::SchematicSymbolInstance &aSymbol) const

bool	Deserialize (const kiapi::schematic::types::SchematicSymbolInstance &aSymbol)

void	ClearBrightenedPins ()

bool	HasBrightenedPins ()

bool	IsPointClickableAnchor (const VECTOR2I &aPos) const override

bool	IsSymbolLikePowerGlobalLabel () const

bool	IsSymbolLikePowerLocalLabel () const

bool	IsGlobalPower () const override

bool	IsLocalPower () const override

bool	IsPower () const override

bool	IsNormal () const override

bool	GetShowPinNames () const override

void	SetShowPinNames (bool aShow) override
	Set or clear the pin name visibility flag.

bool	GetShowPinNumbers () const override

void	SetShowPinNumbers (bool aShow) override
	Set or clear the pin number visibility flag.

double	Similarity (const SCH_ITEM &aOther) const override
	Return a measure of how likely the other object is to represent the same object.

std::unordered_set< wxString >	GetComponentClassNames (const SCH_SHEET_PATH *aPath) const
	Return the component classes this symbol belongs in.

void	DeleteVariant (const KIID_PATH &aPath, const wxString &aVariantName)

void	ClearVariantField (const KIID_PATH &aPath, const wxString &aVariantName, const wxString &aFieldName)

void	RenameVariant (const KIID_PATH &aPath, const wxString &aOldName, const wxString &aNewName)

void	CopyVariant (const KIID_PATH &aPath, const wxString &aSourceVariant, const wxString &aNewVariant)

std::optional< SCH_SYMBOL_VARIANT >	GetVariant (const SCH_SHEET_PATH &aInstance, const wxString &aVariantName) const

void	AddVariant (const SCH_SHEET_PATH &aInstance, const SCH_SYMBOL_VARIANT &aVariant)

void	SetVariantSymbolOverride (const SCH_SHEET_PATH &aPath, const wxString &aVariantName, const LIB_ID &aLibId)
	Set the alternate-symbol override for a given variant and sheet instance.

bool	ClearVariantSymbolOverride (const SCH_SHEET_PATH &aPath, const wxString &aVariantName)
	Remove the alternate-symbol override for a given variant and sheet instance.

LIB_SYMBOL *	GetVariantLibSymbol (const wxString &aVariantName, const SCH_SHEET_PATH &aPath) const
	Resolve the alternate library symbol for a given variant.

const LIB_SYMBOL *	GetEffectiveLibSymbol (const SCH_SHEET_PATH *aPath=nullptr) const
	Return the library symbol to use for rendering and bounding box calculations.

std::vector< SCH_PIN * >	MapLibPins (const std::vector< SCH_PIN * > &aLibPins, bool aByNumber) const
	Map pins of an effective library symbol to this symbol's instance pins.

void	DeleteVariant (const SCH_SHEET_PATH &aInstance, const wxString &aVariantName)

void	RenameVariant (const SCH_SHEET_PATH &aInstance, const wxString &aOldName, const wxString &aNewName)

void	CopyVariant (const SCH_SHEET_PATH &aInstance, const wxString &aSourceVariant, const wxString &aNewVariant)

bool	operator== (const SCH_ITEM &aOther) const override

void	SetPinNameOffset (int aOffset)
	Set the offset in mils of the pin name text from the pin symbol.

int	GetPinNameOffset () const

const TRANSFORM &	GetTransform () const

TRANSFORM &	GetTransform ()

void	SetTransform (const TRANSFORM &aTransform)

void	SetPreviewUnit (int aUnit)

void	SetPreviewBodyStyle (int aBodyStyle)

std::vector< int >	ViewGetLayers () const override
	Return the layers the item is drawn on (which may be more than its "home" layer)

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

bool	IsGroupableType () const

void	SwapItemData (SCH_ITEM *aImage)
	Swap data between aItem and aImage.

void	SwapFlags (SCH_ITEM *aItem)
	Swap the non-temp and non-edit flags.

SCH_ITEM *	Duplicate (bool addToParentGroup, SCH_COMMIT *aCommit=nullptr, bool aDoClone=false) const
	Routine to create a new copy of given item.

virtual void	SetUnit (int aUnit)

int	GetUnit () const

virtual void	SetUnitString (const wxString &aUnit)

virtual wxString	GetUnitString () const

int	GetBodyStyle () const

void	SetPrivate (bool aPrivate)

bool	IsPrivate () const

bool	IsLocked () const override

void	SetLocked (bool aLocked) override

bool	ResolveExcludedFromSim (const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const

bool	ResolveExcludedFromBOM (const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const

bool	ResolveExcludedFromBoard (const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const

bool	ResolveExcludedFromPosFiles (const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const

bool	ResolveDNP (const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const

wxString	ResolveText (const wxString &aText, const SCH_SHEET_PATH *aPath, int aDepth=0) const

wxString	ResolveText (const wxString &aText, const SCH_SHEET_PATH *aPath, int aDepth, const wxString &aVariantName) const

VECTOR2I &	GetStoredPos ()

void	SetStoredPos (const VECTOR2I &aPos)

SCHEMATIC *	Schematic () const
	Search the item hierarchy to find a SCHEMATIC.

SCH_SCREEN *	GetParentScreen () const

const SYMBOL *	GetParentSymbol () const

SYMBOL *	GetParentSymbol ()

virtual bool	HasHypertext () const
	Indicates that the item has at least one hypertext action.

virtual bool	HasHoveredHypertext () const
	Indicates that a hypertext link is currently active.

virtual void	DoHypertextAction (EDA_DRAW_FRAME *aFrame, const VECTOR2I &aMousePos) const

SCH_LAYER_ID	GetLayer () const
	Return the layer this item is on.

void	SetLayer (SCH_LAYER_ID aLayer)

const BOX2I	ViewBBox () const override
	The view bounds of text that shows a net name must match the drawing, so this reads connectivity inside a SCH_CONNECTIVITY::RENDER_SCOPE.

int	GetMaxError () const

virtual int	GetPenWidth () const

int	GetEffectivePenWidth (const SCH_RENDER_SETTINGS *aSettings) const

const wxString &	GetDefaultFont (const KIGFX::RENDER_SETTINGS *aSettings) const

const KIFONT::METRICS &	GetFontMetrics () const

bool	RenderAsBitmap (double aWorldScale) const override

double	SimilarityBase (const SCH_ITEM &aItem) const
	Calculate the boilerplate similarity for all LIB_ITEMs without preventing the use above of a pure virtual function that catches at compile time when a new object has not been fully implemented.

virtual void	BeginEdit (const VECTOR2I &aPosition)
	Begin drawing a symbol library draw item at aPosition.

virtual bool	ContinueEdit (const VECTOR2I &aPosition)
	Continue an edit in progress at aPosition.

virtual void	EndEdit (bool aClosed=false)
	End an object editing action.

virtual void	CalcEdit (const VECTOR2I &aPosition)
	Calculate the attributes of an item at aPosition when it is being edited.

virtual bool	IsEndPoint (const VECTOR2I &aPt) const
	Test if aPt is an end point of this schematic object.

virtual bool	IsDangling () const

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

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

std::optional< wxString >	GetConnectionName (const SCH_SHEET_PATH *aSheet=nullptr, bool aLocal=false, bool aIgnoreSheet=false) const
	Return the active connection name; absent for missing or stale published rows.

bool	HasBusConnection (const SCH_SHEET_PATH *aSheet=nullptr) const

std::vector< wxString >	GetBusMemberNames (const SCH_SHEET_PATH *aSheet=nullptr) const
	Names of the bus members of this item's connection, empty when it does not have a bus.

bool	MatchesNetName (const EDA_SEARCH_DATA &aSearchData, const SCH_SHEET_PATH *aSheet) const
	Match aSearchData against the connection of this item on aSheet.

const std::vector< SCH_ITEM * > &	ConnectedItems (const SCH_SHEET_PATH &aPath) const
	Retrieve the set of items connected to this item on the given sheet.

void	AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
	Add a connection link between this item and another.

void	ClearConnectedItems (const SCH_SHEET_PATH &aPath)
	Clear all connections to this item.

SCH_CONNECTION *	InitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
	Create a new connection object associated with this object.

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.

bool	IsConnectivityDirty () const

void	SetConnectivityDirty (bool aDirty=true)
	Set the dirty flag.

void	SetConnectionGraph (CONNECTION_GRAPH *aGraph)
	Update the connection graph for all connections in this item.

virtual bool	HasCachedDriverName () const

virtual const wxString &	GetCachedDriverName () const

virtual void	SetLastResolvedState (const SCH_ITEM *aItem)

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

AUTOPLACE_ALGO	GetFieldsAutoplaced () const
	Return whether the fields have been automatically placed.

void	SetFieldsAutoplaced (AUTOPLACE_ALGO aAlgo)

virtual bool	HasLineStroke () const
	Check if this schematic item has line stoke properties.

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

void	ClearRuleAreasCache ()
	Reset the cache of rule areas (called prior to schematic connectivity computation)

void	AddRuleAreaToCache (SCH_RULE_AREA *aRuleArea)
	Add a rule area to the item's cache.

void	RemoveRuleAreaFromCache (SCH_RULE_AREA *aRuleArea)
	Remove a specific rule area from the item's cache.

const std::unordered_set< SCH_RULE_AREA * > &	GetRuleAreaCache () const
	Get the cache of rule areas enclosing this item.

const std::vector< wxString > *	GetEmbeddedFonts () override

bool	operator< (const EDA_ITEM &aItem) const
	Test if another item is less than this object.

KICAD_T	Type () const
	Returns the type of object.

EDA_ITEM *	GetParent () const

virtual void	SetParent (EDA_ITEM *aParent)

virtual void	SetParentGroup (EDA_GROUP *aGroup)

virtual EDA_GROUP *	GetParentGroup () const

KIID	GetParentGroupId () const

bool	HasSelectedAncestorGroup () const

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsNetHighlighted () const
	Net highlighting must not clear brightening owned by find or picker tools.

void	SetNetHighlighted (bool aHighlighted)

bool	IsRollover () const

VECTOR2I	GetRolloverPos () const

void	SetIsRollover (bool aIsRollover, const VECTOR2I &aMousePos)

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	XorFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

virtual void	ClearEditFlags ()

EDA_ITEM_FLAGS	GetTempFlags () const

virtual void	ClearTempFlags ()

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.

bool	IsForceVisible () const

const std::map< wxString, wxString > &	GetCustomProperties () const
	Custom user-defined string key/value properties attached to this item.

void	SetCustomProperties (const std::map< wxString, wxString > &aProps)

void	SetCustomProperty (const wxString &aKey, const wxString &aValue)

bool	HasCustomProperties () const

void	ClearCustomProperties ()

void	RemoveCustomProperty (const wxString &aKey)

std::vector< wxString >	RemoveConflictingCustomProperties ()
	Remove custom properties whose keys collide with an existing field or built-in property name (matched case-insensitively).

bool	GetCustomProperty (const wxString &aKey, wxString &aValue) const

std::vector< PROPERTY_BASE * >	GetCustomPropertiesAsInspectables () const

virtual wxString	GetFriendlyName () const

virtual const VECTOR2I	GetFocusPosition () const
	Similar to GetPosition() but allows items to return their visual center rather than their anchor.

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

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

virtual wxString	DisambiguateItemDescription (UNITS_PROVIDER *aUnitsProvider, bool aFull) const

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.

bool	IsSCH_ITEM () const

bool	IsBOARD_ITEM () const

virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Draw the parts of the object belonging to layer aLayer.

virtual double	ViewGetLOD (int aLayer, const VIEW *aView) const
	Return the level of detail (LOD) of the item.

VIEW_ITEM_DATA *	viewPrivData () const

void	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue, bool aNotify=true)

template<typename T>
bool	Set (PROPERTY_BASE *aProperty, T aValue, bool aNotify=true)

bool	Set (PROPERTY_BASE *aProperty, wxVariant aValue, bool aNotify=true)

template<typename T>
bool	Set (const wxString &aProperty, T aValue, bool aNotify=true)

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 void	BuildLocalPowerIconShape (std::vector< SCH_SHAPE > &aShapeList, const VECTOR2D &aPos, double aSize, double aLineWidth, bool aHorizontal)
	Build the local power pin indicator icon shape, at coordinate aPos.

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.

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.

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.

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.

Public Attributes
const KIID	m_Uuid

Protected Member Functions
void	swapData (SCH_ITEM *aItem) override
	Swap the internal data structures aItem with the schematic item.

void	invalidateConnectivity (KICAD_T aChangedType=TYPE_NOT_INIT)
	Bump the parent screen's connectivity revision when this item, or the item owning it as a child, is on its draw list.

SCH_RENDER_SETTINGS *	getRenderSettings (PLOTTER *aPlotter) const

virtual int	compare (const SCH_ITEM &aOther, int aCompareFlags=~COMPARE_FLAGS::UNIT) const
	Provide the draw object specific comparison called by the == and < operators.

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

EDA_ITEM *	findParent (KICAD_T aType) const

Static Protected Member Functions
static double	lodScaleForThreshold (const KIGFX::VIEW *aView, int aWhatIu, int aThresholdIu)
	Get the scale at which aWhatIu would be drawn at the same size as aThresholdIu on screen.

Protected Attributes
TRANSFORM	m_transform
	The rotation/mirror transformation.

int	m_pinNameOffset
	The offset in mils to draw the pin name.

bool	m_showPinNames

bool	m_showPinNumbers

bool	m_excludedFromSim

bool	m_excludedFromBOM

bool	m_excludedFromBoard

bool	m_excludedFromPosFiles

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

int	m_previewUnit = 1

int	m_previewBodyStyle = 1

SCH_LAYER_ID	m_layer

int	m_unit

int	m_bodyStyle

bool	m_private

AUTOPLACE_ALGO	m_fieldsAutoplaced

VECTOR2I	m_storedPos

std::map< SCH_SHEET_PATH, std::vector< SCH_ITEM * >, SHEET_PATH_CMP >	m_connected_items
	Store pointers to other items that are connected to this one, per sheet.

std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * >	m_connection_map
	Store connectivity information, per sheet.

bool	m_connectivity_dirty

std::unordered_set< SCH_RULE_AREA * >	m_rule_areas_cache
	Store pointers to rule areas which this item is contained within.

bool	m_isLocked

EDA_ITEM_FLAGS	m_flags

EDA_ITEM *	m_parent
	Owner.

EDA_GROUP *	m_group
	The group this item belongs to, if any. No ownership implied.

VECTOR2I	m_rolloverPos

bool	m_isRollover

bool	m_forceVisible

bool	m_netHighlighted = false

std::map< wxString, wxString >	m_customProperties

std::map< wxString, std::unique_ptr< PROPERTY_BASE > >	m_dynamicCustomPropsCache
	Per-key cache of dynamic property descriptors for m_customProperties, owned by this object.

Static Protected Attributes
static constexpr double	LOD_HIDE = std::numeric_limits<double>::max()
	Return this constant from ViewGetLOD() to hide the item unconditionally.

static constexpr double	LOD_SHOW = 0.0
	Return this constant from ViewGetLOD() to show the item unconditionally.

Private Member Functions
void	updatePins ()

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.

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

void	setVariantAttribute (bool aEnable, const SCH_SHEET_PATH aInstance, const wxString &aVariantName, bool SCH_SYMBOL::aBase, bool SCH_SYMBOL_VARIANT::*aOverride)

SCH_SYMBOL_INSTANCE *	getInstance (const KIID_PATH &aPath)

const SCH_SYMBOL_INSTANCE *	getInstance (const KIID_PATH &aPath) const

SCH_SYMBOL_INSTANCE *	getInstance (const SCH_SHEET_PATH &aPath)

const SCH_SYMBOL_INSTANCE *	getInstance (const SCH_SHEET_PATH &aPath) const

PIN_MAP_INSTANCE_OVERRIDE	resolveDelegatedPinMapOverride (const SCH_SHEET_PATH &aSheet, const wxString &aVariantName) const
	Return unit 1's pin-map override for a unit that delegates to it (issue #2282).

void	rebuildInstancePathIndex ()

void	registerConnectivityOwner (const std::shared_ptr< CONNECTION_GRAPH_LIFETIME > &aOwner)
	Graph membership belongs to this item identity and must not propagate to clones.

Private Attributes
VECTOR2I	m_pos

LIB_ID	m_lib_id
	Name and library the symbol was loaded from, i.e. 74xx:74LS00.

wxString	m_prefix
	C, R, U, Q etc - the first character(s) which typically indicate what the symbol is.

wxString	m_schLibSymbolName
	The name used to look up a symbol in the symbol library embedded in a schematic.

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

std::map< wxString, std::unique_ptr< PROPERTY_BASE > >	m_dynamicPropertyCache
	Per-object cache of dynamic property descriptors for custom fields and effective pin-map entries, keyed by descriptor name and populated lazily.

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

bool	m_doNetlist
	True if the symbol should appear in netlist.

PASSTHROUGH_MODE	m_passthroughMode

wxString	m_signalName

std::vector< std::unique_ptr< SCH_PIN > >	m_pins
	A copy of SCH_PIN objects from the library symbol.

std::unordered_map< SCH_PIN , SCH_PIN >	m_pinMap
	Library pin pointer : SCH_PIN indices.

PIN_MAP_INSTANCE_OVERRIDE	m_pinMapOverride
	Base (no-variant) pin-to-pad map override applied when no variant override exists for the sheet path (issue #2282).

std::vector< SCH_SYMBOL_INSTANCE >	m_instances
	Define the hierarchical path and reference of the symbol.

std::unordered_map< KIID_PATH, size_t >	m_instancePathIndex
	Index from an instance's sheet path to its position in m_instances for O(1) lookups.

std::map< wxString, std::unique_ptr< LIB_SYMBOL > >	m_variantSymbolCache

std::vector< std::weak_ptr< CONNECTION_GRAPH_LIFETIME > >	m_connectivityOwners
	An item may be indexed by multiple graphs, each with an independent lifetime.

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

bool	m_isSCH_ITEM

bool	m_isBOARD_ITEM

VIEW_ITEM_DATA *	m_viewPrivData

double	m_forcedTransparency
	Additional transparency for diff'ing items.

Static Private Attributes
static std::unordered_map< TRANSFORM, int >	s_transformToOrientationCache

Detailed Description

Schematic symbol object.

Definition at line 72 of file sch_symbol.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum SCH_ITEM::COMPARE_FLAGS : int

inherited

The list of flags used by various compare functions.

Enumerator
UNIT
POSITION
UUID
MISSING_FIELDS
EXTRA_FIELDS
FIELD_TEXT
FIELD_VISIBILITY
FIELD_SIZE_AND_STYLE
FIELD_POSITIONS
PIN_VISIBILITIES
PIN_ALT_DEFS
EXCLUDE_FROM_SIM
EXCLUDE_FROM_BOARD
DNP
EXCLUDE_FROM_BOM
EXCLUDE_FROM_POS_FILES
IDENTITY

Definition at line 743 of file sch_item.h.

◆ PASSTHROUGH_MODE

enum class SCH_SYMBOL::PASSTHROUGH_MODE

strong

Enumerator
DEFAULT
BLOCK
FORCE

Definition at line 848 of file sch_symbol.h.

Constructor & Destructor Documentation

◆ SCH_SYMBOL() [1/4]

SCH_SYMBOL::SCH_SYMBOL ( )

Definition at line 583 of file sch_symbol.cpp.

References DEFAULT, Init(), m_passthroughMode, m_signalName, SCH_SYMBOL_T, and SYMBOL::SYMBOL().

Referenced by BOOST_AUTO_TEST_CASE(), Clone(), GetDynamicProperties(), GetOrientation(), HasConnectivityChanges(), operator!=(), operator<(), operator=(), operator==(), operator==(), resolveDelegatedPinMapOverride(), ResolveTextVar(), SCH_SYMBOL(), SCH_SYMBOL(), setVariantAttribute(), Similarity(), swapData(), and SyncOtherUnits().

◆ SCH_SYMBOL() [2/4]

SCH_SYMBOL::SCH_SYMBOL	(	const LIB_SYMBOL &	aSymbol,
		const LIB_ID &	aLibId,
		const SCH_SHEET_PATH *	aSheet,
		int	aUnit,
		int	aBodyStyle = 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.
aBodyStyle	is the alternate body style for the schematic symbols.
aPosition	is the position of the symbol.
aParent	is the parent object of the newly created symbol.

Definition at line 592 of file sch_symbol.cpp.

References DEFAULT, EDA_ITEM::EDA_ITEM(), LIB_SYMBOL::Flatten(), UTIL::GetRefDesPrefix(), UTIL::GetRefDesUnannotated(), Init(), SCH_ITEM::LIB_SYMBOL, SCH_ITEM::m_bodyStyle, SYMBOL::m_excludedFromBoard, SYMBOL::m_excludedFromBOM, SYMBOL::m_excludedFromPosFiles, SYMBOL::m_excludedFromSim, m_lib_id, m_part, m_passthroughMode, m_prefix, m_signalName, SCH_ITEM::m_unit, SCH_SYMBOL_T, SetLibSymbol(), SetRef(), SYMBOL::SYMBOL(), 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 631 of file sch_symbol.cpp.

References EDA_ITEM::EDA_ITEM(), PICKED_SYMBOL::Fields, SCH_ITEM::LIB_SYMBOL, and SCH_SYMBOL().

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

References SCH_ITEM::m_bodyStyle, SYMBOL::m_DNP, m_doNetlist, m_fields, SCH_ITEM::m_fieldsAutoplaced, m_instancePathIndex, m_instances, m_lib_id, EDA_ITEM::m_parent, m_part, m_passthroughMode, m_pinMapOverride, m_pins, m_pos, m_prefix, m_schLibSymbolName, m_signalName, SYMBOL::m_transform, SCH_ITEM::m_unit, EDA_ITEM::m_Uuid, pin, SCH_SYMBOL(), and SYMBOL::SYMBOL().

◆ ~SCH_SYMBOL()

SCH_SYMBOL::~SCH_SYMBOL ( )

Definition at line 697 of file sch_symbol.cpp.

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

References m_connected_items, and SCH_ITEM().

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

References SCH_ITEM::invalidateConnectivity(), and m_fields.

Referenced by SCH_PROPERTIES_PANEL::addBlankField(), BACK_ANNOTATE::applyChangelist(), ORCAD_CONVERTER::applyCisVariants(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), SCH_IO_LTSPICE_PARSER::CreateFields(), DIPTRACE::SCH_PARSER::createSymbolInstance(), Deserialize(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), FIELD_CASE_CONFLICT_FIXTURE::makeSymbol(), SCH_DYNAMIC_FIXTURE::makeSymbol(), SCH_IO_ALTIUM::ParseParameter(), EASYPC::SCH_BUILDER::placeFields(), ORCAD_CONVERTER::placePowerSymbol(), ORCAD_CONVERTER::placeSymbolFields(), SCH_SYMBOL_FIELD_PROPERTY::setter(), and UpdateFields().

◆ AddHierarchicalReference() [1/2]

void SCH_SYMBOL::AddHierarchicalReference	(	const KIID_PATH &	aPath,
		const wxString &	aRef,
		int	aUnit )

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.

Definition at line 1470 of file sch_symbol.cpp.

References AddHierarchicalReference(), SCH_SYMBOL_INSTANCE::m_Path, SCH_SYMBOL_INSTANCE::m_Reference, and SCH_SYMBOL_INSTANCE::m_Unit.

Referenced by AddHierarchicalReference(), SCH_SHEET_PATH::AddNewSymbolInstances(), AddSheetPathReferenceEntryIfMissing(), KICAD_DIFF::SCH_MERGE_APPLIER::Apply(), ApplySymbolInstance(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), SCH_SHEET_PATH::CheckForMissingSymbolInstances(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), SCH_IO_EAGLE::loadModuleInstance(), SCH_IO_PADS::LoadSchematicFile(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SCREEN::SetLegacySymbolInstanceData(), SetRef(), SetUnitSelection(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and SCH_SHEET_LIST::UpdateSymbolInstanceData().

◆ AddHierarchicalReference() [2/2]

void SCH_SYMBOL::AddHierarchicalReference ( const SCH_SYMBOL_INSTANCE & aInstance )

Definition at line 1481 of file sch_symbol.cpp.

References KIID_PATH::AsString(), GetField(), SCH_ITEM::invalidateConnectivity(), m_instancePathIndex, m_instances, SCH_SYMBOL_INSTANCE::m_Path, SCH_SYMBOL_INSTANCE::m_Reference, SCH_SYMBOL_INSTANCE::m_Unit, SCH_ITEM::m_unit, EDA_ITEM::m_Uuid, REFERENCE, RemoveInstance(), SCH_FIELD::SetText(), and traceSchSheetPaths.

◆ AddRuleAreaToCache()

void SCH_ITEM::AddRuleAreaToCache ( SCH_RULE_AREA * aRuleArea )

inlineinherited

Add a rule area to the item's cache.

Definition at line 723 of file sch_item.h.

References m_rule_areas_cache.

Referenced by SCH_RULE_AREA::addContainedItem().

◆ AddSheetPathReferenceEntryIfMissing()

bool SCH_SYMBOL::AddSheetPathReferenceEntryIfMissing ( const KIID_PATH & aSheetPath )

Add an instance to the alternate references list (m_instances), 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 3441 of file sch_symbol.cpp.

References AddHierarchicalReference(), GetField(), m_instances, SCH_ITEM::m_unit, and REFERENCE.

Referenced by SCH_SCREEN::EnsureAlternateReferencesExist(), and SCH_IO_ALTIUM::NormalizeRepeatedSheetInstances().

◆ AddVariant()

void SCH_SYMBOL::AddVariant	(	const SCH_SHEET_PATH &	aInstance,
		const SCH_SYMBOL_VARIANT &	aVariant )

Definition at line 4850 of file sch_symbol.cpp.

References getInstance(), SCH_ITEM::invalidateConnectivity(), VARIANT::m_Name, and SCH_SYMBOL_INSTANCE::m_Variants.

Referenced by ORCAD_CONVERTER::applyCisVariants(), SCH_IO_ALTIUM::LoadSchematicFile(), SetPinMapOverride(), and setVariantAttribute().

◆ AutoplaceFields()

void SCH_SYMBOL::AutoplaceFields	(	SCH_SCREEN *	aScreen,
		AUTOPLACE_ALGO	aAlgo )

overridevirtual

Automatically orient all the fields in the symbol.

Parameters

aScreen	is the SCH_SCREEN associated with the current instance of the symbol. Required when aAlgo is AUTOPLACE_MANUAL; optional otherwise.
aAlgo	is the field placement algorithm to use.

Reimplemented from SCH_ITEM.

Definition at line 763 of file autoplace_fields.cpp.

References AUTOPLACE_AUTO, AUTOPLACE_MANUAL, AUTOPLACER::DoAutoplace(), and SCH_ITEM::m_fieldsAutoplaced.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_EDIT_TOOL::EditProperties(), PlaceRemoteDownloadedSymbol(), SCH_EDIT_TOOL::Rotate(), and SCH_EDIT_FRAME::SelectUnit().

◆ BeginEdit()

virtual void SCH_ITEM::BeginEdit ( const VECTOR2I & aPosition )

inlinevirtualinherited

Begin drawing a symbol library draw item at aPosition.

It typically would be called on a left click when a draw tool is selected in the symbol library editor and one of the graphics tools is selected.

Parameters

aPosition The position in drawing coordinates where the drawing was started. May or may not be required depending on the item being drawn.

Reimplemented in SCH_FIELD, SCH_SHAPE, and SCH_TEXT.

Definition at line 455 of file sch_item.h.

◆ BuildLocalPowerIconShape()

void SCH_SYMBOL::BuildLocalPowerIconShape	(	std::vector< SCH_SHAPE > &	aShapeList,
		const VECTOR2D &	aPos,
		double	aSize,
		double	aLineWidth,
		bool	aHorizontal )

static

Build the local power pin indicator icon shape, at coordinate aPos.

it is currently a set of 3 bezier curves + one filled cirle

Parameters

aShapeList	is a std::vector<SCH_SHAPE> to store the set of SCH_SHAPE
aPos	is the position of icon
aSize	is the size of icon
aLineWidth	is the line width used to build shapes
aHorizontal	= false for a vertical icon, true for a horizontal icon shape

Definition at line 5188 of file sch_symbol.cpp.

References BEZIER, CIRCLE, FILLED_SHAPE, LAYER_DEVICE, and NO_FILL.

Referenced by KIGFX::SCH_PAINTER::drawLocalPowerIcon(), and plotLocalPowerIcon().

◆ CalcEdit()

virtual void SCH_ITEM::CalcEdit ( const VECTOR2I & aPosition )

inlinevirtualinherited

Calculate the attributes of an item at aPosition when it is being edited.

This method gets called by the Draw() method when the item is being edited. This probably should be a pure virtual method but bezier curves are not yet editable in the symbol library editor. Therefore, the default method does nothing.

Parameters

aPosition The current mouse position in drawing coordinates.

Reimplemented in SCH_FIELD, SCH_PIN, SCH_SHAPE, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 485 of file sch_item.h.

Referenced by SCH_DRAWING_TOOLS::TwoClickPlace().

◆ CanConnect()

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

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 831 of file sch_symbol.h.

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

References EDA_ITEM::EDA_ITEM(), 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 3394 of file sch_symbol.cpp.

References GetField(), UTIL::GetRefDesUnannotated(), SCH_FIELD::GetText(), m_instances, m_pins, m_prefix, SCH_SHEET_PATH::Path(), path, pin, REFERENCE, and SCH_FIELD::SetText().

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

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 154 of file eda_item.h.

References BRIGHTENED, and ClearFlags().

Referenced by KICAD_DIFF::ConfigureSchDiffCanvasContext(), FOOTPRINT_DIFF_WIDGET::DisplayDiff(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), PL_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and PCB_TEST_SELECTION_TOOL::unhighlightInternal().

◆ ClearBrightenedPins()

void SCH_SYMBOL::ClearBrightenedPins ( )

Definition at line 4679 of file sch_symbol.cpp.

References m_pins, and pin.

◆ ClearCaches()

void SCH_SYMBOL::ClearCaches ( )

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 2554 of file sch_symbol.cpp.

References SCH_ITEM::ClearCaches(), and m_variantSymbolCache.

Referenced by TEST_VARIANT_FIELD_RESOLUTION_FIXTURE::ClearVariants(), SCH_EDIT_TOOL::ClearVariantSymbol(), and SCH_EDIT_TOOL::SetVariantSymbol().

◆ ClearConnectedItems()

void SCH_ITEM::ClearConnectedItems ( const SCH_SHEET_PATH & aPath )

inherited

Clear all connections to this item.

Definition at line 757 of file sch_item.cpp.

References m_connected_items.

Referenced by CONNECTION_GRAPH::updateGenericItemConnectivity(), CONNECTION_GRAPH::updatePinConnectivity(), and CONNECTION_GRAPH::updateSymbolConnectivity().

◆ ClearCustomProperties()

void EDA_ITEM::ClearCustomProperties ( )

inlineinherited

Definition at line 270 of file eda_item.h.

References m_customProperties.

◆ ClearEditFlags()

virtual void EDA_ITEM::ClearEditFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 178 of file eda_item.h.

References ClearFlags(), and GetEditFlags().

Referenced by BOARD::Add(), FOOTPRINT::Add(), KICAD_DIFF::PCB_MERGE_APPLIER::Apply(), LIB_SYMBOL::ClearEditFlags(), DRAWING_TOOL::drawShape(), SCH_MOVE_TOOL::finalizeMoveOperation(), PL_DRAWING_TOOLS::PlaceItem(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::PutDataInPreviousState(), BOARD_COMMIT::RevertToCheckpoint(), SCH_ITEM::SwapFlags(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and FOOTPRINT::UpdateFields().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 160 of file eda_item.h.

References EDA_ITEM_ALL_FLAGS, m_flags, and m_netHighlighted.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), PNS_KICAD_IFACE_GENERATOR::AddItem(), AlignSchematicItemsToGrid(), SCH_MOVE_TOOL::AlignToGrid(), BACK_ANNOTATE::applyChangelist(), PCB_CONTROL::ApplyDesignBlockLayout(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), FOOTPRINT::BuildCourtyardCaches(), PCB_VIA_STACK::BuildMembers(), ClearBrightened(), ClearEditFlags(), ClearSelected(), ClearTempFlags(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), MULTICHANNEL_TOOL::copyRuleAreaContents(), FOOTPRINT_EDITOR_CONTROL::CreateFootprintFromWizard(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), PCB_TOOL_BASE::doInteractiveItemPlacement(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), PCB_TUNING_PATTERN::EditCancel(), PCB_VIA_STACK::EditCancel(), PCB_VIA_STITCH::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), PCB_VIA_STACK::EditFinish(), PCB_VIA_STITCH::EditFinish(), BOARD::ExchangeFootprint(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), SCH_IO_KICAD_SEXPR::Format(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), SCH_IO_PADS::LoadSchematicFile(), SCH_ALIGN_TOOL::moveItem(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_EASYEDAPRO_V3_PARSER::ParseSchematic(), PCB_BASE_FRAME::PlaceFootprint(), DRAWING_TOOL::PlaceMicroviaStack(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_MOVE_TOOL::preprocessBreakOrSliceSelection(), SCH_COMMIT::pushSchEdit(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), PAD::Recombine(), FOOTPRINT_EDIT_FRAME::RefreshLibraryFootprintTab(), GERBVIEW_FRAME::RemapLayers(), SCH_POINT_EDITOR::Reset(), SCH_COMMIT::RevertToCheckpoint(), DRC_TEST_PROVIDER_DISALLOW::Run(), ISSUE22864_FIXTURE::RunAlignmentAndVerify(), ISSUE22864_FIXTURE::RunAlignmentAndVerifyNoSkew(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), HEADLESS_FOOTPRINT_CONTEXT::SaveFootprintInLibrary(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin(), SCH_SELECTION_TOOL::SelectMultiple(), SetIsShownAsBitmap(), PCB_VIA::SetSizeFromRules(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_SELECTION_TOOL::unhighlight(), SCH_SHAPE::UpdateHatching(), and SCOPED_FLAGS_CLEANER::~SCOPED_FLAGS_CLEANER().

◆ ClearRuleAreasCache()

void SCH_ITEM::ClearRuleAreasCache ( )

inlineinherited

Reset the cache of rule areas (called prior to schematic connectivity computation)

Definition at line 718 of file sch_item.h.

References m_rule_areas_cache.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

◆ ClearTempFlags()

virtual void EDA_ITEM::ClearTempFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 191 of file eda_item.h.

References ClearFlags(), and GetTempFlags().

Referenced by LIB_SYMBOL::ClearTempFlags(), SCH_EDIT_FRAME::PutDataInPreviousState(), and SCH_ITEM::SwapFlags().

◆ ClearVariantField()

void SCH_SYMBOL::ClearVariantField	(	const KIID_PATH &	aPath,
		const wxString &	aVariantName,
		const wxString &	aFieldName )

Definition at line 5012 of file sch_symbol.cpp.

References getInstance(), SCH_ITEM::invalidateConnectivity(), and SCH_SYMBOL_INSTANCE::m_Variants.

Referenced by applySymbolVariants().

◆ ClearVariantSymbolOverride()

bool SCH_SYMBOL::ClearVariantSymbolOverride	(	const SCH_SHEET_PATH &	aPath,
		const wxString &	aVariantName )

Remove the alternate-symbol override for a given variant and sheet instance.

Returns false if the variant had no override.

Definition at line 5086 of file sch_symbol.cpp.

References getInstance(), SCH_ITEM::invalidateConnectivity(), SCH_SYMBOL_VARIANT::m_SymbolOverride, SCH_SYMBOL_INSTANCE::m_Variants, and m_variantSymbolCache.

Referenced by applySymbolVariants(), and SCH_EDIT_TOOL::ClearVariantSymbol().

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

References EDA_ITEM::EDA_ITEM(), and SCH_SYMBOL().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_FIXTURE_TEST_CASE().

◆ compare()

int SCH_ITEM::compare	(	const SCH_ITEM &	aOther,
		int	aCompareFlags = ~COMPARE_FLAGS::UNIT ) const

protectedvirtualinherited

Provide the draw object specific comparison called by the == and < operators.

The base object sort order which always proceeds the derived object sort order is as follows:

Symbol alternate part (DeMorgan) number.
Symbol part number.
KICAD_T enum value.
Result of derived classes comparison.

Note: Make sure you call down to SCH_ITEM::compare before doing any derived object comparisons or you will break the sorting using the symbol library file format.

Parameters

aOther	A reference to the other SCH_ITEM to compare the arc against.
aCompareFlags	The flags used to perform the comparison.

Returns: An integer value less than 0 if the object is less than aOther object, zero if the object is equal to aOther object, or greater than 0 if the object is greater than aOther object.

Reimplemented in LIB_SYMBOL, SCH_FIELD, SCH_PIN, SCH_SHAPE, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 935 of file sch_item.cpp.

References EDA_ITEM::GetPosition(), IsPrivate(), m_bodyStyle, EDA_ITEM::m_customProperties, m_unit, EDA_ITEM::m_Uuid, name, POSITION, SCH_ITEM(), EDA_ITEM::Type(), UNIT, UUID, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_FIELD::compare(), SCH_PIN::compare(), SCH_SHAPE::compare(), SCH_TEXT::compare(), SCH_ITEM::cmp_items::operator()(), operator<(), operator==(), and SCH_PIN::operator==().

◆ ConnectedItems()

const std::vector< SCH_ITEM * > & SCH_ITEM::ConnectedItems ( const SCH_SHEET_PATH & aPath ) const

inherited

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

Definition at line 766 of file sch_item.cpp.

References empty(), and m_connected_items.

Referenced by addConnections(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), CONNECTION_GRAPH::boost_test_update_symbol_connectivity, CONNECTION_GRAPH::buildItemSubGraphs(), SCH_CONNECTIVITY::Dump(), findSingleNetLabelForPin(), 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 580 of file sch_item.cpp.

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

Referenced by CONNECTION_SUBGRAPH::Absorb(), CONNECTION_SUBGRAPH::AddItem(), SCH_CONNECTIVITY::AppendConnectionInfo(), SCH_EDITOR_CONTROL::AssignNetclass(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), CONNECTION_GRAPH::boost_test_update_generic_connectivity, CONNECTION_GRAPH::boost_test_update_symbol_connectivity, CONNECTION_GRAPH::buildConnectionGraph(), cloneWireConnection(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_SUBGRAPH::ExchangeItem(), SCH_EDITOR_CONTROL::FindNetInInspector(), SCH_DRAWING_TOOLS::findWireLabelDriverName(), CONNECTION_GRAPH::GetBusesNeedingMigration(), GetBusMemberNames(), GetConnectionName(), SCH_PIN::GetMsgPanelInfo(), GetOrInitConnection(), HasBusConnection(), SCH_SELECTION_TOOL::Init(), InitializeConnection(), MatchesNetName(), BUS_UNFOLD_MENU::memberEntries(), SCH_CONNECTIVITY::NETCHAIN_MANAGER::NetKeyForItem(), SCH_TEXT::Plot(), SCH_DRAG_NET_COLLISION_MONITOR::recordItemNet(), ORCAD_CONVERTER::recordNetNameMap(), SCH_EDIT_FRAME::RefreshConnectivity(), CONNECTION_SUBGRAPH::ResolveDrivers(), and SCH_TOOL_BASE< T >::saveCopyInUndoList().

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

References EDA_ITEM::EDA_ITEM().

◆ ContinueEdit()

virtual bool SCH_ITEM::ContinueEdit ( const VECTOR2I & aPosition )

inlinevirtualinherited

Continue an edit in progress at aPosition.

This is used to perform the next action while drawing an item. This would be called for each additional left click when the mouse is captured while the item is being drawn.

Parameters

aPosition The position of the mouse left click in drawing coordinates.

Returns: True if additional mouse clicks are required to complete the edit in progress.

Reimplemented in SCH_SHAPE.

Definition at line 467 of file sch_item.h.

◆ CopyVariant() [1/2]

void SCH_SYMBOL::CopyVariant	(	const KIID_PATH &	aPath,
		const wxString &	aSourceVariant,
		const wxString &	aNewVariant )

Definition at line 5044 of file sch_symbol.cpp.

References getInstance(), SCH_ITEM::invalidateConnectivity(), VARIANT::m_Name, and SCH_SYMBOL_INSTANCE::m_Variants.

Referenced by SCH_SCREEN::CopyVariant(), and CopyVariant().

◆ CopyVariant() [2/2]

void SCH_SYMBOL::CopyVariant	(	const SCH_SHEET_PATH &	aInstance,
		const wxString &	aSourceVariant,
		const wxString &	aNewVariant )

inline

Definition at line 1067 of file sch_symbol.h.

References CopyVariant(), and SCH_SHEET_PATH::Path().

◆ DeleteVariant() [1/2]

void SCH_SYMBOL::DeleteVariant	(	const KIID_PATH &	aPath,
		const wxString &	aVariantName )

Definition at line 4998 of file sch_symbol.cpp.

References getInstance(), SCH_ITEM::invalidateConnectivity(), and SCH_SYMBOL_INSTANCE::m_Variants.

Referenced by applySymbolVariants(), SCH_SCREEN::DeleteVariant(), and DeleteVariant().

◆ DeleteVariant() [2/2]

void SCH_SYMBOL::DeleteVariant	(	const SCH_SHEET_PATH &	aInstance,
		const wxString &	aVariantName )

inline

Definition at line 1057 of file sch_symbol.h.

References DeleteVariant(), and SCH_SHEET_PATH::Path().

◆ Deserialize() [1/2]

bool SCH_SYMBOL::Deserialize ( const google::protobuf::Any & aContainer )

overridevirtual

Deserializes the given protobuf message into this object.

Parameters

aContainer is an Any which should have a concrete type matching this object

Returns: true if unpacking and deserialization succeeded

Reimplemented from SERIALIZABLE.

Definition at line 903 of file sch_symbol.cpp.

References Deserialize().

Referenced by Deserialize(), and UnpackSymbol().

◆ Deserialize() [2/2]

bool SCH_SYMBOL::Deserialize ( const kiapi::schematic::types::SchematicSymbolInstance & aSymbol )

Definition at line 914 of file sch_symbol.cpp.

References AddField(), ALL_BODY_STYLES, ALL_UNITS, AUTOPLACE_AUTO, AUTOPLACE_NONE, DATASHEET, DESCRIPTION, LIB_SYMBOL::Deserialize(), SCH_FIELD::Deserialize(), FOOTPRINT, FromProtoEnum(), GetAllLibPins(), GetField(), GetFields(), GetGraphicalPins(), LIB_ID::GetLibItemName(), SCH_ITEM::GetParentScreen(), SCH_FIELD::IsMandatory(), SCH_ITEM::LIB_SYMBOL, m_lib_id, m_pins, EDA_ITEM::m_Uuid, name, pin, REFERENCE, RemoveField(), SCH_PIN_T, schIUScale, SetBodyStyle(), SCH_ITEM::SetFieldsAutoplaced(), SetLibSymbol(), SCH_ITEM::SetLocked(), SetMirrorX(), SetMirrorY(), SetOrientationProp(), SetPassthroughMode(), SYMBOL::SetPinNameOffset(), SetPosition(), SetSchSymbolLibraryName(), SetShowPinNames(), SetShowPinNumbers(), kiapi::common::TypeNameFromAny(), kiapi::common::UnpackCustomProperties(), kiapi::common::UnpackDistance(), kiapi::common::UnpackLibId(), kiapi::common::UnpackVector2(), UpdatePins(), USER, and VALUE.

◆ DisambiguateItemDescription()

virtual wxString EDA_ITEM::DisambiguateItemDescription	(	UNITS_PROVIDER *	aUnitsProvider,
		bool	aFull ) const

inlinevirtualinherited

Reimplemented in FOOTPRINT.

Definition at line 458 of file eda_item.h.

References GetItemDescription().

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ doGetBoundingBox()

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

private

Definition at line 3697 of file sch_symbol.cpp.

References SCHEMATIC::CurrentSheet(), LIB_SYMBOL::GetBodyBoundingBox(), LIB_SYMBOL::GetDummy(), GetEffectiveLibSymbol(), SCH_ITEM::LIB_SYMBOL, SCH_ITEM::m_bodyStyle, m_fields, m_pos, SYMBOL::m_transform, SCH_ITEM::m_unit, BOX2< Vec >::Merge(), BOX2< Vec >::Normalize(), BOX2< Vec >::Offset(), and SCH_ITEM::Schematic().

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

◆ DoHypertextAction()

virtual void SCH_ITEM::DoHypertextAction	(	EDA_DRAW_FRAME *	aFrame,
		const VECTOR2I &	aMousePos ) const

inlinevirtualinherited

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 348 of file sch_item.h.

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

References ALL_BODY_STYLES, ALL_UNITS, SCH_ITEM::GetBodyStyle(), SCH_ITEM::GetUnit(), m_pins, m_pos, SYMBOL::m_transform, pin, and PT_NC.

◆ DoNetList()

bool SCH_SYMBOL::DoNetList ( ) const

Returns: true if the symbol is in netlist.

Definition at line 4419 of file sch_symbol.cpp.

References m_doNetlist.

Referenced by SCH_CONNECTIVITY::ExtractInstanceFacts(), and CONNECTION_SUBGRAPH::ResolveDrivers().

◆ Duplicate()

SCH_ITEM * SCH_ITEM::Duplicate	(	bool	addToParentGroup,
		SCH_COMMIT *	aCommit = nullptr,
		bool	aDoClone = false ) const

inherited

Routine to create a new copy of given item.

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

Parameters

	addToParentGroup	Indicates whether or not the new item is added to the group (if any) containing the old item. If true, aCommit must be provided.
[out]	aCommit	is the optional commit object for undo/redo operations.
	aDoClone	(default = false) indicates unique values (such as timestamp and sheet name) should be duplicated. Use only for undo/redo operations.

Definition at line 191 of file sch_item.cpp.

References BRIGHTENED, EDA_ITEM::ClearFlags(), EDA_ITEM::Clone(), EDA_ITEM::GetParentGroup(), group, EDA_ITEM::m_Uuid, COMMIT::Modify(), NO_RECURSE, RunOnChildren(), SCH_ITEM(), SCH_SYMBOL_T, SELECTED, and EDA_ITEM::Type().

Referenced by SCH_EDIT_FRAME::AddCopyForRepeatItem(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_LINE::BreakAt(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SCH_GROUP::DeepDuplicate(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_IO_EAGLE::loadSchematic(), SCH_IO_DATABASE::loadSymbolFromRow(), SCH_LINE::NonGroupAware_BreakAt(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_LINE_WIRE_BUS_TOOL::startSegments().

◆ EndEdit()

virtual void SCH_ITEM::EndEdit ( bool aClosed = false )

inlinevirtualinherited

End an object editing action.

This is used to end or abort an edit action in progress initiated by BeginEdit().

Reimplemented in SCH_SHAPE.

Definition at line 474 of file sch_item.h.

◆ FindFieldCaseInsensitive() [1/2]

SCH_FIELD * SCH_SYMBOL::FindFieldCaseInsensitive ( const wxString & aFieldName )

Search for a SCH_FIELD with aFieldName.

Parameters

aFieldName is the name of the field to find.

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

Definition at line 2312 of file sch_symbol.cpp.

References m_fields.

Referenced by ORCAD_CONVERTER::applyCisVariants(), and NETLIST_EXPORTER_ALLEGRO::getGroupField().

◆ FindFieldCaseInsensitive() [2/2]

const SCH_FIELD * SCH_SYMBOL::FindFieldCaseInsensitive ( const wxString & aFieldName ) const

Definition at line 2324 of file sch_symbol.cpp.

References m_fields.

◆ findParent()

EDA_ITEM * EDA_ITEM::findParent ( KICAD_T aType ) const

protectedinherited

Definition at line 137 of file eda_item.cpp.

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

Referenced by BOARD_ITEM::GetBoard(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParentFootprint(), SCH_ITEM::GetParentScreen(), SCH_ITEM::GetParentSymbol(), SCH_ITEM::GetParentSymbol(), and SCH_ITEM::Schematic().

◆ Get() [1/3]

template<typename T>

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

inherited

Definition at line 84 of file inspectable_impl.h.

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inherited

◆ Get() [3/3]

template<typename T>

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inherited

Definition at line 72 of file inspectable_impl.h.

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

◆ GetAllLibPins()

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

Returns: a list of pin pointers for all units / bodyStyles. Used primarily for SPICE where we want to treat all units together as a single SPICE element.

Definition at line 2636 of file sch_symbol.cpp.

References ALL_BODY_STYLES, ALL_UNITS, and m_part.

Referenced by BOOST_FIXTURE_TEST_CASE(), SIM_LIB_MGR::CaptureModelInput(), LEGACY_POWER_SYMBOLS_TEST_FIXTURE::CheckSymbols(), Deserialize(), SCH_SCREEN::FixLegacyPowerSymbolMismatches(), IsSymbolLikePowerGlobalLabel(), IsSymbolLikePowerLocalLabel(), and ResolveTextVar().

◆ GetBodyAndPinsBoundingBox()

BOX2I SCH_SYMBOL::GetBodyAndPinsBoundingBox ( ) const

overridevirtual

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

Implements SYMBOL.

Definition at line 3740 of file sch_symbol.cpp.

References doGetBoundingBox().

Referenced by BOOST_AUTO_TEST_CASE(), KIGFX::SCH_PAINTER::draw(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), operator<(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_EASYEDAPRO_V3_PARSER::ParseSchematic(), and PlotDNP().

◆ GetBodyBoundingBox()

BOX2I SCH_SYMBOL::GetBodyBoundingBox ( ) const

overridevirtual

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

Implements SYMBOL.

Definition at line 3726 of file sch_symbol.cpp.

References doGetBoundingBox().

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), HitTest(), HitTest(), HitTest(), SCH_EASYEDA_PARSER::ParseSchematic(), and PlotDNP().

◆ GetBodyStyle()

int SCH_ITEM::GetBodyStyle ( ) const

inlineinherited

Definition at line 253 of file sch_item.h.

References m_bodyStyle.

◆ GetBodyStyleCount()

int SCH_SYMBOL::GetBodyStyleCount ( ) const

overridevirtual

Return the number of body styles of the symbol.

Returns: the number of body styles or zero if the library entry cannot be found.

Implements SYMBOL.

Definition at line 1358 of file sch_symbol.cpp.

References m_part.

Referenced by SCH_EDIT_TOOL::CycleBodyStyle(), IsMultiBodyStyle(), Serialize(), SetBodyStyleProp(), and BODY_STYLE_MENU::update().

◆ GetBodyStyleDescription()

wxString SCH_SYMBOL::GetBodyStyleDescription	(	int	aBodyStyle,
		bool	aLabel ) const

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1387 of file sch_symbol.cpp.

References m_part.

Referenced by GetBodyStyleProp(), SetBodyStyleProp(), and BODY_STYLE_MENU::update().

◆ GetBodyStyleProp()

wxString SCH_SYMBOL::GetBodyStyleProp ( ) const

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 539 of file sch_symbol.h.

References SCH_ITEM::GetBodyStyle(), and GetBodyStyleDescription().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

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

References doGetBoundingBox().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), Plot(), and SCH_RULE_AREA::RefreshContainedItemsAndDirectives().

◆ GetBusMemberNames()

std::vector< wxString > SCH_ITEM::GetBusMemberNames ( const SCH_SHEET_PATH * aSheet = nullptr ) const

inherited

Names of the bus members of this item's connection, empty when it does not have a bus.

The published connectivity gives the leaf names, so a nested bus is flattened here.

Definition at line 647 of file sch_item.cpp.

References Connection(), ADVANCED_CFG::GetCfg(), SCH_CONNECTION::IsBus(), SCH_CONNECTION::Members(), and publishedConnection().

Referenced by SCH_LINE::Plot().

◆ GetCachedDriverName()

const wxString & SCH_ITEM::GetCachedDriverName ( ) const

virtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 827 of file sch_item.cpp.

Referenced by CONNECTION_SUBGRAPH::GetNameForDriver().

◆ GetClass()

wxString SCH_SYMBOL::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 113 of file sch_symbol.h.

Referenced by operator=().

◆ GetComponentClassNames()

std::unordered_set< wxString > SCH_SYMBOL::GetComponentClassNames ( const SCH_SHEET_PATH * aPath ) const

Return the component classes this symbol belongs in.

Definition at line 4806 of file sch_symbol.cpp.

References INTERNAL, m_fields, and SCH_ITEM::m_rule_areas_cache.

Referenced by NETLIST_EXPORTER_XML::getComponentClassNamesForAllSymbolUnits().

◆ GetConnectionName()

std::optional< wxString > SCH_ITEM::GetConnectionName	(	const SCH_SHEET_PATH *	aSheet = nullptr,
		bool	aLocal = false,
		bool	aIgnoreSheet = false ) const

inherited

Return the active connection name; absent for missing or stale published rows.

aIgnoreSheet removes only the hierarchy prefix of the canonical name.

Definition at line 629 of file sch_item.cpp.

References Connection(), ADVANCED_CFG::GetCfg(), and publishedConnection().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGFX::SCH_PAINTER::draw(), GetEffectiveNetClass(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_LABEL_BASE::ResolveTextVar(), SCH_EDITOR_CONTROL::ShowCreateNetChain(), SCH_EDITOR_CONTROL::SimProbe(), NET_CHAIN_MENU::update(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

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

Reimplemented from SCH_ITEM.

Definition at line 4098 of file sch_symbol.cpp.

References ALL_BODY_STYLES, ALL_UNITS, SCH_ITEM::GetBodyStyle(), SCH_ITEM::GetUnit(), m_pins, m_pos, SYMBOL::m_transform, and pin.

◆ GetContextualTextVars()

void SCH_SYMBOL::GetContextualTextVars ( wxArrayString * aVars ) const

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

Definition at line 2797 of file sch_symbol.cpp.

References m_fields.

Referenced by DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TABLECELL_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), and SCH_FIELD::OnScintillaCharAdded().

◆ GetCustomProperties()

const std::map< wxString, wxString > & EDA_ITEM::GetCustomProperties ( ) const

inlineinherited

Custom user-defined string key/value properties attached to this item.

Keys and values are arbitrary strings; their meaning is defined by the user. The only constraint is that keys may not duplicate a built-in property (or field name, for items that have fields).

Definition at line 242 of file eda_item.h.

References m_customProperties.

Referenced by BOOST_AUTO_TEST_CASE(), KICAD_FORMAT::FormatCustomProperties(), and kiapi::common::PackCustomProperties().

◆ GetCustomPropertiesAsInspectables()

std::vector< PROPERTY_BASE * > EDA_ITEM::GetCustomPropertiesAsInspectables ( ) const

inherited

Definition at line 200 of file eda_item.cpp.

References m_customProperties, m_dynamicCustomPropsCache, and TYPE_HASH.

Referenced by GetDynamicProperties(), FOOTPRINT::GetDynamicProperties(), SCH_SHEET::GetDynamicProperties(), and SCH_SYMBOL::GetDynamicProperties().

◆ GetCustomProperty()

bool EDA_ITEM::GetCustomProperty	(	const wxString &	aKey,
		wxString &	aValue ) const

inherited

Returns: true if aKey is present and aValue was filled

Definition at line 188 of file eda_item.cpp.

References m_customProperties.

Referenced by BOOST_AUTO_TEST_CASE(), customPropertyFunc(), EDA_CUSTOM_PROPERTY::getter(), hasCustomPropertyFunc(), PCB_PROPERTIES_PANEL::onKeyRenamed(), and SCH_PROPERTIES_PANEL::onKeyRenamed().

◆ GetDatasheet()

wxString SCH_SYMBOL::GetDatasheet ( ) const

Return the documentation text for the given part alias.

Definition at line 1148 of file sch_symbol.cpp.

References m_part.

Referenced by UpdateFields().

◆ GetDefaultFont()

const wxString & SCH_ITEM::GetDefaultFont ( const KIGFX::RENDER_SETTINGS * aSettings ) const

inherited

Definition at line 999 of file sch_item.cpp.

References GetAppSettings(), KIGFX::RENDER_SETTINGS::GetDefaultFont(), and KICAD_FONT_NAME.

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

◆ GetDescription()

wxString SCH_SYMBOL::GetDescription ( ) const

overridevirtual

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

Implements SYMBOL.

Definition at line 1112 of file sch_symbol.cpp.

References m_part.

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ GetDNP()

bool SCH_SYMBOL::GetDNP	(	const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString ) const

overridevirtual

Set or clear the 'Do Not Populate' flag.

Reimplemented from SYMBOL.

Definition at line 1913 of file sch_symbol.cpp.

References GetInstance(), SYMBOL::m_DNP, SCH_SYMBOL_INSTANCE::m_Variants, and SCH_SHEET_PATH::Path().

◆ GetDNPProp()

bool SCH_SYMBOL::GetDNPProp ( ) const

Definition at line 88 of file sch_symbol.cpp.

References GetDNP(), and SCH_ITEM::Schematic().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ GetDrawItem()

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

References SCHEMATIC::CurrentSheet(), GetEffectiveLibSymbol(), SCH_ITEM::LIB_SYMBOL, LIB_SYMBOL::LocateDrawItem(), SCH_ITEM::m_bodyStyle, m_pos, SYMBOL::m_transform, SCH_ITEM::m_unit, SCH_ITEM::SCH_ITEM(), and SCH_ITEM::Schematic().

Referenced by SCH_SCREEN::GetPin().

◆ GetDynamicProperties() [1/2]

std::vector< PROPERTY_BASE * > SCH_SYMBOL::GetDynamicProperties ( ) const

overridevirtual

Return dynamically-computed properties specific to this object instance (e.g.

custom fields, pin-map entries). These are NOT registered in PROPERTY_MANAGER and do NOT appear in GetProperties(TYPE_ID).

The returned PROPERTY_BASE* pointers are owned by the object and remain valid until the object is destroyed or its property set changes.

Reimplemented from EDA_ITEM.

Definition at line 710 of file sch_symbol.cpp.

References GetDynamicProperties(), and SCH_ITEM::Schematic().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GetDynamicProperties(), and ResolveTextVar().

◆ GetDynamicProperties() [2/2]

std::vector< PROPERTY_BASE * > SCH_SYMBOL::GetDynamicProperties ( const SCH_SHEET_PATH * aPath ) const

Definition at line 716 of file sch_symbol.cpp.

References EDA_ITEM::GetCustomPropertiesAsInspectables(), GetFields(), GetPins(), SCH_FIELD::GetUntranslatedName(), HasEffectiveAssociatedFootprint(), PROPERTY_MANAGER::Instance(), m_dynamicPropertyCache, name, pin, PIN_MAP_ENTRY_PREFIX, PIN_MAP_FOOTPRINT_PROP, PIN_MAP_MODE_PROP, PIN_MAP_NAME_PROP, SCH_SYMBOL(), and TYPE_HASH.

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

◆ GetEffectiveLibSymbol()

const LIB_SYMBOL * SCH_SYMBOL::GetEffectiveLibSymbol ( const SCH_SHEET_PATH * aPath = nullptr ) const

Return the library symbol to use for rendering and bounding box calculations.

If the current variant has a symbol override and it resolves successfully, returns the alternate symbol. Otherwise returns the base m_part.

Parameters

aPath optional sheet path for variant context.

Returns: the effective library symbol, or nullptr.

Definition at line 4933 of file sch_symbol.cpp.

References SCHEMATIC::GetCurrentVariant(), GetVariantLibSymbol(), SCH_ITEM::LIB_SYMBOL, m_part, and SCH_ITEM::Schematic().

Referenced by doGetBoundingBox(), KIGFX::SCH_PAINTER::draw(), SCH_CONNECTIVITY::ExtractInstanceFacts(), GetDrawItem(), Plot(), and PlotPins().

◆ GetEffectiveNetClass()

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

inherited

◆ GetEffectivePenWidth()

int SCH_ITEM::GetEffectivePenWidth ( const SCH_RENDER_SETTINGS * aSettings ) const

inherited

Definition at line 1021 of file sch_item.cpp.

References KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), EDA_ITEM::GetParent(), GetPenWidth(), LIB_SYMBOL_T, SCH_RENDER_SETTINGS::m_SymbolLineWidth, and EDA_ITEM::Type().

Referenced by KIGFX::SCH_PAINTER::getLineWidth(), SCH_LINE::Plot(), SCH_NO_CONNECT::Plot(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), SCH_SHEET::Plot(), SCH_TEXTBOX::Plot(), and SCH_PIN::PlotPinType().

◆ GetEmbeddedFiles()

EMBEDDED_FILES * SCH_SYMBOL::GetEmbeddedFiles ( )

overridevirtual

SCH_SYMBOLs don't currently support embedded files, but their LIB_SYMBOL counterparts do.

Reimplemented from EDA_ITEM.

Definition at line 3870 of file sch_symbol.cpp.

References GetLibSymbolRef().

Referenced by BOOST_AUTO_TEST_CASE(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), SCH_EDITOR_CONTROL::SimProbe(), and SIMULATOR_FRAME_UI::UpdateTunerValue().

◆ GetEmbeddedFonts()

const std::vector< wxString > * SCH_ITEM::GetEmbeddedFonts ( )

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 1072 of file sch_item.cpp.

References GetParentSymbol(), and Schematic().

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

References ALL_UNITS, GetPinPhysicalPosition(), m_pins, SCH_ITEM::m_unit, pin, and PIN_END.

◆ GetExcludedFromBoard()

bool SCH_SYMBOL::GetExcludedFromBoard	(	const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString ) const

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 2073 of file sch_symbol.cpp.

References GetInstance(), SYMBOL::m_excludedFromBoard, SCH_SYMBOL_INSTANCE::m_Variants, and SCH_SHEET_PATH::Path().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BACK_ANNOTATE::checkForUnusedSymbols(), NETLIST_EXPORTER_ALLEGRO::extractComponentsInfo(), SCH_CONNECTIVITY::ExtractInstanceFacts(), CONNECTION_SUBGRAPH::GetDriverPriority(), GetExcludedFromBoardProp(), GetMsgPanelInfo(), SCH_SYMBOL_VARIANT::HasDifferentials(), SCH_SYMBOL_VARIANT::InitializeAttributes(), PackSymbol(), ResolveTextVar(), SCH_IO_KICAD_SEXPR::saveSymbol(), SyncOtherUnits(), NETLIST_EXPORTER_CADSTAR::writeNetlist(), NETLIST_EXPORTER_ORCADPCB2::writeNetlist(), and NETLIST_EXPORTER_PADS::writeNetlist().

◆ GetExcludedFromBoardProp()

bool SCH_SYMBOL::GetExcludedFromBoardProp ( ) const

Definition at line 124 of file sch_symbol.cpp.

References GetExcludedFromBoard(), and SCH_ITEM::Schematic().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ GetExcludedFromBOM()

bool SCH_SYMBOL::GetExcludedFromBOM	(	const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString ) const

overridevirtual

Reimplemented from SYMBOL.

Definition at line 2022 of file sch_symbol.cpp.

References GetInstance(), SYMBOL::m_excludedFromBOM, SCH_SYMBOL_INSTANCE::m_Variants, and SCH_SHEET_PATH::Path().

Referenced by BACK_ANNOTATE::applyChangelist(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GetExcludedFromBOMProp(), GetMsgPanelInfo(), SCH_SYMBOL_VARIANT::HasDifferentials(), SCH_SYMBOL_VARIANT::InitializeAttributes(), PackSymbol(), ResolveTextVar(), SCH_IO_KICAD_SEXPR::saveSymbol(), and SyncOtherUnits().

◆ GetExcludedFromBOMProp()

bool SCH_SYMBOL::GetExcludedFromBOMProp ( ) const

Definition at line 100 of file sch_symbol.cpp.

References GetExcludedFromBOM(), and SCH_ITEM::Schematic().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ GetExcludedFromPosFiles()

bool SCH_SYMBOL::GetExcludedFromPosFiles	(	const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString ) const

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 2100 of file sch_symbol.cpp.

References GetInstance(), SYMBOL::m_excludedFromPosFiles, SCH_SYMBOL_INSTANCE::m_Variants, and SCH_SHEET_PATH::Path().

Referenced by BACK_ANNOTATE::applyChangelist(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GetExcludedFromPosFilesProp(), SCH_SYMBOL_VARIANT::HasDifferentials(), SCH_SYMBOL_VARIANT::InitializeAttributes(), PackSymbol(), ResolveTextVar(), SCH_IO_KICAD_SEXPR::saveSymbol(), and SyncOtherUnits().

◆ GetExcludedFromPosFilesProp()

bool SCH_SYMBOL::GetExcludedFromPosFilesProp ( ) const

Definition at line 136 of file sch_symbol.cpp.

References GetExcludedFromPosFiles(), and SCH_ITEM::Schematic().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ GetExcludedFromSim()

bool SCH_SYMBOL::GetExcludedFromSim	(	const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString ) const

overridevirtual

Reimplemented from SYMBOL.

Definition at line 2047 of file sch_symbol.cpp.

References GetInstance(), SYMBOL::m_excludedFromSim, SCH_SYMBOL_INSTANCE::m_Variants, and SCH_SHEET_PATH::Path().

Referenced by BACK_ANNOTATE::applyChangelist(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGFX::SCH_PAINTER::draw(), GetExcludedFromSimProp(), GetMsgPanelInfo(), SCH_SYMBOL_VARIANT::HasDifferentials(), SCH_SYMBOL_VARIANT::InitializeAttributes(), PackSymbol(), ResolveTextVar(), and SCH_IO_KICAD_SEXPR::saveSymbol().

◆ GetExcludedFromSimProp()

bool SCH_SYMBOL::GetExcludedFromSimProp ( ) const

Definition at line 112 of file sch_symbol.cpp.

References GetExcludedFromSim(), and SCH_ITEM::Schematic().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ GetField() [1/4]

SCH_FIELD * SCH_SYMBOL::GetField ( const wxString & aFieldName )

Return a field in this symbol.

Parameters

aFieldName is the untranslated name of the field.

Returns: Both non-const and const versions return nullptr if the field is not found.

Definition at line 2235 of file sch_symbol.cpp.

References FindField(), and m_fields.

◆ GetField() [2/4]

const SCH_FIELD * SCH_SYMBOL::GetField ( const wxString & aFieldName ) const

Definition at line 2241 of file sch_symbol.cpp.

References FindField(), and m_fields.

◆ GetField() [3/4]

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

Definition at line 2229 of file sch_symbol.cpp.

References FindField(), and m_fields.

◆ GetField() [4/4]

SCH_FIELD * SCH_SYMBOL::GetField ( FIELD_T aFieldType )

Return a mandatory field in this symbol.

The const version will return nullptr if the field is not found; non-const version will create the field.

Definition at line 2219 of file sch_symbol.cpp.

References FindField(), and m_fields.

◆ GetFields() [1/3]

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

inline

Return a reference to the vector holding the symbol's fields.

Definition at line 461 of file sch_symbol.h.

References m_fields.

Referenced by Deserialize(), GetDynamicProperties(), operator==(), operator==(), Plot(), and Serialize().

◆ GetFields() [2/3]

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

inline

Definition at line 462 of file sch_symbol.h.

References m_fields.

◆ GetFields() [3/3]

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

overridevirtual

Populate a std::vector with SCH_FIELDs, sorted in ordinal order.

Parameters

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

Implements SYMBOL.

Definition at line 2247 of file sch_symbol.cpp.

References m_fields.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), BACK_ANNOTATE::applyChangelist(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SIM_LIB_MGR::CaptureModelInput(), PADS_SCH::PADS_SCH_SCHEMATIC_BUILDER::CreateCustomFields(), DetectFieldCaseConflicts(), SCH_INSPECTION_TOOL::DiffSymbol(), KIGFX::SCH_PAINTER::draw(), SCH_CONNECTIVITY::ExtractInstanceFacts(), SCH_SCREEN::HasSymbolFieldNamesWithWhiteSpace(), EESCHEMA_JOBS_HANDLER::JobExportBom(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_FIND_REPLACE_TOOL::nextMatch(), DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsAdded(), DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsChanged(), operator==(), operator==(), SCH_IO_ALTIUM::ParseComponent(), EASYPC::SCH_BUILDER::placeFields(), ORCAD_CONVERTER::placeInstance(), ORCAD_CONVERTER::placeSymbolFields(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SCH_IO_KICAD_LEGACY::saveSymbol(), SCH_IO_KICAD_SEXPR::saveSymbol(), POWER_SEARCH_HANDLER::Search(), SYMBOL_SEARCH_HANDLER::Search(), SCH_SELECTION_TOOL::SelectMultiple(), ERC_TESTER::TestFieldNameWhitespace(), DIALOG_CHANGE_SYMBOLS::updateFieldsList(), SIMULATOR_FRAME_UI::UpdateTunerValue(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetFieldsAutoplaced()

AUTOPLACE_ALGO SCH_ITEM::GetFieldsAutoplaced ( ) const

inlineinherited

Return whether the fields have been automatically placed.

Definition at line 673 of file sch_item.h.

References m_fieldsAutoplaced.

Referenced by SCH_EDIT_TOOL::editFieldText(), SCH_EDIT_TOOL::EditProperties(), packLabel(), SCH_EDIT_TOOL::Rotate(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_IO_KICAD_SEXPR::saveText(), SCH_EDIT_FRAME::SelectUnit(), SCH_GLOBALLABEL::Serialize(), SCH_SHEET::Serialize(), and SCH_SYMBOL::Serialize().

◆ GetFieldText()

wxString SCH_SYMBOL::GetFieldText	(	const wxString &	aFieldName,
		const SCH_SHEET_PATH *	aPath = nullptr,
		const wxString &	aVariantName = wxEmptyString ) const

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 167 of file eda_item.h.

References m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), checkCourtyardCloses(), collidesWithArea(), PCB_TABLE::DeleteMarkedCells(), SCH_TABLE::DeleteMarkedCells(), doConvertOutlineToPolygon(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), doIntersectsAreaFunc(), KIGFX::SCH_PAINTER::draw(), PCB_TUNING_PATTERN::EditCancel(), PCB_VIA_STITCH::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), PCB_VIA_STITCH::EditFinish(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_SELECTION_TOOL::FilterCollectorForHierarchy(), findNext(), DRC_ITEM::GetViolationLayers(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), LIB_SYMBOL::LIB_SYMBOL(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD::Recombine(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_IO_KICAD_SEXPR::saveTable(), PAD::SetAttribute(), PCB_VIA::SetBottomLayer(), BOARD_CONNECTED_ITEM::SetLayer(), PCB_VIA::SetLayerPair(), PAD::SetLayerSet(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_VIA::SetTopLayer(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), PCB_TUNING_PATTERN::Update(), PCB_VIA_STACK::Update(), and PCB_VIA_STITCH::Update().

◆ 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_ARC, PCB_SHAPE, and PCB_TRACK.

Definition at line 355 of file eda_item.h.

References GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), and test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run().

◆ GetFontMetrics()

const KIFONT::METRICS & SCH_ITEM::GetFontMetrics ( ) const

inherited

◆ GetFootprintFieldText()

const wxString SCH_SYMBOL::GetFootprintFieldText	(	const SCH_SHEET_PATH *	aPath,
		RESOLUTION_CONTEXT	aContext,
		const wxString &	aVariantName = wxEmptyString ) const

Definition at line 2205 of file sch_symbol.cpp.

References FOOTPRINT, GetField(), and SCH_FIELD::GetShownText().

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GetFieldText(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), ERC_TESTER::TestPinMap(), NETLIST_EXPORTER_ALLEGRO::toAllegroPackages(), NETLIST_EXPORTER_CADSTAR::writeNetlist(), NETLIST_EXPORTER_ORCADPCB2::writeNetlist(), and NETLIST_EXPORTER_PADS::writeNetlist().

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 167 of file view_item.h.

References m_forcedTransparency.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::getRenderColor(), EDA_ITEM::operator=(), ZONE_PAINTER::PCB_PAINTER(), and LIB_SYMBOL::SetParent().

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, PCB_TABLECELL, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, PCB_VIA_STACK, PCB_VIA_STITCH, SCH_DIRECTIVE_LABEL, SCH_FIELD, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LABEL, SCH_LINE, SCH_PIN, SCH_RULE_AREA, SCH_SHEET_PIN, SCH_TEXT, and ZONE.

Definition at line 565 of file eda_item.cpp.

References GetTypeDesc().

Referenced by API_HANDLER_BOARD::createItemForType(), API_HANDLER_SCH::createItemForType(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), and PROPERTIES_PANEL::rebuildProperties().

◆ GetFullPinCount()

size_t SCH_SYMBOL::GetFullPinCount ( ) const

Returns: a count of pins for all units.

Definition at line 2645 of file sch_symbol.cpp.

References m_part.

◆ GetGraphicalPins()

std::vector< SCH_PIN * > SCH_SYMBOL::GetGraphicalPins	(	int	aUnit,
		int	aBodyStyle ) const

overridevirtual

◆ GetInstance()

bool SCH_SYMBOL::GetInstance	(	SCH_SYMBOL_INSTANCE &	aInstance,
		const KIID_PATH &	aSheetPath,
		bool	aTestFromEnd = false ) const

◆ getInstance() [1/4]

SCH_SYMBOL_INSTANCE * SCH_SYMBOL::getInstance ( const KIID_PATH & aPath )

private

Definition at line 5239 of file sch_symbol.cpp.

References m_instancePathIndex, and m_instances.

Referenced by AddVariant(), ClearVariantField(), ClearVariantSymbolOverride(), CopyVariant(), DeleteVariant(), GetFieldText(), GetVariantLibSymbol(), RenameVariant(), SetFieldText(), SetInstanceProjectName(), SetPinMapOverride(), SetValueFieldText(), setVariantAttribute(), and SetVariantSymbolOverride().

◆ getInstance() [2/4]

const SCH_SYMBOL_INSTANCE * SCH_SYMBOL::getInstance ( const KIID_PATH & aPath ) const

private

Definition at line 5248 of file sch_symbol.cpp.

References m_instancePathIndex, and m_instances.

◆ getInstance() [3/4]

SCH_SYMBOL_INSTANCE * SCH_SYMBOL::getInstance ( const SCH_SHEET_PATH & aPath )

inlineprivate

Definition at line 1094 of file sch_symbol.h.

References getInstance(), and SCH_SHEET_PATH::Path().

Referenced by getInstance().

◆ getInstance() [4/4]

const SCH_SYMBOL_INSTANCE * SCH_SYMBOL::getInstance ( const SCH_SHEET_PATH & aPath ) const

inlineprivate

Definition at line 1095 of file sch_symbol.h.

References getInstance(), and SCH_SHEET_PATH::Path().

Referenced by getInstance().

◆ GetInstances()

const std::vector< SCH_SYMBOL_INSTANCE > & SCH_SYMBOL::GetInstances ( ) const

inline

Definition at line 133 of file sch_symbol.h.

References m_instances.

Referenced by SCH_SHEET_PATH::AddNewSymbolInstances(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), SCH_SHEET_PATH::CheckForMissingSymbolInstances(), SCH_SCREEN::CopyVariant(), SCH_SCREEN::DeleteVariant(), TEST_VARIANT_FIELD_RESOLUTION_FIXTURE::GetMutableInstance(), SCHEMATIC::GetSchematicsSharedByMultipleProjects(), DIALOG_CHANGE_SYMBOLS::getSymbolReferences(), SCH_SCREEN::GetVariantNames(), SCH_SCREEN::HasInstanceDataFromOtherProjects(), SCH_IO_EAGLE::loadModuleInstance(), SCH_EDITOR_CONTROL::Paste(), SCH_SCREEN::PruneOrphanedSymbolInstances(), PrunePastedSymbolInstances(), SCH_SCREEN::RenameVariant(), SCH_IO_KICAD_LEGACY::saveSymbol(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_SCREEN::SetLegacySymbolInstanceData(), SCH_EDITOR_CONTROL::setPastedSymbolInstances(), SymbolHasSheetInstances(), and SCH_EDITOR_CONTROL::updatePastedSymbol().

◆ GetItemDescription()

wxString SCH_SYMBOL::GetItemDescription	(	UNITS_PROVIDER *	aUnitsProvider,
		bool	aFull ) const

overridevirtual

Return a user-visible description string of this item.

This description is used in disambiguation menus, the message panel, ERC/DRC reports, etc.

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.

Parameters

aUnitsProvider	is the UNITS_PROVIDER object to handle item units.
aFull	is a flag to get the extend (full) description.

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 4139 of file sch_symbol.cpp.

References _, KIUI::EllipsizeMenuText(), GetField(), GetLibId(), and REFERENCE.

◆ GetKeyWords()

wxString SCH_SYMBOL::GetKeyWords ( ) const

overridevirtual

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

Implements SYMBOL.

Definition at line 1130 of file sch_symbol.cpp.

References m_part.

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 353 of file sch_item.h.

References m_layer.

◆ GetLibId()

const LIB_ID & SCH_SYMBOL::GetLibId ( ) const

inlineoverridevirtual

Implements SYMBOL.

Definition at line 163 of file sch_symbol.h.

References m_lib_id.

◆ GetLibPins()

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

Populate a vector with all the pins from the library object that match the current unit and bodyStyle.

Definition at line 2627 of file sch_symbol.cpp.

References SCH_ITEM::m_bodyStyle, m_part, and SCH_ITEM::m_unit.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), NETLIST_EXPORTER_ALLEGRO::extractComponentsInfo(), SCH_SCREEN::GetPin(), DIPTRACE_SCH_IMPORT_FIXTURE::LibPinCountForRefdesUnitOnSheet(), and DIPTRACE_SCH_IMPORT_FIXTURE::LibPinNamesForRefdesUnitOnSheet().

◆ GetLibSymbolRef() [1/2]

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

inline

Definition at line 182 of file sch_symbol.h.

References m_part.

◆ GetLibSymbolRef() [2/2]

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

inline

Definition at line 183 of file sch_symbol.h.

References m_part.

◆ GetMaxError()

int SCH_ITEM::GetMaxError ( ) const

inherited

Definition at line 990 of file sch_item.cpp.

References ARC_LOW_DEF_MM, Schematic(), and schIUScale.

Referenced by SCH_SHAPE::getMaxError(), and SCH_SHAPE::Plot().

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

References add_component.

◆ GetMirrorX()

bool SCH_SYMBOL::GetMirrorX ( ) const

inline

Definition at line 334 of file sch_symbol.h.

References GetOrientation(), and SYM_MIRROR_X.

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), and Serialize().

◆ GetMirrorY()

bool SCH_SYMBOL::GetMirrorY ( ) const

inline

Definition at line 351 of file sch_symbol.h.

References GetOrientation(), and SYM_MIRROR_Y.

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), and Serialize().

◆ 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

aFrame	is the EDA_DRAW_FRAME that displays the message panel
aList	is the list to populate.

Reimplemented from SCH_ITEM.

Definition at line 3752 of file sch_symbol.cpp.

References _, DESCRIPTION, KIUI::EllipsizeStatusText(), FOOTPRINT, SCH_EDIT_FRAME::GetCurrentSheet(), SCHEMATIC::GetCurrentVariant(), GetDNP(), LIB_SYMBOL::GetDummy(), EDA_ITEM::GetEditFlags(), GetExcludedFromBoard(), GetExcludedFromBOM(), GetExcludedFromSim(), GetField(), GetLibId(), LIB_ID::GetLibNickname(), GetRef(), m_lib_id, m_part, SCH_ITEM::Schematic(), UnescapeString(), and VALUE.

◆ GetNetChainName()

const wxString & SCH_SYMBOL::GetNetChainName ( ) const

inline

Definition at line 865 of file sch_symbol.h.

References m_signalName.

Referenced by BOOST_FIXTURE_TEST_CASE().

◆ GetNextFieldOrdinal()

int SCH_SYMBOL::GetNextFieldOrdinal ( ) const

Return the next ordinal for a user field for this symbol.

Definition at line 2268 of file sch_symbol.cpp.

References m_fields, and NextFieldOrdinal().

◆ GetOrientation()

int SCH_SYMBOL::GetOrientation ( ) const

overridevirtual

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.

Reimplemented from SYMBOL.

Definition at line 3624 of file sch_symbol.cpp.

References SYMBOL::GetTransform(), SYMBOL::m_transform, s_transformToOrientationCache, SCH_SYMBOL(), SetOrientation(), EDA_ITEM::SetParentGroup(), SYM_MIRROR_X, SYM_MIRROR_Y, SYM_NORMAL, SYM_ORIENT_0, SYM_ORIENT_180, SYM_ORIENT_270, and SYM_ORIENT_90.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGFX::SCH_PAINTER::draw(), GetMirrorX(), GetMirrorY(), GetOrientationProp(), GetPinSpinStyle(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCH_SELECTION_TOOL::Main(), orientLabel(), SCH_IO_KICAD_SEXPR::saveSymbol(), SetMirrorX(), SetMirrorY(), SetOrientationProp(), and SCH_EDIT_TOOL::Swap().

◆ GetOrientationProp()

SYMBOL_ORIENTATION_PROP SCH_SYMBOL::GetOrientationProp ( ) const

inline

Definition at line 305 of file sch_symbol.h.

References GetOrientation(), SYM_MIRROR_X, SYM_MIRROR_Y, SYM_NORMAL, SYM_ORIENT_0, SYM_ORIENT_180, SYM_ORIENT_270, SYM_ORIENT_90, SYMBOL_ANGLE_0, SYMBOL_ANGLE_180, SYMBOL_ANGLE_270, and SYMBOL_ANGLE_90.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), and Serialize().

◆ GetOrInitConnection()

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

inherited

Definition at line 813 of file sch_item.cpp.

References Connection(), CONNECTION_GRAPH, InitializeConnection(), and IsConnectable().

Referenced by BOOST_AUTO_TEST_CASE(), CONNECTION_SUBGRAPH::ExchangeItem(), and RESOLVE_DRIVERS_FIXTURE::MakeLabel().

◆ GetParent()

EDA_ITEM * EDA_ITEM::GetParent ( ) const

inlineinherited

Definition at line 112 of file eda_item.h.

References EDA_ITEM(), and m_parent.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_GROUP_TOOL::canGroupItem(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), SCHEMATIC_TEXT_VAR_ADAPTER::ExtractSourceKeys(), ORCAD_CONVERTER::finalizeNativePowerPackages(), findParent(), SCH_IO_KICAD_SEXPR::Format(), getClosestGroup(), SCH_TABLECELL::GetColumn(), SCH_TABLECELL::GetColumnWidth(), SCH_ITEM::GetEffectivePenWidth(), SCH_FIELD::GetFieldColor(), getInferredSymbols(), SCH_SHEET::GetNoConnects(), SCH_TABLECELL::GetParentGroup(), SCH_TABLECELL::GetRow(), SCH_TABLECELL::GetRowHeight(), SCH_ALIGN_TOOL::GetSelections(), SCH_TABLECELL::GetShownText(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_SELECTION_TOOL::highlight(), SCH_FIELD::HitTest(), SCH_FIELD::HitTest(), SCH_FIELD::HitTest(), SCH_ITEM::invalidateConnectivity(), IsGeneratedTableCell(), SCH_PIN::IsStacked(), SCH_EDIT_TOOL::JustifyText(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDIT_FRAME::onNetNavigatorSelection(), SCH_FIELD::OnScintillaCharAdded(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), SCH_MOVE_TOOL::prepareMoveOperation(), SCH_MOVE_TOOL::prepareSelection(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_SELECTION_TOOL::RequestSelection(), SCH_COMMIT::RevertToCheckpoint(), SCH_EDIT_TOOL::Rotate(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCHEMATIC::SCHEMATIC(), SCH_SCREEN::Schematic(), SCH_SHEET::SearchHierarchy(), PCB_SELECTION_TOOL::select(), SCH_TABLECELL::SetColumnWidth(), SCH_LABEL_BASE::SetLabelShape(), SCH_TABLECELL::SetRowHeight(), SCH_EDIT_TOOL::Swap(), SYMBOL_EDITOR_EDIT_TOOL::Swap(), SCH_ITEM::SwapItemData(), SCH_EDIT_TOOL::SwapPins(), ToProto(), SCHEMATIC_TEXT_VAR_ADAPTER::trackedItem(), DIALOG_FOOTPRINT_FIELDS_TABLE::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), BOARD_COMMIT::undoLevelItem(), SCH_COMMIT::undoLevelItem(), SCH_SELECTION_TOOL::unhighlight(), KIGFX::SCH_VIEW::Update(), DIALOG_FIELD_PROPERTIES::UpdateField(), SCH_BASE_FRAME::UpdateItem(), SCH_PROPERTIES_PANEL::valueChanged(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetParentGroup()

virtual EDA_GROUP * EDA_ITEM::GetParentGroup ( ) const

inlinevirtualinherited

Reimplemented in PCB_TABLECELL, and SCH_TABLECELL.

Definition at line 116 of file eda_item.h.

References m_group.

Referenced by EDA_GROUP::AddItem(), KICAD_DIFF::PCB_MERGE_APPLIER::Apply(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_DATA_TEST_CASE_F(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), EDIT_TOOL::DeleteItems(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), EDIT_TOOL::doMoveSelection(), BOARD_ITEM::Duplicate(), PCB_TABLE::Duplicate(), SCH_ITEM::Duplicate(), BOARD::ExchangeFootprint(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), TRACKS_CLEANER::filterItem(), MULTICHANNEL_TOOL::GeneratePotentialRuleAreas(), GENERATOR_TOOL::GENERATOR_TOOL(), getClosestGroup(), getClosestGroup(), PCB_TABLECELL::GetParentGroup(), SCH_TABLECELL::GetParentGroup(), GetParentGroupId(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), isExpandableMicrovia(), isInTuningPattern(), BOARD_ITEM::IsLocked(), SCH_ITEM::IsLocked(), PCB_SELECTION_TOOL::isWithinEnteredGroup(), memberOfGroupFunc(), BOARD_EDITOR_CONTROL::modifyLockSelected(), BOARD::Move(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_MOVE_TOOL::prepareMoveOperation(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), BOARD::Remove(), PNS_KICAD_IFACE::RemoveItem(), BOARD_COMMIT::RemoveOrDiscard(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), COMMIT::Stage(), BOARD_ITEM::SwapItemData(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), PCB_SELECTION_TOOL::unrouteSegment(), PCB_EDIT_FRAME::UpdateDesignBlockFromSelection(), SCH_EDIT_FRAME::UpdateDesignBlockFromSelection(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), BOARD_NETLIST_UPDATER::updateGroups(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), PCB_GROUP::WithinScope(), and SCH_GROUP::WithinScope().

◆ GetParentGroupId()

KIID EDA_ITEM::GetParentGroupId ( ) const

inherited

Definition at line 232 of file eda_item.cpp.

References GetParentGroup(), group, and niluuid.

Referenced by ITEM_PICKER::SetItem(), and ITEM_PICKER::SetLink().

◆ GetParentScreen()

SCH_SCREEN * SCH_ITEM::GetParentScreen ( ) const

inherited

Definition at line 308 of file sch_item.cpp.

References EDA_ITEM::findParent(), and SCH_SCREEN_T.

Referenced by SCH_SHEET::AddPin(), AutoPlaceSheetPins(), BOOST_DATA_TEST_CASE_F(), SCH_LABEL_BASE::cacheShownText(), SCH_SHEET::CleanupSheet(), SCH_SHEET::Deserialize(), SCH_SYMBOL::Deserialize(), invalidateConnectivity(), operator=(), SCH_SHEET::RemovePin(), SCH_COMMIT::Stage(), SwapItemData(), unpackLabel(), and SCH_SYMBOL::UpdatePins().

◆ GetParentSymbol() [1/2]

SYMBOL * SCH_ITEM::GetParentSymbol ( )

inherited

Definition at line 362 of file sch_item.cpp.

References EDA_ITEM::findParent(), LIB_SYMBOL, LIB_SYMBOL_T, and SCH_SYMBOL_T.

◆ GetParentSymbol() [2/2]

const SYMBOL * SCH_ITEM::GetParentSymbol ( ) const

inherited

Definition at line 350 of file sch_item.cpp.

References EDA_ITEM::findParent(), LIB_SYMBOL, LIB_SYMBOL_T, and SCH_SYMBOL_T.

Referenced by addCreateNetChainBetweenPinsIfApplicable(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), SCH_CONNECTIVITY::NETCHAIN_MANAGER::buildBridgeAdjacency(), SCH_GROUP_TOOL::canGroupItem(), SCH_PIN::compare(), compareDrivers(), SCH_PIN::ComparisonData(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SCH_EDITOR_CONTROL::CreateNetChainBetweenPins(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::EditField(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), CONNECTION_GRAPH::ercCheckNoConnects(), NETLIST_EXPORTER_ALLEGRO::extractComponentsInfo(), SCH_SELECTION_TOOL::FilterCollectorForHierarchy(), PIN_INFO_FORMATTER::Format(), GetBodyStyleDescription(), SCH_PIN::GetDefaultNetName(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_PIN::GetEffectivePadNumber(), SCH_PIN::GetEffectivePadNumber(), GetEmbeddedFonts(), SCH_FIELD::GetFullText(), SCH_PIN::GetItemDescription(), SCH_PROPERTIES_PANEL::getItemValue(), GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_PIN::GetPinRoot(), SCH_PIN::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), GetUnitDisplayName(), SCH_PIN::IsGlobalPower(), SCH_PIN::IsLocalPower(), SCH_FIELD::IsLocked(), SCH_PIN::IsLocked(), SCH_PIN::MirrorHorizontally(), SCH_PIN::MirrorVertically(), NETLIST_EXPORTER_ALLEGRO::NET_NODE::operator<(), orientLabel(), SCH_PIN::Plot(), BACK_ANNOTATE::processNetNameChange(), ORCAD_CONVERTER::recordNetNameMap(), SCH_PIN::Replace(), NETLIST_EXPORTER_BASE::resolvePadNumbers(), SCH_PIN::Rotate(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_ITEM_DESC::SCH_ITEM_DESC(), SetBodyStyleProp(), SCH_SHAPE::SetFilled(), SetUnitString(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDIT_FRAME::UpdateDesignBlockFromSelection(), PIN_INFO_FORMATTER::UpdatePin(), and SCH_PROPERTIES_PANEL::valueChanged().

◆ GetPassthroughMode()

PASSTHROUGH_MODE SCH_SYMBOL::GetPassthroughMode ( ) const

inline

Definition at line 855 of file sch_symbol.h.

References m_passthroughMode.

Referenced by HasConnectivityChanges(), SCH_IO_KICAD_SEXPR::saveSymbol(), and Serialize().

◆ 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_BUS_ENTRY, SCH_BUS_ENTRY_BASE, SCH_BUS_WIRE_ENTRY, SCH_DIRECTIVE_LABEL, SCH_FIELD, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 372 of file sch_item.h.

Referenced by SCH_DRAG_NET_COLLISION_MONITOR::collectDisconnectedMarkers(), EE_RTREE::contains(), GetEffectivePenWidth(), EE_RTREE::insert(), and EE_RTREE::remove().

◆ GetPin() [1/3]

const SCH_PIN * SCH_SYMBOL::GetPin ( const VECTOR2I & aPosition ) const

Return the SCH_PIN object found at aPosition.

Parameters

aPosition is the position of the pin to fetch.

Returns: the SCH_PIN object found at aPosition or nullptr.

Definition at line 2606 of file sch_symbol.cpp.

References ALL_BODY_STYLES, ALL_UNITS, SCH_ITEM::GetBodyStyle(), SCH_ITEM::GetUnit(), m_pins, and pin.

◆ GetPin() [2/3]

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

References m_pins, and pin.

Referenced by BACK_ANNOTATE::applyChangelist(), BACK_ANNOTATE::applyPinSwaps(), SCH_SELECTION_TOOL::autostartEvent(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), CONNECTION_GRAPH::ercCheckNoConnects(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), MapLibPins(), operator==(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), ResolveTextVar(), and CONNECTION_GRAPH::updateSymbolConnectivity().

◆ GetPin() [3/3]

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

Returns: the instance SCH_PIN associated with a particular SCH_PIN from the LIB_SYMBOL.

Definition at line 2651 of file sch_symbol.cpp.

References m_pinMap.

◆ GetPinByEffectivePadNumber()

SCH_PIN * SCH_SYMBOL::GetPinByEffectivePadNumber	(	const wxString &	aPadNumber,
		const SCH_SHEET_PATH *	aSheet,
		const wxString &	aVariantName = wxEmptyString ) const

Find the pin whose effective footprint pad number (issue #2282) is aPadNumber on aSheet, expanding bracketed stacked targets.

This is the reverse of pin-to-pad resolution, used by cross-probe (PCB pad -> schematic pin).

Returns: the owning SCH_PIN, or nullptr if no pin resolves to that pad.

Definition at line 2573 of file sch_symbol.cpp.

References ExpandStackedPinNotation(), m_pins, pad, and pin.

Referenced by SCH_EDITOR_CONTROL::FindSymbolAndItem().

◆ GetPinMapOverride()

PIN_MAP_INSTANCE_OVERRIDE SCH_SYMBOL::GetPinMapOverride	(	const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString ) const

Returns: the pin-to-pad map override in effect for the given sheet/variant.

A DELEGATE_TO_UNIT_1 override is resolved here by returning unit 1's override, so callers never have to special-case multi-unit delegation.

Definition at line 1960 of file sch_symbol.cpp.

References GetInstance(), m_pinMapOverride, SCH_SYMBOL_INSTANCE::m_Variants, SCH_SHEET_PATH::Path(), resolveDelegatedPinMapOverride(), and result.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_SYMBOL_VARIANT::InitializeAttributes(), PackSymbol(), resolveDelegatedPinMapOverride(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_SYMBOL_PIN_MAP_MODE_PROPERTY::setter(), SCH_SYMBOL_PIN_MAP_NAME_PROPERTY::setter(), SyncOtherUnits(), SCH_SYMBOL_PIN_MAP_MODE_PROPERTY::ValueForInstance(), and SCH_SYMBOL_PIN_MAP_NAME_PROPERTY::ValueForInstance().

◆ GetPinNameOffset()

int SYMBOL::GetPinNameOffset ( ) const

inlineinherited

Definition at line 163 of file symbol.h.

References m_pinNameOffset.

Referenced by BOOST_AUTO_TEST_CASE(), LIB_SYMBOL::GetPinNamesInsideProp(), PIN_LAYOUT_CACHE::GetPinNumberInfo(), LIB_SYMBOL_DESC::LIB_SYMBOL_DESC(), SCH_PIN::Plot(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), LIB_SYMBOL::Serialize(), SCH_SYMBOL::Serialize(), and LIB_SYMBOL::SetPinNamesInsideProp().

◆ GetPinPhysicalPosition()

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

Definition at line 4036 of file sch_symbol.cpp.

References SCH_PIN::GetPosition(), m_pos, SYMBOL::m_transform, SCH_PIN_T, and EDA_ITEM::Type().

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

◆ GetPins() [1/2]

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

Definition at line 2686 of file sch_symbol.cpp.

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

◆ GetPins() [2/2]

std::vector< const SCH_PIN * > SCH_SYMBOL::GetPins ( const SCH_SHEET_PATH * aSheet ) 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 2663 of file sch_symbol.cpp.

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

◆ GetPinsByNumber()

std::vector< SCH_PIN * > SCH_SYMBOL::GetPinsByNumber ( const wxString & aNumber ) const

Find all symbol pins with the given number.

This is useful for symbols that intentionally have multiple pins with the same number, such as jumper symbols where duplicate pin numbers are internally connected.

Parameters

aNumber is the number of the pins to find.

Returns: Vector of matching pin objects, empty if none found.

Definition at line 2592 of file sch_symbol.cpp.

References m_pins, and pin.

Referenced by BOOST_FIXTURE_TEST_CASE().

◆ GetPosition()

VECTOR2I SCH_SYMBOL::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 895 of file sch_symbol.h.

References m_pos.

◆ GetPrefix()

wxString SCH_SYMBOL::GetPrefix ( ) const

inline

Definition at line 238 of file sch_symbol.h.

References m_prefix.

Referenced by SIM_LIB_MGR::CaptureModelInput(), SCH_IO_KICAD_LEGACY::saveSymbol(), and SCH_IO_KICAD_SEXPR::saveSymbol().

◆ GetRawPins() [1/2]

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

inline

Definition at line 678 of file sch_symbol.h.

References m_pins.

Referenced by ORCAD_CONVERTER::assignPinUuids(), ORCAD_CONVERTER::assignRemainingUuids(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), and SCH_IO_KICAD_SEXPR::saveSymbol().

◆ GetRawPins() [2/2]

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

inline

Definition at line 679 of file sch_symbol.h.

References m_pins.

◆ GetRef()

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

overridevirtual

Returns: the reference for the instance on the given sheet.

Implements SYMBOL.

Definition at line 1507 of file sch_symbol.cpp.

References GetField(), UTIL::GetRefDesUnannotated(), SCH_FIELD::GetText(), GetUnitCount(), m_instancePathIndex, m_instances, m_prefix, SCH_SYMBOL_INSTANCE::m_Reference, SCH_SYMBOL_INSTANCE::m_Unit, EDA_ITEM::m_Uuid, SCH_SHEET_PATH::Path(), path, REFERENCE, SCH_SHEET_PATH::size(), SubReference(), and traceSchSymbolRef.

◆ GetRefProp()

wxString SCH_SYMBOL::GetRefProp ( ) const

Definition at line 63 of file sch_symbol.cpp.

References GetRef(), and SCH_ITEM::Schematic().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ getRenderSettings()

SCH_RENDER_SETTINGS * SCH_ITEM::getRenderSettings ( PLOTTER * aPlotter ) const

protectedinherited

Definition at line 46 of file sch_item.cpp.

References PLOTTER::RenderSettings().

Referenced by LIB_SYMBOL::Plot(), SCH_BUS_ENTRY_BASE::Plot(), SCH_FIELD::Plot(), SCH_LINE::Plot(), SCH_NO_CONNECT::Plot(), SCH_PIN::Plot(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), SCH_SHEET::Plot(), SCH_SYMBOL::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_SYMBOL::PlotDNP(), LIB_SYMBOL::PlotFields(), SCH_SYMBOL::PlotPins(), SCH_PIN::PlotPinTexts(), and SCH_PIN::PlotPinType().

◆ GetRolloverPos()

VECTOR2I EDA_ITEM::GetRolloverPos ( ) const

inlineinherited

Definition at line 143 of file eda_item.h.

References m_rolloverPos.

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

◆ GetRuleAreaCache()

const std::unordered_set< SCH_RULE_AREA * > & SCH_ITEM::GetRuleAreaCache ( ) const

inlineinherited

Get the cache of rule areas enclosing this item.

Definition at line 733 of file sch_item.h.

References m_rule_areas_cache.

Referenced by BOOST_AUTO_TEST_CASE(), CONNECTION_SUBGRAPH::GetNetclassesForDriver(), and NETLIST_EXPORTER_XML::getSheetComponentClasses().

◆ GetSchSymbolLibraryName()

wxString SCH_SYMBOL::GetSchSymbolLibraryName ( ) const

◆ GetShownDescription()

wxString SCH_SYMBOL::GetShownDescription	(	RESOLUTION_CONTEXT	aContext,
		int	aDepth = 0 ) const

overridevirtual

Implements SYMBOL.

Definition at line 1121 of file sch_symbol.cpp.

References m_part.

Referenced by SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_XML::makeSymbols(), Matches(), and ResolveTextVar().

◆ GetShownKeyWords()

wxString SCH_SYMBOL::GetShownKeyWords	(	RESOLUTION_CONTEXT	aContext,
		int	aDepth = 0 ) const

overridevirtual

Implements SYMBOL.

Definition at line 1139 of file sch_symbol.cpp.

References m_part.

Referenced by Matches(), and ResolveTextVar().

◆ GetShowPinNames()

bool SCH_SYMBOL::GetShowPinNames ( ) const

overridevirtual

Reimplemented from SYMBOL.

Definition at line 4691 of file sch_symbol.cpp.

References m_part.

Referenced by BOOST_AUTO_TEST_CASE(), and Serialize().

◆ GetShowPinNumbers()

bool SCH_SYMBOL::GetShowPinNumbers ( ) const

overridevirtual

Reimplemented from SYMBOL.

Definition at line 4704 of file sch_symbol.cpp.

References m_part.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and Serialize().

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

References GetPosition().

◆ GetStoredPos()

VECTOR2I & SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 314 of file sch_item.h.

References m_storedPos.

Referenced by SCH_MOVE_TOOL::updateStoredPositions().

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 691 of file sch_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ GetSymbolIDAsString()

wxString SCH_SYMBOL::GetSymbolIDAsString ( ) const

inline

Definition at line 165 of file sch_symbol.h.

References m_lib_id.

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 183 of file eda_item.h.

References CANDIDATE, CONNECTIVITY_CANDIDATE, IS_LINKED, m_flags, SELECTED_BY_DRAG, SELECTION_CANDIDATE, and SKIP_STRUCT.

Referenced by ClearTempFlags(), and SCH_ITEM::SwapFlags().

◆ GetTransform() [1/2]

TRANSFORM & SYMBOL::GetTransform ( )

inlineinherited

Definition at line 248 of file symbol.h.

References m_transform.

◆ GetTransform() [2/2]

const TRANSFORM & SYMBOL::GetTransform ( ) const

inlineinherited

Definition at line 247 of file symbol.h.

References m_transform.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_CONNECTIVITY::ExtractInstanceFacts(), SCH_FIELD::GetDrawRotation(), SCH_SYMBOL::GetOrientation(), SCH_FIELD::GetPosition(), GetRelativePosition(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_MOVE_TOOL::moveItem(), SCH_SYMBOL::operator==(), EASYPC::SCH_BUILDER::placeFields(), ORCAD_CONVERTER::placeInstance(), ORCAD_CONVERTER::placePowerSymbol(), ORCAD_CONVERTER::placeSymbolFields(), SCH_SYMBOL::Plot(), SCH_SYMBOL::PlotLocalPowerIconShape(), SCH_SYMBOL::PlotPins(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_IO_KICAD_LEGACY::saveSymbol(), and SCH_FIELD::SetPosition().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

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

Definition at line 556 of file eda_item.cpp.

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

Referenced by EDIT_TOOL::doMoveSelection(), and GetFriendlyName().

◆ GetUnit()

int SCH_ITEM::GetUnit ( ) const

inlineinherited

Definition at line 243 of file sch_item.h.

References m_unit.

◆ GetUnitCount()

int SCH_SYMBOL::GetUnitCount ( ) const

overridevirtual

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.

Implements SYMBOL.

Definition at line 1349 of file sch_symbol.cpp.

References m_part.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), SCH_EDIT_FRAME::DeleteAnnotation(), NETLIST_EXPORTER_XML::getComponentClassNamesForAllSymbolUnits(), GetRef(), GetUnplacedUnitsForSymbol(), DIALOG_EDIT_SYMBOLS_LIBID::initDlg(), IsMultiUnit(), SCH_FIELD::Matches(), SyncOtherUnits(), DIALOG_FIELD_PROPERTIES::TransferDataToWindow(), and DIPTRACE_SCH_IMPORT_FIXTURE::UnitCountForRefdes().

◆ GetUnitDisplayName()

wxString SCH_SYMBOL::GetUnitDisplayName	(	int	aUnit,
		bool	aLabel ) const

overridevirtual

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.

Reimplemented from SCH_ITEM.

Definition at line 1376 of file sch_symbol.cpp.

References _, m_part, and SubReference().

Referenced by DIALOG_FIELD_PROPERTIES::TransferDataToWindow(), and SYMBOL_UNIT_MENU::update().

◆ GetUnitProp()

int SCH_SYMBOL::GetUnitProp ( ) const

Definition at line 75 of file sch_symbol.cpp.

References GetUnitSelection(), and SCH_ITEM::Schematic().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

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

References m_instancePathIndex, m_instances, SCH_ITEM::m_unit, SCH_SHEET_PATH::Path(), and path.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::applyChangelist(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGFX::SCH_PAINTER::draw(), SCH_CONNECTIVITY::ExtractInstanceFacts(), NETLIST_EXPORTER_XML::getComponentClassNamesForAllSymbolUnits(), GetPins(), GetPins(), GetUnitProp(), HasConnectivityChanges(), SCH_FIELD::Matches(), CONNECTION_GRAPH::Recalculate(), ORCAD_CONVERTER::recordNetNameMap(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), SyncOtherUnits(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

◆ GetUnitString()

wxString SCH_ITEM::GetUnitString ( ) const

virtualinherited

Definition at line 269 of file sch_item.cpp.

References GetUnitDisplayName(), and m_unit.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ GetValue()

const wxString SCH_SYMBOL::GetValue	(	const SCH_SHEET_PATH *	aPath,
		RESOLUTION_CONTEXT	aContext,
		const wxString &	aVariantName = wxEmptyString ) const

overridevirtual

Returns: the value for the instance on the given sheet.

Implements SYMBOL.

Definition at line 2131 of file sch_symbol.cpp.

References ExpandTextVars(), LIB_SYMBOL::GetField(), GetField(), SCH_FIELD::GetName(), SCH_FIELD::GetShownText(), SCH_FIELD::GetText(), GetVariant(), GetVariantLibSymbol(), SCH_ITEM::LIB_SYMBOL, ResolveTextVar(), and VALUE.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), SCH_EDIT_FRAME::DeleteAnnotation(), SCH_CONNECTIVITY::ExtractInstanceFacts(), SCH_PIN::GetDefaultNetName(), GetValueProp(), HasConnectivityChanges(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), SyncOtherUnits(), NETLIST_EXPORTER_ALLEGRO::toAllegroPackages(), NETLIST_EXPORTER_CADSTAR::writeNetlist(), NETLIST_EXPORTER_ORCADPCB2::writeNetlist(), and NETLIST_EXPORTER_PADS::writeNetlist().

◆ GetValueProp()

wxString SCH_SYMBOL::GetValueProp ( ) const

Definition at line 69 of file sch_symbol.cpp.

References GetValue(), RAW_VALUE, and SCH_ITEM::Schematic().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ GetVariant()

std::optional< SCH_SYMBOL_VARIANT > SCH_SYMBOL::GetVariant	(	const SCH_SHEET_PATH &	aInstance,
		const wxString &	aVariantName ) const

Definition at line 4838 of file sch_symbol.cpp.

References GetInstance(), SCH_SYMBOL_INSTANCE::m_Variants, and SCH_SHEET_PATH::Path().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), SCH_EDIT_TOOL::ClearVariantSymbol(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), GetValue(), SCH_EDIT_TOOL::Init(), and SYMBOL_FIELDS_EDITOR_GRID_TRICKS::showFieldsTablePopupMenu().

◆ GetVariantLibSymbol()

LIB_SYMBOL * SCH_SYMBOL::GetVariantLibSymbol	(	const wxString &	aVariantName,
		const SCH_SHEET_PATH &	aPath ) const

Resolve the alternate library symbol for a given variant.

Looks up the variant's symbol override and resolves the LIB_ID through the project's symbol library adapter. Returns nullptr if the variant has no override or if the LIB_ID cannot be resolved.

Parameters

aVariantName	the variant to resolve.
aPath	the sheet path for this instance.

Returns: the resolved flattened library symbol, or nullptr.

Definition at line 4863 of file sch_symbol.cpp.

References empty(), LIB_ID::Format(), getInstance(), SCH_ITEM::LIB_SYMBOL, SYMBOL_LIBRARY_ADAPTER::LoadSymbol(), m_lib_id, m_part, SCH_SYMBOL_VARIANT::m_SymbolOverride, SCH_SYMBOL_INSTANCE::m_Variants, m_variantSymbolCache, SCH_ITEM::Schematic(), PROJECT_SCH::SymbolLibAdapter(), and ValidateVariantSymbolCompatibility().

Referenced by GetEffectiveLibSymbol(), GetFieldText(), getFootprintChooserSymbolNetlist(), GetValue(), NETLIST_EXPORTER_XML::makeSymbols(), and SetFieldText().

◆ GetX()

int SCH_SYMBOL::GetX ( ) const

inline

Definition at line 898 of file sch_symbol.h.

References GetPosition(), and VECTOR2< T >::x.

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), and SetY().

◆ GetY()

int SCH_SYMBOL::GetY ( ) const

inline

Definition at line 901 of file sch_symbol.h.

References GetPosition(), and VECTOR2< T >::y.

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), and SetX().

◆ HasBrightenedPins()

bool SCH_SYMBOL::HasBrightenedPins ( )

Definition at line 4667 of file sch_symbol.cpp.

References m_pins, and pin.

◆ HasBusConnection()

bool SCH_ITEM::HasBusConnection ( const SCH_SHEET_PATH * aSheet = nullptr ) const

inherited

Definition at line 720 of file sch_item.cpp.

References Connection(), ADVANCED_CFG::GetCfg(), SCH_CONNECTION::IsBus(), and publishedConnection().

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_LABEL_BASE::Plot(), and SCH_EDITOR_CONTROL::SimProbe().

◆ HasCachedDriverName()

virtual bool SCH_ITEM::HasCachedDriverName ( ) const

inlinevirtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 663 of file sch_item.h.

Referenced by CONNECTION_SUBGRAPH::GetNameForDriver().

◆ HasConnectivityChanges()

bool SCH_SYMBOL::HasConnectivityChanges	(	const SCH_ITEM *	aItem,
		const SCH_SHEET_PATH *	aInstance = nullptr ) const

overridevirtual

Check if aItem has connectivity changes against this object.

This provides granular per object connectivity change testing to prevent the need to rebuild the CONNECTION_GRAPH when object properties that have nothing to do with the schematic connectivity changes i.e. color, thickness, fill type. etc.

Note: Developers should override this method for all objects that are connectable.

Parameters

aItem	is the item to test for connectivity changes.
aInstance	is the instance to test for connectivity changes. This parameter is only meaningful for SCH_SYMBOL objects.

Returns: true if there are connectivity changes otherwise false.

Reimplemented from SCH_ITEM.

Definition at line 4045 of file sch_symbol.cpp.

References FOR_NETNAME, GetLibId(), GetPassthroughMode(), GetPosition(), GetRef(), GetUnitSelection(), GetValue(), HasConnectivityChanges(), IsPower(), m_pins, pin, SCH_ITEM::SCH_ITEM(), and SCH_SYMBOL().

Referenced by HasConnectivityChanges().

◆ HasCustomProperties()

bool EDA_ITEM::HasCustomProperties ( ) const

inlineinherited

Definition at line 269 of file eda_item.h.

References m_customProperties.

Referenced by KICAD_FORMAT::FormatCustomProperties().

◆ HasDeMorganBodyStyles()

bool SCH_SYMBOL::HasDeMorganBodyStyles ( ) const

overridevirtual

Implements SYMBOL.

Definition at line 1367 of file sch_symbol.cpp.

References m_part.

Referenced by BODY_STYLE_MENU::update().

◆ HasEffectiveAssociatedFootprint()

bool SCH_SYMBOL::HasEffectiveAssociatedFootprint ( ) const

Definition at line 702 of file sch_symbol.cpp.

References GetLibSymbolRef().

Referenced by GetDynamicProperties(), and SCH_PROPERTIES_PANEL::getSinglePinMappedSymbol().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 168 of file eda_item.h.

References m_flags.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), BOOST_AUTO_TEST_CASE(), BOARD::BulkRemoveStaleTeardrops(), GRAPHICS_CLEANER::cleanupShapes(), PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), SYMBOL_EDIT_FRAME::ClearUndoORRedoList(), SCH_EDIT_TOOL::DoDelete(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_MOVE_TOOL::findTargetSheet(), PCB_TUNING_PATTERN::Flip(), SYMBOL_EDIT_FRAME::freeTransientUndoCommands(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), ZONE::IsConflicting(), SCH_SCREEN::MarkConnections(), PCB_TUNING_PATTERN::Mirror(), PCB_TUNING_PATTERN::Move(), MoveSchematicItem(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_MOVE_TOOL::performItemMove(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), GERBVIEW_FRAME::RemapLayers(), SCH_POINT_EDITOR::Reset(), PCB_TUNING_PATTERN::Rotate(), SCH_EDIT_TOOL::Rotate(), ISSUE22864_FIXTURE::RunAlignmentAndVerify(), ISSUE22864_FIXTURE::RunAlignmentAndVerifyNoSkew(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), PCB_SELECTION_TOOL::selectAllConnectedShapes(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), SCH_SELECTION_TOOL::SelectMultiple(), PCB_VIA::SetSizeFromRules(), SCH_COMMIT::Stage(), TRACKS_CLEANER::testTrackEndpointIsNode(), SCH_MOVE_TOOL::trimDanglingLines(), SCH_FIND_REPLACE_TOOL::UpdateFind(), and PCB_TUNING_PATTERN::ViewDraw().

◆ HasHoveredHypertext()

virtual bool SCH_ITEM::HasHoveredHypertext ( ) const

inlinevirtualinherited

Indicates that a hypertext link is currently active.

(Note that the default implementation here only handles the simple case.)

Reimplemented in SCH_TEXT, and SCH_TEXTBOX.

Definition at line 346 of file sch_item.h.

References HasHypertext(), and EDA_ITEM::IsRollover().

Referenced by SCH_SELECTION_TOOL::Main().

◆ HasHypertext()

virtual bool SCH_ITEM::HasHypertext ( ) const

inlinevirtualinherited

Indicates that the item has at least one hypertext action.

This could be a URL assigned to the item as a whole, or one (or more) urls within the text of the item.

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 340 of file sch_item.h.

Referenced by HasHoveredHypertext(), and RenderAsBitmap().

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

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ HasSelectedAncestorGroup()

bool EDA_ITEM::HasSelectedAncestorGroup ( ) const

inherited

Returns: true if any ancestor group (recursively) of this item is currently selected. Group members do not carry the SELECTED flag themselves, so callers that need to know whether an item is moving as part of a group selection should use this helper.

Definition at line 241 of file eda_item.cpp.

References EDA_ITEM(), and group.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and SCH_MOVE_TOOL::getConnectedDragItems().

◆ HitTest() [1/3]

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

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

◆ HitTest() [2/3]

bool SCH_SYMBOL::HitTest	(	const SHAPE_LINE_CHAIN &	aPoly,
		bool	aContained ) const

overridevirtual

Test if aPoly intersects this item.

Parameters

aPoly	A reference to a SHAPE_LINE_CHAIN object containing the polygon or polyline to test.
aContained	Set to true to test for containment instead of an intersection.

Returns: True if aPoly contains or intersects the item.

Reimplemented from EDA_ITEM.

Definition at line 4385 of file sch_symbol.cpp.

References KIGEOM::BoxHitTest(), GetBodyBoundingBox(), EDA_ITEM::m_flags, SKIP_STRUCT, and STRUCT_DELETED.

◆ HitTest() [3/3]

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

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

◆ Init()

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

private

Definition at line 803 of file sch_symbol.cpp.

References BASE, DATASHEET, DEFAULT, DESCRIPTION, FOOTPRINT, GetDefaultFieldName(), LAYER_DEVICE, LAYER_FIELDS, LAYER_REFERENCEPART, LAYER_VALUEPART, SCH_ITEM::m_bodyStyle, m_doNetlist, m_fields, SCH_ITEM::m_layer, m_passthroughMode, m_pos, m_prefix, m_signalName, SYMBOL::m_transform, SCH_ITEM::m_unit, REFERENCE, UNTRANSLATED, and VALUE.

Referenced by SCH_SYMBOL(), and 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

[in]	aPath	is the sheet path to initialize.
[in]	aGraph	is the connection graph to initialize.

Definition at line 790 of file sch_item.cpp.

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

Referenced by cloneWireConnection(), GetOrInitConnection(), and CONNECTION_GRAPH::updateGenericItemConnectivity().

◆ invalidateConnectivity()

void SCH_ITEM::invalidateConnectivity ( KICAD_T aChangedType = TYPE_NOT_INIT )

protectedinherited

Bump the parent screen's connectivity revision when this item, or the item owning it as a child, is on its draw list.

Call it from each setter that changes captured state.

Parameters

aChangedType is passed to SCH_SCREEN::BumpConnectivityRevision().

Definition at line 323 of file sch_item.cpp.

References SCH_SCREEN::BumpConnectivityRevision(), SCH_SCREEN::CheckIfOnDrawList(), EDA_ITEM::GetParent(), GetParentScreen(), NO_RECURSE, and SCH_ITEM().

Referenced by SCH_LABEL_BASE::AddField(), SCH_SHEET::AddField(), SCH_SYMBOL::AddField(), SCH_LABEL_BASE::AddFields(), SCH_SYMBOL::AddHierarchicalReference(), SCH_SHEET::AddVariant(), SCH_SYMBOL::AddVariant(), SCH_LABEL_BASE::cacheShownText(), SCH_SHEET::ClearVariantField(), SCH_SYMBOL::ClearVariantField(), SCH_SYMBOL::ClearVariantSymbolOverride(), SCH_SHEET::CopyVariant(), SCH_SYMBOL::CopyVariant(), SCH_SHEET::DeleteVariant(), SCH_SYMBOL::DeleteVariant(), SCH_LABEL_BASE::Move(), SCH_FIELD::operator=(), SCH_SYMBOL::RemoveField(), SCH_SYMBOL::RemoveInstance(), SCH_SHEET::RenameVariant(), SCH_SYMBOL::RenameVariant(), SetConnectivityDirty(), SCH_LABEL_BASE::SetFields(), SCH_SHEET::SetFieldText(), SCH_SYMBOL::SetFieldText(), SCH_FIELD::SetName(), SCH_SYMBOL::SetRef(), SCH_FIELD::SetText(), SCH_SYMBOL::SetUnitSelection(), SCH_SHEET::setVariantAttribute(), SCH_SYMBOL::setVariantAttribute(), and SCH_SYMBOL::SetVariantSymbolOverride().

◆ IsAnnotated()

bool SCH_SYMBOL::IsAnnotated ( const SCH_SHEET_PATH * aSheet ) const

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

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

Referenced by SCH_EDIT_FRAME::DeleteAnnotation(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SyncOtherUnits(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ IsBOARD_ITEM()

bool KIGFX::VIEW_ITEM::IsBOARD_ITEM ( ) const

inlineinherited

Definition at line 98 of file view_item.h.

References m_isBOARD_ITEM.

Referenced by KIGFX::PCB_VIEW::Add(), PCB_GROUP_TOOL::canGroupItem(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::Draw(), EDA_ITEM::EDA_ITEM(), PCB_BASE_FRAME::FocusOnItem(), PCB_PROPERTIES_PANEL::getPropertyFromEvent(), KIGFX::PCB_PAINTER::HasUniformColor(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), GENERAL_COLLECTOR::Inspect(), BOARD::Move(), PCB_GRID_HELPER::nearestAnchor(), PCB_GRID_HELPER::OnBoardItemRemoved(), PCB_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), KIGFX::PCB_VIEW::Remove(), PCB_GRID_HELPER::ResolveSnap(), BOARD_COMMIT::RevertToCheckpoint(), GRAPHIC_EDIT_TOOL::runInteractive(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::SelectAll(), PCB_EDIT_FRAME::SetPageSettings(), PCB_BASE_FRAME::SetPlotSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), BOARD_COMMIT::Stage(), EDIT_TOOL::Swap(), BOARD_COMMIT::undoLevelItem(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), PCB_SELECTION_TOOL::UnselectAll(), KIGFX::PCB_VIEW::Update(), KIGFX::PCB_VIEW::UpdateCollidingItems(), EDIT_TOOL::updateModificationPoint(), and DIALOG_POSITION_RELATIVE::UpdatePickedItem().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 136 of file eda_item.h.

References BRIGHTENED, m_flags, and m_netHighlighted.

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

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

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

Referenced by JUNCTION_HELPERS::AnalyzePoint(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_MOVE_TOOL::getConnectedItems(), SCH_SCREEN::IsTerminalPoint(), and SCH_SCREEN::MarkConnections().

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( ) const

inlineinherited

◆ IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_DIRECTIVE_LABEL, SCH_LABEL_BASE, SCH_LINE, and SCH_PIN.

Definition at line 538 of file sch_item.h.

◆ IsEndPoint()

virtual bool SCH_ITEM::IsEndPoint ( const VECTOR2I & aPt ) const

inlinevirtualinherited

Test if aPt is an end point of this schematic object.

Note: The end point test doe not imply electrical connectivity. See IsConnectable(). In other words all connection points are end points but not all end points are connection points such as graphical lines and arcs. Override this method for all objects that have end points.

Parameters

aPt	is the coordinate to test for an end point.

Return values

true	if aPt is an end point.
false	if aPt is not an end point.

Reimplemented in SCH_LINE, and SCH_SHAPE.

Definition at line 536 of file sch_item.h.

Referenced by SCH_SCREEN::MarkConnections().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 135 of file eda_item.h.

References ENTERED, and m_flags.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), and KIGFX::SCH_PAINTER::draw().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 233 of file eda_item.h.

References m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_FIELD::Plot(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ IsGlobalPower()

bool SCH_SYMBOL::IsGlobalPower ( ) const

overridevirtual

Implements SYMBOL.

Definition at line 4783 of file sch_symbol.cpp.

References m_part.

Referenced by BOOST_AUTO_TEST_CASE(), IsPower(), and IsSymbolLikePowerGlobalLabel().

◆ IsGroupableType()

bool SCH_ITEM::IsGroupableType ( ) const

inherited

◆ IsLocalPower()

bool SCH_SYMBOL::IsLocalPower ( ) const

overridevirtual

Implements SYMBOL.

Definition at line 4774 of file sch_symbol.cpp.

References m_part.

Referenced by IsPower(), IsSymbolLikePowerLocalLabel(), and ResolveTextVar().

◆ IsLocked()

bool SCH_ITEM::IsLocked ( ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in SCH_PIN, and SCH_SHEET_PIN.

Definition at line 179 of file sch_item.cpp.

References EDA_ITEM::GetParentGroup(), group, and m_isLocked.

◆ 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: LIB_SYMBOL::GetDummy()

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

Definition at line 1052 of file sch_symbol.cpp.

References m_part.

Referenced by SCH_EDIT_TOOL::EditProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsAdded(), DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsChanged(), POWER_SEARCH_HANDLER::Search(), and SYMBOL_SEARCH_HANDLER::Search().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 130 of file eda_item.h.

References IS_CHANGED, and 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 1058 of file sch_symbol.cpp.

References m_pins, m_pos, pin, and schIUScale.

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

◆ IsMultiBodyStyle()

bool SCH_SYMBOL::IsMultiBodyStyle ( ) const

inlineoverridevirtual

Returns: true if the symbol has multiple body styles available.

Implements SYMBOL.

Definition at line 264 of file sch_symbol.h.

References GetBodyStyleCount().

Referenced by BODY_STYLE_MENU::update().

◆ IsMultiUnit()

bool SCH_SYMBOL::IsMultiUnit ( ) const

inlineoverridevirtual

Returns: true if the symbol has multiple units per symbol.

Implements SYMBOL.

Definition at line 255 of file sch_symbol.h.

References GetUnitCount().

Referenced by PlaceRemoteDownloadedSymbol().

◆ IsNetHighlighted()

bool EDA_ITEM::IsNetHighlighted ( ) const

inherited

Net highlighting must not clear brightening owned by find or picker tools.

Definition at line 125 of file eda_item.cpp.

References m_netHighlighted.

Referenced by KIGFX::SCH_PAINTER::draw(), and setNetHighlight().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 131 of file eda_item.h.

References IS_NEW, and m_flags.

Referenced by SCH_EDIT_TOOL::CycleBodyStyle(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PCB_TUNING_PATTERN::EditStart(), PCB_VIA_STACK::EditStart(), PCB_VIA_STITCH::EditStart(), SCH_MOVE_TOOL::finalizeMoveOperation(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), SCH_SCREEN::IsTerminalPoint(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SCH_POINT_EDITOR::Main(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_MOVE_TOOL::prepareMoveOperation(), SCH_SELECTION_TOOL::select(), SCH_MOVE_TOOL::startMoveOperation(), PCB_TUNING_PATTERN::Update(), and PCB_TUNING_PATTERN::ViewDraw().

◆ IsNormal()

bool SCH_SYMBOL::IsNormal ( ) const

overridevirtual

Implements SYMBOL.

Definition at line 4798 of file sch_symbol.cpp.

References m_part.

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

References ALL_BODY_STYLES, ALL_UNITS, SCH_ITEM::GetBodyStyle(), SCH_ITEM::GetUnit(), m_pins, and pin.

◆ IsPower()

bool SCH_SYMBOL::IsPower ( ) const

overridevirtual

Implements SYMBOL.

Definition at line 4792 of file sch_symbol.cpp.

References IsGlobalPower(), and IsLocalPower().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_DATA_TEST_CASE_F(), NETLIST_EXPORTER_BASE::CreatePinList(), SCH_EDIT_TOOL::EditField(), HasConnectivityChanges(), DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsAdded(), DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsChanged(), ResolveTextVar(), POWER_SEARCH_HANDLER::Search(), SYMBOL_SEARCH_HANDLER::Search(), SCH_SHEET::SymbolCount(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ IsPrivate()

bool SCH_ITEM::IsPrivate ( ) const

inlineinherited

Definition at line 259 of file sch_item.h.

References m_private.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), BOOST_AUTO_TEST_CASE(), LIB_SYMBOL::Compare(), compare(), SCH_PIN::compare(), SCH_PIN::ComparisonData(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_CONNECTIVITY::ExtractLibraryFieldFact(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getFieldResolvedLiveValue(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getFieldResolvedLiveValue(), FIELDS_GRID_TABLE::GetFieldRow(), FIELDS_GRID_TABLE::GetMandatoryRowCount(), GetMsgPanelInfo(), FIELDS_GRID_TABLE::GetValue(), FIELDS_GRID_TABLE::GetValueAsBool(), FIELDS_GRID_TABLE::getVisibleRowCount(), SCH_FIELD::HasSameContent(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), DIALOG_CHANGE_SYMBOLS::processSymbols(), EE_GRID_HELPER::queryVisible(), SCH_IO_KICAD_SEXPR::saveField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveSymbolDrawItem(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveText(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveTextBox(), SCH_ITEM_DESC::SCH_ITEM_DESC(), SCH_FIELD::Serialize(), SCH_SHAPE::ViewGetLayers(), and SCH_TEXT::ViewGetLayers().

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

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

References m_isRollover.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), and SCH_ITEM::HasHoveredHypertext().

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 97 of file view_item.h.

References m_isSCH_ITEM.

Referenced by SCH_GROUP_TOOL::canGroupItem(), KIGFX::SCH_VIEW::DisplaySheet(), EDA_ITEM::EDA_ITEM(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), SCH_PROPERTIES_PANEL::getPropertyFromEvent(), EE_GRID_HELPER::ResolveSnap(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), and KIGFX::SCH_VIEW::Update().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 134 of file eda_item.h.

References m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and m_flags.

◆ IsSymbolLikePowerGlobalLabel()

bool SCH_SYMBOL::IsSymbolLikePowerGlobalLabel ( ) const

Returns: true if the symbol is equivalent to a global label: It is a Power symbol It has only one pin type Power input

Definition at line 4738 of file sch_symbol.cpp.

References GetAllLibPins(), GetLibSymbolRef(), IsGlobalPower(), and PT_POWER_IN.

Referenced by DIALOG_LABEL_PROPERTIES::TransferDataToWindow().

◆ IsSymbolLikePowerLocalLabel()

bool SCH_SYMBOL::IsSymbolLikePowerLocalLabel ( ) const

Definition at line 4756 of file sch_symbol.cpp.

References GetAllLibPins(), GetLibSymbolRef(), IsLocalPower(), and PT_POWER_IN.

Referenced by KIGFX::SCH_PAINTER::draw(), Plot(), and DIALOG_LABEL_PROPERTIES::TransferDataToWindow().

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

References EDA_ITEM::IsType(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, 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_DRAG_NET_COLLISION_MONITOR::collectDisconnectedMarkers(), SCH_DRAWING_TOOLS::findWireLabelDriverName(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_SELECTION_TOOL::Init(), SCH_FIELD::IsType(), SCH_LABEL_BASE::IsType(), SCH_LINE::IsType(), SCH_SELECTION_TOOL::RequestSelection(), GROUP_SEARCH_HANDLER::Search(), LABEL_SEARCH_HANDLER::Search(), SCH_EDITOR_CONTROL::ShowCreateNetChain(), ToProto(), SCHEMATIC_TEXT_VAR_ADAPTER::trackedItem(), NET_CHAIN_MENU::update(), SCH_EDIT_FRAME::UpdateHopOveredWires(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

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

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

Referenced by BOARD::Visit(), FOOTPRINT::Visit(), and 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 421 of file eda_item.h.

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

◆ lodScaleForThreshold()

double VIEW_ITEM::lodScaleForThreshold	(	const KIGFX::VIEW *	aView,
		int	aWhatIu,
		int	aThresholdIu )

staticprotectedinherited

Get the scale at which aWhatIu would be drawn at the same size as aThresholdIu on screen.

This is useful when a level-of-detail is defined in terms of a threshold size (i.e. 'only draw X when it will be bigger than Y size on screen').

E.g. if aWhatIu is 1000 and aThresholdIu is 100, then the item will be the same size as the threshold at 0.1 scale. Returning that 0.1 as the LoD will hide the item when the scale is less than 0.1 - i.e. smaller than the threshold.

Because even at zoom 1.0, 1mm in KiCad may not be exactly 1mm on a physical screen, the threshold may not be exact in practice.

Definition at line 35 of file view_item.cpp.

References KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), KIGFX::RENDER_SETTINGS::IsPrinting(), LOD_HIDE, LOD_SHOW, and VIEW.

Referenced by GERBER_DRAW_ITEM::ViewGetLOD(), PAD::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), and SCH_LINE::ViewGetLOD().

◆ MapLibPins()

std::vector< SCH_PIN * > SCH_SYMBOL::MapLibPins	(	const std::vector< SCH_PIN * > &	aLibPins,
		bool	aByNumber ) const

Map pins of an effective library symbol to this symbol's instance pins.

Base symbol pins are matched through the pin map. Pins from a variant alternate symbol are not in the pin map, so each occurrence is matched by number, unit, body style, and position.

Parameters

aLibPins	pins of the effective library symbol, in drawing order.
aByNumber	true when aLibPins belong to a variant alternate symbol.

Returns: instance pins aligned with aLibPins; entries are nullptr when unmatched.

Definition at line 4952 of file sch_symbol.cpp.

References SCH_ITEM::GetBodyStyle(), LIB_SYMBOL::GetGraphicalPins(), GetPin(), SCH_ITEM::GetUnit(), SCH_ITEM::LIB_SYMBOL, m_part, and VariantSymbolPinsMatch().

Referenced by BOOST_AUTO_TEST_CASE(), KIGFX::SCH_PAINTER::draw(), Plot(), and PlotPins().

◆ Matches() [1/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 318 of file eda_item.cpp.

References CTX_SEARCH, EDA_COMBINED_MATCHER::Find(), EDA_SEARCH_DATA::findString, flag, IsReplaceable(), isWordChar(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), PERMISSIVE, REGEX, EDA_SEARCH_DATA::regex, EDA_SEARCH_DATA::regex_string, EDA_SEARCH_DATA::searchAndReplace, text, WHOLEWORD, and WILDCARD.

◆ Matches() [2/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 3934 of file sch_symbol.cpp.

References FOR_GUI, GetLibSymbolRef(), GetSchSymbolLibraryName(), GetShownDescription(), GetShownKeyWords(), EDA_ITEM::Matches(), SCH_FIELD_T, SCH_ITEM::SCH_ITEM(), and EDA_SEARCH_DATA::searchMetadata.

Referenced by BOOST_AUTO_TEST_CASE(), and SCH_FIELD::Matches().

◆ MatchesNetName()

bool SCH_ITEM::MatchesNetName	(	const EDA_SEARCH_DATA &	aSearchData,
		const SCH_SHEET_PATH *	aSheet ) const

inherited

Match aSearchData against the connection of this item on aSheet.

A bus matches when one of its members matches. An item without a connection never matches, which is also what a search finds while connectivity is out of date.

Definition at line 676 of file sch_item.cpp.

References SCH_CONNECTION::AllMembers(), Connection(), ADVANCED_CFG::GetCfg(), SCH_CONNECTION::GetNetName(), SCH_CONNECTION::IsBus(), SCH_CONNECTIVITY::BUS_MEMBERS::leaves, EDA_ITEM::Matches(), SCH_CONNECTIVITY::NET_VIEW::Members(), and publishedConnection().

Referenced by SCH_LABEL_BASE::Matches(), and SCH_PIN::Matches().

◆ MirrorHorizontally()

void SCH_SYMBOL::MirrorHorizontally ( int aCenter )

overridevirtual

Mirror item horizontally about aCenter.

Reimplemented from SCH_ITEM.

Definition at line 3879 of file sch_symbol.cpp.

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.

Reimplemented from SCH_ITEM.

Definition at line 3897 of file sch_symbol.cpp.

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.

Reimplemented from SCH_ITEM.

Definition at line 789 of file sch_symbol.h.

References m_fields, and m_pos.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_DATA_TEST_CASE_F(), BOOST_FIXTURE_TEST_CASE(), SCH_IO_LTSPICE_PARSER::CreateKicadSYMBOLs(), SCH_IO_LTSPICE_PARSER::CreatePowerSymbol(), and SetPosition().

◆ operator!=()

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

Definition at line 4307 of file sch_symbol.cpp.

References SCH_SYMBOL().

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

References EDA_ITEM(), and KIGFX::VIEW_ITEM::GetClass().

◆ operator<() [2/2]

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

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 4217 of file sch_symbol.cpp.

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

◆ operator=()

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

Definition at line 4313 of file sch_symbol.cpp.

References GetClass(), SCH_ITEM::m_bodyStyle, m_doNetlist, m_fields, m_instancePathIndex, m_instances, m_lib_id, m_part, m_passthroughMode, m_pinMapOverride, m_pos, m_prefix, m_signalName, SYMBOL::m_transform, SCH_ITEM::m_unit, m_variantSymbolCache, SYMBOL::operator=(), SCH_SYMBOL(), EDA_ITEM::Type(), and UpdatePins().

◆ operator==() [1/2]

bool SCH_SYMBOL::operator== ( const SCH_ITEM & aOther ) const

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 5108 of file sch_symbol.cpp.

References SCH_ITEM::GetBodyStyle(), GetFields(), GetFields(), GetLibId(), GetPosition(), SYMBOL::GetTransform(), SCH_ITEM::GetUnit(), SYMBOL::m_DNP, SYMBOL::m_excludedFromBoard, SYMBOL::m_excludedFromBOM, SYMBOL::m_excludedFromPosFiles, SYMBOL::m_excludedFromSim, m_pins, m_schLibSymbolName, SCH_ITEM::SCH_ITEM(), SCH_SYMBOL(), and EDA_ITEM::Type().

◆ operator==() [2/2]

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

Definition at line 4245 of file sch_symbol.cpp.

References GetFields(), GetFields(), GetPin(), m_doNetlist, m_passthroughMode, m_pins, m_prefix, m_schLibSymbolName, m_signalName, REFERENCE, and SCH_SYMBOL().

◆ Plot()

void SCH_SYMBOL::Plot	(	PLOTTER *	aPlotter,
		bool	aBackground,
		const SCH_PLOT_OPTS &	aPlotOpts,
		int	aUnit,
		int	aBodyStyle,
		const VECTOR2I &	aOffset,
		bool	aDimmed )

overridevirtual

Plot the item to aPlotter.

Parameters

[in]	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.
[in]	aPlotOpts	are the options that control the plot output.
	aUnit	is which unit to print.
	aBodyStyle	is which body style to print.
	aOffset	is a relative offset.
	aDimmed	to reduce brightness of item.

Reimplemented from SCH_ITEM.

Definition at line 4425 of file sch_symbol.cpp.

References _, PLOTTER::Bookmark(), SCHEMATIC::CurrentSheet(), dummy, PLOTTER::EndBlock(), FOR_CANVAS, FOR_GUI, SCH_ITEM::GetBodyStyle(), GetBoundingBox(), SCHEMATIC::GetCurrentVariant(), GetDNP(), LIB_SYMBOL::GetDrawItems(), GetEffectiveLibSymbol(), GetFields(), LIB_SYMBOL::GetGraphicalPins(), LIB_SYMBOL::GetKeyWords(), GetRef(), SCH_ITEM::getRenderSettings(), SCH_PIN::GetShape(), LIB_SYMBOL::GetShownKeyWords(), SCH_PIN::GetShownName(), SYMBOL::GetTransform(), SCH_PIN::GetType(), SCH_ITEM::GetUnit(), PLOTTER::HyperlinkMenu(), IS_DANGLING, SCH_PIN::IsDangling(), LIB_SYMBOL::IsPower(), IsSymbolLikePowerLocalLabel(), SCH_ITEM::LIB_SYMBOL, m_fields, m_part, SCH_PLOT_OPTS::m_PDFPropertyPopups, m_pos, SCH_RENDER_SETTINGS::m_ShowDNPMarkers, SCH_RENDER_SETTINGS::m_Transform, MapLibPins(), LIB_SYMBOL::Plot(), PlotDNP(), PlotLocalPowerIconShape(), SCH_ITEM::SCH_ITEM(), SCH_ITEM::Schematic(), EDA_ITEM::SetFlags(), SCH_PIN::SetName(), SCH_PIN::SetShape(), SCH_PIN::SetType(), PLOTTER::StartBlock(), text, USER, and VALUE.

◆ PlotDNP()

void SCH_SYMBOL::PlotDNP ( PLOTTER * aPlotter ) const

Plot the red 'X' over the symbol.

This is separated to allow it being used from the screen plot function, overlapping the pins

Parameters

aPlotter the PLOTTER object used to draw the X

Definition at line 4537 of file sch_symbol.cpp.

References DEFAULT_LINE_WIDTH_MILS, GetBodyAndPinsBoundingBox(), GetBodyBoundingBox(), BOX2< Vec >::GetEnd(), BOX2< Vec >::GetHeight(), KIGFX::RENDER_SETTINGS::GetLayerColor(), BOX2< Vec >::GetOrigin(), SCH_ITEM::getRenderSettings(), BOX2< Vec >::GetWidth(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), BOX2< Vec >::Inflate(), KiROUND(), LAYER_DNP_MARKER, schIUScale, PLOTTER::SetColor(), PLOTTER::ThickSegment(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Plot().

◆ PlotLocalPowerIconShape()

void SCH_SYMBOL::PlotLocalPowerIconShape ( PLOTTER * aPlotter ) const

Plot the local power pin indicator icon shape.

Parameters

aPlotter the PLOTTER object used to draw the icon

Definition at line 4588 of file sch_symbol.cpp.

References ANGLE_HORIZONTAL, ANGLE_VERTICAL, BOX2< Vec >::GetBottom(), SCH_FIELD::GetBoundingBox(), GetField(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), EDA_TEXT::GetTextAngle(), SYMBOL::GetTransform(), BOX2< Vec >::GetWidth(), EDA_ANGLE::IsHorizontal(), plotLocalPowerIcon(), and VALUE.

Referenced by Plot().

◆ PlotPins()

void SCH_SYMBOL::PlotPins	(	PLOTTER *	aPlotter,
		bool	aDnp ) 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.
aDnp	includes "do not populate" indicators when true.

Definition at line 4626 of file sch_symbol.cpp.

References SCHEMATIC::CurrentSheet(), SCH_ITEM::GetBodyStyle(), GetEffectiveLibSymbol(), LIB_SYMBOL::GetGraphicalPins(), SCH_ITEM::getRenderSettings(), SCH_PIN::GetShape(), SCH_PIN::GetShownName(), SYMBOL::GetTransform(), SCH_PIN::GetType(), SCH_ITEM::GetUnit(), SCH_ITEM::LIB_SYMBOL, m_part, m_pos, SCH_RENDER_SETTINGS::m_Transform, MapLibPins(), SCH_PIN::Plot(), SCH_ITEM::Schematic(), SCH_PIN::SetName(), SCH_PIN::SetShape(), and SCH_PIN::SetType().

◆ rebuildInstancePathIndex()

void SCH_SYMBOL::rebuildInstancePathIndex ( )

private

Definition at line 1460 of file sch_symbol.cpp.

References m_instancePathIndex, and m_instances.

Referenced by RemoveInstance().

◆ registerConnectivityOwner()

void SCH_ITEM::registerConnectivityOwner ( const std::shared_ptr< CONNECTION_GRAPH_LIFETIME > & aOwner )

privateinherited

Graph membership belongs to this item identity and must not propagate to clones.

Definition at line 126 of file sch_item.cpp.

References m_connectivityOwners.

Referenced by CONNECTION_GRAPH::Merge().

◆ RemoveConflictingCustomProperties()

std::vector< wxString > EDA_ITEM::RemoveConflictingCustomProperties ( )

inherited

Remove custom properties whose keys collide with an existing field or built-in property name (matched case-insensitively).

Returns the keys removed, if any.

Definition at line 168 of file eda_item.cpp.

References _HKI, PROPERTY_MANAGER::Instance(), m_customProperties, and RemoveCustomProperty().

◆ RemoveCustomProperty()

void EDA_ITEM::RemoveCustomProperty ( const wxString & aKey )

inherited

Definition at line 161 of file eda_item.cpp.

References m_customProperties, and m_dynamicCustomPropsCache.

Referenced by PCB_PROPERTIES_PANEL::onKeyRenamed(), SCH_PROPERTIES_PANEL::onKeyRenamed(), RemoveConflictingCustomProperties(), and SCH_PROPERTIES_PANEL::removeCustomProperty().

◆ RemoveField() [1/2]

void SCH_SYMBOL::RemoveField ( const wxString & aFieldName )

Remove a user field from the symbol.

This will remove it from all variants.

Parameters

aFieldName is the user fieldName to remove.

Definition at line 2284 of file sch_symbol.cpp.

References SCH_ITEM::invalidateConnectivity(), m_fields, and m_instances.

Referenced by BACK_ANNOTATE::applyChangelist(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), DIALOG_RESOLVE_FIELD_CASE_CONFLICTS::applyResolutions(), BOOST_AUTO_TEST_CASE(), Deserialize(), ORCAD_CONVERTER::placeSymbolFields(), RemoveField(), and SCH_PROPERTIES_PANEL::removeField().

◆ RemoveField() [2/2]

void SCH_SYMBOL::RemoveField ( SCH_FIELD * aField )

inline

Definition at line 483 of file sch_symbol.h.

References SCH_FIELD::GetName(), and RemoveField().

◆ RemoveInstance() [1/2]

void SCH_SYMBOL::RemoveInstance ( const KIID_PATH & aInstancePath )

Definition at line 1430 of file sch_symbol.cpp.

References KIID_PATH::AsString(), SCH_ITEM::invalidateConnectivity(), m_instances, EDA_ITEM::m_Uuid, rebuildInstancePathIndex(), and traceSchSheetPaths.

◆ RemoveInstance() [2/2]

void SCH_SYMBOL::RemoveInstance ( const SCH_SHEET_PATH & aInstancePath )

Definition at line 1424 of file sch_symbol.cpp.

References SCH_SHEET_PATH::Path(), and RemoveInstance().

Referenced by AddHierarchicalReference(), SCH_SCREEN::PruneOrphanedSymbolInstances(), PrunePastedSymbolInstances(), RemoveInstance(), and SCH_SHEET_PATH::RemoveSymbolInstances().

◆ RemoveRuleAreaFromCache()

void SCH_ITEM::RemoveRuleAreaFromCache ( SCH_RULE_AREA * aRuleArea )

inlineinherited

Remove a specific rule area from the item's cache.

Definition at line 728 of file sch_item.h.

References m_rule_areas_cache.

◆ RenameVariant() [1/2]

void SCH_SYMBOL::RenameVariant	(	const KIID_PATH &	aPath,
		const wxString &	aOldName,
		const wxString &	aNewName )

Definition at line 5025 of file sch_symbol.cpp.

References getInstance(), SCH_ITEM::invalidateConnectivity(), VARIANT::m_Name, and SCH_SYMBOL_INSTANCE::m_Variants.

Referenced by SCH_SCREEN::RenameVariant(), and RenameVariant().

◆ RenameVariant() [2/2]

void SCH_SYMBOL::RenameVariant	(	const SCH_SHEET_PATH &	aInstance,
		const wxString &	aOldName,
		const wxString &	aNewName )

inline

Definition at line 1062 of file sch_symbol.h.

References SCH_SHEET_PATH::Path(), and RenameVariant().

◆ RenderAsBitmap()

bool SCH_ITEM::RenderAsBitmap ( double aWorldScale ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 1044 of file sch_item.cpp.

References BITMAP_FONT_SIZE_THRESHOLD, HasHypertext(), and text.

Referenced by KIGFX::SCH_PAINTER::draw(), and 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 SCH_FIELD, SCH_LABEL_BASE, SCH_PIN, SCH_SHEET_PIN, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 511 of file eda_item.h.

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

References EDA_SEARCH_DATA::findString, flag, isWordChar(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), REGEX, EDA_SEARCH_DATA::regex, EDA_SEARCH_DATA::regex_string, EDA_SEARCH_DATA::replaceString, result, text, and WHOLEWORD.

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

◆ resolveDelegatedPinMapOverride()

PIN_MAP_INSTANCE_OVERRIDE SCH_SYMBOL::resolveDelegatedPinMapOverride	(	const SCH_SHEET_PATH &	aSheet,
		const wxString &	aVariantName ) const

private

Return unit 1's pin-map override for a unit that delegates to it (issue #2282).

Definition at line 1981 of file sch_symbol.cpp.

References GetPinMapOverride(), GetRef(), SCH_ITEM::GetUnit(), PIN_MAP_INSTANCE_OVERRIDE::IsDelegate(), SCH_ITEM::SCH_ITEM(), SCH_SYMBOL(), SCH_SYMBOL_T, and SCH_ITEM::Schematic().

Referenced by GetPinMapOverride().

◆ ResolveDNP()

bool SCH_ITEM::ResolveDNP	(	const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString ) const

inherited

Definition at line 446 of file sch_item.cpp.

References SCH_CONNECTIVITY::INPUT_TEXT_SCOPE::Active(), GetDNP(), and m_rule_areas_cache.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_XML::makeSymbols(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ ResolveExcludedFromBoard()

bool SCH_ITEM::ResolveExcludedFromBoard	(	const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString ) const

inherited

Definition at line 410 of file sch_item.cpp.

References SCH_CONNECTIVITY::INPUT_TEXT_SCOPE::Active(), GetExcludedFromBoard(), and m_rule_areas_cache.

Referenced by SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_XML::makeListOfNets(), and NETLIST_EXPORTER_XML::makeSymbols().

◆ ResolveExcludedFromBOM()

bool SCH_ITEM::ResolveExcludedFromBOM	(	const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString ) const

inherited

Definition at line 392 of file sch_item.cpp.

References SCH_CONNECTIVITY::INPUT_TEXT_SCOPE::Active(), GetExcludedFromBOM(), and m_rule_areas_cache.

Referenced by SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_XML::makeListOfNets(), NETLIST_EXPORTER_XML::makeSymbols(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ ResolveExcludedFromPosFiles()

bool SCH_ITEM::ResolveExcludedFromPosFiles	(	const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString ) const

inherited

Definition at line 428 of file sch_item.cpp.

References SCH_CONNECTIVITY::INPUT_TEXT_SCOPE::Active(), GetExcludedFromPosFiles(), and m_rule_areas_cache.

Referenced by SYMBOL_SEARCH_HANDLER::getResultCell(), and NETLIST_EXPORTER_XML::makeSymbols().

◆ ResolveExcludedFromSim()

bool SCH_ITEM::ResolveExcludedFromSim	(	const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString ) const

inherited

Definition at line 374 of file sch_item.cpp.

References SCH_CONNECTIVITY::INPUT_TEXT_SCOPE::Active(), GetExcludedFromSim(), and m_rule_areas_cache.

Referenced by SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_XML::makeSymbols(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), and SCH_EDIT_FRAME::RefreshOperatingPointDisplay().

◆ ResolveText() [1/2]

wxString SCH_ITEM::ResolveText	(	const wxString &	aText,
		const SCH_SHEET_PATH *	aPath,
		int	aDepth,
		const wxString &	aVariantName ) const

inherited

Definition at line 471 of file sch_item.cpp.

References labelTypes, LIB_SYMBOL, LIB_SYMBOL_T, EDA_ITEM::m_parent, path, SCHEMATIC::Project(), LIB_SYMBOL::ResolveTextVar(), SCH_LABEL_BASE::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), ResolveTextVars(), SCH_SHEET_T, SCH_SYMBOL_T, Schematic(), and PROJECT::TextVarResolver().

◆ ResolveText() [2/2]

wxString SCH_ITEM::ResolveText	(	const wxString &	aText,
		const SCH_SHEET_PATH *	aPath,
		int	aDepth = 0 ) const

inherited

◆ ResolveTextVar() [1/2]

bool SCH_SYMBOL::ResolveTextVar	(	const SCH_SHEET_PATH *	aPath,
		wxString *	token,
		const wxString &	aVariantName,
		int	aDepth = 0 ) const

Resolve any references to system tokens supported by the symbol with variant support.

Parameters

aPath	the sheet path for context.
token	the token to resolve (modified in place with the result).
aVariantName	optional variant name to resolve field values for a specific variant.
aDepth	a counter to limit recursion and circular references.

Definition at line 2846 of file sch_symbol.cpp.

References SCH_CONNECTIVITY::INPUT_TEXT_SCOPE::Active(), ALL_UNITS, SIM_LIB_MGR::CreateModel(), INSPECTABLE::Get(), GetAllLibPins(), SCH_PIN::GetAlt(), SCH_SHEET_PATH::GetDNP(), GetDNP(), GetDynamicProperties(), SCH_SHEET_PATH::GetExcludedFromBoard(), GetExcludedFromBoard(), SCH_SHEET_PATH::GetExcludedFromBOM(), GetExcludedFromBOM(), GetExcludedFromPosFiles(), SCH_SHEET_PATH::GetExcludedFromSim(), GetExcludedFromSim(), GetFootprintFieldText(), SCH_PIN::GetName(), SCH_PIN::GetNumber(), GetPin(), GetPins(), PROPERTY_MANAGER::GetProperty(), GetRef(), GetShownDescription(), GetShownKeyWords(), KICAD_DIFF::DIFF_VALUE::GetType(), GetUnitSelection(), GetValue(), PROPERTY_MANAGER::Instance(), INTERNAL, PROPERTY_MANAGER::IsAvailableFor(), IsLocalPower(), IsPower(), SCH_SHEET_PATH::Last(), m_fields, m_lib_id, m_part, MILS, model, name, KICAD_DIFF::DIFF_VALUE::NONE, path, pin, RAW_VALUE, REFERENCE, SPICE_ITEM::refName, SCH_SHEET::ResolveTextVar(), result, SCH_ITEM::SCH_ITEM(), SCH_SYMBOL(), SCH_SYMBOL_T, SCH_ITEM::Schematic(), schIUScale, SIM_LIB_MGR::SetFilesStack(), SubReference(), KICAD_DIFF::DIFF_VALUE::ToDisplayString(), TYPE_HASH, and KICAD_DIFF::WxAnyToDiffValue().

◆ ResolveTextVar() [2/2]

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

Resolve any references to system tokens supported by the symbol.

Parameters

aPath	the sheet path for context.
token	the token to resolve (modified in place with the result).
aDepth	a counter to limit recursion and circular references.

Definition at line 2835 of file sch_symbol.cpp.

References SCHEMATIC::GetCurrentVariant(), ResolveTextVar(), and SCH_ITEM::Schematic().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGFX::SCH_PAINTER::expandLibItemTextVars(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getFieldResolvedLiveValue(), GetValue(), SCHEMATIC::resolveCrossReference(), SCH_ITEM::ResolveText(), ResolveTextVar(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars().

◆ Rotate()

void SCH_SYMBOL::Rotate	(	const VECTOR2I &	aCenter,
		bool	aRotateCCW )

overridevirtual

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

Reimplemented from SCH_ITEM.

Definition at line 3915 of file sch_symbol.cpp.

References ANGLE_270, ANGLE_90, m_fields, m_pos, RotatePoint(), SetOrientation(), SYM_ROTATE_CLOCKWISE, 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,
		RECURSE_MODE	aMode )

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 2544 of file sch_symbol.cpp.

References m_fields, m_pins, pin, and SCH_ITEM::SCH_ITEM().

Referenced by SCH_MARKER::FromProto(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const

inherited

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

References EDA_ITEM::findParent(), and SCHEMATIC_T.

Referenced by addConnections(), SCH_CONNECTIVITY::AppendConnectionInfo(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), AutoPlaceSheetPins(), SCH_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::ChangeTextType(), Connection(), SCH_DRAWING_TOOLS::createNewSheetPin(), SCH_MARKER::Deserialize(), SCH_GROUP::DeserializeGroup(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_SIM_MODEL< T >::DIALOG_SIM_MODEL(), SCH_SYMBOL::doGetBoundingBox(), SCH_FIELD::DoHypertextAction(), KIGFX::SCH_PAINTER::draw(), FIELDS_GRID_TABLE::FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE::FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE::FIELDS_GRID_TABLE(), SCH_SHEET::findSelf(), SCH_MARKER::GetColorLayer(), SCH_SHEET::GetContextualTextVars(), SCH_SHEET::GetDNPProp(), SCH_SYMBOL::GetDNPProp(), SCH_SYMBOL::GetDrawItem(), SCH_SYMBOL::GetDynamicProperties(), SCH_SYMBOL::GetEffectiveLibSymbol(), GetEffectiveNetClass(), SCH_JUNCTION::getEffectiveShape(), SCH_SHAPE::GetEffectiveWidth(), GetEmbeddedFonts(), SCH_SYMBOL::GetExcludedFromBoardProp(), SCH_SHEET::GetExcludedFromBOMProp(), SCH_SYMBOL::GetExcludedFromBOMProp(), SCH_SYMBOL::GetExcludedFromPosFilesProp(), SCH_SHEET::GetExcludedFromSimProp(), SCH_SYMBOL::GetExcludedFromSimProp(), GetFontMetrics(), SCH_LABEL_BASE::GetIntersheetRefs(), ERC_ITEM::getItemDescription(), SCH_PROPERTIES_PANEL::getItemValue(), SCH_LABEL_BASE::GetLabelBoxExpansion(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant(), GetMaxError(), SCH_LINE::GetMsgPanelInfo(), SCH_SHEET::GetMsgPanelInfo(), SCH_SYMBOL::GetMsgPanelInfo(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_NO_CONNECT::GetPenWidth(), SCH_SHEET::GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetRefProp(), GetSameSymbolMultiUnitSelection(), SCH_MARKER::GetSeverity(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TABLECELL::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_SHEET_FIELD_PROPERTY::getter(), SCH_TEXT::GetTextOffset(), SCH_SYMBOL::GetUnitProp(), GetUnplacedUnitsForSymbol(), SCH_SYMBOL::GetValueProp(), SCH_SYMBOL::GetVariantLibSymbol(), SCH_PIN::HitTest(), SCH_SHEET::IsTopLevelSheet(), SCH_LABEL_BASE::IsType(), SCH_SHEET::IsVirtualRootSheet(), SCH_POINT_EDITOR::makePointsAndBehavior(), BUS_UNFOLD_MENU::memberEntries(), SIM_MODEL::MigrateSimModel(), SCH_CONNECTIVITY::NETCHAIN_MANAGER::NetKeyForItem(), SCH_FIELD::OnScintillaCharAdded(), PackSheet(), PackSymbol(), SCH_SHEET_PATH::PathHumanReadable(), PIN_LAYOUT_CACHE::PIN_LAYOUT_CACHE(), LIB_SYMBOL::Plot(), SCH_BUS_ENTRY_BASE::Plot(), SCH_FIELD::Plot(), SCH_JUNCTION::Plot(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_NO_CONNECT::Plot(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), SCH_SHEET::Plot(), SCH_SYMBOL::Plot(), SCH_TABLE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_SYMBOL::PlotPins(), SCH_PIN::PlotPinTexts(), SCH_PIN::PlotPinType(), publishedConnection(), SCH_COMMIT::pushSchEdit(), SCH_SYMBOL::resolveDelegatedPinMapOverride(), ResolveText(), ResolveText(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_LABEL_BASE::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_COMMIT::RevertToCheckpoint(), SCH_FIELD::SCH_FIELD(), SCH_EDIT_FRAME::SelectUnit(), SCH_SHEET::SetDNPProp(), SCH_SYMBOL::SetDNPProp(), SCH_SYMBOL::SetExcludedFromBoardProp(), SCH_SHEET::SetExcludedFromBOMProp(), SCH_SYMBOL::SetExcludedFromBOMProp(), SCH_SYMBOL::SetExcludedFromPosFilesProp(), SCH_SHEET::SetExcludedFromSimProp(), SCH_SYMBOL::SetExcludedFromSimProp(), SCH_SYMBOL::SetRef(), SCH_SYMBOL::SetRefProp(), SCH_SHEET_FIELD_PROPERTY::setter(), SCH_SYMBOL_FIELD_PROPERTY::setter(), SCH_SYMBOL_PIN_MAP_MODE_PROPERTY::setter(), SCH_SYMBOL_PIN_MAP_NAME_PROPERTY::setter(), SCH_SYMBOL::SetUnitProp(), SCH_SYMBOL::SetValueProp(), SCH_INSPECTION_TOOL::ShowDatasheet(), SCH_EDITOR_CONTROL::SimTune(), SCH_SYMBOL::SubReference(), SCH_SYMBOL::SyncOtherUnits(), ToProto(), DIALOG_TABLE_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLE_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_FIELD_PROPERTIES::UpdateField(), DIALOG_FIELD_PROPERTIES::UpdateField(), SCH_PROPERTIES_PANEL::valueChanged(), and SCH_MARKER::ViewGetLayers().

◆ Serialize() [1/2]

void SCH_SYMBOL::Serialize ( google::protobuf::Any & aContainer ) const

overridevirtual

Serializes this object to the given Any message.

The Any message's concrete type will be specific to the object in question.

Parameters

aContainer will be filled with a message describing this object

Reimplemented from SERIALIZABLE.

Definition at line 841 of file sch_symbol.cpp.

References Serialize().

Referenced by PackSymbol(), and Serialize().

◆ Serialize() [2/2]

void SCH_SYMBOL::Serialize ( kiapi::schematic::types::SchematicSymbolInstance & aSymbol ) const

◆ Set() [1/4]

template<typename T>

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

inherited

Definition at line 48 of file inspectable_impl.h.

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

◆ Set() [2/4]

template<typename T>

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

inherited

Definition at line 31 of file inspectable_impl.h.

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

◆ Set() [3/4]

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

inherited

Definition at line 28 of file inspectable.cpp.

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

Referenced by KICAD_DIFF::ApplyPropertyResolutions(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), MATCH_PROPERTIES_CATALOG::Copy(), PCB_PROPERTIES_PANEL::valueChanged(), and SCH_PROPERTIES_PANEL::valueChanged().

◆ Set() [4/4]

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		wxVariant	aValue,
		bool	aNotify = true )

inherited

Definition at line 45 of file inspectable.cpp.

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

◆ SetBodyStyle()

void SCH_SYMBOL::SetBodyStyle ( int aBodyStyle )

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1337 of file sch_symbol.cpp.

References SCH_ITEM::m_bodyStyle, and UpdatePins().

Referenced by Deserialize(), SCH_IO_ALTIUM::ParseComponent(), SCH_EDIT_FRAME::SelectBodyStyle(), and SetBodyStyleProp().

◆ SetBodyStyleProp()

void SCH_SYMBOL::SetBodyStyleProp ( const wxString & aBodyStyle )

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 544 of file sch_symbol.h.

References GetBodyStyleCount(), GetBodyStyleDescription(), and SetBodyStyle().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 151 of file eda_item.h.

References BRIGHTENED, and SetFlags().

Referenced by KICAD_DIFF::ConfigureSchDiffCanvasContext(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), PL_SELECTION_TOOL::highlight(), SCH_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), and PCB_TEST_SELECTION_TOOL::highlightInternal().

◆ SetConnectionGraph()

void SCH_ITEM::SetConnectionGraph ( CONNECTION_GRAPH * aGraph )

inherited

Update the connection graph for all connections in this item.

Definition at line 604 of file sch_item.cpp.

References CONNECTION_GRAPH, m_connection_map, and path.

Referenced by CONNECTION_GRAPH::Merge().

◆ SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool aDirty = true )

inherited

Set the dirty flag.

Setting it also bumps the parent screen revision for a connectivity source, so an edit outside SCH_COMMIT can use this call. Clearing it does not bump. The bump follows the draw list check of invalidateConnectivity().

Definition at line 314 of file sch_item.cpp.

References invalidateConnectivity(), SCH_SCREEN::IsConnectivitySource(), m_connectivity_dirty, and EDA_ITEM::Type().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), SCH_LINE::BreakAt(), SCH_EDIT_TOOL::editFieldText(), SCH_MOVE_TOOL::getConnectedDragItems(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), SCH_IO_PADS::LoadSchematicFile(), SCH_LINE::NonGroupAware_BreakAt(), DIALOG_MIGRATE_BUSES::onAcceptClicked(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_CONNECTIVITY::FACADE::Recalculate(), SCH_COMMIT::RevertToCheckpoint(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), SCH_SYMBOL::SetPassthroughMode(), and SCH_SYMBOL::SetUnitSelection().

◆ SetCustomProperties()

void EDA_ITEM::SetCustomProperties ( const std::map< wxString, wxString > & aProps )

inlineinherited

Definition at line 247 of file eda_item.h.

References m_customProperties, and SetCustomProperty().

Referenced by kiapi::common::UnpackCustomProperties().

◆ SetCustomProperty()

void EDA_ITEM::SetCustomProperty	(	const wxString &	aKey,
		const wxString &	aValue )

inlineinherited

Definition at line 255 of file eda_item.h.

References m_customProperties.

Referenced by SCH_PROPERTIES_PANEL::addBlankCustomProperty(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_PROPERTIES_PANEL::onKeyRenamed(), SCH_PROPERTIES_PANEL::onKeyRenamed(), PCB_IO_KICAD_SEXPR_PARSER::parseCustomProperty(), SCH_IO_KICAD_SEXPR_PARSER::parseCustomProperty(), SetCustomProperties(), and EDA_CUSTOM_PROPERTY::setter().

◆ SetDNP()

void SCH_SYMBOL::SetDNP	(	bool	aEnable,
		const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString )

overridevirtual

Reimplemented from SYMBOL.

Definition at line 1907 of file sch_symbol.cpp.

References SYMBOL::m_DNP, VARIANT::m_DNP, and setVariantAttribute().

Referenced by BACK_ANNOTATE::applyChangelist(), applySymbolVariants(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ORCAD_CONVERTER::placeInstance(), SetDNPProp(), and UnpackSymbol().

◆ SetDNPProp()

void SCH_SYMBOL::SetDNPProp ( bool aEnable )

Definition at line 94 of file sch_symbol.cpp.

References SCH_ITEM::Schematic(), and SetDNP().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ SetExcludedFromBoard()

void SCH_SYMBOL::SetExcludedFromBoard	(	bool	aEnable,
		const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString )

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 2065 of file sch_symbol.cpp.

References VARIANT::m_ExcludedFromBoard, SYMBOL::m_excludedFromBoard, and setVariantAttribute().

Referenced by applySymbolVariants(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), EASYPC::SCH_BUILDER::buildSymbols(), ORCAD_CONVERTER::placeInstance(), SetExcludedFromBoardProp(), and UnpackSymbol().

◆ SetExcludedFromBoardProp()

void SCH_SYMBOL::SetExcludedFromBoardProp ( bool aEnable )

Definition at line 130 of file sch_symbol.cpp.

References SCH_ITEM::Schematic(), and SetExcludedFromBoard().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ SetExcludedFromBOM()

void SCH_SYMBOL::SetExcludedFromBOM	(	bool	aExcludeFromBOM,
		const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString )

overridevirtual

Set or clear the exclude from schematic bill of materials flag.

Reimplemented from SYMBOL.

Definition at line 2015 of file sch_symbol.cpp.

References VARIANT::m_ExcludedFromBOM, SYMBOL::m_excludedFromBOM, and setVariantAttribute().

Referenced by BACK_ANNOTATE::applyChangelist(), applySymbolVariants(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EASYPC::SCH_BUILDER::buildSymbols(), SetExcludedFromBOMProp(), and UnpackSymbol().

◆ SetExcludedFromBOMProp()

void SCH_SYMBOL::SetExcludedFromBOMProp ( bool aEnable )

Definition at line 106 of file sch_symbol.cpp.

References SCH_ITEM::Schematic(), and SetExcludedFromBOM().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ SetExcludedFromPosFiles()

void SCH_SYMBOL::SetExcludedFromPosFiles	(	bool	aEnable,
		const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString )

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 2092 of file sch_symbol.cpp.

References VARIANT::m_ExcludedFromPosFiles, SYMBOL::m_excludedFromPosFiles, and setVariantAttribute().

Referenced by BACK_ANNOTATE::applyChangelist(), applySymbolVariants(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SetExcludedFromPosFilesProp(), and UnpackSymbol().

◆ SetExcludedFromPosFilesProp()

void SCH_SYMBOL::SetExcludedFromPosFilesProp ( bool aEnable )

Definition at line 142 of file sch_symbol.cpp.

References SCH_ITEM::Schematic(), and SetExcludedFromPosFiles().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ SetExcludedFromSim()

void SCH_SYMBOL::SetExcludedFromSim	(	bool	aExcludeFromSim,
		const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString )

overridevirtual

Set or clear the exclude from simulation flag.

Reimplemented from SYMBOL.

Definition at line 2040 of file sch_symbol.cpp.

References VARIANT::m_ExcludedFromSim, SYMBOL::m_excludedFromSim, and setVariantAttribute().

Referenced by BACK_ANNOTATE::applyChangelist(), applySymbolVariants(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SetExcludedFromSimProp(), and UnpackSymbol().

◆ SetExcludedFromSimProp()

void SCH_SYMBOL::SetExcludedFromSimProp ( bool aEnable )

Definition at line 118 of file sch_symbol.cpp.

References SCH_ITEM::Schematic(), and SetExcludedFromSim().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( AUTOPLACE_ALGO aAlgo )

inlineinherited

Definition at line 674 of file sch_item.h.

References m_fieldsAutoplaced.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_SHEET::Deserialize(), SCH_SYMBOL::Deserialize(), SCH_EDIT_TOOL::JustifyText(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_IO_KICAD_SEXPR_PARSER::parseSchText(), SCH_EDIT_TOOL::Rotate(), unpackLabel(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ SetFieldText()

void SCH_SYMBOL::SetFieldText	(	const wxString &	aFieldName,
		const wxString &	aFieldText,
		const SCH_SHEET_PATH *	aPath = nullptr,
		const wxString &	aVariantName = wxEmptyString )

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 158 of file eda_item.h.

References m_flags.

◆ SetFootprintFieldText()

void SCH_SYMBOL::SetFootprintFieldText ( const wxString & aFootprint )

◆ SetForcedTransparency()

void KIGFX::VIEW_ITEM::SetForcedTransparency ( double aForcedTransparency )

inlineinherited

Definition at line 162 of file view_item.h.

References m_forcedTransparency.

Referenced by FOOTPRINT_DIFF_WIDGET::onSlider(), EDA_ITEM::operator=(), and LIB_SYMBOL::SetParent().

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

References m_forceVisible.

Referenced by SCH_FIND_REPLACE_TOOL::FindNext(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ SetInstanceProjectName()

bool SCH_SYMBOL::SetInstanceProjectName	(	const KIID_PATH &	aSheetPath,
		const wxString &	aProjectName )

Set the owning project of the instance stored for aSheetPath.

Parameters

aSheetPath	is the full sheet path of the instance to reassign.
aProjectName	is the name of the project that now owns the instance.

Returns: false if no instance is stored for aSheetPath.

Definition at line 3459 of file sch_symbol.cpp.

References getInstance(), and SCH_SYMBOL_INSTANCE::m_ProjectName.

Referenced by PrunePastedSymbolInstances().

◆ SetIsRollover()

void EDA_ITEM::SetIsRollover	(	bool	aIsRollover,
		const VECTOR2I &	aMousePos )

inlineinherited

Definition at line 144 of file eda_item.h.

References m_isRollover, and m_rolloverPos.

Referenced by SCH_SELECTION_TOOL::Main().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 198 of file eda_item.h.

References ClearFlags(), IS_SHOWN_AS_BITMAP, and 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 666 of file sch_item.h.

References SCH_ITEM().

Referenced by SCH_EDITOR_CONTROL::Paste().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID aLayer )

inlineinherited

◆ SetLibId()

void SCH_SYMBOL::SetLibId ( const LIB_ID & aName )

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

References LIB_SYMBOL::IsRoot(), SCH_ITEM::LIB_SYMBOL, m_part, m_pins, m_variantSymbolCache, pin, and UpdatePins().

◆ SetLocked()

void SCH_ITEM::SetLocked ( bool aLocked )

inlineoverridevirtualinherited

◆ SetMirrorX()

void SCH_SYMBOL::SetMirrorX ( bool aMirror )

inline

Definition at line 322 of file sch_symbol.h.

References GetOrientation(), SetOrientation(), and SYM_MIRROR_X.

Referenced by Deserialize(), and SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ SetMirrorY()

void SCH_SYMBOL::SetMirrorY ( bool aMirror )

inline

Definition at line 339 of file sch_symbol.h.

References GetOrientation(), SetOrientation(), and SYM_MIRROR_Y.

Referenced by Deserialize(), and SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 260 of file eda_item.cpp.

References IS_CHANGED, m_parent, and SetFlags().

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), SCH_IO_ALTIUM::ParseASCIISchematic(), and SCH_IO_ALTIUM::ParseFileHeader().

◆ SetNetChainName()

void SCH_SYMBOL::SetNetChainName ( wxString aName )

inlinenoexcept

Definition at line 866 of file sch_symbol.h.

References m_signalName.

Referenced by SCH_CONNECTIVITY::NETCHAIN_MANAGER::setSymbolName().

◆ SetNetHighlighted()

void EDA_ITEM::SetNetHighlighted ( bool aHighlighted )

inherited

Definition at line 131 of file eda_item.cpp.

References m_netHighlighted.

Referenced by KIGFX::SCH_PAINTER::draw(), and setNetHighlight().

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

References SYMBOL::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 BOOST_AUTO_TEST_CASE(), SCH_IO_LTSPICE_PARSER::CreatePowerSymbol(), GetOrientation(), ORCAD_CONVERTER::instantiateSymbol(), SCH_IO_PADS::LoadSchematicFile(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_EDIT_TOOL::Mirror(), MirrorHorizontally(), MirrorVertically(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_ALTIUM::ParsePowerPort(), Rotate(), SCH_IO_LTSPICE_PARSER::RotateMirror(), SetMirrorX(), SetMirrorY(), SetOrientation(), SetOrientationProp(), and SCH_EDIT_TOOL::Swap().

◆ SetOrientationProp()

void SCH_SYMBOL::SetOrientationProp ( SYMBOL_ORIENTATION_PROP aAngle )

inline

Orientation/mirroring access for property manager.

Definition at line 296 of file sch_symbol.h.

References GetOrientation(), SetOrientation(), SYM_MIRROR_X, and SYM_MIRROR_Y.

Referenced by Deserialize(), and SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ SetParent()

void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

virtualinherited

Reimplemented in LIB_SYMBOL, NETINFO_ITEM, and PCB_POINT.

Definition at line 153 of file eda_item.cpp.

References EDA_ITEM(), and m_parent.

◆ SetParentGroup()

virtual void EDA_ITEM::SetParentGroup ( EDA_GROUP * aGroup )

inlinevirtualinherited

◆ SetPassthroughMode()

void SCH_SYMBOL::SetPassthroughMode ( PASSTHROUGH_MODE aMode )

inline

Definition at line 856 of file sch_symbol.h.

References m_passthroughMode, and SCH_ITEM::SetConnectivityDirty().

Referenced by BOOST_AUTO_TEST_CASE(), and Deserialize().

◆ SetPinMapOverride()

void SCH_SYMBOL::SetPinMapOverride	(	const PIN_MAP_INSTANCE_OVERRIDE &	aOverride,
		const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString )

Set the per-instance pin-to-pad map override (issue #2282).

Mirrors SetDNP: with no sheet/variant the base override is set; otherwise the override is stored on the variant record for the sheet path.

Definition at line 1930 of file sch_symbol.cpp.

References AddVariant(), getInstance(), SCH_SYMBOL_VARIANT::InitializeAttributes(), PIN_MAP_INSTANCE_OVERRIDE::IsDefault(), SCH_SYMBOL_VARIANT::m_PinMapOverride, m_pinMapOverride, SCH_SYMBOL_INSTANCE::m_Variants, and SCH_SHEET_PATH::PathHumanReadable().

Referenced by applySymbolVariants(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PIN_MAP_OVERRIDE_FIXTURE::placeSymbol(), SCH_SYMBOL_PIN_MAP_MODE_PROPERTY::setter(), SCH_SYMBOL_PIN_MAP_NAME_PROPERTY::setter(), and UnpackSymbol().

◆ SetPinNameOffset()

void SYMBOL::SetPinNameOffset ( int aOffset )

inlineinherited

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

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

Parameters

aOffset - The offset in mils.

Definition at line 162 of file symbol.h.

References m_pinNameOffset.

Referenced by BOOST_AUTO_TEST_CASE(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), LIB_SYMBOL::Deserialize(), SCH_SYMBOL::Deserialize(), LIB_SYMBOL_DESC::LIB_SYMBOL_DESC(), and LIB_SYMBOL::SetPinNamesInsideProp().

◆ SetPosition()

void SCH_SYMBOL::SetPosition ( const VECTOR2I & aPosition )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 896 of file sch_symbol.h.

References m_pos, and Move().

◆ SetPrefix()

void SCH_SYMBOL::SetPrefix ( const wxString & aPrefix )

inline

Definition at line 239 of file sch_symbol.h.

References m_prefix.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), and UpdatePrefix().

◆ SetPreviewBodyStyle()

void SYMBOL::SetPreviewBodyStyle ( int aBodyStyle )

inlineinherited

Definition at line 252 of file symbol.h.

References m_previewBodyStyle.

◆ SetPreviewUnit()

void SYMBOL::SetPreviewUnit ( int aUnit )

inlineinherited

Definition at line 251 of file symbol.h.

References m_previewUnit.

◆ SetPrivate()

void SCH_ITEM::SetPrivate ( bool aPrivate )

inlineinherited

Definition at line 258 of file sch_item.h.

References m_private.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), BOOST_AUTO_TEST_CASE(), LIB_SYMBOL::Deserialize(), SCH_FIELD::Deserialize(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_ITEM_DESC::SCH_ITEM_DESC(), FIELDS_GRID_TABLE::SetValue(), FIELDS_GRID_TABLE::SetValueAsBool(), and SCH_SYMBOL::UpdateFields().

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

References AddHierarchicalReference(), GetField(), UTIL::GetRefDesPrefix(), SCH_FIELD::GetText(), SCH_ITEM::invalidateConnectivity(), m_doNetlist, m_instancePathIndex, m_instances, m_pins, m_prefix, SCH_ITEM::m_unit, SCH_SHEET_PATH::Path(), path, pin, REFERENCE, SCH_ITEM::Schematic(), and SCH_FIELD::SetText().

◆ SetRefProp()

void SCH_SYMBOL::SetRefProp ( const wxString & aRef )

Definition at line 1563 of file sch_symbol.cpp.

References REFERENCE, SCH_ITEM::Schematic(), SetRef(), and validator.

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), and SCH_PROPERTIES_PANEL::valueChanged().

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

References m_schLibSymbolName.

Referenced by SCH_SCREEN::Append(), Deserialize(), ORCAD_CONVERTER::finalizeNativePowerPackages(), and API_HANDLER_SCH::handleCreateUpdateItemsInternal().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 150 of file eda_item.h.

References SELECTED, and SetFlags().

Referenced by BOOST_AUTO_TEST_CASE(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), PL_SELECTION_TOOL::highlight(), SCH_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), SCH_LINE::MergeOverlap(), DRAWING_TOOL::PlaceSubGrid(), DS_PROXY_UNDO_ITEM::Restore(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::selectVisually(), and SCH_COMMIT::Stage().

◆ SetShowPinNames()

void SCH_SYMBOL::SetShowPinNames ( bool aShow )

overridevirtual

Set or clear the pin name visibility flag.

Reimplemented from SYMBOL.

Definition at line 4697 of file sch_symbol.cpp.

References m_part.

Referenced by Deserialize().

◆ SetShowPinNumbers()

void SCH_SYMBOL::SetShowPinNumbers ( bool aShow )

overridevirtual

Set or clear the pin number visibility flag.

Reimplemented from SYMBOL.

Definition at line 4710 of file sch_symbol.cpp.

References m_part.

Referenced by Deserialize().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( const VECTOR2I & aPos )

inlineinherited

Definition at line 315 of file sch_item.h.

References m_storedPos.

Referenced by SCH_MOVE_TOOL::prepareMoveOperation(), and SCH_MOVE_TOOL::updateStoredPositions().

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

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ SetTransform()

void SYMBOL::SetTransform ( const TRANSFORM & aTransform )

inlineinherited

Definition at line 249 of file symbol.h.

References m_transform.

Referenced by EASYPC::SCH_BUILDER::buildSymbols().

◆ SetUnit()

virtual void SCH_ITEM::SetUnit ( int aUnit )

inlinevirtualinherited

Definition at line 242 of file sch_item.h.

References m_unit.

◆ SetUnitProp()

void SCH_SYMBOL::SetUnitProp ( int aUnit )

Definition at line 81 of file sch_symbol.cpp.

References SCH_ITEM::Schematic(), SCH_ITEM::SetUnit(), and SetUnitSelection().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ SetUnitSelection() [1/2]

void SCH_SYMBOL::SetUnitSelection	(	const SCH_SHEET_PATH *	aSheet,
		int	aUnitSelection )

Set the selected unit of this symbol on one sheet.

Definition at line 1852 of file sch_symbol.cpp.

References AddHierarchicalReference(), UTIL::GetRefDesUnannotated(), SCH_ITEM::invalidateConnectivity(), m_instancePathIndex, m_instances, m_prefix, SCH_SHEET_PATH::Path(), and path.

Referenced by ApplySymbolInstance(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), ORCAD_CONVERTER::finalizeNativePowerPackages(), ORCAD_CONVERTER::placeInstance(), ORCAD_CONVERTER::placePowerSymbol(), SCH_DRAWING_TOOLS::PlaceSymbol(), ISSUE24107_FIXTURE::placeUnit(), SCH_EDIT_FRAME::SelectUnit(), SetUnitProp(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ SetUnitSelection() [2/2]

void SCH_SYMBOL::SetUnitSelection ( int aUnitSelection )

Set the selected unit of this symbol for all sheets.

Definition at line 2119 of file sch_symbol.cpp.

References m_instances, and SCH_ITEM::SetConnectivityDirty().

◆ SetUnitString()

void SCH_ITEM::SetUnitString ( const wxString & aUnit )

virtualinherited

Definition at line 247 of file sch_item.cpp.

References _HKI, GetParentSymbol(), and m_unit.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ SetValueFieldText()

void SCH_SYMBOL::SetValueFieldText	(	const wxString &	aValue,
		const SCH_SHEET_PATH *	aInstance = nullptr,
		const wxString &	aVariantName = wxEmptyString )

Definition at line 2175 of file sch_symbol.cpp.

References GetField(), getInstance(), SCH_FIELD::GetName(), SCH_SYMBOL_VARIANT::InitializeAttributes(), VARIANT::m_Fields, SCH_SYMBOL_INSTANCE::m_Variants, SCH_FIELD::SetText(), and VALUE.

Referenced by BACK_ANNOTATE::applyChangelist(), PADS_SCH::PADS_SCH_SCHEMATIC_BUILDER::ApplyPartAttributes(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CONNECTION_GRAPH::boost_test_update_symbol_connectivity, EASYPC::SCH_BUILDER::buildSymbols(), SCH_IO_LTSPICE_PARSER::CreateFields(), SCH_IO_LTSPICE_PARSER::CreatePowerSymbol(), SCH_SCREEN::FixLegacyPowerSymbolMismatches(), SCH_IO_PADS::LoadSchematicFile(), SCH_IO_ALTIUM::ParsePowerPort(), ORCAD_CONVERTER::placePowerSymbol(), ORCAD_CONVERTER::placeSymbolFields(), SetValueProp(), UpdateFields(), and SCH_SHEET_LIST::UpdateSymbolInstanceData().

◆ SetValueProp()

void SCH_SYMBOL::SetValueProp ( const wxString & aValue )

Definition at line 1572 of file sch_symbol.cpp.

References SCHEMATIC::GetCurrentVariant(), SCH_ITEM::Schematic(), and SetValueFieldText().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ setVariantAttribute()

void SCH_SYMBOL::setVariantAttribute	(	bool	aEnable,
		const SCH_SHEET_PATH *	aInstance,
		const wxString &	aVariantName,
		bool SCH_SYMBOL::*	aBase,
		bool SCH_SYMBOL_VARIANT::*	aOverride )

private

Definition at line 1869 of file sch_symbol.cpp.

References AddVariant(), getInstance(), SCH_SYMBOL_VARIANT::InitializeAttributes(), SCH_ITEM::invalidateConnectivity(), SCH_SYMBOL_INSTANCE::m_Variants, SCH_SHEET_PATH::PathHumanReadable(), and SCH_SYMBOL().

Referenced by SetDNP(), SetExcludedFromBoard(), SetExcludedFromBOM(), SetExcludedFromPosFiles(), and SetExcludedFromSim().

◆ SetVariantSymbolOverride()

void SCH_SYMBOL::SetVariantSymbolOverride	(	const SCH_SHEET_PATH &	aPath,
		const wxString &	aVariantName,
		const LIB_ID &	aLibId )

Set the alternate-symbol override for a given variant and sheet instance.

Creates the variant if it does not already exist.

Definition at line 5062 of file sch_symbol.cpp.

References getInstance(), SCH_SYMBOL_VARIANT::InitializeAttributes(), SCH_ITEM::invalidateConnectivity(), SCH_SYMBOL_INSTANCE::m_Variants, and m_variantSymbolCache.

Referenced by applySymbolVariants(), and SCH_EDIT_TOOL::SetVariantSymbol().

◆ SetX()

void SCH_SYMBOL::SetX ( int aX )

inline

Definition at line 899 of file sch_symbol.h.

References GetY(), and SetPosition().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ SetY()

void SCH_SYMBOL::SetY ( int aY )

inline

Definition at line 902 of file sch_symbol.h.

References GetX(), and SetPosition().

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ Similarity()

double SCH_SYMBOL::Similarity ( const SCH_ITEM & aItem ) const

overridevirtual

Return a measure of how likely the other object is to represent the same object.

The scale runs from 0.0 (definitely different objects) to 1.0 (same)

Reimplemented from SCH_ITEM.

Definition at line 5171 of file sch_symbol.cpp.

References GetLibId(), GetPosition(), SCH_ITEM::SCH_ITEM(), SCH_SYMBOL(), and EDA_ITEM::Type().

◆ SimilarityBase()

double SCH_ITEM::SimilarityBase ( const SCH_ITEM & aItem ) const

inlineinherited

Calculate the boilerplate similarity for all LIB_ITEMs without preventing the use above of a pure virtual function that catches at compile time when a new object has not been fully implemented.

Definition at line 398 of file sch_item.h.

References m_bodyStyle, m_private, m_unit, and SCH_ITEM().

Referenced by SCH_FIELD::Similarity(), SCH_PIN::Similarity(), SCH_SHAPE::Similarity(), SCH_TEXT::Similarity(), and SCH_TEXTBOX::Similarity().

◆ Sort()

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

inlinestaticinherited

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

Parameters

aLeft	The left hand item to compare.
aRight	The right hand item to compare.

Returns: True if aLeft is less than aRight.

Definition at line 540 of file eda_item.h.

References EDA_ITEM().

◆ SubReference()

wxString SCH_SYMBOL::SubReference	(	int	aUnit,
		bool	aAddSeparator = true ) const

Definition at line 1807 of file sch_symbol.cpp.

References LIB_SYMBOL::LetterSubReference(), m_part, and SCH_ITEM::Schematic().

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), SCH_REFERENCE_LIST::CheckAnnotation(), SCH_EDIT_FRAME::DeleteAnnotation(), SCH_REFERENCE::GetCanonicalRef(), SCH_REFERENCE::GetFullRef(), GetRef(), GetUnitDisplayName(), SCH_FIELD::Matches(), and ResolveTextVar().

◆ swapData()

void SCH_SYMBOL::swapData ( SCH_ITEM * aItem )

overrideprotectedvirtual

Swap the internal data structures aItem with the schematic item.

Obviously, aItem must have the same type than me.

Parameters

aItem The item to swap the data structures with.

Reimplemented from SCH_ITEM.

Definition at line 2738 of file sch_symbol.cpp.

References SCH_ITEM::LIB_SYMBOL, SYMBOL::m_DNP, m_doNetlist, SYMBOL::m_excludedFromBoard, SYMBOL::m_excludedFromBOM, SYMBOL::m_excludedFromPosFiles, SYMBOL::m_excludedFromSim, m_fields, m_instancePathIndex, m_instances, m_lib_id, m_part, m_passthroughMode, m_pinMapOverride, m_pins, m_pos, m_prefix, m_schLibSymbolName, m_signalName, SYMBOL::m_transform, m_variantSymbolCache, pin, SCH_ITEM::SCH_ITEM(), SCH_SYMBOL(), SCH_SYMBOL_T, EDA_ITEM::SetParent(), EDA_ITEM::Type(), and UpdatePins().

◆ SwapFlags()

void SCH_ITEM::SwapFlags ( SCH_ITEM * aItem )

inherited

Swap the non-temp and non-edit flags.

Definition at line 870 of file sch_item.cpp.

References EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearTempFlags(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetTempFlags(), EDA_ITEM::m_flags, SCH_ITEM(), and EDA_ITEM::SetFlags().

Referenced by SwapItemData().

◆ SwapItemData()

void SCH_ITEM::SwapItemData ( SCH_ITEM * aImage )

inherited

Swap data between aItem and aImage.

aItem and aImage should have the same type.

Used in undo and redo commands to swap values between an item and its copy. Only values like layer, size .. which are modified by editing are swapped.

Parameters

aImage the item image which contains data to swap.

Definition at line 840 of file sch_item.cpp.

References EDA_ITEM::EDA_ITEM(), EDA_ITEM::GetParent(), GetParentScreen(), m_bodyStyle, EDA_ITEM::m_customProperties, m_fieldsAutoplaced, m_isLocked, m_layer, m_private, m_unit, SCH_ITEM(), EDA_ITEM::SetParent(), swapData(), SwapFlags(), and EDA_ITEM::Type().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_SYMBOL::handleCreateUpdateItemsInternal(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_COMMIT::RemovedForCleanup(), and SCH_COMMIT::RevertToCheckpoint().

◆ SyncOtherUnits()

void SCH_SYMBOL::SyncOtherUnits	(	const SCH_SHEET_PATH &	aSourceSheet,
		SCH_COMMIT &	aCommit,
		PROPERTY_BASE *	aProperty,
		const wxString &	aVariantName = wxEmptyString )

Keep fields other than the reference, include/exclude flags, and alternate pin assignments in sync in multi-unit parts.

Parameters

aSourceSheet	the sheet instance of the unit to sync to.
aCommit	is the SCH_COMMIT object for undo/redo actions.
aProperty	if present, the single property to sync. (Otherwise the include/exclude flags, alternate pin assignments, and all fields bar the reference will be synced.)
aVariantName	is the name of the variant to use. An empty string is the default variant.

Definition at line 2402 of file sch_symbol.cpp.

References _HKI, CollectOtherUnits(), GetDNP(), GetExcludedFromBoard(), GetExcludedFromBOM(), GetExcludedFromPosFiles(), GetField(), SCH_FIELD::GetName(), GetPinMapOverride(), GetPosition(), GetRef(), GetUnitCount(), GetUnitSelection(), GetValue(), IsAnnotated(), SCH_FIELD::IsMandatory(), m_fields, m_lib_id, m_pins, EDA_ITEM::m_Uuid, COMMIT::Modify(), PROPERTY_BASE::Name(), EDA_TEXT::Offset(), RAW_VALUE, REFERENCE, SCH_SYMBOL(), SCH_ITEM::Schematic(), EDA_ITEM::SetParent(), SCH_FIELD::SetText(), updatePins(), and VALUE.

Referenced by ISSUE24943_FIXTURE::sync(), and SCH_PROPERTIES_PANEL::valueChanged().

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Returns the type of object.

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

Returns: the type of object.

Definition at line 110 of file eda_item.h.

References m_structType.

◆ UpdateDanglingState()

bool SCH_SYMBOL::UpdateDanglingState	(	std::vector< DANGLING_END_ITEM > &	aItemListByType,
		std::vector< DANGLING_END_ITEM > &	aItemListByPos,
		const SCH_SHEET_PATH *	aPath = nullptr )

overridevirtual

Test if the symbol's dangling state has changed for all pins.

As a side effect, actually update the dangling status for all pins.

Note: This does not test for short circuits.

Parameters

aItemListByType	is list of all DANGLING_END_ITEM items to be tested.
aItemListByPos
aPath	is the sheet path instance to be tested.

Returns: true if any pin's state has changed.

Reimplemented from SCH_ITEM.

Definition at line 3984 of file sch_symbol.cpp.

References DANGLING_END_ITEM_HELPER::get_lower_pos(), DANGLING_END_ITEM::GetParent(), DANGLING_END_ITEM::GetType(), JUNCTION_END, LABEL_END, m_pins, m_pos, SYMBOL::m_transform, NO_CONNECT_END, pin, PIN_END, SHEET_LABEL_END, and WIRE_END.

◆ UpdateFields()

void SCH_SYMBOL::UpdateFields	(	const SCH_SHEET_PATH *	aPath,
		bool	aUpdateStyle,
		bool	aUpdateRef,
		bool	aUpdateOtherFields,
		bool	aResetRef,
		bool	aResetOtherFields )

Restore fields to the original library values.

Parameters

aPath	is the sheet path instance for variable substitution purposes.
aUpdateStyle	selects whether fields should update the position and text attributes.
aUpdateRef	selects whether the reference field should be updated.
aUpdateOtherFields	selects whether non-reference fields should be updated.
aResetRef	selects whether the reference should be reset to the library value.
aResetOtherFields	selects whether non-reference fields should be reset to library values.

Definition at line 2336 of file sch_symbol.cpp.

References AddField(), DATASHEET, GetDatasheet(), GetField(), SCH_FIELD::ImportValues(), m_part, m_pos, REFERENCE, SCH_ITEM::SetPrivate(), SetRef(), SCH_FIELD::SetText(), EDA_TEXT::SetTextPos(), SetValueFieldText(), UnescapeString(), USER, and VALUE.

Referenced by SCH_SYMBOL().

◆ UpdatePins()

void SCH_SYMBOL::UpdatePins ( )

Updates the cache of SCH_PIN objects for each pin.

Definition at line 1157 of file sch_symbol.cpp.

References SCH_ITEM::GetParentScreen(), and updatePins().

◆ updatePins()

void SCH_SYMBOL::updatePins ( )

private

Definition at line 1166 of file sch_symbol.cpp.

References ALL_UNITS, EDA_ITEM::IsSelected(), SCH_ITEM::m_bodyStyle, m_part, m_pinMap, m_pins, name, and pin.

Referenced by SyncOtherUnits(), and UpdatePins().

◆ UpdatePrefix()

void SCH_SYMBOL::UpdatePrefix ( )

Set the prefix based on the current reference designator.

Definition at line 1780 of file sch_symbol.cpp.

References GetField(), SCH_FIELD::GetText(), REFERENCE, and SetPrefix().

Referenced by SCH_SHEET_LIST::UpdateSymbolInstanceData().

◆ UseLibIdLookup()

bool SCH_SYMBOL::UseLibIdLookup ( ) const

inline

Definition at line 180 of file sch_symbol.h.

References m_schLibSymbolName.

Referenced by SCH_IO_KICAD_SEXPR::Format(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_IO_KICAD_SEXPR::saveSymbol(), and Serialize().

◆ ViewBBox()

const BOX2I SCH_ITEM::ViewBBox ( ) const

overridevirtualinherited

The view bounds of text that shows a net name must match the drawing, so this reads connectivity inside a SCH_CONNECTIVITY::RENDER_SCOPE.

Reimplemented from EDA_ITEM.

Reimplemented in SCH_PIN.

Definition at line 557 of file sch_item.cpp.

References EDA_ITEM::ViewBBox().

◆ ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

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

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Reimplemented in CONSTRAINT_BADGE_ITEM, DS_PROXY_VIEW_ITEM, EDIT_POINTS, KIGFX::ANCHOR_DEBUG, KIGFX::CONSTRUCTION_GEOM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::BEZIER_ASSISTANT, KIGFX::PREVIEW::ELLIPSE_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::SNAP_INDICATOR, KIGFX::VIEW_GROUP, KIGFX::VIEW_OVERLAY, MY_DRAWING, PCB_TUNING_PATTERN, PCB_VIA_STITCH, RATSNEST_VIEW_ITEM, RECT_RADIUS_TEXT_ITEM, ROUTER_PREVIEW_ITEM, ROUTER_STATUS_VIEW_ITEM, TUNING_STATUS_VIEW_ITEM, and VIEW_OVERLAY.

Definition at line 123 of file view_item.h.

References VIEW.

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

◆ ViewGetLayers()

std::vector< int > SYMBOL::ViewGetLayers ( ) const

overridevirtualinherited

Return the layers the item is drawn on (which may be more than its "home" layer)

Reimplemented from SCH_ITEM.

Definition at line 24 of file symbol.cpp.

References LAYER_DANGLING, LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LAYER_FIELDS, LAYER_NOTES_BACKGROUND, LAYER_OP_CURRENTS, LAYER_PRIVATE_NOTES, LAYER_REFERENCEPART, LAYER_SELECTION_SHADOWS, LAYER_SHAPES_BACKGROUND, LAYER_VALUEPART, LIB_SYMBOL_T, SCH_SYMBOL_T, and EDA_ITEM::Type().

◆ ViewGetLOD()

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

inlinevirtualinherited

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

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

Use LOD_HIDE and LOD_SHOW constants to hide or show the item unconditionally.

Use lodScaleForThreshold() to calculate the LOD scale for when the item passes a certain threshold size on screen.

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Returns: the level of detail. 0 always shows the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in FOOTPRINT, GERBER_DRAW_ITEM, PAD, PCB_BARCODE, PCB_DIMENSION_BASE, PCB_FIELD, PCB_GRID_ITEM, PCB_GROUP, PCB_POINT, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, SCH_GROUP, SCH_LINE, and ZONE.

Definition at line 151 of file view_item.h.

References LOD_SHOW, and VIEW.

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

◆ viewPrivData()

VIEW_ITEM_DATA * KIGFX::VIEW_ITEM::viewPrivData ( ) const

inlineinherited

◆ Visit()

INSPECT_RESULT SCH_SYMBOL::Visit	(	INSPECTOR	aInspector,
		void *	aTestData,
		const std::vector< KICAD_T > &	aScanTypes )

overridevirtual

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

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

Parameters

aInspector	An INSPECTOR instance to use in the inspection.
aTestData	Arbitrary data used by the inspector.
aScanTypes	Which KICAD_T types are of interest and the order in which they should be processed.

Returns: INSPECT_RESULT INSPECT_RESULT::QUIT if the Iterator is to stop the scan, else INSPECT_RESULT::CONTINUE, and determined by the inspector.

Reimplemented from EDA_ITEM.

Definition at line 4147 of file sch_symbol.cpp.

References ALL_BODY_STYLES, ALL_UNITS, CONTINUE, DATASHEET, FOOTPRINT, SCH_ITEM::GetBodyStyle(), GetField(), SCH_ITEM::GetUnit(), m_fields, m_part, m_pins, pin, QUIT, REFERENCE, SCH_FIELD_LOCATE_DATASHEET_T, SCH_FIELD_LOCATE_FOOTPRINT_T, SCH_FIELD_LOCATE_REFERENCE_T, SCH_FIELD_LOCATE_VALUE_T, SCH_FIELD_T, SCH_LOCATE_ANY_T, SCH_PIN_T, SCH_SYMBOL_LOCATE_POWER_T, SCH_SYMBOL_T, and VALUE.

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 159 of file eda_item.h.

References m_flags.

Referenced by SCH_SELECTION_TOOL::SelectMultiple().

Member Data Documentation

◆ LOD_HIDE

double KIGFX::VIEW_ITEM::LOD_HIDE = std::numeric_limits<double>::max()

staticconstexprprotectedinherited

Return this constant from ViewGetLOD() to hide the item unconditionally.

Definition at line 176 of file view_item.h.

Referenced by lodScaleForThreshold(), KIGFX::VIEW_GROUP::ViewDraw(), FOOTPRINT::ViewGetLOD(), PAD::ViewGetLOD(), PCB_BARCODE::ViewGetLOD(), PCB_DIMENSION_BASE::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GRID_ITEM::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TABLE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), SCH_GROUP::ViewGetLOD(), SCH_LINE::ViewGetLOD(), and ZONE::ViewGetLOD().

◆ LOD_SHOW

double KIGFX::VIEW_ITEM::LOD_SHOW = 0.0

staticconstexprprotectedinherited

Return this constant from ViewGetLOD() to show the item unconditionally.

Definition at line 181 of file view_item.h.

Referenced by lodScaleForThreshold(), FOOTPRINT::ViewGetLOD(), GERBER_DRAW_ITEM::ViewGetLOD(), ViewGetLOD(), PAD::ViewGetLOD(), PCB_BARCODE::ViewGetLOD(), PCB_DIMENSION_BASE::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GRID_ITEM::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TABLE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), SCH_GROUP::ViewGetLOD(), SCH_LINE::ViewGetLOD(), and ZONE::ViewGetLOD().

◆ m_bodyStyle

int SCH_ITEM::m_bodyStyle

protectedinherited

◆ m_connected_items

std::map<SCH_SHEET_PATH, std::vector<SCH_ITEM*>, SHEET_PATH_CMP> SCH_ITEM::m_connected_items

protectedinherited

Store pointers to other items that are connected to this one, per sheet.

Definition at line 847 of file sch_item.h.

Referenced by AddConnectionTo(), ClearConnectedItems(), ConnectedItems(), and SCH_LABEL_BASE::IsType().

◆ m_connection_map

std::unordered_map<SCH_SHEET_PATH, SCH_CONNECTION*> SCH_ITEM::m_connection_map

protectedinherited

Store connectivity information, per sheet.

Definition at line 850 of file sch_item.h.

Referenced by Connection(), InitializeConnection(), SetConnectionGraph(), and ~SCH_ITEM().

◆ m_connectivity_dirty

bool SCH_ITEM::m_connectivity_dirty

protectedinherited

Definition at line 852 of file sch_item.h.

Referenced by IsConnectivityDirty(), SCH_LINE::MergeOverlap(), operator=(), SCH_ITEM(), SCH_ITEM(), and SetConnectivityDirty().

◆ m_connectivityOwners

std::vector<std::weak_ptr<CONNECTION_GRAPH_LIFETIME> > SCH_ITEM::m_connectivityOwners

privateinherited

An item may be indexed by multiple graphs, each with an independent lifetime.

Definition at line 861 of file sch_item.h.

Referenced by registerConnectivityOwner(), and ~SCH_ITEM().

◆ m_customProperties

std::map<wxString, wxString> EDA_ITEM::m_customProperties

protectedinherited

◆ m_DNP

bool SYMBOL::m_DNP

protectedinherited

True if symbol is set to 'Do Not Populate'.

Definition at line 278 of file symbol.h.

Referenced by LIB_SYMBOL::Compare(), LIB_SYMBOL::ComparisonAttributes(), SCH_SYMBOL::GetDNP(), GetDNP(), operator=(), SCH_SYMBOL::operator==(), SCH_SYMBOL::SCH_SYMBOL(), SCH_SYMBOL::SetDNP(), SetDNP(), SCH_SYMBOL::swapData(), SYMBOL(), and SYMBOL().

◆ m_doNetlist

bool SCH_SYMBOL::m_doNetlist

private

True if the symbol should appear in netlist.

Definition at line 1129 of file sch_symbol.h.

Referenced by DoNetList(), Init(), operator=(), operator==(), SCH_SYMBOL(), SetRef(), and swapData().

◆ m_dynamicCustomPropsCache

std::map<wxString, std::unique_ptr<PROPERTY_BASE> > EDA_ITEM::m_dynamicCustomPropsCache

mutableprotectedinherited

Per-key cache of dynamic property descriptors for m_customProperties, owned by this object.

Mirrors the per-object field-property caches used by FOOTPRINT / SCH_SYMBOL / SCH_SHEET; entries linger after a key is removed but are simply not enumerated.

Definition at line 623 of file eda_item.h.

Referenced by GetCustomPropertiesAsInspectables(), and RemoveCustomProperty().

◆ m_dynamicPropertyCache

std::map<wxString, std::unique_ptr<PROPERTY_BASE> > SCH_SYMBOL::m_dynamicPropertyCache

mutableprivate

Per-object cache of dynamic property descriptors for custom fields and effective pin-map entries, keyed by descriptor name and populated lazily.

Definition at line 1125 of file sch_symbol.h.

Referenced by GetDynamicProperties().

◆ m_excludedFromBoard

bool SYMBOL::m_excludedFromBoard

protectedinherited

Definition at line 276 of file symbol.h.

Referenced by LIB_SYMBOL::Compare(), LIB_SYMBOL::ComparisonAttributes(), SCH_SYMBOL::GetExcludedFromBoard(), GetExcludedFromBoard(), operator=(), SCH_SYMBOL::operator==(), SCH_SYMBOL::SCH_SYMBOL(), SCH_SYMBOL::SetExcludedFromBoard(), SetExcludedFromBoard(), LIB_SYMBOL::Similarity(), SCH_SYMBOL::swapData(), SYMBOL(), and SYMBOL().

◆ m_excludedFromBOM

bool SYMBOL::m_excludedFromBOM

protectedinherited

Definition at line 275 of file symbol.h.

Referenced by LIB_SYMBOL::Compare(), LIB_SYMBOL::ComparisonAttributes(), SCH_SYMBOL::GetExcludedFromBOM(), GetExcludedFromBOM(), operator=(), SCH_SYMBOL::operator==(), SCH_SYMBOL::SCH_SYMBOL(), SCH_SYMBOL::SetExcludedFromBOM(), SetExcludedFromBOM(), LIB_SYMBOL::Similarity(), SCH_SYMBOL::swapData(), SYMBOL(), and SYMBOL().

◆ m_excludedFromPosFiles

bool SYMBOL::m_excludedFromPosFiles

protectedinherited

Definition at line 277 of file symbol.h.

Referenced by LIB_SYMBOL::Compare(), LIB_SYMBOL::ComparisonAttributes(), SCH_SYMBOL::GetExcludedFromPosFiles(), GetExcludedFromPosFiles(), operator=(), SCH_SYMBOL::operator==(), SCH_SYMBOL::SCH_SYMBOL(), SCH_SYMBOL::SetExcludedFromPosFiles(), SetExcludedFromPosFiles(), LIB_SYMBOL::Similarity(), SCH_SYMBOL::swapData(), SYMBOL(), and SYMBOL().

◆ m_excludedFromSim

bool SYMBOL::m_excludedFromSim

protectedinherited

Definition at line 274 of file symbol.h.

Referenced by LIB_SYMBOL::Compare(), LIB_SYMBOL::ComparisonAttributes(), SCH_SYMBOL::GetExcludedFromSim(), GetExcludedFromSim(), operator=(), SCH_SYMBOL::operator==(), SCH_SYMBOL::SCH_SYMBOL(), SCH_SYMBOL::SetExcludedFromSim(), SetExcludedFromSim(), LIB_SYMBOL::Similarity(), SCH_SYMBOL::swapData(), SYMBOL(), and SYMBOL().

◆ m_fields

std::vector<SCH_FIELD> SCH_SYMBOL::m_fields

private

Variable length list of fields.

Definition at line 1120 of file sch_symbol.h.

Referenced by AddField(), doGetBoundingBox(), FindFieldCaseInsensitive(), FindFieldCaseInsensitive(), GetComponentClassNames(), GetContextualTextVars(), GetField(), GetField(), GetField(), GetField(), GetFields(), GetFields(), GetFields(), GetNextFieldOrdinal(), Init(), MirrorHorizontally(), MirrorVertically(), Move(), operator=(), Plot(), RemoveField(), ResolveTextVar(), Rotate(), RunOnChildren(), SCH_SYMBOL(), swapData(), SyncOtherUnits(), and Visit().

◆ m_fieldsAutoplaced

AUTOPLACE_ALGO SCH_ITEM::m_fieldsAutoplaced

protectedinherited

Definition at line 842 of file sch_item.h.

Referenced by LIB_SYMBOL::AutoplaceFields(), SCH_DIRECTIVE_LABEL::AutoplaceFields(), SCH_LABEL_BASE::AutoplaceFields(), SCH_SHEET::AutoplaceFields(), SCH_SYMBOL::AutoplaceFields(), GetFieldsAutoplaced(), operator=(), SCH_SHEET::Resize(), SCH_SHEET::Rotate(), SCH_LABEL_BASE::Rotate90(), SCH_ITEM(), SCH_ITEM(), SCH_SHEET::SCH_SHEET(), SCH_SHEET::SCH_SHEET(), SCH_SYMBOL::SCH_SYMBOL(), SetFieldsAutoplaced(), and SwapItemData().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 608 of file eda_item.h.

Referenced by ClearFlags(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), SCH_PIN::GetBoundingBox(), GetEditFlags(), GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), GetTempFlags(), HasFlag(), SCH_FIELD::HitTest(), SCH_FIELD::HitTest(), SCH_JUNCTION::HitTest(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), SCH_LINE::HitTest(), SCH_PIN::HitTest(), SCH_PIN::HitTest(), SCH_SHAPE::HitTest(), SCH_SHAPE::HitTest(), SCH_SYMBOL::HitTest(), SCH_SYMBOL::HitTest(), SCH_TEXT::HitTest(), SCH_TEXT::HitTest(), ZONE::InitDataFromSrcInCopyCtor(), IsBrightened(), SCH_ITEM::IsConnected(), IsEntered(), IsModified(), IsMoving(), IsNew(), IsSelected(), IsShownAsBitmap(), SCH_LINE::MirrorHorizontally(), SCH_LINE::MirrorVertically(), operator=(), PCB_SHAPE::operator==(), SCH_LINE::Rotate(), SetFlags(), LIB_SYMBOL::Similarity(), PCB_SHAPE::Similarity(), PCB_REFERENCE_IMAGE::swapData(), PCB_SHAPE::swapData(), SCH_ITEM::SwapFlags(), SCH_PIN::ViewBBox(), and XorFlags().

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 206 of file view_item.h.

Referenced by GetForcedTransparency(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), SetForcedTransparency(), and VIEW_ITEM().

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 614 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), ZONE::InitDataFromSrcInCopyCtor(), IsForceVisible(), operator=(), PCB_SHAPE::operator==(), SetForceVisible(), LIB_SYMBOL::SetParent(), PCB_SHAPE::Similarity(), PCB_REFERENCE_IMAGE::swapData(), and PCB_SHAPE::swapData().

◆ m_group

EDA_GROUP* EDA_ITEM::m_group

protectedinherited

The group this item belongs to, if any. No ownership implied.

Definition at line 610 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), GetParentGroup(), operator=(), SCH_LINE::SCH_LINE(), and SetParentGroup().

◆ m_instancePathIndex

std::unordered_map<KIID_PATH, size_t> SCH_SYMBOL::m_instancePathIndex

private

Index from an instance's sheet path to its position in m_instances for O(1) lookups.

Maintained by AddHierarchicalReference() and RemoveInstance().

Definition at line 1153 of file sch_symbol.h.

Referenced by AddHierarchicalReference(), GetInstance(), getInstance(), getInstance(), GetRef(), GetUnitSelection(), operator=(), rebuildInstancePathIndex(), SCH_SYMBOL(), SetRef(), SetUnitSelection(), and swapData().

◆ m_instances

std::vector<SCH_SYMBOL_INSTANCE> SCH_SYMBOL::m_instances

private

Define the hierarchical path and reference of the symbol.

This allows support for multiple references to a single sub-sheet.

Definition at line 1147 of file sch_symbol.h.

Referenced by AddHierarchicalReference(), AddSheetPathReferenceEntryIfMissing(), ClearAnnotation(), GetInstance(), getInstance(), getInstance(), GetInstances(), GetRef(), GetUnitSelection(), IsAnnotated(), operator=(), rebuildInstancePathIndex(), RemoveField(), RemoveInstance(), SCH_SYMBOL(), SetRef(), SetUnitSelection(), SetUnitSelection(), and swapData().

◆ m_isBOARD_ITEM

bool KIGFX::VIEW_ITEM::m_isBOARD_ITEM

privateinherited

Definition at line 204 of file view_item.h.

Referenced by IsBOARD_ITEM(), and VIEW_ITEM().

◆ m_isLocked

bool SCH_ITEM::m_isLocked

protectedinherited

Definition at line 857 of file sch_item.h.

Referenced by IsLocked(), operator=(), SCH_ITEM(), SCH_ITEM(), SetLocked(), and SwapItemData().

◆ m_isRollover

bool EDA_ITEM::m_isRollover

protectedinherited

Definition at line 613 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), IsRollover(), operator=(), SetIsRollover(), and LIB_SYMBOL::SetParent().

◆ m_isSCH_ITEM

bool KIGFX::VIEW_ITEM::m_isSCH_ITEM

privateinherited

Definition at line 203 of file view_item.h.

Referenced by IsSCH_ITEM(), and VIEW_ITEM().

◆ m_layer

SCH_LAYER_ID SCH_ITEM::m_layer

protectedinherited

Definition at line 838 of file sch_item.h.

Referenced by CanConnect(), SCH_LINE::CanConnect(), SCH_LINE::doIsConnected(), SCH_LINE::GetItemDescription(), GetLayer(), SCH_TEXTBOX::GetLegacyTextMargin(), SCH_LINE::GetMenuImage(), SCH_TEXT::GetMsgPanelInfo(), SCH_LINE::GetPenWidth(), SCH_SYMBOL::Init(), SCH_LINE::IsConnectable(), IsType(), SCH_LINE::IsType(), SCH_TEXT::MirrorHorizontally(), SCH_TEXT::MirrorVertically(), operator=(), SCH_BUS_ENTRY_BASE::Plot(), SCH_LABEL_BASE::Plot(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), SCH_TABLE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_BITMAP::SCH_BITMAP(), SCH_BUS_BUS_ENTRY::SCH_BUS_BUS_ENTRY(), SCH_BUS_WIRE_ENTRY::SCH_BUS_WIRE_ENTRY(), SCH_BUS_WIRE_ENTRY::SCH_BUS_WIRE_ENTRY(), SCH_DIRECTIVE_LABEL::SCH_DIRECTIVE_LABEL(), SCH_GLOBALLABEL::SCH_GLOBALLABEL(), SCH_HIERLABEL::SCH_HIERLABEL(), SCH_ITEM(), SCH_ITEM(), SCH_JUNCTION::SCH_JUNCTION(), SCH_LABEL::SCH_LABEL(), SCH_LINE::SCH_LINE(), SCH_PIN::SCH_PIN(), SCH_PIN::SCH_PIN(), SCH_PIN::SCH_PIN(), SCH_PIN::SCH_PIN(), SCH_SHEET::SCH_SHEET(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), SCH_TEXTBOX::SCH_TEXTBOX(), SetLayer(), SwapItemData(), SCH_JUNCTION::ViewGetLayers(), SCH_LINE::ViewGetLayers(), SCH_SHAPE::ViewGetLayers(), and SCH_TEXT::ViewGetLayers().

◆ m_lib_id

LIB_ID SCH_SYMBOL::m_lib_id

private

Name and library the symbol was loaded from, i.e. 74xx:74LS00.

Definition at line 1105 of file sch_symbol.h.

Referenced by Deserialize(), GetLibId(), GetMsgPanelInfo(), GetSchSymbolLibraryName(), GetSymbolIDAsString(), GetVariantLibSymbol(), operator=(), ResolveTextVar(), SCH_SYMBOL(), SCH_SYMBOL(), SetLibId(), swapData(), and SyncOtherUnits().

◆ m_netHighlighted

bool EDA_ITEM::m_netHighlighted = false

protectedinherited

Definition at line 615 of file eda_item.h.

Referenced by ClearFlags(), IsBrightened(), IsNetHighlighted(), operator=(), SetNetHighlighted(), and LIB_SYMBOL::SetParent().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Owner.

Definition at line 609 of file eda_item.h.

Referenced by PCB_BOARD_OUTLINE::CopyPros(), SCH_FIELD::Deserialize(), SCH_FIELD::DoHypertextAction(), EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetDefaultLayer(), SCH_FIELD::GetDrawRotation(), SCH_FIELD::GetMenuImage(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_FIELD::GetName(), BOARD_ITEM::GetParent(), GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParentAsString(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_TEXT::GetShownText(), SCH_FIELD::GetText(), SCH_FIELD::getUnescapedText(), SCH_FIELD::GetUntranslatedName(), SCH_FIELD::HitTest(), SCH_FIELD::IsLocked(), SCH_PIN::IsStacked(), SCH_FIELD::Matches(), BOARD_BOUNDING_BOX::operator=(), operator=(), PAD::operator==(), PCB_BOARD_OUTLINE::operator==(), SCH_FIELD::operator==(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_FIELD::Replace(), SCH_ITEM::ResolveText(), SCH_LABEL_BASE::ResolveTextVar(), SCH_FIELD::SCH_FIELD(), SCH_SYMBOL::SCH_SYMBOL(), SCH_FIELD::Serialize(), SetModified(), SetParent(), SCH_FIELD::SetPosition(), SCH_FIELD::SetText(), PAD::Similarity(), PCB_BOARD_OUTLINE::Similarity(), PCB_REFERENCE_IMAGE::swapData(), and PCB_SHAPE::swapData().

◆ m_part

std::unique_ptr<LIB_SYMBOL> SCH_SYMBOL::m_part

private

A flattened copy of the LIB_SYMBOL from the PROJECT object's libraries.

Definition at line 1127 of file sch_symbol.h.

Referenced by GetAllLibPins(), GetBodyStyleCount(), GetBodyStyleDescription(), GetDatasheet(), GetDescription(), GetEffectiveLibSymbol(), GetFullPinCount(), GetKeyWords(), GetLibPins(), GetLibSymbolRef(), GetLibSymbolRef(), GetMsgPanelInfo(), GetShownDescription(), GetShownKeyWords(), GetShowPinNames(), GetShowPinNumbers(), GetUnitCount(), GetUnitDisplayName(), GetVariantLibSymbol(), HasDeMorganBodyStyles(), IsGlobalPower(), IsLocalPower(), IsMissingLibSymbol(), IsNormal(), MapLibPins(), operator=(), Plot(), PlotPins(), ResolveTextVar(), SCH_SYMBOL(), SCH_SYMBOL(), Serialize(), SetLibSymbol(), SetShowPinNames(), SetShowPinNumbers(), SubReference(), swapData(), UpdateFields(), updatePins(), and Visit().

◆ m_passthroughMode

PASSTHROUGH_MODE SCH_SYMBOL::m_passthroughMode

private

Definition at line 1131 of file sch_symbol.h.

Referenced by GetPassthroughMode(), Init(), operator=(), operator==(), SCH_SYMBOL(), SCH_SYMBOL(), SCH_SYMBOL(), SetPassthroughMode(), and swapData().

◆ m_pinMap

std::unordered_map<SCH_PIN*, SCH_PIN*> SCH_SYMBOL::m_pinMap

private

Library pin pointer : SCH_PIN indices.

Definition at line 1136 of file sch_symbol.h.

Referenced by GetPin(), and updatePins().

◆ m_pinMapOverride

PIN_MAP_INSTANCE_OVERRIDE SCH_SYMBOL::m_pinMapOverride

private

Base (no-variant) pin-to-pad map override applied when no variant override exists for the sheet path (issue #2282).

Definition at line 1140 of file sch_symbol.h.

Referenced by GetPinMapOverride(), operator=(), SCH_SYMBOL(), SetPinMapOverride(), and swapData().

◆ m_pinNameOffset

int SYMBOL::m_pinNameOffset

protectedinherited

The offset in mils to draw the pin name.

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

Definition at line 269 of file symbol.h.

Referenced by LIB_SYMBOL::Compare(), LIB_SYMBOL::ComparisonAttributes(), GetPinNameOffset(), LIB_SYMBOL::LIB_SYMBOL(), operator=(), SetPinNameOffset(), LIB_SYMBOL::Similarity(), SYMBOL(), and SYMBOL().

◆ m_pins

std::vector<std::unique_ptr<SCH_PIN> > SCH_SYMBOL::m_pins

private

A copy of SCH_PIN objects from the library symbol.

Definition at line 1135 of file sch_symbol.h.

Referenced by ClearAnnotation(), ClearBrightenedPins(), Deserialize(), doIsConnected(), GetConnectionPoints(), GetEndPoints(), GetGraphicalPins(), GetPin(), GetPin(), GetPinByEffectivePadNumber(), GetPins(), GetPins(), GetPinsByNumber(), GetRawPins(), GetRawPins(), HasBrightenedPins(), HasConnectivityChanges(), IsMovableFromAnchorPoint(), IsPointClickableAnchor(), operator==(), operator==(), RunOnChildren(), SCH_SYMBOL(), SetLibSymbol(), SetRef(), swapData(), SyncOtherUnits(), UpdateDanglingState(), updatePins(), and Visit().

◆ m_pos

VECTOR2I SCH_SYMBOL::m_pos

private

Definition at line 1104 of file sch_symbol.h.

Referenced by doGetBoundingBox(), doIsConnected(), GetConnectionPoints(), GetDrawItem(), GetPinPhysicalPosition(), GetPosition(), Init(), IsMovableFromAnchorPoint(), MirrorHorizontally(), MirrorVertically(), Move(), operator<(), operator=(), Plot(), PlotPins(), Rotate(), SCH_SYMBOL(), SetPosition(), swapData(), UpdateDanglingState(), and UpdateFields().

◆ m_prefix

wxString SCH_SYMBOL::m_prefix

private

C, R, U, Q etc - the first character(s) which typically indicate what the symbol is.

Determined, upon placement, from the library symbol. Created upon file load, by the first non-digits in the reference fields.

Definition at line 1106 of file sch_symbol.h.

Referenced by ClearAnnotation(), GetPrefix(), GetRef(), Init(), operator<(), operator=(), operator==(), SCH_SYMBOL(), SCH_SYMBOL(), SetPrefix(), SetRef(), SetUnitSelection(), and swapData().

◆ m_previewBodyStyle

int SYMBOL::m_previewBodyStyle = 1

protectedinherited

Definition at line 281 of file symbol.h.

Referenced by LIB_SYMBOL::GetBodyAndPinsBoundingBox(), LIB_SYMBOL::GetBodyBoundingBox(), and SetPreviewBodyStyle().

◆ m_previewUnit

int SYMBOL::m_previewUnit = 1

protectedinherited

Definition at line 280 of file symbol.h.

Referenced by LIB_SYMBOL::GetBodyAndPinsBoundingBox(), LIB_SYMBOL::GetBodyBoundingBox(), and SetPreviewUnit().

◆ m_private

bool SCH_ITEM::m_private

protectedinherited

Definition at line 841 of file sch_item.h.

Referenced by IsPrivate(), SCH_FIELD::operator=(), operator=(), SCH_FIELD::SCH_FIELD(), SCH_ITEM(), SCH_ITEM(), SetPrivate(), SimilarityBase(), and SwapItemData().

◆ m_rolloverPos

VECTOR2I EDA_ITEM::m_rolloverPos

protectedinherited

Definition at line 612 of file eda_item.h.

Referenced by GetRolloverPos(), and SetIsRollover().

◆ m_rule_areas_cache

std::unordered_set<SCH_RULE_AREA*> SCH_ITEM::m_rule_areas_cache

protectedinherited

Store pointers to rule areas which this item is contained within.

Definition at line 855 of file sch_item.h.

Referenced by AddRuleAreaToCache(), ClearRuleAreasCache(), SCH_SYMBOL::GetComponentClassNames(), GetRuleAreaCache(), RemoveRuleAreaFromCache(), ResolveDNP(), ResolveExcludedFromBoard(), ResolveExcludedFromBOM(), ResolveExcludedFromPosFiles(), ResolveExcludedFromSim(), and ~SCH_ITEM().

◆ m_schLibSymbolName

wxString SCH_SYMBOL::m_schLibSymbolName

private

The name used to look up a symbol in the symbol library embedded in a schematic.

By default this is the same as LIB_ID::GetLibItemName(). However, schematics allow for multiple variants of the same library symbol. Set this member in order to preserve the link to the original symbol library. If empty, LIB_ID::GetLibItemName() should be used.

Definition at line 1118 of file sch_symbol.h.

Referenced by GetSchSymbolLibraryName(), operator<(), operator==(), operator==(), SCH_SYMBOL(), SetSchSymbolLibraryName(), swapData(), and UseLibIdLookup().

◆ m_showPinNames

bool SYMBOL::m_showPinNames

protectedinherited

Definition at line 271 of file symbol.h.

Referenced by LIB_SYMBOL::Compare(), LIB_SYMBOL::ComparisonAttributes(), GetShowPinNames(), operator=(), SetShowPinNames(), LIB_SYMBOL::Similarity(), SYMBOL(), and SYMBOL().

◆ m_showPinNumbers

bool SYMBOL::m_showPinNumbers

protectedinherited

Definition at line 272 of file symbol.h.

Referenced by LIB_SYMBOL::Compare(), LIB_SYMBOL::ComparisonAttributes(), GetShowPinNumbers(), operator=(), SetShowPinNumbers(), LIB_SYMBOL::Similarity(), SYMBOL(), and SYMBOL().

◆ m_signalName

wxString SCH_SYMBOL::m_signalName

private

Definition at line 1133 of file sch_symbol.h.

Referenced by GetNetChainName(), Init(), operator=(), operator==(), SCH_SYMBOL(), SCH_SYMBOL(), SCH_SYMBOL(), SetNetChainName(), and swapData().

◆ m_storedPos

VECTOR2I SCH_ITEM::m_storedPos

protectedinherited

Definition at line 843 of file sch_item.h.

Referenced by GetStoredPos(), and SetStoredPos().

◆ m_structType

KICAD_T EDA_ITEM::m_structType

privateinherited

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

Definition at line 605 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), IsType(), and Type().

◆ m_transform

TRANSFORM SYMBOL::m_transform

protectedinherited

The rotation/mirror transformation.

Definition at line 267 of file symbol.h.

Referenced by SCH_SYMBOL::doGetBoundingBox(), SCH_SYMBOL::doIsConnected(), SCH_SYMBOL::GetConnectionPoints(), SCH_SYMBOL::GetDrawItem(), SCH_SYMBOL::GetOrientation(), SCH_SYMBOL::GetPinPhysicalPosition(), GetTransform(), GetTransform(), SCH_SYMBOL::Init(), SCH_SYMBOL::operator=(), SCH_SYMBOL::SCH_SYMBOL(), SCH_SYMBOL::SetOrientation(), SetTransform(), SCH_SYMBOL::swapData(), and SCH_SYMBOL::UpdateDanglingState().

◆ m_unit

int SCH_ITEM::m_unit

protectedinherited

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 599 of file eda_item.h.

◆ m_variantSymbolCache

std::map<wxString, std::unique_ptr<LIB_SYMBOL> > SCH_SYMBOL::m_variantSymbolCache

mutableprivate

Definition at line 1155 of file sch_symbol.h.

Referenced by ClearCaches(), ClearVariantSymbolOverride(), GetVariantLibSymbol(), operator=(), SetLibSymbol(), SetVariantSymbolOverride(), and swapData().

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 205 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::OnDestroy(), KIGFX::VIEW::unlinkItem(), KIGFX::VIEW::updateBbox(), KIGFX::VIEW::updateLayers(), VIEW_ITEM(), viewPrivData(), and ~VIEW_ITEM().

◆ s_transformToOrientationCache

std::unordered_map< TRANSFORM, int > SCH_SYMBOL::s_transformToOrientationCache

staticprivate

See also: SCH_SYMBOL::GetOrientation

Definition at line 1158 of file sch_symbol.h.

Referenced by GetOrientation().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

◆ PASSTHROUGH_MODE

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]

◆ AddRuleAreaToCache()

◆ AddSheetPathReferenceEntryIfMissing()

◆ AddVariant()

◆ AutoplaceFields()

◆ BeginEdit()

◆ BuildLocalPowerIconShape()

◆ CalcEdit()

◆ CanConnect()

◆ ClassOf()

◆ ClearAnnotation()

◆ ClearBrightened()

◆ ClearBrightenedPins()

◆ ClearCaches()

◆ ClearConnectedItems()

◆ ClearCustomProperties()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearRuleAreasCache()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearVariantField()

◆ ClearVariantSymbolOverride()

◆ Clone()

◆ compare()

◆ ConnectedItems()

◆ Connection()

◆ ConnectionPropagatesTo()

◆ ContinueEdit()

◆ CopyVariant() [1/2]

◆ CopyVariant() [2/2]

◆ DeleteVariant() [1/2]

◆ DeleteVariant() [2/2]

◆ Deserialize() [1/2]

◆ Deserialize() [2/2]

◆ DisambiguateItemDescription()

◆ doGetBoundingBox()

◆ DoHypertextAction()

◆ doIsConnected()

◆ DoNetList()

◆ Duplicate()

◆ EndEdit()

◆ FindFieldCaseInsensitive() [1/2]

◆ FindFieldCaseInsensitive() [2/2]

◆ findParent()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAllLibPins()

◆ GetBodyAndPinsBoundingBox()

◆ GetBodyBoundingBox()

◆ GetBodyStyle()

◆ GetBodyStyleCount()

◆ GetBodyStyleDescription()

◆ GetBodyStyleProp()