Sheet symbol placed in a schematic, and is the entry point for a sub schematic. More...

#include <sch_sheet.h>

Inheritance diagram for SCH_SHEET:

Public Types
enum	COMPARE_FLAGS : int { UNIT = 0x01 , EQUALITY = 0x02 , ERC = 0x04 , SKIP_TST_POS = 0x08 }
	The list of flags used by the compare function. More...

Public Member Functions
	SCH_SHEET (EDA_ITEM *aParent=nullptr, const VECTOR2I &aPos=VECTOR2I(0, 0), VECTOR2I aSize=VECTOR2I(schIUScale.MilsToIU(MIN_SHEET_WIDTH), schIUScale.MilsToIU(MIN_SHEET_HEIGHT)))

	SCH_SHEET (const SCH_SHEET &aSheet)
	Copy aSheet into a new object.

	~SCH_SHEET ()

wxString	GetClass () const override
	Return the class name.

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.

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

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

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

const SCH_FIELD *	GetField (FIELD_T aFieldNdx) const

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

void	SetFields (const std::vector< SCH_FIELD > &aFields)
	Set multiple schematic fields.

wxString	GetShownName (bool aAllowExtraText) const

wxString	GetName () const

void	SetName (const wxString &aName)

SCH_SCREEN *	GetScreen () const

VECTOR2I	GetSize () const

void	SetSize (const VECTOR2I &aSize)

int	GetBorderWidth () const

void	SetBorderWidth (int aWidth)

KIGFX::COLOR4D	GetBorderColor () const

void	SetBorderColor (KIGFX::COLOR4D aColor)

KIGFX::COLOR4D	GetBackgroundColor () const

void	SetBackgroundColor (KIGFX::COLOR4D aColor)

bool	IsRootSheet () const

void	SetScreen (SCH_SCREEN *aScreen)
	Set the SCH_SCREEN associated with this sheet to aScreen.

int	GetScreenCount () const
	Return the number of times the associated screen for the sheet is being used.

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

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

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.

bool	IsVerticalOrientation () const

void	SetPositionIgnoringPins (const VECTOR2I &aPosition)

void	AddPin (SCH_SHEET_PIN *aSheetPin)
	Add aSheetPin to the sheet.

std::vector< SCH_SHEET_PIN * > &	GetPins ()

const std::vector< SCH_SHEET_PIN * > &	GetPins () const

void	RemovePin (const SCH_SHEET_PIN *aSheetPin)
	Remove aSheetPin from the sheet.

void	CleanupSheet ()
	Delete sheet label which do not have a corresponding hierarchical label.

SCH_SHEET_PIN *	GetPin (const VECTOR2I &aPosition)
	Return the sheet pin item found at aPosition in the sheet.

bool	HasPin (const wxString &aName) const
	Check if the sheet already has a sheet pin named aName.

bool	HasPins () const

bool	HasUndefinedPins () const
	Check all sheet labels against schematic for undefined hierarchical labels.

int	GetMinWidth (bool aFromLeft) const
	Return the minimum width of the sheet based on the widths of the sheet pin text.

int	GetMinHeight (bool aFromTop) const
	Return the minimum height that the sheet can be resized based on the sheet pin positions.

int	GetPenWidth () const override

const BOX2I	GetBodyBoundingBox () const
	Return a bounding box for the sheet body but not the fields.

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

VECTOR2I	GetRotationCenter () const
	Rotating around the boundingBox's center can cause walking when the sheetname or filename is longer than the edge it's on.

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

int	SymbolCount () const
	Count our own symbols, without the power symbols.

bool	SearchHierarchy (const wxString &aFilename, SCH_SCREEN **aScreen)
	Search the existing hierarchy for an instance of screen loaded from aFileName.

bool	LocatePathOfScreen (SCH_SCREEN aScreen, SCH_SHEET_PATH aList)
	Search the existing hierarchy for an instance of screen loaded from aFileName.

int	CountSheets () const
	Count the number of sheets found in "this" sheet including all of the subsheets.

int	CountSheets (const wxString &aFileName) const
	Count the number of sheets that refer to a specific file including all of the subsheets.

wxString	GetFileName () const
	Return the filename corresponding to this sheet.

void	SetFileName (const wxString &aFilename)

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.

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

void	Resize (const VECTOR2I &aSize)
	Resize this sheet to aSize and adjust all of the labels accordingly.

void	AutoplaceFields (SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo) override

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 the schematic item to aItemList to check if it's dangling state has changed.

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

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.

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

void	SetExcludedFromSim (bool aExcludeFromSim) override
	Set or clear the exclude from simulation flag.

bool	GetExcludedFromSim () const override

void	SetExcludedFromBOM (bool aExcludeFromBOM) override
	Set or clear the exclude from schematic bill of materials flag.

bool	GetExcludedFromBOM () const override

void	SetExcludedFromBoard (bool aExcludeFromBoard) override
	Set or clear exclude from board netlist flag.

bool	GetExcludedFromBoard () const override

bool	GetDNP () const override
	Set or clear the 'Do Not Populate' flags.

void	SetDNP (bool aDNP) override

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.

SCH_SHEET &	operator= (const SCH_ITEM &aSheet)

bool	operator< (const SCH_ITEM &aItem) const override

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

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &aPosition) override

bool	HitTest (const VECTOR2I &aPosition, int aAccuracy) 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.

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

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

bool	HasRootInstance () const
	Check to see if this sheet has a root sheet instance.

const SCH_SHEET_INSTANCE &	GetRootInstance () const
	Return the root sheet instance data.

void	RemoveInstance (const KIID_PATH &aInstancePath)

void	AddInstance (const SCH_SHEET_INSTANCE &aInstance)

bool	HasPageNumberChanges (const SCH_SHEET &aOther) const
	Check if the instance data of this sheet has any changes compared to aOther.

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

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

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 doClone=false) const
	Routine to create a new copy of given item.

virtual void	SetUnit (int aUnit)

int	GetUnit () const

virtual wxString	GetUnitDisplayName (int aUnit, bool aLabel) const

virtual wxString	GetBodyStyleDescription (int aBodyStyle, bool aLabel) const

virtual void	SetBodyStyle (int aBodyStyle)

int	GetBodyStyle () const

virtual void	SetBodyStyleProp (const wxString &aBodyStyle)

virtual wxString	GetBodyStyleProp () const

void	SetPrivate (bool aPrivate)

bool	IsPrivate () const

bool	ResolveExcludedFromSim () const

bool	ResolveExcludedFromBOM () const

bool	ResolveExcludedFromBoard () const

bool	ResolveDNP () const

VECTOR2I &	GetStoredPos ()

void	SetStoredPos (const VECTOR2I &aPos)

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

const SYMBOL *	GetParentSymbol () const

SYMBOL *	GetParentSymbol ()

virtual bool	IsHypertext () const
	Allow items to support hypertext actions when hovered/clicked.

virtual void	DoHypertextAction (EDA_DRAW_FRAME *aFrame) const

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

void	SetLayer (SCH_LAYER_ID aLayer)

int	GetEffectivePenWidth (const SCH_RENDER_SETTINGS *aSettings) const

const wxString &	GetDefaultFont (const 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

virtual bool	IsPointClickableAnchor (const VECTOR2I &aPos) 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.

const SCH_ITEM_VEC &	ConnectedItems (const SCH_SHEET_PATH &aPath)
	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)

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

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.

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

virtual bool	IsLocked () const

virtual void	SetLocked (bool aLocked)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetIsRollover (bool aIsRollover)

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

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

virtual const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers.

virtual EMBEDDED_FILES *	GetEmbeddedFiles ()

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

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

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

Static Public Member Functions
static bool	ClassOf (const EDA_ITEM *aItem)

static int	ComparePageNum (const wxString &aPageNumberA, const wxString &aPageNumberB)
	Compare page numbers of schematic sheets.

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	setInstances (const std::vector< SCH_SHEET_INSTANCE > &aInstances)

bool	addInstance (const KIID_PATH &aInstance)
	Add a new instance aSheetPath to the instance list.

wxString	getPageNumber (const KIID_PATH &aParentPath) const
	Return the sheet page number for aParentPath.

void	setPageNumber (const KIID_PATH &aInstance, const wxString &aPageNumber)
	Set the page number for the sheet instance aInstance.

bool	getInstance (SCH_SHEET_INSTANCE &aInstance, const KIID_PATH &aSheetPath, bool aTestFromEnd=false) const

void	renumberPins ()
	Renumber the sheet pins in the sheet.

SCH_SHEET_PATH	findSelf () const
	Get the sheetpath of this sheet.

SCH_RENDER_SETTINGS *	getRenderSettings (PLOTTER *aPlotter) const

virtual int	compare (const SCH_ITEM &aOther, int aCompareFlags=0) 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
friend	SCH_SHEET_PATH

friend	SCH_IO_KICAD_SEXPR_PARSER

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

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.

bool	m_forceVisible

bool	m_isRollover

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
bool	doIsConnected (const VECTOR2I &aPosition) const override
	Provide the object specific test to see if it is connected to aPosition.

Private Attributes
SCH_SCREEN *	m_screen

std::vector< SCH_SHEET_PIN * >	m_pins

std::vector< SCH_FIELD >	m_fields

bool	m_excludedFromSim

bool	m_excludedFromBOM

bool	m_excludedFromBoard

bool	m_DNP

VECTOR2I	m_pos

VECTOR2I	m_size

int	m_borderWidth

KIGFX::COLOR4D	m_borderColor

KIGFX::COLOR4D	m_backgroundColor

std::vector< SCH_SHEET_INSTANCE >	m_instances

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.

Friends
class	SCH_SHEET_PIN

class	SCH_SHEET_LIST

Detailed Description

Sheet symbol placed in a schematic, and is the entry point for a sub schematic.

Definition at line 46 of file sch_sheet.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum SCH_ITEM::COMPARE_FLAGS : int

inherited

The list of flags used by the compare function.

UNIT This flag relaxes unit, body-style and pin-number constraints. It is used for SCH_ITEM object unit comparisons.

EQUALITY This flag relaxes ordering constraints so that fields, etc. don't have to appear in the same order to be considered equal.

ERC This flag relaxes constraints on data that is settable in the schematic editor. It compares only symbol-editor-only data.

SKIP_TST_POS This flag relaxes comparisons on position (mainly for fields) for ERC.

Enumerator
UNIT
EQUALITY
ERC
SKIP_TST_POS

Definition at line 666 of file sch_item.h.

Constructor & Destructor Documentation

◆ SCH_SHEET() [1/2]

SCH_SHEET::SCH_SHEET	(	EDA_ITEM *	aParent = nullptr,
		const VECTOR2I &	aPos = VECTOR2I( 0, 0 ),
		VECTOR2I	aSize = VECTOR2I( schIUScale.MilsToIU( MIN_SHEET_WIDTH ), schIUScale.MilsToIU( MIN_SHEET_HEIGHT ) ) )

Definition at line 54 of file sch_sheet.cpp.

References AUTOPLACE_AUTO, AutoplaceFields(), DO_TRANSLATE, EDA_ITEM::EDA_ITEM(), GetDefaultFieldName(), LAYER_SHEET, m_backgroundColor, m_borderColor, m_borderWidth, m_DNP, m_excludedFromBoard, m_excludedFromBOM, m_excludedFromSim, m_fields, SCH_ITEM::m_fieldsAutoplaced, SCH_ITEM::m_layer, m_pos, m_screen, m_size, SCH_ITEM::SCH_ITEM(), SCH_SHEET_T, SHEET_FILENAME, SHEET_NAME, and COLOR4D::UNSPECIFIED.

Referenced by Clone(), CountSheets(), CountSheets(), findSelf(), HasConnectivityChanges(), HasPageNumberChanges(), LocatePathOfScreen(), operator<(), operator=(), operator==(), SCH_SHEET(), SearchHierarchy(), Similarity(), swapData(), and SymbolCount().

◆ SCH_SHEET() [2/2]

SCH_SHEET::SCH_SHEET ( const SCH_SHEET & aSheet )

Copy aSheet into a new object.

All sheet pins are copied as is except and the SCH_SHEET_PIN object's #m_Parent pointers are set to the new copied parent object.

Definition at line 81 of file sch_sheet.cpp.

References m_backgroundColor, m_borderColor, m_borderWidth, m_DNP, m_excludedFromBoard, m_excludedFromBOM, m_excludedFromSim, m_fields, SCH_ITEM::m_fieldsAutoplaced, m_instances, SCH_ITEM::m_layer, m_pins, m_pos, m_screen, m_size, EDA_ITEM::m_Uuid, pin, SCH_ITEM::SCH_ITEM(), SCH_SHEET(), and SCH_SHEET_PIN.

◆ ~SCH_SHEET()

SCH_SHEET::~SCH_SHEET ( )

Definition at line 116 of file sch_sheet.cpp.

References m_pins, m_screen, pin, and SCH_SHEET_PIN.

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

References m_connected_items, and SCH_ITEM().

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

◆ AddInstance()

void SCH_SHEET::AddInstance ( const SCH_SHEET_INSTANCE & aInstance )

Definition at line 1367 of file sch_sheet.cpp.

References getInstance(), m_instances, SCH_SHEET_INSTANCE::m_Path, and RemoveInstance().

Referenced by SCH_EDITOR_CONTROL::Paste().

◆ addInstance()

bool SCH_SHEET::addInstance ( const KIID_PATH & aInstance )

protected

