#include <sch_label.h>

Inheritance diagram for SCH_GLOBALLABEL:

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_GLOBALLABEL (const VECTOR2I &aPos=VECTOR2I(0, 0), const wxString &aText=wxEmptyString)

	SCH_GLOBALLABEL (const SCH_GLOBALLABEL &aGlobalLabel)

	~SCH_GLOBALLABEL ()

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

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

wxString	GetClass () const override
	Return the class name.

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

int	GetMandatoryFieldCount () override

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

const SCH_FIELD *	GetField (FIELD_T aFieldNdx) const

void	SetSpinStyle (SPIN_STYLE aSpinStyle) override

VECTOR2I	GetSchematicTextOffset (const RENDER_SETTINGS *aSettings) const override
	This offset depends on the orientation, the type of text, and the area required to draw the associated graphic symbol or to put the text above a wire.

void	CreateGraphicShape (const RENDER_SETTINGS *aRenderSettings, std::vector< VECTOR2I > &aPoints, const VECTOR2I &aPos) const override
	Calculate the graphic shape (a polygon) associated to the text.

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

bool	IsConnectable () const override

std::vector< int >	ViewGetLayers () const override
	Return the all the layers within the VIEW the object is painted on.

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

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

bool	IsPointClickableAnchor (const VECTOR2I &aPos) const override

bool	AutoRotateOnPlacementSupported () const override

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

bool	CanConnect (const SCH_ITEM *aItem) 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.

LABEL_SHAPE	GetLabelShape () const

void	SetLabelShape (LABEL_SHAPE aShape)

LABEL_FLAG_SHAPE	GetShape () const

void	SetShape (LABEL_FLAG_SHAPE aShape)

COLOR4D	GetLabelColor () const

SPIN_STYLE	GetSpinStyle () const

void	SetLastResolvedState (const SCH_ITEM *aItem) override

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

std::vector< SCH_FIELD > &	GetFields ()

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

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

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

void	AddField (const SCH_FIELD &aField)

bool	IncrementLabel (int aIncrement)
	Increment the label text if it ends with a number.

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

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

void	Rotate90 (bool aClockwise) override

void	MirrorSpinStyle (bool aLeftRight) override

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

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

void	SetPosition (const VECTOR2I &aPosition) override

void	AutoplaceFields (SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo) override

void	GetIntersheetRefs (const SCH_SHEET_PATH aPath, std::vector< std::pair< wxString, wxString > > pages)
	Build an array of { pageNumber, pageName } pairs.

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

wxString	GetShownText (const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const override

wxString	GetShownText (bool aAllowExtraText, int aDepth=0) const override
	Return the string actually shown after processing of the base text.

bool	HasCachedDriverName () const override

const wxString &	GetCachedDriverName () const override

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

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

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

bool	Replace (const EDA_SEARCH_DATA &aSearchData, void *aAuxData) override
	Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

bool	Replace (const EDA_SEARCH_DATA &aSearchData)
	Helper function used in search and replace dialog.

int	GetLabelBoxExpansion (const RENDER_SETTINGS *aSettings=nullptr) const

virtual const BOX2I	GetBodyBoundingBox (const RENDER_SETTINGS *aSettings) const
	Return the bounding box of the label only, without taking in account its fields.

const BOX2I	GetBoundingBox () const override
	Return the bounding box of the label including its fields.

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

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

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

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

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

void	SetIsDangling (bool aIsDangling)

void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
	Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

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

bool	AutoRotateOnPlacement () const
	autoRotateOnPlacement

void	SetAutoRotateOnPlacement (bool autoRotate=true)

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

double	Similarity (const EDA_TEXT &aOther) const

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

bool	operator== (const EDA_TEXT &aRhs) const

wxString	GetFriendlyName () const override

KIFONT::FONT *	GetDrawFont (const RENDER_SETTINGS *aSettings) const override

int	GetSchTextSize () const

void	SetSchTextSize (int aSize)

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

void	DoHypertextAction (EDA_DRAW_FRAME *aFrame) const override

void	SetExcludedFromSim (bool aExclude) override

bool	GetExcludedFromSim () const override

bool	operator< (const SCH_ITEM &aItem) const override

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

bool	operator< (const EDA_TEXT &aRhs) const

int	GetTextOffset (const RENDER_SETTINGS *aSettings=nullptr) const

int	GetPenWidth () const override

void	NormalizeJustification (bool inverse)

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

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

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

VECTOR2I	GetPosition () const override

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

virtual void	SetExcludedFromBOM (bool aExcludeFromBOM)

virtual bool	GetExcludedFromBOM () const

bool	ResolveExcludedFromBOM () const

virtual void	SetExcludedFromBoard (bool aExcludeFromBoard)

virtual bool	GetExcludedFromBoard () const

bool	ResolveExcludedFromBoard () const

virtual void	SetDNP (bool aDNP)

virtual bool	GetDNP () const

bool	ResolveDNP () const

virtual bool	IsMovableFromAnchorPoint () const
	Check if object is movable from the anchor point.

VECTOR2I &	GetStoredPos ()

void	SetStoredPos (const VECTOR2I &aPos)

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

const SYMBOL *	GetParentSymbol () const

SYMBOL *	GetParentSymbol ()

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 bool	ContinueEdit (const VECTOR2I &aPosition)
	Continue an edit in progress at aPosition.

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

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

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.

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

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 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 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 const wxString &	GetText () const
	Return the string associated with the text object.

bool	HasTextVars () const
	Indicates the ShownText has text var references which need to be processed.

virtual void	SetText (const wxString &aText)

wxString	EvaluateText (const wxString &aText) const

void	SetTextThickness (int aWidth)
	The TextThickness is that set by the user.

int	GetTextThickness () const

int	GetTextThicknessProperty () const

void	SetAutoThickness (bool aAuto)

bool	GetAutoThickness () const

int	GetEffectiveTextPenWidth (int aDefaultPenWidth=0) const
	The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.

virtual void	SetTextAngle (const EDA_ANGLE &aAngle)

const EDA_ANGLE &	GetTextAngle () const

void	SetTextAngleDegrees (double aOrientation)

double	GetTextAngleDegrees () const

void	SetItalic (bool aItalic)
	Set the text to be italic - this will also update the font if needed.

void	SetItalicFlag (bool aItalic)
	Set only the italic flag, without changing the font.

bool	IsItalic () const

void	SetBold (bool aBold)
	Set the text to be bold - this will also update the font if needed.

void	SetBoldFlag (bool aBold)
	Set only the bold flag, without changing the font.

bool	IsBold () const

virtual void	SetVisible (bool aVisible)

virtual bool	IsVisible () const

void	SetMirrored (bool isMirrored)

bool	IsMirrored () const

void	SetMultilineAllowed (bool aAllow)

bool	IsMultilineAllowed () const

void	SetHorizJustify (GR_TEXT_H_ALIGN_T aType)

GR_TEXT_H_ALIGN_T	GetHorizJustify () const

void	SetVertJustify (GR_TEXT_V_ALIGN_T aType)

GR_TEXT_V_ALIGN_T	GetVertJustify () const

void	SetKeepUpright (bool aKeepUpright)

bool	IsKeepUpright () const

void	FlipHJustify ()

void	SetAttributes (const EDA_TEXT &aSrc, bool aSetPosition=true)
	Set the text attributes from another instance.

void	SetAttributes (const TEXT_ATTRIBUTES &aTextAttrs)

void	SwapAttributes (EDA_TEXT &aTradingPartner)
	Swap the text attributes of the two involved instances.

void	SwapText (EDA_TEXT &aTradingPartner)

void	CopyText (const EDA_TEXT &aSrc)

const TEXT_ATTRIBUTES &	GetAttributes () const

bool	IsDefaultFormatting () const

void	SetFont (KIFONT::FONT *aFont)

KIFONT::FONT *	GetFont () const

void	SetUnresolvedFontName (const wxString &aFontName)

bool	ResolveFont (const std::vector< wxString > *aEmbeddedFonts)

wxString	GetFontName () const

void	SetFontProp (const wxString &aFontName)

wxString	GetFontProp () const

void	SetLineSpacing (double aLineSpacing)

double	GetLineSpacing () const

void	SetTextSize (VECTOR2I aNewSize, bool aEnforceMinTextSize=true)

VECTOR2I	GetTextSize () const

void	SetTextWidth (int aWidth)

int	GetTextWidth () const

void	SetTextHeight (int aHeight)

int	GetTextHeight () const

void	SetTextColor (const COLOR4D &aColor)

COLOR4D	GetTextColor () const

void	SetTextPos (const VECTOR2I &aPoint)

const VECTOR2I &	GetTextPos () const

void	SetTextX (int aX)

void	SetTextY (int aY)

void	Offset (const VECTOR2I &aOffset)

void	Empty ()

void	Print (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, const COLOR4D &aColor)
	Print this text object to the device context aDC.

std::shared_ptr< SHAPE_COMPOUND >	GetEffectiveTextShape (bool aTriangulate=true, const BOX2I &aBBox=BOX2I(), const EDA_ANGLE &aAngle=ANGLE_0) const
	build a list of segments (SHAPE_SEGMENT) to describe a text shape.

virtual bool	TextHitTest (const VECTOR2I &aPoint, int aAccuracy=0) const
	Test if aPoint is within the bounds of this object.

virtual bool	TextHitTest (const BOX2I &aRect, bool aContains, int aAccuracy=0) const
	Test if object bounding box is contained within or intersects aRect.

BOX2I	GetTextBox (const RENDER_SETTINGS *aSettings, int aLine=-1) const
	Useful in multiline texts to calculate the full text or a line area (for zones filling, locate functions....)

int	GetInterline (const RENDER_SETTINGS *aSettings) const
	Return the distance between two lines of text.

wxString	GetTextStyleName () const

void	GetLinePositions (const RENDER_SETTINGS *aSettings, std::vector< VECTOR2I > &aPositions, int aLineCount) const
	Populate aPositions with the position of each line of a multiline text, according to the vertical justification and the rotation of the whole text.

double	Levenshtein (const EDA_TEXT &aOther) const
	Return the levenstein distance between two texts.

virtual void	Format (OUTPUTFORMATTER *aFormatter, int aControlBits) const
	Output the object to aFormatter in s-expression form.

virtual EDA_ANGLE	GetDrawRotation () const

virtual VECTOR2I	GetDrawPos () const

virtual void	ClearRenderCache ()

virtual void	ClearBoundingBoxCache ()

std::vector< std::unique_ptr< KIFONT::GLYPH > > *	GetRenderCache (const KIFONT::FONT *aFont, const wxString &forResolvedText, const VECTOR2I &aOffset={ 0, 0 }) const

void	SetupRenderCache (const wxString &aResolvedText, const KIFONT::FONT *aFont, const EDA_ANGLE &aAngle, const VECTOR2I &aOffset)

void	AddRenderCacheGlyph (const SHAPE_POLY_SET &aPoly)

int	Compare (const EDA_TEXT *aOther) const

bool	operator> (const EDA_TEXT &aRhs) const

virtual bool	HasHyperlink () const

wxString	GetHyperlink () const

void	SetHyperlink (wxString aLink)

void	RemoveHyperlink ()

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

static const wxString	GetDefaultFieldName (const wxString &aName, bool aUseDefaultName)

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 HTML_MESSAGE_BOX *	ShowSyntaxHelp (wxWindow *aParentWindow)

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

static GR_TEXT_H_ALIGN_T	MapHorizJustify (int aHorizJustify)

static GR_TEXT_V_ALIGN_T	MapVertJustify (int aVertJustify)

static bool	ValidateHyperlink (const wxString &aURL)
	Check if aURL is a valid hyperlink.

static bool	IsGotoPageHref (const wxString &aHref, wxString *aDestination=nullptr)
	Check if aHref is a valid internal hyperlink.

static wxString	GotoPageHref (const wxString &aDestination)
	Generate a href to a page in the current schematic.

Public Attributes
const KIID	m_Uuid

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

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

void	cacheShownText () override

const KIFONT::METRICS &	getFontMetrics () const override

int	compare (const SCH_ITEM &aOther, int aCompareFlags=0) const override
	Provide the draw object specific comparison called by the == and < operators.

SCH_RENDER_SETTINGS *	getRenderSettings (PLOTTER *aPlotter) const

EDA_ITEM *	findParent (KICAD_T aType) const

void	printOneLineOfText (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, const COLOR4D &aColor, const wxString &aText, const VECTOR2I &aPos)
	Print each line of this EDA_TEXT.

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
std::vector< SCH_FIELD >	m_fields

LABEL_FLAG_SHAPE	m_shape

CONNECTION_TYPE	m_connectionType

bool	m_isDangling

bool	m_autoRotateOnPlacement

COLOR4D	m_lastResolvedColor

wxString	m_cached_driver_name

bool	m_excludedFromSim

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

wxString	m_hyperlink
	A hyperlink URL.

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

wxString	m_text

wxString	m_shown_text

bool	m_shown_text_has_text_var_refs

std::reference_wrapper< const EDA_IU_SCALE >	m_IuScale

wxString	m_render_cache_text

const KIFONT::FONT *	m_render_cache_font

EDA_ANGLE	m_render_cache_angle

VECTOR2I	m_render_cache_offset

std::vector< std::unique_ptr< KIFONT::GLYPH > >	m_render_cache

std::map< int, BBOX_CACHE_ENTRY >	m_bbox_cache

TEXT_ATTRIBUTES	m_attributes

wxString	m_unresolvedFontName

VECTOR2I	m_pos

bool	m_visible

Detailed Description

Definition at line 518 of file sch_label.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_GLOBALLABEL() [1/2]

SCH_GLOBALLABEL::SCH_GLOBALLABEL	(	const VECTOR2I &	aPos = VECTOR2I( 0, 0 ),
		const wxString &	aText = wxEmptyString )

Definition at line 1988 of file sch_label.cpp.

References SCH_LABEL_BASE::GetDefaultFieldName(), GR_TEXT_V_ALIGN_CENTER, INTERSHEET_REFS, L_BIDI, LAYER_GLOBLABEL, SCH_LABEL_BASE::m_fields, SCH_LABEL_BASE::m_isDangling, SCH_ITEM::m_layer, SCH_LABEL_BASE::m_shape, SCH_GLOBAL_LABEL_T, SCH_LABEL_BASE::SCH_LABEL_BASE(), EDA_TEXT::SetVertJustify(), and text.

Referenced by Clone(), and SCH_GLOBALLABEL().

◆ SCH_GLOBALLABEL() [2/2]

SCH_GLOBALLABEL::SCH_GLOBALLABEL ( const SCH_GLOBALLABEL & aGlobalLabel )

Definition at line 2006 of file sch_label.cpp.

References SCH_GLOBALLABEL(), and SCH_LABEL_BASE::SCH_LABEL_BASE().

◆ ~SCH_GLOBALLABEL()

SCH_GLOBALLABEL::~SCH_GLOBALLABEL ( )

inline

Definition at line 526 of file sch_label.h.

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

◆ AddField()

void SCH_LABEL_BASE::AddField ( const SCH_FIELD & aField )

inlineinherited

Definition at line 230 of file sch_label.h.

References m_fields.

Referenced by SCH_IO_LTSPICE_PARSER::CreateSCH_LABEL().

◆ AddFields()

void SCH_LABEL_BASE::AddFields ( const std::vector< SCH_FIELD > & aFields )

inlineinherited

Definition at line 225 of file sch_label.h.

References m_fields.

Referenced by SCH_EDIT_TOOL::ChangeTextType().

◆ AddRenderCacheGlyph()

void EDA_TEXT::AddRenderCacheGlyph ( const SHAPE_POLY_SET & aPoly )

inherited

Definition at line 731 of file eda_text.cpp.

References KIFONT::OUTLINE_GLYPH::CacheTriangulation(), and m_render_cache.

◆ 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_LABEL_BASE::AutoplaceFields	(	SCH_SCREEN *	aScreen,
		AUTOPLACE_ALGO	aAlgo )

overridevirtualinherited

◆ AutoRotateOnPlacement()

bool SCH_LABEL_BASE::AutoRotateOnPlacement ( ) const

inherited

autoRotateOnPlacement

Returns: true if the label rotation will be automatically set on the placement.

Definition at line 1585 of file sch_label.cpp.

References m_autoRotateOnPlacement.

Referenced by SCH_EDIT_FRAME::AutoRotateItem(), and SCH_DRAWING_TOOLS::createNewLabel().

◆ AutoRotateOnPlacementSupported()

bool SCH_GLOBALLABEL::AutoRotateOnPlacementSupported ( ) const

inlineoverridevirtual

Returns: true if the automated rotation of the label is supported after the placement At the moment it is supported for global and hierarchical labels

Implements SCH_LABEL_BASE.

Definition at line 578 of file sch_label.h.

◆ BeginEdit()

void SCH_TEXT::BeginEdit ( const VECTOR2I & aPosition )

overridevirtualinherited

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

Definition at line 422 of file sch_text.cpp.

References EDA_TEXT::SetTextPos().

◆ cacheShownText()

void SCH_LABEL_BASE::cacheShownText ( )

overrideprotectedvirtualinherited

Reimplemented from EDA_TEXT.

Definition at line 962 of file sch_label.cpp.

References EDA_TEXT::cacheShownText(), CTX_NETNAME, EscapeString(), EDA_TEXT::GetShownText(), EDA_TEXT::HasTextVars(), and m_cached_driver_name.

◆ CalcEdit()

void SCH_TEXT::CalcEdit ( const VECTOR2I & aPosition )

overridevirtualinherited

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

Definition at line 428 of file sch_text.cpp.

References EDA_TEXT::SetTextPos().

◆ CanConnect()

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

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 148 of file sch_label.h.

References SCH_ITEM::GetLayer(), LAYER_BUS, LAYER_WIRE, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_ITEM::SCH_ITEM(), SCH_LABEL_T, SCH_LINE_T, SCH_SHEET_PIN_T, SCH_SYMBOL_T, and EDA_ITEM::Type().

Referenced by SCH_MOVE_TOOL::getConnectedDragItems().

◆ ClassOf()

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

inlinestatic

Definition at line 531 of file sch_label.h.

References SCH_GLOBAL_LABEL_T, and EDA_ITEM::Type().

◆ ClearBoundingBoxCache()

void EDA_TEXT::ClearBoundingBoxCache ( )

virtualinherited

Definition at line 678 of file eda_text.cpp.

References m_bbox_cache.

Referenced by cacheShownText(), SCH_FIELD::ClearCaches(), Empty(), Offset(), Replace(), SetAttributes(), SetBoldFlag(), SetFont(), SetHorizJustify(), SetItalicFlag(), SetKeepUpright(), SetLineSpacing(), SetMirrored(), SetMultilineAllowed(), SetTextAngle(), SetTextHeight(), SetTextSize(), SetTextThickness(), SetTextWidth(), SetVertJustify(), and SwapAttributes().

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

◆ ClearRenderCache()

void EDA_TEXT::ClearRenderCache ( )

virtualinherited

Reimplemented in PCB_DIMENSION_BASE, and SCH_FIELD.

Definition at line 672 of file eda_text.cpp.

References m_render_cache.

Referenced by cacheShownText(), PCB_DIMENSION_BASE::ClearRenderCache(), SCH_FIELD::ClearRenderCache(), Empty(), PCB_TABLE::Normalize(), SCH_TABLE::Normalize(), Replace(), SetAttributes(), SetBoldFlag(), SetFont(), SetHorizJustify(), SetItalicFlag(), SetKeepUpright(), SetLineSpacing(), SetMirrored(), SetMultilineAllowed(), SetTextAngle(), SetTextHeight(), SetTextSize(), SetTextThickness(), SetTextWidth(), SetVertJustify(), SetVisible(), and SwapAttributes().

◆ 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_GLOBALLABEL::Clone ( ) const

inlineoverridevirtual

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 541 of file sch_label.h.

References SCH_GLOBALLABEL().

◆ Compare()

int EDA_TEXT::Compare ( const EDA_TEXT * aOther ) const

inherited

Definition at line 1196 of file eda_text.cpp.

References EDA_TEXT(), GetFontName(), m_attributes, m_pos, m_text, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by operator<(), operator==(), and operator>().

◆ compare()

int SCH_TEXT::compare	(	const SCH_ITEM &	aOther,
		int	aCompareFlags = 0 ) const

overrideprotectedvirtualinherited

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.

The text specific sort order is as follows:

Text string, case insensitive compare.
Text horizontal (X) position.
Text vertical (Y) position.
Text width.
Text height.

Reimplemented from SCH_ITEM.

Definition at line 641 of file sch_text.cpp.

References SCH_ITEM::compare(), EDA_TEXT::GetText(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextWidth(), result, SCH_ITEM::SCH_ITEM(), SCH_TEXT(), SCH_TEXT_T, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT & aSrc )

inherited

Definition at line 278 of file eda_text.cpp.

References cacheShownText(), EDA_TEXT(), and m_text.

◆ CreateGraphicShape()

void SCH_GLOBALLABEL::CreateGraphicShape	(	const RENDER_SETTINGS *	aSettings,
		std::vector< VECTOR2I > &	aPoints,
		const VECTOR2I &	Pos ) const

overridevirtual

Calculate the graphic shape (a polygon) associated to the text.

Parameters

aPoints	A buffer to fill with polygon corners coordinates
Pos	Position of the shape, for texts and labels: do nothing

Reimplemented from SCH_LABEL_BASE.

Definition at line 2151 of file sch_label.cpp.

References ANGLE_180, ANGLE_90, SPIN_STYLE::BOTTOM, SCH_LABEL_BASE::GetLabelBoxExpansion(), SCH_TEXT::GetPenWidth(), SCH_LABEL_BASE::GetSpinStyle(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextHeight(), BOX2< Vec >::GetWidth(), L_BIDI, L_INPUT, L_OUTPUT, L_TRISTATE, L_UNSPECIFIED, SPIN_STYLE::LEFT, SCH_LABEL_BASE::m_shape, SPIN_STYLE::RIGHT, RotatePoint(), and SPIN_STYLE::UP.

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

◆ Deserialize()

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

overridevirtual

Deserializes the given protobuf message into this object.

Parameters

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

Returns: true if unpacking and deserialization succeeded

Reimplemented from SERIALIZABLE.

Definition at line 2018 of file sch_label.cpp.

◆ DoHypertextAction()

void SCH_TEXT::DoHypertextAction ( EDA_DRAW_FRAME * aFrame ) const

overridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 365 of file sch_text.cpp.

References TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), SCH_NAVIGATE_TOOL::HypertextCommand(), IsHypertext(), and EDA_TEXT::m_hyperlink.

◆ doIsConnected()

bool SCH_GLOBALLABEL::doIsConnected ( const VECTOR2I & aPosition ) const

inlineoverrideprivatevirtual

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 581 of file sch_label.h.

References EDA_TEXT::GetTextPos().

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

◆ Empty()

void EDA_TEXT::Empty ( )

inherited

Definition at line 616 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_text.

Referenced by SCH_IO_KICAD_LEGACY_LIB_CACHE::LoadPart().

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

◆ EvaluateText()

wxString EDA_TEXT::EvaluateText ( const wxString & aText ) const

inherited

Definition at line 642 of file eda_text.cpp.

References EXPRESSION_EVALUATOR::Evaluate().

Referenced by PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), and SCH_TEXTBOX::GetShownText().

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

