Instances are attached to a symbol or sheet and provide a place for the symbol's value, reference designator, footprint, , a sheet's name, filename, and user definable name-value pairs of arbitrary purpose. More...

#include <sch_field.h>

Inheritance diagram for SCH_FIELD:

Public Member Functions
	SCH_FIELD (const VECTOR2I &aPos, int aFieldId, SCH_ITEM *aParent, const wxString &aName=wxEmptyString)

	SCH_FIELD (SCH_ITEM *aParent, int aFieldId, const wxString &aName=wxEmptyString)

	SCH_FIELD (const SCH_FIELD &aText)

	~SCH_FIELD ()

SCH_FIELD &	operator= (const SCH_FIELD &aField)

wxString	GetClass () const override
	Return the class name. More...

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

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

void	DoHypertextAction (EDA_DRAW_FRAME *aFrame) const override

wxString	GetName (bool aUseDefaultName=true) const
	Return the field name (not translated). More...

wxString	GetCanonicalName () const
	Get a non-language-specific name for a field which can be used for storage, variable look-up, etc. More...

void	SetName (const wxString &aName)

const wxString &	GetInternalName ()
	Get the initial name of the field set at creation (or set by SetName()). More...

int	GetId () const

void	SetId (int aId)

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

COLOR4D	GetFieldColor () const

void	SetLastResolvedState (const SCH_ITEM *aItem) override

EDA_ANGLE	GetDrawRotation () const override
	Adjusters to allow EDA_TEXT to draw/print/etc. More...

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

bool	IsHorizJustifyFlipped () const
	Return whether the field will be rendered with the horizontal justification inverted due to rotation or mirroring of the parent. More...

bool	IsVertJustifyFlipped () const

GR_TEXT_H_ALIGN_T	GetEffectiveHorizJustify () const

GR_TEXT_V_ALIGN_T	GetEffectiveVertJustify () const

bool	IsNameShown () const

void	SetNameShown (bool aShown=true)

bool	CanAutoplace () const

void	SetCanAutoplace (bool aCanPlace)

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

void	ImportValues (const LIB_FIELD &aSource)
	Copy parameters from a LIB_FIELD source. More...

int	GetPenWidth () const override

void	ClearCaches () override

void	ClearRenderCache () override

std::vector< std::unique_ptr< KIFONT::GLYPH > > *	GetRenderCache (const wxString &forResolvedText, const VECTOR2I &forPosition, TEXT_ATTRIBUTES &aAttrs) const

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

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

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

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

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

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

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

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

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

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

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

VECTOR2I	GetLibPosition () const

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &aPosition) override

VECTOR2I	GetParentPosition () const

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

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

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

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

bool	operator< (const SCH_ITEM &aItem) const override

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

virtual bool	IsMovableFromAnchorPoint () const

VECTOR2I &	GetStoredPos ()

void	SetStoredPos (const VECTOR2I &aPos)

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

virtual bool	IsLocked () const

virtual void	SetLocked (bool aLocked)
	Set the 'lock' status to aLocked for of this item. More...

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

void	SetLayer (SCH_LAYER_ID aLayer)
	Set the layer this item is on. More...

void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the layers the item is drawn on (which may be more than its "home" layer) More...

const wxString &	GetDefaultFont () const

bool	RenderAsBitmap (double aWorldScale) const override

virtual void	PrintBackground (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset)
	Print the (optional) backaground elements if they exist. More...

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

virtual bool	UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemList, const SCH_SHEET_PATH *aPath=nullptr)
	Test the schematic item to aItemList to check if it's dangling state has changed. More...

virtual bool	IsDangling () const

virtual bool	CanConnect (const SCH_ITEM *aItem) const

virtual bool	IsConnectable () const

virtual bool	IsPointClickableAnchor (const VECTOR2I &aPos) const

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

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

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

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

SCH_ITEM_SET &	ConnectedItems (const SCH_SHEET_PATH &aPath)
	Retrieve the set of items connected to this item on the given sheet. More...

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

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

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

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

bool	IsConnectivityDirty () const

void	SetConnectivityDirty (bool aDirty=true)

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

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

void	SetFieldsAutoplaced ()

void	ClearFieldsAutoplaced ()

void	AutoAutoplaceFields (SCH_SCREEN *aScreen)
	Autoplace fields only if correct to do so automatically. More...

virtual void	AutoplaceFields (SCH_SCREEN *aScreen, bool aManual)

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

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

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

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

KICAD_T	Type () const
	Returns the type of object. More...

EDA_ITEM *	GetParent () const

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	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

void	ClearTempFlags ()

void	ClearEditFlags ()

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...

bool	IsForceVisible () const

virtual wxString	GetFriendlyName () const

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

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

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

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

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

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

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

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

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

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

wxAny	Get (PROPERTY_BASE *aProperty) const

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

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

virtual const wxString &	GetText () const
	Return the string associated with the text object. More...

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

virtual void	SetText (const wxString &aText)

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

int	GetTextThickness () const

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

virtual void	SetTextAngle (const EDA_ANGLE &aAngle)

const EDA_ANGLE &	GetTextAngle () const

void	SetTextAngleDegrees (double aOrientation)

double	GetTextAngleDegrees () const

void	SetItalic (bool aItalic)

bool	IsItalic () const

void	SetBold (bool aBold)

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	SetAttributes (const EDA_TEXT &aSrc)
	Set the text attributes from another instance. More...

void	SetAttributes (const TEXT_ATTRIBUTES &aTextAttrs)

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

void	SwapText (EDA_TEXT &aTradingPartner)

void	CopyText (const EDA_TEXT &aSrc)

const TEXT_ATTRIBUTES &	GetAttributes () const

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

bool	IsDefaultFormatting () const

void	SetFont (KIFONT::FONT *aFont)

KIFONT::FONT *	GetFont () const

wxString	GetFontName () const

void	SetLineSpacing (double aLineSpacing)

double	GetLineSpacing () const

void	SetTextSize (const VECTOR2I &aNewSize)

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, OUTLINE_MODE aDisplay_mode=FILLED)
	Print this text object to the device context aDC. More...

void	TransformBoundingBoxToPolygon (SHAPE_POLY_SET *aBuffer, int aClearance) const
	Convert the text bounding box to a rectangular polygon depending on the text orientation, the bounding box is not always horizontal or vertical. More...

std::shared_ptr< SHAPE_COMPOUND >	GetEffectiveTextShape (bool aTriangulate=true, bool aUseTextRotation=true) const
	build a list of segments (SHAPE_SEGMENT) to describe a text shape. More...

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

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

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

int	GetInterline () const
	Return the distance between two lines of text. More...

wxString	GetTextStyleName () const

void	GetLinePositions (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. More...

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

virtual VECTOR2I	GetDrawPos () const

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 EDA_ANGLE &aAngle)

void	AddRenderCacheGlyph (const SHAPE_POLY_SET &aPoly)

int	Compare (const EDA_TEXT *aOther) 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)

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

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

static bool	Replace (const EDA_SEARCH_DATA &aSearchData, wxString &aText)
	Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...

static bool	Sort (const EDA_ITEM aLeft, const EDA_ITEM aRight)
	Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...

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

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

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

Public Attributes
const KIID	m_Uuid

Protected Member Functions
KIFONT::FONT *	getDrawFont () const override

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

void	cacheShownText ()

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

Protected Attributes
SCH_LAYER_ID	m_layer

EDA_ITEMS	m_connections

FIELDS_AUTOPLACED	m_fieldsAutoplaced

VECTOR2I	m_storedPos

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

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

bool	m_connectivity_dirty

EDA_ITEM_FLAGS	m_status

EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

wxString	m_hyperlink
	A hyperlink URL. More...

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

Private Attributes
int	m_id
	Field index,. More...

wxString	m_name

bool	m_showName
	Render the field name in addition to its value. More...

bool	m_allowAutoPlace
	This field can be autoplaced. More...

bool	m_renderCacheValid

VECTOR2I	m_renderCachePos

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

COLOR4D	m_lastResolvedColor

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

VIEW_ITEM_DATA *	m_viewPrivData

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

EDA_ANGLE	m_render_cache_angle

VECTOR2I	m_render_cache_offset

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

bool	m_bounding_box_cache_valid

VECTOR2I	m_bounding_box_cache_pos

int	m_bounding_box_cache_line

bool	m_bounding_box_cache_inverted

BOX2I	m_bounding_box_cache

TEXT_ATTRIBUTES	m_attributes

VECTOR2I	m_pos

Detailed Description

Instances are attached to a symbol or sheet and provide a place for the symbol's value, reference designator, footprint, , a sheet's name, filename, and user definable name-value pairs of arbitrary purpose.

Field 0 is reserved for the symbol reference.
Field 1 is reserved for the symbol value.
Field 2 is reserved for the symbol footprint.
Field 3 is reserved for the symbol data sheet file.
Field 4 and higher are user definable.

Definition at line 50 of file sch_field.h.

Constructor & Destructor Documentation

◆ SCH_FIELD() [1/3]

SCH_FIELD::SCH_FIELD	(	const VECTOR2I &	aPos,
		int	aFieldId,
		SCH_ITEM *	aParent,
		const wxString &	aName = `wxEmptyString`
	)

Definition at line 59 of file sch_field.cpp.

 :
 SCH_ITEM( aParent, SCH_FIELD_T ),
 EDA_TEXT( schIUScale, wxEmptyString ),
 m_id( 0 ),
 m_name( aName ),
 m_showName( false ),
 m_allowAutoPlace( true ),
 m_renderCacheValid( false ),
 m_lastResolvedColor( COLOR4D::UNSPECIFIED )
{
 SetTextPos( aPos );
 SetId( aFieldId ); // will also set the layer
 SetVisible( false );
}