Add a new instance aSheetPath to the instance list.

If aSheetPath does not already exist, it is added to the list. If already exists in the list, do nothing. Sheet instances allow for the sharing in complex hierarchies which allows for per instance data such as page number for sheets to stored.

Warning: The KIID_PATH object must be a full hierarchical path which means the sheet at index 0 must be the root sheet.

Parameters

[in] aInstance is the SCH_SHEET_PATH of the sheet instance to the instance list.

Returns: false if the instance already exists, true if the instance was added.

Definition at line 1379 of file sch_sheet.cpp.

References KIID_PATH::AsString(), GetName(), m_instances, SCH_SHEET_INSTANCE::m_Path, and traceSchSheetPaths.

Referenced by SCH_SHEET_LIST::AddNewSheetInstances(), and SCH_SHEET_PATH::SetPageNumber().

◆ AddPin()

void SCH_SHEET::AddPin ( SCH_SHEET_PIN * aSheetPin )

Add aSheetPin to the sheet.

Note: Once a sheet pin is added to the sheet, it is owned by the sheet. Do not delete the sheet pin object or you will likely get a segfault when the sheet is destroyed.

Parameters

aSheetPin The sheet pin item to add to the sheet.

Definition at line 401 of file sch_sheet.cpp.

References m_pins, renumberPins(), SCH_SHEET_PIN, SCH_SHEET_PIN_T, EDA_ITEM::SetParent(), and EDA_ITEM::Type().

Referenced by SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ AddRuleAreaToCache()

void SCH_ITEM::AddRuleAreaToCache ( SCH_RULE_AREA * aRuleArea )

inlineinherited

Add a rule area to the item's cache.

Definition at line 640 of file sch_item.h.

References m_rule_areas_cache.

Referenced by SCH_RULE_AREA::addContainedItem().

◆ AutoplaceFields()

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

overridevirtual

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

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

Definition at line 433 of file sch_item.h.

◆ CanConnect()

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

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 366 of file sch_sheet.h.

References SCH_ITEM::GetLayer(), LAYER_BUS, LAYER_WIRE, SCH_ITEM::SCH_ITEM(), SCH_LINE_T, SCH_NO_CONNECT_T, SCH_SYMBOL_T, and EDA_ITEM::Type().

◆ ClassOf()

static bool SCH_SHEET::ClassOf ( const EDA_ITEM * aItem )

inlinestatic

Definition at line 63 of file sch_sheet.h.

References EDA_ITEM::EDA_ITEM(), SCH_SHEET_T, and EDA_ITEM::Type().

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadNets().

◆ CleanupSheet()

void SCH_SHEET::CleanupSheet ( )

Delete sheet label which do not have a corresponding hierarchical label.

Note: Make sure you save a copy of the sheet in the undo list before calling CleanupSheet() otherwise any unreferenced sheet labels will be lost.

Definition at line 588 of file sch_sheet.cpp.

References EDA_TEXT::GetText(), m_pins, m_screen, pin, SCH_HIER_LABEL_T, SCH_ITEM::SCH_ITEM(), and SCH_SHEET_PIN.

Referenced by SCH_EDIT_TOOL::CleanupSheetPins().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 138 of file eda_item.h.

References BRIGHTENED, and ClearFlags().

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

◆ ClearCaches()

void SCH_ITEM::ClearCaches ( )

virtualinherited

Reimplemented in SCH_FIELD.

Definition at line 497 of file sch_item.cpp.

References NO_RECURSE, RunOnChildren(), SCH_ITEM(), and text.

◆ ClearConnectedItems()

void SCH_ITEM::ClearConnectedItems ( const SCH_SHEET_PATH & aPath )

inherited

Clear all connections to this item.

Definition at line 373 of file sch_item.cpp.

References m_connected_items.

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

◆ ClearEditFlags()

virtual void EDA_ITEM::ClearEditFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 156 of file eda_item.h.

References ClearFlags(), and GetEditFlags().

