Field object used in symbol libraries. More...

#include <lib_field.h>

Inheritance diagram for LIB_FIELD:

Public Types
enum	LIB_CONVERT : int { BASE = 1 , DEMORGAN = 2 }

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

Public Member Functions
	LIB_FIELD (int aId=2)

	LIB_FIELD (int aId, const wxString &aName)

	LIB_FIELD (LIB_SYMBOL *aParent, int aId=2, const wxString &aName=wxEmptyString)

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

wxString	GetTypeName () const override
	Provide a user-consumable name of the object type. More...

void	Init (int aId)
	Object constructor initialization helper. More...

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)
	Set a user definable field name to aName. More...

int	GetId () const

void	SetId (int aId)

int	GetPenWidth () const override

KIFONT::FONT *	getDrawFont () const override

void	Copy (LIB_FIELD *aTarget) const
	Copy parameters of this field to another field. More...

void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the all the layers within the VIEW the object is painted on. More...

const BOX2I	GetBoundingBox () const override
	Return the orthogonal bounding box of this object for display purposes. 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...

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

LIB_FIELD &	operator= (const LIB_FIELD &field)

wxString	GetFullText (int unit=1) const
	Return the text of a field. More...

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

SCH_LAYER_ID	GetDefaultLayer () const

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

void	Offset (const VECTOR2I &aOffset) override
	Set the drawing object by aOffset from the current position. More...

void	MoveTo (const VECTOR2I &aPosition) override
	Move a draw object to aPosition. More...

VECTOR2I	GetPosition () const override

void	MirrorHorizontal (const VECTOR2I &aCenter) override
	Mirror the draw object along the horizontal (X) axis about aCenter point. More...

void	MirrorVertical (const VECTOR2I &aCenter) override
	Mirror the draw object along the MirrorVertical (Y) axis about aCenter point. More...

void	Rotate (const VECTOR2I &aCenter, bool aRotateCCW=true) override
	Rotate the object about aCenter point. More...

void	Plot (PLOTTER *aPlotter, bool aBackground, const VECTOR2I &aOffset, const TRANSFORM &aTransform, bool aDimmed) const override
	Plot the draw item using the plot object. More...

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

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

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

bool	IsMandatory () const

bool	IsAutoAdded () const

void	SetAutoAdded (bool aAutoAdded)

bool	IsNameShown () const

void	SetNameShown (bool aShown=true)

bool	CanAutoplace () const

void	SetCanAutoplace (bool aCanPlace)

bool	ShowInChooser () const

void	SetShowInChooser (bool aShow=true)

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

virtual void	EndEdit ()
	End an object editing action. More...

virtual void	Print (const RENDER_SETTINGS aSettings, const VECTOR2I &aOffset, void aData, const TRANSFORM &aTransform, bool aDimmed)
	Draw an item. More...

const wxString &	GetDefaultFont () const

virtual int	GetEffectivePenWidth (const RENDER_SETTINGS *aSettings) const

LIB_SYMBOL *	GetParent () const

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

bool	operator== (const LIB_ITEM &aOther) const
	Test LIB_ITEM objects for equivalence. More...

bool	operator== (const LIB_ITEM *aOther) const

bool	operator< (const LIB_ITEM &aOther) const
	Test if another draw item is less than this draw object. More...

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

void	SetPosition (const VECTOR2I &aPosition) override

void	SetUnit (int aUnit)

int	GetUnit () const

void	SetConvert (int aConvert)

int	GetConvert () const

void	SetPrivate (bool aPrivate)