References SetId(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetVisible(), and UNSPECIFIED.

Referenced by Clone().

◆ SCH_FIELD() [2/3]

SCH_FIELD::SCH_FIELD	(	SCH_ITEM *	aParent,
		int	aFieldId,
		const wxString &	aName = `wxEmptyString`
	)

Definition at line 76 of file sch_field.cpp.

 :
 SCH_FIELD( VECTOR2I(), aFieldId, aParent, aName )
{
}

◆ SCH_FIELD() [3/3]

SCH_FIELD::SCH_FIELD ( const SCH_FIELD & aText )

Definition at line 82 of file sch_field.cpp.

 :
 SCH_ITEM( aField ),
 EDA_TEXT( aField )
{
 m_id = aField.m_id;
 m_name = aField.m_name;
 m_showName = aField.m_showName;
 m_allowAutoPlace = aField.m_allowAutoPlace;
 
 m_renderCache.clear();
 
 for( const std::unique_ptr<KIFONT::GLYPH>& glyph : aField.m_renderCache )
 {
 KIFONT::OUTLINE_GLYPH* outline_glyph = static_cast<KIFONT::OUTLINE_GLYPH*>( glyph.get() );
 m_renderCache.emplace_back( std::make_unique<KIFONT::OUTLINE_GLYPH>( *outline_glyph ) );
 }
 
 m_renderCacheValid = aField.m_renderCacheValid;
 m_renderCachePos = aField.m_renderCachePos;
 
 m_lastResolvedColor = aField.m_lastResolvedColor;
}

References m_allowAutoPlace, m_id, m_lastResolvedColor, m_name, m_renderCache, m_renderCachePos, m_renderCacheValid, and m_showName.

◆ ~SCH_FIELD()

SCH_FIELD::~SCH_FIELD ( )

inline

Definition at line 60 of file sch_field.h.

61 { }

Member Function Documentation

◆ AddConnectionTo()

void SCH_ITEM::AddConnectionTo	(	const SCH_SHEET_PATH &	aPath,
		SCH_ITEM *	aItem
	)

inherited

Add a connection link between this item and another.

Definition at line 193 of file sch_item.cpp.

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

References SCH_ITEM::m_connected_items.

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

◆ AddRenderCacheGlyph()

void EDA_TEXT::AddRenderCacheGlyph ( const SHAPE_POLY_SET & aPoly )

inherited

Definition at line 493 of file eda_text.cpp.

{
 m_render_cache.emplace_back( std::make_unique<KIFONT::OUTLINE_GLYPH>( aPoly ) );
}

References EDA_TEXT::m_render_cache.

◆ AutoAutoplaceFields()

void SCH_ITEM::AutoAutoplaceFields ( SCH_SCREEN * aScreen )

inlineinherited

Autoplace fields only if correct to do so automatically.

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

Parameters

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

Definition at line 436 of file sch_item.h.

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

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

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

◆ AutoplaceFields()

virtual void SCH_ITEM::AutoplaceFields	(	SCH_SCREEN *	aScreen,
		bool	aManual
	)

inlinevirtualinherited

Reimplemented in SCH_LABEL_BASE, SCH_DIRECTIVE_LABEL, SCH_SHEET, and SCH_SYMBOL.

Definition at line 442 of file sch_item.h.

442{ }

Referenced by SCH_ITEM::AutoAutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ cacheShownText()

void EDA_TEXT::cacheShownText ( )

protectedinherited

Definition at line 410 of file eda_text.cpp.

{
 if( m_text.IsEmpty() )
 {
 m_shown_text = wxEmptyString;
 m_shown_text_has_text_var_refs = false;
 }
 else
 {
 m_shown_text = UnescapeString( m_text );
 m_shown_text_has_text_var_refs = m_shown_text.Contains( wxT( "${" ) );
 }
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_bounding_box_cache_valid, EDA_TEXT::m_shown_text, EDA_TEXT::m_shown_text_has_text_var_refs, EDA_TEXT::m_text, and UnescapeString().

Referenced by EDA_TEXT::EDA_TEXT(), EDA_TEXT::Replace(), and EDA_TEXT::SetText().

◆ CanAutoplace()

bool SCH_FIELD::CanAutoplace ( ) const

inline

Definition at line 161 of file sch_field.h.

161{ return m_allowAutoPlace; }

References m_allowAutoPlace.

Referenced by DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), AUTOPLACER::DoAutoplace(), and SCH_SEXPR_PLUGIN::saveField().

◆ CanConnect()

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

inlinevirtualinherited

Reimplemented in SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 344 of file sch_item.h.

344{ return m_layer == aItem->GetLayer(); }

SCH_ITEM::GetLayer

SCH_LAYER_ID GetLayer() const

Return the layer this item is on.

Definition: sch_item.h:246

SCH_ITEM::m_layer

SCH_LAYER_ID m_layer

Definition: sch_item.h:491

References SCH_ITEM::GetLayer(), and SCH_ITEM::m_layer.

Referenced by SCH_MOVE_TOOL::getConnectedDragItems().

◆ ClassOf()

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

inlinestatic

Definition at line 65 of file sch_field.h.

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

References SCH_FIELD_T, and EDA_ITEM::Type().

◆ ClearBoundingBoxCache()

void EDA_TEXT::ClearBoundingBoxCache ( )

virtualinherited

Definition at line 446 of file eda_text.cpp.

{
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::m_bounding_box_cache_valid.

Referenced by ClearCaches(), EESCHEMA_HELPERS::LoadSchematic(), SCH_EDIT_FRAME::RecomputeIntersheetRefs(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

119{ ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:141

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearCaches()

void SCH_FIELD::ClearCaches ( )

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 262 of file sch_field.cpp.

{
 ClearRenderCache();
 EDA_TEXT::ClearBoundingBoxCache();
}

References EDA_TEXT::ClearBoundingBoxCache(), and ClearRenderCache().

◆ ClearConnections()

void SCH_ITEM::ClearConnections ( )

inlineinherited

Clears all of the connection items from the list.

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

Definition at line 372 of file sch_item.h.

372{ m_connections.clear(); }

SCH_ITEM::m_connections

EDA_ITEMS m_connections

Definition: sch_item.h:492

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 158 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

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

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

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )

inlineinherited

Definition at line 427 of file sch_item.h.

427{ m_fieldsAutoplaced = FIELDS_AUTOPLACED_NO; }

SCH_ITEM::m_fieldsAutoplaced

FIELDS_AUTOPLACED m_fieldsAutoplaced

Definition: sch_item.h:493

FIELDS_AUTOPLACED_NO

@ FIELDS_AUTOPLACED_NO

Definition: sch_item.h:56

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 141 of file eda_item.h.

141{ m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:498

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), BOARD_COMMIT::dirtyIntersectingZones(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Init(), EE_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetIsShownAsBitmap(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearRenderCache()

void SCH_FIELD::ClearRenderCache ( )

overridevirtual

Reimplemented from EDA_TEXT.

Definition at line 269 of file sch_field.cpp.

{
 EDA_TEXT::ClearRenderCache();
 m_renderCacheValid = false;
}

References EDA_TEXT::ClearRenderCache(), and m_renderCacheValid.

Referenced by ClearCaches().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

118{ ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Item was manually selected by the user.

Definition: eda_item_flags.h:47

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 153 of file eda_item.h.

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

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

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

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * SCH_FIELD::Clone ( ) const

overridevirtual

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

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

Returns: A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 132 of file sch_field.cpp.

{
 return new SCH_FIELD( *this );
}

References SCH_FIELD().

◆ Compare()

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

inherited

Definition at line 913 of file eda_text.cpp.

{
#define EPSILON 2 // Should be enough for rounding errors on calculated items
 
#define TEST( a, b ) { if( a != b ) return a - b; }
#define TEST_E( a, b ) { if( abs( a - b ) > EPSILON ) return a - b; }
#define TEST_PT( a, b ) { TEST_E( a.x, b.x ); TEST_E( a.y, b.y ); }
 
 TEST_PT( m_pos, aOther->m_pos );
 
 TEST_PT( m_attributes.m_Size, aOther->m_attributes.m_Size );
 TEST_E( m_attributes.m_StrokeWidth, aOther->m_attributes.m_StrokeWidth );
 TEST( m_attributes.m_Angle.AsDegrees(), aOther->m_attributes.m_Angle.AsDegrees() );
 TEST( m_attributes.m_LineSpacing, aOther->m_attributes.m_LineSpacing );
 
 TEST( m_attributes.m_Halign, aOther->m_attributes.m_Halign );
 TEST( m_attributes.m_Valign, aOther->m_attributes.m_Valign );
 TEST( m_attributes.m_Italic, aOther->m_attributes.m_Italic );
 TEST( m_attributes.m_Bold, aOther->m_attributes.m_Bold );
 TEST( m_attributes.m_Underlined, aOther->m_attributes.m_Underlined );
 TEST( m_attributes.m_Visible, aOther->m_attributes.m_Visible );
 TEST( m_attributes.m_Mirrored, aOther->m_attributes.m_Mirrored );
 TEST( m_attributes.m_Multiline, aOther->m_attributes.m_Multiline );
 TEST( m_attributes.m_KeepUpright, aOther->m_attributes.m_KeepUpright );
 
 int val = GetFontName().Cmp( aOther->GetFontName() );
 
 if( val != 0 )
 return val;
 
 return m_text.Cmp( aOther->m_text );
}

◆ ConnectedItems()

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

inherited

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

Definition at line 187 of file sch_item.cpp.

{
 return m_connected_items[ aSheet ];
}

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE::FindWireSegmentNetNameRecursive(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ Connection()

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

inherited

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

Note: The returned value can be nullptr.

Definition at line 146 of file sch_item.cpp.

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

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

Referenced by CONNECTION_SUBGRAPH::Absorb(), CONNECTION_SUBGRAPH::AddItem(), CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::GetBusesNeedingMigration(), SCH_ITEM::GetEffectiveNetClass(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), SCH_ITEM::GetOrInitConnection(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_TEXT::Plot(), SCH_LABEL_BASE::Print(), NETLIST_EXPORTER_SPICE_MODEL::readPorts(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_LABEL_BASE::ResolveTextVar(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), BUS_UNFOLD_MENU::update(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ ConnectionPropagatesTo()

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

inlinevirtualinherited

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

Reimplemented in SCH_BUS_WIRE_ENTRY, SCH_LINE, and SCH_PIN.

Definition at line 411 of file sch_item.h.

411{ return true; }

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT & aSrc )

inherited

Definition at line 176 of file eda_text.cpp.

{
 m_text = aSrc.m_text;
 m_shown_text = aSrc.m_shown_text;
 m_shown_text_has_text_var_refs = aSrc.m_shown_text_has_text_var_refs;
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_bounding_box_cache_valid, EDA_TEXT::m_shown_text, EDA_TEXT::m_shown_text_has_text_var_refs, and EDA_TEXT::m_text.

Referenced by LIB_FIELD::Copy(), and CLIPBOARD_IO::SaveSelection().

◆ DoHypertextAction()

void SCH_FIELD::DoHypertextAction ( EDA_DRAW_FRAME * aFrame ) const

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 765 of file sch_field.cpp.

{
 constexpr int START_ID = 1;
 
 if( IsHypertext() )
 {
 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( m_parent );
 std::vector<std::pair<wxString, wxString>> pages;
 wxMenu menu;
 wxString href;
 
 label->GetIntersheetRefs( &pages );
 
 for( int i = 0; i < (int) pages.size(); ++i )
 {
 menu.Append( i + START_ID, wxString::Format( _( "Go to Page %s (%s)" ),
 pages[i].first,
 pages[i].second ) );
 }
 
 menu.AppendSeparator();
 menu.Append( 999 + START_ID, _( "Back to Previous Selected Sheet" ) );
 
 int sel = aFrame->GetPopupMenuSelectionFromUser( menu ) - START_ID;
 
 if( sel >= 0 && sel < (int) pages.size() )
 href = wxT( "#" ) + pages[ sel ].first;
 else if( sel == 999 )
 href = SCH_NAVIGATE_TOOL::g_BackLink;
 
 if( !href.IsEmpty() )
 {
 SCH_NAVIGATE_TOOL* navTool = aFrame->GetToolManager()->GetTool<SCH_NAVIGATE_TOOL>();
 navTool->HypertextCommand( href );
 }
 }
}

References _, Format(), SCH_NAVIGATE_TOOL::g_BackLink, SCH_LABEL_BASE::GetIntersheetRefs(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), SCH_NAVIGATE_TOOL::HypertextCommand(), IsHypertext(), and EDA_ITEM::m_parent.

◆ doIsConnected()

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

inlineprivatevirtualinherited

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 in SCH_BUS_ENTRY_BASE, SCH_JUNCTION, SCH_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_NO_CONNECT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 488 of file sch_item.h.

488{ return false; }

Referenced by SCH_ITEM::IsConnected().

◆ Duplicate()

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

inherited

Routine to create a new copy of given item.

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

Parameters

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

Definition at line 93 of file sch_item.cpp.

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

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

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

◆ Empty()

void EDA_TEXT::Empty ( )

inherited

Definition at line 402 of file eda_text.cpp.

{
 m_text.Empty();
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_bounding_box_cache_valid, and EDA_TEXT::m_text.

Referenced by SCH_LEGACY_PLUGIN_CACHE::LoadPart().

◆ Format()

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

virtualinherited

Output the object to aFormatter in s-expression form.

Parameters

aFormatter	The OUTPUTFORMATTER object to write to.
aNestLevel	The indentation next level.
aControlBits	The control bit definition for object specific formatting.

Exceptions

IO_ERROR on write error.

Definition at line 783 of file eda_text.cpp.

{
 aFormatter->Print( aNestLevel + 1, "(effects" );
 
 aFormatter->Print( 0, " (font" );
 
 if( GetFont() && !GetFont()->GetName().IsEmpty() )
 aFormatter->Print( 0, " (face \"%s\")", GetFont()->NameAsToken() );
 
 // Text size
 aFormatter->Print( 0, " (size %s %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( m_IuScale, GetTextHeight() ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( m_IuScale, GetTextWidth() ).c_str() );
 
 if( GetLineSpacing() != 1.0 )
 {
 aFormatter->Print( 0, " (line_spacing %s)",
 FormatDouble2Str( GetLineSpacing() ).c_str() );
 }
 
 if( GetTextThickness() )
 {
 aFormatter->Print( 0, " (thickness %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( m_IuScale, GetTextThickness() ).c_str() );
 }
 
 if( IsBold() )
 aFormatter->Print( 0, " bold" );
 
 if( IsItalic() )
 aFormatter->Print( 0, " italic" );
 
 if( GetTextColor() != COLOR4D::UNSPECIFIED )
 {
 aFormatter->Print( 0, " (color %d %d %d %s)",
 KiROUND( GetTextColor().r * 255.0 ),
 KiROUND( GetTextColor().g * 255.0 ),
 KiROUND( GetTextColor().b * 255.0 ),
 FormatDouble2Str( GetTextColor().a ).c_str() );
 }
 
 aFormatter->Print( 0, ")"); // (font
 
 if( IsMirrored() || GetHorizJustify() != GR_TEXT_H_ALIGN_CENTER
 || GetVertJustify() != GR_TEXT_V_ALIGN_CENTER )
 {
 aFormatter->Print( 0, " (justify");
 
 if( GetHorizJustify() != GR_TEXT_H_ALIGN_CENTER )
 aFormatter->Print( 0, GetHorizJustify() == GR_TEXT_H_ALIGN_LEFT ? " left" : " right" );
 
 if( GetVertJustify() != GR_TEXT_V_ALIGN_CENTER )
 aFormatter->Print( 0, GetVertJustify() == GR_TEXT_V_ALIGN_TOP ? " top" : " bottom" );
 
 if( IsMirrored() )
 aFormatter->Print( 0, " mirror" );
 
 aFormatter->Print( 0, ")" ); // (justify
 }
 
 if( !( aControlBits & CTL_OMIT_HIDE ) && !IsVisible() )
 aFormatter->Print( 0, " hide" );
 
 if( HasHyperlink() )
 {
 aFormatter->Print( 0, " (href %s)", aFormatter->Quotew( GetHyperlink() ).c_str() );
 }
 
 aFormatter->Print( 0, ")\n" ); // (effects
}

References CTL_OMIT_HIDE, FormatDouble2Str(), EDA_UNIT_UTILS::FormatInternalUnits(), EDA_TEXT::GetFont(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetHyperlink(), EDA_TEXT::GetLineSpacing(), EDA_TEXT::GetTextColor(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), EDA_TEXT::GetVertJustify(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, EDA_TEXT::HasHyperlink(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsVisible(), KiROUND(), EDA_TEXT::m_IuScale, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Referenced by SCH_SEXPR_PLUGIN_CACHE::saveField(), and SCH_SEXPR_PLUGIN::saveField().

◆ Get() [1/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

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

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

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

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

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

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

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

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

◆ GetAttributes()

const TEXT_ATTRIBUTES & EDA_TEXT::GetAttributes ( ) const

inlineinherited

◆ GetBoundingBox()

const BOX2I SCH_FIELD::GetBoundingBox ( ) const

overridevirtual

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

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

Reimplemented from EDA_ITEM.

Definition at line 449 of file sch_field.cpp.

{
 // Calculate the text bounding box:
 BOX2I bbox = GetTextBox();
 
 // Calculate the bounding box position relative to the parent:
 VECTOR2I origin = GetParentPosition();
 VECTOR2I pos = GetTextPos() - origin;
 VECTOR2I begin = bbox.GetOrigin() - origin;
 VECTOR2I end = bbox.GetEnd() - origin;
 RotatePoint( begin, pos, GetTextAngle() );
 RotatePoint( end, pos, GetTextAngle() );
 
 // Now, apply the symbol transform (mirror/rot)
 TRANSFORM transform;
 
 if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
 {
 SCH_SYMBOL* parentSymbol = static_cast<SCH_SYMBOL*>( m_parent );
 
 // Due to the Y axis direction, we must mirror the bounding box,
 // relative to the text position:
 MIRROR( begin.y, pos.y );
 MIRROR( end.y, pos.y );
 
 transform = parentSymbol->GetTransform();
 }
 else
 {
 transform = TRANSFORM( 1, 0, 0, 1 ); // identity transform
 }
 
 bbox.SetOrigin( transform.TransformCoordinate( begin ) );
 bbox.SetEnd( transform.TransformCoordinate( end ) );
 
 bbox.Move( origin );
 bbox.Normalize();
 
 return bbox;
}

References BOX2< Vec >::GetEnd(), BOX2< Vec >::GetOrigin(), GetParentPosition(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextPos(), SCH_SYMBOL::GetTransform(), EDA_ITEM::m_parent, MIRROR(), BOX2< Vec >::Move(), BOX2< Vec >::Normalize(), RotatePoint(), SCH_SYMBOL_T, BOX2< Vec >::SetEnd(), BOX2< Vec >::SetOrigin(), TRANSFORM::TransformCoordinate(), EDA_ITEM::Type(), and VECTOR2< T >::y.

Referenced by KIGFX::SCH_PAINTER::draw(), AUTOPLACER::fieldVPlacement(), HitTest(), IsHorizJustifyFlipped(), IsVertJustifyFlipped(), Plot(), and Print().

◆ GetCanonicalName()

wxString SCH_FIELD::GetCanonicalName ( ) const

Get a non-language-specific name for a field which can be used for storage, variable look-up, etc.

Definition at line 836 of file sch_field.cpp.

{
 if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
 {
 switch( m_id )
 {
 case REFERENCE_FIELD: return wxT( "Reference" );
 case VALUE_FIELD: return wxT( "Value" );
 case FOOTPRINT_FIELD: return wxT( "Footprint" );
 case DATASHEET_FIELD: return wxT( "Datasheet" );
 default: return m_name;
 }
 }
 else if( m_parent && m_parent->Type() == SCH_SHEET_T )
 {
 switch( m_id )
 {
 case SHEETNAME: return wxT( "Sheetname" );
 case SHEETFILENAME: return wxT( "Sheetfile" );
 default: return m_name;
 }
 }
 else if( m_parent && m_parent->IsType( { SCH_LABEL_LOCATE_ANY_T } ) )
 {
 // These should be stored in canonical format, but just in case:
 if( m_name == _( "Net Class" ) || m_name == wxT( "Net Class" ) )
 return wxT( "Netclass" );
 else if( m_name == _( "Sheet References" )
 || m_name == wxT( "Sheet References" )
 || m_name == wxT( "Intersheet References" ) )
 return wxT( "Intersheetrefs" );
 else
 return m_name;
 }
 else
 {
 if( m_parent )
 {
 wxFAIL_MSG( wxString::Format( "Unhandled field owner type (id %d, parent type %d).",
 m_id, m_parent->Type() ) );
 }
 
 return m_name;
 }
}

References _, DATASHEET_FIELD, FOOTPRINT_FIELD, Format(), EDA_ITEM::IsType(), m_id, m_name, EDA_ITEM::m_parent, REFERENCE_FIELD, SCH_SHEET_T, SCH_SYMBOL_T, SHEETFILENAME, SHEETNAME, EDA_ITEM::Type(), and VALUE_FIELD.

Referenced by DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_SEXPR_PLUGIN::saveField(), and SetId().

◆ GetClass()

wxString SCH_FIELD::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 70 of file sch_field.h.

 {
 return wxT( "SCH_FIELD" );
 }

◆ GetConnectionPoints()

virtual std::vector< VECTOR2I > SCH_ITEM::GetConnectionPoints ( ) const

inlinevirtualinherited

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 in SCH_BUS_ENTRY_BASE, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 364 of file sch_item.h.

364{ return {}; }

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), EE_GRID_HELPER::computeAnchors(), SCH_EDIT_TOOL::DoDelete(), SCH_SCREEN::GetNeededJunctions(), SCH_MOVE_TOOL::Main(), SCH_EDITOR_CONTROL::Paste(), and SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires().

◆ GetDefaultFont()

const wxString & SCH_ITEM::GetDefaultFont ( ) const

inherited

Definition at line 286 of file sch_item.cpp.

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

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

Referenced by getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), GetRenderCache(), and SCH_TEXTBOX::GetShownText().

◆ getDrawFont()

KIFONT::FONT * SCH_FIELD::getDrawFont ( ) const

overrideprotectedvirtual

Reimplemented from EDA_TEXT.

Definition at line 251 of file sch_field.cpp.

{
 KIFONT::FONT* font = EDA_TEXT::GetFont();
 
 if( !font )
 font = KIFONT::FONT::GetFont( GetDefaultFont(), IsBold(), IsItalic() );
 
 return font;
}

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

◆ GetDrawPos()

virtual VECTOR2I EDA_TEXT::GetDrawPos ( ) const

inlinevirtualinherited

Reimplemented in LIB_TEXTBOX, SCH_TEXTBOX, FP_TEXTBOX, and PCB_TEXTBOX.

Definition at line 318 of file eda_text.h.

318{ return GetTextPos(); }

References EDA_TEXT::GetTextPos().

Referenced by BOARD_ADAPTER::addText(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT::GetEffectiveTextShape(), EDA_TEXT::GetLinePositions(), EDA_TEXT::GetRenderCache(), EDA_TEXT::GetTextBox(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), EDA_TEXT::Print(), EDA_TEXT::TextHitTest(), and EDA_TEXT::TransformBoundingBoxToPolygon().

◆ GetDrawRotation()

EDA_ANGLE SCH_FIELD::GetDrawRotation ( ) const

overridevirtual

Adjusters to allow EDA_TEXT to draw/print/etc.

text in absolute coords.

Reimplemented from EDA_TEXT.

Definition at line 427 of file sch_field.cpp.

{
 // Calculate the text orientation according to the symbol orientation.
 EDA_ANGLE orient = GetTextAngle();
 
 if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
 {
 SCH_SYMBOL* parentSymbol = static_cast<SCH_SYMBOL*>( m_parent );
 
 if( parentSymbol && parentSymbol->GetTransform().y1 ) // Rotate symbol 90 degrees.
 {
 if( orient.IsHorizontal() )
 orient = ANGLE_VERTICAL;
 else
 orient = ANGLE_HORIZONTAL;
 }
 }
 
 return orient;
}

References ANGLE_HORIZONTAL, ANGLE_VERTICAL, EDA_TEXT::GetTextAngle(), SCH_SYMBOL::GetTransform(), EDA_ANGLE::IsHorizontal(), EDA_ITEM::m_parent, SCH_SYMBOL_T, EDA_ITEM::Type(), and TRANSFORM::y1.

Referenced by IsHorizJustifyFlipped(), and IsVertJustifyFlipped().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 145 of file eda_item.h.

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

References IS_BROKEN, IS_CHANGED, IS_MOVING, IS_NEW, IS_PASTED, EDA_ITEM::m_flags, and STRUCT_DELETED.

◆ GetEffectiveHorizJustify()

GR_TEXT_H_ALIGN_T SCH_FIELD::GetEffectiveHorizJustify ( ) const

Definition at line 514 of file sch_field.cpp.

{
 switch( GetHorizJustify() )
 {
 case GR_TEXT_H_ALIGN_LEFT:
 return IsHorizJustifyFlipped() ? GR_TEXT_H_ALIGN_RIGHT : GR_TEXT_H_ALIGN_LEFT;
 case GR_TEXT_H_ALIGN_RIGHT:
 return IsHorizJustifyFlipped() ? GR_TEXT_H_ALIGN_LEFT : GR_TEXT_H_ALIGN_RIGHT;
 default:
 return GR_TEXT_H_ALIGN_CENTER;
 }
}

References EDA_TEXT::GetHorizJustify(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, and IsHorizJustifyFlipped().

Referenced by DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ GetEffectiveNetClass()

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

inherited

Definition at line 166 of file sch_item.cpp.

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

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

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

◆ GetEffectiveTextPenWidth()

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

inherited

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

Definition at line 299 of file eda_text.cpp.

{
 int penWidth = GetTextThickness();
 
 if( penWidth <= 1 )
 {
 penWidth = aDefaultPenWidth;
 
 if( IsBold() )
 penWidth = GetPenSizeForBold( GetTextWidth() );
 else if( penWidth <= 1 )
 penWidth = GetPenSizeForNormal( GetTextWidth() );
 }
 
 // Clip pen size for small texts:
 penWidth = Clamp_Text_PenSize( penWidth, GetTextSize() );
 
 return penWidth;
}

References Clamp_Text_PenSize(), GetPenSizeForBold(), GetPenSizeForNormal(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), and EDA_TEXT::IsBold().

Referenced by BOARD_ADAPTER::addText(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), SCH_LABEL_BASE::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), SCH_HIERLABEL::GetBodyBoundingBox(), FP_TEXT::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), EDA_TEXT::GetEffectiveTextShape(), LIB_FIELD::GetPenWidth(), LIB_TEXT::GetPenWidth(), GetPenWidth(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_TEXT::GetPenWidth(), EDA_TEXT::GetTextBox(), Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), Print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), EDA_TEXT::printOneLineOfText(), FP_TEXT::TransformTextToPolySet(), FP_TEXTBOX::TransformTextToPolySet(), PCB_TEXT::TransformTextToPolySet(), PCB_TEXTBOX::TransformTextToPolySet(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ GetEffectiveTextShape()

std::shared_ptr< SHAPE_COMPOUND > EDA_TEXT::GetEffectiveTextShape	(	bool	aTriangulate = `true`,
		bool	aUseTextRotation = `true`
	)		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 855 of file eda_text.cpp.

{
 std::shared_ptr<SHAPE_COMPOUND> shape = std::make_shared<SHAPE_COMPOUND>();
 KIGFX::GAL_DISPLAY_OPTIONS empty_opts;
 KIFONT::FONT* font = getDrawFont();
 int penWidth = GetEffectiveTextPenWidth();
 TEXT_ATTRIBUTES attrs = GetAttributes();
 
 if( aUseTextRotation )
 attrs.m_Angle = GetDrawRotation();
 else
 attrs.m_Angle = ANGLE_0;
 
 if( aTriangulate )
 {
 CALLBACK_GAL callback_gal(
 empty_opts,
 // Stroke callback
 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
 {
 shape->AddShape( new SHAPE_SEGMENT( aPt1, aPt2, penWidth ) );
 },
 // Triangulation callback
 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2, const VECTOR2I& aPt3 )
 {
 SHAPE_SIMPLE* triShape = new SHAPE_SIMPLE;
 
 for( const VECTOR2I& point : { aPt1, aPt2, aPt3 } )
 triShape->Append( point.x, point.y );
 
 shape->AddShape( triShape );
 } );
 
 font->Draw( &callback_gal, GetShownText(), GetDrawPos(), attrs );
 }
 else
 {
 CALLBACK_GAL callback_gal(
 empty_opts,
 // Stroke callback
 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
 {
 shape->AddShape( new SHAPE_SEGMENT( aPt1, aPt2, penWidth ) );
 },
 // Outline callback
 [&]( const SHAPE_LINE_CHAIN& aPoly )
 {
 shape->AddShape( aPoly.Clone() );
 } );
 
 font->Draw( &callback_gal, GetShownText(), GetDrawPos(), attrs );
 }
 
 return shape;
}

References ANGLE_0, SHAPE_SIMPLE::Append(), KIFONT::FONT::Draw(), EDA_TEXT::GetAttributes(), EDA_TEXT::getDrawFont(), EDA_TEXT::GetDrawPos(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetShownText(), and TEXT_ATTRIBUTES::m_Angle.

Referenced by PCB_DIMENSION_BASE::GetEffectiveShape(), FP_TEXT::GetEffectiveShape(), FP_TEXTBOX::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), PCB_TEXTBOX::GetEffectiveShape(), PCB_SELECTION_TOOL::hitTestDistance(), PNS_KICAD_IFACE_BASE::syncTextItem(), and EDA_TEXT::TransformBoundingBoxToPolygon().

◆ GetEffectiveVertJustify()

GR_TEXT_V_ALIGN_T SCH_FIELD::GetEffectiveVertJustify ( ) const

Definition at line 551 of file sch_field.cpp.

{
 switch( GetVertJustify() )
 {
 case GR_TEXT_V_ALIGN_TOP:
 return IsVertJustifyFlipped() ? GR_TEXT_V_ALIGN_BOTTOM : GR_TEXT_V_ALIGN_TOP;
 case GR_TEXT_V_ALIGN_BOTTOM:
 return IsVertJustifyFlipped() ? GR_TEXT_V_ALIGN_TOP : GR_TEXT_V_ALIGN_BOTTOM;
 default:
 return GR_TEXT_V_ALIGN_CENTER;
 }
}

References EDA_TEXT::GetVertJustify(), GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, and IsVertJustifyFlipped().

Referenced by DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ GetEndPoints()

virtual void SCH_ITEM::GetEndPoints ( std::vector< DANGLING_END_ITEM > & aItemList )

inlinevirtualinherited

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 in SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_SHEET, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 318 of file sch_item.h.

318{}

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems().

◆ GetFieldColor()

COLOR4D SCH_FIELD::GetFieldColor ( ) const

Definition at line 407 of file sch_field.cpp.

{
 if( GetTextColor() != COLOR4D::UNSPECIFIED )
 {
 m_lastResolvedColor = GetTextColor();
 }
 else
 {
 SCH_LABEL_BASE* parentLabel = dynamic_cast<SCH_LABEL_BASE*>( GetParent() );
 
 if( parentLabel && !parentLabel->IsConnectivityDirty() )
 m_lastResolvedColor = parentLabel->GetEffectiveNetClass()->GetSchematicColor();
 else
 m_lastResolvedColor = GetTextColor();
 }
 
 return m_lastResolvedColor;
}

References SCH_ITEM::GetEffectiveNetClass(), EDA_ITEM::GetParent(), EDA_TEXT::GetTextColor(), SCH_ITEM::IsConnectivityDirty(), and m_lastResolvedColor.

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const

inlineinherited

Return whether the fields have been automatically placed.

Definition at line 424 of file sch_item.h.

424{ return m_fieldsAutoplaced; }

References SCH_ITEM::m_fieldsAutoplaced.

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

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

142{ return m_flags; }

References EDA_ITEM::m_flags.

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

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 256 of file eda_item.h.

256{ return GetPosition(); }

EDA_ITEM::GetPosition

virtual VECTOR2I GetPosition() const

Definition: eda_item.h:249

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetFont()

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

inlineinherited

Definition at line 188 of file eda_text.h.

188{ return m_attributes.m_Font; }

TEXT_ATTRIBUTES::m_Font

KIFONT::FONT * m_Font

Definition: text_attributes.h:66

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Font.

Referenced by BOARD_ADAPTER::addText(), SCH_EDIT_TOOL::ChangeTextType(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), PCB_PLUGIN::format(), EDA_TEXT::Format(), PCB_PLUGIN::formatRenderCache(), EDA_TEXT::getDrawFont(), LIB_FIELD::getDrawFont(), LIB_TEXT::getDrawFont(), LIB_TEXTBOX::getDrawFont(), getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), KIGFX::SCH_PAINTER::getFont(), EDA_TEXT::GetFontName(), LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), GetRenderCache(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), Print(), LIB_FIELD::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ GetFontName()

wxString EDA_TEXT::GetFontName ( ) const

inherited

Definition at line 759 of file eda_text.cpp.

{
 if( GetFont() )
 return GetFont()->GetName();
 else
 return wxEmptyString;
}

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

Referenced by EDA_TEXT::Compare(), EDA_TEXT::IsDefaultFormatting(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, PCB_TRACK, and ZONE.

Definition at line 310 of file eda_item.cpp.

{
 return GetTypeDesc();
}

References EDA_ITEM::GetTypeDesc().

Referenced by PROPERTIES_PANEL::rebuildProperties().

◆ GetHorizJustify()

GR_TEXT_H_ALIGN_T EDA_TEXT::GetHorizJustify ( ) const

inlineinherited

Definition at line 149 of file eda_text.h.

149{ return m_attributes.m_Halign; };

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Halign.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), LIB_TEXTBOX::compare(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), AUTOPLACER::fieldHPlacement(), EDA_TEXT::Format(), LIB_TEXTBOX::GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), FP_TEXTBOX::GetDrawPos(), PCB_TEXTBOX::GetDrawPos(), GetEffectiveHorizJustify(), LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), GetMsgPanelInfo(), EDA_TEXT::GetTextBox(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), IsHorizJustifyFlipped(), FP_TEXT::KeepUpright(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EDIT_TOOL::Mirror(), FP_TEXT::Mirror(), PCB_TEXT::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXTBOX::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), LIB_TEXT::MirrorVertical(), LIB_TEXTBOX::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), LIB_TEXT::NormalizeJustification(), Plot(), positioningChanged(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), LIB_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), textsNeedUpdate(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ GetHyperlink()

wxString EDA_TEXT::GetHyperlink ( ) const

inlineinherited

Definition at line 334 of file eda_text.h.

334{ return m_hyperlink; }

EDA_TEXT::m_hyperlink

wxString m_hyperlink

A hyperlink URL.

Definition: eda_text.h:386

References EDA_TEXT::m_hyperlink.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GetId()

int SCH_FIELD::GetId ( ) const

inline

Definition at line 125 of file sch_field.h.

125{ return m_id; }

References m_id.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_EDIT_TOOL::editFieldText(), getInferredSymbols(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), operator<(), SCH_SEXPR_PARSER::parseSchematicSymbol(), SCH_SEXPR_PARSER::parseSheet(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN::saveField(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ GetInterline()

int EDA_TEXT::GetInterline ( ) 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 499 of file eda_text.cpp.

{
 return KiROUND( getDrawFont()->GetInterline( GetTextHeight() ) );
}

References EDA_TEXT::getDrawFont(), EDA_TEXT::GetInterline(), EDA_TEXT::GetTextHeight(), and KiROUND().

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

◆ GetInternalName()

const wxString & SCH_FIELD::GetInternalName ( )

inline

Get the initial name of the field set at creation (or set by SetName()).

This is the raw field name with no translation and no change.

Definition at line 123 of file sch_field.h.

123{ return m_name; }

References m_name.

Referenced by SCH_SEXPR_PARSER::parseSchText(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

◆ GetItemDescription()

wxString SCH_FIELD::GetItemDescription ( UNITS_PROVIDER * aUnitsProvider ) 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.

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 722 of file sch_field.cpp.

{
 return wxString::Format( "%s '%s'", GetName(), KIUI::EllipsizeMenuText( GetShownText() ) );
}

References KIUI::EllipsizeMenuText(), Format(), GetName(), and GetShownText().

◆ GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 246 of file sch_item.h.

246{ return m_layer; }

References SCH_ITEM::m_layer.

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

◆ GetLibPosition()

VECTOR2I SCH_FIELD::GetLibPosition ( ) const

inline

Definition at line 226 of file sch_field.h.

226{ return EDA_TEXT::GetTextPos(); }

References EDA_TEXT::GetTextPos().

Referenced by operator<(), and SCH_LEGACY_PLUGIN::saveField().

◆ GetLinePositions()

void EDA_TEXT::GetLinePositions	(	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 673 of file eda_text.cpp.

{
 VECTOR2I pos = GetDrawPos(); // Position of first line of the multiline text according
 // to the center of the multiline text block
 
 VECTOR2I offset; // Offset to next line.
 
 offset.y = GetInterline();
 
 if( aLineCount > 1 )
 {
 switch( GetVertJustify() )
 {
 case GR_TEXT_V_ALIGN_TOP:
 break;
 
 case GR_TEXT_V_ALIGN_CENTER:
 pos.y -= ( aLineCount - 1 ) * offset.y / 2;
 break;
 
 case GR_TEXT_V_ALIGN_BOTTOM:
 pos.y -= ( aLineCount - 1 ) * offset.y;
 break;
 }
 }
 
 // Rotate the position of the first line around the center of the multiline text block
 RotatePoint( pos, GetDrawPos(), GetDrawRotation() );
 
 // Rotate the offset lines to increase happened in the right direction
 RotatePoint( offset, GetDrawRotation() );
 
 for( int ii = 0; ii < aLineCount; ii++ )
 {
 aPositions.push_back( (VECTOR2I) pos );
 pos += offset;
 }
}

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

Referenced by SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), and EDA_TEXT::Print().

◆ GetLineSpacing()

double EDA_TEXT::GetLineSpacing ( ) const

inlineinherited

Definition at line 193 of file eda_text.h.

193{ return m_attributes.m_LineSpacing; }

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_LineSpacing.

Referenced by EDA_TEXT::Format().

◆ GetMenuImage()

BITMAPS SCH_FIELD::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 883 of file sch_field.cpp.

{
 if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
 {
 switch( m_id )
 {
 case REFERENCE_FIELD: return BITMAPS::edit_comp_ref;
 case VALUE_FIELD: return BITMAPS::edit_comp_value;
 case FOOTPRINT_FIELD: return BITMAPS::edit_comp_footprint;
 default: return BITMAPS::text;
 }
 }
 
 return BITMAPS::text;
}

References edit_comp_footprint, edit_comp_ref, edit_comp_value, FOOTPRINT_FIELD, m_id, EDA_ITEM::m_parent, REFERENCE_FIELD, SCH_SYMBOL_T, text, EDA_ITEM::Type(), and VALUE_FIELD.

◆ GetMsgPanelInfo()

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

overridevirtual

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

Parameters

aList is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 728 of file sch_field.cpp.

{
 wxString msg;
 
 aList.emplace_back( _( "Symbol Field" ), GetName() );
 
 // Don't use GetShownText() here; we want to show the user the variable references
 aList.emplace_back( _( "Text" ), UnescapeString( GetText() ) );
 
 aList.emplace_back( _( "Visible" ), IsVisible() ? _( "Yes" ) : _( "No" ) );
 
 aList.emplace_back( _( "Font" ), GetFont() ? GetFont()->GetName() : _( "Default" ) );
 
 aList.emplace_back( _( "Style" ), GetTextStyleName() );
 
 aList.emplace_back( _( "Text Size" ), aFrame->MessageTextFromValue( GetTextWidth() ) );
 
 switch ( GetHorizJustify() )
 {
 case GR_TEXT_H_ALIGN_LEFT: msg = _( "Left" ); break;
 case GR_TEXT_H_ALIGN_CENTER: msg = _( "Center" ); break;
 case GR_TEXT_H_ALIGN_RIGHT: msg = _( "Right" ); break;
 }
 
 aList.emplace_back( _( "H Justification" ), msg );
 
 switch ( GetVertJustify() )
 {
 case GR_TEXT_V_ALIGN_TOP: msg = _( "Top" ); break;
 case GR_TEXT_V_ALIGN_CENTER: msg = _( "Center" ); break;
 case GR_TEXT_V_ALIGN_BOTTOM: msg = _( "Bottom" ); break;
 }
 
 aList.emplace_back( _( "V Justification" ), msg );
}

References _, EDA_TEXT::GetFont(), EDA_TEXT::GetHorizJustify(), GetName(), EDA_TEXT::GetText(), EDA_TEXT::GetTextStyleName(), EDA_TEXT::GetTextWidth(), EDA_TEXT::GetVertJustify(), 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, EDA_TEXT::IsVisible(), UNITS_PROVIDER::MessageTextFromValue(), and UnescapeString().

◆ GetName()

wxString SCH_FIELD::GetName ( bool aUseDefaultName = true ) const

Return the field name (not translated).

Parameters

aUseDefaultName When true return the default field name if the field name is empty. Otherwise the default field name is returned.

Returns: the name of the field.

Definition at line 804 of file sch_field.cpp.

{
 if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
 {
 if( m_id >= 0 && m_id < MANDATORY_FIELDS )
 return TEMPLATE_FIELDNAME::GetDefaultFieldName( m_id );
 else if( m_name.IsEmpty() && aUseDefaultName )
 return TEMPLATE_FIELDNAME::GetDefaultFieldName( m_id );
 else
 return m_name;
 }
 else if( m_parent && m_parent->Type() == SCH_SHEET_T )
 {
 if( m_id >= 0 && m_id < SHEET_MANDATORY_FIELDS )
 return SCH_SHEET::GetDefaultFieldName( m_id );
 else if( m_name.IsEmpty() && aUseDefaultName )
 return SCH_SHEET::GetDefaultFieldName( m_id );
 else
 return m_name;
 }
 else if( m_parent && m_parent->IsType( { SCH_LABEL_LOCATE_ANY_T } ) )
 {
 return SCH_LABEL_BASE::GetDefaultFieldName( m_name, aUseDefaultName );
 }
 else
 {
 wxFAIL_MSG( "Unhandled field owner type." );
 return m_name;
 }
}

References SCH_LABEL_BASE::GetDefaultFieldName(), SCH_SHEET::GetDefaultFieldName(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), EDA_ITEM::IsType(), m_id, m_name, EDA_ITEM::m_parent, MANDATORY_FIELDS, SCH_SHEET_T, SCH_SYMBOL_T, SHEET_MANDATORY_FIELDS, and EDA_ITEM::Type().

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_EDIT_TOOL::editFieldText(), GetItemDescription(), GetMsgPanelInfo(), GetShownText(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), DIALOG_SYMBOL_PROPERTIES::OnEditSpiceModel(), operator<(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_SYMBOL::RemoveField(), SCH_LEGACY_PLUGIN::saveField(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::Validate(), DIALOG_SYMBOL_PROPERTIES::Validate(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetOrInitConnection()

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

inherited

Definition at line 228 of file sch_item.cpp.

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

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

◆ GetParent()

EDA_ITEM * EDA_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 99 of file eda_item.h.

99{ return m_parent; }

References EDA_ITEM::m_parent.

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

◆ GetParentPosition()

VECTOR2I SCH_FIELD::GetParentPosition ( ) const

Definition at line 1084 of file sch_field.cpp.

{
 return m_parent ? m_parent->GetPosition() : VECTOR2I( 0, 0 );
}

References EDA_ITEM::GetPosition(), and EDA_ITEM::m_parent.

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

◆ GetPenWidth()

int SCH_FIELD::GetPenWidth ( ) const

overridevirtual

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

Reimplemented from SCH_ITEM.

Definition at line 245 of file sch_field.cpp.

{
 return GetEffectiveTextPenWidth();
}

References EDA_TEXT::GetEffectiveTextPenWidth().

◆ GetPosition()

VECTOR2I SCH_FIELD::GetPosition ( ) const

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 1068 of file sch_field.cpp.

{
 if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
 {
 SCH_SYMBOL* parentSymbol = static_cast<SCH_SYMBOL*>( m_parent );
 VECTOR2I relativePos = GetTextPos() - parentSymbol->GetPosition();
 
 relativePos = parentSymbol->GetTransform().TransformCoordinate( relativePos );
 
 return relativePos + parentSymbol->GetPosition();
 }
 
 return GetTextPos();
}

References SCH_SYMBOL::GetPosition(), EDA_TEXT::GetTextPos(), SCH_SYMBOL::GetTransform(), EDA_ITEM::m_parent, SCH_SYMBOL_T, TRANSFORM::TransformCoordinate(), and EDA_ITEM::Type().

Referenced by DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), IsHorizJustifyFlipped(), IsVertJustifyFlipped(), SCH_EAGLE_PLUGIN::loadInstance(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), positioningChanged(), DIALOG_CHANGE_SYMBOLS::processSymbols(), Rotate(), SCH_SEXPR_PLUGIN::saveField(), SCH_SHEET_PATH::UpdateAllScreenReferences(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ GetRenderCache() [1/2]

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

inherited

Definition at line 453 of file eda_text.cpp.

{
 if( getDrawFont()->IsOutline() )
 {
 EDA_ANGLE resolvedAngle = GetDrawRotation();
 
 if( m_render_cache.empty()
 || m_render_cache_text != forResolvedText
 || m_render_cache_angle != resolvedAngle
 || m_render_cache_offset != aOffset )
 {
 m_render_cache.clear();
 
 KIFONT::OUTLINE_FONT* font = static_cast<KIFONT::OUTLINE_FONT*>( getDrawFont() );
 TEXT_ATTRIBUTES attrs = GetAttributes();
 
 attrs.m_Angle = resolvedAngle;
 
 font->GetLinesAsGlyphs( &m_render_cache, GetShownText(), GetDrawPos() + aOffset, attrs );
 m_render_cache_angle = resolvedAngle;
 m_render_cache_text = forResolvedText;
 m_render_cache_offset = aOffset;
 }
 
 return &m_render_cache;
 }
 
 return nullptr;
}

References EDA_TEXT::GetAttributes(), EDA_TEXT::getDrawFont(), EDA_TEXT::GetDrawPos(), EDA_TEXT::GetDrawRotation(), KIFONT::OUTLINE_FONT::GetLinesAsGlyphs(), EDA_TEXT::GetShownText(), TEXT_ATTRIBUTES::m_Angle, EDA_TEXT::m_render_cache, EDA_TEXT::m_render_cache_angle, EDA_TEXT::m_render_cache_offset, and EDA_TEXT::m_render_cache_text.

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

◆ GetRenderCache() [2/2]

std::vector< std::unique_ptr< KIFONT::GLYPH > > * SCH_FIELD::GetRenderCache	(	const wxString &	forResolvedText,
		const VECTOR2I &	forPosition,
		TEXT_ATTRIBUTES &	aAttrs
	)		const

Definition at line 277 of file sch_field.cpp.

{
 KIFONT::FONT* font = GetFont();
 
 if( !font )
 font = KIFONT::FONT::GetFont( GetDefaultFont(), IsBold(), IsItalic() );
 
 if( font->IsOutline() )
 {
 KIFONT::OUTLINE_FONT* outlineFont = static_cast<KIFONT::OUTLINE_FONT*>( font );
 
 if( m_renderCache.empty() || !m_renderCacheValid )
 {
 m_renderCache.clear();
 
 outlineFont->GetLinesAsGlyphs( &m_renderCache, forResolvedText, forPosition, aAttrs );
 
 m_renderCachePos = forPosition;
 m_renderCacheValid = true;
 }
 
 if( m_renderCachePos != forPosition )
 {
 VECTOR2I delta = forPosition - m_renderCachePos;
 
 for( std::unique_ptr<KIFONT::GLYPH>& glyph : m_renderCache )
 static_cast<KIFONT::OUTLINE_GLYPH*>( glyph.get() )->Move( delta );
 
 m_renderCachePos = forPosition;
 }
 
 return &m_renderCache;
 }
 
 return nullptr;
}

References delta, SCH_ITEM::GetDefaultFont(), EDA_TEXT::GetFont(), KIFONT::FONT::GetFont(), KIFONT::OUTLINE_FONT::GetLinesAsGlyphs(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), KIFONT::FONT::IsOutline(), m_renderCache, m_renderCachePos, m_renderCacheValid, and Move().

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

◆ GetShownText()

wxString SCH_FIELD::GetShownText	(	int	aDepth = `0`,
		bool	aAllowExtraText = `true`
	)		const

overridevirtual

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

Parameters

aDepth	is used to prevent infinite recursions and loops when expanding text variables.
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).

Reimplemented from EDA_TEXT.

Definition at line 175 of file sch_field.cpp.

{
 std::function<bool( wxString* )> symbolResolver =
 [&]( wxString* token ) -> bool
 {
 return static_cast<SCH_SYMBOL*>( m_parent )->ResolveTextVar( token, aDepth + 1 );
 };
 
 std::function<bool( wxString* )> sheetResolver =
 [&]( wxString* token ) -> bool
 {
 return static_cast<SCH_SHEET*>( m_parent )->ResolveTextVar( token, aDepth + 1 );
 };
 
 std::function<bool( wxString* )> labelResolver =
 [&]( wxString* token ) -> bool
 {
 return static_cast<SCH_LABEL_BASE*>( m_parent )->ResolveTextVar( token,
 aDepth + 1 );
 };
 
 wxString text = EDA_TEXT::GetShownText();
 
 if( IsNameShown() )
 text = GetName() << wxS( ": " ) << text;
 
 if( text == wxS( "~" ) ) // Legacy placeholder for empty string
 {
 text = wxS( "" );
 }
 else if( HasTextVars() )
 {
 if( aDepth < 10 )
 {
 if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
 text = ExpandTextVars( text, &symbolResolver );
 else if( m_parent && m_parent->Type() == SCH_SHEET_T )
 text = ExpandTextVars( text, &sheetResolver );
 else if( m_parent && m_parent->IsType( { SCH_LABEL_LOCATE_ANY_T } ) )
 text = ExpandTextVars( text, &labelResolver );
 else if( Schematic() )
 text = ExpandTextVars( text, &Schematic()->Prj() );
 }
 }
 
 // WARNING: the IDs of FIELDS and SHEETS overlap, so one must check *both* the
 // id and the parent's type.
 
 if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
 {
 SCH_SYMBOL* parentSymbol = static_cast<SCH_SYMBOL*>( m_parent );
 
 if( m_id == REFERENCE_FIELD )
 {
 // For more than one part per package, we must add the part selection
 // A, B, ... or 1, 2, .. to the reference.
 if( parentSymbol->GetUnitCount() > 1 )
 text << LIB_SYMBOL::SubReference( parentSymbol->GetUnit() );
 }
 }
 else if( m_parent && m_parent->Type() == SCH_SHEET_T )
 {
 if( m_id == SHEETFILENAME && aAllowExtraText )
 text = _( "File:" ) + wxS( " " )+ text;
 }
 
 return text;
}

References _, ExpandTextVars(), GetName(), EDA_TEXT::GetShownText(), SCH_SYMBOL::GetUnit(), SCH_SYMBOL::GetUnitCount(), EDA_TEXT::HasTextVars(), IsNameShown(), EDA_ITEM::IsType(), m_id, EDA_ITEM::m_parent, Prj(), REFERENCE_FIELD, SCH_SHEET_T, SCH_SYMBOL_T, SCH_ITEM::Schematic(), SHEETFILENAME, LIB_SYMBOL::SubReference(), text, and EDA_ITEM::Type().

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), KIGFX::SCH_PAINTER::draw(), SCH_SYMBOL::GetFootprintFieldText(), GetItemDescription(), SCH_SYMBOL::GetValueFieldText(), HitTest(), Matches(), DIALOG_SHEET_PROPERTIES::OnUpdateUI(), Plot(), Print(), and EE_INSPECTION_TOOL::ShowDatasheet().

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

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

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

Returns: X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 265 of file eda_item.h.

265{ return GetPosition(); }

References EDA_ITEM::GetPosition().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 123 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 136 of file eda_item.h.

136{ return m_status; }

References EDA_ITEM::m_status.

◆ GetStoredPos()

VECTOR2I & SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 209 of file sch_item.h.

209{ return m_storedPos; }

SCH_ITEM::m_storedPos

VECTOR2I m_storedPos

Definition: sch_item.h:494

References SCH_ITEM::m_storedPos.

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 457 of file sch_item.h.

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

STROKE_PARAMS

Simple container to manage line stroke parameters.

Definition: stroke_params.h:88

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ 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 87 of file eda_text.h.

87{ return m_text; }

References EDA_TEXT::m_text.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_SHEET_PATH::AddNewSymbolInstances(), NETLIST_EXPORTER_XML::addSymbolFields(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_FRAME::AutoRotateItem(), EE_SELECTION_TOOL::autostartEvent(), CONNECTION_GRAPH::buildConnectionGraph(), SCH_EDIT_TOOL::ChangeTextType(), CheckLibSymbol(), SCH_SHEET::CleanupSheet(), LIB_TEXT::Clone(), LIB_FIELD::compare(), LIB_TEXT::compare(), LIB_TEXTBOX::compare(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_LIB_FIELD_PROPERTIES::DIALOG_LIB_FIELD_PROPERTIES(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySymbol(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CONNECTION_GRAPH::ercCheckHierSheets(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), LIB_SYMBOL::Flatten(), PCB_PLUGIN::format(), LIB_SYMBOL::GetFootprint(), SCH_SYMBOL::GetFootprintFieldText(), LIB_FIELD::GetFullText(), SCH_LABEL_BASE::GetIntersheetRefs(), PCB_DIMENSION_BASE::GetItemDescription(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet(), FP_TEXT::GetLength(), LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), LIB_SYMBOL::GetPrefix(), SCH_SYMBOL::GetRef(), FOOTPRINT::GetReference(), LIB_SYMBOL::GetSearchText(), FOOTPRINT::GetValue(), SCH_SYMBOL::GetValueFieldText(), hash_fp_item(), SCH_SHEET::HasUndefinedPins(), LIB_FIELD::HitTest(), SCH_DRAWING_TOOLS::importHierLabel(), SCH_LABEL_BASE::IncrementLabel(), GENERAL_COLLECTOR::Inspect(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EAGLE_PLUGIN::loadSegments(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), LIB_TEXTBOX::Matches(), SCH_LABEL_BASE::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_TEXTBOX::Matches(), DIALOG_SHEET_PIN_PROPERTIES::onComboBox(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), LIB_FIELD::operator=(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceText(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), DIALOG_RESCUE_EACH::PopulateInstanceList(), LIB_FIELD::print(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_EDIT_FRAME::PutDataInPreviousState(), NETLIST_EXPORTER_SPICE_MODEL::readPorts(), SCHEMATIC::RecomputeIntersheetRefs(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN::saveField(), CLIPBOARD_IO::SaveSelection(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN::saveText(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_VIEWER_FRAME::setupUIConditions(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_SHEET::SymbolCount(), textsNeedUpdate(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxToPolygon(), PCB_DIM_LEADER::updateGeometry(), SCH_EDITOR_CONTROL::updatePastedSymbol(), SCH_SYMBOL::UpdatePrefix(), SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo(), and FP_TEXT::ViewGetLOD().

◆ GetTextAngle()

const EDA_ANGLE & EDA_TEXT::GetTextAngle ( ) const

inlineinherited

Definition at line 120 of file eda_text.h.

120{ return m_attributes.m_Angle; }

References TEXT_ATTRIBUTES::m_Angle, and EDA_TEXT::m_attributes.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), LIB_TEXTBOX::compare(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_PLUGIN::format(), SCH_LABEL::GetBodyBoundingBox(), LIB_FIELD::GetBoundingBox(), LIB_TEXT::GetBoundingBox(), GetBoundingBox(), SCH_TEXT::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), LIB_TEXTBOX::GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), EDA_TEXT::GetDrawRotation(), GetDrawRotation(), FP_TEXT::GetDrawRotation(), FP_TEXTBOX::GetDrawRotation(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), hash_fp_item(), LIB_FIELD::HitTest(), LIB_TEXT::HitTest(), FP_TEXT::KeepUpright(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), FP_TEXT::Mirror(), PCB_TEXT::Mirror(), PCB_DIMENSION_BASE::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXTBOX::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), LIB_TEXT::MirrorVertical(), LIB_TEXTBOX::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), LIB_TEXT::NormalizeJustification(), KI_TEST::kitest_cmp_drawings::operator()(), EAGLE_PLUGIN::orientFPText(), Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), positioningChanged(), Print(), LIB_FIELD::print(), LIB_TEXT::print(), SCH_EDIT_TOOL::Rotate(), SCH_TEXTBOX::Rotate(), LIB_TEXTBOX::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), FP_TEXTBOX::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), PCB_TEXTBOX::Rotate(), SCH_TEXTBOX::Rotate90(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), FP_TEXTBOX::SetTextAngle(), PCB_TEXTBOX::SetTextAngle(), textsNeedUpdate(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), and PCB_DIM_LEADER::updateGeometry().

◆ GetTextAngleDegrees()

double EDA_TEXT::GetTextAngleDegrees ( ) const

inlineinherited

Definition at line 127 of file eda_text.h.

127{ return m_attributes.m_Angle.AsDegrees(); }

References EDA_ANGLE::AsDegrees(), TEXT_ATTRIBUTES::m_Angle, and EDA_TEXT::m_attributes.

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

◆ GetTextBox()

BOX2I EDA_TEXT::GetTextBox	(	int	aLine = `-1`,
		bool	aInvertY = `false`
	)		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.
aInvertY	Invert the Y axis when calculating bounding box.

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 505 of file eda_text.cpp.

{
 VECTOR2I drawPos = GetDrawPos();
 
 if( m_bounding_box_cache_valid
 && m_bounding_box_cache_pos == drawPos
 && m_bounding_box_cache_line == aLine
 && m_bounding_box_cache_inverted == aInvertY )
 {
 return m_bounding_box_cache;
 }
 
 BOX2I bbox;
 wxArrayString strings;
 wxString text = GetShownText();
 int thickness = GetEffectiveTextPenWidth();
 
 if( IsMultilineAllowed() )
 {
 wxStringSplit( text, strings, '\n' );
 
 if( strings.GetCount() ) // GetCount() == 0 for void strings with multilines allowed
 {
 if( aLine >= 0 && ( aLine < static_cast<int>( strings.GetCount() ) ) )
 text = strings.Item( aLine );
 else
 text = strings.Item( 0 );
 }
 }
 
 // calculate the H and V size
 KIFONT::FONT* font = getDrawFont();
 VECTOR2D fontSize( GetTextSize() );
 bool bold = IsBold();
 bool italic = IsItalic();
 VECTOR2I extents = font->StringBoundaryLimits( text, fontSize, thickness, bold, italic );
 int overbarOffset = 0;
 
 // Creates bounding box (rectangle) for horizontal, left and top justified text. The
 // bounding box will be moved later according to the actual text options
 VECTOR2I textsize = VECTOR2I( extents.x, extents.y );
 VECTOR2I pos = drawPos;
 
 if( IsMultilineAllowed() && aLine > 0 && aLine < (int) strings.GetCount() )
 pos.y -= KiROUND( aLine * font->GetInterline( fontSize.y ) );
 
 if( text.Contains( wxT( "~{" ) ) )
 overbarOffset = extents.y / 14;
 
 if( aInvertY )
 pos.y = -pos.y;
 
 bbox.SetOrigin( pos );
 
 // for multiline texts and aLine < 0, merge all rectangles (aLine == -1 signals all lines)
 if( IsMultilineAllowed() && aLine < 0 && strings.GetCount() )
 {
 for( unsigned ii = 1; ii < strings.GetCount(); ii++ )
 {
 text = strings.Item( ii );
 extents = font->StringBoundaryLimits( text, fontSize, thickness, bold, italic );
 textsize.x = std::max( textsize.x, extents.x );
 }
 
 // interline spacing is only *between* lines, so total height is the height of the first
 // line plus the interline distance (with interline spacing) for all subsequent lines
 textsize.y += KiROUND( ( strings.GetCount() - 1 ) * font->GetInterline( fontSize.y ) );
 }
 
 bbox.SetSize( textsize );
 
 /*
 * At this point the rectangle origin is the text origin (m_Pos). This is correct only for
 * left and top justified, non-mirrored, non-overbarred texts. Recalculate for all others.
 */
 int italicOffset = IsItalic() ? KiROUND( fontSize.y * ITALIC_TILT ) : 0;
 
 switch( GetHorizJustify() )
 {
 case GR_TEXT_H_ALIGN_LEFT:
 if( IsMirrored() )
 bbox.SetX( bbox.GetX() - ( bbox.GetWidth() - italicOffset ) );
 break;
 
 case GR_TEXT_H_ALIGN_CENTER:
 bbox.SetX( bbox.GetX() - ( bbox.GetWidth() - italicOffset ) / 2 );
 break;
 
 case GR_TEXT_H_ALIGN_RIGHT:
 if( !IsMirrored() )
 bbox.SetX( bbox.GetX() - ( bbox.GetWidth() - italicOffset ) );
 break;
 }
 
 switch( GetVertJustify() )
 {
 case GR_TEXT_V_ALIGN_TOP:
 break;
 
 case GR_TEXT_V_ALIGN_CENTER:
 bbox.SetY( bbox.GetY() - ( bbox.GetHeight() + overbarOffset ) / 2 );
 break;
 
 case GR_TEXT_V_ALIGN_BOTTOM:
 bbox.SetY( bbox.GetY() - ( bbox.GetHeight() + overbarOffset ) );
 break;
 }
 
 bbox.Normalize(); // Make h and v sizes always >= 0
 
 m_bounding_box_cache_valid = true;
 m_bounding_box_cache_pos = drawPos;
 m_bounding_box_cache_line = aLine;
 m_bounding_box_cache_inverted = aInvertY;
 m_bounding_box_cache = bbox;
 
 return bbox;
}

References EDA_TEXT::getDrawFont(), EDA_TEXT::GetDrawPos(), EDA_TEXT::GetEffectiveTextPenWidth(), BOX2< Vec >::GetHeight(), EDA_TEXT::GetHorizJustify(), KIFONT::FONT::GetInterline(), EDA_TEXT::GetShownText(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetVertJustify(), BOX2< Vec >::GetWidth(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), 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, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsMultilineAllowed(), ITALIC_TILT, KiROUND(), EDA_TEXT::m_bounding_box_cache, EDA_TEXT::m_bounding_box_cache_inverted, EDA_TEXT::m_bounding_box_cache_line, EDA_TEXT::m_bounding_box_cache_pos, EDA_TEXT::m_bounding_box_cache_valid, BOX2< Vec >::Normalize(), 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::SCH_PAINTER::draw(), SCH_LABEL::GetBodyBoundingBox(), SCH_HIERLABEL::GetBodyBoundingBox(), LIB_FIELD::GetBoundingBox(), LIB_TEXT::GetBoundingBox(), GetBoundingBox(), SCH_TEXT::GetBoundingBox(), DS_DRAW_ITEM_TEXT::GetBoundingBox(), FP_TEXT::GetBoundingBox(), PCB_DIMENSION_BASE::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), ALTIUM_PCB::HelperParseDimensions6Radial(), LIB_TEXT::HitTest(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), LIB_TEXT::NormalizeJustification(), SCH_TEXT::Plot(), SCH_TEXT::Print(), EDA_TEXT::TextHitTest(), FP_TEXT::TextHitTest(), EDA_TEXT::TransformBoundingBoxToPolygon(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), and FP_TEXT::ViewBBox().

◆ GetTextColor()

COLOR4D EDA_TEXT::GetTextColor ( ) const

inlineinherited

Definition at line 205 of file eda_text.h.

205{ return m_attributes.m_Color; }

TEXT_ATTRIBUTES::m_Color

KIGFX::COLOR4D m_Color

Definition: text_attributes.h:75

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Color.

Referenced by DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT::Format(), GetFieldColor(), SCH_LABEL_BASE::GetLabelColor(), KIGFX::SCH_PAINTER::getRenderColor(), Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), Print(), LIB_FIELD::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_LABEL_BASE::Print(), SCH_TEXT::Print(), SCH_TEXTBOX::Print(), DS_DRAW_ITEM_TEXT::PrintWsItem(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GetTextHeight()

int EDA_TEXT::GetTextHeight ( ) const

inlineinherited

Definition at line 202 of file eda_text.h.

202{ return m_attributes.m_Size.y; }

References EDA_TEXT::m_attributes, TEXT_ATTRIBUTES::m_Size, and VECTOR2< T >::y.

Referenced by SCH_LABEL_BASE::AutoplaceFields(), LIB_FIELD::compare(), LIB_TEXT::compare(), LIB_TEXTBOX::compare(), SCH_GLOBALLABEL::CreateGraphicShape(), SCH_HIERLABEL::CreateGraphicShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), SCH_HIERLABEL::GetBodyBoundingBox(), EDA_TEXT::GetInterline(), PCB_TEXT::getKnockoutMargin(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), SCH_GLOBALLABEL::GetSchematicTextOffset(), hash_fp_item(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_SEXPR_PLUGIN::saveField(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ GetTextPos()

const VECTOR2I & EDA_TEXT::GetTextPos ( ) const

inlineinherited

Definition at line 208 of file eda_text.h.

208{ return m_pos; }

References EDA_TEXT::m_pos.

Referenced by SCH_LABEL_BASE::AutoplaceFields(), LIB_FIELD::compare(), LIB_TEXT::compare(), PCB_GRID_HELPER::computeAnchors(), SCH_SHEET_PIN::ConstrainOnEdge(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_LABEL::doIsConnected(), SCH_GLOBALLABEL::doIsConnected(), SCH_HIERLABEL::doIsConnected(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), PCB_PLUGIN::format(), SCH_LABEL_BASE::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), SCH_HIERLABEL::GetBodyBoundingBox(), LIB_FIELD::GetBoundingBox(), LIB_TEXT::GetBoundingBox(), GetBoundingBox(), SCH_TEXT::GetBoundingBox(), FP_TEXT::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LABEL_BASE::GetConnectionPoints(), EDA_TEXT::GetDrawPos(), SCH_LABEL_BASE::GetEndPoints(), SCH_SHEET_PIN::GetEndPoints(), GetLibPosition(), LIB_FIELD::GetPosition(), LIB_TEXT::GetPosition(), GetPosition(), SCH_TEXT::GetPosition(), DS_DRAW_ITEM_TEXT::GetPosition(), FP_TEXT::GetPosition(), PCB_TEXT::GetPosition(), ALTIUM_PCB::HelperParseDimensions6Radial(), LIB_FIELD::HitTest(), LIB_TEXT::HitTest(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PCB_POINT_EDITOR::makePoints(), FP_TEXT::Mirror(), PCB_TEXT::Mirror(), PCB_DIMENSION_BASE::Mirror(), LIB_FIELD::MirrorHorizontal(), LIB_TEXT::MirrorHorizontal(), SCH_SHEET_PIN::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), LIB_FIELD::MirrorVertical(), LIB_TEXT::MirrorVertical(), SCH_SHEET_PIN::MirrorVertically(), SCH_TEXT::MirrorVertically(), LIB_TEXT::NormalizeJustification(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), DRAWING_TOOL::PlaceText(), Plot(), SCH_LABEL_BASE::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_FIELD::print(), SCH_LABEL_BASE::Print(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), FP_TEXT::SetDrawCoord(), FP_TEXT::SetLocalCoord(), FP_TEXT::TextHitTest(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), FP_TEXT::TransformTextToPolySet(), PCB_TEXT::TransformTextToPolySet(), SCH_LABEL_BASE::UpdateDanglingState(), PCB_DIM_RADIAL::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), PCB_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updatePoints(), PCB_DIM_RADIAL::updateText(), and FP_TEXT::ViewBBox().

◆ GetTextSize()

VECTOR2I EDA_TEXT::GetTextSize ( ) const

inlineinherited

Definition at line 196 of file eda_text.h.

196{ return m_attributes.m_Size; }

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Size.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::SCH_PAINTER::draw(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), FP_TEXT::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), EDA_TEXT::GetEffectiveTextPenWidth(), SCH_LABEL_BASE::GetLabelBoxExpansion(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), EDA_TEXT::GetTextBox(), LIB_TEXTBOX::GetTextMargin(), SCH_TEXTBOX::GetTextMargin(), FP_TEXTBOX::GetTextMargin(), PCB_TEXTBOX::GetTextMargin(), SCH_TEXT::GetTextOffset(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), EAGLE_PLUGIN::orientFPText(), Plot(), SCH_TEXT::Plot(), Print(), LIB_FIELD::print(), LIB_TEXT::print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_LEGACY_PLUGIN::saveSheet(), textsNeedUpdate(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ GetTextStyleName()

wxString EDA_TEXT::GetTextStyleName ( ) const

inherited

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

Definition at line 738 of file eda_text.cpp.

{
 int style = 0;
 
 if( IsItalic() )
 style = 1;
 
 if( IsBold() )
 style += 2;
 
 wxString stylemsg[4] = {
 _("Normal"),
 _("Italic"),
 _("Bold"),
 _("Bold+Italic")
 };
 
 return stylemsg[style];
}

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

Referenced by LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), and GetMsgPanelInfo().

◆ GetTextThickness()

int EDA_TEXT::GetTextThickness ( ) const

inlineinherited

Definition at line 112 of file eda_text.h.

112{ return m_attributes.m_StrokeWidth; };

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_StrokeWidth.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetEffectiveTextPenWidth(), PCB_TEXT::getKnockoutMargin(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), EDA_TEXT::IsDefaultFormatting(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_LEGACY_PLUGIN::saveText(), textsNeedUpdate(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ GetTextWidth()

int EDA_TEXT::GetTextWidth ( ) const

inlineinherited

Definition at line 199 of file eda_text.h.

199{ return m_attributes.m_Size.x; }

References EDA_TEXT::m_attributes, TEXT_ATTRIBUTES::m_Size, and VECTOR2< T >::x.

Referenced by LIB_FIELD::compare(), LIB_TEXT::compare(), LIB_TEXTBOX::compare(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetEffectiveTextPenWidth(), PCB_TEXT::getKnockoutMargin(), LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), SCH_HIERLABEL::GetSchematicTextOffset(), hash_fp_item(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_EAGLE_PLUGIN::loadTextAttributes(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN::saveText(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), and DIALOG_FIELD_PROPERTIES::updateText().

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

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

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

Referenced by PCB_GROUP::AddItem(), EDIT_TOOL::doMoveSelection(), and EDA_ITEM::GetFriendlyName().

◆ GetVertJustify()

GR_TEXT_V_ALIGN_T EDA_TEXT::GetVertJustify ( ) const

inlineinherited

Definition at line 152 of file eda_text.h.

152{ return m_attributes.m_Valign; };

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Valign.

Referenced by DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), LIB_TEXTBOX::GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), GetEffectiveVertJustify(), EDA_TEXT::GetLinePositions(), LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), GetMsgPanelInfo(), EDA_TEXT::GetTextBox(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), IsVertJustifyFlipped(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), Plot(), positioningChanged(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), LIB_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), textsNeedUpdate(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ 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 1006 of file eda_text.cpp.

{
 return wxT( "#" ) + aDestination;
}

Referenced by SCH_SHEET::Plot().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 143 of file eda_item.h.

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

References EDA_ITEM::m_flags.

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

◆ HasHyperlink()

virtual bool EDA_TEXT::HasHyperlink ( ) const

inlinevirtualinherited

Definition at line 333 of file eda_text.h.

333{ return !m_hyperlink.IsEmpty(); }

References EDA_TEXT::m_hyperlink.

Referenced by EDA_TEXT::Format(), SCH_TEXT::IsHypertext(), SCH_TEXTBOX::IsHypertext(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ HasLineStroke()

virtual bool SCH_ITEM::HasLineStroke ( ) const

inlinevirtualinherited

Check if this schematic item has line stoke properties.

See also: STROKE_PARAMS

Returns: true if this schematic item support line stroke properties. Otherwise, false.

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 455 of file sch_item.h.

455{ return false; }

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

◆ HasTextVars()

bool EDA_TEXT::HasTextVars ( ) const

inlineinherited

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

Definition at line 103 of file eda_text.h.

103{ return m_shown_text_has_text_var_refs; }

References EDA_TEXT::m_shown_text_has_text_var_refs.

Referenced by KIGFX::SCH_PAINTER::draw(), GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXT::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXT::GetShownText(), and PCB_TEXTBOX::GetShownText().

◆ HitTest() [1/2]

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

overridevirtual

Test if aRect intersects this item.

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 920 of file sch_field.cpp.

{
 // Do not hit test hidden fields.
 if( !IsVisible() || GetShownText().IsEmpty() )
 return false;
 
 BOX2I rect = aRect;
 
 rect.Inflate( aAccuracy );
 
 if( GetParent() && GetParent()->Type() == SCH_GLOBAL_LABEL_T )
 {
 SCH_GLOBALLABEL* label = static_cast<SCH_GLOBALLABEL*>( GetParent() );
 rect.Offset( label->GetSchematicTextOffset( nullptr ) );
 }
 
 if( aContained )
 return rect.Contains( GetBoundingBox() );
 
 return rect.Intersects( GetBoundingBox() );
}

References BOX2< Vec >::Contains(), GetBoundingBox(), EDA_ITEM::GetParent(), SCH_GLOBALLABEL::GetSchematicTextOffset(), GetShownText(), BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), EDA_TEXT::IsVisible(), BOX2< Vec >::Offset(), SCH_GLOBAL_LABEL_T, and EDA_ITEM::Type().

◆ HitTest() [2/2]

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

overridevirtual

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 900 of file sch_field.cpp.

{
 // Do not hit test hidden or empty fields.
 if( !IsVisible() || GetShownText().IsEmpty() )
 return false;
 
 BOX2I rect = GetBoundingBox();
 
 rect.Inflate( aAccuracy );
 
 if( GetParent() && GetParent()->Type() == SCH_GLOBAL_LABEL_T )
 {
 SCH_GLOBALLABEL* label = static_cast<SCH_GLOBALLABEL*>( GetParent() );
 rect.Offset( label->GetSchematicTextOffset( nullptr ) );
 }
 
 return rect.Contains( aPosition );
}

References BOX2< Vec >::Contains(), GetBoundingBox(), EDA_ITEM::GetParent(), SCH_GLOBALLABEL::GetSchematicTextOffset(), GetShownText(), BOX2< Vec >::Inflate(), EDA_TEXT::IsVisible(), BOX2< Vec >::Offset(), SCH_GLOBAL_LABEL_T, and EDA_ITEM::Type().

◆ ImportValues()

void SCH_FIELD::ImportValues ( const LIB_FIELD & aSource )

Copy parameters from a LIB_FIELD source.

Pointers and specific values (position) are not copied.

Parameters

aSource is the LIB_FIELD to read.

Definition at line 382 of file sch_field.cpp.

{
 SetAttributes( aSource );
 SetNameShown( aSource.IsNameShown() );
 SetCanAutoplace( aSource.CanAutoplace() );
}

References LIB_FIELD::CanAutoplace(), LIB_FIELD::IsNameShown(), EDA_TEXT::SetAttributes(), SetCanAutoplace(), and SetNameShown().

Referenced by SCH_SYMBOL::UpdateFields().

◆ InitializeConnection()

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

inherited

Create a new connection object associated with this object.

Parameters

aPath is the sheet path to initialize.

Definition at line 205 of file sch_item.cpp.

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

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

Referenced by SCH_ITEM::GetOrInitConnection().

◆ IsBold()

bool EDA_TEXT::IsBold ( ) const

inlineinherited

Definition at line 133 of file eda_text.h.

133{ return m_attributes.m_Bold; }

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Bold.

Referenced by BOARD_ADAPTER::addText(), SCH_EDIT_TOOL::ChangeTextType(), LIB_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::getDrawFont(), LIB_FIELD::getDrawFont(), LIB_TEXT::getDrawFont(), LIB_TEXTBOX::getDrawFont(), getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), EDA_TEXT::GetEffectiveTextPenWidth(), KIGFX::SCH_PAINTER::getFont(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), GetRenderCache(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextStyleName(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), Print(), LIB_FIELD::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), textsNeedUpdate(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

108{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ IsConnectable()

virtual bool SCH_ITEM::IsConnectable ( ) const

inlinevirtualinherited

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

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

Definition at line 349 of file sch_item.h.

349{ return false; }

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_JUNCTION::CanConnect(), SCH_ITEM::Connection(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_EDIT_TOOL::DoDelete(), SCH_SCREEN::GetNeededJunctions(), SCH_ITEM::GetOrInitConnection(), EE_SELECTION::GetTopLeftItem(), SCH_EDIT_TOOL::Init(), SCH_MOVE_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), EE_GRID_HELPER::nearestAnchor(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Swap(), and SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires().

◆ IsConnected()

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

inherited

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

Parameters

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

Returns: True if connection to aPoint exists.

Definition at line 137 of file sch_item.cpp.

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

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

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

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( ) const

inlineinherited

Definition at line 413 of file sch_item.h.

413{ return m_connectivity_dirty; }

SCH_ITEM::m_connectivity_dirty

bool m_connectivity_dirty

Definition: sch_item.h:503

References SCH_ITEM::m_connectivity_dirty.

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

◆ IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LABEL_BASE, SCH_LINE, and SCH_PIN.

Definition at line 342 of file sch_item.h.

342{ return false; }

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

◆ IsDefaultFormatting()

bool EDA_TEXT::IsDefaultFormatting ( ) const

inherited

Definition at line 768 of file eda_text.cpp.

{
 return ( IsVisible()
 && !IsMirrored()
 && GetHorizJustify() == GR_TEXT_H_ALIGN_CENTER
 && GetVertJustify() == GR_TEXT_V_ALIGN_CENTER
 && GetTextThickness() == 0
 && !IsItalic()
 && !IsBold()
 && !IsMultilineAllowed()
 && GetFontName().IsEmpty()
 );
}

References EDA_TEXT::GetFontName(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetVertJustify(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsMultilineAllowed(), and EDA_TEXT::IsVisible().

Referenced by SCH_SEXPR_PLUGIN::saveField().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

107{ return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:72

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 201 of file eda_item.h.

201{ return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:497

References EDA_ITEM::m_forceVisible.

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

◆ 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 1000 of file eda_text.cpp.

{
 return aHref.StartsWith( wxT( "#" ), aDestination );
}

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

◆ IsHorizJustifyFlipped()

bool SCH_FIELD::IsHorizJustifyFlipped ( ) const

Return whether the field will be rendered with the horizontal justification inverted due to rotation or mirroring of the parent.

Definition at line 491 of file sch_field.cpp.

{
 VECTOR2I render_center = GetBoundingBox().Centre();
 VECTOR2I pos = GetPosition();
 
 switch( GetHorizJustify() )
 {
 case GR_TEXT_H_ALIGN_LEFT:
 if( GetDrawRotation().IsVertical() )
 return render_center.y > pos.y;
 else
 return render_center.x < pos.x;
 case GR_TEXT_H_ALIGN_RIGHT:
 if( GetDrawRotation().IsVertical() )
 return render_center.y < pos.y;
 else
 return render_center.x > pos.x;
 default:
 return false;
 }
}

References BOX2< Vec >::Centre(), GetBoundingBox(), GetDrawRotation(), EDA_TEXT::GetHorizJustify(), GetPosition(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by AUTOPLACER::fieldHPlacement(), GetEffectiveHorizJustify(), AUTOPLACER::justifyField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ IsHypertext()

bool SCH_FIELD::IsHypertext ( ) const

inlineoverridevirtual

Allow items to support hypertext actions when hovered/clicked.

Reimplemented from SCH_ITEM.

Definition at line 95 of file sch_field.h.

 {
 return m_id == 0 && m_parent && m_parent->Type() == SCH_GLOBAL_LABEL_T;
 }

References m_id, EDA_ITEM::m_parent, SCH_GLOBAL_LABEL_T, and EDA_ITEM::Type().

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

◆ IsItalic()

bool EDA_TEXT::IsItalic ( ) const

inlineinherited

Definition at line 130 of file eda_text.h.

130{ return m_attributes.m_Italic; }

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Italic.

Referenced by BOARD_ADAPTER::addText(), SCH_DIRECTIVE_LABEL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), LIB_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::getDrawFont(), LIB_FIELD::getDrawFont(), LIB_TEXT::getDrawFont(), LIB_TEXTBOX::getDrawFont(), getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), KIGFX::SCH_PAINTER::getFont(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), GetRenderCache(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextStyleName(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), Print(), LIB_FIELD::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN::saveText(), textsNeedUpdate(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ IsKeepUpright()

bool EDA_TEXT::IsKeepUpright ( ) const

inlineinherited

Definition at line 155 of file eda_text.h.

155{ return m_attributes.m_KeepUpright; }

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_KeepUpright.

Referenced by PCB_PLUGIN::format(), FP_TEXT::GetDrawRotation(), FP_TEXT::KeepUpright(), and textsNeedUpdate().

◆ IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const

inlinevirtualinherited

Returns: true if the object is locked, else false.

Definition at line 229 of file sch_item.h.

229{ return false; }

◆ IsMirrored()

bool EDA_TEXT::IsMirrored ( ) const

inlineinherited

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

102{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

virtual bool SCH_ITEM::IsMovableFromAnchorPoint ( ) const

inlinevirtualinherited

Returns: true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor Usually return true for small items (labels, junctions) and false for items which can be large (hierarchical sheets, symbols)

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

Definition at line 207 of file sch_item.h.

207{ return true; }

Referenced by SCH_MOVE_TOOL::Main().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

104{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsMultilineAllowed()

bool EDA_TEXT::IsMultilineAllowed ( ) const

inlineinherited

Definition at line 146 of file eda_text.h.

146{ return m_attributes.m_Multiline; }

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Multiline.

Referenced by EDA_TEXT::GetTextBox(), EDA_TEXT::IsDefaultFormatting(), BRDITEMS_PLOTTER::PlotPcbText(), and EDA_TEXT::Print().

◆ IsNameShown()

bool SCH_FIELD::IsNameShown ( ) const

inline

Definition at line 158 of file sch_field.h.

158{ return m_showName; }

References m_showName.

Referenced by DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), GetShownText(), SCH_SEXPR_PLUGIN::saveField(), and EE_INSPECTION_TOOL::ShowDatasheet().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

103{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

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

◆ IsPointClickableAnchor()

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

inlinevirtualinherited

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

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

Definition at line 355 of file sch_item.h.

355{ return false; }

Referenced by EE_SELECTION_TOOL::autostartEvent().

◆ IsReplaceable()

bool SCH_FIELD::IsReplaceable ( ) const

overridevirtual

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 613 of file sch_field.cpp.

{
 if( m_parent && m_parent->Type() == SCH_SHEET_T )
 {
 // See comments in SCH_FIELD::Replace(), below.
 if( m_id == SHEETFILENAME )
 return false;
 }
 else if( m_parent && m_parent->Type() == SCH_GLOBAL_LABEL_T )
 {
 if( m_id == 0 /* IntersheetRefs */ )
 return false;
 }
 
 return true;
}

References m_id, EDA_ITEM::m_parent, SCH_GLOBAL_LABEL_T, SCH_SHEET_T, SHEETFILENAME, and EDA_ITEM::Type().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

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

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

106{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 173 of file eda_item.h.

173{ return m_flags & IS_SHOWN_AS_BITMAP; }

IS_SHOWN_AS_BITMAP

#define IS_SHOWN_AS_BITMAP

Definition: eda_item_flags.h:54

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsType()

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

inlineoverridevirtual

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

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

Reimplemented from EDA_ITEM.

Definition at line 75 of file sch_field.h.

 {
 if( SCH_ITEM::IsType( aScanTypes ) )
 return true;
 
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == SCH_FIELD_LOCATE_REFERENCE_T && m_id == REFERENCE_FIELD )
 return true;
 else if ( scanType == SCH_FIELD_LOCATE_VALUE_T && m_id == VALUE_FIELD )
 return true;
 else if ( scanType == SCH_FIELD_LOCATE_FOOTPRINT_T && m_id == FOOTPRINT_FIELD )
 return true;
 else if ( scanType == SCH_FIELD_LOCATE_DATASHEET_T && m_id == DATASHEET_FIELD )
 return true;
 }
 
 return false;
 }

References DATASHEET_FIELD, FOOTPRINT_FIELD, SCH_ITEM::IsType(), m_id, REFERENCE_FIELD, SCH_FIELD_LOCATE_DATASHEET_T, SCH_FIELD_LOCATE_FOOTPRINT_T, SCH_FIELD_LOCATE_REFERENCE_T, SCH_FIELD_LOCATE_VALUE_T, and VALUE_FIELD.

◆ IsVertJustifyFlipped()

bool SCH_FIELD::IsVertJustifyFlipped ( ) const

Definition at line 528 of file sch_field.cpp.

{
 VECTOR2I render_center = GetBoundingBox().Centre();
 VECTOR2I pos = GetPosition();
 
 switch( GetVertJustify() )
 {
 case GR_TEXT_V_ALIGN_TOP:
 if( GetDrawRotation().IsVertical() )
 return render_center.x < pos.x;
 else
 return render_center.y < pos.y;
 case GR_TEXT_V_ALIGN_BOTTOM:
 if( GetDrawRotation().IsVertical() )
 return render_center.x > pos.x;
 else
 return render_center.y > pos.y;
 default:
 return false;
 }
}

References BOX2< Vec >::Centre(), GetBoundingBox(), GetDrawRotation(), GetPosition(), EDA_TEXT::GetVertJustify(), GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_TOP, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GetEffectiveVertJustify(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ IsVisible()

virtual bool EDA_TEXT::IsVisible ( ) const

inlinevirtualinherited

Reimplemented in PCB_TEXT, and PCB_TEXTBOX.

Definition at line 136 of file eda_text.h.

136{ return m_attributes.m_Visible; }

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Visible.

Referenced by BOARD_ADAPTER::addFootprintShapes(), SCH_EDITOR_CONTROL::AssignFootprints(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), AUTOPLACER::DoAutoplace(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_EDIT_TOOL::EditField(), PCB_PLUGIN::format(), EDA_TEXT::Format(), FOOTPRINT::GetBoundingBox(), LIB_FIELD::GetMsgPanelInfo(), GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), HitTest(), DRC_RTREE::Insert(), EDA_TEXT::IsDefaultFormatting(), SCH_EAGLE_PLUGIN::loadInstance(), Matches(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), Plot(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), Print(), LIB_SYMBOL::Print(), LIB_FIELD::print(), LIB_TEXT::print(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_EDIT_TOOL::Properties(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), textsNeedUpdate(), FOOTPRINT::TransformFPShapesToPolySet(), SCH_SHEET_PATH::UpdateAllScreenReferences(), FP_TEXT::ViewGetLayers(), and FP_TEXTBOX::ViewGetLayers().

◆ IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 302 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 322 of file eda_item.h.

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

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

◆ MapHorizJustify()

GR_TEXT_H_ALIGN_T EDA_TEXT::MapHorizJustify ( int aHorizJustify )

staticinherited

Definition at line 64 of file eda_text.cpp.

{
 wxASSERT( aHorizJustify >= GR_TEXT_H_ALIGN_LEFT && aHorizJustify <= GR_TEXT_H_ALIGN_RIGHT );
 
 if( aHorizJustify > GR_TEXT_H_ALIGN_RIGHT )
 return GR_TEXT_H_ALIGN_RIGHT;
 
 if( aHorizJustify < GR_TEXT_H_ALIGN_LEFT )
 return GR_TEXT_H_ALIGN_LEFT;
 
 return static_cast<GR_TEXT_H_ALIGN_T>( aHorizJustify );
}

References GR_TEXT_H_ALIGN_LEFT, and GR_TEXT_H_ALIGN_RIGHT.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ MapVertJustify()

GR_TEXT_V_ALIGN_T EDA_TEXT::MapVertJustify ( int aVertJustify )

staticinherited

Definition at line 78 of file eda_text.cpp.

{
 wxASSERT( aVertJustify >= GR_TEXT_V_ALIGN_TOP && aVertJustify <= GR_TEXT_V_ALIGN_BOTTOM );
 
 if( aVertJustify > GR_TEXT_V_ALIGN_BOTTOM )
 return GR_TEXT_V_ALIGN_BOTTOM;
 
 if( aVertJustify < GR_TEXT_V_ALIGN_TOP )
 return GR_TEXT_V_ALIGN_TOP;
 
 return static_cast<GR_TEXT_V_ALIGN_T>( aVertJustify );
}

References GR_TEXT_V_ALIGN_BOTTOM, and GR_TEXT_V_ALIGN_TOP.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ Matches() [1/2]

bool SCH_FIELD::Matches	(	const EDA_SEARCH_DATA &	aSearchData,
		void *	aAuxData
	)		const

overridevirtual

Compare the item against the search criteria in aSearchData.

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

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns: True if the item's text matches the search criteria in aSearchData.

Reimplemented from EDA_ITEM.

Definition at line 565 of file sch_field.cpp.

{
 bool searchHiddenFields = false;
 bool searchAndReplace = false;
 bool replaceReferences = false;
 
 try
 {
 const SCH_SEARCH_DATA& schSearchData = dynamic_cast<const SCH_SEARCH_DATA&>( aSearchData ); // downcast
 searchHiddenFields = schSearchData.searchAllFields;
 searchAndReplace = schSearchData.searchAndReplace;
 replaceReferences = schSearchData.replaceReferences;
 }
 catch( const std::bad_cast& )
 {
 }
 
 wxString text = GetShownText();
 
 if( !IsVisible() && !searchHiddenFields )
 return false;
 
 if( m_parent && m_parent->Type() == SCH_SYMBOL_T && m_id == REFERENCE_FIELD )
 {
 if( searchAndReplace && !replaceReferences )
 return false;
 
 SCH_SYMBOL* parentSymbol = static_cast<SCH_SYMBOL*>( m_parent );
 wxASSERT( aAuxData );
 
 // Take sheet path into account which effects the reference field and the unit for
 // symbols with multiple parts.
 if( aAuxData )
 {
 text = parentSymbol->GetRef((SCH_SHEET_PATH*) aAuxData );
 
 if( SCH_ITEM::Matches( text, aSearchData ) )
 return true;
 
 if( parentSymbol->GetUnitCount() > 1 )
 text << LIB_SYMBOL::SubReference( parentSymbol->GetUnit() );
 }
 }
 
 return SCH_ITEM::Matches( text, aSearchData );
}

References SCH_SYMBOL::GetRef(), GetShownText(), SCH_SYMBOL::GetUnit(), SCH_SYMBOL::GetUnitCount(), EDA_TEXT::IsVisible(), m_id, EDA_ITEM::m_parent, EDA_ITEM::Matches(), REFERENCE_FIELD, SCH_SEARCH_DATA::replaceReferences, SCH_SYMBOL_T, SCH_SEARCH_DATA::searchAllFields, EDA_SEARCH_DATA::searchAndReplace, LIB_SYMBOL::SubReference(), text, and EDA_ITEM::Type().

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 117 of file eda_item.cpp.

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

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

◆ MirrorHorizontally()

void SCH_FIELD::MirrorHorizontally ( int aCenter )

inlineoverridevirtual

Mirror item horizontally about aCenter.

This overload does nothing. Fields are never mirrored alone. They are moved when the parent symbol is mirrored. This function is only needed by the pure function of the master class.

Implements SCH_ITEM.

Definition at line 211 of file sch_field.h.

212 {

213 }

◆ MirrorVertically()

void SCH_FIELD::MirrorVertically ( int aCenter )

inlineoverridevirtual

Mirror item vertically about aCenter.

This overload does nothing. Fields are never mirrored alone. They are moved when the parent symbol is mirrored. This function is only needed by the pure function of the master class.

Implements SCH_ITEM.

Definition at line 200 of file sch_field.h.

201 {

202 }

◆ Move()

void SCH_FIELD::Move ( const VECTOR2I & aMoveVector )

inlineoverridevirtual

Move the item by aMoveVector to a new position.

Implements SCH_ITEM.

Definition at line 186 of file sch_field.h.

 {
 Offset( aMoveVector );
 }

References EDA_TEXT::Offset().

Referenced by GetRenderCache().

◆ Offset()

void EDA_TEXT::Offset ( const VECTOR2I & aOffset )

inherited

Definition at line 391 of file eda_text.cpp.

{
 m_pos += aOffset;
 
 for( std::unique_ptr<KIFONT::GLYPH>& glyph : m_render_cache )
 static_cast<KIFONT::OUTLINE_GLYPH*>( glyph.get() )->Move( aOffset );
 
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::m_bounding_box_cache_valid, EDA_TEXT::m_pos, and EDA_TEXT::m_render_cache.

Referenced by CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), Move(), SCH_SHEET_PIN::Move(), SCH_TEXT::Move(), SCH_TEXTBOX::Move(), FP_TEXT::Move(), FP_TEXTBOX::Move(), PCB_TEXT::Move(), PCB_TEXTBOX::Move(), PCB_DIMENSION_BASE::Move(), LIB_FIELD::Offset(), LIB_TEXT::Offset(), FP_TEXT::SetDrawCoord(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextX(), EDA_TEXT::SetTextY(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ operator<() [1/2]

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

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

Returns: - True if aItem is less than the item.

Definition at line 231 of file eda_item.cpp.

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

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

◆ operator<() [2/2]

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

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1090 of file sch_field.cpp.

{
 if( Type() != aItem.Type() )
 return Type() < aItem.Type();
 
 auto field = static_cast<const SCH_FIELD*>( &aItem );
 
 if( GetId() != field->GetId() )
 return GetId() < field->GetId();
 
 if( GetText() != field->GetText() )
 return GetText() < field->GetText();
 
 if( GetLibPosition().x != field->GetLibPosition().x )
 return GetLibPosition().x < field->GetLibPosition().x;
 
 if( GetLibPosition().y != field->GetLibPosition().y )
 return GetLibPosition().y < field->GetLibPosition().y;
 
 return GetName() < field->GetName();
}

References GetId(), GetLibPosition(), GetName(), EDA_TEXT::GetText(), EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ operator=()

SCH_FIELD & SCH_FIELD::operator= ( const SCH_FIELD & aField )

Definition at line 106 of file sch_field.cpp.

{
 EDA_TEXT::operator=( aField );
 
 m_id = aField.m_id;
 m_name = aField.m_name;
 m_showName = aField.m_showName;
 m_allowAutoPlace = aField.m_allowAutoPlace;
 
 m_renderCache.clear();
 
 for( const std::unique_ptr<KIFONT::GLYPH>& glyph : aField.m_renderCache )
 {
 KIFONT::OUTLINE_GLYPH* outline_glyph = static_cast<KIFONT::OUTLINE_GLYPH*>( glyph.get() );
 m_renderCache.emplace_back( std::make_unique<KIFONT::OUTLINE_GLYPH>( *outline_glyph ) );
 }
 
 m_renderCacheValid = aField.m_renderCacheValid;
 m_renderCachePos = aField.m_renderCachePos;
 
 m_lastResolvedColor = aField.m_lastResolvedColor;
 
 return *this;
}

References m_allowAutoPlace, m_id, m_lastResolvedColor, m_name, m_renderCache, m_renderCachePos, m_renderCacheValid, m_showName, and EDA_TEXT::operator=().

◆ Plot()

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

overridevirtual

Plot the schematic item to aPlotter.

Parameters

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

Reimplemented from SCH_ITEM.

Definition at line 943 of file sch_field.cpp.

{
 if( GetShownText().IsEmpty() || aBackground )
 return;
 
 RENDER_SETTINGS* settings = aPlotter->RenderSettings();
 COLOR4D color = settings->GetLayerColor( GetLayer() );
 int penWidth = GetEffectiveTextPenWidth( settings->GetDefaultPenWidth() );
 
 COLOR4D bg = settings->GetBackgroundColor();;
 
 if( bg == COLOR4D::UNSPECIFIED || !aPlotter->GetColorMode() )
 bg = COLOR4D::WHITE;
 
 if( aPlotter->GetColorMode() && GetTextColor() != COLOR4D::UNSPECIFIED )
 color = GetTextColor();
 
 penWidth = std::max( penWidth, settings->GetMinPenWidth() );
 
 // clamp the pen width to be sure the text is readable
 penWidth = std::min( penWidth, std::min( GetTextSize().x, GetTextSize().y ) / 4 );
 
 if( !IsVisible() )
 return;
 
 // Calculate the text orientation, according to the symbol orientation/mirror
 EDA_ANGLE orient = GetTextAngle();
 VECTOR2I textpos = GetTextPos();
 GR_TEXT_H_ALIGN_T hjustify = GetHorizJustify();
 GR_TEXT_V_ALIGN_T vjustify = GetVertJustify();
 
 if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
 {
 SCH_SYMBOL* parentSymbol = static_cast<SCH_SYMBOL*>( m_parent );
 
 if( parentSymbol->GetDNP() )
 {
 color.Desaturate();
 color = color.Mix( bg, 0.5f );
 }
 
 if( parentSymbol->GetTransform().y1 ) // Rotate symbol 90 deg.
 {
 if( orient.IsHorizontal() )
 orient = ANGLE_VERTICAL;
 else
 orient = ANGLE_HORIZONTAL;
 }
 
 /*
 * Calculate the text justification, according to the symbol orientation/mirror. This is
 * a bit complicated due to cumulative calculations:
 * - numerous cases (mirrored or not, rotation)
 * - the plotter's Text() function will also recalculate H and V justifications according
 * to the text orientation
 * - when a symbol is mirrored the text is not, and justifications become a nightmare
 *
 * So the easier way is to use no justifications (centered text) and use GetBoundingBox to
 * know the text coordinate considered as centered.
 */
 hjustify = GR_TEXT_H_ALIGN_CENTER;
 vjustify = GR_TEXT_V_ALIGN_CENTER;
 textpos = GetBoundingBox().Centre();
 }
 else if( m_parent && m_parent->Type() == SCH_GLOBAL_LABEL_T )
 {
 SCH_GLOBALLABEL* label = static_cast<SCH_GLOBALLABEL*>( m_parent );
 textpos += label->GetSchematicTextOffset( settings );
 }
 
 KIFONT::FONT* font = GetFont();
 
 if( !font )
 font = KIFONT::FONT::GetFont( settings->GetDefaultFont(), IsBold(), IsItalic() );
 
 TEXT_ATTRIBUTES attrs = GetAttributes();
 attrs.m_StrokeWidth = penWidth;
 attrs.m_Halign = hjustify;
 attrs.m_Valign = vjustify;
 attrs.m_Angle = orient;
 attrs.m_Multiline = false;
 
 aPlotter->PlotText( textpos, color, GetShownText(), attrs, font );
 
 if( IsHypertext() )
 {
 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( m_parent );
 std::vector<std::pair<wxString, wxString>> pages;
 std::vector<wxString> pageHrefs;
 BOX2I bbox = GetBoundingBox();
 
 wxCHECK( label, /* void */ );
 
 label->GetIntersheetRefs( &pages );
 
 for( const std::pair<wxString, wxString>& page : pages )
 pageHrefs.push_back( wxT( "#" ) + page.first );
 
 bbox.Offset( label->GetSchematicTextOffset( settings ) );
 
 aPlotter->HyperlinkMenu( bbox, pageHrefs );
 }
}

References ANGLE_HORIZONTAL, ANGLE_VERTICAL, BOX2< Vec >::Centre(), color, EDA_TEXT::GetAttributes(), KIGFX::RENDER_SETTINGS::GetBackgroundColor(), GetBoundingBox(), PLOTTER::GetColorMode(), KIGFX::RENDER_SETTINGS::GetDefaultFont(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), SCH_SYMBOL::GetDNP(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetFont(), KIFONT::FONT::GetFont(), EDA_TEXT::GetHorizJustify(), SCH_LABEL_BASE::GetIntersheetRefs(), SCH_ITEM::GetLayer(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), SCH_LABEL_BASE::GetSchematicTextOffset(), SCH_GLOBALLABEL::GetSchematicTextOffset(), GetShownText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextColor(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), SCH_SYMBOL::GetTransform(), EDA_TEXT::GetVertJustify(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, PLOTTER::HyperlinkMenu(), EDA_TEXT::IsBold(), EDA_ANGLE::IsHorizontal(), IsHypertext(), EDA_TEXT::IsItalic(), EDA_TEXT::IsVisible(), TEXT_ATTRIBUTES::m_Angle, TEXT_ATTRIBUTES::m_Halign, TEXT_ATTRIBUTES::m_Multiline, EDA_ITEM::m_parent, TEXT_ATTRIBUTES::m_StrokeWidth, TEXT_ATTRIBUTES::m_Valign, BOX2< Vec >::Offset(), PLOTTER::PlotText(), PLOTTER::RenderSettings(), SCH_GLOBAL_LABEL_T, SCH_SYMBOL_T, EDA_ITEM::Type(), WHITE, and TRANSFORM::y1.

◆ Print() [1/2]

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

overridevirtual

Print a schematic item.

Each schematic item should have its own method

Parameters

aOffset is the drawing offset (usually {0,0} but can be different when moving an object).

Implements SCH_ITEM.

Definition at line 316 of file sch_field.cpp.

{
 wxDC* DC = aSettings->GetPrintDC();
 COLOR4D color = aSettings->GetLayerColor( IsForceVisible() ? LAYER_HIDDEN : m_layer );
 bool blackAndWhiteMode = GetGRForceBlackPenState();
 VECTOR2I textpos;
 int penWidth = GetEffectiveTextPenWidth( aSettings->GetDefaultPenWidth() );
 
 if( ( !IsVisible() && !IsForceVisible() ) || GetShownText().IsEmpty() )
 return;
 
 COLOR4D bg = aSettings->GetBackgroundColor();
 
 if( bg == COLOR4D::UNSPECIFIED || GetGRForceBlackPenState() )
 bg = COLOR4D::WHITE;
 
 if( IsForceVisible() )
 bg = aSettings->GetLayerColor( LAYER_HIDDEN );
 
 if( !blackAndWhiteMode && GetTextColor() != COLOR4D::UNSPECIFIED )
 color = GetTextColor();
 
 // Calculate the text orientation according to the symbol orientation.
 EDA_ANGLE orient = GetTextAngle();
 
 if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
 {
 SCH_SYMBOL* parentSymbol = static_cast<SCH_SYMBOL*>( m_parent );
 
 if( parentSymbol && parentSymbol->GetTransform().y1 ) // Rotate symbol 90 degrees.
 {
 if( orient == ANGLE_HORIZONTAL )
 orient = ANGLE_VERTICAL;
 else
 orient = ANGLE_HORIZONTAL;
 }
 
 if( parentSymbol && parentSymbol->GetDNP() )
 {
 color.Desaturate();
 color = color.Mix( bg, 0.5f );
 }
 }
 
 KIFONT::FONT* font = GetFont();
 
 if( !font )
 font = KIFONT::FONT::GetFont( aSettings->GetDefaultFont(), IsBold(), IsItalic() );
 
 /*
 * Calculate the text justification, according to the symbol orientation/mirror.
 * This is a bit complicated due to cumulative calculations:
 * - numerous cases (mirrored or not, rotation)
 * - the GRText function will also recalculate H and V justifications according to the text
 * orientation.
 * - When a symbol is mirrored, the text is not mirrored and justifications are complicated
 * to calculate so the more easily way is to use no justifications (centered text) and use
 * GetBoundingBox to know the text coordinate considered as centered
 */
 textpos = GetBoundingBox().Centre() + aOffset;
 
 GRPrintText( DC, textpos, color, GetShownText(), orient, GetTextSize(), GR_TEXT_H_ALIGN_CENTER,
 GR_TEXT_V_ALIGN_CENTER, penWidth, IsItalic(), IsBold(), font );
}

References ANGLE_HORIZONTAL, ANGLE_VERTICAL, BOX2< Vec >::Centre(), color, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), GetBoundingBox(), KIGFX::RENDER_SETTINGS::GetDefaultFont(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), SCH_SYMBOL::GetDNP(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetFont(), KIFONT::FONT::GetFont(), GetGRForceBlackPenState(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GetShownText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextColor(), EDA_TEXT::GetTextSize(), SCH_SYMBOL::GetTransform(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, GRPrintText(), EDA_TEXT::IsBold(), EDA_ITEM::IsForceVisible(), EDA_TEXT::IsItalic(), EDA_TEXT::IsVisible(), LAYER_HIDDEN, SCH_ITEM::m_layer, EDA_ITEM::m_parent, SCH_SYMBOL_T, EDA_ITEM::Type(), WHITE, and TRANSFORM::y1.

◆ Print() [2/2]

void EDA_TEXT::Print	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		const COLOR4D &	aColor,
		OUTLINE_MODE	aDisplay_mode = `FILLED`
	)

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.
aDisplay_mode	FILLED or SKETCH.

Definition at line 650 of file eda_text.cpp.

{
 if( IsMultilineAllowed() )
 {
 std::vector<VECTOR2I> positions;
 wxArrayString strings;
 wxStringSplit( GetShownText(), strings, '\n' );
 
 positions.reserve( strings.Count() );
 
 GetLinePositions( positions, (int) strings.Count() );
 
 for( unsigned ii = 0; ii < strings.Count(); ii++ )
 printOneLineOfText( aSettings, aOffset, aColor, aFillMode, strings[ii], positions[ii] );
 }
 else
 {
 printOneLineOfText( aSettings, aOffset, aColor, aFillMode, GetShownText(), GetDrawPos() );
 }
}

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

Referenced by SCH_LABEL_BASE::Print(), SCH_TEXT::Print(), SCH_TEXTBOX::Print(), and DS_DRAW_ITEM_TEXT::PrintWsItem().

◆ PrintBackground()

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

inlinevirtualinherited

Print the (optional) backaground elements if they exist.

Parameters

aSettings	Print settings
aOffset	is the drawing offset (usually {0,0} but can be different when moving an object).

Reimplemented in SCH_SHAPE, and SCH_SYMBOL.

Definition at line 286 of file sch_item.h.

286{};

◆ printOneLineOfText()

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

protectedinherited

Print each line of this EDA_TEXT.

Parameters

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

Definition at line 713 of file eda_text.cpp.

{
 wxDC* DC = aSettings->GetPrintDC();
 int penWidth = GetEffectiveTextPenWidth( aSettings->GetDefaultPenWidth() );
 
 if( aFillMode == SKETCH )
 penWidth = -penWidth;
 
 VECTOR2I size = GetTextSize();
 
 if( IsMirrored() )
 size.x = -size.x;
 
 KIFONT::FONT* font = GetFont();
 
 if( !font )
 font = KIFONT::FONT::GetFont( aSettings->GetDefaultFont(), IsBold(), IsItalic() );
 
 GRPrintText( DC, aOffset + aPos, aColor, aText, GetDrawRotation(), size, GetHorizJustify(),
 GetVertJustify(), penWidth, IsItalic(), IsBold(), font );
}

References KIGFX::RENDER_SETTINGS::GetDefaultFont(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetFont(), KIFONT::FONT::GetFont(), EDA_TEXT::GetHorizJustify(), KIGFX::RENDER_SETTINGS::GetPrintDC(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetVertJustify(), GRPrintText(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), SKETCH, and VECTOR2< T >::x.

Referenced by EDA_TEXT::Print().

◆ RemoveHyperlink()

void EDA_TEXT::RemoveHyperlink ( )

inlineinherited

Definition at line 336 of file eda_text.h.

336{ m_hyperlink = wxEmptyString; }

References EDA_TEXT::m_hyperlink.

◆ RenderAsBitmap()

bool SCH_ITEM::RenderAsBitmap ( double aWorldScale ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 294 of file sch_item.cpp.

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

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

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

◆ Replace() [1/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 320 of file eda_text.cpp.

{
 bool retval = EDA_ITEM::Replace( aSearchData, m_text );
 
 cacheShownText();
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
 
  return retval;
}

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

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

◆ Replace() [2/3]

bool SCH_FIELD::Replace	(	const EDA_SEARCH_DATA &	aSearchData,
		void *	aAuxData = `nullptr`
	)

overridevirtual

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.

Definition at line 631 of file sch_field.cpp.

{
 bool replaceReferences = false;
 
 try
 {
 const SCH_SEARCH_DATA& schSearchData = dynamic_cast<const SCH_SEARCH_DATA&>( aSearchData );
 replaceReferences = schSearchData.replaceReferences;
 }
 catch( const std::bad_cast& )
 {
 }
 
 wxString text;
 bool resolve = false; // Replace in source text, not shown text
 bool isReplaced = false;
 
 if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
 {
 SCH_SYMBOL* parentSymbol = static_cast<SCH_SYMBOL*>( m_parent );
 
 switch( m_id )
 {
 case REFERENCE_FIELD:
 wxCHECK_MSG( aAuxData, false, wxT( "Need sheetpath to replace in refdes." ) );
 
 if( !replaceReferences )
 return false;
 
 text = parentSymbol->GetRef( (SCH_SHEET_PATH*) aAuxData );
 isReplaced = EDA_ITEM::Replace( aSearchData, text );
 
 if( isReplaced )
 parentSymbol->SetRef( (SCH_SHEET_PATH*) aAuxData, text );
 
 break;
 
 case VALUE_FIELD:
 wxCHECK_MSG( aAuxData, false, wxT( "Need sheetpath to replace in value field." ) );
 
 text = parentSymbol->GetValueFieldText( resolve );
 isReplaced = EDA_ITEM::Replace( aSearchData, text );
 
 if( isReplaced )
 parentSymbol->SetValueFieldText( text );
 
 break;
 
 case FOOTPRINT_FIELD:
 wxCHECK_MSG( aAuxData, false, wxT( "Need sheetpath to replace in footprint field." ) );
 
 text = parentSymbol->GetFootprintFieldText( resolve );
 isReplaced = EDA_ITEM::Replace( aSearchData, text );
 
 if( isReplaced )
 parentSymbol->SetFootprintFieldText( text );
 
 break;
 
 default:
 isReplaced = EDA_TEXT::Replace( aSearchData );
 }
 }
 else if( m_parent && m_parent->Type() == SCH_SHEET_T )
 {
 isReplaced = EDA_TEXT::Replace( aSearchData );
 
 if( m_id == SHEETFILENAME && isReplaced )
 {
 // If we allowed this we'd have a bunch of work to do here, including warning
 // about it not being undoable, checking for recursive hierarchies, reloading
 // sheets, etc. See DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().
 }
 }
 else
 {
 isReplaced = EDA_TEXT::Replace( aSearchData );
 }
 
  return isReplaced;
}

References FOOTPRINT_FIELD, SCH_SYMBOL::GetFootprintFieldText(), SCH_SYMBOL::GetRef(), SCH_SYMBOL::GetValueFieldText(), m_id, EDA_ITEM::m_parent, REFERENCE_FIELD, EDA_TEXT::Replace(), EDA_ITEM::Replace(), SCH_SEARCH_DATA::replaceReferences, SCH_SHEET_T, SCH_SYMBOL_T, SCH_SYMBOL::SetFootprintFieldText(), SCH_SYMBOL::SetRef(), SCH_SYMBOL::SetValueFieldText(), SHEETFILENAME, text, EDA_ITEM::Type(), and VALUE_FIELD.

◆ Replace() [3/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 168 of file eda_item.cpp.

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

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

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

◆ Rotate()

void SCH_FIELD::Rotate ( const VECTOR2I & aCenter )

overridevirtual

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

Implements SCH_ITEM.

Definition at line 714 of file sch_field.cpp.

{
 VECTOR2I pt = GetPosition();
 RotatePoint( pt, aCenter, ANGLE_90 );
 SetPosition( pt );
}

References ANGLE_90, GetPosition(), RotatePoint(), and SetPosition().

Referenced by SCH_EDIT_TOOL::Rotate().

◆ RunOnChildren()

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

inlinevirtualinherited

Reimplemented in SCH_LABEL_BASE, SCH_SHEET, and SCH_SYMBOL.

Definition at line 444 of file sch_item.h.

444{ }

Referenced by SCH_ITEM::ClearCaches(), SCH_ITEM::Duplicate(), SCH_SHEET_PATH::GetItem(), CONNECTION_SUBGRAPH::GetNetclassForDriver(), SCH_EDIT_FRAME::RecalculateConnections(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const

inherited

Searches the item hierarchy to find a SCHEMATIC.

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

Every SCH_SCREEN should be parented to the SCHEMATIC.

Note: This hierarchy is not the same as the sheet hierarchy!

Returns: the parent schematic this item lives on, or nullptr.

Definition at line 112 of file sch_item.cpp.

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

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

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

◆ Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 66 of file inspectable.h.

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

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 54 of file inspectable.h.

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCH_FIELD() [1/3]

◆ SCH_FIELD() [2/3]

◆ SCH_FIELD() [3/3]

◆ ~SCH_FIELD()

Member Function Documentation

◆ AddConnectionTo()

◆ AddRenderCacheGlyph()

◆ AutoAutoplaceFields()

◆ AutoplaceFields()

◆ cacheShownText()

◆ CanAutoplace()

◆ CanConnect()

◆ ClassOf()

◆ ClearBoundingBoxCache()

◆ ClearBrightened()

◆ ClearCaches()

◆ ClearConnections()

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

◆ ClearFlags()

◆ ClearRenderCache()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ Compare()

◆ ConnectedItems()

◆ Connection()

◆ ConnectionPropagatesTo()

◆ CopyText()

◆ DoHypertextAction()

◆ doIsConnected()

◆ Duplicate()

◆ Empty()

◆ Format()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAttributes()

◆ GetBoundingBox()

◆ GetCanonicalName()

◆ GetClass()

◆ GetConnectionPoints()

◆ GetDefaultFont()

◆ getDrawFont()

◆ GetDrawPos()

◆ GetDrawRotation()

◆ GetEditFlags()

◆ GetEffectiveHorizJustify()

◆ GetEffectiveNetClass()

◆ GetEffectiveTextPenWidth()

◆ GetEffectiveTextShape()

◆ GetEffectiveVertJustify()

◆ GetEndPoints()

◆ GetFieldColor()

◆ GetFieldsAutoplaced()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFont()

◆ GetFontName()

◆ GetFriendlyName()

◆ GetHorizJustify()

◆ GetHyperlink()

◆ GetId()

◆ GetInterline()

◆ GetInternalName()

◆ GetItemDescription()

◆ GetLayer()

◆ GetLibPosition()

◆ GetLinePositions()

◆ GetLineSpacing()