◆ FlipHJustify()

void EDA_TEXT::FlipHJustify ( )

inlineinherited

Definition at line 207 of file eda_text.h.

References GetHorizJustify(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, and SetHorizJustify().

Referenced by SCH_TEXT::MirrorHorizontally(), SCH_TEXT::MirrorSpinStyle(), SCH_TEXT::MirrorVertically(), and SCH_TEXT::Rotate90().

◆ Format()

void EDA_TEXT::Format	(	OUTPUTFORMATTER *	aFormatter,
		int	aControlBits ) const

virtualinherited

Output the object to aFormatter in s-expression form.

Parameters

aFormatter	The OUTPUTFORMATTER object to write to.
aControlBits	The control bit definition for object specific formatting.

Exceptions

IO_ERROR on write error.

Definition at line 1050 of file eda_text.cpp.

References CTL_OMIT_COLOR, CTL_OMIT_HYPERLINK, KICAD_FORMAT::FormatBool(), FormatDouble2Str(), EDA_UNIT_UTILS::FormatInternalUnits(), GetAutoThickness(), GetFont(), GetHorizJustify(), GetHyperlink(), GetLineSpacing(), GetTextColor(), GetTextHeight(), GetTextThickness(), GetTextWidth(), GetVertJustify(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, HasHyperlink(), IsBold(), IsItalic(), IsMirrored(), KiROUND(), m_IuScale, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and COLOR4D::UNSPECIFIED.

Referenced by SCH_IO_KICAD_SEXPR::saveField(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField().

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

◆ GetAttributes()

const TEXT_ATTRIBUTES & EDA_TEXT::GetAttributes ( ) const

inlineinherited

Definition at line 230 of file eda_text.h.

References m_attributes.

Referenced by BOARD_ADAPTER::addText(), PCB_IO_IPC2581::addText(), Deserialize(), PCB_TEXTBOX::Deserialize(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DS_DRAW_ITEM_TEXT::GetApproxBBox(), GetEffectiveTextShape(), PCB_TEXT::GetKnockoutCache(), GetRenderCache(), FEATURES_MANAGER::InitFeatureList(), SIM_MODEL::MigrateSimModel(), std::hash< EDA_TEXT >::operator()(), PCB_FIELD::PCB_FIELD(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotText(), CLIPBOARD_IO::SaveSelection(), Serialize(), PCB_TEXTBOX::Serialize(), PCB_TEXT::TransformTextToPolySet(), and PCB_TEXTBOX::TransformTextToPolySet().

◆ GetAutoThickness()

bool EDA_TEXT::GetAutoThickness ( ) const

inlineinherited

Definition at line 138 of file eda_text.h.

References GetTextThickness().

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), GetTextThicknessProperty(), IsDefaultFormatting(), and SetAutoThickness().

◆ GetBodyBoundingBox()

const BOX2I SCH_LABEL_BASE::GetBodyBoundingBox ( const RENDER_SETTINGS * aSettings ) const

virtualinherited

Return the bounding box of the label only, without taking in account its fields.

Reimplemented in SCH_HIERLABEL, and SCH_LABEL.

Definition at line 1117 of file sch_label.cpp.

References CreateGraphicShape(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetTextPos(), BOX2< Vec >::Inflate(), BOX2< Vec >::Merge(), and BOX2< Vec >::Normalize().

Referenced by AutoplaceFields(), GetBoundingBox(), HitTest(), HitTest(), HitTest(), and Plot().

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

◆ GetBoundingBox()

const BOX2I SCH_LABEL_BASE::GetBoundingBox ( ) const

overridevirtualinherited

Return the bounding box of the label including its fields.

Reimplemented from EDA_ITEM.

Definition at line 1135 of file sch_label.cpp.

References GetBodyBoundingBox(), GetSchematicTextOffset(), m_fields, BOX2< Vec >::Merge(), BOX2< Vec >::Normalize(), BOX2< Vec >::Offset(), SCH_GLOBAL_LABEL_T, SCH_LABEL_T, and EDA_ITEM::Type().

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

◆ GetCachedDriverName()

const wxString & SCH_LABEL_BASE::GetCachedDriverName ( ) const

overridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 956 of file sch_label.cpp.

References m_cached_driver_name.

◆ GetClass()

wxString SCH_GLOBALLABEL::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements SCH_LABEL_BASE.

Definition at line 536 of file sch_label.h.

◆ GetConnectionPoints()

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

overridevirtualinherited

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 1086 of file sch_label.cpp.

References EDA_TEXT::GetTextPos().

Referenced by SCH_RULE_AREA::RefreshContainedItemsAndDirectives(), and ERC_TESTER::TestLabelMultipleWires().

◆ GetContextualTextVars()

void SCH_LABEL_BASE::GetContextualTextVars ( wxArrayString * aVars ) const

inherited

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

Definition at line 769 of file sch_label.cpp.

References m_fields.

Referenced by SCH_FIELD::OnScintillaCharAdded().

◆ GetDefaultFieldName()

const wxString SCH_LABEL_BASE::GetDefaultFieldName	(	const wxString &	aName,
		bool	aUseDefaultName )

staticinherited

Definition at line 220 of file sch_label.cpp.

References _.

Referenced by SCH_FIELD::GetName(), FIELDS_GRID_TABLE::GetValue(), DIALOG_LABEL_PROPERTIES::OnAddField(), and SCH_GLOBALLABEL::SCH_GLOBALLABEL().

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

virtual bool SCH_ITEM::GetDNP ( ) const

inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, and SYMBOL.

Definition at line 265 of file sch_item.h.

Referenced by ResolveDNP().

◆ GetDrawFont()

KIFONT::FONT * SCH_TEXT::GetDrawFont ( const RENDER_SETTINGS * aSettings ) const

overridevirtualinherited

Reimplemented from EDA_TEXT.

Definition at line 285 of file sch_text.cpp.

References SCH_ITEM::GetDefaultFont(), EDA_TEXT::GetFont(), KIFONT::FONT::GetFont(), EDA_TEXT::IsBold(), and EDA_TEXT::IsItalic().

Referenced by SCH_LABEL_BASE::Plot(), and Plot().

◆ GetDrawPos()

virtual VECTOR2I EDA_TEXT::GetDrawPos ( ) const

inlinevirtualinherited

Reimplemented in PCB_TEXTBOX, and SCH_TEXTBOX.

Definition at line 377 of file eda_text.h.

References GetTextPos().

Referenced by BOARD_ADAPTER::addText(), PCB_TEXT::buildBoundingHull(), KIGFX::SCH_PAINTER::draw(), GetEffectiveTextShape(), PCB_TEXT::GetKnockoutCache(), GetLinePositions(), GetRenderCache(), GetTextBox(), Print(), TextHitTest(), and PCB_TEXT::TextHitTest().

◆ GetDrawRotation()

virtual EDA_ANGLE EDA_TEXT::GetDrawRotation ( ) const

inlinevirtualinherited

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

◆ GetEffectiveTextPenWidth()

int EDA_TEXT::GetEffectiveTextPenWidth ( int aDefaultPenWidth = 0 ) const

inherited

The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.

Definition at line 466 of file eda_text.cpp.

References ClampTextPenSize(), GetPenSizeForBold(), GetPenSizeForNormal(), GetTextSize(), GetTextThickness(), GetTextWidth(), and IsBold().

Referenced by BOARD_ADAPTER::addText(), PCB_IO_IPC2581::addText(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), SCH_HIERLABEL::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), SCH_LABEL_BASE::GetBodyBoundingBox(), GetEffectiveTextShape(), PCB_TEXT::getKnockoutMargin(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_FIELD::GetPenWidth(), SCH_TEXT::GetPenWidth(), SCH_TEXTBOX::GetShownText(), GetTextBox(), GetTextThicknessProperty(), FEATURES_MANAGER::InitFeatureList(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotText(), printOneLineOfText(), SetAutoThickness(), PCB_TEXT::TextHitTest(), PCB_TEXT::TransformTextToPolySet(), PCB_TEXTBOX::TransformTextToPolySet(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ GetEffectiveTextShape()

std::shared_ptr< SHAPE_COMPOUND > EDA_TEXT::GetEffectiveTextShape	(	bool	aTriangulate = true,
		const BOX2I &	aBBox = BOX2I(),
		const EDA_ANGLE &	aAngle = ANGLE_0 ) const

inherited

build a list of segments (SHAPE_SEGMENT) to describe a text shape.

Parameters

aTriangulate	true to build also the triangulation of each shape
aUseTextRotation	true to use the actual text draw rotation. false to build a list of shape for a not rotated text ("native" shapes).

Definition at line 1117 of file eda_text.cpp.

References SHAPE_SIMPLE::Append(), KIFONT::FONT::Draw(), KIGFX::GAL::DrawGlyphs(), GetAttributes(), BOX2< Vec >::GetCenter(), GetDrawFont(), GetDrawPos(), GetDrawRotation(), GetEffectiveTextPenWidth(), getFontMetrics(), GetRenderCache(), GetShownText(), BOX2< Vec >::GetWidth(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, KIFONT::FONT::IsOutline(), TEXT_ATTRIBUTES::m_Angle, TEXT_ATTRIBUTES::m_Halign, and TEXT_ATTRIBUTES::m_Valign.

Referenced by PCB_DIMENSION_BASE::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), PCB_TEXTBOX::GetEffectiveShape(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), and PCB_SELECTION_TOOL::hitTestDistance().

◆ 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_LABEL_BASE::GetEndPoints ( std::vector< DANGLING_END_ITEM > & aItemList )

overridevirtualinherited

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.

Reimplemented in SCH_SHEET_PIN.

Definition at line 1079 of file sch_label.cpp.

References EDA_TEXT::GetTextPos(), and LABEL_END.

◆ GetExcludedFromBoard()

virtual bool SCH_ITEM::GetExcludedFromBoard ( ) const

inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, and SYMBOL.

Definition at line 261 of file sch_item.h.

Referenced by ResolveExcludedFromBoard().

◆ GetExcludedFromBOM()

virtual bool SCH_ITEM::GetExcludedFromBOM ( ) const

inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, and SYMBOL.

Definition at line 257 of file sch_item.h.

Referenced by ResolveExcludedFromBOM().

◆ GetExcludedFromSim()

bool SCH_TEXT::GetExcludedFromSim ( ) const

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 88 of file sch_text.h.

References m_excludedFromSim.

Referenced by operator<(), operator==(), SCH_IO_KICAD_SEXPR::saveText(), and Similarity().

◆ GetField() [1/2]

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

Definition at line 2035 of file sch_label.cpp.

References FindField(), and SCH_LABEL_BASE::m_fields.

◆ GetField() [2/2]

SCH_FIELD * SCH_GLOBALLABEL::GetField ( FIELD_T aFieldType )

Return a mandatory field in this label.

The const version will return nullptr if the field doesn't exist; the non-const version will create it.

Definition at line 2025 of file sch_label.cpp.

References FindField(), and SCH_LABEL_BASE::m_fields.

Referenced by SCH_DRAWING_TOOLS::createNewLabel(), SCH_IO_KICAD_SEXPR_PARSER::parseSchText(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

◆ GetFields() [1/2]

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

inlineinherited

Definition at line 212 of file sch_label.h.

References m_fields.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewLabel(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_FIND_REPLACE_TOOL::nextMatch(), SCH_IO_KICAD_SEXPR_PARSER::parseSchText(), Plot(), SCH_IO_KICAD_SEXPR::saveText(), SCH_EDIT_TOOL::Swap(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

◆ GetFields() [2/2]

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

inlineinherited

Definition at line 213 of file sch_label.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().

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

◆ GetFont()

KIFONT::FONT * EDA_TEXT::GetFont ( ) const

inlineinherited

Definition at line 246 of file eda_text.h.

References m_attributes.

Referenced by BOARD_ADAPTER::addText(), SCH_EDIT_TOOL::ChangeTextType(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), Format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::formatRenderCache(), GetDrawFont(), SCH_FIELD::GetDrawFont(), SCH_TEXT::GetDrawFont(), SCH_TEXTBOX::GetDrawFont(), GetFontName(), GetFontProp(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TABLECELL::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), FIELDS_GRID_TABLE::GetValue(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), Serialize(), PCB_TEXTBOX::Serialize(), SetBold(), and SetItalic().

◆ GetFontMetrics()

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

inherited

◆ getFontMetrics()

const KIFONT::METRICS & SCH_TEXT::getFontMetrics ( ) const

inlineoverrideprotectedvirtualinherited

Reimplemented from EDA_TEXT.

Definition at line 174 of file sch_text.h.

References SCH_ITEM::GetFontMetrics().

◆ GetFontName()

wxString EDA_TEXT::GetFontName ( ) const

inherited

Definition at line 996 of file eda_text.cpp.

References GetFont(), and KIFONT::FONT::GetName().

Referenced by Compare(), and IsDefaultFormatting().

◆ GetFontProp()

wxString EDA_TEXT::GetFontProp ( ) const

inherited

Definition at line 1005 of file eda_text.cpp.

References _, GetFont(), IsEeschemaType(), and KICAD_FONT_NAME.

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

◆ 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 SCH_TEXT::GetFriendlyName ( ) const

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 57 of file sch_text.h.

References _.

◆ GetHorizJustify()

GR_TEXT_H_ALIGN_T EDA_TEXT::GetHorizJustify ( ) const

inlineinherited

Definition at line 199 of file eda_text.h.

References m_attributes.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), KIGFX::PCB_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), AUTOPLACER::fieldHPlacement(), FlipHJustify(), Format(), PCB_TEXTBOX::GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), SCH_FIELD::GetEffectiveHorizJustify(), SCH_FIELD::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_LABEL_BASE::GetSpinStyle(), GetTextBox(), hash_fp_item(), IsDefaultFormatting(), SCH_FIELD::IsHorizJustifyFlipped(), AUTOPLACER::justifyField(), PCB_TEXT::KeepUpright(), SCH_IO_EAGLE::loadFieldAttributes(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), SIM_MODEL::MigrateSimModel(), PCB_TEXT::Mirror(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_TEXT::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), SCH_TEXT::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), SCH_TEXT::NormalizeJustification(), PCB_IO_EAGLE::orientFPText(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_FIELD::Plot(), positioningChanged(), positioningChanged(), printOneLineOfText(), processTextItem(), SCH_FIELD::Rotate(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), Serialize(), PCB_TEXTBOX::Serialize(), and swapFieldPositionsWithMatching().

◆ GetHyperlink()

wxString EDA_TEXT::GetHyperlink ( ) const

inlineinherited

Definition at line 400 of file eda_text.h.

References m_hyperlink.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), CLIPBOARD_IO::SaveSelection(), and Serialize().

◆ GetInterline()

int EDA_TEXT::GetInterline ( const RENDER_SETTINGS * aSettings ) const

inherited

Return the distance between two lines of text.

Calculates the distance (pitch) between two lines of text. This distance includes the interline distance plus room for characters like j, {, and [. It also used for single line text, to calculate the text bounding box.

Definition at line 738 of file eda_text.cpp.

References GetDrawFont(), getFontMetrics(), GetInterline(), GetTextHeight(), and KiROUND().

Referenced by CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), GetInterline(), and GetLinePositions().

◆ GetIntersheetRefs()

void SCH_LABEL_BASE::GetIntersheetRefs	(	const SCH_SHEET_PATH *	aPath,
		std::vector< std::pair< wxString, wxString > > *	pages )

inherited

Build an array of { pageNumber, pageName } pairs.

Parameters

pages [out] Array of { pageNumber, pageName } pairs.

Definition at line 732 of file sch_label.cpp.

References SCHEMATIC::CurrentSheet(), end, SCHEMATIC::GetPageRefsMap(), GetShownText(), SCH_SHEET_PATH::GetVirtualPageNumber(), SCHEMATIC::GetVirtualPageToSheetNamesMap(), SCHEMATIC::GetVirtualPageToSheetPagesMap(), and SCH_ITEM::Schematic().

Referenced by SCH_FIELD::DoHypertextAction().

◆ GetItemDescription()

wxString SCH_GLOBALLABEL::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 2219 of file sch_label.cpp.

References _, KIUI::EllipsizeMenuText(), SCH_LABEL_BASE::GetShownText(), and EDA_TEXT::GetText().

◆ GetLabelBoxExpansion()

int SCH_LABEL_BASE::GetLabelBoxExpansion ( const RENDER_SETTINGS * aSettings = nullptr ) const

inherited

Definition at line 1102 of file sch_label.cpp.

References DEFAULT_LABEL_SIZE_RATIO, EDA_TEXT::GetTextSize(), KiROUND(), SCHEMATIC_SETTINGS::m_LabelSizeRatio, SCH_ITEM::Schematic(), and SCHEMATIC::Settings().

Referenced by SCH_GLOBALLABEL::CreateGraphicShape(), and SCH_GLOBALLABEL::GetSchematicTextOffset().

◆ GetLabelColor()

COLOR4D SCH_LABEL_BASE::GetLabelColor ( ) const

inherited

Definition at line 309 of file sch_label.cpp.

References SCH_ITEM::GetEffectiveNetClass(), NETCLASS::GetSchematicColor(), EDA_TEXT::GetTextColor(), SCH_ITEM::IsConnectivityDirty(), m_lastResolvedColor, and COLOR4D::UNSPECIFIED.

Referenced by KIGFX::SCH_PAINTER::getRenderColor(), and Plot().

◆ GetLabelShape()

LABEL_SHAPE SCH_LABEL_BASE::GetLabelShape ( ) const

inlineinherited

Definition at line 177 of file sch_label.h.

References m_shape.

Referenced by SCH_SELECTION_TOOL::Main(), and SCH_LABEL_DESC::SCH_LABEL_DESC().

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

◆ GetLinePositions()

void EDA_TEXT::GetLinePositions	(	const RENDER_SETTINGS *	aSettings,
		std::vector< VECTOR2I > &	aPositions,
		int	aLineCount ) const

inherited

Populate aPositions with the position of each line of a multiline text, according to the vertical justification and the rotation of the whole text.

Parameters

aPositions	is the list to populate by the VECTOR2I positions.
aLineCount	is the number of lines (not recalculated here for efficiency reasons.

Definition at line 912 of file eda_text.cpp.

References GetDrawPos(), GetDrawRotation(), GetInterline(), GetVertJustify(), GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_INDETERMINATE, GR_TEXT_V_ALIGN_TOP, RotatePoint(), and VECTOR2< T >::y.

Referenced by FEATURES_MANAGER::InitFeatureList(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotText(), and Print().

◆ GetLineSpacing()

double EDA_TEXT::GetLineSpacing ( ) const

inlineinherited

Definition at line 257 of file eda_text.h.

References m_attributes.

Referenced by Format(), FOOTPRINT::cmp_drawings::operator()(), Serialize(), and PCB_TEXTBOX::Serialize().

◆ GetMandatoryFieldCount()

int SCH_GLOBALLABEL::GetMandatoryFieldCount ( )

inlineoverridevirtual

Reimplemented from SCH_LABEL_BASE.

Definition at line 546 of file sch_label.h.

◆ GetMenuImage()

BITMAPS SCH_GLOBALLABEL::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 2226 of file sch_label.cpp.

References add_glabel.

◆ GetMsgPanelInfo()

void SCH_LABEL_BASE::GetMsgPanelInfo	(	EDA_DRAW_FRAME *	aFrame,
		std::vector< MSG_PANEL_ITEM > &	aList )

overridevirtualinherited

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 1396 of file sch_label.cpp.

References _, SCH_CONNECTION::AppendInfoToMsgPanel(), SPIN_STYLE::BOTTOM, SCH_ITEM::Connection(), SCH_ITEM::GetEffectiveNetClass(), getElectricalTypeLabel(), EDA_TEXT::GetFont(), GetShape(), GetSpinStyle(), EDA_TEXT::GetText(), EDA_TEXT::GetTextWidth(), EDA_TEXT::IsBold(), SCH_CONNECTION::IsBus(), SCH_ITEM::IsConnectivityDirty(), EDA_TEXT::IsItalic(), SPIN_STYLE::LEFT, UNITS_PROVIDER::MessageTextFromValue(), SPIN_STYLE::RIGHT, SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_SHEET_PIN_T, EDA_ITEM::Type(), UnescapeString(), and SPIN_STYLE::UP.

◆ GetNextFieldOrdinal()

int SCH_LABEL_BASE::GetNextFieldOrdinal ( ) const

inherited

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

Definition at line 233 of file sch_label.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().

◆ 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_TEXT::GetPenWidth ( ) const

overridevirtualinherited

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

Reimplemented from SCH_ITEM.

Definition at line 279 of file sch_text.cpp.

References EDA_TEXT::GetEffectiveTextPenWidth().

Referenced by SCH_LABEL_BASE::AutoplaceFields(), SCH_GLOBALLABEL::CreateGraphicShape(), and SCH_LABEL_BASE::GetSchematicTextOffset().

◆ GetPosition()

VECTOR2I SCH_TEXT::GetPosition ( ) const

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 141 of file sch_text.h.

References EDA_TEXT::GetTextPos().

Referenced by SCH_IO_EAGLE::adjustNetLabels(), SCH_DIRECTIVE_LABEL::AutoplaceFields(), SCH_EDIT_FRAME::AutoRotateItem(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), SCH_IO_ALTIUM::CreateAliases(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckNoConnects(), SCH_LABEL::GetBodyBoundingBox(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), GetNetNavigatorItemText(), LABEL_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), SCH_LABEL_BASE::HasConnectivityChanges(), SCH_SHEET_PIN::HasConnectivityChanges(), SCH_GLOBALLABEL::IsPointClickableAnchor(), SCH_HIERLABEL::IsPointClickableAnchor(), SCH_LABEL::IsPointClickableAnchor(), SCH_SHEET_PIN::IsPointClickableAnchor(), SCH_IO_EAGLE::SEG_DESC::LabelAttached(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_IO_EAGLE::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_DIRECTIVE_LABEL::MirrorHorizontally(), SCH_LABEL_BASE::MirrorHorizontally(), SCH_DIRECTIVE_LABEL::MirrorSpinStyle(), SCH_LABEL_BASE::MirrorSpinStyle(), SCH_DIRECTIVE_LABEL::MirrorVertically(), SCH_LABEL_BASE::MirrorVertically(), operator<(), SCH_LABEL_BASE::Rotate90(), SCH_IO_KICAD_LEGACY::saveText(), SCH_IO_KICAD_SEXPR::saveText(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveText(), SCH_LABEL::Serialize(), and ERC_TESTER::TestTextVars().

◆ GetRenderCache()

std::vector< std::unique_ptr< KIFONT::GLYPH > > * EDA_TEXT::GetRenderCache	(	const KIFONT::FONT *	aFont,
		const wxString &	forResolvedText,
		const VECTOR2I &	aOffset = { 0, 0 } ) const

inherited

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

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

◆ GetSchematicTextOffset()

VECTOR2I SCH_GLOBALLABEL::GetSchematicTextOffset ( const RENDER_SETTINGS * aSettings ) const

overridevirtual

This offset depends on the orientation, the type of text, and the area required to draw the associated graphic symbol or to put the text above a wire.

Returns: the offset between the SCH_TEXT position and the text itself position

Reimplemented from SCH_TEXT.

Definition at line 2041 of file sch_label.cpp.

References SPIN_STYLE::BOTTOM, SCH_LABEL_BASE::GetLabelBoxExpansion(), SCH_LABEL_BASE::GetSpinStyle(), EDA_TEXT::GetTextHeight(), L_BIDI, L_INPUT, L_OUTPUT, L_TRISTATE, L_UNSPECIFIED, SPIN_STYLE::LEFT, SCH_LABEL_BASE::m_shape, SPIN_STYLE::RIGHT, and SPIN_STYLE::UP.

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

◆ GetSchTextSize()

int SCH_TEXT::GetSchTextSize ( ) const

inlineinherited

Definition at line 77 of file sch_text.h.

References EDA_TEXT::GetTextWidth().

Referenced by SCH_TEXT_DESC::SCH_TEXT_DESC().

◆ GetShape()

LABEL_FLAG_SHAPE SCH_LABEL_BASE::GetShape ( ) const

inlineinherited

Definition at line 180 of file sch_label.h.

References m_shape.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewSheetPinFromLabel(), KIGFX::SCH_PAINTER::draw(), GetMsgPanelInfo(), DIALOG_SHEET_PIN_PROPERTIES::onComboBox(), Plot(), NETLIST_EXPORTER_SPICE_MODEL::readPorts(), CONNECTION_SUBGRAPH::ResolveDrivers(), ResolveTextVar(), SCH_IO_KICAD_LEGACY::saveText(), SCH_IO_KICAD_SEXPR::saveText(), and PANEL_SYNC_SHEET_PINS::UpdateForms().

◆ GetShownText() [1/2]

wxString SCH_LABEL_BASE::GetShownText	(	bool	aAllowExtraText,
		int	aDepth = 0 ) const

inlineoverridevirtualinherited

Return the string actually shown after processing of the base text.

Parameters

aAllowExtraText	is true to allow adding more text than the initial expanded text, for intance a title, a prefix for texts in display functions. False to disable any added text (for instance when writing the shown text in netlists).
aDepth	is used to prevent infinite recursions and loops when expanding text variables.

Reimplemented from EDA_TEXT.

Definition at line 278 of file sch_label.h.

References SCHEMATIC::CurrentSheet(), GetShownText(), EDA_TEXT::GetText(), and SCH_ITEM::Schematic().

◆ GetShownText() [2/2]

wxString SCH_LABEL_BASE::GetShownText	(	const SCH_SHEET_PATH *	aPath,
		bool	aAllowExtraText,
		int	aDepth = 0 ) const

overridevirtualinherited

Reimplemented from SCH_TEXT.

Definition at line 971 of file sch_label.cpp.

References EDA_TEXT::EvaluateText(), ExpandTextVars(), ADVANCED_CFG::GetCfg(), EDA_TEXT::GetShownText(), EDA_TEXT::HasTextVars(), ResolveTextVar(), and text.

Referenced by SCH_SELECTION_TOOL::autostartEvent(), CONNECTION_GRAPH::buildConnectionGraph(), CONNECTION_SUBGRAPH::driverName(), CONNECTION_GRAPH::ercCheckHierSheets(), CONNECTION_GRAPH::generateBusAliasMembers(), GetIntersheetRefs(), SCH_GLOBALLABEL::GetItemDescription(), SCH_HIERLABEL::GetItemDescription(), SCH_LABEL::GetItemDescription(), SCH_SHEET_PIN::GetItemDescription(), LABEL_SEARCH_HANDLER::getResultCell(), GetShownText(), HasConnectivityChanges(), SCH_SELECTION_TOOL::Main(), Plot(), NETLIST_EXPORTER_SPICE_MODEL::readPorts(), SCHEMATIC::RecomputeIntersheetRefs(), SCH_GLOBALLABEL::ResolveTextVar(), ERC_TESTER::TestSameLocalGlobalLabel(), and ERC_TESTER::TestSimilarLabels().

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

◆ GetSpinStyle()

SPIN_STYLE SCH_LABEL_BASE::GetSpinStyle ( ) const

inherited

Definition at line 431 of file sch_label.cpp.

References ANGLE_VERTICAL, SPIN_STYLE::BOTTOM, EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextAngle(), GR_TEXT_H_ALIGN_RIGHT, SPIN_STYLE::LEFT, SPIN_STYLE::RIGHT, and SPIN_STYLE::UP.

Referenced by SCH_DIRECTIVE_LABEL::AutoplaceFields(), AutoplaceFields(), SCH_EDIT_FRAME::AutoRotateItem(), SCH_EDIT_TOOL::ChangeTextType(), SCH_DIRECTIVE_LABEL::CreateGraphicShape(), SCH_GLOBALLABEL::CreateGraphicShape(), SCH_HIERLABEL::CreateGraphicShape(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_HIERLABEL::GetBodyBoundingBox(), GetMsgPanelInfo(), SCH_GLOBALLABEL::GetSchematicTextOffset(), SCH_HIERLABEL::GetSchematicTextOffset(), GetSchematicTextOffset(), SCH_DIRECTIVE_LABEL::MirrorHorizontally(), SCH_DIRECTIVE_LABEL::MirrorVertically(), SCH_IO_KICAD_LEGACY::saveText(), SCH_IO_KICAD_SEXPR::saveText(), and SCH_EDIT_TOOL::Swap().

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

◆ GetText()

virtual const wxString & EDA_TEXT::GetText ( ) const

inlinevirtualinherited

Return the string associated with the text object.

Returns: a const wxString reference containing the string of the item.

Definition at line 97 of file eda_text.h.

References m_text.

◆ GetTextAngle()

const EDA_ANGLE & EDA_TEXT::GetTextAngle ( ) const

inlineinherited

Definition at line 146 of file eda_text.h.

References m_attributes.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), SCH_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), KIGFX::SCH_PAINTER::draw(), SCH_TABLE::DrawBorders(), SCH_DRAWING_TOOLS::DrawShape(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), SCH_LABEL::GetBodyBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_TEXTBOX::GetDrawPos(), GetDrawRotation(), PCB_TEXT::GetDrawRotation(), SCH_FIELD::GetDrawRotation(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), PCB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_LABEL_BASE::GetSpinStyle(), FIELDS_GRID_TABLE::GetValue(), PCB_FIELDS_GRID_TABLE::GetValue(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), SCH_EDIT_TOOL::JustifyText(), PCB_TEXT::KeepUpright(), SCH_IO_EAGLE::loadFieldAttributes(), PCB_DIMENSION_BASE::Mirror(), PCB_TEXT::Mirror(), PCB_TEXTBOX::Mirror(), SCH_TEXT::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), SCH_TEXT::MirrorSpinStyle(), SCH_TEXT::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), PCB_TABLE::Normalize(), SCH_TABLE::Normalize(), SCH_TEXT::NormalizeJustification(), FOOTPRINT::cmp_drawings::operator()(), KI_TEST::kitest_cmp_drawings::operator()(), PCB_IO_EAGLE::orientFPText(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), positioningChanged(), positioningChanged(), processTextItem(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), PCB_TEXTBOX::Rotate(), SCH_EDIT_TOOL::Rotate(), SCH_FIELD::Rotate(), SCH_TEXTBOX::Rotate(), SCH_TEXT::Rotate90(), SCH_TEXTBOX::Rotate90(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_SEXPR::saveField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), SCH_IO_KICAD_SEXPR::saveText(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveText(), SCH_IO_KICAD_SEXPR::saveTextBox(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveTextBox(), PCB_TEXTBOX::SetTextAngle(), swapFieldPositionsWithMatching(), EASYEDA_PARSER_BASE::TransformTextToBaseline(), DIALOG_FIELD_PROPERTIES::UpdateField(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), and PCB_DIM_RADIAL::updateGeometry().

◆ GetTextAngleDegrees()

double EDA_TEXT::GetTextAngleDegrees ( ) const

inlineinherited

Definition at line 153 of file eda_text.h.

References m_attributes.

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_DIMENSION_BASE::GetTextAngleDegreesProp(), Serialize(), and PCB_TEXTBOX::Serialize().

◆ GetTextBox()

BOX2I EDA_TEXT::GetTextBox	(	const RENDER_SETTINGS *	aSettings,
		int	aLine = -1 ) const

inherited

Useful in multiline texts to calculate the full text or a line area (for zones filling, locate functions....)

Parameters

aLine The line of text to consider. Pass -1 for all lines.

Returns: the rect containing the line of text (i.e. the position and the size of one line) this rectangle is calculated for 0 orient text. If orientation is not 0 the rect must be rotated to match the physical area

Definition at line 744 of file eda_text.cpp.

References GetDrawFont(), GetDrawPos(), GetEffectiveTextPenWidth(), getFontMetrics(), BOX2< Vec >::GetHeight(), GetHorizJustify(), KIFONT::FONT::GetInterline(), GetShownText(), GetTextSize(), GetVertJustify(), BOX2< Vec >::GetWidth(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_INDETERMINATE, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_INDETERMINATE, GR_TEXT_V_ALIGN_TOP, IsBold(), IsItalic(), IsMirrored(), IsMultilineAllowed(), KIFONT::FONT::IsStroke(), ITALIC_TILT, KiROUND(), m_bbox_cache, BOX2< Vec >::Normalize(), BOX2< Vec >::Offset(), BOX2< Vec >::SetOrigin(), BOX2< Vec >::SetSize(), BOX2< Vec >::SetX(), BOX2< Vec >::SetY(), KIFONT::FONT::StringBoundaryLimits(), text, wxStringSplit(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_GLOBALLABEL::CreateGraphicShape(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_HIERLABEL::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), DS_DRAW_ITEM_TEXT::GetBoundingBox(), PCB_DIMENSION_BASE::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_TEXT::NormalizeJustification(), SCH_TEXT::Plot(), TextHitTest(), TextHitTest(), PCB_TEXT::TextHitTest(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), and PCB_DIM_RADIAL::updateGeometry().

◆ GetTextColor()

COLOR4D EDA_TEXT::GetTextColor ( ) const

inlineinherited

Definition at line 269 of file eda_text.h.

References m_attributes.

Referenced by DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), SCH_FIELD::GetFieldColor(), SCH_LABEL_BASE::GetLabelColor(), KIGFX::SCH_PAINTER::getRenderColor(), FIELDS_GRID_TABLE::GetValue(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), and DS_DRAW_ITEM_TEXT::PrintWsItem().

◆ GetTextHeight()

int EDA_TEXT::GetTextHeight ( ) const

inlineinherited

Definition at line 266 of file eda_text.h.

References m_attributes.

Referenced by SCH_LABEL_BASE::AutoplaceFields(), SCH_FIELD::compare(), SCH_TEXT::compare(), SCH_TEXTBOX::compare(), SCH_GLOBALLABEL::CreateGraphicShape(), SCH_HIERLABEL::CreateGraphicShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), SCH_HIERLABEL::GetBodyBoundingBox(), GetInterline(), PCB_TEXT::getKnockoutMargin(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), SCH_GLOBALLABEL::GetSchematicTextOffset(), FIELDS_GRID_TABLE::GetValue(), PCB_FIELDS_GRID_TABLE::GetValue(), hash_fp_item(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_IO_KICAD_SEXPR::saveField(), SCH_IO_LTSPICE_PARSER::setTextJustification(), PCB_DIM_ALIGNED::updateText(), PCB_DIM_ORTHOGONAL::updateText(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

◆ GetTextOffset()

int SCH_TEXT::GetTextOffset ( const RENDER_SETTINGS * aSettings = nullptr ) const

inherited

Definition at line 264 of file sch_text.cpp.

References DEFAULT_TEXT_OFFSET_RATIO, EDA_TEXT::GetTextSize(), KiROUND(), SCHEMATIC_SETTINGS::m_TextOffsetRatio, SCH_ITEM::Schematic(), and SCHEMATIC::Settings().

Referenced by SCH_DIRECTIVE_LABEL::AutoplaceFields(), SCH_LABEL_BASE::AutoplaceFields(), SCH_HIERLABEL::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), SCH_HIERLABEL::GetSchematicTextOffset(), and SCH_LABEL_BASE::GetSchematicTextOffset().

◆ GetTextPos()

const VECTOR2I & EDA_TEXT::GetTextPos ( ) const

inlineinherited

Definition at line 272 of file eda_text.h.

References m_pos.

Referenced by PCB_IO_IPC2581::addText(), SCH_LABEL_BASE::AutoplaceFields(), SCH_FIELD::compare(), SCH_TEXT::compare(), PCB_GRID_HELPER::computeAnchors(), SCH_SHEET_PIN::ConstrainOnEdge(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_GLOBALLABEL::doIsConnected(), SCH_HIERLABEL::doIsConnected(), SCH_LABEL::doIsConnected(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), PCB_TEXT::Flip(), PCB_IO_KICAD_SEXPR::format(), DS_DRAW_ITEM_TEXT::GetApproxBBox(), SCH_HIERLABEL::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), SCH_LABEL_BASE::GetBodyBoundingBox(), PCB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LABEL_BASE::GetConnectionPoints(), GetDrawPos(), SCH_LABEL_BASE::GetEndPoints(), SCH_SHEET_PIN::GetEndPoints(), SCH_FIELD::GetLibPosition(), DS_DRAW_ITEM_TEXT::GetPosition(), PCB_TEXT::GetPosition(), SCH_FIELD::GetPosition(), SCH_TEXT::GetPosition(), FIELDS_GRID_TABLE::GetValue(), FEATURES_MANAGER::InitFeatureList(), PCB_DIMENSION_BASE::Mirror(), PCB_TEXT::Mirror(), SCH_DIRECTIVE_LABEL::MirrorHorizontally(), SCH_FIELD::MirrorHorizontally(), SCH_SHEET_PIN::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), SCH_DIRECTIVE_LABEL::MirrorVertically(), SCH_FIELD::MirrorVertically(), SCH_SHEET_PIN::MirrorVertically(), SCH_TEXT::MirrorVertically(), SCH_TEXT::NormalizeJustification(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), std::hash< EDA_TEXT >::operator()(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), BRDITEMS_PLOTTER::PlotText(), DIALOG_CHANGE_SYMBOLS::processSymbols(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), Serialize(), SCH_LABEL_BASE::SetPosition(), FIELDS_GRID_TABLE::SetValue(), EASYEDA_PARSER_BASE::TransformTextToBaseline(), PCB_TEXT::TransformTextToPolySet(), SCH_LABEL_BASE::UpdateDanglingState(), PCB_DIM_LEADER::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), and PCB_DIM_RADIAL::updateText().

◆ GetTextSize()

VECTOR2I EDA_TEXT::GetTextSize ( ) const

inlineinherited

Definition at line 260 of file eda_text.h.

References m_attributes.

Referenced by SCH_SHEET::AutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), KIGFX::SCH_PAINTER::draw(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), GetEffectiveTextPenWidth(), SCH_LABEL_BASE::GetLabelBoxExpansion(), PCB_TEXTBOX::GetLegacyTextMargin(), SCH_TEXTBOX::GetLegacyTextMargin(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), PCB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), GetTextBox(), SCH_TEXT::GetTextOffset(), SCH_IO_EAGLE::loadFieldAttributes(), FOOTPRINT::cmp_drawings::operator()(), PCB_IO_EAGLE::orientFPText(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), printOneLineOfText(), processTextItem(), SCH_IO_KICAD_LEGACY::saveSheet(), Serialize(), PCB_TEXTBOX::Serialize(), PCB_TEXT::TextHitTest(), EASYEDA_PARSER_BASE::TransformTextToBaseline(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

◆ GetTextStyleName()

wxString EDA_TEXT::GetTextStyleName ( ) const

inherited

Returns: a wxString with the style name( Normal, Italic, Bold, Bold+Italic).

Definition at line 975 of file eda_text.cpp.

References _, IsBold(), and IsItalic().

Referenced by SCH_FIELD::GetMsgPanelInfo().

◆ GetTextThickness()

int EDA_TEXT::GetTextThickness ( ) const

inlineinherited

◆ GetTextThicknessProperty()

int EDA_TEXT::GetTextThicknessProperty ( ) const

inlineinherited

Definition at line 129 of file eda_text.h.

References GetAutoThickness(), GetEffectiveTextPenWidth(), and GetTextThickness().

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

◆ GetTextWidth()

int EDA_TEXT::GetTextWidth ( ) const

inlineinherited

Definition at line 263 of file eda_text.h.

References m_attributes.

Referenced by SCH_FIELD::compare(), SCH_TEXT::compare(), SCH_TEXTBOX::compare(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), GetEffectiveTextPenWidth(), PCB_TEXT::getKnockoutMargin(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TABLECELL::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), SCH_HIERLABEL::GetSchematicTextOffset(), SCH_FIELD::GetSchTextSize(), SCH_TEXT::GetSchTextSize(), SCH_TEXTBOX::GetSchTextSize(), PCB_FIELDS_GRID_TABLE::GetValue(), hash_fp_item(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY::saveText(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), DIALOG_FIELD_PROPERTIES::updateText(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

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

◆ GetVertJustify()

GR_TEXT_V_ALIGN_T EDA_TEXT::GetVertJustify ( ) const

inlineinherited

Definition at line 202 of file eda_text.h.

References m_attributes.

Referenced by SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), PCB_TEXTBOX::GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), SCH_FIELD::GetEffectiveVertJustify(), GetLinePositions(), SCH_FIELD::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), GetTextBox(), hash_fp_item(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), IsDefaultFormatting(), SCH_FIELD::IsVertJustifyFlipped(), PCB_TEXT::KeepUpright(), SCH_IO_EAGLE::loadFieldAttributes(), PCB_IO_EAGLE::loadPlain(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_TEXT::MirrorHorizontally(), SCH_TEXT::MirrorVertically(), SCH_TEXT::NormalizeJustification(), PCB_IO_EAGLE::orientFPText(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_FIELD::Plot(), positioningChanged(), positioningChanged(), printOneLineOfText(), processTextItem(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), Serialize(), PCB_TEXTBOX::Serialize(), and swapFieldPositionsWithMatching().

◆ GotoPageHref()

wxString EDA_TEXT::GotoPageHref ( const wxString & aDestination )

staticinherited

Generate a href to a page in the current schematic.

Parameters

aDestination Destination sheet's page number.

Returns: A hyperlink href string that goes to the specified page.

Definition at line 1298 of file eda_text.cpp.

Referenced by SCH_LABEL_BASE::Plot(), and SCH_SHEET::Plot().

◆ HasCachedDriverName()

bool SCH_LABEL_BASE::HasCachedDriverName ( ) const

overridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 950 of file sch_label.cpp.

References EDA_TEXT::HasTextVars().

◆ HasConnectivityChanges()

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

overridevirtualinherited

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.

Reimplemented in SCH_SHEET_PIN.

Definition at line 1359 of file sch_label.cpp.

References SCH_FIELD::GetCanonicalName(), SCH_TEXT::GetPosition(), GetShownText(), EDA_TEXT::GetText(), SCH_ITEM::IsConnectable(), m_fields, SCH_ITEM::SCH_ITEM(), and SCH_LABEL_BASE().

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

◆ HasHyperlink()

virtual bool EDA_TEXT::HasHyperlink ( ) const

inlinevirtualinherited

Definition at line 399 of file eda_text.h.

References m_hyperlink.

Referenced by SCH_TEXTBOX::DoHypertextAction(), Format(), SCH_TEXT::IsHypertext(), SCH_TEXTBOX::IsHypertext(), SCH_TEXT::Plot(), and SCH_TEXTBOX::Plot().

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

◆ HasTextVars()

bool EDA_TEXT::HasTextVars ( ) const

inlineinherited

Indicates the ShownText has text var references which need to be processed.

Definition at line 116 of file eda_text.h.

References m_shown_text_has_text_var_refs.

Referenced by BACK_ANNOTATE::applyChangelist(), SCH_LABEL_BASE::cacheShownText(), KIGFX::SCH_PAINTER::draw(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_LABEL_BASE::HasCachedDriverName(), and SCH_LABEL_BASE::SCH_LABEL_BASE().

◆ HitTest() [1/3]

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

overridevirtualinherited

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 1187 of file sch_label.cpp.

References BOX2< Vec >::Contains(), GetBodyBoundingBox(), GetBoundingBox(), GetSchematicTextOffset(), BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), m_fields, BOX2< Vec >::Offset(), SCH_GLOBAL_LABEL_T, SCH_LABEL_T, and EDA_ITEM::Type().

◆ HitTest() [2/3]

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

overridevirtualinherited

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 1221 of file sch_label.cpp.

References KIGEOM::BoxHitTest(), GetBodyBoundingBox(), GetBoundingBox(), GetSchematicTextOffset(), m_fields, BOX2< Vec >::Offset(), SCH_GLOBAL_LABEL_T, SCH_LABEL_T, and EDA_ITEM::Type().

◆ HitTest() [3/3]

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

overridevirtualinherited

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.

Reimplemented in SCH_SHEET_PIN.

Definition at line 1160 of file sch_label.cpp.

References BOX2< Vec >::Contains(), GetBodyBoundingBox(), GetSchematicTextOffset(), BOX2< Vec >::Inflate(), m_fields, BOX2< Vec >::Offset(), SCH_GLOBAL_LABEL_T, SCH_LABEL_T, and EDA_ITEM::Type().

◆ IncrementLabel()

bool SCH_LABEL_BASE::IncrementLabel ( int aIncrement )

inherited

Increment the label text if it ends with a number.

Parameters

aIncrement = the increment value to add to the number ending the text.

Definition at line 583 of file sch_label.cpp.

References EDA_TEXT::GetText(), IncrementString(), EDA_TEXT::SetText(), and text.

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

◆ IsBold()

bool EDA_TEXT::IsBold ( ) const

inlineinherited

Definition at line 183 of file eda_text.h.

References m_attributes.

Referenced by BOARD_ADAPTER::addText(), SCH_EDIT_TOOL::ChangeTextType(), SCH_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), KIGFX::DS_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), GetDrawFont(), SCH_FIELD::GetDrawFont(), SCH_TEXT::GetDrawFont(), SCH_TEXTBOX::GetDrawFont(), GetEffectiveTextPenWidth(), KIGFX::SCH_PAINTER::getFont(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TABLECELL::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), PCB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), GetTextBox(), GetTextStyleName(), FIELDS_GRID_TABLE::GetValue(), FIELDS_GRID_TABLE::GetValueAsBool(), hash_fp_item(), IsDefaultFormatting(), SCH_IO_EAGLE::loadFieldAttributes(), FOOTPRINT::cmp_drawings::operator()(), printOneLineOfText(), ResolveFont(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), Serialize(), PCB_TEXTBOX::Serialize(), SetFontProp(), SetItalic(), and FIELDS_GRID_TABLE::SetValue().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 129 of file eda_item.h.

References BRIGHTENED, and m_flags.

◆ IsConnectable()

bool SCH_GLOBALLABEL::IsConnectable ( ) const

inlineoverridevirtual

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

Reimplemented from SCH_ITEM.

Definition at line 565 of file sch_label.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()

bool SCH_LABEL_BASE::IsDangling ( ) const

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 337 of file sch_label.h.

References m_isDangling.

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

◆ IsDefaultFormatting()

bool EDA_TEXT::IsDefaultFormatting ( ) const

inherited

Definition at line 1036 of file eda_text.cpp.

References GetAutoThickness(), GetFontName(), GetHorizJustify(), GetVertJustify(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, IsBold(), IsItalic(), IsMirrored(), and IsMultilineAllowed().

Referenced by SCH_IO_KICAD_SEXPR::saveField().

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

◆ IsGotoPageHref()

bool EDA_TEXT::IsGotoPageHref	(	const wxString &	aHref,
		wxString *	aDestination = nullptr )

staticinherited

Check if aHref is a valid internal hyperlink.

Parameters

aHref	String to validate
aDestination	[optional] pointer to populate with the destination page

Returns: true if aHref is a valid internal hyperlink. Does not check if the destination page actually exists.

Definition at line 1292 of file eda_text.cpp.

Referenced by PDF_PLOTTER::endPlotEmitResources(), SCH_NAVIGATE_TOOL::HypertextCommand(), and ValidateHyperlink().

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

bool SCH_TEXT::IsHypertext ( ) const

inlineoverridevirtualinherited

Allow items to support hypertext actions when hovered/clicked.

Reimplemented from SCH_ITEM.

Definition at line 80 of file sch_text.h.

References EDA_TEXT::HasHyperlink().

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

◆ IsItalic()

bool EDA_TEXT::IsItalic ( ) const

inlineinherited

Definition at line 168 of file eda_text.h.

References m_attributes.

Referenced by BOARD_ADAPTER::addText(), SCH_DIRECTIVE_LABEL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), SCH_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), KIGFX::DS_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), GetDrawFont(), SCH_FIELD::GetDrawFont(), SCH_TEXT::GetDrawFont(), SCH_TEXTBOX::GetDrawFont(), KIGFX::SCH_PAINTER::getFont(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TABLECELL::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), PCB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), GetTextBox(), GetTextStyleName(), FIELDS_GRID_TABLE::GetValue(), FIELDS_GRID_TABLE::GetValueAsBool(), PCB_FIELDS_GRID_TABLE::GetValueAsBool(), hash_fp_item(), IsDefaultFormatting(), FOOTPRINT::cmp_drawings::operator()(), printOneLineOfText(), ResolveFont(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY::saveText(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), Serialize(), PCB_TEXTBOX::Serialize(), SetBold(), SetFontProp(), and FIELDS_GRID_TABLE::SetValue().

◆ IsKeepUpright()

bool EDA_TEXT::IsKeepUpright ( ) const

inlineinherited

Definition at line 205 of file eda_text.h.

References m_attributes.

Referenced by PCB_IO_KICAD_SEXPR::format(), PCB_TEXT::GetDrawRotation(), PCB_FIELDS_GRID_TABLE::GetValueAsBool(), PCB_TEXT::KeepUpright(), PCB_TEXT_DESC::PCB_TEXT_DESC(), Serialize(), and PCB_TEXTBOX::Serialize().

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

◆ IsMirrored()

bool EDA_TEXT::IsMirrored ( ) const

inlineinherited

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

virtual bool SCH_ITEM::IsMovableFromAnchorPoint ( ) const

inlinevirtualinherited

Check if object is movable from the anchor point.

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

Return values

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

Reimplemented in SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_SHEET, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 277 of file sch_item.h.

Referenced by SCH_MOVE_TOOL::doMoveSelection().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

◆ IsMultilineAllowed()

bool EDA_TEXT::IsMultilineAllowed ( ) const

inlineinherited

Definition at line 196 of file eda_text.h.

References m_attributes.

Referenced by GetTextBox(), FEATURES_MANAGER::InitFeatureList(), IsDefaultFormatting(), BRDITEMS_PLOTTER::PlotText(), Print(), Serialize(), and PCB_TEXTBOX::Serialize().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

◆ IsPointClickableAnchor()

bool SCH_GLOBALLABEL::IsPointClickableAnchor ( const VECTOR2I & aPos ) const

inlineoverridevirtual

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

Reimplemented from SCH_ITEM.

Definition at line 573 of file sch_label.h.

References SCH_TEXT::GetPosition(), and SCH_LABEL_BASE::m_isDangling.

◆ 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_TEXT::IsReplaceable ( ) const

inlineoverridevirtualinherited

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 133 of file sch_text.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().

◆ 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_LABEL_BASE::IsType ( const std::vector< KICAD_T > & aScanTypes ) const

overridevirtualinherited

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

Definition at line 239 of file sch_label.cpp.

References SCH_ITEM::IsType(), SCH_ITEM::m_connected_items, SCH_ITEM::SCH_ITEM(), SCH_ITEM_LOCATE_BUS_T, SCH_ITEM_LOCATE_WIRE_T, SCH_LABEL_LOCATE_ANY_T, SCH_LABEL_LOCATE_BUS_T, SCH_LABEL_LOCATE_WIRE_T, SCH_PIN_T, and SCH_ITEM::Schematic().

Referenced by Visit().

◆ IsVisible()

virtual bool EDA_TEXT::IsVisible ( ) const

inlinevirtualinherited

Definition at line 186 of file eda_text.h.

References m_visible.

Referenced by SCH_EDITOR_CONTROL::AssignFootprints(), EDIT_TOOL::DeleteItems(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawVia(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_EDIT_TOOL::EditField(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_IPC2581::generateLayerSetNet(), LIB_SYMBOL::GetFields(), SCH_FIELD::GetMsgPanelInfo(), FIELDS_GRID_TABLE::GetValue(), FIELDS_GRID_TABLE::GetValueAsBool(), PCB_FIELDS_GRID_TABLE::GetValueAsBool(), SCH_FIELD::ImportValues(), FEATURES_MANAGER::InitFeatureList(), DRC_RTREE::Insert(), GENERAL_COLLECTOR::Inspect(), PCB_FIELD::Matches(), SCH_FIELD::Matches(), SIM_MODEL::MigrateSimModel(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), PCB_FIELD::PCB_FIELD(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), LIB_SYMBOL::PlotFields(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), DIALOG_CHANGE_SYMBOLS::processSymbols(), processTextItem(), SCH_EDIT_TOOL::Properties(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_SEXPR::saveField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), PCB_SELECTION_TOOL::Selectable(), SCH_SELECTION_TOOL::Selectable(), PCB_FIELD::Serialize(), PNS_KICAD_IFACE_BASE::syncTextItem(), SCH_SHEET_PATH::UpdateAllScreenReferences(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

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

◆ Levenshtein()

double EDA_TEXT::Levenshtein ( const EDA_TEXT & aOther ) const

inherited

Return the levenstein distance between two texts.

Return a value of 0.0 - 1.0 where 1.0 is a perfect match.

Definition at line 1230 of file eda_text.cpp.

References distance(), EDA_TEXT(), and GetText().

Referenced by Similarity().

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

◆ MapHorizJustify()

GR_TEXT_H_ALIGN_T EDA_TEXT::MapHorizJustify ( int aHorizJustify )

staticinherited

Definition at line 68 of file eda_text.cpp.

References GR_TEXT_H_ALIGN_LEFT, and GR_TEXT_H_ALIGN_RIGHT.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), FIELDS_GRID_TABLE::SetValue(), DIALOG_FIELD_PROPERTIES::UpdateField(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ MapVertJustify()

GR_TEXT_V_ALIGN_T EDA_TEXT::MapVertJustify ( int aVertJustify )

staticinherited

Definition at line 82 of file eda_text.cpp.

References GR_TEXT_V_ALIGN_BOTTOM, and GR_TEXT_V_ALIGN_TOP.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), FIELDS_GRID_TABLE::SetValue(), DIALOG_FIELD_PROPERTIES::UpdateField(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ 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_LABEL_BASE::Matches	(	const EDA_SEARCH_DATA &	aSearchData,
		void *	aAuxData ) const

overridevirtualinherited

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.

Reimplemented in SCH_SHEET_PIN.

Definition at line 1002 of file sch_label.cpp.

References SCH_CONNECTION::AllMembers(), SCH_ITEM::Connection(), SCH_CONNECTION::GetNetName(), EDA_TEXT::GetText(), SCH_CONNECTION::IsBus(), EDA_ITEM::Matches(), SCH_SEARCH_DATA::searchNetNames, and UnescapeString().

Referenced by LABEL_SEARCH_HANDLER::Search().

◆ MirrorHorizontally()

void SCH_LABEL_BASE::MirrorHorizontally ( int aCenter )

overridevirtualinherited

Mirror item horizontally about aCenter.

Reimplemented from SCH_ITEM.

Reimplemented in SCH_SHEET_PIN.

Definition at line 545 of file sch_label.cpp.

References ANGLE_HORIZONTAL, delta, SCH_TEXT::GetPosition(), m_fields, SCH_TEXT::MirrorHorizontally(), and VECTOR2< T >::x.

Referenced by SCH_EDIT_TOOL::ChangeTextType().

◆ MirrorSpinStyle()

void SCH_LABEL_BASE::MirrorSpinStyle ( bool aLeftRight )

overridevirtualinherited

Reimplemented from SCH_TEXT.

Definition at line 517 of file sch_label.cpp.

References delta, SCH_TEXT::GetPosition(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, m_fields, SCH_TEXT::MirrorSpinStyle(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ MirrorVertically()

void SCH_LABEL_BASE::MirrorVertically ( int aCenter )

overridevirtualinherited

Mirror item vertically about aCenter.

Reimplemented from SCH_ITEM.

Reimplemented in SCH_SHEET_PIN.

Definition at line 564 of file sch_label.cpp.

References ANGLE_VERTICAL, delta, SCH_TEXT::GetPosition(), m_fields, SCH_TEXT::MirrorVertically(), and VECTOR2< T >::y.

Referenced by SCH_EDIT_TOOL::ChangeTextType().

◆ Move()

void SCH_LABEL_BASE::Move ( const VECTOR2I & aMoveVector )

overridevirtualinherited

Move the item by aMoveVector to a new position.

Reimplemented from SCH_ITEM.

Reimplemented in SCH_SHEET_PIN.

Definition at line 477 of file sch_label.cpp.

References m_fields, and SCH_TEXT::Move().

Referenced by SCH_IO_LTSPICE_PARSER::CreatePin(), SCH_MOVE_TOOL::moveItem(), and SetPosition().

◆ NormalizeJustification()

void SCH_TEXT::NormalizeJustification ( bool inverse )

inherited

Definition at line 80 of file sch_text.cpp.

References delta, BOX2< Vec >::GetHeight(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetVertJustify(), BOX2< Vec >::GetWidth(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, and EDA_TEXT::SetTextPos().

Referenced by MirrorHorizontally(), and MirrorVertically().

◆ Offset()

void EDA_TEXT::Offset ( const VECTOR2I & aOffset )

inherited

◆ operator<() [1/3]

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/3]

bool EDA_TEXT::operator< ( const EDA_TEXT & aRhs ) const

inlineinherited

Definition at line 396 of file eda_text.h.

References Compare(), and EDA_TEXT().

◆ operator<() [3/3]

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

overridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 241 of file sch_text.cpp.

References GetExcludedFromSim(), SCH_ITEM::GetLayer(), GetPosition(), EDA_TEXT::GetText(), SCH_ITEM::SCH_ITEM(), SCH_TEXT(), EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ operator==() [1/2]

bool EDA_TEXT::operator== ( const EDA_TEXT & aRhs ) const

inlineinherited

Definition at line 395 of file eda_text.h.

References Compare(), and EDA_TEXT().

Referenced by PCB_DIMENSION_BASE::operator==(), PCB_FIELD::operator==(), PCB_TEXT::operator==(), PCB_TEXTBOX::operator==(), SCH_FIELD::operator==(), SCH_TEXT::operator==(), and SCH_TEXTBOX::operator==().

◆ operator==() [2/2]

bool SCH_LABEL_BASE::operator== ( const SCH_ITEM & aItem ) const

overridevirtualinherited

Reimplemented from SCH_ITEM.

Reimplemented in SCH_SHEET_PIN.

Definition at line 597 of file sch_label.cpp.

References m_connectionType, m_fields, m_shape, SCH_TEXT::operator==(), SCH_ITEM::SCH_ITEM(), and SCH_LABEL_BASE().

◆ operator>()

bool EDA_TEXT::operator> ( const EDA_TEXT & aRhs ) const

inlineinherited

Definition at line 397 of file eda_text.h.

References Compare(), and EDA_TEXT().

◆ Plot()

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

overridevirtualinherited

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 1454 of file sch_label.cpp.

References _, PLOTTER::Bookmark(), color, SCH_ITEM::Connection(), CreateGraphicShape(), SCHEMATIC::CurrentSheet(), F_DOT, F_ROUND, PLOTTER::FilledCircle(), EDA_TEXT::GetAttributes(), GetBodyBoundingBox(), PLOTTER::GetColorMode(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), SCH_TEXT::GetDrawFont(), SCH_ITEM::GetEffectiveNetClass(), EDA_TEXT::GetEffectiveTextPenWidth(), GetFields(), SCH_ITEM::GetFontMetrics(), GetLabelColor(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), GetSchematicTextOffset(), GetShape(), GetShownText(), EDA_TEXT::GetTextColor(), EDA_TEXT::GetTextPos(), EDA_TEXT::GotoPageHref(), PLOTTER::HyperlinkBox(), PLOTTER::HyperlinkMenu(), SCH_CONNECTION::IsBus(), LAYER_BUS, PLOTTER::LineTo(), m_fields, SCH_ITEM::m_layer, TEXT_ATTRIBUTES::m_Multiline, EDA_ITEM::m_parent, SCH_PLOT_OPTS::m_PDFHierarchicalLinks, SCH_PLOT_OPTS::m_PDFPropertyPopups, TEXT_ATTRIBUTES::m_StrokeWidth, PLOTTER::MoveTo(), SCH_CONNECTION::Name(), NO_FILL, path, PLOTTER::PenFinish(), PLOTTER::PlotPoly(), PLOTTER::PlotText(), PLOTTER::RenderSettings(), SCH_HIER_LABEL_T, SCH_SHEET_PIN_T, SCH_ITEM::Schematic(), PLOTTER::SetColor(), PLOTTER::SetCurrentLineWidth(), SCH_SHEET_PATH::size(), PLOTTER::ThickCircle(), EDA_ITEM::Type(), and COLOR4D::UNSPECIFIED.

◆ Print()

void EDA_TEXT::Print	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		const COLOR4D &	aColor )

inherited

Print this text object to the device context aDC.

Parameters

aDC	the current Device Context.
aOffset	draw offset (usually (0,0)).
aColor	text color.

Definition at line 890 of file eda_text.cpp.

References GetDrawPos(), GetLinePositions(), GetShownText(), IsMultilineAllowed(), printOneLineOfText(), and wxStringSplit().

Referenced by DS_DRAW_ITEM_TEXT::PrintWsItem().

◆ printOneLineOfText()

void EDA_TEXT::printOneLineOfText	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		const COLOR4D &	aColor,
		const wxString &	aText,
		const VECTOR2I &	aPos )

protectedinherited

Print each line of this EDA_TEXT.

Parameters

aOffset	draw offset (usually (0,0)).
aColor	text color.
aText	the single line of text to draw.
aPos	the position of this line ).

Definition at line 957 of file eda_text.cpp.

References KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), GetDrawFont(), GetDrawRotation(), GetEffectiveTextPenWidth(), getFontMetrics(), GetHorizJustify(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GetTextSize(), GetVertJustify(), GRPrintText(), IsBold(), IsItalic(), IsMirrored(), and VECTOR2< T >::x.

Referenced by Print().

◆ RemoveHyperlink()

void EDA_TEXT::RemoveHyperlink ( )

inlineinherited

Definition at line 402 of file eda_text.h.

References m_hyperlink.

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

◆ Replace() [1/3]

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

◆ Replace() [2/3]

bool EDA_TEXT::Replace ( const EDA_SEARCH_DATA & aSearchData )

inherited

Helper function used in search and replace dialog.

Perform a text replace using the find and replace criteria in aSearchData.

Parameters

aSearchData A reference to a EDA_SEARCH_DATA object containing the search and replace criteria.

Returns: True if the text item was modified, otherwise false.

Definition at line 487 of file eda_text.cpp.

References cacheShownText(), ClearBoundingBoxCache(), ClearRenderCache(), m_text, and EDA_ITEM::Replace().

Referenced by SCH_FIELD::Replace(), SCH_LABEL_BASE::Replace(), SCH_SHEET_PIN::Replace(), SCH_TEXT::Replace(), and SCH_TEXTBOX::Replace().

◆ Replace() [3/3]

bool SCH_LABEL_BASE::Replace	(	const EDA_SEARCH_DATA &	aSearchData,
		void *	aAuxData )

overridevirtualinherited

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

Reimplemented in SCH_SHEET_PIN.

Definition at line 1044 of file sch_label.cpp.

References CTX_NETNAME, EscapeString(), EDA_SEARCH_DATA::findString, EDA_TEXT::Replace(), and EDA_SEARCH_DATA::replaceString.

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

◆ ResolveFont()

bool EDA_TEXT::ResolveFont ( const std::vector< wxString > * aEmbeddedFonts )

inherited

Definition at line 508 of file eda_text.cpp.

References KIFONT::FONT::GetFont(), IsBold(), IsItalic(), m_attributes, m_render_cache, m_render_cache_font, and m_unresolvedFontName.

◆ ResolveTextVar()

bool SCH_GLOBALLABEL::ResolveTextVar	(	const SCH_SHEET_PATH *	aPath,
		wxString *	token,
		int	aDepth ) const

overridevirtual

Resolve any references to system tokens supported by the label.

Parameters

aDepth a counter to limit recursion and circular references.

Reimplemented from SCH_LABEL_BASE.

Definition at line 2080 of file sch_label.cpp.

References SCHEMATIC::CurrentSheet(), SCHEMATIC::GetPageRefsMap(), SCH_LABEL_BASE::GetShownText(), SCH_SHEET_PATH::GetVirtualPageNumber(), SCHEMATIC::GetVirtualPageToSheetPagesMap(), SCHEMATIC_SETTINGS::m_IntersheetRefsFormatShort, SCHEMATIC_SETTINGS::m_IntersheetRefsListOwnPage, SCHEMATIC_SETTINGS::m_IntersheetRefsPrefix, SCHEMATIC_SETTINGS::m_IntersheetRefsSuffix, SCH_LABEL_BASE::ResolveTextVar(), SCH_ITEM::Schematic(), and SCHEMATIC::Settings().

◆ Rotate()

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

overridevirtualinherited

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

Reimplemented from SCH_ITEM.

Reimplemented in SCH_SHEET_PIN.

Definition at line 486 of file sch_label.cpp.

References ANGLE_270, ANGLE_90, EDA_TEXT::GetTextPos(), m_fields, Rotate90(), RotatePoint(), and EDA_TEXT::SetTextPos().

◆ Rotate90()

void SCH_LABEL_BASE::Rotate90 ( bool aClockwise )

overridevirtualinherited

Reimplemented from SCH_TEXT.

Definition at line 501 of file sch_label.cpp.

References AUTOPLACE_AUTO, AUTOPLACE_MANUAL, AutoplaceFields(), SCH_TEXT::GetPosition(), m_fields, SCH_ITEM::m_fieldsAutoplaced, and SCH_TEXT::Rotate90().

Referenced by Rotate().

◆ RunOnChildren()

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

overridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 995 of file sch_label.cpp.

References m_fields, and SCH_ITEM::SCH_ITEM().

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

◆ Serialize()

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

overridevirtual

Serializes this object to the given Any message.

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

Parameters

aContainer will be filled with a message describing this object

Reimplemented from SERIALIZABLE.

Definition at line 2012 of file sch_label.cpp.

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

◆ SetAttributes() [1/2]

void EDA_TEXT::SetAttributes	(	const EDA_TEXT &	aSrc,
		bool	aSetPosition = true )

inherited

Set the text attributes from another instance.

Definition at line 434 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), EDA_TEXT(), m_attributes, and m_pos.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), MULTICHANNEL_TOOL::copyRuleAreaContents(), Deserialize(), PCB_TEXTBOX::Deserialize(), SCH_FIELD::ImportValues(), SIM_MODEL::MigrateSimModel(), DIALOG_LABEL_PROPERTIES::OnAddField(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), PCB_FIELD::PCB_FIELD(), DIALOG_CHANGE_SYMBOLS::processSymbols(), processTextItem(), and CLIPBOARD_IO::SaveSelection().

◆ SetAttributes() [2/2]

void EDA_TEXT::SetAttributes ( const TEXT_ATTRIBUTES & aTextAttrs )

inlineinherited

Definition at line 229 of file eda_text.h.

References m_attributes.

◆ SetAutoRotateOnPlacement()

void SCH_LABEL_BASE::SetAutoRotateOnPlacement ( bool autoRotate = true )

inherited

Parameters

autoRotate If set to true when the label is placed in the connection to a pin/net the direction will be automatically set according to the positioning of the net/pin.

Definition at line 1591 of file sch_label.cpp.

References m_autoRotateOnPlacement.

Referenced by SCH_DRAWING_TOOLS::createNewLabel(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetAutoThickness()

void EDA_TEXT::SetAutoThickness ( bool aAuto )

inherited

Definition at line 293 of file eda_text.cpp.

References GetAutoThickness(), GetEffectiveTextPenWidth(), and SetTextThickness().

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

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

◆ SetBold()

void EDA_TEXT::SetBold ( bool aBold )

inherited

Set the text to be bold - this will also update the font if needed.

This is the properties system interface.

Definition at line 336 of file eda_text.cpp.

References GetFont(), KIFONT::FONT::GetFont(), KIFONT::FONT::GetName(), GetPenSizeForBold(), GetPenSizeForNormal(), IsItalic(), KIFONT::FONT::IsStroke(), m_attributes, SetBoldFlag(), and SetFont().

Referenced by SCH_IO_ALTIUM::AddTextBox(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists(), SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_IO_EAGLE::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_IO_EAGLE::loadTextAttributes(), SCH_IO_ALTIUM::ParseLabel(), FIELDS_GRID_TABLE::SetValue(), FIELDS_GRID_TABLE::SetValueAsBool(), SCH_DRAWING_TOOLS::TwoClickPlace(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetBoldFlag()

void EDA_TEXT::SetBoldFlag ( bool aBold )

inherited

Set only the bold flag, without changing the font.

Used when bulk-changing text attributes (e.g. from a dialog or import).

Definition at line 379 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), SCH_IO_KICAD_LEGACY::loadSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), and SetBold().

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

virtual void SCH_ITEM::SetDNP ( bool aDNP )

inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, and SYMBOL.

Definition at line 264 of file sch_item.h.

◆ SetExcludedFromBoard()

virtual void SCH_ITEM::SetExcludedFromBoard ( bool aExcludeFromBoard )

inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, and SYMBOL.

Definition at line 260 of file sch_item.h.

◆ SetExcludedFromBOM()

virtual void SCH_ITEM::SetExcludedFromBOM ( bool aExcludeFromBOM )

inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, and SYMBOL.

Definition at line 256 of file sch_item.h.

◆ SetExcludedFromSim()

void SCH_TEXT::SetExcludedFromSim ( bool aExclude )

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 87 of file sch_text.h.

References m_excludedFromSim.

◆ SetFields()

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

inlineinherited

Set multiple schematic fields.

Parameters

aFields are the fields to set in this symbol.

Definition at line 220 of file sch_label.h.

References m_fields.

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

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 142 of file eda_item.h.

References m_flags.

◆ SetFont()

void EDA_TEXT::SetFont ( KIFONT::FONT * aFont )

inherited

Definition at line 500 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), SetBold(), SetFontProp(), SetItalic(), FIELDS_GRID_TABLE::SetValue(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetFontProp()

void EDA_TEXT::SetFontProp ( const wxString & aFontName )

inherited

Definition at line 1017 of file eda_text.cpp.

References _, KIFONT::FONT::GetFont(), IsBold(), IsEeschemaType(), IsItalic(), KICAD_FONT_NAME, and SetFont().

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

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

◆ SetHorizJustify()

void EDA_TEXT::SetHorizJustify ( GR_TEXT_H_ALIGN_T aType )

inherited

Definition at line 410 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_IO_ALTIUM::AddLibTextBox(), SCH_IO_ALTIUM::AddTextBox(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_SHEET::AutoplaceFields(), FOOTPRINT::AutoPositionFields(), SCH_IO_ALTIUM::CreateAliases(), SCH_DRAWING_TOOLS::createNewText(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), SCH_DRAWING_TOOLS::DrawShape(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FlipHJustify(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), AUTOPLACER::justifyField(), PCB_TEXT::KeepUpright(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), SCH_IO_EAGLE::loadFieldAttributes(), SCH_IO_EAGLE::loadFrame(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), SCH_IO_KICAD_LEGACY::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), PCB_TEXT::Mirror(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_TEXT::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), SCH_TEXT::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), PCB_IO_EAGLE::orientFPText(), PCB_IO_EAGLE::packageText(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_TEXTBOX::PCB_TEXTBOX(), PCB_CONTROL::PlaceStackup(), SCH_FIELD::Rotate(), SCH_TEXTBOX::SCH_TEXTBOX(), SCH_FIELD::SetEffectiveHorizJustify(), SCH_LABEL_BASE::SetSpinStyle(), SCH_IO_LTSPICE_PARSER::setTextJustification(), PCAD2KICAD::SetTextJustify(), FABMASTER::setupText(), FIELDS_GRID_TABLE::SetValue(), swapFieldPositionsWithMatching(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_FIELD_PROPERTIES::UpdateField(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ SetHyperlink()

void EDA_TEXT::SetHyperlink ( wxString aLink )

inlineinherited

Definition at line 401 of file eda_text.h.

References m_hyperlink.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), Deserialize(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), and CLIPBOARD_IO::SaveSelection().

◆ SetIsDangling()

void SCH_LABEL_BASE::SetIsDangling ( bool aIsDangling )

inlineinherited

Definition at line 338 of file sch_label.h.

References m_isDangling.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems().

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

◆ SetItalic()

void EDA_TEXT::SetItalic ( bool aItalic )

inherited

Set the text to be italic - this will also update the font if needed.

This is the properties system interface.

Definition at line 308 of file eda_text.cpp.

References GetFont(), KIFONT::FONT::GetFont(), KIFONT::FONT::GetName(), IsBold(), KIFONT::FONT::IsStroke(), m_attributes, SetFont(), and SetItalicFlag().

Referenced by SCH_IO_ALTIUM::AddTextBox(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCAD_TEXT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_IO_EAGLE::loadFieldAttributes(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_LABEL_PROPERTIES::OnAddField(), SCH_IO_ALTIUM::ParseLabel(), FABMASTER::setupText(), FIELDS_GRID_TABLE::SetValue(), FIELDS_GRID_TABLE::SetValueAsBool(), PCB_FIELDS_GRID_TABLE::SetValueAsBool(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), SCH_DRAWING_TOOLS::TwoClickPlace(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetItalicFlag()

void EDA_TEXT::SetItalicFlag ( bool aItalic )

inherited

Set only the italic flag, without changing the font.

Used when bulk-changing text attributes (e.g. from a dialog or import).

Definition at line 328 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), SCH_IO_KICAD_LEGACY::loadSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), and SetItalic().

◆ SetKeepUpright()

void EDA_TEXT::SetKeepUpright ( bool aKeepUpright )

inherited

Definition at line 426 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), PCB_BASE_FRAME::CreateNewFootprint(), PCB_IO_EAGLE::loadPlain(), PCB_IO_EAGLE::packageText(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_TEXT::PCB_TEXT(), PCB_TEXT_DESC::PCB_TEXT_DESC(), FABMASTER::setupText(), PCB_FIELDS_GRID_TABLE::SetValueAsBool(), PCB_TEXT::StyleFromSettings(), and PCB_TEXTBOX::StyleFromSettings().

◆ SetLabelShape()

void SCH_LABEL_BASE::SetLabelShape ( LABEL_SHAPE aShape )

inherited

Definition at line 320 of file sch_label.cpp.

References SCH_SCREEN::GetClientSheetPaths(), EDA_ITEM::GetParent(), SCH_SHEET::GetPins(), SCH_SHEET::GetScreen(), EDA_TEXT::GetText(), SCH_SCREEN::Items(), m_shape, EE_RTREE::OfType(), pin, SCH_HIER_LABEL_T, SCH_ITEM::SCH_ITEM(), SCH_SHEET_PIN_T, SetLabelShape(), text, and EDA_ITEM::Type().

Referenced by SCH_LABEL_DESC::SCH_LABEL_DESC(), SetLabelShape(), and SetShape().

◆ SetLastResolvedState()

void SCH_LABEL_BASE::SetLastResolvedState ( const SCH_ITEM * aItem )

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 195 of file sch_label.h.

References m_lastResolvedColor, SCH_ITEM::SCH_ITEM(), and SCH_LABEL_BASE().

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

◆ SetLineSpacing()

void EDA_TEXT::SetLineSpacing ( double aLineSpacing )

inherited

Definition at line 526 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), and SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT().

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

◆ SetMirrored()

void EDA_TEXT::SetMirrored ( bool isMirrored )

inherited

Definition at line 394 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCAD_TEXT::AddToBoard(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), PCB_DIMENSION_BASE::Mirror(), PCB_IO_EAGLE::orientFPText(), PCB_IO_EAGLE::packageText(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), PCB_TABLECELL::PCB_TABLECELL(), FABMASTER::setupText(), PCB_FIELDS_GRID_TABLE::SetValueAsBool(), PCB_FIELDS_GRID_TABLE::SetValueAsLong(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

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

◆ SetMultilineAllowed()

void EDA_TEXT::SetMultilineAllowed ( bool aAllow )

inherited

Parameters

aAllow true if ok to use multiline option, false if ok to use only single line text. (Single line is faster in calculations than multiline.)

Definition at line 402 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by SCH_IO_LTSPICE_PARSER::CreateSCH_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), PCB_TEXT::PCB_TEXT(), PCB_TEXTBOX::PCB_TEXTBOX(), SCH_LABEL_BASE::SCH_LABEL_BASE(), SCH_LABEL_BASE::SCH_LABEL_BASE(), SCH_TEXT::SCH_TEXT(), and SCH_TEXTBOX::SCH_TEXTBOX().

◆ 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_LABEL_BASE::SetPosition ( const VECTOR2I & aPosition )

overridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in SCH_SHEET_PIN.

Definition at line 470 of file sch_label.cpp.

References EDA_TEXT::GetTextPos(), and Move().

Referenced by SCH_IO_EAGLE::addImplicitConnections(), SCH_IO_LTSPICE_PARSER::CreateSCH_LABEL(), SCH_LABEL::Deserialize(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), and SCH_MOVE_TOOL::moveItem().

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

◆ SetSchTextSize()

void SCH_TEXT::SetSchTextSize ( int aSize )

inlineinherited

Definition at line 78 of file sch_text.h.

References EDA_TEXT::SetTextSize().

Referenced by SCH_TEXT_DESC::SCH_TEXT_DESC().

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

◆ SetShape()

void SCH_LABEL_BASE::SetShape ( LABEL_FLAG_SHAPE aShape )

inlineinherited

Definition at line 181 of file sch_label.h.

References F_FIRST, m_shape, and SetLabelShape().

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_IO_LTSPICE_PARSER::CreatePin(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), SCH_IO_EAGLE::loadModuleInstance(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_IO_KICAD_LEGACY::loadText(), SCH_SELECTION_TOOL::Main(), SCH_IO_ALTIUM::ParsePortHelper(), SCH_IO_KICAD_SEXPR_PARSER::parseSchText(), SCH_IO_ALTIUM::ParseSheetEntry(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetSpinStyle()

void SCH_GLOBALLABEL::SetSpinStyle ( SPIN_STYLE aSpinStyle )

overridevirtual

Reimplemented from SCH_LABEL_BASE.

Definition at line 2073 of file sch_label.cpp.

References GR_TEXT_V_ALIGN_CENTER, SCH_LABEL_BASE::SetSpinStyle(), and EDA_TEXT::SetVertJustify().

Referenced by SCH_IO_EAGLE::addImplicitConnections(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances().

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

◆ SetText()

void EDA_TEXT::SetText ( const wxString & aText )

virtualinherited

Reimplemented in SCH_FIELD.

Definition at line 271 of file eda_text.cpp.

References cacheShownText(), and m_text.

◆ SetTextAngle()

void EDA_TEXT::SetTextAngle ( const EDA_ANGLE & aAngle )

virtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 300 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCAD_TEXT::AddToBoard(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_SHEET::AutoplaceFields(), FOOTPRINT::AutoPositionFields(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), SCH_DRAWING_TOOLS::DrawShape(), eagleToKicadAlignment(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_IO_EASYEDA::FootprintLoad(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), PCB_TEXT::KeepUpright(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), SCH_IO_EAGLE::loadFieldAttributes(), FABMASTER::loadFootprints(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), SCH_IO_KICAD_LEGACY::loadSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), PCB_DIMENSION_BASE::Mirror(), PCB_TEXTBOX::Mirror(), DIALOG_SHEET_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), PCB_IO_EAGLE::orientFPText(), PCB_IO_EAGLE::packageText(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_IO_KICAD_SEXPR_PARSER::parseSchTextBoxContent(), SCH_TEXTBOX::Plot(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), PCB_TEXTBOX::Rotate(), SCH_EDIT_TOOL::Rotate(), SCH_FIELD::Rotate(), SCH_TEXTBOX::Rotate(), SCH_TEXT::Rotate90(), SCH_TEXTBOX::Rotate90(), CLIPBOARD_IO::SaveSelection(), SCH_LABEL_BASE::SetSpinStyle(), SetTextAngleDegrees(), SCH_IO_LTSPICE_PARSER::setTextJustification(), FABMASTER::setupText(), FIELDS_GRID_TABLE::SetValue(), PCB_FIELDS_GRID_TABLE::SetValue(), swapFieldPositionsWithMatching(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_FIELD_PROPERTIES::updateText(), PCB_DIM_ALIGNED::updateText(), PCB_DIM_ORTHOGONAL::updateText(), and PCB_DIM_RADIAL::updateText().

◆ SetTextAngleDegrees()

void EDA_TEXT::SetTextAngleDegrees ( double aOrientation )

inlineinherited

Definition at line 149 of file eda_text.h.

References DEGREES_T, and SetTextAngle().

Referenced by PCB_DIMENSION_BASE::ChangeTextAngleDegrees(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), SCH_EASYEDA_PARSER::ParseSchematic(), and SCH_EASYEDA_PARSER::ParseSymbolShapes().

◆ SetTextColor()

void EDA_TEXT::SetTextColor ( const COLOR4D & aColor )

inlineinherited

Definition at line 268 of file eda_text.h.

References m_attributes.

Referenced by DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), FIELDS_GRID_TABLE::SetValue(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextHeight()

void EDA_TEXT::SetTextHeight ( int aHeight )

inherited

Definition at line 568 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), m_attributes, m_IuScale, TEXT_MAX_SIZE_MM, and TEXT_MIN_SIZE_MM.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::setupText(), PCB_FIELDS_GRID_TABLE::SetValue(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetTextPos()

void EDA_TEXT::SetTextPos ( const VECTOR2I & aPoint )

inherited

Definition at line 579 of file eda_text.cpp.

References m_pos, Offset(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCAD2KICAD::PCAD_TEXT::AddToBoard(), BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), SCH_SHEET::AutoplaceFields(), SCH_FIELD::BeginEdit(), SCH_TEXT::BeginEdit(), BOOST_AUTO_TEST_CASE(), SCH_FIELD::CalcEdit(), SCH_TEXT::CalcEdit(), SCH_EDIT_TOOL::ChangeTextType(), Deserialize(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_IO_EAGLE::loadFieldAttributes(), SCH_IO_EAGLE::loadInstance(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), SCH_IO_KICAD_LEGACY::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), PCB_DIMENSION_BASE::Mirror(), SCH_TEXT::NormalizeJustification(), PCB_IO_EAGLE::orientFPText(), SCH_IO_ALTIUM::ParseLibParameter(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), SCH_IO_KICAD_SEXPR_PARSER::parseSchText(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_TEXT::PCB_TEXT(), DIALOG_CHANGE_SYMBOLS::processSymbols(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), DS_DRAW_ITEM_TEXT::SetPosition(), PCB_TEXT::SetPosition(), SCH_FIELD::SetPosition(), SCH_TEXT::SetPosition(), FABMASTER::setupText(), FIELDS_GRID_TABLE::SetValue(), EASYEDA_PARSER_BASE::TransformTextToBaseline(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_FIELD_PROPERTIES::UpdateField(), SCH_SYMBOL::UpdateFields(), PCB_DIM_ALIGNED::updateText(), PCB_DIM_CENTER::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ SetTextSize()

void EDA_TEXT::SetTextSize	(	VECTOR2I	aNewSize,
		bool	aEnforceMinTextSize = true )

inherited

Definition at line 534 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), m_attributes, m_IuScale, TEXT_MAX_SIZE_MM, TEXT_MIN_SIZE_MM, unityScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_IO_EAGLE::addImplicitConnections(), SCH_IO_ALTIUM::AddLibTextBox(), SCH_IO_ALTIUM::AddTextBox(), CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), SCH_IO_LTSPICE_PARSER::CreateFields(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), SCH_IO_LTSPICE_PARSER::CreatePowerSymbol(), SCH_IO_LTSPICE_PARSER::CreateSCH_LABEL(), SCH_IO_LTSPICE_PARSER::CreateSCH_TEXT(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawTable(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), SCH_IO_EAGLE::loadFieldAttributes(), SCH_IO_EAGLE::loadFrame(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_IO_KICAD_LEGACY::loadSheet(), SCH_IO_KICAD_LEGACY::loadSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), SCH_IO_EAGLE::loadTextAttributes(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), PCB_IO_EAGLE::orientFPText(), PCB_IO_EAGLE::packageText(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_ALTIUM::ParseLabel(), SCH_IO_ALTIUM::ParseLibDesignator(), SCH_IO_ALTIUM::ParseLibParameter(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_CONTROL::PlaceCharacteristics(), PCB_CONTROL::PlaceStackup(), BACK_ANNOTATE::processNetNameChange(), SCH_FIELD::SCH_FIELD(), SCH_FIELD::SetSchTextSize(), SCH_TEXT::SetSchTextSize(), SCH_TEXTBOX::SetSchTextSize(), PCAD2KICAD::SetTextSizeFromStrokeFontHeight(), PCAD2KICAD::SetTextSizeFromTrueTypeFontHeight(), FIELDS_GRID_TABLE::SetValue(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), SCH_DRAWING_TOOLS::TwoClickPlace(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextThickness()

void EDA_TEXT::SetTextThickness ( int aWidth )

inherited

The TextThickness is that set by the user.

The EffectiveTextPenWidth also factors in bold text and thickness clamping.

Definition at line 285 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCAD_TEXT::AddToBoard(), CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), PCB_BASE_FRAME::CreateNewFootprint(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), PCB_IO_EAGLE::orientFPText(), PCB_IO_EAGLE::packageText(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), PCB_CONTROL::PlaceCharacteristics(), PCB_CONTROL::PlaceStackup(), SetAutoThickness(), FABMASTER::setupText(), PCB_FIELDS_GRID_TABLE::SetValue(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetTextWidth()

void EDA_TEXT::SetTextWidth ( int aWidth )

inherited

Definition at line 557 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), m_attributes, m_IuScale, TEXT_MAX_SIZE_MM, and TEXT_MIN_SIZE_MM.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::setupText(), PCB_FIELDS_GRID_TABLE::SetValue(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetTextX()

void EDA_TEXT::SetTextX ( int aX )

inherited

Definition at line 585 of file eda_text.cpp.

References m_pos, and Offset().

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), PCB_TEXT::Flip(), PCB_TEXT::Mirror(), SCH_DIRECTIVE_LABEL::MirrorHorizontally(), SCH_FIELD::MirrorHorizontally(), SCH_SHEET_PIN::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), and SCH_SHEET_PIN::SetSide().

◆ SetTextY()

void EDA_TEXT::SetTextY ( int aY )

inherited

Definition at line 591 of file eda_text.cpp.

References m_pos, and Offset().

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), PCB_TEXT::Flip(), PCB_TEXT::Mirror(), SCH_DIRECTIVE_LABEL::MirrorVertically(), SCH_FIELD::MirrorVertically(), SCH_SHEET_PIN::MirrorVertically(), SCH_TEXT::MirrorVertically(), and SCH_SHEET_PIN::SetSide().

◆ SetUnit()

virtual void SCH_ITEM::SetUnit ( int aUnit )

inlinevirtualinherited

Definition at line 237 of file sch_item.h.

References m_unit.

◆ SetUnresolvedFontName()

void EDA_TEXT::SetUnresolvedFontName ( const wxString & aFontName )

inlineinherited

Definition at line 248 of file eda_text.h.

References m_unresolvedFontName.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), and SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT().

◆ SetupRenderCache()

void EDA_TEXT::SetupRenderCache	(	const wxString &	aResolvedText,
		const KIFONT::FONT *	aFont,
		const EDA_ANGLE &	aAngle,
		const VECTOR2I &	aOffset )

inherited

Definition at line 720 of file eda_text.cpp.

References m_render_cache, m_render_cache_angle, m_render_cache_font, m_render_cache_offset, and m_render_cache_text.

◆ SetVertJustify()

void EDA_TEXT::SetVertJustify ( GR_TEXT_V_ALIGN_T aType )

inherited

Definition at line 418 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_SHEET::AutoplaceFields(), FOOTPRINT::AutoPositionFields(), SCH_IO_ALTIUM::CreateAliases(), SCH_DRAWING_TOOLS::createNewText(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), SCH_DRAWING_TOOLS::DrawShape(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), AUTOPLACER::justifyField(), PCB_TEXT::KeepUpright(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), SCH_IO_EAGLE::loadFieldAttributes(), SCH_IO_EAGLE::loadFrame(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), SCH_IO_KICAD_LEGACY::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_TEXT::MirrorHorizontally(), SCH_TEXT::MirrorVertically(), PCB_IO_EAGLE::orientFPText(), PCB_IO_EAGLE::packageText(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_TEXTBOX::PCB_TEXTBOX(), SCH_GLOBALLABEL::SCH_GLOBALLABEL(), SCH_TEXTBOX::SCH_TEXTBOX(), SCH_FIELD::SetEffectiveVertJustify(), SCH_GLOBALLABEL::SetSpinStyle(), SCH_HIERLABEL::SetSpinStyle(), SCH_LABEL_BASE::SetSpinStyle(), SCH_IO_LTSPICE_PARSER::setTextJustification(), PCAD2KICAD::SetTextJustify(), FABMASTER::setupText(), FIELDS_GRID_TABLE::SetValue(), swapFieldPositionsWithMatching(), DIALOG_FIELD_PROPERTIES::UpdateField(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ SetVisible()

void EDA_TEXT::SetVisible ( bool aVisible )

virtualinherited

Definition at line 387 of file eda_text.cpp.

References ClearRenderCache(), and m_visible.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::addNewFieldToSymbol(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_IO_LTSPICE_PARSER::CreateFields(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_IO_LTSPICE_PARSER::CreatePowerSymbol(), SCH_IO_LTSPICE_PARSER::CreateSCH_LABEL(), SCH_IO_LTSPICE_PARSER::CreateSCH_TEXT(), EDIT_TOOL::DeleteItems(), PCB_FIELD::Deserialize(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_IO_EASYEDAPRO_PARSER::fillFootprintModelInfo(), FOOTPRINT::FOOTPRINT(), PCB_IO_EASYEDA::FootprintLoad(), PCB_IO_EASYEDAPRO::FootprintLoad(), SCH_IO_EAGLE::getEagleSymbolFieldAttributes(), SCH_FIELD::ImportValues(), LIB_SYMBOL::LIB_SYMBOL(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), PCB_IO_EAGLE::loadElements(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), FABMASTER::loadFootprints(), SCH_IO_EAGLE::loadInstance(), SCH_IO_EAGLE::loadLibrary(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_IO_KICAD_LEGACY_LIB_CACHE::LoadPart(), PCB_IO_EAGLE::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_IO_KICAD_LEGACY::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_IO_DATABASE::loadSymbolFromRow(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolGateAndPartFields(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), SIM_MODEL::MigrateSimModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_LABEL_PROPERTIES::OnAddField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SHEET_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), SCH_IO_ALTIUM::ParseDesignator(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_ALTIUM::ParseFileName(), PCB_IO_KICAD_SEXPR_PARSER::parseFOOTPRINT_unchecked(), SCH_IO_ALTIUM::ParseLibParameter(), SCH_IO_ALTIUM::ParseParameter(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), SCH_IO_ALTIUM::ParsePortHelper(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_IO_KICAD_SEXPR_PARSER::parseSchText(), SCH_IO_ALTIUM::ParseSheetName(), SCH_EASYEDA_PARSER::ParseSymbol(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), PCB_FIELD::PCB_FIELD(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_CHANGE_SYMBOLS::processSymbols(), processTextItem(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveDcmInfoAsFields(), SCH_FIELD::SCH_FIELD(), SCH_IO_LTSPICE_PARSER::setTextJustification(), FIELDS_GRID_TABLE::SetValue(), FIELDS_GRID_TABLE::SetValueAsBool(), PCB_FIELDS_GRID_TABLE::SetValueAsBool(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ ShowSyntaxHelp()

HTML_MESSAGE_BOX * SCH_TEXT::ShowSyntaxHelp ( wxWindow * aParentWindow )

staticinherited

Definition at line 2379 of file sch_label.cpp.

References _, HTML_MESSAGE_BOX::AddHTML_Text(), ConvertMarkdown2Html(), HTML_MESSAGE_BOX::SetDialogSizeInDU(), and HTML_MESSAGE_BOX::ShowModeless().

Referenced by DIALOG_LABEL_PROPERTIES::OnFormattingHelp(), DIALOG_TEXT_PROPERTIES::OnFormattingHelp(), DIALOG_SHEET_PIN_PROPERTIES::OnSyntaxHelp(), and SCH_INSPECTION_TOOL::ShowBusSyntaxHelp().

◆ Similarity() [1/2]

double EDA_TEXT::Similarity ( const EDA_TEXT & aOther ) const

inherited

Definition at line 1276 of file eda_text.cpp.

References EDA_TEXT(), Levenshtein(), m_attributes, and m_pos.

Referenced by PCB_DIMENSION_BASE::Similarity(), PCB_FIELD::Similarity(), PCB_TEXT::Similarity(), PCB_TEXTBOX::Similarity(), SCH_FIELD::Similarity(), SCH_TEXT::Similarity(), and SCH_TEXTBOX::Similarity().

◆ Similarity() [2/2]

double SCH_LABEL_BASE::Similarity ( const SCH_ITEM & aItem ) const

overridevirtualinherited

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.

Reimplemented in SCH_SHEET_PIN.

Definition at line 623 of file sch_label.cpp.

References std::abs(), m_connectionType, m_fields, m_shape, EDA_ITEM::m_Uuid, SCH_ITEM::SCH_ITEM(), SCH_LABEL_BASE(), and SCH_TEXT::Similarity().

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

◆ SwapAttributes()

void EDA_TEXT::SwapAttributes ( EDA_TEXT & aTradingPartner )

inherited

Swap the text attributes of the two involved instances.

Definition at line 453 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), EDA_TEXT(), m_attributes, and m_pos.

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

◆ swapData()

void SCH_LABEL_BASE::swapData ( SCH_ITEM * aItem )

overrideprotectedvirtualinherited

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.

Reimplemented in SCH_SHEET_PIN.

Definition at line 287 of file sch_label.cpp.

References m_connectionType, m_fields, SCH_ITEM::m_fieldsAutoplaced, m_isDangling, m_lastResolvedColor, m_shape, SCH_ITEM::SCH_ITEM(), SCH_LABEL_BASE(), EDA_ITEM::SetParent(), and SCH_TEXT::swapData().

Referenced by SCH_DIRECTIVE_LABEL::swapData().

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

◆ SwapText()

void EDA_TEXT::SwapText ( EDA_TEXT & aTradingPartner )

inherited

Definition at line 446 of file eda_text.cpp.

References cacheShownText(), EDA_TEXT(), and m_text.

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

◆ TextHitTest() [1/2]

bool EDA_TEXT::TextHitTest	(	const BOX2I &	aRect,
		bool	aContains,
		int	aAccuracy = 0 ) const

virtualinherited

Test if object bounding box is contained within or intersects aRect.

Parameters

aRect	Rect to test against.
aContains	Test for containment instead of intersection if true.
aAccuracy	Amount to inflate the bounding box.

Returns: true if a hit, else false.

Reimplemented in PCB_TEXT.

Definition at line 879 of file eda_text.cpp.

References BOX2< Vec >::Contains(), GetDrawRotation(), BOX2< Vec >::GetInflated(), GetTextBox(), and BOX2< Vec >::Intersects().

◆ TextHitTest() [2/2]

bool EDA_TEXT::TextHitTest	(	const VECTOR2I &	aPoint,
		int	aAccuracy = 0 ) const

virtualinherited

Test if aPoint is within the bounds of this object.

Parameters

aPoint	A VECTOR2I to test.
aAccuracy	Amount to inflate the bounding box.

Returns: true if a hit, else false.

Reimplemented in PCB_TEXT.

Definition at line 871 of file eda_text.cpp.

References BOX2< Vec >::Contains(), GetDrawPos(), GetDrawRotation(), BOX2< Vec >::GetInflated(), GetRotated(), GetTextBox(), and location.

Referenced by DS_DRAW_ITEM_TEXT::HitTest(), DS_DRAW_ITEM_TEXT::HitTest(), and PCB_TEXT::TextHitTest().

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

overridevirtualinherited

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 1251 of file sch_label.cpp.

References accuracy, SCH_ITEM::AddConnectionTo(), BUS, BUS_END, DANGLING_END_ITEM_HELPER::get_lower_pos(), DANGLING_END_ITEM_HELPER::get_lower_type(), DANGLING_END_ITEM::GetItem(), DANGLING_END_ITEM::GetPosition(), EDA_TEXT::GetTextPos(), DANGLING_END_ITEM::GetType(), LABEL_END, m_connectionType, m_isDangling, NET, NO_CONNECT_END, NONE, PIN_END, SCH_ITEM::SCH_ITEM(), SHEET_LABEL_END, TestSegmentHit(), and WIRE_END.

◆ ValidateHyperlink()

bool EDA_TEXT::ValidateHyperlink ( const wxString & aURL )

staticinherited

Check if aURL is a valid hyperlink.

Parameters

aURL	String to validate

Returns: true if aURL is a valid hyperlink

Definition at line 1220 of file eda_text.cpp.

References IsGotoPageHref().

Referenced by SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ 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_GLOBALLABEL::ViewGetLayers ( ) const

overridevirtual

Return the all the layers within the VIEW the object is painted on.

For instance, a PAD spans zero or more copper layers and a few technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called for each of the layers returned by ViewGetLayers(), depending on the rendering order.

Reimplemented from EDA_ITEM.

Definition at line 2139 of file sch_label.cpp.

References LAYER_DANGLING, LAYER_DEVICE, LAYER_FIELDS, LAYER_GLOBLABEL, LAYER_INTERSHEET_REFS, LAYER_NETCLASS_REFS, and LAYER_SELECTION_SHADOWS.

◆ 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_LABEL_BASE::Visit	(	INSPECTOR	inspector,
		void *	testData,
		const std::vector< KICAD_T > &	aScanTypes )

overridevirtualinherited

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 1054 of file sch_label.cpp.

References CONTINUE, IsType(), m_fields, QUIT, SCH_FIELD_T, and SCH_LOCATE_ANY_T.

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

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_attributes

TEXT_ATTRIBUTES EDA_TEXT::m_attributes

privateinherited

◆ m_autoRotateOnPlacement

bool SCH_LABEL_BASE::m_autoRotateOnPlacement

protectedinherited

Definition at line 381 of file sch_label.h.

Referenced by AutoRotateOnPlacement(), operator=(), SCH_LABEL_BASE(), SCH_LABEL_BASE(), and SetAutoRotateOnPlacement().

◆ m_bbox_cache

std::map<int, BBOX_CACHE_ENTRY> EDA_TEXT::m_bbox_cache

mutableprivateinherited

Definition at line 471 of file eda_text.h.

Referenced by ClearBoundingBoxCache(), EDA_TEXT(), GetTextBox(), and operator=().

◆ m_bodyStyle

int SCH_ITEM::m_bodyStyle

protectedinherited

◆ m_cached_driver_name

wxString SCH_LABEL_BASE::m_cached_driver_name

protectedinherited

Definition at line 385 of file sch_label.h.

Referenced by cacheShownText(), GetCachedDriverName(), operator=(), SCH_LABEL_BASE(), and SCH_LABEL_BASE().

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

CONNECTION_TYPE SCH_LABEL_BASE::m_connectionType

protectedinherited

Definition at line 379 of file sch_label.h.

Referenced by operator=(), operator==(), SCH_LABEL_BASE(), SCH_LABEL_BASE(), Similarity(), swapData(), and UpdateDanglingState().

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

bool SCH_TEXT::m_excludedFromSim

protectedinherited

Definition at line 189 of file sch_text.h.

Referenced by GetExcludedFromSim(), GetMsgPanelInfo(), SCH_TEXT(), SCH_TEXT(), and SetExcludedFromSim().

◆ m_fields

std::vector<SCH_FIELD> SCH_LABEL_BASE::m_fields

protectedinherited

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

wxString EDA_TEXT::m_hyperlink

protectedinherited

A hyperlink URL.

If empty, this text object is not a hyperlink.

Definition at line 450 of file eda_text.h.

Referenced by SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), GetHyperlink(), HasHyperlink(), RemoveHyperlink(), and SetHyperlink().

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

bool SCH_LABEL_BASE::m_isDangling

protectedinherited

Definition at line 380 of file sch_label.h.

Referenced by SCH_DIRECTIVE_LABEL::IsDangling(), IsDangling(), SCH_GLOBALLABEL::IsPointClickableAnchor(), SCH_HIERLABEL::IsPointClickableAnchor(), SCH_LABEL::IsPointClickableAnchor(), SCH_SHEET_PIN::IsPointClickableAnchor(), operator=(), SCH_DIRECTIVE_LABEL::SCH_DIRECTIVE_LABEL(), SCH_GLOBALLABEL::SCH_GLOBALLABEL(), SCH_HIERLABEL::SCH_HIERLABEL(), SCH_LABEL::SCH_LABEL(), SCH_LABEL_BASE(), SCH_LABEL_BASE(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SetIsDangling(), swapData(), and UpdateDanglingState().

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

std::reference_wrapper<const EDA_IU_SCALE> EDA_TEXT::m_IuScale

privateinherited

Definition at line 457 of file eda_text.h.

Referenced by EDA_TEXT(), EDA_TEXT(), Format(), SetTextHeight(), SetTextSize(), and SetTextWidth().

◆ m_lastResolvedColor

COLOR4D SCH_LABEL_BASE::m_lastResolvedColor

mutableprotectedinherited

Definition at line 383 of file sch_label.h.

Referenced by GetLabelColor(), operator=(), SCH_LABEL_BASE(), SCH_LABEL_BASE(), SetLastResolvedState(), and swapData().

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

VECTOR2I EDA_TEXT::m_pos

privateinherited

Definition at line 475 of file eda_text.h.

Referenced by Compare(), EDA_TEXT(), GetTextPos(), Offset(), operator=(), SetAttributes(), SetTextPos(), SetTextX(), SetTextY(), Similarity(), and SwapAttributes().

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

std::vector<std::unique_ptr<KIFONT::GLYPH> > EDA_TEXT::m_render_cache

mutableprivateinherited

Definition at line 463 of file eda_text.h.

Referenced by AddRenderCacheGlyph(), ClearRenderCache(), EDA_TEXT(), GetRenderCache(), Offset(), operator=(), ResolveFont(), and SetupRenderCache().

◆ m_render_cache_angle

EDA_ANGLE EDA_TEXT::m_render_cache_angle

mutableprivateinherited

Definition at line 461 of file eda_text.h.

Referenced by EDA_TEXT(), GetRenderCache(), operator=(), and SetupRenderCache().

◆ m_render_cache_font

const KIFONT::FONT* EDA_TEXT::m_render_cache_font

mutableprivateinherited

Definition at line 460 of file eda_text.h.

Referenced by EDA_TEXT(), EDA_TEXT(), GetRenderCache(), operator=(), ResolveFont(), and SetupRenderCache().

◆ m_render_cache_offset

VECTOR2I EDA_TEXT::m_render_cache_offset

mutableprivateinherited

Definition at line 462 of file eda_text.h.

Referenced by EDA_TEXT(), GetRenderCache(), operator=(), and SetupRenderCache().

◆ m_render_cache_text

wxString EDA_TEXT::m_render_cache_text

mutableprivateinherited

Definition at line 459 of file eda_text.h.

Referenced by EDA_TEXT(), GetRenderCache(), operator=(), and SetupRenderCache().

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

◆ m_shown_text

wxString EDA_TEXT::m_shown_text

privateinherited

Definition at line 454 of file eda_text.h.

Referenced by cacheShownText(), EDA_TEXT(), EDA_TEXT(), GetShownText(), and operator=().

◆ m_shown_text_has_text_var_refs

bool EDA_TEXT::m_shown_text_has_text_var_refs

privateinherited

Definition at line 455 of file eda_text.h.

Referenced by cacheShownText(), EDA_TEXT(), EDA_TEXT(), HasTextVars(), and operator=().

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

wxString EDA_TEXT::m_text

privateinherited

Definition at line 453 of file eda_text.h.

Referenced by cacheShownText(), Compare(), CopyText(), EDA_TEXT(), EDA_TEXT(), Empty(), GetText(), operator=(), Replace(), SetText(), and SwapText().

◆ m_unit

int SCH_ITEM::m_unit

protectedinherited

◆ m_unresolvedFontName

wxString EDA_TEXT::m_unresolvedFontName

privateinherited

Definition at line 474 of file eda_text.h.

Referenced by EDA_TEXT(), operator=(), ResolveFont(), and SetUnresolvedFontName().

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

◆ m_visible

bool EDA_TEXT::m_visible

privateinherited

Definition at line 476 of file eda_text.h.

Referenced by EDA_TEXT(), EDA_TEXT(), IsVisible(), operator=(), and SetVisible().

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

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

Constructor & Destructor Documentation

◆ SCH_GLOBALLABEL() [1/2]

◆ SCH_GLOBALLABEL() [2/2]

◆ ~SCH_GLOBALLABEL()

Member Function Documentation

◆ AddConnectionTo()

◆ AddField()

◆ AddFields()

◆ AddRenderCacheGlyph()

◆ AddRuleAreaToCache()

◆ AutoplaceFields()

◆ AutoRotateOnPlacement()

◆ AutoRotateOnPlacementSupported()

◆ BeginEdit()

◆ cacheShownText()

◆ CalcEdit()

◆ CanConnect()

◆ ClassOf()

◆ ClearBoundingBoxCache()

◆ ClearBrightened()

◆ ClearCaches()

◆ ClearConnectedItems()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearRenderCache()

◆ ClearRuleAreasCache()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ Compare()

◆ compare()

◆ ConnectedItems()

◆ Connection()

◆ ConnectionPropagatesTo()

◆ ContinueEdit()

◆ CopyText()

◆ CreateGraphicShape()

◆ Deserialize()

◆ DoHypertextAction()

◆ doIsConnected()

◆ Duplicate()

◆ Empty()

◆ EndEdit()

◆ EvaluateText()

◆ findParent()

◆ FlipHJustify()

◆ Format()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAttributes()

◆ GetAutoThickness()

◆ GetBodyBoundingBox()

◆ GetBodyStyle()

◆ GetBodyStyleDescription()

◆ GetBodyStyleProp()

◆ GetBoundingBox()

◆ GetCachedDriverName()

◆ GetClass()

◆ GetConnectionPoints()

◆ GetContextualTextVars()

◆ GetDefaultFieldName()

◆ GetDefaultFont()

◆ GetDNP()

◆ GetDrawFont()

◆ GetDrawPos()

◆ GetDrawRotation()