bool	IsPrivate () const

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

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

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

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

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 bool	Matches (const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData. More...

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

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

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

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

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

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

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

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

wxAny	Get (PROPERTY_BASE *aProperty) const

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

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

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

virtual VECTOR2I	GetDrawPos () const

virtual void	ClearRenderCache ()

virtual void	ClearBoundingBoxCache ()

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

void	SetupRenderCache (const wxString &aResolvedText, const 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
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
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
int	m_unit
	Unit identification for multiple parts per package. More...

int	m_convert
	Shape identification for alternate body styles. More...

bool	m_private
	Private items are shown only in the Symbol Editor. More...

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
int	compare (const LIB_ITEM &aOther, int aCompareFlags=0) const override
	Provide the draw object specific comparison called by the == and < operators. More...

void	print (const RENDER_SETTINGS aSettings, const VECTOR2I &aOffset, void aData, const TRANSFORM &aTransform, bool aDimmed) override
	Print the field. More...

void	CalcEdit (const VECTOR2I &aPosition) override
	Calculate the new circle at aPosition when editing. More...

Private Attributes
int	m_id

wxString	m_name
	Name (not the field text value itself, that is #EDA_TEXT::m_Text) More...

bool	m_autoAdded
	Was this field automatically added to a LIB_SYMBOL? More...

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

bool	m_allowAutoPlace
	This field can be autoplaced when converted to a SCH_FIELD. More...

bool	m_showInChooser
	This field is available as a data column for the chooser. More...

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

VIEW_ITEM_DATA *	m_viewPrivData

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

Friends
class	SCH_LEGACY_PLUGIN_CACHE

Detailed Description

Field object used in symbol libraries.

At least MANDATORY_FIELDS are always present in a RAM-resident library symbol. All constructors must ensure this because the symbol property editor assumes it.

A field is a string linked to a symbol. Unlike purely graphical text, fields can be used in netlist generation and other tools (BOM).

The first 4 fields have a special meaning:

0 = REFERENCE_FIELD 1 = VALUE_FIELD 2 = FOOTPRINT_FIELD (default Footprint) 3 = DATASHEET_FIELD (user doc link)

others = free fields

See also: enum MANDATORY_FIELD_T

Definition at line 60 of file lib_field.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum LIB_ITEM::COMPARE_FLAGS : int

inherited

The list of flags used by the compare function.

UNIT This flag relaxes unit, conversion and pin number constraints. It is used for LIB_ITEM object unit comparisons.
EQUALITY This flag relaxes ordering contstraints so that fields, etc. don't have to appear in the same order to be considered equal.
ERC This flag relaxes constraints on data that is settable in the schematic editor. It compares only symbol-editor-only data.

Enumerator
UNIT
EQUALITY
ERC

Definition at line 82 of file lib_item.h.

 {
 UNIT = 0x01,
 EQUALITY = 0x02,
 ERC = 0x04
 };

◆ LIB_CONVERT

enum LIB_ITEM::LIB_CONVERT : int

inherited

Enumerator
BASE
DEMORGAN

Definition at line 70 of file lib_item.h.

70: int { BASE = 1, DEMORGAN = 2 };

LIB_ITEM::BASE

@ BASE

Definition: lib_item.h:70

LIB_ITEM::DEMORGAN

@ DEMORGAN

Definition: lib_item.h:70

Constructor & Destructor Documentation

◆ LIB_FIELD() [1/3]

LIB_FIELD::LIB_FIELD ( int aId = 2 )

Definition at line 52 of file lib_field.cpp.

 :
 LIB_ITEM( LIB_FIELD_T, nullptr ),
 EDA_TEXT( schIUScale )
{
 Init( aId );
}

References Init().

Referenced by Clone().

◆ LIB_FIELD() [2/3]

LIB_FIELD::LIB_FIELD	(	int	aId,
		const wxString &	aName
	)

Definition at line 60 of file lib_field.cpp.

 :
 LIB_ITEM( LIB_FIELD_T, nullptr ),
 EDA_TEXT( schIUScale )
{
 Init( aId );
 m_name = aName;
}

References Init(), and m_name.

◆ LIB_FIELD() [3/3]

LIB_FIELD::LIB_FIELD	(	LIB_SYMBOL *	aParent,
		int	aId = `2`,
		const wxString &	aName = `wxEmptyString`
	)

Definition at line 43 of file lib_field.cpp.

 :
 LIB_ITEM( LIB_FIELD_T, aParent ),
 EDA_TEXT( schIUScale )
{
 Init( aId );
 m_name = aName;
}

References Init(), and m_name.

Member Function Documentation

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

◆ BeginEdit()

void LIB_FIELD::BeginEdit ( const VECTOR2I & aPosition )

overridevirtual

Begin drawing a symbol library draw item at aPosition.

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

Parameters

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

Reimplemented from LIB_ITEM.

Definition at line 523 of file lib_field.cpp.

{
 SetTextPos( aPosition );
}

References EDA_TEXT::SetTextPos().

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

◆ CalcEdit()

void LIB_FIELD::CalcEdit ( const VECTOR2I & aPosition )

overrideprivatevirtual

Calculate the new circle at aPosition when editing.

Parameters

aPosition - The position to edit the circle in drawing coordinates.

Reimplemented from LIB_ITEM.

Definition at line 529 of file lib_field.cpp.

{
 SetTextPos( aPosition );
}

References EDA_TEXT::SetTextPos().

◆ CanAutoplace()

bool LIB_FIELD::CanAutoplace ( ) const

inline

Definition at line 183 of file lib_field.h.

183{ return m_allowAutoPlace; }

LIB_FIELD::m_allowAutoPlace

bool m_allowAutoPlace

This field can be autoplaced when converted to a SCH_FIELD.

Definition: lib_field.h:227

References m_allowAutoPlace.

Referenced by DIALOG_LIB_FIELD_PROPERTIES::DIALOG_LIB_FIELD_PROPERTIES(), SCH_FIELD::ImportValues(), DIALOG_CHANGE_SYMBOLS::processSymbols(), and SCH_SEXPR_PLUGIN_CACHE::saveField().

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

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

◆ 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 EDA_TEXT::ClearRenderCache ( )

virtualinherited

Reimplemented in SCH_FIELD, and PCB_DIMENSION_BASE.

Definition at line 440 of file eda_text.cpp.

{
 m_render_cache.clear();
}

References EDA_TEXT::m_render_cache.

Referenced by EDA_TEXT::cacheShownText(), SCH_FIELD::ClearRenderCache(), PCB_DIMENSION_BASE::ClearRenderCache(), EDA_TEXT::CopyText(), EDA_TEXT::Empty(), EDA_TEXT::Replace(), EDA_TEXT::SetAttributes(), EDA_TEXT::SetBold(), EDA_TEXT::SetFont(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), EDA_TEXT::SetKeepUpright(), EDA_TEXT::SetLineSpacing(), EDA_TEXT::SetMirrored(), EDA_TEXT::SetMultilineAllowed(), EDA_TEXT::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextHeight(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), EDA_TEXT::SetTextWidth(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), EDA_TEXT::SwapAttributes(), EDA_TEXT::SwapText(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and EE_POINT_EDITOR::updateParentItem().

◆ 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 * LIB_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 198 of file lib_field.cpp.

{
 LIB_FIELD* newfield = new LIB_FIELD( m_id );
 
 Copy( newfield );
 
 return (EDA_ITEM*) newfield;
}

References Copy(), LIB_FIELD(), and m_id.

◆ 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 );
}

◆ compare()

int LIB_FIELD::compare	(	const LIB_ITEM &	aOther,
		int	aCompareFlags = `0`
	)		const

overrideprivatevirtual

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

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

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

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

Parameters

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

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

The field specific sort order is as follows:

 - Field ID, REFERENCE, VALUE, etc.
 - Field string, case insensitive compare.
 - Field horizontal (X) position.
 - Field vertical (Y) position.
 - Field width.
 - Field height.

Reimplemented from LIB_ITEM.

Definition at line 222 of file lib_field.cpp.

{
 wxASSERT( aOther.Type() == LIB_FIELD_T );
 
 int retv = LIB_ITEM::compare( aOther, aCompareFlags );
 
 if( retv )
 return retv;
 
 const LIB_FIELD* tmp = ( LIB_FIELD* ) &aOther;
 
 // Equality test will vary depending whether or not the field is mandatory. Otherwise,
 // sorting is done by ordinal.
 if( aCompareFlags & LIB_ITEM::COMPARE_FLAGS::EQUALITY )
 {
 // Mandatory fields have fixed ordinals and their names can vary due to translated field
 // names. Optional fields have fixed names and their ordinals can vary.
 if( IsMandatory() )
 {
 if( m_id != tmp->m_id )
 return m_id - tmp->m_id;
 }
 else
 {
 retv = m_name.Cmp( tmp->m_name );
 
 if( retv )
 return retv;
 }
 }
 else
 {
 if( m_id != tmp->m_id )
 return m_id - tmp->m_id;
 }
 
 retv = GetText().CmpNoCase( tmp->GetText() );
 
 if( retv != 0 )
 return retv;
 
 if( GetTextPos().x != tmp->GetTextPos().x )
 return GetTextPos().x - tmp->GetTextPos().x;
 
 if( GetTextPos().y != tmp->GetTextPos().y )
 return GetTextPos().y - tmp->GetTextPos().y;
 
 if( GetTextWidth() != tmp->GetTextWidth() )
 return GetTextWidth() - tmp->GetTextWidth();
 
 if( GetTextHeight() != tmp->GetTextHeight() )
 return GetTextHeight() - tmp->GetTextHeight();
 
 return 0;
}

References LIB_ITEM::compare(), EDA_TEXT::GetText(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextWidth(), IsMandatory(), LIB_FIELD_T, m_id, m_name, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by LIB_SYMBOL::Compare().

◆ ContinueEdit()

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

inlinevirtualinherited

Continue an edit in progress at aPosition.

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

Parameters

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

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

Reimplemented in LIB_SHAPE.

Definition at line 116 of file lib_item.h.

116{ return false; }

◆ Copy()

void LIB_FIELD::Copy ( LIB_FIELD * aTarget ) const

Copy parameters of this field to another field.

Pointers are not copied.

Parameters

aTarget Target field to copy values to.

Definition at line 208 of file lib_field.cpp.

{
 aTarget->m_name = m_name;
 aTarget->m_showName = m_showName;
 aTarget->m_allowAutoPlace = m_allowAutoPlace;
 aTarget->m_showInChooser = m_showInChooser;
 
 aTarget->CopyText( *this );
 aTarget->SetAttributes( *this );
 aTarget->SetParent( m_parent );
 aTarget->SetAutoAdded( IsAutoAdded() );
}

References EDA_TEXT::CopyText(), IsAutoAdded(), m_allowAutoPlace, m_name, EDA_ITEM::m_parent, m_showInChooser, m_showName, EDA_TEXT::SetAttributes(), SetAutoAdded(), and EDA_ITEM::SetParent().

Referenced by Clone().

◆ 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 Copy(), and CLIPBOARD_IO::SaveSelection().

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

◆ EndEdit()

virtual void LIB_ITEM::EndEdit ( )

inlinevirtualinherited

End an object editing action.

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

Reimplemented in LIB_SHAPE.

Definition at line 123 of file lib_item.h.

123{}

◆ 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 LIB_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 425 of file lib_field.cpp.

{
 /* Y coordinates for LIB_ITEMS are bottom to top, so we must invert the Y position when
 * calling GetTextBox() that works using top to bottom Y axis orientation.
 */
 BOX2I bbox = GetTextBox( -1, true );
 bbox.RevertYAxis();
 
 // We are using now a bottom to top Y axis.
 VECTOR2I orig = bbox.GetOrigin();
 VECTOR2I end = bbox.GetEnd();
 
 RotatePoint( orig, GetTextPos(), -GetTextAngle() );
 RotatePoint( end, GetTextPos(), -GetTextAngle() );
 
 bbox.SetOrigin( orig );
 bbox.SetEnd( end );
 
 // We are using now a top to bottom Y axis:
 bbox.RevertYAxis();
 
 return bbox;
}

References BOX2< Vec >::GetEnd(), BOX2< Vec >::GetOrigin(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextPos(), BOX2< Vec >::RevertYAxis(), RotatePoint(), BOX2< Vec >::SetEnd(), and BOX2< Vec >::SetOrigin().

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

◆ GetCanonicalName()

wxString LIB_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 485 of file lib_field.cpp.

{
 switch( m_id )
 {
 case REFERENCE_FIELD:
 case VALUE_FIELD:
 case FOOTPRINT_FIELD:
 case DATASHEET_FIELD:
 return TEMPLATE_FIELDNAME::GetDefaultFieldName( m_id );
 }
 
 return m_name;
}

References DATASHEET_FIELD, FOOTPRINT_FIELD, TEMPLATE_FIELDNAME::GetDefaultFieldName(), m_id, m_name, REFERENCE_FIELD, and VALUE_FIELD.

Referenced by KI_TEST::FieldNameIdMatches(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), DIALOG_CHANGE_SYMBOLS::onOkButtonClicked(), BOOST_TEST_PRINT_NAMESPACE_OPEN::print_log_value< LIB_FIELD >::operator()(), SCH_SEXPR_PARSER::parseProperty(), DIALOG_CHANGE_SYMBOLS::processSymbols(), and SCH_LIB_PLUGIN_CACHE::removeSymbol().

◆ GetClass()

wxString LIB_FIELD::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 71 of file lib_field.h.

 {
 return wxT( "LIB_FIELD" );
 }

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Properties().

◆ GetConvert()

int LIB_ITEM::GetConvert ( ) const

inlineinherited

Definition at line 276 of file lib_item.h.

276{ return m_convert; }

LIB_ITEM::m_convert

int m_convert

Shape identification for alternate body styles.

Definition: lib_item.h:333

References LIB_ITEM::m_convert.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_PIN::GetMsgPanelInfo(), EE_COLLECTOR::Inspect(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), EE_SELECTION_TOOL::Selectable(), sort_by_pin_number(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetDefaultFont()

const wxString & LIB_ITEM::GetDefaultFont ( ) const

inherited

Definition at line 128 of file lib_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(), LIB_TEXT::getDrawFont(), LIB_TEXTBOX::getDrawFont(), and LIB_TEXTBOX::GetShownText().

◆ GetDefaultLayer()

SCH_LAYER_ID LIB_FIELD::GetDefaultLayer ( ) const

Definition at line 465 of file lib_field.cpp.

{
 switch( m_id )
 {
 case REFERENCE_FIELD: return LAYER_REFERENCEPART;
 case VALUE_FIELD: return LAYER_VALUEPART;
 default: return LAYER_FIELDS;
 }
}

References LAYER_FIELDS, LAYER_REFERENCEPART, LAYER_VALUEPART, m_id, REFERENCE_FIELD, and VALUE_FIELD.

Referenced by Plot(), and print().

◆ getDrawFont()

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

overridevirtual

Reimplemented from EDA_TEXT.

Definition at line 120 of file lib_field.cpp.

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

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

virtual EDA_ANGLE EDA_TEXT::GetDrawRotation ( ) const

inlinevirtualinherited

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

◆ GetEffectivePenWidth()

virtual int LIB_ITEM::GetEffectivePenWidth ( const RENDER_SETTINGS * aSettings ) const

inlinevirtualinherited

Definition at line 155 of file lib_item.h.

 {
 // For historical reasons, a stored value of 0 means "default width" and negative
 // numbers meant "don't stroke".
 
 if( GetPenWidth() < 0 )
 return 0;
 else if( GetPenWidth() == 0 )
 return std::max( aSettings->GetDefaultPenWidth(), aSettings->GetMinPenWidth() );
 else
 return std::max( GetPenWidth(), aSettings->GetMinPenWidth() );
 }

References KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), and LIB_ITEM::GetPenWidth().

Referenced by Plot(), LIB_SHAPE::Plot(), LIB_TEXTBOX::Plot(), LIB_PIN::PlotSymbol(), print(), LIB_SHAPE::print(), LIB_TEXTBOX::print(), and LIB_PIN::printPinSymbol().

◆ 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(), GetPenWidth(), LIB_TEXT::GetPenWidth(), SCH_FIELD::GetPenWidth(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_TEXT::GetPenWidth(), EDA_TEXT::GetTextBox(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::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().

◆ 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(), getDrawFont(), LIB_TEXT::getDrawFont(), LIB_TEXTBOX::getDrawFont(), SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), KIGFX::SCH_PAINTER::getFont(), EDA_TEXT::GetFontName(), GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::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_FIELD::GetRenderCache(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), 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().

◆ GetFullText()

wxString LIB_FIELD::GetFullText ( int unit = 1 ) const

Return the text of a field.

If the field is the reference field, the unit number is used to create a pseudo reference text. If the base reference field is U, the string U?A will be returned for unit = 1.

Parameters

unit	- The package unit number. Only effects reference field.

Returns: Field text.

Definition at line 397 of file lib_field.cpp.

{
 if( m_id != REFERENCE_FIELD )
 return GetText();
 
 wxString text = GetText();
 text << wxT( "?" );
 
 wxCHECK( GetParent(), text );
 
 if( GetParent()->IsMulti() )
 text << LIB_SYMBOL::SubReference( unit );
 
 return text;
}

References LIB_ITEM::GetParent(), EDA_TEXT::GetText(), m_id, REFERENCE_FIELD, LIB_SYMBOL::SubReference(), and text.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), LIB_SYMBOL::PlotLibFields(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), and DIALOG_CHOOSE_SYMBOL::ShowFootprintFor().

◆ 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(), SCH_FIELD::GetEffectiveHorizJustify(), GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), EDA_TEXT::GetTextBox(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::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(), SCH_FIELD::Plot(), positioningChanged(), 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 LIB_FIELD::GetId ( ) const

inline

Definition at line 114 of file lib_field.h.

114{ return m_id; }

References m_id.

Referenced by LIB_SYMBOL::Compare(), DIALOG_LIB_FIELD_PROPERTIES::DIALOG_LIB_FIELD_PROPERTIES(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), KI_TEST::FieldNameIdMatches(), LIB_SYMBOL::GetFieldById(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), LIB_SYMBOL::PlotLibFields(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), and LIB_SYMBOL::UpdateFieldOrdinals().

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

◆ GetItemDescription()

wxString LIB_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 517 of file lib_field.cpp.

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

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

◆ 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 LIB_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 574 of file lib_field.cpp.

{
 return BITMAPS::move;
}

References move.

◆ GetMsgPanelInfo()

void LIB_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 535 of file lib_field.cpp.

{
 wxString msg;
 
 LIB_ITEM::GetMsgPanelInfo( aFrame, aList );
 
 aList.emplace_back( _( "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(), LIB_ITEM::GetMsgPanelInfo(), 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 LIB_FIELD::GetName ( bool aUseDefaultName = true ) const

Return the field name (not translated).

The first four field IDs are reserved and therefore always return their respective names.

The user definable fields will return FieldN where N is the ID of the field when the m_name member is empty unless false is passed to aUseDefaultName.

Definition at line 476 of file lib_field.cpp.

{
 if( m_name.IsEmpty() && aUseDefaultName )
 return TEMPLATE_FIELDNAME::GetDefaultFieldName( m_id );
 
 return m_name;
}

References TEMPLATE_FIELDNAME::GetDefaultFieldName(), m_id, and m_name.

Referenced by LIB_SYMBOL::Compare(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), LIB_SYMBOL::Flatten(), LIB_SYMBOL::GetChooserFields(), GetItemDescription(), GetMsgPanelInfo(), GetShownText(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), DIALOG_LIB_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_SEXPR_PLUGIN_CACHE::saveField(), and DIALOG_LIB_SYMBOL_PROPERTIES::Validate().

◆ GetParent()

LIB_SYMBOL * LIB_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 168 of file lib_item.h.

 {
 return (LIB_SYMBOL*) m_parent;
 }

References EDA_ITEM::m_parent.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), LIB_PIN::GetBoundingBox(), GetFullText(), LIB_PIN::IsGlobalPower(), LIB_PIN::Plot(), LIB_PIN::print(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetPenWidth()

int LIB_FIELD::GetPenWidth ( ) const

overridevirtual

Implements LIB_ITEM.

Definition at line 114 of file lib_field.cpp.

{
 return GetEffectiveTextPenWidth();
}

References EDA_TEXT::GetEffectiveTextPenWidth().

◆ GetPosition()

VECTOR2I LIB_FIELD::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 160 of file lib_field.h.

160{ return EDA_TEXT::GetTextPos(); }

References EDA_TEXT::GetTextPos().

Referenced by SCH_ALTIUM_PLUGIN::ParsePowerPort(), and SCH_SEXPR_PLUGIN_CACHE::saveField().

◆ GetRenderCache()

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

inherited

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

◆ GetShownText()

wxString LIB_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 414 of file lib_field.cpp.

{
 wxString text = EDA_TEXT::GetShownText( aDepth );
 
 if( IsNameShown() )
 text = GetName() << wxT( ": " ) << text;
 
 return text;
}

References GetName(), EDA_TEXT::GetShownText(), IsNameShown(), and text.

Referenced by KIGFX::SCH_PAINTER::draw(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), GetItemDescription(), Plot(), and LIB_SYMBOL::PlotLibFields().

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

◆ 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(), 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(), GetFullText(), SCH_LABEL_BASE::GetIntersheetRefs(), PCB_DIMENSION_BASE::GetItemDescription(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet(), FP_TEXT::GetLength(), GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::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(), 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(), SCH_FIELD::operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), operator=(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceText(), Plot(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), DIALOG_RESCUE_EACH::PopulateInstanceList(), 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(), GetBoundingBox(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), LIB_TEXTBOX::GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), EDA_TEXT::GetDrawRotation(), SCH_FIELD::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(), 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(), SCH_FIELD::Plot(), Plot(), LIB_TEXT::Plot(), positioningChanged(), SCH_FIELD::Print(), print(), LIB_TEXT::print(), SCH_EDIT_TOOL::Rotate(), SCH_TEXTBOX::Rotate(), LIB_TEXTBOX::Rotate(), 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(), GetBoundingBox(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::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(), SCH_FIELD::GetFieldColor(), SCH_LABEL_BASE::GetLabelColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), SCH_FIELD::Print(), 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(), 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(), 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(), GetBoundingBox(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::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(), SCH_FIELD::GetLibPosition(), GetPosition(), LIB_TEXT::GetPosition(), SCH_FIELD::GetPosition(), SCH_TEXT::GetPosition(), DS_DRAW_ITEM_TEXT::GetPosition(), FP_TEXT::GetPosition(), PCB_TEXT::GetPosition(), ALTIUM_PCB::HelperParseDimensions6Radial(), HitTest(), LIB_TEXT::HitTest(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PCB_POINT_EDITOR::makePoints(), FP_TEXT::Mirror(), PCB_TEXT::Mirror(), PCB_DIMENSION_BASE::Mirror(), MirrorHorizontal(), LIB_TEXT::MirrorHorizontal(), SCH_SHEET_PIN::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), MirrorVertical(), LIB_TEXT::MirrorVertical(), SCH_SHEET_PIN::MirrorVertically(), SCH_TEXT::MirrorVertically(), LIB_TEXT::NormalizeJustification(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), DRAWING_TOOL::PlaceText(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), print(), SCH_LABEL_BASE::Print(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), 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(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), SCH_FIELD::Print(), 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 GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), and SCH_FIELD::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 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(), GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::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().

◆ GetTypeName()

wxString LIB_FIELD::GetTypeName ( ) const

inlineoverridevirtual

Provide a user-consumable name of the object type.

Perform localization when called so that run-time language selection works.

Implements LIB_ITEM.

Definition at line 76 of file lib_field.h.

 {
 return _( "Field" );
 }

References _.

◆ GetUnit()

int LIB_ITEM::GetUnit ( ) const

inlineinherited

Definition at line 273 of file lib_item.h.

273{ return m_unit; }

LIB_ITEM::m_unit

int m_unit

Unit identification for multiple parts per package.

Definition: lib_item.h:327

References LIB_ITEM::m_unit.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), SCH_SYMBOL::GetEndPoints(), EE_COLLECTOR::Inspect(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), SYMBOL_EDITOR_MOVE_TOOL::Main(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), EE_SELECTION_TOOL::Selectable(), PIN_TABLE_DATA_MODEL::SetValue(), sort_by_pin_number(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ 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(), SCH_FIELD::GetEffectiveVertJustify(), EDA_TEXT::GetLinePositions(), GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), EDA_TEXT::GetTextBox(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::IsVertJustifyFlipped(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), SCH_FIELD::Plot(), positioningChanged(), 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().

◆ 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(), SCH_FIELD::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 LIB_ITEM::HitTest	(	const BOX2I &	aRect,
		bool	aContained,
		int	aAccuracy = `0`
	)		const

overridevirtualinherited

Test if aRect intersects this item.

Parameters

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

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

Reimplemented from EDA_ITEM.

Reimplemented in LIB_PIN, LIB_SHAPE, LIB_TEXT, and LIB_TEXTBOX.

Definition at line 111 of file lib_item.cpp.

{
 if( m_flags & (STRUCT_DELETED | SKIP_STRUCT ) )
 return false;
 
 BOX2I sel = aRect;
 
 if ( aAccuracy )
 sel.Inflate( aAccuracy );
 
 if( aContained )
 return sel.Contains( GetBoundingBox() );
 
 return sel.Intersects( GetBoundingBox() );
}

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

◆ HitTest() [2/2]

bool LIB_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 164 of file lib_field.cpp.

{
 // Because HitTest is mainly used to select the field return false if it is empty
 if( GetText().IsEmpty() )
 return false;
 
 // Build a temporary copy of the text for hit testing
 EDA_TEXT tmp_text( *this );
 
 // Reference designator text has one or 2 additional character (displays U? or U?A)
 if( m_id == REFERENCE_FIELD )
 {
 const LIB_SYMBOL* parent = dynamic_cast<const LIB_SYMBOL*>( m_parent );
 
 wxString extended_text = tmp_text.GetText();
 extended_text.Append('?');
 
 if ( parent && parent->GetUnitCount() > 1 )
 extended_text.Append('A');
 
 tmp_text.SetText( extended_text );
 }
 
 tmp_text.SetTextPos( DefaultTransform.TransformCoordinate( GetTextPos() ) );
 
 // The text orientation may need to be flipped if the transformation matrix causes xy axes
 // to be flipped. This simple algo works only for schematic matrix (rot 90 or/and mirror)
 bool t1 = ( DefaultTransform.x1 != 0 ) ^ ( GetTextAngle() != ANGLE_HORIZONTAL );
 tmp_text.SetTextAngle( t1 ? ANGLE_HORIZONTAL : ANGLE_VERTICAL );
 
 return tmp_text.TextHitTest( aPosition, aAccuracy );
}

References ANGLE_HORIZONTAL, ANGLE_VERTICAL, DefaultTransform, EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), LIB_SYMBOL::GetUnitCount(), m_id, EDA_ITEM::m_parent, REFERENCE_FIELD, EDA_TEXT::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), EDA_TEXT::TextHitTest(), TRANSFORM::TransformCoordinate(), and TRANSFORM::x1.

◆ Init()

void LIB_FIELD::Init ( int aId )

Object constructor initialization helper.

Definition at line 86 of file lib_field.cpp.

{
 m_id = aId;
 
 SetTextAngle( ANGLE_HORIZONTAL ); // constructor already did this.
 
 // Fields in RAM must always have names, because we are trying to get less dependent on
 // field ids and more dependent on names. Plus assumptions are made in the field editors.
 m_name = TEMPLATE_FIELDNAME::GetDefaultFieldName( aId );
 
 // By contrast, VALUE and REFERENCE are are always constructed as initially visible, and
 // template fieldsnames' initial visibility is controlled by the template fieldname config.
 if( aId == DATASHEET_FIELD || aId == FOOTPRINT_FIELD )
 SetVisible( false );
 
 m_autoAdded = false;
 m_showName = false;
 m_allowAutoPlace = true;
 m_showInChooser = true;
}

References ANGLE_HORIZONTAL, DATASHEET_FIELD, FOOTPRINT_FIELD, TEMPLATE_FIELDNAME::GetDefaultFieldName(), m_allowAutoPlace, m_autoAdded, m_id, m_name, m_showInChooser, m_showName, EDA_TEXT::SetTextAngle(), and EDA_TEXT::SetVisible().

Referenced by LIB_FIELD().

◆ IsAutoAdded()

bool LIB_FIELD::IsAutoAdded ( ) const

inline

Definition at line 177 of file lib_field.h.

177{ return m_autoAdded; }

References m_autoAdded.

Referenced by Copy().

◆ 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(), getDrawFont(), LIB_TEXT::getDrawFont(), LIB_TEXTBOX::getDrawFont(), SCH_FIELD::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(), SCH_FIELD::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(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), 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().

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

◆ 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(), getDrawFont(), LIB_TEXT::getDrawFont(), LIB_TEXTBOX::getDrawFont(), SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), KIGFX::SCH_PAINTER::getFont(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::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(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), 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().

◆ IsMandatory()

bool LIB_FIELD::IsMandatory ( ) const

Definition at line 580 of file lib_field.cpp.

{
 return m_id >= 0 && m_id < MANDATORY_FIELDS;
}

References m_id, and MANDATORY_FIELDS.

Referenced by compare(), LIB_SYMBOL::Compare(), LIB_SYMBOL::Flatten(), LIB_SYMBOL::GetFields(), SetName(), and LIB_SYMBOL::UpdateFieldOrdinals().

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

◆ 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 LIB_FIELD::IsNameShown ( ) const

inline

Definition at line 180 of file lib_field.h.

180{ return m_showName; }

References m_showName.

Referenced by DIALOG_LIB_FIELD_PROPERTIES::DIALOG_LIB_FIELD_PROPERTIES(), GetShownText(), SCH_FIELD::ImportValues(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), DIALOG_CHANGE_SYMBOLS::processSymbols(), and SCH_SEXPR_PLUGIN_CACHE::saveField().

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

◆ IsPrivate()

bool LIB_ITEM::IsPrivate ( ) const

inlineinherited

Definition at line 279 of file lib_item.h.

279{ return m_private; }

LIB_ITEM::m_private

bool m_private

Private items are shown only in the Symbol Editor.

Definition: lib_item.h:338

References LIB_ITEM::m_private.

Referenced by LIB_ITEM::compare(), KIGFX::SCH_PAINTER::draw(), LIB_ITEM::GetMsgPanelInfo(), LIB_SHAPE::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), LIB_SHAPE::print(), LIB_TEXTBOX::print(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), LIB_SHAPE::ViewGetLayers(), LIB_TEXT::ViewGetLayers(), and LIB_TEXTBOX::ViewGetLayers().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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 in LIB_TEXTBOX, SCH_FIELD, SCH_LABEL, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 420 of file eda_item.h.

420{ return false; }

Referenced by EDA_ITEM::Matches().

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

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

inlinevirtualinherited

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 in SCH_FIELD, SCH_ITEM, SCH_LABEL_BASE, SCH_LINE, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, and PCB_VIA.

Definition at line 181 of file eda_item.h.

 {
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == SCH_LOCATE_ANY_T || scanType == m_structType )
 return true;
 }
 
 return false;
 }

References EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_FIELD::GetCanonicalName(), KIGFX::SCH_PAINTER::getLineWidth(), SCH_FIELD::GetName(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_FIELD::GetShownText(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_ITEM::IsType(), FP_TEXT::IsType(), FP_TEXTBOX::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), PCB_SHAPE::IsType(), PCB_TEXT::IsType(), PCB_TEXTBOX::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), CONVERT_TOOL::makePolysFromChainedSegs(), EE_SELECTION_TOOL::RequestSelection(), SCH_FIELD::SetId(), SCH_BASE_FRAME::UpdateItem(), and EDA_ITEM::Visit().

◆ 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(), GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), SCH_FIELD::HitTest(), DRC_RTREE::Insert(), EDA_TEXT::IsDefaultFormatting(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_FIELD::Matches(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_FIELD::Plot(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), SCH_FIELD::Print(), LIB_SYMBOL::Print(), 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]

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

inlinevirtualinherited

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 in SCH_MARKER, LIB_TEXTBOX, SCH_FIELD, SCH_LABEL_BASE, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, FP_TEXT, FP_TEXTBOX, NETINFO_ITEM, PCB_MARKER, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 382 of file eda_item.h.

 {
 return false;
 }

Referenced by SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_FIND_REPLACE_TOOL::HasMatch(), SCH_MARKER::Matches(), LIB_TEXTBOX::Matches(), SCH_FIELD::Matches(), SCH_LABEL_BASE::Matches(), SCH_PIN::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_TEXTBOX::Matches(), FP_TEXT::Matches(), FP_TEXTBOX::Matches(), NETINFO_ITEM::Matches(), PCB_MARKER::Matches(), PCB_TEXT::Matches(), PCB_TEXTBOX::Matches(), ZONE::Matches(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

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

◆ MirrorHorizontal()

void LIB_FIELD::MirrorHorizontal ( const VECTOR2I & aCenter )

overridevirtual

Mirror the draw object along the horizontal (X) axis about aCenter point.

Parameters

aCenter Point to mirror around.

Implements LIB_ITEM.

Definition at line 291 of file lib_field.cpp.

{
 int x = GetTextPos().x;
 
 x -= center.x;
 x *= -1;
 x += center.x;
 
 SetTextX( x );
}

References EDA_TEXT::GetTextPos(), EDA_TEXT::SetTextX(), and VECTOR2< T >::x.

◆ MirrorVertical()

void LIB_FIELD::MirrorVertical ( const VECTOR2I & aCenter )

overridevirtual

Mirror the draw object along the MirrorVertical (Y) axis about aCenter point.

Parameters

aCenter Point to mirror around.

Implements LIB_ITEM.

Definition at line 303 of file lib_field.cpp.

{
 int y = GetTextPos().y;
 
 y -= center.y;
 y *= -1;
 y += center.y;
 
 SetTextY( y );
}

References EDA_TEXT::GetTextPos(), EDA_TEXT::SetTextY(), and VECTOR2< T >::y.

◆ MoveTo()

void LIB_FIELD::MoveTo ( const VECTOR2I & aPosition )

overridevirtual

Move a draw object to aPosition.

Parameters

aPosition Position to move draw item to.

Implements LIB_ITEM.

Definition at line 285 of file lib_field.cpp.

{
 EDA_TEXT::SetTextPos( newPosition );
}

References EDA_TEXT::SetTextPos().

◆ Offset()

void LIB_FIELD::Offset ( const VECTOR2I & aOffset )

overridevirtual

Set the drawing object by aOffset from the current position.

Parameters

aOffset Coordinates to offset the item position.

Implements LIB_ITEM.

Definition at line 279 of file lib_field.cpp.

{
 EDA_TEXT::Offset( aOffset );
}

References EDA_TEXT::Offset().

◆ 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 LIB_ITEM::operator< ( const LIB_ITEM & aOther ) const

inherited

Test if another draw item is less than this draw object.

Parameters

aOther - Draw item to compare against.

Returns: - True if object is less than this object.

Definition at line 102 of file lib_item.cpp.

{
 if( Type() != aOther.Type() )
 return Type() < aOther.Type();
 
 return ( compare( aOther ) < 0 );
}

References LIB_ITEM::compare(), and EDA_ITEM::Type().

◆ operator=()

LIB_FIELD & LIB_FIELD::operator= ( const LIB_FIELD & field )

Definition at line 69 of file lib_field.cpp.

{
 m_id = field.m_id;
 m_name = field.m_name;
 m_parent = field.m_parent;
 m_autoAdded = field.m_autoAdded;
 m_showName = field.m_showName;
 m_allowAutoPlace = field.m_allowAutoPlace;
 m_showInChooser = field.m_showInChooser;
 
 SetText( field.GetText() );
 SetAttributes( field );
 
 return *this;
}

References EDA_TEXT::GetText(), m_allowAutoPlace, m_autoAdded, m_id, m_name, EDA_ITEM::m_parent, m_showInChooser, m_showName, EDA_TEXT::SetAttributes(), and EDA_TEXT::SetText().

◆ operator==() [1/2]

bool LIB_ITEM::operator== ( const LIB_ITEM & aOther ) const

inherited

Test LIB_ITEM objects for equivalence.

Parameters

aOther Object to test against.

Returns: True if object is identical to this object.

Definition at line 93 of file lib_item.cpp.

{
 if( Type() != aOther.Type() )
 return false;
 
 return compare( aOther, LIB_ITEM::COMPARE_FLAGS::EQUALITY ) == 0;
}

References LIB_ITEM::compare(), and EDA_ITEM::Type().

◆ operator==() [2/2]

bool LIB_ITEM::operator== ( const LIB_ITEM * aOther ) const

inlineinherited

Definition at line 207 of file lib_item.h.

 {
 return *this == *aOther;
 }

◆ Plot()

void LIB_FIELD::Plot	(	PLOTTER *	aPlotter,
		bool	aBackground,
		const VECTOR2I &	aOffset,
		const TRANSFORM &	aTransform,
		bool	aDimmed
	)		const

overridevirtual

Plot the draw item using the plot object.

Parameters

aPlotter	The plot 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.
aOffset	Plot offset position.
aFill	Flag to indicate whether or not the object is filled.
aTransform	The plot transform.
aDimmed	if true, reduce color to background

Implements LIB_ITEM.

Definition at line 327 of file lib_field.cpp.

{
 if( GetText().IsEmpty() || aBackground )
 return;
 
 RENDER_SETTINGS* renderSettings = aPlotter->RenderSettings();
 
 // Calculate the text orientation, according to the symbol orientation/mirror.
 EDA_ANGLE orient = GetTextAngle();
 
 if( aTransform.y1 ) // Rotate symbol 90 deg.
 {
 if( orient.IsHorizontal() )
 orient = ANGLE_VERTICAL;
 else
 orient = ANGLE_HORIZONTAL;
 }
 
 BOX2I bbox = GetBoundingBox();
 bbox.RevertYAxis();
 
 GR_TEXT_H_ALIGN_T hjustify = GR_TEXT_H_ALIGN_CENTER;
 GR_TEXT_V_ALIGN_T vjustify = GR_TEXT_V_ALIGN_CENTER;
 VECTOR2I textpos = aTransform.TransformCoordinate( bbox.Centre() ) + aOffset;
 
 COLOR4D color;
 COLOR4D bg;
 
 if( aPlotter->GetColorMode() )
 {
 if( GetTextColor() != COLOR4D::UNSPECIFIED )
 color = GetTextColor();
 else
 color = renderSettings->GetLayerColor( GetDefaultLayer() );
 
 bg = renderSettings->GetBackgroundColor();
 
 if( bg == COLOR4D::UNSPECIFIED )
 bg = COLOR4D::WHITE;
 }
 else
 {
 color = COLOR4D::BLACK;
 bg = COLOR4D::WHITE;
 }
 
 if( aDimmed )
 {
 color.Desaturate( );
 color = color.Mix( bg, 0.5f );
 }
 
 int penWidth = GetEffectivePenWidth( renderSettings );
 KIFONT::FONT* font = GetFont();
 
 if( !font )
 font = KIFONT::FONT::GetFont( renderSettings->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 );
}

References ANGLE_HORIZONTAL, ANGLE_VERTICAL, BLACK, BOX2< Vec >::Centre(), color, EDA_TEXT::GetAttributes(), KIGFX::RENDER_SETTINGS::GetBackgroundColor(), GetBoundingBox(), PLOTTER::GetColorMode(), KIGFX::RENDER_SETTINGS::GetDefaultFont(), GetDefaultLayer(), LIB_ITEM::GetEffectivePenWidth(), EDA_TEXT::GetFont(), KIFONT::FONT::GetFont(), KIGFX::RENDER_SETTINGS::GetLayerColor(), GetShownText(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextColor(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, EDA_TEXT::IsBold(), EDA_ANGLE::IsHorizontal(), EDA_TEXT::IsItalic(), TEXT_ATTRIBUTES::m_Angle, TEXT_ATTRIBUTES::m_Halign, TEXT_ATTRIBUTES::m_Multiline, TEXT_ATTRIBUTES::m_StrokeWidth, TEXT_ATTRIBUTES::m_Valign, PLOTTER::PlotText(), PLOTTER::RenderSettings(), BOX2< Vec >::RevertYAxis(), TRANSFORM::TransformCoordinate(), WHITE, and TRANSFORM::y1.

Referenced by LIB_SYMBOL::PlotLibFields().

◆ Print() [1/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().

◆ Print() [2/2]

void LIB_ITEM::Print	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		void *	aData,
		const TRANSFORM &	aTransform,
		bool	aDimmed
	)

virtualinherited

Draw an item.

Parameters

aDC	Device Context (can be null)
aOffset	Offset to draw
aData	Value or pointer used to pass others parameters, depending on body items. Used for some items to force to force no fill mode ( has meaning only for items what can be filled ). used in printing or moving objects mode or to pass reference to the lib symbol for pins.
aTransform	Transform Matrix (rotation, mirror ..)
aDimmed	Dim the color on the printout

Definition at line 136 of file lib_item.cpp.

{
 print( aSettings, aOffset, aData, aTransform, aDimmed );
}

References LIB_ITEM::print().

Referenced by DIALOG_PIN_PROPERTIES::OnPaintShowPanel(), LIB_SYMBOL::Print(), and LIB_SYMBOL::PrintBackground().

◆ print()

void LIB_FIELD::print	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		void *	aData,
		const TRANSFORM &	aTransform,
		bool	aDimmed
	)

overrideprivatevirtual

Print the field.

If aData not NULL, aData must point a wxString which is used instead of the m_Text

Implements LIB_ITEM.

Definition at line 131 of file lib_field.cpp.

{
 wxDC* DC = aSettings->GetPrintDC();
 COLOR4D color = aSettings->GetLayerColor( IsVisible() ? GetDefaultLayer() : LAYER_HIDDEN );
 COLOR4D bg = aSettings->GetBackgroundColor();
 bool blackAndWhiteMode = GetGRForceBlackPenState();
  int penWidth = GetEffectivePenWidth( aSettings );
 VECTOR2I text_pos = aTransform.TransformCoordinate( GetTextPos() ) + aOffset;
 wxString text = aData ? *static_cast<wxString*>( aData ) : GetText();
 
 if( blackAndWhiteMode || bg == COLOR4D::UNSPECIFIED )
 bg = COLOR4D::WHITE;
 
 if( !blackAndWhiteMode && GetTextColor() != COLOR4D::UNSPECIFIED )
 color = GetTextColor();
 
 if( aDimmed )
 {
 color.Desaturate( );
 color = color.Mix( bg, 0.5f );
 }
 
 KIFONT::FONT* font = GetFont();
 
 if( !font )
 font = KIFONT::FONT::GetFont( aSettings->GetDefaultFont(), IsBold(), IsItalic() );
 
 GRPrintText( DC, text_pos, color, text, GetTextAngle(), GetTextSize(), GetHorizJustify(),
 GetVertJustify(), penWidth, IsItalic(), IsBold(), font );
}

References color, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), KIGFX::RENDER_SETTINGS::GetDefaultFont(), GetDefaultLayer(), LIB_ITEM::GetEffectivePenWidth(), EDA_TEXT::GetFont(), KIFONT::FONT::GetFont(), GetGRForceBlackPenState(), EDA_TEXT::GetHorizJustify(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetPrintDC(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextColor(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetVertJustify(), GRPrintText(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsVisible(), LAYER_HIDDEN, text, TRANSFORM::TransformCoordinate(), and WHITE.

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

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 163 of file eda_item.h.

163{ return false; }

◆ 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(), SCH_FIELD::Replace(), and SCH_SHEET_PIN::Replace().

◆ Replace() [2/3]

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

inlinevirtualinherited

Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

Parameters

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

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

Reimplemented in LIB_TEXTBOX, SCH_LABEL_BASE, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 409 of file eda_item.h.

 {
 return false;
 }

◆ 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(), SCH_FIELD::Replace(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), and SCH_FIND_REPLACE_TOOL::ReplaceAndFindNext().

◆ Rotate()

void LIB_FIELD::Rotate	(	const VECTOR2I &	aCenter,
		bool	aRotateCCW = `true`
	)

overridevirtual

Rotate the object about aCenter point.

Parameters

aCenter	Point to rotate around.
aRotateCCW	True to rotate counter clockwise. False to rotate clockwise.

Implements LIB_ITEM.

Definition at line 315 of file lib_field.cpp.

{
 EDA_ANGLE rot_angle = aRotateCCW ? -ANGLE_90 : ANGLE_90;
 
 VECTOR2I pt = GetTextPos();
 RotatePoint( pt, center, rot_angle );
 SetTextPos( pt );
 
 SetTextAngle( GetTextAngle() != ANGLE_HORIZONTAL ? ANGLE_HORIZONTAL : ANGLE_VERTICAL );
}

References ANGLE_90, ANGLE_HORIZONTAL, ANGLE_VERTICAL, EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), RotatePoint(), EDA_TEXT::SetTextAngle(), and EDA_TEXT::SetTextPos().

◆ Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 66 of file inspectable.h.

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

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 54 of file inspectable.h.

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

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

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

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

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

◆ SetAttributes() [1/2]

void EDA_TEXT::SetAttributes ( const EDA_TEXT & aSrc )

inherited

Set the text attributes from another instance.

Definition at line 266 of file eda_text.cpp.

{
 m_attributes = aSrc.m_attributes;
 m_pos = aSrc.m_pos;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and EDA_TEXT::m_pos.

Referenced by LIB_TEXT::Clone(), Copy(), SCH_FIELD::ImportValues(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), operator=(), DRAWING_TOOL::PlaceText(), DIALOG_CHANGE_SYMBOLS::processSymbols(), and CLIPBOARD_IO::SaveSelection().

◆ SetAttributes() [2/2]

void EDA_TEXT::SetAttributes ( const TEXT_ATTRIBUTES & aTextAttrs )

inlineinherited

Definition at line 171 of file eda_text.h.

171{ m_attributes = aTextAttrs; }

References EDA_TEXT::m_attributes.

◆ SetAutoAdded()

void LIB_FIELD::SetAutoAdded ( bool aAutoAdded )

inline

Definition at line 178 of file lib_field.h.

178{ m_autoAdded = aAutoAdded; }

References m_autoAdded.

Referenced by Copy(), and SCH_DATABASE_PLUGIN::loadSymbolFromRow().

◆ SetBold()

void EDA_TEXT::SetBold ( bool aBold )

inherited

Definition at line 211 of file eda_text.cpp.

{
 m_attributes.m_Bold = aBold;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, TEXT_ATTRIBUTES::m_Bold, and EDA_TEXT::m_bounding_box_cache_valid.

Referenced by SCH_ALTIUM_PLUGIN::AddTextBox(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_LABEL_PROPERTIES::OnAddField(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParseLabel(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 116 of file eda_item.h.

116{ SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:139

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetCanAutoplace()

void LIB_FIELD::SetCanAutoplace ( bool aCanPlace )

inline

Definition at line 184 of file lib_field.h.

184{ m_allowAutoPlace = aCanPlace; }

References m_allowAutoPlace.

Referenced by DIALOG_LIB_FIELD_PROPERTIES::UpdateField().

◆ SetConvert()

void LIB_ITEM::SetConvert ( int aConvert )

inlineinherited

Definition at line 275 of file lib_item.h.

275{ m_convert = aConvert; }

References LIB_ITEM::m_convert.

Referenced by BOOST_AUTO_TEST_CASE(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), LIB_PIN::LIB_PIN(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), SCH_LEGACY_PLUGIN_CACHE::loadPolyLine(), SCH_LEGACY_PLUGIN_CACHE::loadRect(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 139 of file eda_item.h.

139{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

◆ SetFont()

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

inherited

Definition at line 333 of file eda_text.cpp.

{
 m_attributes.m_Font = aFont;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Font.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible.

Parameters

aEnable True forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 199 of file eda_item.h.

199{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

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

◆ SetHorizJustify()

void EDA_TEXT::SetHorizJustify ( GR_TEXT_H_ALIGN_T aType )

inherited

Definition at line 242 of file eda_text.cpp.

{
 m_attributes.m_Halign = aType;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Halign.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), SCH_ALTIUM_PLUGIN::AddTextBox(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXTBOX::FP_TEXTBOX(), ALTIUM_PCB::HelperParseDimensions6Radial(), AUTOPLACER::justifyField(), FP_TEXT::KeepUpright(), LIB_TEXTBOX::LIB_TEXTBOX(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), FABMASTER::loadFootprints(), SCH_EAGLE_PLUGIN::loadFrame(), FABMASTER::loadGraphics(), LEGACY_PLUGIN::loadMODULE_TEXT(), FABMASTER::loadOutline(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), 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(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), PCB_TEXTBOX::PCB_TEXTBOX(), LIB_TEXT::Rotate(), SCH_TEXTBOX::SCH_TEXTBOX(), PCAD2KICAD::SetTextJustify(), SCH_TEXT::SetTextSpinStyle(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ SetHyperlink()

void EDA_TEXT::SetHyperlink ( wxString aLink )

inlineinherited

Definition at line 335 of file eda_text.h.

335{ m_hyperlink = aLink; }

References EDA_TEXT::m_hyperlink.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_SEXPR_PARSER::parseEDA_TEXT(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetId()

void LIB_FIELD::SetId ( int aId )

Definition at line 108 of file lib_field.cpp.

{
 m_id = aId;
}

References m_id.

Referenced by LIB_SYMBOL::UpdateFieldOrdinals().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 165 of file eda_item.h.

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

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

◆ SetItalic()

void EDA_TEXT::SetItalic ( bool aItalic )

inherited

Definition at line 203 of file eda_text.cpp.

{
 m_attributes.m_Italic = aItalic;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Italic.

Referenced by SCH_ALTIUM_PLUGIN::AddTextBox(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), SCH_LEGACY_PLUGIN_CACHE::loadField(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), LEGACY_PLUGIN::loadMODULE_TEXT(), FABMASTER::loadOutline(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_LEGACY_PLUGIN::loadSymbol(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_LABEL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParseLabel(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetKeepUpright()

void EDA_TEXT::SetKeepUpright ( bool aKeepUpright )

inherited

Definition at line 258 of file eda_text.cpp.

{
 m_attributes.m_KeepUpright = aKeepUpright;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_KeepUpright.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), PCB_BASE_FRAME::CreateNewFootprint(), FP_TEXT::FP_TEXT(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ SetLineSpacing()

void EDA_TEXT::SetLineSpacing ( double aLineSpacing )

inherited

Definition at line 341 of file eda_text.cpp.

{
 m_attributes.m_LineSpacing = aLineSpacing;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_LineSpacing.

Referenced by PCB_PARSER::parseEDA_TEXT(), and SCH_SEXPR_PARSER::parseEDA_TEXT().

◆ SetMirrored()

void EDA_TEXT::SetMirrored ( bool isMirrored )

inherited

Definition at line 226 of file eda_text.cpp.

{
 m_attributes.m_Mirrored = isMirrored;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Mirrored.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), FP_TEXT::FP_TEXT(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), PCB_DIMENSION_BASE::Mirror(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 64 of file eda_item.cpp.

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

References IS_CHANGED, EDA_ITEM::m_parent, EDA_ITEM::SetFlags(), and EDA_ITEM::SetModified().

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_SYMBOL::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), PCB_PARSER::parseZONE(), LIB_SYMBOL::RemoveDrawItem(), SCH_SYMBOL::SetConvert(), SCH_SYMBOL::SetLibId(), EDA_ITEM::SetModified(), SetName(), SCH_SYMBOL::SetTransform(), and SCH_SYMBOL::SetUnit().

◆ SetMultilineAllowed()

void EDA_TEXT::SetMultilineAllowed ( bool aAllow )

inherited

Parameters

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

Definition at line 234 of file eda_text.cpp.

{
 m_attributes.m_Multiline = aAllow;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Multiline.

Referenced by FP_TEXTBOX::FP_TEXTBOX(), LIB_TEXTBOX::LIB_TEXTBOX(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PCB_TEXT::PCB_TEXT(), PCB_TEXTBOX::PCB_TEXTBOX(), SCH_LABEL_BASE::SCH_LABEL_BASE(), SCH_TEXT::SCH_TEXT(), and SCH_TEXTBOX::SCH_TEXTBOX().

◆ SetName()

void LIB_FIELD::SetName ( const wxString & aName )

Set a user definable field name to aName.

Reserved fields such as value and reference are not renamed. If the field name is changed, the field modified flag is set. If the field is the child of a symbol, the parent symbol's modified flag is also set.

Parameters

aName - User defined field name.

Definition at line 500 of file lib_field.cpp.

{
 // Mandatory field names are fixed.
 if( IsMandatory() )
 {
 wxFAIL_MSG( wxS( "trying to set a MANDATORY_FIELD's name\n" ) );
 return;
 }
 
 if( m_name != aName )
 {
 m_name = aName;
 SetModified();
 }
}

References IsMandatory(), m_name, and EDA_ITEM::SetModified().

Referenced by SCH_DATABASE_PLUGIN::loadSymbolFromRow(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), and DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked().

◆ SetNameShown()

void LIB_FIELD::SetNameShown ( bool aShown = true )

inline

Definition at line 181 of file lib_field.h.

181{ m_showName = aShown; }

References m_showName.

Referenced by SCH_DATABASE_PLUGIN::loadSymbolFromRow(), and DIALOG_LIB_FIELD_PROPERTIES::UpdateField().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 100 of file eda_item.h.

100{ m_parent = aParent; }

References EDA_ITEM::m_parent.

◆ SetPosition()

void LIB_ITEM::SetPosition ( const VECTOR2I & aPosition )

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in LIB_PIN, and LIB_SHAPE.

Definition at line 234 of file lib_item.h.

234{ MoveTo( aPosition ); }

LIB_ITEM::MoveTo

virtual void MoveTo(const VECTOR2I &aPosition)=0

Move a draw object to aPosition.

References LIB_ITEM::MoveTo().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFrame(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ SetPrivate()

void LIB_ITEM::SetPrivate ( bool aPrivate )

inlineinherited

Definition at line 278 of file lib_item.h.

278{ m_private = aPrivate; }

References LIB_ITEM::m_private.

Referenced by DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 115 of file eda_item.h.

115{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetShowInChooser()

void LIB_FIELD::SetShowInChooser ( bool aShow = true )

inline

Definition at line 187 of file lib_field.h.

187{ m_showInChooser = aShow; }

References m_showInChooser.

◆ SetState()

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

inlineinherited

Definition at line 128 of file eda_item.h.

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

References EDA_ITEM::m_status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 137 of file eda_item.h.

137{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetText()

void EDA_TEXT::SetText ( const wxString & aText )

virtualinherited

Definition at line 165 of file eda_text.cpp.

{
 m_text = aText;
 
 cacheShownText();
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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

◆ SetTextAngle()

void EDA_TEXT::SetTextAngle ( const EDA_ANGLE & aAngle )

virtualinherited

Reimplemented in FP_TEXTBOX, and PCB_TEXTBOX.

Definition at line 195 of file eda_text.cpp.

{
 m_attributes.m_Angle = aAngle;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), TEXT_ATTRIBUTES::m_Angle, EDA_TEXT::m_attributes, and EDA_TEXT::m_bounding_box_cache_valid.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), eagleToKicadAlignment(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), HitTest(), LIB_TEXT::HitTest(), Init(), FP_TEXT::KeepUpright(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), PCB_DIMENSION_BASE::Mirror(), DIALOG_LABEL_PROPERTIES::OnAddField(), DIALOG_SHEET_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EDIT_TOOL::Rotate(), SCH_TEXTBOX::Rotate(), LIB_TEXTBOX::Rotate(), Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), FP_TEXTBOX::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), PCB_TEXTBOX::Rotate(), SCH_TEXTBOX::Rotate90(), EDA_TEXT::SetTextAngleDegrees(), SCH_TEXT::SetTextSpinStyle(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PCB_DIM_ALIGNED::updateText(), PCB_DIM_ORTHOGONAL::updateText(), PCB_DIM_RADIAL::updateText(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextAngleDegrees()

void EDA_TEXT::SetTextAngleDegrees ( double aOrientation )

inlineinherited

Definition at line 123 of file eda_text.h.

 {
 SetTextAngle( EDA_ANGLE( aOrientation, DEGREES_T ) );
 }

References DEGREES_T, and EDA_TEXT::SetTextAngle().

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

◆ SetTextColor()

void EDA_TEXT::SetTextColor ( const COLOR4D & aColor )

inlineinherited

Definition at line 204 of file eda_text.h.

204{ m_attributes.m_Color = aColor; }

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

Referenced by DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParseHarnessType(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextHeight()

void EDA_TEXT::SetTextHeight ( int aHeight )

inherited

Definition at line 365 of file eda_text.cpp.

{
 m_attributes.m_Size.y = aHeight;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, TEXT_ATTRIBUTES::m_Size, and VECTOR2< T >::y.

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), FABMASTER::loadOutline(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetTextPos()

void EDA_TEXT::SetTextPos ( const VECTOR2I & aPoint )

inherited

Definition at line 373 of file eda_text.cpp.

{
 Offset( VECTOR2I( aPoint.x - m_pos.x, aPoint.y - m_pos.y ) );
}

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_TEXT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), BeginEdit(), LIB_TEXT::BeginEdit(), CalcEdit(), LIB_TEXT::CalcEdit(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), FP_TEXT::FP_TEXT(), ALTIUM_PCB::HelperParseDimensions6Radial(), HitTest(), LIB_TEXT::HitTest(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), FABMASTER::loadOutline(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PCB_DIMENSION_BASE::Mirror(), MoveTo(), LIB_TEXT::MoveTo(), LIB_TEXT::NormalizeJustification(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseSchText(), DRAWING_TOOL::PlaceText(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), SCH_FIELD::SCH_FIELD(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), FP_TEXT::SetDrawCoord(), DS_DRAW_ITEM_TEXT::SetPosition(), FP_TEXT::SetPosition(), PCB_TEXT::SetPosition(), SCH_FIELD::SetPosition(), SCH_TEXT::SetPosition(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), SCH_SYMBOL::UpdateFields(), PCB_POINT_EDITOR::updateItem(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ SetTextSize()

void EDA_TEXT::SetTextSize ( const VECTOR2I & aNewSize )

inherited

Definition at line 349 of file eda_text.cpp.

{
 m_attributes.m_Size = aNewSize;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Size.

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_ALTIUM_PLUGIN::AddTextBox(), CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), MICROWAVE_TOOL::createBaseFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT::EDA_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), LIB_TEXT::LIB_TEXT(), LIB_TEXTBOX::LIB_TEXTBOX(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EAGLE_PLUGIN::loadFrame(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_LEGACY_PLUGIN::loadSheet(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParseLabel(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BACK_ANNOTATE::processNetNameChange(), PCAD2KICAD::SetTextSizeFromStrokeFontHeight(), PCAD2KICAD::SetTextSizeFromTrueTypeFontHeight(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextThickness()

void EDA_TEXT::SetTextThickness ( int aWidth )

inherited

The TextThickness is that set by the user.

The EffectiveTextPenWidth also factors in bold text and thickness clamping.

Definition at line 187 of file eda_text.cpp.

{
 m_attributes.m_StrokeWidth = aWidth;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_StrokeWidth.

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), MICROWAVE_TOOL::createBaseFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXT::FP_TEXT(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), LEGACY_PLUGIN::loadMODULE_TEXT(), FABMASTER::loadOutline(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetTextWidth()

void EDA_TEXT::SetTextWidth ( int aWidth )

inherited

Definition at line 357 of file eda_text.cpp.

{
 m_attributes.m_Size.x = aWidth;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, TEXT_ATTRIBUTES::m_Size, and VECTOR2< T >::x.

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), FABMASTER::loadOutline(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetTextX()

void EDA_TEXT::SetTextX ( int aX )

inherited

Definition at line 379 of file eda_text.cpp.

{
 Offset( VECTOR2I( aX - m_pos.x, 0 ) );
}

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

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), FP_TEXT::Mirror(), PCB_TEXT::Mirror(), MirrorHorizontal(), LIB_TEXT::MirrorHorizontal(), SCH_SHEET_PIN::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), and SCH_SHEET_PIN::SetSide().

◆ SetTextY()

void EDA_TEXT::SetTextY ( int aY )

inherited

Definition at line 385 of file eda_text.cpp.

{
 Offset( VECTOR2I( 0, aY - m_pos.y ) );
}

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

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), FP_TEXT::Mirror(), PCB_TEXT::Mirror(), MirrorVertical(), LIB_TEXT::MirrorVertical(), SCH_SHEET_PIN::MirrorVertically(), SCH_TEXT::MirrorVertically(), and SCH_SHEET_PIN::SetSide().

◆ SetUnit()

void LIB_ITEM::SetUnit ( int aUnit )

inlineinherited

Definition at line 272 of file lib_item.h.

272{ m_unit = aUnit; }

References LIB_ITEM::m_unit.

◆ SetupRenderCache()

void EDA_TEXT::SetupRenderCache	(	const wxString &	aResolvedText,
		const EDA_ANGLE &	aAngle
	)

inherited

Definition at line 485 of file eda_text.cpp.

{
 m_render_cache_text = aResolvedText;
 m_render_cache_angle = aAngle;
 m_render_cache.clear();
}

References EDA_TEXT::m_render_cache, EDA_TEXT::m_render_cache_angle, and EDA_TEXT::m_render_cache_text.

◆ SetVertJustify()

void EDA_TEXT::SetVertJustify ( GR_TEXT_V_ALIGN_T aType )

inherited

Definition at line 250 of file eda_text.cpp.

{
 m_attributes.m_Valign = aType;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Valign.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXTBOX::FP_TEXTBOX(), ALTIUM_PCB::HelperParseDimensions6Radial(), AUTOPLACER::justifyField(), LIB_TEXTBOX::LIB_TEXTBOX(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EAGLE_PLUGIN::loadFrame(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_TEXTBOX::PCB_TEXTBOX(), LIB_TEXT::Rotate(), SCH_GLOBALLABEL::SCH_GLOBALLABEL(), SCH_TEXTBOX::SCH_TEXTBOX(), PCAD2KICAD::SetTextJustify(), SCH_TEXT::SetTextSpinStyle(), SCH_GLOBALLABEL::SetTextSpinStyle(), SCH_HIERLABEL::SetTextSpinStyle(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ SetVisible()

void EDA_TEXT::SetVisible ( bool aVisible )

virtualinherited

Reimplemented in PCB_TEXT, and PCB_TEXTBOX.

Definition at line 219 of file eda_text.cpp.

{
 m_attributes.m_Visible = aVisible;
 ClearRenderCache();
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Visible.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_EDIT_TOOL::ChangeTextType(), PCB_BASE_FRAME::CreateNewFootprint(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Init(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), EAGLE_PLUGIN::loadElements(), SCH_LEGACY_PLUGIN_CACHE::loadField(), FABMASTER::loadFootprints(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_EAGLE_PLUGIN::loadLibrary(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_LEGACY_PLUGIN_CACHE::LoadPart(), EAGLE_PLUGIN::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_LEGACY_PLUGIN::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), DIALOG_LABEL_PROPERTIES::OnAddField(), ALTIUM_PCB::ParseComponents6Data(), SCH_ALTIUM_PLUGIN::ParseDesignator(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseFileName(), SCH_ALTIUM_PLUGIN::ParseHarnessType(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_SEXPR_PARSER::parseSchText(), SCH_ALTIUM_PLUGIN::ParseSheetName(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_SEXPR_PLUGIN_CACHE::saveDcmInfoAsFields(), SCH_FIELD::SCH_FIELD(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ ShowInChooser()

bool LIB_FIELD::ShowInChooser ( ) const

inline

Definition at line 186 of file lib_field.h.

186{ return m_showInChooser; }

References m_showInChooser.

Referenced by LIB_SYMBOL::GetChooserFields().

◆ Sort()

static bool EDA_ITEM::Sort	(	const EDA_ITEM *	aLeft,
		const EDA_ITEM *	aRight
	)

inlinestaticinherited

Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters

aLeft	The left hand item to compare.
aRight	The right hand item to compare.

Returns: True if aLeft is less than aRight.

Definition at line 438 of file eda_item.h.

438{ return *aLeft < *aRight; }

◆ SwapAttributes()

void EDA_TEXT::SwapAttributes ( EDA_TEXT & aTradingPartner )

inherited

Swap the text attributes of the two involved instances.

Definition at line 286 of file eda_text.cpp.

{
 std::swap( m_attributes, aTradingPartner.m_attributes );
 std::swap( m_pos, aTradingPartner.m_pos );
 
 ClearRenderCache();
 aTradingPartner.ClearRenderCache();
 
 m_bounding_box_cache_valid = false;
 aTradingPartner.m_bounding_box_cache_valid = false;
}

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and EDA_TEXT::m_pos.

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

◆ SwapText()

void EDA_TEXT::SwapText ( EDA_TEXT & aTradingPartner )

inherited

Definition at line 275 of file eda_text.cpp.

{
 std::swap( m_text, aTradingPartner.m_text );
 std::swap( m_shown_text, aTradingPartner.m_shown_text );
 std::swap( m_shown_text_has_text_var_refs, aTradingPartner.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 SCH_FIELD::SwapData(), SCH_TEXT::SwapData(), and SCH_TEXTBOX::SwapData().

◆ TextHitTest() [1/2]

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

virtualinherited

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

Parameters

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

Returns: true if a hit, else false.

Reimplemented in FP_TEXT, and PCB_TEXT.

Definition at line 637 of file eda_text.cpp.

{
 BOX2I rect = aRect;
 
 rect.Inflate( aAccuracy );
 
 if( aContains )
 return rect.Contains( GetTextBox() );
 
 return rect.Intersects( GetTextBox(), GetDrawRotation() );
}

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

◆ TextHitTest() [2/2]

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

virtualinherited

Test if aPoint is within the bounds of this object.

Parameters

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

Returns: true if a hit, else false.

Reimplemented in FP_TEXT, and PCB_TEXT.

Definition at line 625 of file eda_text.cpp.

{
 BOX2I rect = GetTextBox();
 VECTOR2I location = aPoint;
 
 rect.Inflate( aAccuracy );
 RotatePoint( location, GetDrawPos(), -GetDrawRotation() );
 
 return rect.Contains( location );
}

References BOX2< Vec >::Contains(), EDA_TEXT::GetDrawPos(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetTextBox(), BOX2< Vec >::Inflate(), and RotatePoint().

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

◆ TransformBoundingBoxToPolygon()

void EDA_TEXT::TransformBoundingBoxToPolygon	(	SHAPE_POLY_SET *	aBuffer,
		int	aClearance
	)		const

inherited

Convert the text bounding box to a rectangular polygon depending on the text orientation, the bounding box is not always horizontal or vertical.

Used in filling zones calculations Circles and arcs are approximated by segments

Parameters

aBuffer	a buffer to store the polygon.
aClearance	the clearance around the text bounding box to the real clearance value (usually near from 1.0).

Definition at line 947 of file eda_text.cpp.

{
 if( GetText().Length() == 0 )
 return;
 
 VECTOR2I corners[4]; // Buffer of polygon corners
 BOX2I rect = GetTextBox();
 
 // TrueType bounding boxes aren't guaranteed to include all descenders, diacriticals, etc.
 // Since we use this for zone knockouts and DRC, we need something more accurate.
 if( getDrawFont()->IsOutline() )
 rect = GetEffectiveTextShape( false, false )->BBox();
 
 rect.Inflate( aClearance );
 
 corners[0].x = rect.GetOrigin().x;
 corners[0].y = rect.GetOrigin().y;
 corners[1].y = corners[0].y;
 corners[1].x = rect.GetRight();
 corners[2].x = corners[1].x;
 corners[2].y = rect.GetBottom();
 corners[3].y = corners[2].y;
 corners[3].x = corners[0].x;
 
 aBuffer->NewOutline();
 
 for( VECTOR2I& corner : corners )
 {
 RotatePoint( corner, GetDrawPos(), GetDrawRotation() );
 
 aBuffer->Append( corner.x, corner.y );
 }
}

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

◆ LIB_CONVERT

Constructor & Destructor Documentation

◆ LIB_FIELD() [1/3]

◆ LIB_FIELD() [2/3]

◆ LIB_FIELD() [3/3]

Member Function Documentation

◆ AddRenderCacheGlyph()

◆ BeginEdit()

◆ cacheShownText()

◆ CalcEdit()

◆ CanAutoplace()

◆ ClearBoundingBoxCache()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearRenderCache()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ Compare()

◆ compare()

◆ ContinueEdit()

◆ Copy()

◆ CopyText()

◆ Empty()

◆ EndEdit()

◆ Format()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAttributes()

◆ GetBoundingBox()

◆ GetCanonicalName()

◆ GetClass()

◆ GetConvert()

◆ GetDefaultFont()

◆ GetDefaultLayer()

◆ getDrawFont()

◆ GetDrawPos()

◆ GetDrawRotation()

◆ GetEditFlags()

◆ GetEffectivePenWidth()

◆ GetEffectiveTextPenWidth()

◆ GetEffectiveTextShape()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFont()

◆ GetFontName()

◆ GetFriendlyName()

◆ GetFullText()

◆ GetHorizJustify()

◆ GetHyperlink()

◆ GetId()

◆ GetInterline()

◆ GetItemDescription()

◆ GetLinePositions()

◆ GetLineSpacing()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetName()

◆ GetParent()

◆ GetPenWidth()

◆ GetPosition()

◆ GetRenderCache()

◆ GetShownText()

◆ GetSortPosition()

◆ GetState()