Referenced by BOARD::Add(), FOOTPRINT::Add(), LIB_SYMBOL::ClearEditFlags(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::PlaceItem(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::PutDataInPreviousState(), BOARD_COMMIT::Revert(), SCH_ITEM::SwapFlags(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 144 of file eda_item.h.

References EDA_ITEM_ALL_FLAGS, and m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), PNS_KICAD_IFACE_GENERATOR::AddItem(), SCH_MOVE_TOOL::AlignToGrid(), PCB_CONTROL::ApplyDesignBlockLayout(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), ClearBrightened(), ClearEditFlags(), ClearSelected(), ClearTempFlags(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SCH_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), PCB_TUNING_PATTERN::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), PCB_EDIT_FRAME::ExchangeFootprint(), SCH_IO_KICAD_SEXPR::Format(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_COMMIT::pushSchEdit(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), PAD::Recombine(), GERBVIEW_FRAME::RemapLayers(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin(), SCH_SELECTION_TOOL::SelectMultiple(), SetIsShownAsBitmap(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_SELECTION_TOOL::unhighlight(), 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 635 of file sch_item.h.

References m_rule_areas_cache.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 137 of file eda_item.h.

References ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_DIFF_WIDGET::DisplayDiff(), EDIT_TOOL::Duplicate(), LIB_SYMBOL::LIB_SYMBOL(), ARRAY_TOOL::onDialogClosed(), SCH_COMMIT::Revert(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), SCH_COMMIT::Stage(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), PL_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearTempFlags()

virtual void EDA_ITEM::ClearTempFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 169 of file eda_item.h.

References ClearFlags(), and GetTempFlags().

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

◆ Clone()

EDA_ITEM * SCH_SHEET::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 134 of file sch_sheet.cpp.

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

Referenced by SCH_DRAWING_TOOLS::DrawSheet().

◆ compare()

int SCH_ITEM::compare	(	const SCH_ITEM &	aOther,
		int	aCompareFlags = 0 ) 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 541 of file sch_item.cpp.

References EQUALITY, ERC, EDA_ITEM::GetPosition(), IsPrivate(), m_bodyStyle, m_unit, EDA_ITEM::m_Uuid, SCH_ITEM(), SKIP_TST_POS, EDA_ITEM::Type(), UNIT, 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<(), and operator==().

◆ ComparePageNum()

int SCH_SHEET::ComparePageNum	(	const wxString &	aPageNumberA,
		const wxString &	aPageNumberB )

static

Compare page numbers of schematic sheets.

Returns: 0 if the page numbers are equal, -1 if aPageNumberA < aPageNumberB, 1 otherwise

Definition at line 1537 of file sch_sheet.cpp.

References std::abs(), result, and StrNumCmp().

Referenced by SCH_SHEET_PATH::ComparePageNum(), SCH_SHEET_LIST::SortByHierarchicalPageNumbers(), and SCH_SHEET_LIST::SortByPageNumbers().

◆ ConnectedItems()

const SCH_ITEM_VEC & SCH_ITEM::ConnectedItems ( const SCH_SHEET_PATH & aPath )

inherited

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

Definition at line 382 of file sch_item.cpp.

References m_connected_items.

Referenced by addConnections(), BOOST_FIXTURE_TEST_CASE(), CONNECTION_GRAPH::boost_test_update_symbol_connectivity, 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 323 of file sch_item.cpp.

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

Referenced by CONNECTION_SUBGRAPH::Absorb(), CONNECTION_SUBGRAPH::AddItem(), CONNECTION_GRAPH::boost_test_update_generic_connectivity, CONNECTION_GRAPH::boost_test_update_symbol_connectivity, CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_SUBGRAPH::ExchangeItem(), SCH_DRAWING_TOOLS::findWireLabelDriverName(), CONNECTION_GRAPH::GetBusesNeedingMigration(), GetEffectiveNetClass(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_JUNCTION::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), GetOrInitConnection(), highlightNet(), InitializeConnection(), SCH_LABEL_BASE::Matches(), SCH_PIN::Matches(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_TEXT::Plot(), NETLIST_EXPORTER_SPICE_MODEL::readPorts(), SCH_EDIT_FRAME::RecalculateConnections(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_LABEL_BASE::ResolveTextVar(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), SCH_EDITOR_CONTROL::SimProbe(), BUS_UNFOLD_MENU::update(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ ConnectionPropagatesTo()

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

inlinevirtualinherited

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

Reimplemented in SCH_BUS_WIRE_ENTRY, SCH_LINE, and SCH_PIN.

Definition at line 552 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 415 of file sch_item.h.

◆ CountSheets() [1/2]

int SCH_SHEET::CountSheets ( ) const

Count the number of sheets found in "this" sheet including all of the subsheets.

Returns: the full count of sheets+subsheets contained by "this"

Definition at line 831 of file sch_sheet.cpp.

References CountSheets(), m_screen, SCH_ITEM::SCH_ITEM(), SCH_SHEET(), and SCH_SHEET_T.

Referenced by CountSheets(), CountSheets(), and SCHEMATIC::SetSheetNumberAndCount().

◆ CountSheets() [2/2]

int SCH_SHEET::CountSheets ( const wxString & aFileName ) const

Count the number of sheets that refer to a specific file including all of the subsheets.

Parameters

aFileName The filename to search for.

Returns: the full count of sheets+subsheets that refer to aFileName

Definition at line 814 of file sch_sheet.cpp.

References CountSheets(), m_screen, SCH_ITEM::SCH_ITEM(), SCH_SHEET(), and SCH_SHEET_T.

◆ Deserialize()

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

virtualinherited

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 in BOARD_STACKUP, EDA_SHAPE, EDA_TEXT, FOOTPRINT, NETCLASS, PAD, PADSTACK, PCB_ARC, PCB_DIM_ALIGNED, PCB_DIM_CENTER, PCB_DIM_LEADER, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIMENSION_BASE, PCB_FIELD, PCB_GROUP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LABEL, SCH_LINE, and ZONE.

Definition at line 30 of file serializable.cpp.

Referenced by ~SERIALIZABLE().

◆ DoHypertextAction()

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

inlinevirtualinherited

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 304 of file sch_item.h.

◆ doIsConnected()

bool SCH_SHEET::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 441 of file sch_sheet.cpp.

References m_pins, and SCH_SHEET_PIN.

◆ Duplicate()

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

inherited

Routine to create a new copy of given item.

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

Parameters

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.
aDoClone	(default = false) indicates unique values (such as timestamp and sheet name) should be duplicated. Use only for undo/redo operations.

Definition at line 137 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(), and SELECTED.

Referenced by SCH_EDIT_FRAME::AddCopyForRepeatItem(), 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_LINE::NonGroupAware_BreakAt(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), 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 422 of file sch_item.h.

◆ findParent()

EDA_ITEM * EDA_ITEM::findParent ( KICAD_T aType ) const

protectedinherited

Definition at line 75 of file eda_item.cpp.

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

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

◆ findSelf()

SCH_SHEET_PATH SCH_SHEET::findSelf ( ) const

protected

Get the sheetpath of this sheet.

NB: REQUIRES that the current sheet hierarchy contains the given sheet.

Definition at line 1033 of file sch_sheet.cpp.

References SCHEMATIC::CurrentSheet(), SCH_SHEET_PATH::empty(), SCH_SHEET_PATH::Last(), SCH_SHEET_PATH::pop_back(), SCH_SHEET_PATH::push_back(), SCH_SHEET(), SCH_SHEET_PATH, and SCH_ITEM::Schematic().

Referenced by GetContextualTextVars(), and Plot().

◆ Get() [1/3]

template<typename T>

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

inlineinherited

Definition at line 141 of file inspectable.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

inlineinherited

Definition at line 121 of file inspectable.h.

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

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), PROPERTIES_PANEL::getItemValue(), PCBEXPR_VAR_REF::GetValue(), and SCHEMATIC::SCHEMATIC().

◆ Get() [3/3]

template<typename T>

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 129 of file inspectable.h.

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

◆ GetBackgroundColor()

KIGFX::COLOR4D SCH_SHEET::GetBackgroundColor ( ) const

inline

Definition at line 127 of file sch_sheet.h.

References m_backgroundColor.

Referenced by KIGFX::SCH_PAINTER::getRenderColor(), operator==(), Plot(), SCH_IO_KICAD_SEXPR::saveSheet(), and SCH_SHEET_DESC::SCH_SHEET_DESC().

◆ GetBodyBoundingBox()

const BOX2I SCH_SHEET::GetBodyBoundingBox ( ) const

Return a bounding box for the sheet body but not the fields.

Definition at line 693 of file sch_sheet.cpp.

References end, GetPenWidth(), BOX2< Vec >::Inflate(), m_pos, m_size, and BOX2< Vec >::SetEnd().

Referenced by SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), GetBoundingBox(), HitTest(), HitTest(), HitTest(), Plot(), and SCH_EDIT_TOOL::Rotate().

◆ GetBodyStyle()

int SCH_ITEM::GetBodyStyle ( ) const

inlineinherited

Definition at line 244 of file sch_item.h.

References m_bodyStyle.

◆ GetBodyStyleDescription()

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

virtualinherited

Reimplemented in LIB_SYMBOL, and SCH_SYMBOL.

Definition at line 179 of file sch_item.cpp.

References _, _HKI, and GetParentSymbol().

Referenced by PIN_INFO_FORMATTER::Format(), GetBodyStyleProp(), GetMsgPanelInfo(), and PIN_INFO_FORMATTER::UpdatePin().

◆ GetBodyStyleProp()

wxString SCH_ITEM::GetBodyStyleProp ( ) const

virtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 211 of file sch_item.cpp.

References GetBodyStyleDescription(), and m_bodyStyle.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ GetBorderColor()

KIGFX::COLOR4D SCH_SHEET::GetBorderColor ( ) const

inline

Definition at line 124 of file sch_sheet.h.

References m_borderColor.

Referenced by KIGFX::SCH_PAINTER::getRenderColor(), operator==(), Plot(), SCH_IO_KICAD_SEXPR::saveSheet(), and SCH_SHEET_DESC::SCH_SHEET_DESC().

◆ GetBorderWidth()

int SCH_SHEET::GetBorderWidth ( ) const

inline

Definition at line 121 of file sch_sheet.h.

References m_borderWidth.

Referenced by GetPenWidth(), operator==(), SCH_IO_KICAD_SEXPR::saveSheet(), and SCH_SHEET_DESC::SCH_SHEET_DESC().

◆ GetBoundingBox()

const BOX2I SCH_SHEET::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 714 of file sch_sheet.cpp.

References GetBodyBoundingBox(), m_fields, and BOX2< Vec >::Merge().

Referenced by SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::Mirror(), Plot(), and SCH_EDIT_TOOL::Rotate().

◆ GetCachedDriverName()

const wxString & SCH_ITEM::GetCachedDriverName ( ) const

virtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 443 of file sch_item.cpp.

Referenced by CONNECTION_SUBGRAPH::GetNameForDriver().

◆ GetClass()

wxString SCH_SHEET::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 68 of file sch_sheet.h.

Referenced by operator=().

◆ GetConnectionPoints()

std::vector< VECTOR2I > SCH_SHEET::GetConnectionPoints ( ) const

overridevirtual

Add all the connection points for this item to aPoints.

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

Parameters

aPoints is the list of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 1112 of file sch_sheet.cpp.

References m_pins, and SCH_SHEET_PIN.

◆ GetContextualTextVars()

void SCH_SHEET::GetContextualTextVars ( wxArrayString * aVars ) const

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

Definition at line 180 of file sch_sheet.cpp.

References alg::contains(), findSelf(), GetContextualTextVars(), SCHEMATIC::GetContextualTextVars(), SCH_SHEET_PATH::Last(), m_fields, m_screen, SCH_SHEET_PATH::pop_back(), SCH_SHEET_PATH, SCH_ITEM::Schematic(), and SCH_SHEET_PATH::size().

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

◆ GetDefaultFont()

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

inherited

Definition at line 580 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().

◆ GetDNP()

bool SCH_SHEET::GetDNP ( ) const

inlineoverridevirtual

Set or clear the 'Do Not Populate' flags.

Reimplemented from SCH_ITEM.

Definition at line 402 of file sch_sheet.h.

References m_DNP.

Referenced by KIGFX::SCH_PAINTER::draw(), GetMsgPanelInfo(), operator==(), Plot(), SCH_IO_KICAD_SEXPR::saveSheet(), and SCH_SHEET_DESC::SCH_SHEET_DESC().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

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

virtual EMBEDDED_FILES * EDA_ITEM::GetEmbeddedFiles ( )

inlinevirtualinherited

Reimplemented in BOARD, FOOTPRINT, LIB_SYMBOL, SCH_SYMBOL, and SCHEMATIC.

Definition at line 468 of file eda_item.h.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::Parse().

◆ GetEmbeddedFonts()

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

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 655 of file sch_item.cpp.

References GetParentSymbol(), and Schematic().

◆ GetEndPoints()

void SCH_SHEET::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 1053 of file sch_sheet.cpp.

References m_pins, SCH_SHEET_PIN, and SCH_SHEET_PIN_T.

◆ GetExcludedFromBoard()

bool SCH_SHEET::GetExcludedFromBoard ( ) const

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 397 of file sch_sheet.h.

References m_excludedFromBoard.

Referenced by GetMsgPanelInfo(), operator==(), SCH_IO_KICAD_SEXPR::saveSheet(), and SCH_SHEET_DESC::SCH_SHEET_DESC().

◆ GetExcludedFromBOM()

bool SCH_SHEET::GetExcludedFromBOM ( ) const

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 391 of file sch_sheet.h.

References m_excludedFromBOM.

Referenced by GetMsgPanelInfo(), operator==(), SCH_IO_KICAD_SEXPR::saveSheet(), and SCH_SHEET_DESC::SCH_SHEET_DESC().

◆ GetExcludedFromSim()

bool SCH_SHEET::GetExcludedFromSim ( ) const

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 385 of file sch_sheet.h.

References m_excludedFromSim.

Referenced by KIGFX::SCH_PAINTER::draw(), GetMsgPanelInfo(), operator==(), SCH_IO_KICAD_SEXPR::saveSheet(), and SCH_SHEET_DESC::SCH_SHEET_DESC().

◆ GetField() [1/2]

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

Definition at line 380 of file sch_sheet.cpp.

References FindField(), and m_fields.

◆ GetField() [2/2]

SCH_FIELD * SCH_SHEET::GetField ( FIELD_T aFieldType )

Return a mandatory field in this sheet.

The const version will return nullptr if the field does not exist; the non-const version will create it.

Definition at line 370 of file sch_sheet.cpp.

References FindField(), and m_fields.

Referenced by AutoplaceFields(), HIERARCHY_PANE::buildHierarchyTree(), SCH_PLOTTER::createPDFFile(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_DRAWING_TOOLS::DrawSheet(), GetFileName(), GetItemDescription(), GetName(), GetShownName(), LTSPICE_SCHEMATIC::Load(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), HIERARCHY_PANE::onTreeEditFinished(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathHumanReadable(), positioningChanged(), HIERARCHY_PANE::renameIdenticalSheets(), SCH_IO_KICAD_LEGACY::saveSheet(), SetFields(), SetFileName(), SetName(), HIERARCHY_PANE::UpdateLabelsHierarchyTree(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetFields() [1/2]

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

inline

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

Definition at line 87 of file sch_sheet.h.

References m_fields.

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), SCH_FIND_REPLACE_TOOL::nextMatch(), operator==(), Plot(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_EDIT_FRAME::SaveSheetAsDesignBlock(), SCH_EDIT_FRAME::SaveSheetToDesignBlock(), ERC_TESTER::TestTextVars(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetFields() [2/2]

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

inline

Definition at line 88 of file sch_sheet.h.

References m_fields.

◆ GetFieldsAutoplaced()

AUTOPLACE_ALGO SCH_ITEM::GetFieldsAutoplaced ( ) const

inlineinherited

Return whether the fields have been automatically placed.

Definition at line 592 of file sch_item.h.

References m_fieldsAutoplaced.

Referenced by SCH_EDIT_TOOL::editFieldText(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_IO_KICAD_SEXPR::saveText(), and SCH_EDIT_FRAME::SelectUnit().

◆ GetFileName()

wxString SCH_SHEET::GetFileName ( ) const

inline

Return the filename corresponding to this sheet.

Returns: a wxString containing the filename

Definition at line 321 of file sch_sheet.h.

References GetField(), EDA_TEXT::GetText(), and SHEET_FILENAME.

Referenced by SCH_SHEET_LIST::BuildSheetList(), CADSTAR_SCH_ARCHIVE_LOADER::CreateLibName(), SCH_EDIT_FRAME::doAutoSave(), SCH_EDITOR_CONTROL::doCopy(), GetMsgPanelInfo(), HasConnectivityChanges(), KI_TEST::LoadHierarchy(), SCH_IO_KICAD_LEGACY::loadHierarchy(), SCH_IO_KICAD_SEXPR::loadHierarchy(), LoadSchematic(), SCH_IO_KICAD_LEGACY::LoadSchematicFile(), SCH_IO_KICAD_SEXPR::LoadSchematicFile(), SCH_SHEET_PATH::MakeFilePathRelativeToParentSheet(), operator<(), SCH_IO_ALTIUM::ParseAltiumSch(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDITOR_CONTROL::SaveCurrSheetCopyAs(), SCH_EDIT_FRAME::SaveProject(), SCH_SHEET_LIST::TestForRecursion(), SCH_SHEET_PATH::TestForRecursion(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 145 of file eda_item.h.

References m_flags.

Referenced by BuildBoardPolygonOutlines(), collidesWithArea(), PCB_TABLE::DeleteMarkedCells(), SCH_TABLE::DeleteMarkedCells(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), PCB_TUNING_PATTERN::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_SELECTION_TOOL::filterCollectorForHierarchy(), findNext(), intersectsAreaFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), LIB_SYMBOL::LIB_SYMBOL(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD::Recombine(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_IO_KICAD_SEXPR::saveTable(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and PCB_TUNING_PATTERN::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 279 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

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 171 of file view_item.h.

References m_forcedTransparency.

Referenced by KIGFX::SCH_PAINTER::draw(), EDA_ITEM::EDA_ITEM(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), and EDA_ITEM::operator=().

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, PCB_TABLECELL, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, SCH_FIELD, SCH_LINE, SCH_PIN, SCH_RULE_AREA, SCH_TEXT, and ZONE.

Definition at line 401 of file eda_item.cpp.

References GetTypeDesc().

Referenced by API_HANDLER_PCB::createItemForType(), API_HANDLER_SCH::createItemForType(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), and PROPERTIES_PANEL::rebuildProperties().

◆ getInstance()

bool SCH_SHEET::getInstance	(	SCH_SHEET_INSTANCE &	aInstance,
		const KIID_PATH &	aSheetPath,
		bool	aTestFromEnd = false ) const

protected

Definition at line 1402 of file sch_sheet.cpp.

References m_instances.

Referenced by AddInstance(), and SCH_SHEET_LIST::AddNewSheetInstances().

◆ GetInstances()

const std::vector< SCH_SHEET_INSTANCE > & SCH_SHEET::GetInstances ( ) const

inline

Returns: the list of SCH_SHEET_INSTANCE objects for this sheet.

Definition at line 430 of file sch_sheet.h.

References m_instances.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::getSheetSymbolReferences(), HasPageNumberChanges(), SCH_EDITOR_CONTROL::Paste(), SCH_SCREEN::PruneOrphanedSheetInstances(), and SCH_IO_KICAD_SEXPR::saveSheet().

◆ GetItemDescription()

wxString SCH_SHEET::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

aLong indicates a long string is acceptable

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 1170 of file sch_sheet.cpp.

References _, KIUI::EllipsizeMenuText(), GetField(), SCH_FIELD::GetShownText(), EDA_TEXT::GetText(), and SHEET_NAME.

◆ GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 309 of file sch_item.h.

References m_layer.

Referenced by JUNCTION_HELPERS::AnalyzePoint(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), CanConnect(), SCH_LABEL_BASE::CanConnect(), SCH_LINE::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_SHEET::CanConnect(), SCH_SYMBOL::CanConnect(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckDanglingWireEndpoints(), CONNECTION_GRAPH::ercCheckFloatingWires(), SCH_LINE::GetFriendlyName(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), GetNetNavigatorItemText(), SCH_LINE::IsBus(), SCH_LINE::IsGraphicLine(), SCH_LINE::IsWire(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_LINE::operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), SCH_BUS_ENTRY_BASE::operator==(), SCH_LINE::operator==(), SCH_TEXT::operator==(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_JUNCTION::Plot(), SCH_LINE::Plot(), SCH_SCREEN::Plot(), SCH_IO_KICAD_LEGACY::saveBusEntry(), SCH_IO_KICAD_LEGACY::saveLine(), SCH_IO_KICAD_SEXPR::saveLine(), SCH_IO_KICAD_LEGACY::saveText(), SCH_LINE::Serialize(), SCH_BUS_ENTRY_BASE::Similarity(), SCH_LINE::Similarity(), SCH_TEXT::Similarity(), SCH_EDIT_FRAME::TrimWire(), CONNECTION_GRAPH::updateGenericItemConnectivity(), CONNECTION_GRAPH::updateItemConnectivity(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetMenuImage()

BITMAPS SCH_SHEET::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 1180 of file sch_sheet.cpp.

References add_hierarchical_subsheet.

◆ GetMinHeight()

int SCH_SHEET::GetMinHeight ( bool aFromTop ) const

Return the minimum height that the sheet can be resized based on the sheet pin positions.

The minimum width of a sheet is determined by the Y axis location of the bottom most sheet pin. If at some point in the future sheet objects can be rotated or pins can be placed in the vertical orientation, this function will need to be changed.

Returns: The minimum height the sheet can be resized.

Definition at line 554 of file sch_sheet.cpp.

References bumpToNextGrid(), BOX2< Vec >::GetBottom(), BOX2< Vec >::GetTop(), LEFT, m_pins, m_pos, m_size, MIN_SHEET_HEIGHT, RIGHT, and schIUScale.

◆ GetMinWidth()

int SCH_SHEET::GetMinWidth ( bool aFromLeft ) const

Return the minimum width of the sheet based on the widths of the sheet pin text.

The minimum sheet width is determined by the width of the bounding box of each hierarchical sheet pin. If two pins are horizontally adjacent ( same Y position ) to each other, the sum of the bounding box widths is used. If at some point in the future sheet objects can be rotated or pins can be placed in the vertical orientation, this function will need to be changed.

Returns: The minimum width the sheet can be resized.

Definition at line 520 of file sch_sheet.cpp.

References BOTTOM, bumpToNextGrid(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), m_pins, m_pos, m_size, MIN_SHEET_WIDTH, schIUScale, and TOP.

◆ GetMsgPanelInfo()

void SCH_SHEET::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 845 of file sch_sheet.cpp.

References _, KIUI::EllipsizeStatusText(), GetDNP(), GetExcludedFromBoard(), GetExcludedFromBOM(), GetExcludedFromSim(), GetFileName(), GetName(), path, and SCH_SHEET_PATH.

◆ GetName()

wxString SCH_SHEET::GetName ( ) const

inline

◆ GetNextFieldOrdinal()

int SCH_SHEET::GetNextFieldOrdinal ( ) const

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

Definition at line 386 of file sch_sheet.cpp.

References m_fields, and NextFieldOrdinal().

◆ GetOrInitConnection()

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

inherited

Definition at line 428 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().

◆ getPageNumber()

wxString SCH_SHEET::getPageNumber ( const KIID_PATH & aParentPath ) const

protected

Return the sheet page number for aParentPath.

Warning: The KIID_PATH object must be a full hierarchical path which means the sheet at index 0 must be the root sheet.

Parameters

aParentPath is the hierarchical path of the sheet that contains an instance of this SCH_SHEET

Returns: the page number for the requested sheet instance.

Definition at line 1454 of file sch_sheet.cpp.

References m_instances.

Referenced by SCH_SHEET_PATH::GetPageNumber(), and SCH_SHEET_LIST::SortByHierarchicalPageNumbers().

◆ 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(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), findParent(), SCH_IO_KICAD_SEXPR::Format(), getClosestGroup(), SCH_TABLECELL::GetColumn(), SCH_TABLECELL::GetColumnWidth(), SCH_ITEM::GetEffectivePenWidth(), SCH_FIELD::GetFieldColor(), getInferredSymbols(), SCH_TABLECELL::GetParentGroup(), SCH_TABLECELL::GetRow(), SCH_TABLECELL::GetRowHeight(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_SELECTION_TOOL::highlight(), highlightNet(), SCH_FIELD::HitTest(), SCH_FIELD::HitTest(), SCH_FIELD::HitTest(), 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(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_SELECTION_TOOL::RequestSelection(), SCH_COMMIT::Revert(), SCH_EDIT_TOOL::Rotate(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCHEMATIC::SCHEMATIC(), SCH_SCREEN::Schematic(), SCH_SHEET::SearchHierarchy(), PCB_SELECTION_TOOL::select(), SCH_MARKER::SerializeToString(), SCH_TABLECELL::SetColumnWidth(), SCH_LABEL_BASE::SetLabelShape(), SCH_TABLECELL::SetRowHeight(), SYMBOL_EDITOR_EDIT_TOOL::Swap(), SCH_ITEM::SwapItemData(), 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(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SCH_MOVE_TOOL::doMoveSelection(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), GENERATOR_TOOL::GENERATOR_TOOL(), getClosestGroup(), getClosestGroup(), PCB_TABLECELL::GetParentGroup(), SCH_TABLECELL::GetParentGroup(), GetParentGroupId(), BOARD_ITEM::IsLocked(), memberOfGroupFunc(), BOARD_EDITOR_CONTROL::modifyLockSelected(), BOARD::Move(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), PNS_KICAD_IFACE::RemoveItem(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), COMMIT::Stage(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), 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 91 of file eda_item.cpp.

References GetParentGroup(), group, and niluuid.

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

◆ GetParentSymbol() [1/2]

SYMBOL * SCH_ITEM::GetParentSymbol ( )

inherited

Definition at line 235 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 223 of file sch_item.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE(), SCH_PIN::compare(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), 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(), GetBodyStyleDescription(), SCH_PIN::GetDefaultNetName(), CONNECTION_SUBGRAPH::GetDriverPriority(), GetEmbeddedFonts(), SCH_FIELD::GetFullText(), SCH_PIN::GetItemDescription(), GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_PIN::GetPinRoot(), SCH_PIN::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), GetUnitDisplayName(), SCH_PIN::IsGlobalPower(), SCH_PIN::IsLocalPower(), SCH_PIN::MirrorHorizontally(), SCH_PIN::MirrorVertically(), NETLIST_EXPORTER_ALLEGRO::NET_NODE::operator<(), SCH_FIELD::operator==(), orientLabel(), SCH_PIN::Plot(), SCH_PIN::Replace(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_PIN::Rotate(), SCH_ITEM_DESC::SCH_ITEM_DESC(), SetBodyStyleProp(), SCH_SHAPE::SetFilled(), and SCH_EDITOR_CONTROL::SimProbe().

◆ GetPenWidth()

int SCH_SHEET::GetPenWidth ( ) const

overridevirtual

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

Reimplemented from SCH_ITEM.

Definition at line 626 of file sch_sheet.cpp.

References DEFAULT_LINE_WIDTH_MILS, GetBorderWidth(), SCHEMATIC_SETTINGS::m_DefaultLineWidth, SCH_ITEM::Schematic(), schIUScale, and SCHEMATIC::Settings().

Referenced by AutoplaceFields(), and GetBodyBoundingBox().

◆ GetPin()

SCH_SHEET_PIN * SCH_SHEET::GetPin ( const VECTOR2I & aPosition )

Return the sheet pin item found at aPosition in the sheet.

Parameters

aPosition The position to check for a sheet pin.

Returns: The sheet pin found at aPosition or NULL if no sheet pin is found.

Definition at line 614 of file sch_sheet.cpp.

References m_pins, pin, and SCH_SHEET_PIN.

Referenced by SCH_SCREEN::GetSheetPin().

◆ GetPins() [1/2]

std::vector< SCH_SHEET_PIN * > & SCH_SHEET::GetPins ( )

inline

Definition at line 187 of file sch_sheet.h.

References m_pins.

Referenced by SCH_MOVE_TOOL::AlignToGrid(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), SCH_DRAWING_TOOLS::createNewSheetPin(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckHierSheets(), CONNECTION_GRAPH::ExtractAffectedItems(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LINE_WIRE_BUS_TOOL::getSheetPin(), SCH_FIND_REPLACE_TOOL::nextMatch(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_FRAME::PutDataInPreviousState(), CONNECTION_GRAPH::Recalculate(), SCHEMATIC::RecalculateConnections(), SCH_IO_KICAD_LEGACY::saveSheet(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_SELECTION_TOOL::SelectAll(), SCH_LABEL_BASE::SetLabelShape(), ERC_TESTER::TestTextVars(), SCH_SELECTION_TOOL::UnselectAll(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), SCH_EDITOR_CONTROL::updatePastedSheet(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetPins() [2/2]

const std::vector< SCH_SHEET_PIN * > & SCH_SHEET::GetPins ( ) const

inline

Definition at line 188 of file sch_sheet.h.

References m_pins.

◆ GetPosition()

VECTOR2I SCH_SHEET::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 415 of file sch_sheet.h.

References m_pos.

Referenced by SCH_MOVE_TOOL::AlignToGrid(), KIGFX::SCH_PAINTER::draw(), HasConnectivityChanges(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_IO_KICAD_LEGACY::saveSheet(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_DRAWING_TOOLS::sizeSheet(), and ERC_TESTER::TestDuplicateSheetNames().

◆ getRenderSettings()

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

inlineprotectedinherited

Definition at line 688 of file sch_item.h.

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(), and SCH_PIN::PlotPinType().

◆ GetRootInstance()

const SCH_SHEET_INSTANCE & SCH_SHEET::GetRootInstance ( ) const

Return the root sheet instance data.

Note: If no root sheet instance data exists, an assertion will be raise in debug builds and an empty instance will be returned.

Returns: the root sheet instance data.

Definition at line 1438 of file sch_sheet.cpp.

References dummy, and m_instances.

Referenced by SCH_IO_KICAD_SEXPR::Format().

◆ GetRotationCenter()

VECTOR2I SCH_SHEET::GetRotationCenter ( ) const

Rotating around the boundingBox's center can cause walking when the sheetname or filename is longer than the edge it's on.

Use this instead, which always returns the center of the sheet itself.

Definition at line 725 of file sch_sheet.cpp.

References BOX2< Vec >::GetCenter(), m_pos, and m_size.

Referenced by SCH_EDIT_TOOL::Rotate().

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

References m_rule_areas_cache.

Referenced by CONNECTION_SUBGRAPH::GetNetclassesForDriver().

◆ GetScreen()

SCH_SCREEN * SCH_SHEET::GetScreen ( ) const

inline

Definition at line 116 of file sch_sheet.h.

References m_screen.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), SCH_SCREENS::buildScreenList(), SCH_EDIT_FRAME::checkForNoFullyDefinedLibIds(), SCH_EDITOR_CONTROL::doCopy(), CONNECTION_GRAPH::ercCheckHierSheets(), SCH_IO_KICAD_LEGACY::Format(), SCH_IO_KICAD_SEXPR::Format(), SCH_IO_EAGLE::getCurrentScreen(), getSheetBbox(), SCH_DRAWING_TOOLS::importHierLabel(), SCH_DRAWING_TOOLS::importHierLabels(), SCH_EDIT_FRAME::InitSheet(), SCH_SHEET_PATH::LastScreen(), SCH_SHEET_PATH::LastScreen(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), LTSPICE_SCHEMATIC::Load(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), KI_TEST::LoadHierarchy(), SCH_IO_KICAD_LEGACY::loadHierarchy(), SCH_IO_KICAD_SEXPR::loadHierarchy(), LoadSchematic(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EASYEDA::LoadSchematicFile(), SCH_IO_EASYEDAPRO::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_MOVE_TOOL::moveSelectionToSheet(), HIERARCHY_PANE::onTreeEditFinished(), SCH_IO_ALTIUM::ParseAltiumSch(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), SCH_IO_KICAD_SEXPR_PARSER::parseSchSheetInstances(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathHumanReadable(), SCH_EDIT_TOOL::Properties(), HIERARCHY_PANE::renameIdenticalSheets(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_FRAME::SaveProject(), SCH_IO_KICAD_LEGACY::SaveSchematicFile(), SCH_IO_KICAD_SEXPR::SaveSchematicFile(), SCH_EDIT_FRAME::saveSchematicFile(), SCH_LABEL_BASE::SetLabelShape(), SCH_DRAWING_TOOLS::SyncAllSheetsPins(), and SCH_EDITOR_CONTROL::updatePastedSheet().

◆ GetScreenCount()

int SCH_SHEET::GetScreenCount ( ) const

Return the number of times the associated screen for the sheet is being used.

If no screen is associated with the sheet, then zero is returned.

Definition at line 163 of file sch_sheet.cpp.

References m_screen.

◆ GetShownName()

wxString SCH_SHEET::GetShownName ( bool aAllowExtraText ) const

inline

Definition at line 109 of file sch_sheet.h.

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

Referenced by HIERARCHY_PANE::getRootString(), and ERC_TESTER::TestDuplicateSheetNames().

◆ GetSize()

VECTOR2I SCH_SHEET::GetSize ( ) const

inline

Definition at line 118 of file sch_sheet.h.

References m_size.

Referenced by SCH_MOVE_TOOL::AlignToGrid(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_IO_KICAD_LEGACY::saveSheet(), and SCH_IO_KICAD_SEXPR::saveSheet().

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

References GetPosition().

◆ GetStoredPos()

VECTOR2I & SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 279 of file sch_item.h.

References m_storedPos.

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 610 of file sch_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 161 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().

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

References m_unit.

◆ GetUnitDisplayName()

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

virtualinherited

Reimplemented in LIB_SYMBOL, and SCH_SYMBOL.

Definition at line 168 of file sch_item.cpp.

References _, _HKI, and GetParentSymbol().

Referenced by PIN_INFO_FORMATTER::Format(), and GetMsgPanelInfo().

◆ HasCachedDriverName()

virtual bool SCH_ITEM::HasCachedDriverName ( ) const

inlinevirtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 582 of file sch_item.h.

Referenced by CONNECTION_SUBGRAPH::GetNameForDriver().

◆ HasConnectivityChanges()

bool SCH_SHEET::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 1078 of file sch_sheet.cpp.

References GetFileName(), GetName(), GetPosition(), HasConnectivityChanges(), m_pins, SCH_ITEM::SCH_ITEM(), SCH_SHEET(), and SCH_SHEET_PATH.

Referenced by HasConnectivityChanges().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 146 of file eda_item.h.

References m_flags.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), BOARD::BulkRemoveStaleTeardrops(), GRAPHICS_CLEANER::cleanupShapes(), PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), SCH_EDIT_TOOL::DoDelete(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), PCB_TUNING_PATTERN::Flip(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), ZONE::IsConflicting(), SCH_SCREEN::MarkConnections(), PCB_TUNING_PATTERN::Mirror(), PCB_TUNING_PATTERN::Move(), SCH_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::orthoLineDrag(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), GERBVIEW_FRAME::RemapLayers(), PCB_TUNING_PATTERN::Rotate(), SCH_EDIT_TOOL::Rotate(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), PCB_SELECTION_TOOL::selectAllConnectedShapes(), SCH_SELECTION_TOOL::SelectMultiple(), SCH_COMMIT::Stage(), TRACKS_CLEANER::testTrackEndpointIsNode(), and PCB_TUNING_PATTERN::ViewDraw().

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

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ HasPageNumberChanges()

bool SCH_SHEET::HasPageNumberChanges ( const SCH_SHEET & aOther ) const

Check if the instance data of this sheet has any changes compared to aOther.

Parameters

aOther is the sheet to compare against.

Returns: true if there are page number changes with aOther otherwise false.

Definition at line 1484 of file sch_sheet.cpp.

References GetInstances(), and SCH_SHEET().

Referenced by SCH_COMMIT::pushSchEdit(), and SCH_EDIT_FRAME::PutDataInPreviousState().

◆ HasPin()

bool SCH_SHEET::HasPin ( const wxString & aName ) const

Check if the sheet already has a sheet pin named aName.

Parameters

aName Name of the sheet pin to search for.

Returns: True if sheet pin with aName is found, otherwise false.

Definition at line 429 of file sch_sheet.cpp.

References m_pins, pin, and SCH_SHEET_PIN.

Referenced by SCH_DRAWING_TOOLS::importHierLabel(), and SCH_DRAWING_TOOLS::importHierLabels().

◆ HasPins()

bool SCH_SHEET::HasPins ( ) const

inline

Definition at line 222 of file sch_sheet.h.

References m_pins.

◆ HasRootInstance()

bool SCH_SHEET::HasRootInstance ( ) const

Check to see if this sheet has a root sheet instance.

Note: It is possible for sheets to contain both sheet instances from other projects as well as a root sheet instance for this schematic. This will happen with a shared schematic is opened by the schematic editor in stand alone model.

Returns: true if the instance data contains a root sheet instance.

Definition at line 1426 of file sch_sheet.cpp.

References m_instances.

Referenced by SCH_IO_KICAD_SEXPR::Format().

◆ HasUndefinedPins()

bool SCH_SHEET::HasUndefinedPins ( ) const

Check all sheet labels against schematic for undefined hierarchical labels.

Returns: True if there are any undefined labels.

Definition at line 474 of file sch_sheet.cpp.

References EDA_TEXT::GetText(), m_pins, m_screen, pin, SCH_HIER_LABEL_T, SCH_ITEM::SCH_ITEM(), and SCH_SHEET_PIN.

Referenced by SCH_EDIT_TOOL::CleanupSheetPins(), and SCH_EDIT_TOOL::Init().

◆ HitTest() [1/3]

bool SCH_SHEET::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 1196 of file sch_sheet.cpp.

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

◆ HitTest() [2/3]

bool SCH_SHEET::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 1209 of file sch_sheet.cpp.

References KIGEOM::BoxHitTest(), and GetBodyBoundingBox().

◆ HitTest() [3/3]

bool SCH_SHEET::HitTest	(	const VECTOR2I &	aPosition,
		int	aAccuracy ) 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 1186 of file sch_sheet.cpp.

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

◆ InitializeConnection()

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

inherited

Create a new connection object associated with this object.

Parameters

aPath is the sheet path to initialize.

Definition at line 404 of file sch_item.cpp.

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

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

◆ IsBOARD_ITEM()

bool KIGFX::VIEW_ITEM::IsBOARD_ITEM ( ) const

inlineinherited

Definition at line 102 of file view_item.h.

References m_isBOARD_ITEM.

Referenced by KIGFX::PCB_VIEW::Add(), PCB_GRID_HELPER::BestSnapAnchor(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::Draw(), EDA_ITEM::EDA_ITEM(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), PCB_BASE_FRAME::FocusOnItem(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), GENERAL_COLLECTOR::Inspect(), BOARD::Move(), PCB_GRID_HELPER::nearestAnchor(), PCB_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), KIGFX::PCB_VIEW::Remove(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::SelectAll(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetPlotSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), 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 129 of file eda_item.h.

References BRIGHTENED, and m_flags.

◆ IsConnectable()

bool SCH_SHEET::IsConnectable ( ) const

inlineoverridevirtual

Returns: true if the schematic item can connect to another schematic item.

Reimplemented from SCH_ITEM.

Definition at line 361 of file sch_sheet.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 314 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 486 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 484 of file sch_item.h.

Referenced by SCH_SCREEN::MarkConnections().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 128 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 211 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().

◆ IsGroupableType()

bool SCH_ITEM::IsGroupableType ( ) const

inherited

Definition at line 105 of file sch_item.cpp.

References SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_GROUP_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_PIN_T, SCH_RULE_AREA_T, SCH_SHAPE_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TABLE_T, SCH_TEXT_T, SCH_TEXTBOX_T, and EDA_ITEM::Type().

Referenced by SCH_MOVE_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_GROUP_TOOL::Group(), SCH_COMMIT::pushSchEdit(), and SCH_EDIT_TOOL::RepeatDrawItem().

◆ IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const

inlinevirtualinherited

Allow items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 302 of file sch_item.h.

Referenced by RenderAsBitmap().

◆ IsLocked()

virtual bool EDA_ITEM::IsLocked ( ) const

inlinevirtualinherited

Reimplemented in BOARD_ITEM, FOOTPRINT, and PAD.

Definition at line 120 of file eda_item.h.

Referenced by DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), SCH_IO_KICAD_SEXPR::saveGroup(), and SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

References IS_CHANGED, and m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

bool SCH_SHEET::IsMovableFromAnchorPoint ( ) const

inlineoverridevirtual

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

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

Returns: false for a hierarchical sheet.

Reimplemented from SCH_ITEM.

Definition at line 82 of file sch_sheet.h.

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

◆ IsPointClickableAnchor()

virtual bool SCH_ITEM::IsPointClickableAnchor ( const VECTOR2I & aPos ) const

inlinevirtualinherited

Returns: true if the given point can start drawing (usually means the anchor is unused/free/dangling).

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_JUNCTION, SCH_LABEL, SCH_LINE, SCH_PIN, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 499 of file sch_item.h.

Referenced by SCH_SELECTION_TOOL::autostartEvent().

◆ IsPrivate()

bool SCH_ITEM::IsPrivate ( ) const

inlineinherited

Definition at line 250 of file sch_item.h.

References m_private.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), compare(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), FIELDS_GRID_TABLE::getField(), FIELDS_EDITOR_GRID_DATA_MODEL::getFieldShownText(), GetMsgPanelInfo(), FIELDS_GRID_TABLE::GetValue(), FIELDS_GRID_TABLE::GetValueAsBool(), FIELDS_GRID_TABLE::getVisibleRowCount(), 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_SHAPE::ViewGetLayers(), and SCH_TEXT::ViewGetLayers().

◆ IsReplaceable()

bool SCH_SHEET::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 344 of file sch_sheet.h.

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 131 of file eda_item.h.

References m_isRollover.

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

◆ IsRootSheet()

bool SCH_SHEET::IsRootSheet ( ) const

Returns: true if this sheet is the root sheet.

Definition at line 172 of file sch_sheet.cpp.

References SCHEMATIC::Root(), and SCH_ITEM::Schematic().

Referenced by SCH_MOVE_TOOL::doMoveSelection(), SCH_SHEET_PATH::IsFullPath(), SCH_EDIT_FRAME::MakeNetNavigatorNode(), and SCH_EDIT_FRAME::SaveProject().

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 101 of file view_item.h.

References m_isSCH_ITEM.

Referenced by EDA_ITEM::EDA_ITEM(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), and KIGFX::SCH_VIEW::Update().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 127 of file eda_item.h.

References m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 184 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and m_flags.

◆ IsType()

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

inlineoverridevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

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

Reimplemented from EDA_ITEM.

Reimplemented in SCH_LABEL_BASE, and SCH_LINE.

Definition at line 182 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_DRAWING_TOOLS::findWireLabelDriverName(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_FIELD::IsType(), SCH_LABEL_BASE::IsType(), SCH_LINE::IsType(), SCH_SELECTION_TOOL::RequestSelection(), GROUP_SEARCH_HANDLER::Search(), LABEL_SEARCH_HANDLER::Search(), SCH_MARKER::SerializeToString(), SCH_EDIT_FRAME::UpdateHopOveredWires(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsVerticalOrientation()

bool SCH_SHEET::IsVerticalOrientation ( ) const

Definition at line 453 of file sch_sheet.cpp.

References BOTTOM, LEFT, m_pins, pin, RIGHT, SCH_SHEET_PIN, and TOP.

Referenced by AutoplaceFields(), and SCH_SHEET_PIN::SCH_SHEET_PIN().

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

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

◆ LocatePathOfScreen()

bool SCH_SHEET::LocatePathOfScreen	(	SCH_SCREEN *	aScreen,
		SCH_SHEET_PATH *	aList )

Search the existing hierarchy for an instance of screen loaded from aFileName.

Don't bother looking at the root sheet, it must be unique. No other references to its m_screen otherwise there would be loops in the hierarchy.

Parameters

[in]	aScreen	The SCH_SCREEN* screen that we search for.
[in]	aList	The SCH_SHEET_PATH* that must be used.

Returns: true if found.

Definition at line 790 of file sch_sheet.cpp.

References EDA_ITEM::EDA_ITEM(), LocatePathOfScreen(), m_screen, SCH_SHEET_PATH::pop_back(), SCH_SHEET_PATH::push_back(), SCH_SHEET(), SCH_SHEET_PATH, and SCH_SHEET_T.

Referenced by LocatePathOfScreen().

◆ 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 39 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().

◆ 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 158 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_SHEET::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 1014 of file sch_sheet.cpp.

Referenced by SCH_DRAWING_TOOLS::DrawSheet().

◆ MirrorHorizontally()

void SCH_SHEET::MirrorHorizontally ( int aCenter )

overridevirtual

Mirror item horizontally about aCenter.

Reimplemented from SCH_ITEM.

Definition at line 969 of file sch_sheet.cpp.

References m_fields, m_pins, m_pos, m_size, MIRROR(), SCH_SHEET_PIN, and VECTOR2< T >::x.

◆ MirrorVertically()

void SCH_SHEET::MirrorVertically ( int aCenter )

overridevirtual

Mirror item vertically about aCenter.

Reimplemented from SCH_ITEM.

Definition at line 949 of file sch_sheet.cpp.

References m_fields, m_pins, m_pos, m_size, MIRROR(), SCH_SHEET_PIN, and VECTOR2< T >::y.

◆ Move()

void SCH_SHEET::Move ( const VECTOR2I & aMoveVector )

overridevirtual

Move the item by aMoveVector to a new position.

Reimplemented from SCH_ITEM.

Definition at line 895 of file sch_sheet.cpp.

References m_fields, m_pins, m_pos, pin, and SCH_SHEET_PIN.

Referenced by SetPosition().

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

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

◆ operator<() [2/2]

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

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1329 of file sch_sheet.cpp.

References GetFileName(), GetName(), SCH_ITEM::SCH_ITEM(), SCH_SHEET(), and EDA_ITEM::Type().

◆ operator=()

SCH_SHEET & SCH_SHEET::operator= ( const SCH_ITEM & aSheet )

Definition at line 1299 of file sch_sheet.cpp.

References SCH_ITEM::GetClass(), GetClass(), m_fields, m_instances, m_pins, m_pos, m_size, SCH_ITEM::operator=(), pin, SCH_ITEM::SCH_ITEM(), SCH_SHEET(), SCH_SHEET_PIN, and EDA_ITEM::Type().

◆ operator==()

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

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1573 of file sch_sheet.cpp.

References GetBackgroundColor(), GetBorderColor(), GetBorderWidth(), GetDNP(), GetExcludedFromBoard(), GetExcludedFromBOM(), GetExcludedFromSim(), GetFields(), m_pos, m_size, SCH_ITEM::SCH_ITEM(), SCH_SHEET(), and EDA_ITEM::Type().

◆ Plot()

void SCH_SHEET::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

aBackground	a poor-man's Z-order. The routine will get called twice, first with aBackground true and then with aBackground false.
aUnit	- which unit to print.
aBodyStyle	- which body style to print.
aOffset	relative offset.
aDimmed	reduce brightness of item.

Reimplemented from SCH_ITEM.

Definition at line 1215 of file sch_sheet.cpp.

References KIGFX::COLOR4D::a, DEFAULT_LINE_WIDTH_MILS, DEFAULT_THEME, FILLED_SHAPE, findSelf(), GetBackgroundColor(), GetBodyBoundingBox(), GetBorderColor(), GetBoundingBox(), COLOR_SETTINGS::GetColor(), PLOTTER::GetColorMode(), GetColorSettings(), GetDNP(), SCH_ITEM::GetEffectivePenWidth(), BOX2< Vec >::GetEnd(), GetFields(), BOX2< Vec >::GetHeight(), KIGFX::RENDER_SETTINGS::GetLayerColor(), BOX2< Vec >::GetOrigin(), SCH_ITEM::getRenderSettings(), BOX2< Vec >::GetWidth(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), EDA_TEXT::GotoPageHref(), PLOTTER::HyperlinkBox(), PLOTTER::HyperlinkMenu(), BOX2< Vec >::Inflate(), KiROUND(), LAYER_DNP_MARKER, LAYER_SHEET, LAYER_SHEET_BACKGROUND, m_fields, SCH_RENDER_SETTINGS::m_OverrideItemColors, SCH_PLOT_OPTS::m_PDFHierarchicalLinks, SCH_PLOT_OPTS::m_PDFPropertyPopups, m_pins, m_pos, m_size, NO_FILL, PLOTTER::Rect(), PLOTTER::RenderSettings(), SCH_SHEET_PIN, schIUScale, PLOTTER::SetColor(), PLOTTER::ThickSegment(), COLOR4D::UNSPECIFIED, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ RemoveInstance()

void SCH_SHEET::RemoveInstance ( const KIID_PATH & aInstancePath )

Definition at line 1346 of file sch_sheet.cpp.

References KIID_PATH::AsString(), m_instances, and traceSchSheetPaths.

Referenced by AddInstance(), SCH_EDITOR_CONTROL::Paste(), and SCH_SCREEN::PruneOrphanedSheetInstances().

◆ RemovePin()

void SCH_SHEET::RemovePin ( const SCH_SHEET_PIN * aSheetPin )

Remove aSheetPin from the sheet.

Parameters

aSheetPin The sheet pin item to remove from the sheet.

Definition at line 412 of file sch_sheet.cpp.

References m_pins, renumberPins(), SCH_SHEET_PIN, SCH_SHEET_PIN_T, and EDA_ITEM::Type().

Referenced by SCH_SCREEN::DeleteItem(), and SCH_EDIT_TOOL::DoDelete().

◆ RenderAsBitmap()

bool SCH_ITEM::RenderAsBitmap ( double aWorldScale ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 625 of file sch_item.cpp.

References BITMAP_FONT_SIZE_THRESHOLD, IsHypertext(), and text.

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

◆ renumberPins()

void SCH_SHEET::renumberPins ( )

protected

Renumber the sheet pins in the sheet.

This method is used internally by SCH_SHEET to update the pin numbering when the pin list changes. Make sure you call this method any time a sheet pin is added or removed.

Definition at line 1021 of file sch_sheet.cpp.

References m_pins, pin, and SCH_SHEET_PIN.

Referenced by AddPin(), and RemovePin().

◆ 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 428 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 236 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().

◆ Resize()

void SCH_SHEET::Resize ( const VECTOR2I & aSize )

Resize this sheet to aSize and adjust all of the labels accordingly.

Parameters

[in] aSize The new size for this sheet.

Definition at line 997 of file sch_sheet.cpp.

References AUTOPLACE_AUTO, AUTOPLACE_MANUAL, AutoplaceFields(), SCH_ITEM::m_fieldsAutoplaced, m_pins, m_size, and SCH_SHEET_PIN.

Referenced by SCH_DRAWING_TOOLS::sizeSheet().

◆ ResolveDNP()

bool SCH_ITEM::ResolveDNP ( ) const

inherited

Definition at line 292 of file sch_item.cpp.

References GetDNP(), and m_rule_areas_cache.

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

◆ ResolveExcludedFromBoard()

bool SCH_ITEM::ResolveExcludedFromBoard ( ) const

inherited

Definition at line 277 of file sch_item.cpp.

References 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

inherited

Definition at line 262 of file sch_item.cpp.

References GetExcludedFromBOM(), and m_rule_areas_cache.

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

◆ ResolveExcludedFromSim()

bool SCH_ITEM::ResolveExcludedFromSim ( ) const

inherited

Definition at line 247 of file sch_item.cpp.

References GetExcludedFromSim(), and m_rule_areas_cache.

Referenced by SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), and ERC_TESTER::TestSimModelIssues().

◆ ResolveTextVar()

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

Resolve any references to system tokens supported by the sheet.

Parameters

aDepth is a counter to limit recursion and circular references.

Definition at line 223 of file sch_sheet.cpp.

References _, SCH_SHEET_PATH::GetDNP(), SCH_SHEET_PATH::GetExcludedFromBoard(), SCH_SHEET_PATH::GetExcludedFromBOM(), SCH_SHEET_PATH::GetExcludedFromSim(), SCH_SHEET_PATH::GetPageNumber(), SCHEMATIC::Hierarchy(), m_fields, m_screen, path, SCH_SHEET_PATH::PathHumanReadable(), SCHEMATIC::Project(), project, SCHEMATIC::ResolveCrossReference(), SCHEMATIC::ResolveTextVar(), SCH_SHEET_PATH, SCH_ITEM::Schematic(), and SCH_SHEET_PATH::size().

Referenced by SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCHEMATIC::ResolveCrossReference(), SCH_LABEL_BASE::ResolveTextVar(), and SCH_SYMBOL::ResolveTextVar().

◆ Rotate()

void SCH_SHEET::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 907 of file sch_sheet.cpp.

References ANGLE_270, ANGLE_90, AUTOPLACE_AUTO, AUTOPLACE_MANUAL, AutoplaceFields(), m_fields, SCH_ITEM::m_fieldsAutoplaced, m_pins, m_pos, m_size, RotatePoint(), SCH_SHEET_PIN, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_EDIT_TOOL::Rotate().

◆ RunOnChildren()

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

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1160 of file sch_sheet.cpp.

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

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

References EDA_ITEM::findParent(), and SCHEMATIC_T.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::ChangeTextType(), Connection(), SCH_DRAWING_TOOLS::createNewSheetPin(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_SIM_MODEL< T >::DIALOG_SIM_MODEL(), 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(), GetEffectiveNetClass(), SCH_JUNCTION::getEffectiveShape(), SCH_SHAPE::GetEffectiveWidth(), GetEmbeddedFonts(), GetFontMetrics(), SCH_LABEL_BASE::GetIntersheetRefs(), SCH_LABEL_BASE::GetLabelBoxExpansion(), SCH_SHAPE::getMaxError(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_NO_CONNECT::GetPenWidth(), SCH_SHEET::GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetRefProp(), SCH_MARKER::GetSeverity(), SCH_FIELD::GetShownText(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_SYMBOL::GetUnitProp(), GetUnplacedUnitsForSymbol(), SCH_SYMBOL::GetValueProp(), SCH_PIN::HitTest(), SCH_SHEET::IsRootSheet(), SCH_LABEL_BASE::IsType(), SCH_POINT_EDITOR::makePointsAndBehavior(), SIM_MODEL::MigrateSimModel(), SCH_FIELD::OnScintillaCharAdded(), PIN_LAYOUT_CACHE::PIN_LAYOUT_CACHE(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_SCREEN::Plot(), SCH_SYMBOL::Plot(), SCH_TABLE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_COMMIT::pushSchEdit(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_LABEL_BASE::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_COMMIT::Revert(), SCH_FIELD::SCH_FIELD(), SCH_EDIT_FRAME::SelectUnit(), SCH_MARKER::SerializeToString(), SCH_SYMBOL::SetRef(), SCH_SYMBOL::SetRefProp(), SCH_SYMBOL::SetUnitProp(), SCH_INSPECTION_TOOL::ShowDatasheet(), SCH_EDITOR_CONTROL::SimTune(), SCH_SYMBOL::SubReference(), SCH_SYMBOL::SyncOtherUnits(), DIALOG_TABLE_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLE_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), FIELDS_EDITOR_GRID_DATA_MODEL::updateDataStoreSymbolField(), DIALOG_FIELD_PROPERTIES::UpdateField(), SCH_MARKER::ViewGetLayers(), and ~SCH_ITEM().

◆ SearchHierarchy()

bool SCH_SHEET::SearchHierarchy	(	const wxString &	aFilename,
		SCH_SCREEN **	aScreen )

Search the existing hierarchy for an instance of screen loaded from aFileName.

Parameters

aFilename	The filename to find (MUST be absolute, and in wxPATH_NATIVE encoding).
aScreen	A location to return a pointer to the screen (if found).

Returns: true if found, and a pointer to the screen

Definition at line 754 of file sch_sheet.cpp.

References SCH_SCREEN::GetFileName(), EDA_ITEM::GetParent(), m_screen, SCH_ITEM::SCH_ITEM(), SCH_SHEET(), SCH_SHEET_T, and SearchHierarchy().

Referenced by DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), and SearchHierarchy().

◆ Serialize()

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

virtualinherited

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 in BOARD_STACKUP, EDA_SHAPE, EDA_TEXT, FOOTPRINT, NETCLASS, PAD, PADSTACK, PCB_ARC, PCB_DIM_ALIGNED, PCB_DIM_CENTER, PCB_DIM_LEADER, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIMENSION_BASE, PCB_FIELD, PCB_GROUP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LABEL, SCH_LINE, and ZONE.

Definition at line 24 of file serializable.cpp.

Referenced by API_HANDLER_PCB::handleCreateUpdateItemsInternal(), and ~SERIALIZABLE().

◆ Set() [1/4]

template<typename T>

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

inlineinherited

Definition at line 98 of file inspectable.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 )

inlineinherited

Definition at line 60 of file inspectable.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 )

inlineinherited

Definition at line 43 of file inspectable.h.

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

Referenced by PCB_PROPERTIES_PANEL::valueChanged(), and SCH_PROPERTIES_PANEL::valueChanged().

◆ Set() [4/4]

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

inlineinherited

Definition at line 76 of file inspectable.h.

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

◆ SetBackgroundColor()

void SCH_SHEET::SetBackgroundColor ( KIGFX::COLOR4D aColor )

inline

Definition at line 128 of file sch_sheet.h.

References m_backgroundColor.

Referenced by SCH_DRAWING_TOOLS::DrawSheet(), SCH_IO_ALTIUM::ParseSheetSymbol(), SCH_SHEET_DESC::SCH_SHEET_DESC(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ SetBodyStyle()

virtual void SCH_ITEM::SetBodyStyle ( int aBodyStyle )

inlinevirtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 243 of file sch_item.h.

References m_bodyStyle.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SYMBOL_EDITOR_EDIT_TOOL::ExplodeStackedPin(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadArc(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadBezier(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadPolyLine(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadRect(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), and PIN_INFO_FORMATTER::UpdatePin().

◆ SetBodyStyleProp()

void SCH_ITEM::SetBodyStyleProp ( const wxString & aBodyStyle )

virtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 189 of file sch_item.cpp.

References _HKI, BASE, DEMORGAN, GetParentSymbol(), and m_bodyStyle.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ SetBorderColor()

void SCH_SHEET::SetBorderColor ( KIGFX::COLOR4D aColor )

inline

Definition at line 125 of file sch_sheet.h.

References m_borderColor.

Referenced by SCH_DRAWING_TOOLS::DrawSheet(), SCH_IO_ALTIUM::ParseSheetSymbol(), SCH_SHEET_DESC::SCH_SHEET_DESC(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ SetBorderWidth()

void SCH_SHEET::SetBorderWidth ( int aWidth )

inline

Definition at line 122 of file sch_sheet.h.

References m_borderWidth.

Referenced by SCH_DRAWING_TOOLS::DrawSheet(), SCH_SHEET_DESC::SCH_SHEET_DESC(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 135 of file eda_item.h.

References BRIGHTENED, and SetFlags().

Referenced by 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(), PCB_TEST_SELECTION_TOOL::highlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ SetConnectionGraph()

void SCH_ITEM::SetConnectionGraph ( CONNECTION_GRAPH * aGraph )

inherited

Update the connection graph for all connections in this item.

Definition at line 340 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 )

inlineinherited

Definition at line 556 of file sch_item.h.

References m_connectivity_dirty.

Referenced by SCH_LINE::BreakAt(), SCH_EDIT_TOOL::editFieldText(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LINE::MergeOverlap(), SCH_LINE::NonGroupAware_BreakAt(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_EDITOR_CONTROL::Paste(), SCH_COMMIT::Revert(), and SCH_TOOL_BASE< T >::saveCopyInUndoList().

◆ SetDNP()

void SCH_SHEET::SetDNP ( bool aDNP )

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 403 of file sch_sheet.h.

References m_DNP.

Referenced by SCH_SHEET_DESC::SCH_SHEET_DESC().

◆ SetExcludedFromBoard()

void SCH_SHEET::SetExcludedFromBoard ( bool aExcludeFromBoard )

inlineoverridevirtual

Set or clear exclude from board netlist flag.

Reimplemented from SCH_ITEM.

Definition at line 396 of file sch_sheet.h.

References m_excludedFromBoard.

Referenced by SCH_SHEET_DESC::SCH_SHEET_DESC().

◆ SetExcludedFromBOM()

void SCH_SHEET::SetExcludedFromBOM ( bool aExcludeFromBOM )

inlineoverridevirtual

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

Reimplemented from SCH_ITEM.

Definition at line 390 of file sch_sheet.h.

References m_excludedFromBOM.

Referenced by SCH_SHEET_DESC::SCH_SHEET_DESC().

◆ SetExcludedFromSim()

void SCH_SHEET::SetExcludedFromSim ( bool aExcludeFromSim )

inlineoverridevirtual

Set or clear the exclude from simulation flag.

Reimplemented from SCH_ITEM.

Definition at line 384 of file sch_sheet.h.

References m_excludedFromSim.

Referenced by SCH_SHEET_DESC::SCH_SHEET_DESC().

◆ SetFields()

void SCH_SHEET::SetFields ( const std::vector< SCH_FIELD > & aFields )

Set multiple schematic fields.

Parameters

aFields are the fields to set in this symbol.

Definition at line 392 of file sch_sheet.cpp.

References GetField(), m_fields, SetFileName(), and SHEET_FILENAME.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets().

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( AUTOPLACE_ALGO aAlgo )

inlineinherited

Definition at line 593 of file sch_item.h.

References m_fieldsAutoplaced.

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

◆ SetFileName()

void SCH_SHEET::SetFileName ( const wxString & aFilename )

inline

Definition at line 327 of file sch_sheet.h.

References GetField(), SCH_FIELD::SetText(), and SHEET_FILENAME.

Referenced by SCH_EDIT_FRAME::importFile(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EASYEDA::LoadSchematicFile(), SCH_IO_EASYEDAPRO::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), SCH_IO_EAGLE::loadSheet(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_SHEET_PATH::MakeFilePathRelativeToParentSheet(), SCH_IO_ALTIUM::ParseAltiumSch(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_FRAME::SaveProject(), and SetFields().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 142 of file eda_item.h.

References m_flags.

◆ SetForcedTransparency()

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

inlineinherited

Definition at line 166 of file view_item.h.

References m_forcedTransparency.

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

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

References m_forceVisible.

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

◆ setInstances()

void SCH_SHEET::setInstances ( const std::vector< SCH_SHEET_INSTANCE > & aInstances )

inlineprotected

Definition at line 484 of file sch_sheet.h.

References m_instances.

◆ SetIsRollover()

void EDA_ITEM::SetIsRollover ( bool aIsRollover )

inlineinherited

Definition at line 132 of file eda_item.h.

References m_isRollover.

Referenced by SCH_SELECTION_TOOL::Main().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 176 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 585 of file sch_item.h.

References SCH_ITEM().

Referenced by SCH_EDITOR_CONTROL::Paste().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID aLayer )

inlineinherited

Definition at line 310 of file sch_item.h.

References m_layer.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_IO_LTSPICE_PARSER::CreateWire(), SCH_LINE::Deserialize(), SCH_MOVE_TOOL::getConnectedDragItems(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), SCH_NO_CONNECT::SCH_NO_CONNECT(), SCH_RULE_AREA::SCH_RULE_AREA(), SCH_SHAPE::SCH_SHAPE(), SCH_TABLE::SCH_TABLE(), and SCH_FIELD::setId().

◆ SetLocked()

virtual void EDA_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

Reimplemented in BOARD_ITEM, FOOTPRINT, and PCB_GROUP.

Definition at line 121 of file eda_item.h.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 100 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().

◆ SetName()

void SCH_SHEET::SetName ( const wxString & aName )

inline

Definition at line 114 of file sch_sheet.h.

References GetField(), SCH_FIELD::SetText(), and SHEET_NAME.

Referenced by SCH_IO_EASYEDAPRO::LoadSchematicFile(), SCH_IO_EAGLE::loadSheet(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), HIERARCHY_PANE::onTreeEditFinished(), SCH_IO_ALTIUM::ParseAltiumSch(), HIERARCHY_PANE::renameIdenticalSheets(), and SCH_SHEET_DESC::SCH_SHEET_DESC().

◆ setPageNumber()

void SCH_SHEET::setPageNumber	(	const KIID_PATH &	aInstance,
		const wxString &	aPageNumber )

protected

Set the page number for the sheet instance aInstance.

Warning: The KIID_PATH object must be a full hierarchical path which means the sheet at index 0 must be the root sheet.

Parameters

[in]	aInstance	is the hierarchical path of the sheet.
[in]	aReference	is the new page number for the sheet.

Definition at line 1471 of file sch_sheet.cpp.

References m_instances.

Referenced by SCH_SHEET_PATH::SetPageNumber().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and NETINFO_ITEM.

Definition at line 113 of file eda_item.h.

References EDA_ITEM(), and m_parent.

Referenced by BOARD::Add(), FOOTPRINT::Add(), PCB_TABLE::AddCell(), SCH_TABLE::AddCell(), LIB_SYMBOL::AddDrawItem(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PADSTACK::AddPrimitive(), PAD::AddPrimitivePoly(), PAD::AddPrimitivePoly(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), BOOST_AUTO_TEST_CASE(), CADSTAR_SCH_ARCHIVE_LOADER::copySymbolItems(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), LIB_SYMBOL_LIBRARY_MANAGER::CreateSymbol(), FIELDS_GRID_TABLE::DetachFields(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), SCH_DRAWING_TOOLS::DrawShape(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO_KICAD_SEXPR::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), PCB_TABLE::InsertCell(), SCH_TABLE::InsertCell(), LIB_SYMBOL::LIB_SYMBOL(), LTSPICE_SCHEMATIC::Load(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), KI_TEST::LoadHierarchy(), SCH_IO_KICAD_LEGACY::loadHierarchy(), SCH_IO_KICAD_SEXPR::loadHierarchy(), SCH_IO_EAGLE::loadSymbolPolyLine(), SCH_IO_EAGLE::loadSymbolRectangle(), SCH_IO_EAGLE::loadSymbolWire(), PCB_POINT_EDITOR::OnSelectionChange(), LIB_SYMBOL::operator=(), SCH_IO_KICAD_SEXPR_PARSER::parseLibSymbol(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), PAD::Recombine(), SCH_IO_LIB_CACHE::removeSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), CLIPBOARD_IO::SaveSelection(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), FOOTPRINT::swapData(), PCB_TABLE::swapData(), SCH_LABEL_BASE::swapData(), SCH_SHEET::swapData(), SCH_SYMBOL::swapData(), SCH_TABLE::swapData(), BOARD_ITEM::SwapItemData(), SCH_ITEM::SwapItemData(), SCH_SYMBOL::SyncOtherUnits(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetParentGroup()

virtual void EDA_ITEM::SetParentGroup ( EDA_GROUP * aGroup )

inlinevirtualinherited

Definition at line 115 of file eda_item.h.

References m_group.

Referenced by EDA_GROUP::AddItem(), PCB_IO_KICAD_SEXPR::FootprintSave(), GENDRILL_WRITER_BASE::genDrillMapFile(), SCH_SYMBOL::GetOrientation(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), EDA_GROUP::RemoveItem(), SaveCopyOfZones(), and CLIPBOARD_IO::SaveSelection().

◆ SetPosition()

void SCH_SHEET::SetPosition ( const VECTOR2I & aPosition )

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 989 of file sch_sheet.cpp.

References m_pos, and Move().

Referenced by LTSPICE_SCHEMATIC::Load().

◆ SetPositionIgnoringPins()

void SCH_SHEET::SetPositionIgnoringPins ( const VECTOR2I & aPosition )

Definition at line 884 of file sch_sheet.cpp.

References delta, m_fields, and m_pos.

◆ SetPrivate()

void SCH_ITEM::SetPrivate ( bool aPrivate )

inlineinherited

Definition at line 249 of file sch_item.h.

References m_private.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_ITEM_DESC::SCH_ITEM_DESC(), FIELDS_GRID_TABLE::SetValue(), FIELDS_GRID_TABLE::SetValueAsBool(), and SCH_SYMBOL::UpdateFields().

◆ SetScreen()

void SCH_SHEET::SetScreen ( SCH_SCREEN * aScreen )

Set the SCH_SCREEN associated with this sheet to aScreen.

The screen reference counting is performed by SetScreen. If aScreen is not the same as the current screen, the current screen reference count is decremented and aScreen becomes the screen for the sheet. If the current screen reference count reaches zero, the current screen is deleted. NULL is a valid value for aScreen.

Parameters

aScreen The new screen to associate with the sheet.

Definition at line 140 of file sch_sheet.cpp.

References m_screen.

Referenced by BOOST_AUTO_TEST_CASE(), CONNECTION_GRAPH::boost_test_update_generic_connectivity, CONNECTION_GRAPH::boost_test_update_symbol_connectivity, SCHEMATIC::CreateDefaultScreens(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_FRAME::InitSheet(), LTSPICE_SCHEMATIC::Load(), KI_TEST::LoadHierarchy(), SCH_IO_KICAD_LEGACY::loadHierarchy(), SCH_IO_KICAD_SEXPR::loadHierarchy(), EESCHEMA_HELPERS::LoadSchematic(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EASYEDA::LoadSchematicFile(), SCH_IO_EASYEDAPRO::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_IO_ALTIUM::ParseAltiumSch(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), and SCH_EDIT_FRAME::SaveSelectionToDesignBlock().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 134 of file eda_item.h.

References SELECTED, and SetFlags().

Referenced by 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(), DS_PROXY_UNDO_ITEM::Restore(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::selectVisually(), and SCH_COMMIT::Stage().

◆ SetSize()

void SCH_SHEET::SetSize ( const VECTOR2I & aSize )

inline

Definition at line 119 of file sch_sheet.h.

References m_size.

Referenced by SCH_MOVE_TOOL::AlignToGrid(), and LTSPICE_SCHEMATIC::Load().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( const VECTOR2I & aPos )

inlineinherited

Definition at line 280 of file sch_item.h.

References m_storedPos.

Referenced by SCH_MOVE_TOOL::doMoveSelection().

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

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ SetUnit()

virtual void SCH_ITEM::SetUnit ( int aUnit )

inlinevirtualinherited

Definition at line 237 of file sch_item.h.

References m_unit.

◆ Similarity()

double SCH_SHEET::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 1620 of file sch_sheet.cpp.

References SCH_SCREEN::GetFileName(), m_screen, SCH_ITEM::SCH_ITEM(), SCH_SHEET(), 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 346 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 457 of file eda_item.h.

References EDA_ITEM().

◆ swapData()

void SCH_SHEET::swapData ( SCH_ITEM * aItem )

overridevirtual

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 331 of file sch_sheet.cpp.

References SCH_ITEM::GetClass(), m_backgroundColor, m_borderColor, m_borderWidth, m_DNP, m_excludedFromBoard, m_excludedFromBOM, m_excludedFromSim, m_fields, SCH_ITEM::m_fieldsAutoplaced, m_instances, m_pins, m_pos, m_size, SCH_ITEM::SCH_ITEM(), SCH_SHEET(), SCH_SHEET_PIN, SCH_SHEET_T, EDA_ITEM::SetParent(), and EDA_ITEM::Type().

◆ SwapFlags()

void SCH_ITEM::SwapFlags ( SCH_ITEM * aItem )

inherited

Swap the non-temp and non-edit flags.

Definition at line 476 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 456 of file sch_item.cpp.

References EDA_ITEM::EDA_ITEM(), EDA_ITEM::GetParent(), m_bodyStyle, m_fieldsAutoplaced, EDA_ITEM::m_group, m_layer, m_private, m_unit, SCH_ITEM(), EDA_ITEM::SetParent(), swapData(), and SwapFlags().

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState(), and SCH_COMMIT::Revert().

◆ SymbolCount()

int SCH_SHEET::SymbolCount ( ) const

Count our own symbols, without the power symbols.

Definition at line 732 of file sch_sheet.cpp.

References SCH_SYMBOL::IsPower(), m_screen, SCH_ITEM::SCH_ITEM(), SCH_SHEET(), SCH_SHEET_T, SCH_SYMBOL_T, and SymbolCount().

Referenced by SymbolCount().

◆ 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_SHEET::UpdateDanglingState	(	std::vector< DANGLING_END_ITEM > &	aItemListByType,
		std::vector< DANGLING_END_ITEM > &	aItemListByPos,
		const SCH_SHEET_PATH *	aSheet = nullptr )

overridevirtual

Test the schematic item to aItemList to check if it's dangling state has changed.

Note that the return value only true when the state of the test has changed. Use the IsDangling() method to get the current dangling state of the item. Some of the schematic objects cannot be tested for a dangling state, the default method always returns false. Only override the method if the item can be tested for a dangling state.

If aSheet is passed a non-null pointer to a SCH_SHEET_PATH, the overridden method can optionally use it to update sheet-local connectivity information

Parameters

aItemListByType	is the list of items to test item against. It's sorted by item type, keeping WIRE_END pairs together.
aItemListByPos	is the same list but sorted first by Y then by X.
aSheet	is the sheet path to update connections for.

Returns: True if the dangling state has changed from it's current setting.

Reimplemented from SCH_ITEM.

Definition at line 1065 of file sch_sheet.cpp.

References m_pins, SCH_SHEET_PATH, and SCH_SHEET_PIN.

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

Return the bounding box of the item covering all its layers.

Returns: the current bounding box.

Implements KIGFX::VIEW_ITEM.

Reimplemented in DS_PROXY_VIEW_ITEM, EDIT_POINTS, FOOTPRINT, GERBER_DRAW_ITEM, KIGFX::ANCHOR_DEBUG, KIGFX::CONSTRUCTION_GEOM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ANGLE_ITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::BEZIER_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::SNAP_INDICATOR, MY_DRAWING, PAD, PCB_DIM_CENTER, PCB_DIMENSION_BASE, PCB_MARKER, PCB_SHAPE, PCB_TEXT, PCB_TRACK, PCB_TUNING_PATTERN, RATSNEST_VIEW_ITEM, RECT_RADIUS_TEXT_ITEM, ROUTER_PREVIEW_ITEM, ROUTER_STATUS_VIEW_ITEM, SCH_PIN, and TUNING_STATUS_VIEW_ITEM.

Definition at line 345 of file eda_item.cpp.

References GetBoundingBox().

Referenced by EDIT_TOOL::doMoveSelection(), and PCB_SHAPE::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 #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 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::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, RATSNEST_VIEW_ITEM, RECT_RADIUS_TEXT_ITEM, ROUTER_PREVIEW_ITEM, ROUTER_STATUS_VIEW_ITEM, TUNING_STATUS_VIEW_ITEM, and VIEW_OVERLAY.

Definition at line 127 of file view_item.h.

References VIEW.

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

◆ ViewGetLayers()

std::vector< int > SCH_SHEET::ViewGetLayers ( ) const

overridevirtual

Return the layers the item is drawn on (which may be more than its "home" layer)

Reimplemented from SCH_ITEM.

Definition at line 685 of file sch_sheet.cpp.

References LAYER_DANGLING, LAYER_HIERLABEL, LAYER_SELECTION_SHADOWS, LAYER_SHEET, LAYER_SHEET_BACKGROUND, LAYER_SHEETFIELDS, LAYER_SHEETFILENAME, and LAYER_SHEETNAME.

◆ 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_FIELD, PCB_GROUP, PCB_POINT, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, SCH_GROUP, SCH_LINE, and ZONE.

Definition at line 155 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_SHEET::Visit	(	INSPECTOR	inspector,
		void *	testData,
		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

inspector	An INSPECTOR instance to use in the inspection.
testData	Arbitrary data used by the inspector.
aScanTypes	Which KICAD_T types are of interest and the order in which they should be processed.

Returns: #SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else #SCAN_CONTINUE, and determined by the inspector.

Reimplemented from EDA_ITEM.

Definition at line 1123 of file sch_sheet.cpp.

References CONTINUE, m_fields, m_pins, QUIT, SCH_FIELD_T, SCH_LOCATE_ANY_T, SCH_SHEET_PIN, SCH_SHEET_PIN_T, and EDA_ITEM::Type().

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 143 of file eda_item.h.

References m_flags.

Referenced by SCH_SELECTION_TOOL::SelectMultiple().

Friends And Related Symbol Documentation

◆ SCH_SHEET_LIST

friend class SCH_SHEET_LIST

friend

Definition at line 548 of file sch_sheet.h.

References SCH_SHEET_LIST.

Referenced by SCH_SHEET_LIST.

◆ SCH_SHEET_PIN

friend class SCH_SHEET_PIN

friend

Definition at line 547 of file sch_sheet.h.

References SCH_SHEET_PIN.

Referenced by AddPin(), CleanupSheet(), doIsConnected(), GetConnectionPoints(), GetEndPoints(), GetPin(), HasPin(), HasUndefinedPins(), IsVerticalOrientation(), MirrorHorizontally(), MirrorVertically(), Move(), operator=(), Plot(), RemovePin(), renumberPins(), Resize(), Rotate(), RunOnChildren(), SCH_SHEET(), SCH_SHEET_PIN, swapData(), UpdateDanglingState(), Visit(), and ~SCH_SHEET().

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 180 of file view_item.h.

Referenced by lodScaleForThreshold(), KIGFX::VIEW_GROUP::ViewDraw(), FOOTPRINT::ViewGetLOD(), PAD::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::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 185 of file view_item.h.

Referenced by lodScaleForThreshold(), FOOTPRINT::ViewGetLOD(), GERBER_DRAW_ITEM::ViewGetLOD(), ViewGetLOD(), PAD::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), SCH_GROUP::ViewGetLOD(), SCH_LINE::ViewGetLOD(), and ZONE::ViewGetLOD().

◆ m_backgroundColor

KIGFX::COLOR4D SCH_SHEET::m_backgroundColor

private

Definition at line 567 of file sch_sheet.h.

Referenced by GetBackgroundColor(), SCH_SHEET(), SCH_SHEET(), SetBackgroundColor(), and swapData().

◆ m_bodyStyle

int SCH_ITEM::m_bodyStyle

protectedinherited

◆ m_borderColor

KIGFX::COLOR4D SCH_SHEET::m_borderColor

private

Definition at line 566 of file sch_sheet.h.

Referenced by GetBorderColor(), SCH_SHEET(), SCH_SHEET(), SetBorderColor(), and swapData().

◆ m_borderWidth

int SCH_SHEET::m_borderWidth

private

Definition at line 565 of file sch_sheet.h.

Referenced by GetBorderWidth(), SCH_SHEET(), SCH_SHEET(), SetBorderWidth(), and swapData().

◆ m_connected_items

std::map<SCH_SHEET_PATH, SCH_ITEM_VEC, 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 748 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 751 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 753 of file sch_item.h.

Referenced by IsConnectivityDirty(), operator=(), SCH_ITEM(), SCH_ITEM(), and SetConnectivityDirty().

◆ m_DNP

bool SCH_SHEET::m_DNP

private

Definition at line 561 of file sch_sheet.h.

Referenced by GetDNP(), SCH_SHEET(), SCH_SHEET(), SetDNP(), and swapData().

◆ m_excludedFromBoard

bool SCH_SHEET::m_excludedFromBoard

private

Definition at line 560 of file sch_sheet.h.

Referenced by GetExcludedFromBoard(), SCH_SHEET(), SCH_SHEET(), SetExcludedFromBoard(), and swapData().

◆ m_excludedFromBOM

bool SCH_SHEET::m_excludedFromBOM

private

Definition at line 559 of file sch_sheet.h.

Referenced by GetExcludedFromBOM(), SCH_SHEET(), SCH_SHEET(), SetExcludedFromBOM(), and swapData().

◆ m_excludedFromSim

bool SCH_SHEET::m_excludedFromSim

private

Definition at line 558 of file sch_sheet.h.

Referenced by GetExcludedFromSim(), SCH_SHEET(), SCH_SHEET(), SetExcludedFromSim(), and swapData().

◆ m_fields

std::vector<SCH_FIELD> SCH_SHEET::m_fields

private

Definition at line 556 of file sch_sheet.h.

Referenced by GetBoundingBox(), GetContextualTextVars(), GetField(), GetField(), GetFields(), GetFields(), GetNextFieldOrdinal(), MirrorHorizontally(), MirrorVertically(), Move(), operator=(), Plot(), ResolveTextVar(), Rotate(), RunOnChildren(), SCH_SHEET(), SCH_SHEET(), SetFields(), SetPositionIgnoringPins(), swapData(), and Visit().

◆ m_fieldsAutoplaced

AUTOPLACE_ALGO SCH_ITEM::m_fieldsAutoplaced

protectedinherited

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 527 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 210 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 530 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), ZONE::InitDataFromSrcInCopyCtor(), IsForceVisible(), operator=(), PCB_SHAPE::operator==(), SetForceVisible(), 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 529 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), GetParentGroup(), operator=(), SCH_LINE::SCH_LINE(), SetParentGroup(), and SCH_ITEM::SwapItemData().

◆ m_instances

std::vector<SCH_SHEET_INSTANCE> SCH_SHEET::m_instances

private

Definition at line 569 of file sch_sheet.h.

Referenced by AddInstance(), addInstance(), getInstance(), GetInstances(), getPageNumber(), GetRootInstance(), HasRootInstance(), operator=(), RemoveInstance(), SCH_SHEET(), setInstances(), setPageNumber(), and swapData().

◆ m_isBOARD_ITEM

bool KIGFX::VIEW_ITEM::m_isBOARD_ITEM

privateinherited

Definition at line 208 of file view_item.h.

Referenced by IsBOARD_ITEM(), and VIEW_ITEM().

◆ m_isRollover

bool EDA_ITEM::m_isRollover

protectedinherited

Definition at line 531 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), IsRollover(), operator=(), and SetIsRollover().

◆ m_isSCH_ITEM

bool KIGFX::VIEW_ITEM::m_isSCH_ITEM

privateinherited

Definition at line 207 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 739 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_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Owner.

Definition at line 528 of file eda_item.h.

Referenced by PCB_BOARD_OUTLINE::CopyPros(), SCH_FIELD::DoHypertextAction(), EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), 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_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_FIELD::HitTest(), SCH_PIN::IsStacked(), SCH_FIELD::Matches(), BOARD_BOUNDING_BOX::operator=(), operator=(), PAD::operator==(), PCB_BOARD_OUTLINE::operator==(), PAD::PAD(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_FIELD::Replace(), SCH_LABEL_BASE::ResolveTextVar(), SCH_FIELD::SCH_FIELD(), SCH_SYMBOL::SCH_SYMBOL(), SetModified(), SetParent(), SCH_FIELD::SetPosition(), PAD::Similarity(), PCB_BOARD_OUTLINE::Similarity(), PCB_REFERENCE_IMAGE::swapData(), and PCB_SHAPE::swapData().

◆ m_pins

std::vector<SCH_SHEET_PIN*> SCH_SHEET::m_pins

private

Definition at line 555 of file sch_sheet.h.

Referenced by AddPin(), CleanupSheet(), doIsConnected(), GetConnectionPoints(), GetEndPoints(), GetMinHeight(), GetMinWidth(), GetPin(), GetPins(), GetPins(), HasConnectivityChanges(), HasPin(), HasPins(), HasUndefinedPins(), IsVerticalOrientation(), MirrorHorizontally(), MirrorVertically(), Move(), operator=(), Plot(), RemovePin(), renumberPins(), Resize(), Rotate(), RunOnChildren(), SCH_SHEET(), swapData(), UpdateDanglingState(), Visit(), and ~SCH_SHEET().

◆ m_pos

VECTOR2I SCH_SHEET::m_pos

private

Definition at line 563 of file sch_sheet.h.

Referenced by AutoplaceFields(), SCH_SHEET_PIN::ConstrainOnEdge(), GetBodyBoundingBox(), GetMinHeight(), GetMinWidth(), GetPosition(), GetRotationCenter(), MirrorHorizontally(), MirrorVertically(), Move(), operator=(), operator==(), Plot(), Rotate(), SCH_SHEET(), SCH_SHEET(), SetPosition(), SetPositionIgnoringPins(), SCH_SHEET_PIN::SetSide(), and swapData().

◆ m_private

bool SCH_ITEM::m_private

protectedinherited

Definition at line 742 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_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 756 of file sch_item.h.

Referenced by AddRuleAreaToCache(), ClearRuleAreasCache(), SCH_SYMBOL::GetComponentClassNames(), GetRuleAreaCache(), ResolveDNP(), ResolveExcludedFromBoard(), ResolveExcludedFromBOM(), and ResolveExcludedFromSim().

◆ m_screen

SCH_SCREEN* SCH_SHEET::m_screen

private

Definition at line 551 of file sch_sheet.h.

Referenced by CleanupSheet(), CountSheets(), CountSheets(), GetContextualTextVars(), GetScreen(), GetScreenCount(), HasUndefinedPins(), LocatePathOfScreen(), ResolveTextVar(), SCH_SHEET(), SCH_SHEET(), SearchHierarchy(), SetScreen(), Similarity(), SymbolCount(), and ~SCH_SHEET().

◆ m_size

VECTOR2I SCH_SHEET::m_size

private

Definition at line 564 of file sch_sheet.h.

Referenced by AutoplaceFields(), SCH_SHEET_PIN::ConstrainOnEdge(), GetBodyBoundingBox(), GetMinHeight(), GetMinWidth(), GetRotationCenter(), GetSize(), MirrorHorizontally(), MirrorVertically(), operator=(), operator==(), Plot(), Resize(), Rotate(), SCH_SHEET(), SCH_SHEET(), SCH_SHEET_PIN::SetSide(), SetSize(), and swapData().

◆ m_storedPos

VECTOR2I SCH_ITEM::m_storedPos

protectedinherited

Definition at line 744 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.

See comment near SetType() regarding virtual functions.

Definition at line 524 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), IsType(), operator=(), and Type().

◆ m_unit

int SCH_ITEM::m_unit

protectedinherited

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 516 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 209 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::OnDestroy(), KIGFX::VIEW::Remove(), KIGFX::VIEW::updateBbox(), KIGFX::VIEW::updateLayers(), VIEW_ITEM(), viewPrivData(), and ~VIEW_ITEM().

◆ SCH_IO_KICAD_SEXPR_PARSER

friend SCH_SHEET::SCH_IO_KICAD_SEXPR_PARSER

protected

Definition at line 482 of file sch_sheet.h.

◆ SCH_SHEET_PATH

friend SCH_SHEET::SCH_SHEET_PATH

protected

Definition at line 481 of file sch_sheet.h.

Referenced by findSelf(), GetContextualTextVars(), GetMsgPanelInfo(), HasConnectivityChanges(), LocatePathOfScreen(), ResolveTextVar(), and UpdateDanglingState().

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

Friends

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

Constructor & Destructor Documentation

◆ SCH_SHEET() [1/2]

◆ SCH_SHEET() [2/2]

◆ ~SCH_SHEET()

Member Function Documentation

◆ AddConnectionTo()

◆ AddInstance()

◆ addInstance()

◆ AddPin()

◆ AddRuleAreaToCache()

◆ AutoplaceFields()

◆ BeginEdit()

◆ CalcEdit()

◆ CanConnect()

◆ ClassOf()

◆ CleanupSheet()

◆ ClearBrightened()

◆ ClearCaches()

◆ ClearConnectedItems()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearRuleAreasCache()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ compare()

◆ ComparePageNum()

◆ ConnectedItems()

◆ Connection()

◆ ConnectionPropagatesTo()

◆ ContinueEdit()

◆ CountSheets() [1/2]

◆ CountSheets() [2/2]

◆ Deserialize()

◆ DoHypertextAction()

◆ doIsConnected()

◆ Duplicate()

◆ EndEdit()

◆ findParent()

◆ findSelf()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBackgroundColor()

◆ GetBodyBoundingBox()

◆ GetBodyStyle()

◆ GetBodyStyleDescription()

◆ GetBodyStyleProp()

◆ GetBorderColor()

◆ GetBorderWidth()

◆ GetBoundingBox()

◆ GetCachedDriverName()

◆ GetClass()

◆ GetConnectionPoints()

◆ GetContextualTextVars()

◆ GetDefaultFont()

◆ GetDNP()

◆ GetEditFlags()

◆ GetEffectiveNetClass()

◆ GetEffectivePenWidth()

◆ GetEmbeddedFiles()

◆ GetEmbeddedFonts()

◆ GetEndPoints()

◆ GetExcludedFromBoard()

◆ GetExcludedFromBOM()

◆ GetExcludedFromSim()