KiCad PCB EDA Suite
SCH_GLOBALLABEL Class Reference

#include <sch_text.h>

Inheritance diagram for SCH_GLOBALLABEL:
SCH_TEXT SCH_ITEM EDA_TEXT EDA_ITEM KIGFX::VIEW_ITEM INSPECTABLE

Public Member Functions

 SCH_GLOBALLABEL (const wxPoint &aPos=wxPoint(0, 0), const wxString &aText=wxEmptyString)
 
 SCH_GLOBALLABEL (const SCH_GLOBALLABEL &aGlobalLabel)
 
 ~SCH_GLOBALLABEL ()
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
EDA_ITEMClone () const override
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
void SwapData (SCH_ITEM *aItem) override
 Swap the internal data structures aItem with the schematic item. More...
 
SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
void RunOnChildren (const std::function< void(SCH_ITEM *)> &aFunction) override
 
void Rotate (wxPoint aPosition) override
 Rotate the item around aPosition 90 degrees in the clockwise direction. More...
 
void Rotate90 (bool aClockwise) override
 
void MirrorSpinStyle (bool aLeftRight) override
 
void SetLabelSpinStyle (LABEL_SPIN_STYLE aSpinStyle) override
 Set a spin or rotation angle, along with specific horizontal and vertical justification styles with each angle. More...
 
wxPoint GetSchematicTextOffset (RENDER_SETTINGS *aSettings) const override
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
void CreateGraphicShape (RENDER_SETTINGS *aRenderSettings, std::vector< wxPoint > &aPoints, const wxPoint &aPos) override
 Calculate the graphic shape (a polygon) associated to the text. More...
 
void UpdateIntersheetRefProps ()
 
void AutoplaceFields (SCH_SCREEN *aScreen, bool aManual) override
 
bool ResolveTextVar (wxString *token, int aDepth) const
 
bool IsConnectable () const override
 
bool CanConnect (const SCH_ITEM *aItem) const override
 
wxString GetSelectMenuText (EDA_UNITS aUnits) const override
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAP_DEF GetMenuImage () const override
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
void Print (RENDER_SETTINGS *aSettings, const wxPoint &offset) override
 Print a schematic item. More...
 
SCH_FIELDGetIntersheetRefs ()
 
void SetIntersheetRefs (const SCH_FIELD &aField)
 
bool IsPointClickableAnchor (const wxPoint &aPos) const override
 
void Move (const wxPoint &aMoveVector) override
 Move the item by aMoveVector to a new position. More...
 
void GetContextualTextVars (wxArrayString *aVars) const
 Returns the set of contextual text variable tokens for this text item. More...
 
wxString GetShownText (int aDepth=0) const override
 Return the string actually shown after processing of the base text. More...
 
wxString GetShownText (bool *processTextVars) const
 A version of GetShownText() which also indicates whether or not the text needs to be processed for text variables. More...
 
void IncrementLabel (int aIncrement)
 Increment the label text, if it ends with a number. More...
 
LABEL_SPIN_STYLE GetLabelSpinStyle () const
 
PINSHEETLABEL_SHAPE GetShape () const
 
void SetShape (PINSHEETLABEL_SHAPE aShape)
 
void Print (RENDER_SETTINGS *aSettings, const wxPoint &aOffset, COLOR4D aColor, OUTLINE_MODE aDisplay_mode=FILLED)
 Print this text object to the device context aDC. More...
 
bool operator< (const SCH_ITEM &aItem) const override
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
int GetTextOffset (RENDER_SETTINGS *aSettings=nullptr) const
 
int GetPenWidth () const override
 
void MirrorY (int aYaxis_position) override
 Mirror item relative to the Y axis about aYaxis_position. More...
 
void MirrorX (int aXaxis_position) override
 Mirror item relative to the X axis about aXaxis_position. More...
 
bool Matches (wxFindReplaceData &aSearchData, void *aAuxData) override
 Function Matches compares the item against the search criteria in aSearchData. More...
 
bool Replace (wxFindReplaceData &aSearchData, void *aAuxData) override
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
bool Replace (wxFindReplaceData &aSearchData)
 Helper function used in search and replace dialog. More...
 
virtual bool IsReplaceable () const override
 Function IsReplaceable. More...
 
void GetEndPoints (std::vector< DANGLING_END_ITEM > &aItemList) override
 Add the schematic item end points to aItemList if the item has end points. More...
 
bool UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemList, const SCH_SHEET_PATH *aPath=nullptr) override
 Test the schematic item to aItemList to check if it's dangling state has changed. More...
 
bool IsDangling () const override
 
void SetIsDangling (bool aIsDangling)
 
std::vector< wxPoint > GetConnectionPoints () const override
 Add all the connection points for this item to aPoints. More...
 
wxPoint GetPosition () const override
 
void SetPosition (const wxPoint &aPosition) override
 
bool HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
 Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
 
void Plot (PLOTTER *aPlotter) override
 Plot the schematic item to aPlotter. More...
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
SCH_ITEMDuplicate (bool doClone=false) const
 Routine to create a new copy of given item. More...
 
virtual bool IsMovableFromAnchorPoint ()
 
wxPoint & GetStoredPos ()
 
void SetStoredPos (wxPoint aPos)
 
SCHEMATICSchematic () const
 Searches the item hierarchy to find a SCHEMATIC. More...
 
virtual bool IsLocked () const
 
virtual void SetLocked (bool aLocked)
 Set the 'lock' status to aLocked for of this item. More...
 
virtual bool IsHypertext () const
 Allows items to support hypertext actions when hovered/clicked. More...
 
virtual void DoHypertextMenu (EDA_DRAW_FRAME *aFrame)
 
SCH_LAYER_ID GetLayer () const
 Return the layer this item is on. More...
 
void SetLayer (SCH_LAYER_ID aLayer)
 Set the layer this item is on. More...
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Return the layers the item is drawn on (which may be more than its "home" layer) More...
 
void ClearConnections ()
 Clears all of the connection items from the list. More...
 
bool IsConnected (const wxPoint &aPoint) const
 Test the item to see if it is connected to aPoint. More...
 
SCH_CONNECTIONConnection (const SCH_SHEET_PATH *aSheet=nullptr) const
 Retrieve the connection associated with this object in the given sheet. More...
 
SCH_ITEM_SETConnectedItems (const SCH_SHEET_PATH &aPath)
 Retrieves the set of items connected to this item on the given sheet. More...
 
void AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
 Adds a connection link between this item and another. More...
 
SCH_CONNECTIONInitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
 Creates a new connection object associated with this object. More...
 
virtual bool ConnectionPropagatesTo (const EDA_ITEM *aItem) const
 Returns true if this item should propagate connection info to aItem. More...
 
bool IsConnectivityDirty ()
 
void SetConnectivityDirty (bool aDirty=true)
 
NETCLASSPTR NetClass (const SCH_SHEET_PATH *aSheet=nullptr) const
 
FIELDS_AUTOPLACED GetFieldsAutoplaced () const
 Return whether the fields have been automatically placed. More...
 
void ClearFieldsAutoplaced ()
 Set fields automatically placed flag false. More...
 
void AutoAutoplaceFields (SCH_SCREEN *aScreen)
 Autoplace fields only if correct to do so automatically. More...
 
virtual bool HasLineStroke () const
 Check if this schematic item has line stoke properties. More...
 
virtual STROKE_PARAMS GetStroke () const
 
virtual void SetStroke (const STROKE_PARAMS &aStroke)
 
KICAD_T Type () const
 Function Type() More...
 
EDA_ITEMGetParent () const
 
virtual void SetParent (EDA_ITEM *aParent)
 
bool IsModified () const
 
bool IsNew () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool HasFlag (STATUS_FLAGS aFlag)
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[]) const
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag 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 const wxPoint GetFocusPosition () const
 Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual double ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns 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)
 
template<typename T >
Get (PROPERTY_BASE *aProperty)
 
template<typename T >
boost::optional< T > Get (const wxString &aProperty)
 
virtual const wxString & GetText () const
 Return the string associated with the text object. More...
 
wxString ShortenedShownText () const
 Returns a shortened version (max 15 characters) of the shown text. 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 aDefaultWidth=0) const
 The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth. More...
 
virtual void SetTextAngle (double aAngle)
 
double GetTextAngle () const
 
double GetTextAngleDegrees () const
 
double GetTextAngleRadians () const
 
void SetItalic (bool isItalic)
 
bool IsItalic () const
 
void SetBold (bool aBold)
 
bool IsBold () const
 
void SetVisible (bool aVisible)
 
bool IsVisible () const
 
void SetMirrored (bool isMirrored)
 
bool IsMirrored () const
 
void SetMultilineAllowed (bool aAllow)
 
bool IsMultilineAllowed () const
 
EDA_TEXT_HJUSTIFY_T GetHorizJustify () const
 
EDA_TEXT_VJUSTIFY_T GetVertJustify () const
 
void SetHorizJustify (EDA_TEXT_HJUSTIFY_T aType)
 
void SetVertJustify (EDA_TEXT_VJUSTIFY_T aType)
 
void SetEffects (const EDA_TEXT &aSrc)
 Set the text effects from another instance. More...
 
void SwapEffects (EDA_TEXT &aTradingPartner)
 Swap the text effects of the two involved instances. More...
 
void SwapText (EDA_TEXT &aTradingPartner)
 
void CopyText (const EDA_TEXT &aSrc)
 
bool IsDefaultFormatting () const
 
void SetTextSize (const wxSize &aNewSize)
 
const wxSize & GetTextSize () const
 
void SetTextWidth (int aWidth)
 
int GetTextWidth () const
 
void SetTextHeight (int aHeight)
 
int GetTextHeight () const
 
void SetTextPos (const wxPoint &aPoint)
 
const wxPoint & GetTextPos () const
 
void SetTextX (int aX)
 
void SetTextY (int aY)
 
void Offset (const wxPoint &aOffset)
 
void Empty ()
 
std::vector< wxPoint > TransformToSegmentList () const
 Convert the text shape to a list of segment. More...
 
void TransformBoundingBoxWithClearanceToPolygon (SHAPE_POLY_SET *aCornerBuffer, int aClearanceValue) 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_COMPOUNDGetEffectiveTextShape () const
 
virtual bool TextHitTest (const wxPoint &aPoint, int aAccuracy=0) const
 Test if aPoint is within the bounds of this object. More...
 
virtual bool TextHitTest (const EDA_RECT &aRect, bool aContains, int aAccuracy=0) const
 Test if object bounding box is contained within or intersects aRect. More...
 
int LenSize (const wxString &aLine, int aThickness) const
 
EDA_RECT 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< wxPoint > &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 double GetDrawRotation () const
 

Static Public Member Functions

static bool ClassOf (const EDA_ITEM *aItem)
 
static bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
static HTML_MESSAGE_BOXShowSyntaxHelp (wxWindow *aParentWindow)
 
template<class T >
static SEARCH_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 
static EDA_TEXT_HJUSTIFY_T MapHorizJustify (int aHorizJustify)
 
static EDA_TEXT_VJUSTIFY_T MapVertJustify (int aVertJustify)
 

Public Attributes

const KIID m_Uuid
 

Protected Member Functions

bool Matches (const wxString &aText, wxFindReplaceData &aSearchData)
 Function Matches compares aText against search criteria in aSearchData. More...
 

Protected Attributes

PINSHEETLABEL_SHAPE m_shape
 
bool m_isDangling
 True if not connected to another object if the object derive from SCH_TEXT supports connections. More...
 
CONNECTION_TYPE m_connectionType
 
LABEL_SPIN_STYLE m_spin_style
 The orientation of text and any associated drawing elements of derived objects. More...
 
SCH_LAYER_ID m_layer
 
EDA_ITEMS m_connections
 
FIELDS_AUTOPLACED m_fieldsAutoplaced
 
wxPoint m_storedPos
 
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SETm_connected_items
 Stores pointers to other items that are connected to this one, per sheet. More...
 
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
 Stores connectivity information, per sheet. More...
 
bool m_connectivity_dirty
 
STATUS_FLAGS m_status
 
EDA_ITEMm_parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
STATUS_FLAGS m_flags
 

Private Member Functions

bool doIsConnected (const wxPoint &aPosition) const override
 Provide the object specific test to see if it is connected to aPosition. More...
 

Private Attributes

SCH_FIELD m_intersheetRefsField
 

Detailed Description

Definition at line 378 of file sch_text.h.

Constructor & Destructor Documentation

◆ SCH_GLOBALLABEL() [1/2]

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

Definition at line 811 of file sch_text.cpp.

811  :
812  SCH_TEXT( pos, text, SCH_GLOBAL_LABEL_T ),
813  m_intersheetRefsField( { 0, 0 }, 0, this )
814 {
817  m_isDangling = true;
818  SetMultilineAllowed( false );
819 
821 
822  m_intersheetRefsField.SetText( wxT( "${INTERSHEET_REFS}" ) );
826 }
bool m_isDangling
True if not connected to another object if the object derive from SCH_TEXT supports connections.
Definition: sch_text.h:172
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201
SCH_LAYER_ID m_layer
Definition: sch_item.h:199
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:121
void SetVertJustify(EDA_TEXT_VJUSTIFY_T aType)
Definition: eda_text.h:209
void SetLayer(SCH_LAYER_ID aLayer)
Set the layer this item is on.
Definition: sch_item.h:292
void SetMultilineAllowed(bool aAllow)
Definition: eda_text.h:202
SCH_FIELD m_intersheetRefsField
Definition: sch_text.h:457
PINSHEETLABEL_SHAPE m_shape
Definition: sch_text.h:168
SCH_TEXT(const wxPoint &aPos=wxPoint(0, 0), const wxString &aText=wxEmptyString, KICAD_T aType=SCH_TEXT_T)
Definition: sch_text.cpp:121

Referenced by Clone().

◆ SCH_GLOBALLABEL() [2/2]

SCH_GLOBALLABEL::SCH_GLOBALLABEL ( const SCH_GLOBALLABEL aGlobalLabel)

Definition at line 829 of file sch_text.cpp.

829  :
830  SCH_TEXT( aGlobalLabel ),
831  m_intersheetRefsField( { 0, 0 }, 0, this )
832 {
834 
835  // Re-parent the fields, which before this had aGlobalLabel as parent
837 
838  m_fieldsAutoplaced = aGlobalLabel.m_fieldsAutoplaced;
839 }
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:184
SCH_FIELD m_intersheetRefsField
Definition: sch_text.h:457
SCH_TEXT(const wxPoint &aPos=wxPoint(0, 0), const wxString &aText=wxEmptyString, KICAD_T aType=SCH_TEXT_T)
Definition: sch_text.cpp:121

◆ ~SCH_GLOBALLABEL()

SCH_GLOBALLABEL::~SCH_GLOBALLABEL ( )
inline

Definition at line 385 of file sch_text.h.

385 { }

Member Function Documentation

◆ AddConnectionTo()

void SCH_ITEM::AddConnectionTo ( const SCH_SHEET_PATH aPath,
SCH_ITEM aItem 
)
inherited

Adds a connection link between this item and another.

Definition at line 170 of file sch_item.cpp.

171 {
172  m_connected_items[ aSheet ].insert( aItem );
173 }
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SET > m_connected_items
Stores pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:206

References SCH_ITEM::m_connected_items.

Referenced by SCH_TEXT::UpdateDanglingState().

◆ AutoAutoplaceFields()

void SCH_ITEM::AutoAutoplaceFields ( SCH_SCREEN aScreen)
inlineinherited

Autoplace fields only if correct to do so automatically.

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

Parameters
aScreenis the SCH_SCREEN associated with the current instance of the symbol.

Definition at line 467 of file sch_item.h.

468  {
469  if( GetFieldsAutoplaced() )
471  }
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition: sch_item.h:453
virtual void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Definition: sch_item.h:473

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

Referenced by SCH_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), and SCH_EDIT_FRAME::SelectUnit().

◆ AutoplaceFields()

void SCH_GLOBALLABEL::AutoplaceFields ( SCH_SCREEN aScreen,
bool  aManual 
)
overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1053 of file sch_text.cpp.

1054 {
1055  int margin = GetTextOffset();
1056  int labelLen = GetBoundingBox().GetSizeMax();
1057  int penOffset = GetPenWidth() / 2;
1058 
1059  // Set both axes to penOffset; we're going to overwrite the text axis below
1060  wxPoint offset( -penOffset, -penOffset );
1061 
1062  switch( GetLabelSpinStyle() )
1063  {
1064  default:
1068  offset.x = - ( labelLen + margin / 2 );
1069  break;
1070 
1071  case LABEL_SPIN_STYLE::UP:
1074  offset.y = - ( labelLen + margin / 2 );
1075  break;
1076 
1080  offset.x = labelLen + margin /2 ;
1081  break;
1082 
1086  offset.y = labelLen + margin / 2;
1087  break;
1088  }
1089 
1091 
1093 }
#define TEXT_ANGLE_HORIZ
Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to...
Definition: eda_text.h:50
int GetTextOffset(RENDER_SETTINGS *aSettings=nullptr) const
Definition: sch_text.cpp:308
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201
int GetPenWidth() const override
Definition: sch_text.cpp:325
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_text.cpp:1225
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:233
wxPoint GetPosition() const override
Definition: sch_text.h:312
SCH_FIELD m_intersheetRefsField
Definition: sch_text.h:457
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:208
#define TEXT_ANGLE_VERT
Definition: eda_text.h:51
virtual void SetTextAngle(double aAngle)
Definition: eda_text.h:173
int GetSizeMax() const
GetSizeMax.
Definition: eda_rect.h:109

References LABEL_SPIN_STYLE::BOTTOM, FIELDS_AUTOPLACED_AUTO, GetBoundingBox(), SCH_TEXT::GetLabelSpinStyle(), SCH_TEXT::GetPenWidth(), SCH_TEXT::GetPosition(), EDA_RECT::GetSizeMax(), SCH_TEXT::GetTextOffset(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, LABEL_SPIN_STYLE::LEFT, SCH_ITEM::m_fieldsAutoplaced, m_intersheetRefsField, LABEL_SPIN_STYLE::RIGHT, EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), TEXT_ANGLE_HORIZ, TEXT_ANGLE_VERT, and LABEL_SPIN_STYLE::UP.

Referenced by UpdateIntersheetRefProps().

◆ CanConnect()

bool SCH_GLOBALLABEL::CanConnect ( const SCH_ITEM aItem) const
inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 425 of file sch_text.h.

426  {
427  return aItem->Type() == SCH_LINE_T &&
428  ( aItem->GetLayer() == LAYER_WIRE || aItem->GetLayer() == LAYER_BUS );
429  }
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:285
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

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

◆ ClassOf()

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

Definition at line 387 of file sch_text.h.

388  {
389  return aItem && SCH_GLOBAL_LABEL_T == aItem->Type();
390  }
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

References SCH_GLOBAL_LABEL_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

◆ ClearConnections()

void SCH_ITEM::ClearConnections ( )
inlineinherited

Clears all of the connection items from the list.

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

Definition at line 405 of file sch_item.h.

405 { m_connections.clear(); }
EDA_ITEMS m_connections
Definition: sch_item.h:200

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )
inlineinherited

Set fields automatically placed flag false.

Definition at line 458 of file sch_item.h.

FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_MOVE_TOOL::moveItem(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 221 of file eda_item.h.

221 { m_flags &= ~aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:164

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), LIB_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_TOOLS::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 233 of file eda_item.h.

234  {
236  DO_NOT_DRAW );
237  }
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: eda_item.h:114
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: eda_item.h:103
#define CANDIDATE
flag indicating that the structure is connected
Definition: eda_item.h:116
#define DO_NOT_DRAW
Used to disable draw function.
Definition: eda_item.h:118
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: eda_item.h:111
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:221
#define ENDPOINT
ends. (Used to support dragging.)
Definition: eda_item.h:112
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: eda_item.h:117

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, ENDPOINT, IS_LINKED, SKIP_STRUCT, STARTPOINT, and TEMP_SELECTED.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 154 of file view_item.h.

155  {
157  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:162
#define NULL

References KIGFX::VIEW_ITEM::m_viewPrivData, and NULL.

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

◆ Clone()

EDA_ITEM * SCH_GLOBALLABEL::Clone ( ) const
overridevirtual

Function Clone creates 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 SCH_TEXT.

Definition at line 842 of file sch_text.cpp.

843 {
844  return new SCH_GLOBALLABEL( *this );
845 }
SCH_GLOBALLABEL(const wxPoint &aPos=wxPoint(0, 0), const wxString &aText=wxEmptyString)
Definition: sch_text.cpp:811

References SCH_GLOBALLABEL().

◆ ConnectedItems()

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

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

Definition at line 164 of file sch_item.cpp.

165 {
166  return m_connected_items[ aSheet ];
167 }
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SET > m_connected_items
Stores pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:206

References SCH_ITEM::m_connected_items.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), CONNECTION_GRAPH::buildConnectionGraph(), CONNECTION_GRAPH::updateItemConnectivity(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ Connection()

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

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

Note
The returned value can be nullptr.

Definition at line 131 of file sch_item.cpp.

132 {
133  if( !aSheet )
134  aSheet = &Schematic()->CurrentSheet();
135 
136  auto it = m_connection_map.find( *aSheet );
137 
138  if( it == m_connection_map.end() )
139  return nullptr;
140  else
141  return it->second;
142 }
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Stores connectivity information, per sheet.
Definition: sch_item.h:209
SCH_SHEET_PATH & CurrentSheet() const
Definition: schematic.h:127

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

Referenced by CONNECTION_SUBGRAPH::Absorb(), CONNECTION_SUBGRAPH::AddItem(), BACK_ANNOTATE::applyChangelist(), CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckNoConnects(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_ITEM::NetClass(), SCH_EDIT_FRAME::OnModify(), SCH_HIERLABEL::Print(), CONNECTION_SUBGRAPH::ResolveDrivers(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), BUS_UNFOLD_MENU::update(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ ConnectionPropagatesTo()

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

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

Reimplemented in SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 442 of file sch_item.h.

442 { return true; }

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT aSrc)
inherited

Definition at line 129 of file eda_text.cpp.

130 {
131  m_text = aSrc.m_text;
132  m_shown_text = aSrc.m_shown_text;
134 }
wxString m_shown_text
Definition: eda_text.h:378
bool m_shown_text_has_text_var_refs
Definition: eda_text.h:379
wxString m_text
Definition: eda_text.h:377

References EDA_TEXT::m_shown_text, EDA_TEXT::m_shown_text_has_text_var_refs, and EDA_TEXT::m_text.

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

◆ CreateGraphicShape()

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

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

Parameters
aPointsA buffer to fill with polygon corners coordinates
PosPosition of the shape, for texts and labels: do nothing Mainly for derived classes (SCH_SHEET_PIN and Hierarchical labels)

Reimplemented from SCH_TEXT.

Definition at line 1153 of file sch_text.cpp.

1155 {
1156  int margin = GetTextOffset( aRenderSettings );
1157  int halfSize = ( GetTextHeight() / 2 ) + margin;
1158  int linewidth = GetPenWidth();
1159  int symb_len = LenSize( GetShownText(), linewidth ) + 2 * margin;
1160 
1161  int x = symb_len + linewidth + 3;
1162  int y = halfSize + linewidth + 3;
1163 
1164  aPoints.clear();
1165 
1166  // Create outline shape : 6 points
1167  aPoints.emplace_back( wxPoint( 0, 0 ) );
1168  aPoints.emplace_back( wxPoint( 0, -y ) ); // Up
1169  aPoints.emplace_back( wxPoint( -x, -y ) ); // left
1170  aPoints.emplace_back( wxPoint( -x, 0 ) ); // Up left
1171  aPoints.emplace_back( wxPoint( -x, y ) ); // left down
1172  aPoints.emplace_back( wxPoint( 0, y ) ); // down
1173 
1174  int x_offset = 0;
1175 
1176  switch( m_shape )
1177  {
1179  x_offset = -halfSize;
1180  aPoints[0].x += halfSize;
1181  break;
1182 
1184  aPoints[3].x -= halfSize;
1185  break;
1186 
1189  x_offset = -halfSize;
1190  aPoints[0].x += halfSize;
1191  aPoints[3].x -= halfSize;
1192  break;
1193 
1195  default:
1196  break;
1197  }
1198 
1199  int angle = 0;
1200 
1201  switch( GetLabelSpinStyle() )
1202  {
1203  default:
1204  case LABEL_SPIN_STYLE::LEFT: break;
1205  case LABEL_SPIN_STYLE::UP: angle = -900; break;
1206  case LABEL_SPIN_STYLE::RIGHT: angle = 1800; break;
1207  case LABEL_SPIN_STYLE::BOTTOM: angle = 900; break;
1208  }
1209 
1210  // Rotate outlines and move corners in real position
1211  for( wxPoint& aPoint : aPoints )
1212  {
1213  aPoint.x += x_offset;
1214 
1215  if( angle )
1216  RotatePoint( &aPoint, angle );
1217 
1218  aPoint += Pos;
1219  }
1220 
1221  aPoints.push_back( aPoints[0] ); // closing
1222 }
int GetTextOffset(RENDER_SETTINGS *aSettings=nullptr) const
Definition: sch_text.cpp:308
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
int GetTextHeight() const
Definition: eda_text.h:251
int GetPenWidth() const override
Definition: sch_text.cpp:325
int LenSize(const wxString &aLine, int aThickness) const
Definition: eda_text.cpp:188
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:233
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_text.cpp:492
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)
PINSHEETLABEL_SHAPE m_shape
Definition: sch_text.h:168

References PNS::angle(), LABEL_SPIN_STYLE::BOTTOM, SCH_TEXT::GetLabelSpinStyle(), SCH_TEXT::GetPenWidth(), SCH_TEXT::GetShownText(), EDA_TEXT::GetTextHeight(), SCH_TEXT::GetTextOffset(), LABEL_SPIN_STYLE::LEFT, EDA_TEXT::LenSize(), SCH_TEXT::m_shape, PS_BIDI, PS_INPUT, PS_OUTPUT, PS_TRISTATE, PS_UNSPECIFIED, LABEL_SPIN_STYLE::RIGHT, RotatePoint(), and LABEL_SPIN_STYLE::UP.

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

◆ DoHypertextMenu()

virtual void SCH_ITEM::DoHypertextMenu ( EDA_DRAW_FRAME aFrame)
inlinevirtualinherited

Reimplemented in SCH_FIELD.

Definition at line 280 of file sch_item.h.

280 { }

◆ doIsConnected()

bool SCH_GLOBALLABEL::doIsConnected ( const wxPoint &  aPosition) const
inlineoverrideprivatevirtual

Provide the object specific test to see if it is connected to aPosition.

Note
Override this function if the derived object can be connect to another object such as a wire, bus, or junction. Do not override this function for objects that cannot have connections. The default will always return false. This functions is call through the public function IsConnected() which performs tests common to all schematic items before calling the item specific connection testing.
Parameters
aPositionA reference to a wxPoint object containing the test position.
Returns
True if connection to aPosition exists.

Reimplemented from SCH_ITEM.

Definition at line 452 of file sch_text.h.

453  {
454  return EDA_TEXT::GetTextPos() == aPosition;
455  }
const wxPoint & GetTextPos() const
Definition: eda_text.h:254

References EDA_TEXT::GetTextPos().

◆ Duplicate()

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

Routine to create a new copy of given item.

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

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

Definition at line 78 of file sch_item.cpp.

79 {
80  SCH_ITEM* newItem = (SCH_ITEM*) Clone();
81 
82  if( !doClone )
83  const_cast<KIID&>( newItem->m_Uuid ) = KIID();
84 
85  newItem->ClearFlags( SELECTED | BRIGHTENED );
86 
87  newItem->RunOnChildren(
88  []( SCH_ITEM* aChild )
89  {
90  aChild->ClearFlags( SELECTED | BRIGHTENED );
91  } );
92 
93  return newItem;
94 }
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:97
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction)
Definition: sch_item.h:475
Definition: kiid.h:44
#define BRIGHTENED
item is drawn with a bright contour
Definition: eda_item.h:129
#define SELECTED
Definition: eda_item.h:113
const KIID m_Uuid
Definition: eda_item.h:151
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:221
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194

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

Referenced by SCH_EDIT_TOOL::Duplicate(), CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_EDIT_TOOL::RepeatDrawItem(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ Empty()

void EDA_TEXT::Empty ( )
inlineinherited

Definition at line 261 of file eda_text.h.

261 { m_text.Empty(); }
wxString m_text
Definition: eda_text.h:377

References EDA_TEXT::m_text.

Referenced by SCH_LEGACY_PLUGIN_CACHE::LoadPart().

◆ Format()

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

Output the object to aFormatter in s-expression form.

Parameters
aFormatterThe OUTPUTFORMATTER object to write to.
aNestLevelThe indentation next level.
aControlBitsThe control bit definition for object specific formatting.
Exceptions
IO_ERRORon write error.

Definition at line 520 of file eda_text.cpp.

521 {
522 #ifndef GERBVIEW // Gerbview does not use EDA_TEXT::Format
523  // and does not define FormatInternalUnits, used here
524  // however this function should exist
525 
526  aFormatter->Print( aNestLevel + 1, "(effects" );
527 
528  // Text size
529  aFormatter->Print( 0, " (font" );
530 
531  aFormatter->Print( 0, " (size %s %s)",
532  FormatInternalUnits( GetTextHeight() ).c_str(),
533  FormatInternalUnits( GetTextWidth() ).c_str() );
534 
535  if( GetTextThickness() )
536  aFormatter->Print( 0, " (thickness %s)", FormatInternalUnits( GetTextThickness() ).c_str() );
537 
538  if( IsBold() )
539  aFormatter->Print( 0, " bold" );
540 
541  if( IsItalic() )
542  aFormatter->Print( 0, " italic" );
543 
544  aFormatter->Print( 0, ")"); // (font
545 
546  if( IsMirrored() ||
549  {
550  aFormatter->Print( 0, " (justify");
551 
553  aFormatter->Print( 0, (GetHorizJustify() == GR_TEXT_HJUSTIFY_LEFT) ? " left" : " right" );
554 
556  aFormatter->Print( 0, (GetVertJustify() == GR_TEXT_VJUSTIFY_TOP) ? " top" : " bottom" );
557 
558  if( IsMirrored() )
559  aFormatter->Print( 0, " mirror" );
560  aFormatter->Print( 0, ")" ); // (justify
561  }
562 
563  if( !(aControlBits & CTL_OMIT_HIDE) && !IsVisible() )
564  aFormatter->Print( 0, " hide" );
565 
566  aFormatter->Print( 0, ")\n" ); // (justify
567 
568 #endif
569 }
bool IsBold() const
Definition: eda_text.h:189
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:206
bool IsMirrored() const
Definition: eda_text.h:195
bool IsVisible() const
Definition: eda_text.h:192
int GetTextThickness() const
Definition: eda_text.h:165
int GetTextHeight() const
Definition: eda_text.h:251
bool IsItalic() const
Definition: eda_text.h:186
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:205
int GetTextWidth() const
Definition: eda_text.h:248
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
#define CTL_OMIT_HIDE
Definition: eda_text.h:56
std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from internal units to a string appropriate for writing ...
Definition: base_units.cpp:528

References CTL_OMIT_HIDE, FormatInternalUnits(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), EDA_TEXT::GetVertJustify(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsVisible(), and OUTPUTFORMATTER::Print().

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

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 84 of file inspectable.h.

85  {
87  TYPE_ID thisType = TYPE_HASH( *this );
88  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
89  return object ? aProperty->getter( object ) : wxAny();
90  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
virtual wxAny getter(void *aObject) const =0
Provides class metadata.
Definition: property_mgr.h:61
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

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

Referenced by CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [2/3]

template<typename T >
T INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 93 of file inspectable.h.

94  {
96  TYPE_ID thisType = TYPE_HASH( *this );
97  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
98  return object ? aProperty->get<T>( object ) : T();
99  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
Provides class metadata.
Definition: property_mgr.h:61
T get(void *aObject)
Definition: property.h:275
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

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

◆ Get() [3/3]

template<typename T >
boost::optional<T> INSPECTABLE::Get ( const wxString &  aProperty)
inlineinherited

Definition at line 102 of file inspectable.h.

103  {
105  TYPE_ID thisType = TYPE_HASH( *this );
106  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
107  boost::optional<T> ret;
108 
109  if( prop )
110  {
111  void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
112 
113  if( object )
114  ret = prop->get<T>( object );
115  }
116 
117  return ret;
118  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Returns a property for a specific type.
Provides class metadata.
Definition: property_mgr.h:61
T get(void *aObject)
Definition: property.h:275
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

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

◆ GetBoundingBox()

const EDA_RECT SCH_GLOBALLABEL::GetBoundingBox ( ) const
overridevirtual

Function GetBoundingBox returns 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 SCH_TEXT.

Definition at line 1225 of file sch_text.cpp.

1226 {
1227  int x = GetTextPos().x;
1228  int y = GetTextPos().y;
1229  int penWidth = GetEffectiveTextPenWidth();
1230  int margin = GetTextOffset();
1231  int height = ( (GetTextHeight() * 15) / 10 ) + penWidth + 2 * margin;
1232  int length = LenSize( GetShownText(), penWidth )
1233  + height // add height for triangular shapes
1234  + 2 * margin;
1235 
1236  int dx, dy;
1237 
1238  switch( GetLabelSpinStyle() ) // respect orientation
1239  {
1240  default:
1242  dx = -length;
1243  dy = height;
1244  x += margin;
1245  y -= height / 2;
1246  break;
1247 
1248  case LABEL_SPIN_STYLE::UP:
1249  dx = height;
1250  dy = -length;
1251  x -= height / 2;
1252  y += margin;
1253  break;
1254 
1256  dx = length;
1257  dy = height;
1258  x -= margin;
1259  y -= height / 2;
1260  break;
1261 
1263  dx = height;
1264  dy = length;
1265  x -= height / 2;
1266  y -= margin;
1267  break;
1268  }
1269 
1270  EDA_RECT box( wxPoint( x, y ), wxSize( dx, dy ) );
1271  box.Normalize();
1272  return box;
1273 }
int GetTextOffset(RENDER_SETTINGS *aSettings=nullptr) const
Definition: sch_text.cpp:308
int GetEffectiveTextPenWidth(int aDefaultWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth.
Definition: eda_text.cpp:157
int GetTextHeight() const
Definition: eda_text.h:251
int LenSize(const wxString &aLine, int aThickness) const
Definition: eda_text.cpp:188
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:233
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_text.cpp:492
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
const wxPoint & GetTextPos() const
Definition: eda_text.h:254

References LABEL_SPIN_STYLE::BOTTOM, EDA_TEXT::GetEffectiveTextPenWidth(), SCH_TEXT::GetLabelSpinStyle(), SCH_TEXT::GetShownText(), EDA_TEXT::GetTextHeight(), SCH_TEXT::GetTextOffset(), EDA_TEXT::GetTextPos(), LABEL_SPIN_STYLE::LEFT, EDA_TEXT::LenSize(), EDA_RECT::Normalize(), LABEL_SPIN_STYLE::RIGHT, and LABEL_SPIN_STYLE::UP.

Referenced by AutoplaceFields().

◆ GetClass()

wxString SCH_GLOBALLABEL::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from SCH_TEXT.

Definition at line 392 of file sch_text.h.

393  {
394  return wxT( "SCH_GLOBALLABEL" );
395  }

◆ GetConnectionPoints()

std::vector< wxPoint > SCH_TEXT::GetConnectionPoints ( ) const
overridevirtualinherited

Add all the connection points for this item to aPoints.

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

Parameters
aPointsList of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 437 of file sch_text.cpp.

438 {
439  // Normal text labels do not have connection points. All others do.
440  if( Type() == SCH_TEXT_T )
441  return {};
442 
443  return { GetTextPos() };
444 }
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

References EDA_TEXT::GetTextPos(), SCH_TEXT_T, and EDA_ITEM::Type().

◆ GetContextualTextVars()

void SCH_TEXT::GetContextualTextVars ( wxArrayString *  aVars) const
inherited

Returns the set of contextual text variable tokens for this text item.

Parameters
aVars[out]

Definition at line 482 of file sch_text.cpp.

483 {
485  aVars->push_back( wxT( "CONNECTION_TYPE" ) );
486 
487  if( Type() == SCH_SHEET_PIN_T && m_parent )
488  static_cast<SCH_SHEET*>( m_parent )->GetContextualTextVars( aVars );
489 }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:162
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

References EDA_ITEM::m_parent, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_SHEET_PIN_T, and EDA_ITEM::Type().

Referenced by DIALOG_LABEL_EDITOR::onScintillaCharAdded().

◆ GetDrawRotation()

double EDA_TEXT::GetDrawRotation ( ) const
virtualinherited

Reimplemented in FP_TEXT.

Definition at line 637 of file eda_text.cpp.

638 {
639  return GetTextAngle();
640 }
double GetTextAngle() const
Definition: eda_text.h:180

References EDA_TEXT::GetTextAngle().

Referenced by EDA_TEXT::TransformToSegmentList().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 225 of file eda_item.h.

226  {
227  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
229 
230  return m_flags & mask;
231  }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:107
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:115
#define IS_MOVED
Item being moved.
Definition: eda_item.h:105
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:108
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
Definition: eda_item.h:119
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:110
STATUS_FLAGS m_flags
Definition: eda_item.h:164
#define IS_NEW
New item, just created.
Definition: eda_item.h:106

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_PASTED, IS_RESIZED, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), LIB_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithLibEdit(), SCH_COMPONENT::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ GetEffectiveTextPenWidth()

int EDA_TEXT::GetEffectiveTextPenWidth ( int  aDefaultWidth = 0) const
inherited

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

Definition at line 157 of file eda_text.cpp.

158 {
159  int width = GetTextThickness();
160 
161  if( width <= 1 )
162  {
163  width = aDefaultWidth;
164 
165  if( IsBold() )
166  width = GetPenSizeForBold( GetTextWidth() );
167  else if( width <= 1 )
168  width = GetPenSizeForNormal( GetTextWidth() );
169  }
170 
171  // Clip pen size for small texts:
173 
174  return width;
175 }
bool IsBold() const
Definition: eda_text.h:189
int GetPenSizeForBold(int aTextSize)
Function GetPensizeForBold.
Definition: gr_text.cpp:48
int GetTextThickness() const
Definition: eda_text.h:165
int Clamp_Text_PenSize(int aPenSize, int aSize, bool aBold)
Function Clamp_Text_PenSize Don't allow text to become cluttered up in its own fatness.
Definition: gr_text.cpp:69
const wxSize & GetTextSize() const
Definition: eda_text.h:245
int GetPenSizeForNormal(int aTextSize)
Function GetPensizeForNormal.
Definition: gr_text.cpp:54
#define ALLOW_BOLD_THICKNESS
Definition: base_units.h:57
int GetTextWidth() const
Definition: eda_text.h:248

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

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), KIGFX::WS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), export_vrml_fp_text(), export_vrml_pcbtext(), GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), EDA_TEXT::GetEffectiveTextShape(), LIB_TEXT::GetPenWidth(), LIB_FIELD::GetPenWidth(), SCH_FIELD::GetPenWidth(), SCH_TEXT::GetPenWidth(), EDA_TEXT::GetTextBox(), KIGFX::SCH_PAINTER::getTextThickness(), LIB_TEXT::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), LIB_TEXT::print(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), PNS_KICAD_IFACE_BASE::syncTextItem(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), ALIGNED_DIMENSION::updateGeometry(), ORTHOGONAL_DIMENSION::updateGeometry(), LEADER::updateGeometry(), ALIGNED_DIMENSION::updateText(), and ORTHOGONAL_DIMENSION::updateText().

◆ GetEffectiveTextShape()

std::shared_ptr< SHAPE_COMPOUND > EDA_TEXT::GetEffectiveTextShape ( ) const
inherited

Definition at line 624 of file eda_text.cpp.

625 {
626  std::shared_ptr<SHAPE_COMPOUND> shape = std::make_shared<SHAPE_COMPOUND>();
627  int penWidth = GetEffectiveTextPenWidth();
628  std::vector<wxPoint> pts = TransformToSegmentList();
629 
630  for( unsigned jj = 0; jj < pts.size(); jj += 2 )
631  shape->AddShape( new SHAPE_SEGMENT( pts[jj], pts[jj+1], penWidth ) );
632 
633  return shape;
634 }
std::vector< wxPoint > TransformToSegmentList() const
Convert the text shape to a list of segment.
Definition: eda_text.cpp:584
int GetEffectiveTextPenWidth(int aDefaultWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth.
Definition: eda_text.cpp:157

References EDA_TEXT::GetEffectiveTextPenWidth(), and EDA_TEXT::TransformToSegmentList().

Referenced by PCB_TEXT::GetEffectiveShape(), and FP_TEXT::GetEffectiveShape().

◆ GetEndPoints()

void SCH_TEXT::GetEndPoints ( std::vector< DANGLING_END_ITEM > &  aItemList)
overridevirtualinherited

Add the schematic item end points to aItemList if the item has end points.

The default version doesn't do anything since many of the schematic object cannot be tested for dangling ends. If you add a new schematic item that can have a dangling end ( no connect ), override this method to provide the correct end points.

Parameters
aItemList- List of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 340 of file sch_text.cpp.

341 {
342  // Normal text labels cannot be tested for dangling ends.
343  if( Type() == SCH_TEXT_T )
344  return;
345 
346  DANGLING_END_ITEM item( LABEL_END, this, GetTextPos() );
347  aItemList.push_back( item );
348 }
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
Helper class used to store the state of schematic items that can be connected to other schematic item...
Definition: sch_item.h:85
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

References EDA_TEXT::GetTextPos(), LABEL_END, SCH_TEXT_T, and EDA_ITEM::Type().

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const
inlineinherited

Return whether the fields have been automatically placed.

Definition at line 453 of file sch_item.h.

453 { return m_fieldsAutoplaced; }
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201

References SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_ITEM::AutoAutoplaceFields(), and EE_POINT_EDITOR::updateParentItem().

◆ GetFlags()

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and TRACK.

Definition at line 333 of file eda_item.h.

333 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: eda_item.h:325

References EDA_ITEM::GetPosition().

Referenced by PCB_BASE_FRAME::FocusOnItem(), and SCH_EDIT_FRAME::FocusOnItem().

◆ GetHorizJustify()

EDA_TEXT_HJUSTIFY_T EDA_TEXT::GetHorizJustify ( ) const
inlineinherited

Definition at line 205 of file eda_text.h.

205 { return EDA_TEXT_HJUSTIFY_T( m_e.hjustify ); };
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:61
TEXT_EFFECTS m_e
Definition: eda_text.h:381
signed char hjustify
horizontal justification
Definition: eda_text.h:101

References TEXT_EFFECTS::hjustify, and EDA_TEXT::m_e.

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), export_vrml_fp_text(), export_vrml_pcbtext(), AUTOPLACER::field_horiz_placement(), PCB_TEXT::Flip(), FP_TEXT::Flip(), EDA_TEXT::Format(), 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(), LIB_TEXT::MirrorHorizontal(), MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), positioningChanged(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), LIB_TEXT::Rotate(), Rotate90(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), KIGFX::GAL::SetTextAttributes(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

◆ GetInterline()

int EDA_TEXT::GetInterline ( ) const
inherited

Return the distance between two lines of text.

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

Definition at line 217 of file eda_text.cpp.

218 {
220 }
static double GetInterline(double aGlyphHeight)
Compute the distance (interline) between 2 lines of text (for multiline texts).
int GetTextHeight() const
Definition: eda_text.h:251
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68

References KIGFX::STROKE_FONT::GetInterline(), EDA_TEXT::GetTextHeight(), and KiROUND().

Referenced by EDA_TEXT::GetLinePositions(), and EDA_TEXT::GetTextBox().

◆ GetIntersheetRefs()

◆ GetLabelSpinStyle()

◆ GetLayer()

◆ GetLinePositions()

void EDA_TEXT::GetLinePositions ( std::vector< wxPoint > &  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
aPositionsis the list to populate by the wxPoint positions
aLineCountis the number of lines (not recalculated here for efficiency reasons

Definition at line 424 of file eda_text.cpp.

425 {
426  wxPoint pos = GetTextPos(); // Position of first line of the
427  // multiline text according to
428  // the center of the multiline text block
429 
430  wxPoint offset; // Offset to next line.
431 
432  offset.y = GetInterline();
433 
434  if( aLineCount > 1 )
435  {
436  switch( GetVertJustify() )
437  {
439  break;
440 
442  pos.y -= ( aLineCount - 1 ) * offset.y / 2;
443  break;
444 
446  pos.y -= ( aLineCount - 1 ) * offset.y;
447  break;
448  }
449  }
450 
451  // Rotate the position of the first line
452  // around the center of the multiline text block
453  RotatePoint( &pos, GetTextPos(), GetTextAngle() );
454 
455  // Rotate the offset lines to increase happened in the right direction
456  RotatePoint( &offset, GetTextAngle() );
457 
458  for( int ii = 0; ii < aLineCount; ii++ )
459  {
460  aPositions.push_back( pos );
461  pos += offset;
462  }
463 }
int GetInterline() const
Return the distance between two lines of text.
Definition: eda_text.cpp:217
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:206
double GetTextAngle() const
Definition: eda_text.h:180
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
const wxPoint & GetTextPos() const
Definition: eda_text.h:254

References EDA_TEXT::GetInterline(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetVertJustify(), GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, and RotatePoint().

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), export_vrml_pcbtext(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), EDA_TEXT::Print(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), and EDA_TEXT::TransformToSegmentList().

◆ GetMenuImage()

BITMAP_DEF SCH_GLOBALLABEL::GetMenuImage ( ) const
overridevirtual

Function GetMenuImage returns 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 SCH_TEXT.

Definition at line 1282 of file sch_text.cpp.

1283 {
1284  return add_glabel_xpm;
1285 }
const BITMAP_OPAQUE add_glabel_xpm[1]
Definition: add_glabel.cpp:42

References add_glabel_xpm.

◆ GetMsgPanelInfo()

void SCH_TEXT::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtualinherited

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters
aListis the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 629 of file sch_text.cpp.

630 {
631  wxString msg;
632 
633  switch( Type() )
634  {
635  case SCH_TEXT_T: msg = _( "Graphic Text" ); break;
636  case SCH_LABEL_T: msg = _( "Label" ); break;
637  case SCH_GLOBAL_LABEL_T: msg = _( "Global Label" ); break;
638  case SCH_HIER_LABEL_T: msg = _( "Hierarchical Label" ); break;
639  case SCH_SHEET_PIN_T: msg = _( "Hierarchical Sheet Pin" ); break;
640  default: return;
641  }
642 
643  aList.push_back( MSG_PANEL_ITEM( msg, GetShownText() ) );
644 
645  switch( GetLabelSpinStyle() )
646  {
647  case LABEL_SPIN_STYLE::LEFT: msg = _( "Horizontal left" ); break;
648  case LABEL_SPIN_STYLE::UP: msg = _( "Vertical up" ); break;
649  case LABEL_SPIN_STYLE::RIGHT: msg = _( "Horizontal right" ); break;
650  case LABEL_SPIN_STYLE::BOTTOM: msg = _( "Vertical down" ); break;
651  default: msg = wxT( "???" ); break;
652  }
653 
654  aList.push_back( MSG_PANEL_ITEM( _( "Orientation" ), msg, BROWN ) );
655 
656  wxString textStyle[] = { _( "Normal" ), _( "Italic" ), _( "Bold" ), _( "Bold Italic" ) };
657  int style = 0;
658 
659  if( IsItalic() )
660  style = 1;
661 
662  if( IsBold() )
663  style += 2;
664 
665  aList.push_back( MSG_PANEL_ITEM( _( "Style" ), textStyle[style] ) );
666 
667  // Display electrical type if it is relevant
669  {
670  msg = getElectricalTypeLabel( GetShape() );
671  aList.push_back( MSG_PANEL_ITEM( _( "Type" ), msg ) );
672  }
673 
674  // Display text size (X or Y value, with are the same value in Eeschema)
675  msg = MessageTextFromValue( aFrame->GetUserUnits(), GetTextWidth() );
676  aList.push_back( MSG_PANEL_ITEM( _( "Size" ), msg ) );
677 
678  SCH_EDIT_FRAME* frame = dynamic_cast<SCH_EDIT_FRAME*>( aFrame );
679 
680  if( frame )
681  {
682  if( SCH_CONNECTION* conn = Connection() )
683  {
684  conn->AppendInfoToMsgPanel( aList );
685 
686  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
687  const wxString& netname = conn->Name( true );
688 
689  if( netSettings.m_NetClassAssignments.count( netname ) )
690  {
691  const wxString& netclassName = netSettings.m_NetClassAssignments[ netname ];
692  aList.push_back( MSG_PANEL_ITEM( _( "Assigned Netclass" ), netclassName ) );
693  }
694  }
695  }
696 }
bool IsBold() const
Definition: eda_text.h:189
std::map< wxString, wxString > m_NetClassAssignments
Definition: net_settings.h:43
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Definition: base_units.cpp:123
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
Definition: color4d.h:62
NET_SETTINGS & NetSettings()
Definition: project_file.h:92
Schematic editor (Eeschema) main window.
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:131
bool IsItalic() const
Definition: eda_text.h:186
VTBL_ENTRY PROJECT_FILE & GetProjectFile() const
Definition: project.h:143
NET_SETTINGS stores various net-related settings in a project context.
Definition: net_settings.h:31
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:233
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_text.cpp:492
int GetTextWidth() const
Definition: eda_text.h:248
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
#define _(s)
Definition: 3d_actions.cpp:33
PROJECT & Prj() const
Return a reference to the project this schematic is part of.
Definition: schematic.h:85
wxString getElectricalTypeLabel(PINSHEETLABEL_SHAPE aType)
Definition: sch_text.cpp:468
EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:54
EDA_UNITS GetUserUnits() const
Return the user units currently in use.
PINSHEETLABEL_SHAPE GetShape() const
Definition: sch_text.h:235
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

References _, LABEL_SPIN_STYLE::BOTTOM, BROWN, SCH_ITEM::Connection(), getElectricalTypeLabel(), SCH_TEXT::GetLabelSpinStyle(), PROJECT::GetProjectFile(), SCH_TEXT::GetShape(), SCH_TEXT::GetShownText(), EDA_TEXT::GetTextWidth(), EDA_BASE_FRAME::GetUserUnits(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), LABEL_SPIN_STYLE::LEFT, NET_SETTINGS::m_NetClassAssignments, MessageTextFromValue(), PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), LABEL_SPIN_STYLE::RIGHT, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_SHEET_PIN_T, SCH_TEXT_T, SCH_ITEM::Schematic(), EDA_ITEM::Type(), and LABEL_SPIN_STYLE::UP.

◆ GetParent()

◆ GetPenWidth()

int SCH_TEXT::GetPenWidth ( ) const
overridevirtualinherited
Returns
the size of the "pen" that be used to draw or plot this item

Reimplemented from SCH_ITEM.

Definition at line 325 of file sch_text.cpp.

326 {
327  return GetEffectiveTextPenWidth();
328 }
int GetEffectiveTextPenWidth(int aDefaultWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth.
Definition: eda_text.cpp:157

References EDA_TEXT::GetEffectiveTextPenWidth().

Referenced by AutoplaceFields(), CreateGraphicShape(), SCH_TEXT::GetSchematicTextOffset(), Print(), and SCH_HIERLABEL::Print().

◆ GetPosition()

◆ GetSchematicTextOffset()

wxPoint SCH_GLOBALLABEL::GetSchematicTextOffset ( RENDER_SETTINGS aSettings) const
overridevirtual
Returns
the offset between the SCH_TEXT position and the text itself position

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

Reimplemented from SCH_TEXT.

Definition at line 894 of file sch_text.cpp.

895 {
896  wxPoint text_offset;
897  int dist = GetTextOffset( aSettings );
898 
899  switch( m_shape )
900  {
904  dist += GetTextHeight() * 3 / 4; // Use three-quarters-height as proxy for triangle size
905  break;
906 
909  default:
910  break;
911  }
912 
913  switch( GetLabelSpinStyle() )
914  {
915  default:
916  case LABEL_SPIN_STYLE::LEFT: text_offset.x -= dist; break;
917  case LABEL_SPIN_STYLE::UP: text_offset.y -= dist; break;
918  case LABEL_SPIN_STYLE::RIGHT: text_offset.x += dist; break;
919  case LABEL_SPIN_STYLE::BOTTOM: text_offset.y += dist; break;
920  }
921 
922  return text_offset;
923 }
int GetTextOffset(RENDER_SETTINGS *aSettings=nullptr) const
Definition: sch_text.cpp:308
int GetTextHeight() const
Definition: eda_text.h:251
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:233
PINSHEETLABEL_SHAPE m_shape
Definition: sch_text.h:168

References LABEL_SPIN_STYLE::BOTTOM, SCH_TEXT::GetLabelSpinStyle(), EDA_TEXT::GetTextHeight(), SCH_TEXT::GetTextOffset(), LABEL_SPIN_STYLE::LEFT, SCH_TEXT::m_shape, PS_BIDI, PS_INPUT, PS_OUTPUT, PS_TRISTATE, PS_UNSPECIFIED, LABEL_SPIN_STYLE::RIGHT, and LABEL_SPIN_STYLE::UP.

Referenced by Print().

◆ GetSelectMenuText()

wxString SCH_GLOBALLABEL::GetSelectMenuText ( EDA_UNITS  aUnits) const
overridevirtual

Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

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

Definition at line 1276 of file sch_text.cpp.

1277 {
1278  return wxString::Format( _( "Global Label '%s'" ), ShortenedShownText() );
1279 }
wxString ShortenedShownText() const
Returns a shortened version (max 15 characters) of the shown text.
Definition: eda_text.cpp:202
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33

References _, Format(), and EDA_TEXT::ShortenedShownText().

◆ GetShape()

◆ GetShownText() [1/2]

wxString EDA_TEXT::GetShownText ( bool *  processTextVars) const
inlineinherited

A version of GetShownText() which also indicates whether or not the text needs to be processed for text variables.

Parameters
processTextVars[out]

Definition at line 147 of file eda_text.h.

148  {
149  *processTextVars = m_shown_text_has_text_var_refs;
150  return m_shown_text;
151  }
wxString m_shown_text
Definition: eda_text.h:378
bool m_shown_text_has_text_var_refs
Definition: eda_text.h:379

References EDA_TEXT::m_shown_text, and EDA_TEXT::m_shown_text_has_text_var_refs.

◆ GetShownText() [2/2]

wxString SCH_TEXT::GetShownText ( int  aDepth = 0) const
overridevirtualinherited

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

@aParam aDepth is used to prevent infinite recusions and loops when expanding text variables.

Reimplemented from EDA_TEXT.

Definition at line 492 of file sch_text.cpp.

493 {
494  std::function<bool( wxString* )> textResolver =
495  [&]( wxString* token ) -> bool
496  {
497  if( ( Type() == SCH_GLOBAL_LABEL_T
498  || Type() == SCH_HIER_LABEL_T
499  || Type() == SCH_SHEET_PIN_T )
500  && token->IsSameAs( wxT( "CONNECTION_TYPE" ) ) )
501  {
502  *token = getElectricalTypeLabel( GetShape() );
503  return true;
504  }
505 
506  if( Type() == SCH_SHEET_PIN_T && m_parent )
507  {
508  SCH_SHEET* sheet = static_cast<SCH_SHEET*>( m_parent );
509 
510  if( sheet->ResolveTextVar( token, aDepth ) )
511  return true;
512  }
513 
514  if( Type() == SCH_TEXT_T )
515  {
516  if( token->Contains( ':' ) )
517  {
518  if( Schematic()->ResolveCrossReference( token, aDepth ) )
519  return true;
520  }
521  else
522  {
523  SCHEMATIC* schematic = Schematic();
524  SCH_SHEET* sheet = schematic ? schematic->CurrentSheet().Last() : nullptr;
525 
526  if( sheet && sheet->ResolveTextVar( token, aDepth + 1 ) )
527  return true;
528  }
529  }
530 
531  return false;
532  };
533 
534  bool processTextVars = false;
535  wxString text = EDA_TEXT::GetShownText( &processTextVars );
536 
537  if( processTextVars )
538  {
539  wxCHECK_MSG( Schematic(), wxEmptyString,
540  "No parent SCHEMATIC set for SCH_TEXT!" );
541 
542  PROJECT* project = nullptr;
543 
544  if( Schematic() )
545  project = &Schematic()->Prj();
546 
547  if( aDepth < 10 )
548  text = ExpandTextVars( text, &textResolver, project );
549  }
550 
551  return text;
552 }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:162
PROJECT holds project specific data.
Definition: project.h:63
Holds all the data relating to one schematic A schematic may consist of one or more sheets (and one r...
Definition: schematic.h:44
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
bool ResolveCrossReference(wxString *token, int aDepth) const
Resolves text vars that refer to other items.
Definition: schematic.cpp:210
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:219
wxString ExpandTextVars(const wxString &aSource, const std::function< bool(wxString *)> *aLocalResolver, const PROJECT *aProject, const std::function< bool(wxString *)> *aFallbackResolver)
Expand '${var-name}' templates in text.
Definition: common.cpp:58
PROJECT & Prj() const
Return a reference to the project this schematic is part of.
Definition: schematic.h:85
wxString getElectricalTypeLabel(PINSHEETLABEL_SHAPE aType)
Definition: sch_text.cpp:468
bool ResolveTextVar(wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the sheet.
Definition: sch_sheet.cpp:204
virtual wxString GetShownText(int aDepth=0) const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:140
PINSHEETLABEL_SHAPE GetShape() const
Definition: sch_text.h:235
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181
SCH_SHEET_PATH & CurrentSheet() const
Definition: schematic.h:127

References SCHEMATIC::CurrentSheet(), ExpandTextVars(), getElectricalTypeLabel(), SCH_TEXT::GetShape(), EDA_TEXT::GetShownText(), SCH_SHEET_PATH::Last(), EDA_ITEM::m_parent, SCHEMATIC::Prj(), SCHEMATIC::ResolveCrossReference(), SCH_SHEET::ResolveTextVar(), SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_SHEET_PIN_T, SCH_TEXT_T, SCH_ITEM::Schematic(), and EDA_ITEM::Type().

Referenced by CreateGraphicShape(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckLabels(), GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXT::Plot(), BACK_ANNOTATE::processNetNameChange(), and ERC_TESTER::TestSimilarLabels().

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 204 of file eda_item.h.

205  {
206  return m_status & type;
207  }
STATUS_FLAGS m_status
Definition: eda_item.h:161

References EDA_ITEM::m_status.

Referenced by TRACK::GetMsgPanelInfoBase_Common(), and TRACK::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 217 of file eda_item.h.

217 { return m_status; }
STATUS_FLAGS m_status
Definition: eda_item.h:161

References EDA_ITEM::m_status.

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 249 of file sch_item.h.

249 { return m_storedPos; }
wxPoint m_storedPos
Definition: sch_item.h:202

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::moveItem().

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const
inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 486 of file sch_item.h.

486 { wxCHECK( false, STROKE_PARAMS() ); }
Simple container to manage line stroke parameters.
Definition: sch_item.h:153

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

133 { return m_text; }
wxString m_text
Definition: eda_text.h:377

References EDA_TEXT::m_text.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), NETLIST_EXPORTER_XML::addSymbolFields(), SIM_PLOT_FRAME::AddTuner(), CONNECTION_GRAPH::buildConnectionGraph(), SCH_EDIT_TOOL::ChangeTextType(), LIB_TEXT::Clone(), LIB_TEXT::compare(), LIB_FIELD::compare(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), KIGFX::SCH_VIEW::DisplayComponent(), SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), SCH_FIELD::DoHypertextMenu(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::Duplicate(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CONNECTION_GRAPH::ercCheckHierSheets(), LIB_PART::Flatten(), PCB_IO::format(), FormatProbeItem(), SCH_COMPONENT::GetFootprint(), LIB_FIELD::GetFullText(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet(), FP_TEXT::GetLength(), getMatchingTextItem(), SCH_COMPONENT::GetRef(), LIB_PART::GetSearchText(), DIMENSION_BASE::GetText(), TEXT_MOD_GRID_TABLE::GetValue(), SCH_COMPONENT::GetValue(), hash_fp_item(), LIB_FIELD::HitTest(), SCH_EDIT_FRAME::importFile(), SCH_DRAWING_TOOLS::importHierLabel(), SCH_TEXT::IncrementLabel(), GENERAL_COLLECTOR::Inspect(), SCH_SCREEN::IsTerminalPoint(), SCH_FIELD::IsVoid(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_EAGLE_PLUGIN::loadSegments(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_FIELD::operator<(), SCH_TEXT::operator<(), LIB_FIELD::operator=(), SCH_COMPONENT::operator==(), PCB_PARSER::parseDIMENSION(), SCH_SEXPR_PARSER::parseSchematicSymbol(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), DRAWING_TOOL::PlaceText(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), DIALOG_RESCUE_EACH::PopulateInstanceList(), LIB_FIELD::print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), processTextItem(), SCH_EDIT_FRAME::RecomputeIntersheetsRefs(), ResolveTextVar(), SCH_LEGACY_PLUGIN::saveComponent(), SCH_SEXPR_PLUGIN::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_LEGACY_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_COMPONENT::SetRef(), LIB_VIEW_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_SHEET::SymbolCount(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), TUNER_SLIDER::TUNER_SLIDER(), DIALOG_FOOTPRINT_FP_EDITOR::Validate(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), and FP_TEXT::ViewGetLOD().

◆ GetTextAngle()

double EDA_TEXT::GetTextAngle ( ) const
inlineinherited

Definition at line 180 of file eda_text.h.

180 { return m_e.angle; }
TEXT_EFFECTS m_e
Definition: eda_text.h:381
double angle
now: 0.1 degrees; future: degrees
Definition: eda_text.h:105

References TEXT_EFFECTS::angle, and EDA_TEXT::m_e.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), BOARD_ADAPTER::AddShapeWithClearanceToContainer(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::WS_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), export_vrml_pcbtext(), PCB_TEXT::Flip(), FP_TEXT::Flip(), PCB_IO::format(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), FP_TEXT::GetDrawRotation(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetLinePositions(), PCB_TEXT::GetMsgPanelInfo(), EDA_TEXT::GetTextAngleDegrees(), EDA_TEXT::GetTextAngleRadians(), TEXT_MOD_GRID_TABLE::GetValue(), hash_fp_item(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), FP_TEXT::KeepUpright(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), DIMENSION_BASE::Mirror(), LIB_TEXT::MirrorHorizontal(), MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), EAGLE_PLUGIN::orientFPText(), PCB_PARSER::parseFOOTPRINT_unchecked(), ALTIUM_PCB::ParseTexts6Data(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), positioningChanged(), LIB_TEXT::print(), LIB_FIELD::print(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), SCH_EDIT_TOOL::Rotate(), LIB_TEXT::Rotate(), PCB_TEXT::Rotate(), FP_TEXT::Rotate(), LIB_FIELD::Rotate(), DIMENSION_BASE::Rotate(), Rotate90(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), EDA_TEXT::TextHitTest(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

◆ GetTextAngleDegrees()

double EDA_TEXT::GetTextAngleDegrees ( ) const
inlineinherited

◆ GetTextAngleRadians()

double EDA_TEXT::GetTextAngleRadians ( ) const
inlineinherited

◆ GetTextBox()

EDA_RECT 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
aLineThe line of text to consider. Pass -1 for all lines.
aInvertYInvert 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 223 of file eda_text.cpp.

224 {
225  EDA_RECT rect;
226  wxArrayString strings;
227  wxString text = GetShownText();
228  int thickness = GetEffectiveTextPenWidth();
229  int linecount = 1;
230  bool hasOverBar = false; // true if the first line of text as an overbar
231 
232  if( IsMultilineAllowed() )
233  {
234  wxStringSplit( text, strings, '\n' );
235 
236  if( strings.GetCount() ) // GetCount() == 0 for void strings
237  {
238  if( aLine >= 0 && ( aLine < (int)strings.GetCount() ) )
239  text = strings.Item( aLine );
240  else
241  text = strings.Item( 0 );
242 
243  linecount = strings.GetCount();
244  }
245  }
246 
247  // Search for overbar symbol. Only text is scanned,
248  // because only this line can change the bounding box
249  for( unsigned ii = 1; ii < text.size(); ii++ )
250  {
251  if( text[ii-1] == '~' && text[ii] != '~' )
252  {
253  hasOverBar = true;
254  break;
255  }
256  }
257 
258  // calculate the H and V size
259  const auto& font = basic_gal.GetStrokeFont();
260  VECTOR2D fontSize( GetTextSize() );
261  double penWidth( thickness );
262  int dx = KiROUND( font.ComputeStringBoundaryLimits( text, fontSize, penWidth ).x );
263  int dy = GetInterline();
264 
265  // Creates bounding box (rectangle) for horizontal, left and top justified text. The
266  // bounding box will be moved later according to the actual text options
267  wxSize textsize = wxSize( dx, dy );
268  wxPoint pos = GetTextPos();
269 
270  if( aInvertY )
271  pos.y = -pos.y;
272 
273  rect.SetOrigin( pos );
274 
275  // The bbox vertical size returned by GetInterline( aThickness )
276  // includes letters like j and y and ] + interval between lines.
277  // The interval below the last line is not usefull, and we can use its half value
278  // as vertical margin above the text
279  // the full interval is roughly GetTextHeight() * 0.4 - aThickness/2
280  rect.Move( wxPoint( 0, thickness/4 - KiROUND( GetTextHeight() * 0.22 ) ) );
281 
282  if( hasOverBar )
283  { // A overbar adds an extra size to the text
284  // Height from the base line text of chars like [ or {
285  double curr_height = GetTextHeight() * 1.15;
286  double overbarPosition = font.ComputeOverbarVerticalPosition( fontSize.y );
287  int extra_height = KiROUND( overbarPosition - curr_height );
288 
289  extra_height += thickness / 2;
290  textsize.y += extra_height;
291  rect.Move( wxPoint( 0, -extra_height ) );
292  }
293 
294  // for multiline texts and aLine < 0, merge all rectangles
295  // ( if aLine < 0, we want the full text bounding box )
296  if( IsMultilineAllowed() && aLine < 0 )
297  {
298  for( unsigned ii = 1; ii < strings.GetCount(); ii++ )
299  {
300  text = strings.Item( ii );
301  dx = KiROUND( font.ComputeStringBoundaryLimits( text, fontSize, penWidth ).x );
302  textsize.x = std::max( textsize.x, dx );
303  textsize.y += dy;
304  }
305  }
306 
307  rect.SetSize( textsize );
308 
309  /* Now, calculate the rect origin, according to text justification
310  * At this point the rectangle origin is the text origin (m_Pos).
311  * This is true only for left and top text justified texts (using top to bottom Y axis
312  * orientation). and must be recalculated for others justifications
313  * also, note the V justification is relative to the first line
314  */
315  switch( GetHorizJustify() )
316  {
318  if( IsMirrored() )
319  rect.SetX( rect.GetX() - rect.GetWidth() );
320  break;
321 
323  rect.SetX( rect.GetX() - (rect.GetWidth() / 2) );
324  break;
325 
327  if( !IsMirrored() )
328  rect.SetX( rect.GetX() - rect.GetWidth() );
329  break;
330  }
331 
332  dy = GetTextHeight() + thickness;
333 
334  switch( GetVertJustify() )
335  {
337  break;
338 
340  rect.SetY( rect.GetY() - ( dy / 2) );
341  break;
342 
344  rect.SetY( rect.GetY() - dy );
345  break;
346  }
347 
348  if( linecount > 1 )
349  {
350  int yoffset;
351  linecount -= 1;
352 
353  switch( GetVertJustify() )
354  {
356  break;
357 
359  yoffset = linecount * GetInterline() / 2;
360  rect.SetY( rect.GetY() - yoffset );
361  break;
362 
364  yoffset = linecount * GetInterline();
365  rect.SetY( rect.GetY() - yoffset );
366  break;
367  }
368  }
369 
370  rect.Normalize(); // Make h and v sizes always >= 0
371 
372  return rect;
373 }
const STROKE_FONT & GetStrokeFont() const
int GetInterline() const
Return the distance between two lines of text.
Definition: eda_text.cpp:217
void Move(const wxPoint &aMoveVector)
Function Move moves the rectangle by the aMoveVector.
Definition: eda_rect.cpp:51
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:206
bool IsMirrored() const
Definition: eda_text.h:195
int GetX() const
Definition: eda_rect.h:111
int GetWidth() const
Definition: eda_rect.h:119
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:131
int GetEffectiveTextPenWidth(int aDefaultWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth.
Definition: eda_text.cpp:157
int GetTextHeight() const
Definition: eda_text.h:251
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:205
const wxSize & GetTextSize() const
Definition: eda_text.h:245
void SetX(int val)
Definition: eda_rect.h:168
bool IsMultilineAllowed() const
Definition: eda_text.h:203
void SetY(int val)
Definition: eda_rect.h:174
void wxStringSplit(const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
Split aString to a string list separated at aSplitter.
Definition: string.cpp:796
void Normalize()
Function Normalize ensures that the height ant width are positive.
Definition: eda_rect.cpp:35
void SetSize(const wxSize &size)
Definition: eda_rect.h:144
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int GetY() const
Definition: eda_rect.h:112
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
BASIC_GAL basic_gal(basic_displayOptions)
virtual wxString GetShownText(int aDepth=0) const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:140

References basic_gal, EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetInterline(), EDA_TEXT::GetShownText(), KIGFX::GAL::GetStrokeFont(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetVertJustify(), EDA_RECT::GetWidth(), EDA_RECT::GetX(), EDA_RECT::GetY(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, EDA_TEXT::IsMirrored(), EDA_TEXT::IsMultilineAllowed(), KiROUND(), EDA_RECT::Move(), EDA_RECT::Normalize(), EDA_RECT::SetOrigin(), EDA_RECT::SetSize(), EDA_RECT::SetX(), EDA_RECT::SetY(), wxStringSplit(), and VECTOR2< T >::y.

Referenced by PCB_TEXT::Flip(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), FP_TEXT::GetBoundingBox(), DIMENSION_BASE::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), WS_DRAW_ITEM_TEXT::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), LIB_TEXT::NormalizeJustification(), FP_TEXT::TextHitTest(), EDA_TEXT::TextHitTest(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), ALIGNED_DIMENSION::updateGeometry(), ORTHOGONAL_DIMENSION::updateGeometry(), LEADER::updateGeometry(), and FP_TEXT::ViewBBox().

◆ GetTextHeight()

◆ GetTextOffset()

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

Definition at line 308 of file sch_text.cpp.

309 {
310  double ratio;
311 
312  if( aSettings )
313  ratio = static_cast<SCH_RENDER_SETTINGS*>( aSettings )->m_TextOffsetRatio;
314  else if( Schematic() )
315  ratio = Schematic()->Settings().m_TextOffsetRatio;
316  else
317  ratio = DEFAULT_TEXT_OFFSET_RATIO; // For previews (such as in Preferences), etc.
318 
319  return KiROUND( ratio * GetTextSize().y );
320 
321  return 0;
322 }
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:125
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
const wxSize & GetTextSize() const
Definition: eda_text.h:245
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
#define DEFAULT_TEXT_OFFSET_RATIO
The offset of the pin name string from the end of the pin in mils.

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

Referenced by AutoplaceFields(), CreateGraphicShape(), SCH_LABEL::GetBoundingBox(), GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), SCH_TEXT::GetSchematicTextOffset(), GetSchematicTextOffset(), and SCH_HIERLABEL::GetSchematicTextOffset().

◆ GetTextPos()

const wxPoint& EDA_TEXT::GetTextPos ( ) const
inlineinherited

Definition at line 254 of file eda_text.h.

254 { return m_e.pos; }
TEXT_EFFECTS m_e
Definition: eda_text.h:381
wxPoint pos
Definition: eda_text.h:106

References EDA_TEXT::m_e, and TEXT_EFFECTS::pos.

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), LIB_TEXT::compare(), LIB_FIELD::compare(), SCH_SHEET_PIN::ConstrainOnEdge(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), SCH_LABEL::doIsConnected(), doIsConnected(), SCH_HIERLABEL::doIsConnected(), KIGFX::WS_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), export_vrml_fp_text(), export_vrml_pcbtext(), FP_TEXT::Flip(), PCB_IO::format(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), FP_TEXT::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), SCH_TEXT::GetConnectionPoints(), SCH_SHEET_PIN::GetEndPoints(), SCH_TEXT::GetEndPoints(), SCH_FIELD::GetLibPosition(), EDA_TEXT::GetLinePositions(), PCB_TEXT::GetPosition(), LIB_TEXT::GetPosition(), FP_TEXT::GetPosition(), LIB_FIELD::GetPosition(), SCH_FIELD::GetPosition(), WS_DRAW_ITEM_TEXT::GetPosition(), SCH_TEXT::GetPosition(), EDA_TEXT::GetTextBox(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), FP_TEXT::Mirror(), DIMENSION_BASE::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_FIELD::MirrorHorizontal(), MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), LIB_FIELD::MirrorVertical(), SCH_SHEET_PIN::MirrorX(), SCH_TEXT::MirrorX(), SCH_SHEET_PIN::MirrorY(), SCH_TEXT::MirrorY(), LIB_TEXT::NormalizeJustification(), PCB_PARSER::parseDIMENSION(), DRAWING_TOOL::PlaceText(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), LIB_FIELD::print(), EDA_TEXT::Print(), Print(), SCH_HIERLABEL::Print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), LIB_TEXT::Rotate(), PCB_TEXT::Rotate(), FP_TEXT::Rotate(), SCH_FIELD::Rotate(), SCH_SHEET_PIN::Rotate(), LIB_FIELD::Rotate(), DIMENSION_BASE::Rotate(), SCH_TEXT::Rotate(), Rotate(), Rotate90(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), FP_TEXT::SetDrawCoord(), FP_TEXT::SetLocalCoord(), SCH_COMPONENT::SetRef(), FP_TEXT::TextHitTest(), EDA_TEXT::TextHitTest(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), SCH_TEXT::UpdateDanglingState(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and FP_TEXT::ViewBBox().

◆ GetTextSize()

◆ GetTextStyleName()

wxString EDA_TEXT::GetTextStyleName ( ) const
inherited
Returns
a wxString with the style name( Normal, Italic, Bold, Bold+Italic)

Definition at line 485 of file eda_text.cpp.

486 {
487  int style = 0;
488 
489  if( IsItalic() )
490  style = 1;
491 
492  if( IsBold() )
493  style += 2;
494 
495  wxString stylemsg[4] = {
496  _("Normal"),
497  _("Italic"),
498  _("Bold"),
499  _("Bold+Italic")
500  };
501 
502  return stylemsg[style];
503 }
bool IsBold() const
Definition: eda_text.h:189
bool IsItalic() const
Definition: eda_text.h:186
#define _(s)
Definition: 3d_actions.cpp:33

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

Referenced by LIB_FIELD::GetMsgPanelInfo().

◆ GetTextThickness()

◆ GetTextWidth()

◆ GetVertJustify()

◆ HasFlag()

◆ HasLineStroke()

virtual bool SCH_ITEM::HasLineStroke ( ) const
inlinevirtualinherited

Check if this schematic item has line stoke properties.

See also
STROKE_PARAMS
Returns
true if this schematic item support line stroke properties. Otherwise, false.

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 484 of file sch_item.h.

484 { return false; }

Referenced by EE_SELECTION::AllItemsHaveLineStroke(), and SCH_EDIT_TOOL::Properties().

◆ HitTest() [1/2]

bool SCH_TEXT::HitTest ( const wxPoint &  aPosition,
int  aAccuracy = 0 
) const
overridevirtualinherited

Function HitTest tests if aPosition is contained within or on the bounding box of an item.

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
aAccuracyIncrease the item bounding box by this amount.
Returns
True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 567 of file sch_text.cpp.

568 {
569  EDA_RECT bBox = GetBoundingBox();
570  bBox.Inflate( aAccuracy );
571  return bBox.Contains( aPosition );
572 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
Definition: eda_rect.cpp:57
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_text.cpp:447
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

References EDA_RECT::Contains(), SCH_TEXT::GetBoundingBox(), and EDA_RECT::Inflate().

◆ HitTest() [2/2]

bool SCH_TEXT::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
overridevirtualinherited

Function HitTest tests if aRect intersects or is contained within the bounding box of an item.

Parameters
aRectA reference to a EDA_RECT object containing the rectangle to test.
aContainedSet to true to test for containment instead of an intersection.
aAccuracyIncrease aRect by this amount.
Returns
True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 575 of file sch_text.cpp.

576 {
577  EDA_RECT bBox = GetBoundingBox();
578  bBox.Inflate( aAccuracy );
579 
580  if( aContained )
581  return aRect.Contains( bBox );
582 
583  return aRect.Intersects( bBox );
584 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
Definition: eda_rect.cpp:57
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_text.cpp:447
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
Definition: eda_rect.cpp:150
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

References EDA_RECT::Contains(), SCH_TEXT::GetBoundingBox(), EDA_RECT::Inflate(), and EDA_RECT::Intersects().

◆ IncrementLabel()

void SCH_TEXT::IncrementLabel ( int  aIncrement)
inherited

Increment the label text, if it ends with a number.

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

Definition at line 152 of file sch_text.cpp.

153 {
154  wxString text = GetText();
155  IncrementLabelMember( text, aIncrement );
156  SetText(text );
157 }
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:121
void IncrementLabelMember(wxString &name, int aIncrement)
Definition: sch_text.cpp:54
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133

References EDA_TEXT::GetText(), IncrementLabelMember(), and EDA_TEXT::SetText().

Referenced by SCH_EDIT_TOOL::RepeatDrawItem().

◆ InitializeConnection()

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

Creates a new connection object associated with this object.

Parameters
aPathis the sheet path to initialize

Definition at line 176 of file sch_item.cpp.

178 {
179  SCH_CONNECTION* connection = Connection( &aSheet );
180 
181  if( connection )
182  {
183  connection->Reset();
184  }
185  else
186  {
187  connection = new SCH_CONNECTION( this );
188  m_connection_map.insert( std::make_pair( aSheet, connection ) );
189  connection->SetGraph( aGraph );
190  }
191 
192  connection->SetSheet( aSheet );
193  return connection;
194 }
void SetSheet(SCH_SHEET_PATH aSheet)
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:131
void Reset()
Clears connectivity information.
void SetGraph(CONNECTION_GRAPH *aGraph)
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Stores connectivity information, per sheet.
Definition: sch_item.h:209
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).

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

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ IsBold()

◆ IsBrightened()

◆ IsConnectable()

bool SCH_GLOBALLABEL::IsConnectable ( ) const
inlineoverridevirtual
Returns
true if the schematic item can connect to another schematic item.

Reimplemented from SCH_ITEM.

Definition at line 423 of file sch_text.h.

423 { return true; }

◆ IsConnected()

bool SCH_ITEM::IsConnected ( const wxPoint &  aPoint) const
inherited

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

Parameters
aPointA reference to a wxPoint object containing the coordinates to test.
Returns
True if connection to aPoint exists.

Definition at line 122 of file sch_item.cpp.

123 {
124  if(( m_flags & STRUCT_DELETED ) || ( m_flags & SKIP_STRUCT ) )
125  return false;
126 
127  return doIsConnected( aPosition );
128 }
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:115
virtual bool doIsConnected(const wxPoint &aPosition) const
Provide the object specific test to see if it is connected to aPosition.
Definition: sch_item.h:513
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: eda_item.h:117
STATUS_FLAGS m_flags
Definition: eda_item.h:164

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

Referenced by SCH_SCREEN::IsTerminalPoint().

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( )
inlineinherited

Definition at line 444 of file sch_item.h.

444 { return m_connectivity_dirty; }
bool m_connectivity_dirty
Definition: sch_item.h:211

References SCH_ITEM::m_connectivity_dirty.

◆ IsDangling()

bool SCH_TEXT::IsDangling ( ) const
inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 303 of file sch_text.h.

303 { return m_isDangling; }
bool m_isDangling
True if not connected to another object if the object derive from SCH_TEXT supports connections.
Definition: sch_text.h:172

References SCH_TEXT::m_isDangling.

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

◆ IsDefaultFormatting()

bool EDA_TEXT::IsDefaultFormatting ( ) const
inherited

Definition at line 506 of file eda_text.cpp.

507 {
508  return ( IsVisible()
509  && !IsMirrored()
512  && GetTextThickness() == 0
513  && !IsItalic()
514  && !IsBold()
515  && !IsMultilineAllowed()
516  );
517 }
bool IsBold() const
Definition: eda_text.h:189
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:206
bool IsMirrored() const
Definition: eda_text.h:195
bool IsVisible() const
Definition: eda_text.h:192
int GetTextThickness() const
Definition: eda_text.h:165
bool IsItalic() const
Definition: eda_text.h:186
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:205
bool IsMultilineAllowed() const
Definition: eda_text.h:203

References EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetVertJustify(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_CENTER, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsMultilineAllowed(), and EDA_TEXT::IsVisible().

Referenced by SCH_SEXPR_PLUGIN::saveField().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 189 of file eda_item.h.

189 { return m_flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:108
STATUS_FLAGS m_flags
Definition: eda_item.h:164

References IS_DRAGGED, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), and KIGFX::SCH_PAINTER::setDeviceColors().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 274 of file eda_item.h.

274 { return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:163

References EDA_ITEM::m_forceVisible.

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

◆ IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const
inlinevirtualinherited

Allows items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD.

Definition at line 278 of file sch_item.h.

278 { return false; }

◆ IsItalic()

bool EDA_TEXT::IsItalic ( ) const
inlineinherited

Definition at line 186 of file eda_text.h.

186 { return m_e.Bit( TE_ITALIC ); }
TEXT_EFFECTS m_e
Definition: eda_text.h:381
void Bit(int aBit, bool aValue)
Definition: eda_text.h:108

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_ITALIC.

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), export_vrml_fp_text(), export_vrml_pcbtext(), EDA_TEXT::Format(), SCH_TEXT::GetMsgPanelInfo(), EDA_TEXT::GetTextStyleName(), TEXT_MOD_GRID_TABLE::GetValueAsBool(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), EDA_TEXT::LenSize(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), LIB_TEXT::print(), LIB_FIELD::print(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), KIGFX::GAL::SetTextAttributes(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and UpdateIntersheetRefProps().

◆ IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const
inlinevirtualinherited
Returns
bool - true if the object is locked, else false

Definition at line 268 of file sch_item.h.

268 { return false; }

Referenced by SCH_EDIT_TOOL::DeleteItemCursor().

◆ IsMirrored()

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 186 of file eda_item.h.

186 { return m_flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: eda_item.h:102
STATUS_FLAGS m_flags
Definition: eda_item.h:164

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

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

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

Definition at line 247 of file sch_item.h.

247 { return true; }

Referenced by SCH_MOVE_TOOL::Main().

◆ IsMoving()

◆ IsMultilineAllowed()

◆ IsNew()

◆ IsPointClickableAnchor()

bool SCH_GLOBALLABEL::IsPointClickableAnchor ( const wxPoint &  aPos) const
inlineoverridevirtual
Returns
true if the given point can start drawing (usually means the anchor is unused/free/dangling)

Reimplemented from SCH_ITEM.

Definition at line 440 of file sch_text.h.

441  {
442  return m_isDangling && GetPosition() == aPos;
443  }
bool m_isDangling
True if not connected to another object if the object derive from SCH_TEXT supports connections.
Definition: sch_text.h:172
wxPoint GetPosition() const override
Definition: sch_text.h:312

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

◆ IsReplaceable()

virtual bool SCH_TEXT::IsReplaceable ( ) const
inlineoverridevirtualinherited

Function IsReplaceable.

Override this method in any derived object that supports test find and replace.

Returns
True if the item has replaceable text that can be modified using the find and replace dialog.

Reimplemented from EDA_ITEM.

Reimplemented in SCH_LABEL, and SCH_SHEET_PIN.

Definition at line 296 of file sch_text.h.

296 { return true; }

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 192 of file eda_item.h.

192 { return m_flags & IS_RESIZED; }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:107
STATUS_FLAGS m_flags
Definition: eda_item.h:164

References IS_RESIZED, and EDA_ITEM::m_flags.

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

◆ IsSelected()

◆ IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[]) const
inlinevirtualinherited

Function IsType Checks whether the item is one of the listed types.

Parameters
aScanTypesList of item types
Returns
true if the item type is contained in the list aScanTypes

Reimplemented in VIA, SCH_LABEL, DIMENSION_BASE, PAD, PCB_SHAPE, SCH_FIELD, SCH_LINE, FP_TEXT, FP_SHAPE, and PCB_TEXT.

Definition at line 250 of file eda_item.h.

251  {
252  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
253  return true;
254 
255  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
256  {
257  if( m_structType == *p )
258  return true;
259  }
260 
261  return false;
262  }
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
KICAD_T m_structType
Run time identification, keep private so it can never be changed after a ctor sets it.
Definition: eda_item.h:158

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), FP_TEXT::IsType(), SCH_LINE::IsType(), SCH_FIELD::IsType(), PCB_SHAPE::IsType(), PAD::IsType(), DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), SCH_BASE_FRAME::UpdateItem(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsVisible()

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 190 of file eda_item.h.

190 { return m_flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:110
STATUS_FLAGS m_flags
Definition: eda_item.h:164

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >
static SEARCH_RESULT EDA_ITEM::IterateForward ( std::deque< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
inlinestaticinherited

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

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

Definition at line 372 of file eda_item.h.

376  {
377  for( auto it : aList )
378  {
379  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
381  return SEARCH_RESULT::QUIT;
382  }
383 
385  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
Definition: eda_item.cpp:107

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >
static SEARCH_RESULT EDA_ITEM::IterateForward ( std::vector< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
inlinestaticinherited

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use std::vector instead

Definition at line 393 of file eda_item.h.

395  {
396  for( auto it : aList )
397  {
398  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
400  return SEARCH_RESULT::QUIT;
401  }
402 
404  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
Definition: eda_item.cpp:107

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

◆ LenSize()

int EDA_TEXT::LenSize ( const wxString &  aLine,
int  aThickness 
) const
inherited
Returns
the text length in internal units
Parameters
aLine: the line of text to consider. For single line text, this parameter is always m_Text
aThickness: the stroke width of the text

Definition at line 188 of file eda_text.cpp.

189 {
192  basic_gal.SetFontUnderlined( false );
193  basic_gal.SetLineWidth( (float) aThickness );
195 
196  VECTOR2D tsize = basic_gal.GetTextLineSize( aLine );
197 
198  return KiROUND( tsize.x );
199 }
bool IsBold() const
Definition: eda_text.h:189
VECTOR2D GetTextLineSize(const UTF8 &aText) const
Compute the X and Y size of a given text.
virtual void SetLineWidth(float aLineWidth)
Set the line width.
bool IsItalic() const
Definition: eda_text.h:186
void SetFontBold(const bool aBold)
Set bold property of current font.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
const wxSize & GetTextSize() const
Definition: eda_text.h:245
void SetFontItalic(bool aItalic)
Set italic property of current font.
void SetGlyphSize(const VECTOR2D aSize)
Set the font glyph size.
void SetFontUnderlined(bool aUnderlined)
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
BASIC_GAL basic_gal(basic_displayOptions)

References basic_gal, KIGFX::GAL::GetTextLineSize(), EDA_TEXT::GetTextSize(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), KiROUND(), KIGFX::GAL::SetFontBold(), KIGFX::GAL::SetFontItalic(), KIGFX::GAL::SetFontUnderlined(), KIGFX::GAL::SetGlyphSize(), KIGFX::GAL::SetLineWidth(), and VECTOR2< T >::x.

Referenced by CreateGraphicShape(), GetBoundingBox(), and SCH_HIERLABEL::GetBoundingBox().

◆ MapHorizJustify()

EDA_TEXT_HJUSTIFY_T EDA_TEXT::MapHorizJustify ( int  aHorizJustify)
staticinherited

Definition at line 63 of file eda_text.cpp.

64 {
65  wxASSERT( aHorizJustify >= GR_TEXT_HJUSTIFY_LEFT && aHorizJustify <= GR_TEXT_HJUSTIFY_RIGHT );
66 
67  if( aHorizJustify > GR_TEXT_HJUSTIFY_RIGHT )
69 
70  if( aHorizJustify < GR_TEXT_HJUSTIFY_LEFT )
71  return GR_TEXT_HJUSTIFY_LEFT;
72 
73  return (EDA_TEXT_HJUSTIFY_T) aHorizJustify;
74 }
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:61

References GR_TEXT_HJUSTIFY_LEFT, and GR_TEXT_HJUSTIFY_RIGHT.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and DIALOG_EDIT_ONE_FIELD::updateText().

◆ MapVertJustify()

EDA_TEXT_VJUSTIFY_T EDA_TEXT::MapVertJustify ( int  aVertJustify)
staticinherited

Definition at line 77 of file eda_text.cpp.

78 {
79  wxASSERT( aVertJustify >= GR_TEXT_VJUSTIFY_TOP && aVertJustify <= GR_TEXT_VJUSTIFY_BOTTOM );
80 
81  if( aVertJustify > GR_TEXT_VJUSTIFY_BOTTOM )
83 
84  if( aVertJustify < GR_TEXT_VJUSTIFY_TOP )
85  return GR_TEXT_VJUSTIFY_TOP;
86 
87  return (EDA_TEXT_VJUSTIFY_T) aVertJustify;
88 }
EDA_TEXT_VJUSTIFY_T
Definition: eda_text.h:68

References GR_TEXT_VJUSTIFY_BOTTOM, and GR_TEXT_VJUSTIFY_TOP.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and DIALOG_EDIT_ONE_FIELD::updateText().

◆ Matches() [1/2]

bool SCH_TEXT::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData 
)
inlineoverridevirtualinherited

Function Matches compares 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
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented from EDA_ITEM.

Definition at line 286 of file sch_text.h.

287  {
288  return SCH_ITEM::Matches( GetText(), aSearchData );
289  }
virtual bool Matches(wxFindReplaceData &aSearchData, void *aAuxData)
Function Matches compares the item against the search criteria in aSearchData.
Definition: eda_item.h:446
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133

References EDA_TEXT::GetText(), and EDA_ITEM::Matches().

◆ Matches() [2/2]

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

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters
aTextA reference to a wxString object containing the string to test.
aSearchDataThe criteria to search against.
Returns
True if aText matches the search criteria in aSearchData.

Definition at line 132 of file eda_item.cpp.

133 {
134  wxString text = aText;
135  wxString searchText = aSearchData.GetFindString();
136 
137  // Don't match if searching for replaceable item and the item doesn't support text replace.
138  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
139  return false;
140 
141  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
142  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
143 
144  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
145  {
146  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
147  return text.Matches( searchText );
148 
149  return text.MakeUpper().Matches( searchText.MakeUpper() );
150  }
151 
152  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
153  return aText.Find( searchText ) != wxNOT_FOUND;
154 
155  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
156 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: eda_item.h:490

References FR_MATCH_WILDCARD, FR_SEARCH_REPLACE, and EDA_ITEM::IsReplaceable().

◆ MirrorSpinStyle()

void SCH_GLOBALLABEL::MirrorSpinStyle ( bool  aLeftRight)
overridevirtual

Reimplemented from SCH_TEXT.

Definition at line 1016 of file sch_text.cpp.

1017 {
1018  SCH_TEXT::MirrorSpinStyle( aLeftRight );
1019 
1020  if( ( aLeftRight && m_intersheetRefsField.GetTextAngle() == TEXT_ANGLE_HORIZ )
1021  || ( !aLeftRight && m_intersheetRefsField.GetTextAngle() == TEXT_ANGLE_VERT ) )
1022  {
1025  else
1027  }
1028 
1029  wxPoint pos = m_intersheetRefsField.GetTextPos();
1030  wxPoint delta = GetPosition() - pos;
1031 
1032  if( aLeftRight )
1033  pos.x = GetPosition().x + delta.x;
1034  else
1035  pos.y = GetPosition().y + delta.y;
1036 
1038 }
#define TEXT_ANGLE_HORIZ
Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to...
Definition: eda_text.h:50
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
double GetTextAngle() const
Definition: eda_text.h:180
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:205
wxPoint GetPosition() const override
Definition: sch_text.h:312
SCH_FIELD m_intersheetRefsField
Definition: sch_text.h:457
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:208
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
virtual void MirrorSpinStyle(bool aLeftRight)
Definition: sch_text.cpp:223
#define TEXT_ANGLE_VERT
Definition: eda_text.h:51

References EDA_TEXT::GetHorizJustify(), SCH_TEXT::GetPosition(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, m_intersheetRefsField, SCH_TEXT::MirrorSpinStyle(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetTextPos(), TEXT_ANGLE_HORIZ, and TEXT_ANGLE_VERT.

◆ MirrorX()

void SCH_TEXT::MirrorX ( int  aXaxis_position)
overridevirtualinherited

Mirror item relative to the X axis about aXaxis_position.

Parameters
aXaxis_positionThe X axis position to mirror around.

Implements SCH_ITEM.

Definition at line 193 of file sch_text.cpp.

194 {
195  // Text is NOT really mirrored; it is moved to a suitable vertical position
197 
198  SetTextY( MIRRORVAL( GetTextPos().y, aXaxis_position ) );
199 }
void MirrorX(int aXaxis_position) override
Mirror item relative to the X axis about aXaxis_position.
Definition: sch_text.cpp:193
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:233
T MIRRORVAL(T aPoint, T aMirrorRef)
Returns the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:31
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
virtual void SetLabelSpinStyle(LABEL_SPIN_STYLE aSpinStyle)
Set a spin or rotation angle, along with specific horizontal and vertical justification styles with e...
Definition: sch_text.cpp:232
void SetTextY(int aY)
Definition: eda_text.h:257

References SCH_TEXT::GetLabelSpinStyle(), EDA_TEXT::GetTextPos(), MIRRORVAL(), SCH_TEXT::SetLabelSpinStyle(), and EDA_TEXT::SetTextY().

Referenced by SCH_TEXT::MirrorSpinStyle().

◆ MirrorY()

void SCH_TEXT::MirrorY ( int  aYaxis_position)
overridevirtualinherited

Mirror item relative to the Y axis about aYaxis_position.

Parameters
aYaxis_positionThe Y axis position to mirror around.

Implements SCH_ITEM.

Definition at line 184 of file sch_text.cpp.

185 {
186  // Text is NOT really mirrored; it is moved to a suitable horizontal position
188 
189  SetTextX( MIRRORVAL( GetTextPos().x, aYaxis_position ) );
190 }
void SetTextX(int aX)
Definition: eda_text.h:256
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:233
T MIRRORVAL(T aPoint, T aMirrorRef)
Returns the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:31
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
virtual void SetLabelSpinStyle(LABEL_SPIN_STYLE aSpinStyle)
Set a spin or rotation angle, along with specific horizontal and vertical justification styles with e...
Definition: sch_text.cpp:232
void MirrorY(int aYaxis_position) override
Mirror item relative to the Y axis about aYaxis_position.
Definition: sch_text.cpp:184

References SCH_TEXT::GetLabelSpinStyle(), EDA_TEXT::GetTextPos(), MIRRORVAL(), SCH_TEXT::SetLabelSpinStyle(), and EDA_TEXT::SetTextX().

Referenced by SCH_TEXT::MirrorSpinStyle().

◆ Move()

void SCH_GLOBALLABEL::Move ( const wxPoint &  aMoveVector)
inlineoverridevirtual

Move the item by aMoveVector to a new position.

Parameters
aMoveVector= the displacement vector

Reimplemented from SCH_TEXT.

Definition at line 445 of file sch_text.h.

446  {
447  SCH_TEXT::Move( aMoveVector );
448  m_intersheetRefsField.Move( aMoveVector );
449  }
void Move(const wxPoint &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_field.h:155
void Move(const wxPoint &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_text.h:274
SCH_FIELD m_intersheetRefsField
Definition: sch_text.h:457

References m_intersheetRefsField, SCH_FIELD::Move(), and SCH_TEXT::Move().

◆ NetClass()

NETCLASSPTR SCH_ITEM::NetClass ( const SCH_SHEET_PATH aSheet = nullptr) const
inherited

Definition at line 145 of file sch_item.cpp.

146 {
147  if( m_connection_map.size() )
148  {
149  SCH_CONNECTION* connection = Connection( aSheet );
150 
151  if( connection )
152  {
153  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
154  const wxString& netclassName = netSettings.GetNetclassName( connection->Name() );
155 
156  return netSettings.m_NetClasses.Find( netclassName );
157  }
158  }
159 
160  return nullptr;
161 }
NETCLASSPTR Find(const wxString &aName) const
Function Find searches this container for a NETCLASS given by aName.
Definition: netclass.cpp:132
const wxString & GetNetclassName(const wxString &aNetName) const
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
NET_SETTINGS & NetSettings()
Definition: project_file.h:92
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:131
NETCLASSES m_NetClasses
Definition: net_settings.h:39
wxString Name(bool aIgnoreSheet=false) const
VTBL_ENTRY PROJECT_FILE & GetProjectFile() const
Definition: project.h:143
NET_SETTINGS stores various net-related settings in a project context.
Definition: net_settings.h:31
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Stores connectivity information, per sheet.
Definition: sch_item.h:209
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
PROJECT & Prj() const
Return a reference to the project this schematic is part of.
Definition: schematic.h:85

References SCH_ITEM::Connection(), NETCLASSES::Find(), NET_SETTINGS::GetNetclassName(), PROJECT::GetProjectFile(), SCH_ITEM::m_connection_map, NET_SETTINGS::m_NetClasses, SCH_CONNECTION::Name(), PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

Referenced by SCH_LINE::GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_JUNCTION::GetJunctionColor(), SCH_LINE::GetLineColor(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), and SCH_BUS_ENTRY_BASE::GetStrokeStyle().

◆ Offset()

◆ operator<() [1/2]

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

Reimplemented from SCH_ITEM.

Definition at line 288 of file sch_text.cpp.

289 {
290  if( Type() != aItem.Type() )
291  return Type() < aItem.Type();
292 
293  auto other = static_cast<const SCH_TEXT*>( &aItem );
294 
295  if( GetLayer() != other->GetLayer() )
296  return GetLayer() < other->GetLayer();
297 
298  if( GetPosition().x != other->GetPosition().x )
299  return GetPosition().x < other->GetPosition().x;
300 
301  if( GetPosition().y != other->GetPosition().y )
302  return GetPosition().y < other->GetPosition().y;
303 
304  return GetText() < other->GetText();
305 }
wxPoint GetPosition() const override
Definition: sch_text.h:312
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:285
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

References SCH_ITEM::GetLayer(), SCH_TEXT::GetPosition(), EDA_TEXT::GetText(), and EDA_ITEM::Type().

◆ operator<() [2/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 185 of file eda_item.cpp.

186 {
187  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
188  GetClass() ) );
189 
190  return false;
191 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
virtual wxString GetClass() const =0
Function GetClass returns the class name.

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

◆ Plot()

void SCH_TEXT::Plot ( PLOTTER aPlotter)
overridevirtualinherited

Plot the schematic item to aPlotter.

Parameters
aPlotterA pointer to a PLOTTER object.

Reimplemented from SCH_ITEM.

Definition at line 587 of file sch_text.cpp.

588 {
589  static std::vector<wxPoint> Poly;
590  COLOR4D color = aPlotter->RenderSettings()->GetLayerColor( GetLayer() );
591  int penWidth = GetEffectiveTextPenWidth( aPlotter->RenderSettings()->GetDefaultPenWidth() );
592 
593  penWidth = std::max( penWidth, aPlotter->RenderSettings()->GetMinPenWidth() );
594  aPlotter->SetCurrentLineWidth( penWidth );
595 
596  if( IsMultilineAllowed() )
597  {
598  std::vector<wxPoint> positions;
599  wxArrayString strings_list;
600  wxStringSplit( GetShownText(), strings_list, '\n' );
601  positions.reserve( strings_list.Count() );
602 
603  GetLinePositions( positions, (int) strings_list.Count() );
604 
605  for( unsigned ii = 0; ii < strings_list.Count(); ii++ )
606  {
607  wxPoint textpos = positions[ii] + GetSchematicTextOffset( aPlotter->RenderSettings() );
608  wxString& txt = strings_list.Item( ii );
609  aPlotter->Text( textpos, color, txt, GetTextAngle(), GetTextSize(), GetHorizJustify(),
610  GetVertJustify(), penWidth, IsItalic(), IsBold() );
611  }
612  }
613  else
614  {
615  wxPoint textpos = GetTextPos() + GetSchematicTextOffset( aPlotter->RenderSettings() );
616 
617  aPlotter->Text( textpos, color, GetShownText(), GetTextAngle(), GetTextSize(),
618  GetHorizJustify(), GetVertJustify(), penWidth, IsItalic(), IsBold() );
619  }
620 
621  // Draw graphic symbol for global or hierarchical labels
622  CreateGraphicShape( aPlotter->RenderSettings(), Poly, GetTextPos() );
623 
624  if( Poly.size() )
625  aPlotter->PlotPoly( Poly, FILL_TYPE::NO_FILL, penWidth );
626 }
bool IsBold() const
Definition: eda_text.h:189
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:206
virtual wxPoint GetSchematicTextOffset(RENDER_SETTINGS *aSettings) const
Definition: sch_text.cpp:160
int color
Definition: DXF_plotter.cpp:60
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
double GetTextAngle() const
Definition: eda_text.h:180
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Draw a polygon ( filled or not )
int GetEffectiveTextPenWidth(int aDefaultWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth.
Definition: eda_text.cpp:157
virtual void Text(const wxPoint &aPos, const COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, bool aMultilineAllowed=false, void *aData=NULL)
Draws text with the plotter.
Definition: gr_text.cpp:219
bool IsItalic() const
Definition: eda_text.h:186
virtual void CreateGraphicShape(RENDER_SETTINGS *aSettings, std::vector< wxPoint > &aPoints, const wxPoint &Pos)
Calculate the graphic shape (a polygon) associated to the text.
Definition: sch_text.h:256
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:205
const wxSize & GetTextSize() const
Definition: eda_text.h:245
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_text.cpp:492
bool IsMultilineAllowed() const
Definition: eda_text.h:203
void wxStringSplit(const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
Split aString to a string list separated at aSplitter.
Definition: string.cpp:796
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:285
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:165
void GetLinePositions(std::vector< wxPoint > &aPositions, int aLineCount) const
Populate aPositions with the position of each line of a multiline text, according to the vertical jus...
Definition: eda_text.cpp:424
int GetDefaultPenWidth() const
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100

References color, SCH_TEXT::CreateGraphicShape(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetHorizJustify(), SCH_ITEM::GetLayer(), KIGFX::RENDER_SETTINGS::GetLayerColor(), EDA_TEXT::GetLinePositions(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), SCH_TEXT::GetSchematicTextOffset(), SCH_TEXT::GetShownText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetVertJustify(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMultilineAllowed(), NO_FILL, PLOTTER::PlotPoly(), PLOTTER::RenderSettings(), PLOTTER::SetCurrentLineWidth(), PLOTTER::Text(), and wxStringSplit().

◆ Print() [1/2]

void EDA_TEXT::Print ( RENDER_SETTINGS aSettings,
const wxPoint &  aOffset,
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 401 of file eda_text.cpp.

403 {
404  if( IsMultilineAllowed() )
405  {
406  std::vector<wxPoint> positions;
407  wxArrayString strings;
408  wxStringSplit( GetShownText(), strings, '\n' );
409 
410  positions.reserve( strings.Count() );
411 
412  GetLinePositions( positions, strings.Count() );
413 
414  for( unsigned ii = 0; ii < strings.Count(); ii++ )
415  printOneLineOfText( aSettings, aOffset, aColor, aFillMode, strings[ii], positions[ii] );
416  }
417  else
418  {
419  printOneLineOfText( aSettings, aOffset, aColor, aFillMode, GetShownText(), GetTextPos() );
420  }
421 }
void printOneLineOfText(RENDER_SETTINGS *aSettings, const wxPoint &aOffset, COLOR4D aColor, OUTLINE_MODE aFillMode, const wxString &aText, const wxPoint &aPos)
Print each line of this EDA_TEXT.
Definition: eda_text.cpp:465
bool IsMultilineAllowed() const
Definition: eda_text.h:203
void wxStringSplit(const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
Split aString to a string list separated at aSplitter.
Definition: string.cpp:796
void GetLinePositions(std::vector< wxPoint > &aPositions, int aLineCount) const
Populate aPositions with the position of each line of a multiline text, according to the vertical jus...
Definition: eda_text.cpp:424
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
virtual wxString GetShownText(int aDepth=0) const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:140

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

Referenced by SCH_TEXT::Print(), Print(), SCH_HIERLABEL::Print(), and WS_DRAW_ITEM_TEXT::PrintWsItem().

◆ Print() [2/2]

void SCH_GLOBALLABEL::Print ( RENDER_SETTINGS aSettings,
const wxPoint &  aOffset 
)
overridevirtual

Print a schematic item.

Each schematic item should have its own method

Parameters
aOffsetdrawing offset (usually {0,0} but can be different when moving an object)

Reimplemented from SCH_TEXT.

Definition at line 1137 of file sch_text.cpp.

1138 {
1139  static std::vector <wxPoint> Poly;
1140 
1141  wxDC* DC = aSettings->GetPrintDC();
1142  COLOR4D color = aSettings->GetLayerColor( m_layer );
1143  int penWidth = std::max( GetPenWidth(), aSettings->GetDefaultPenWidth() );
1144  wxPoint text_offset = aOffset + GetSchematicTextOffset( aSettings );
1145 
1146  EDA_TEXT::Print( aSettings, text_offset, color );
1147 
1148  CreateGraphicShape( aSettings, Poly, GetTextPos() + aOffset );
1149  GRPoly( nullptr, DC, Poly.size(), &Poly[0], false, penWidth, color, color );
1150 }
void GRPoly(EDA_RECT *ClipBox, wxDC *DC, int n, const wxPoint *Points, bool Fill, int width, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:540
int color
Definition: DXF_plotter.cpp:60
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
int GetPenWidth() const override
Definition: sch_text.cpp:325
SCH_LAYER_ID m_layer
Definition: sch_item.h:199
void Print(RENDER_SETTINGS *aSettings, const wxPoint &aOffset, COLOR4D aColor, OUTLINE_MODE aDisplay_mode=FILLED)
Print this text object to the device context aDC.
Definition: eda_text.cpp:401
void CreateGraphicShape(RENDER_SETTINGS *aRenderSettings, std::vector< wxPoint > &aPoints, const wxPoint &aPos) override
Calculate the graphic shape (a polygon) associated to the text.
Definition: sch_text.cpp:1153
int GetDefaultPenWidth() const
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
wxPoint GetSchematicTextOffset(RENDER_SETTINGS *aSettings) const override
Definition: sch_text.cpp:894
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100

References color, CreateGraphicShape(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIGFX::RENDER_SETTINGS::GetLayerColor(), SCH_TEXT::GetPenWidth(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GetSchematicTextOffset(), EDA_TEXT::GetTextPos(), GRPoly(), SCH_ITEM::m_layer, and EDA_TEXT::Print().

◆ Replace() [1/3]

bool EDA_TEXT::Replace ( wxFindReplaceData &  aSearchData)
inherited

Helper function used in search and replace dialog.

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

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
Returns
True if the text item was modified, otherwise false.

Definition at line 178 of file eda_text.cpp.

179 {
180  bool retval = EDA_ITEM::Replace( aSearchData, m_text );
182  m_shown_text_has_text_var_refs = m_shown_text.Contains( wxT( "${" ) );
183 
184  return retval;
185 }
static bool Replace(wxFindReplaceData &aSearchData, wxString &aText)
Helper function used in search and replace dialog Function Replace performs a text replace on aText u...
Definition: eda_item.cpp:159
wxString m_shown_text
Definition: eda_text.h:378
bool m_shown_text_has_text_var_refs
Definition: eda_text.h:379
wxString m_text
Definition: eda_text.h:377
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:152

References EDA_TEXT::m_shown_text, EDA_TEXT::m_shown_text_has_text_var_refs, EDA_TEXT::m_text, EDA_ITEM::Replace(), and UnescapeString().

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

◆ Replace() [2/3]

bool SCH_TEXT::Replace ( wxFindReplaceData &  aSearchData,
void *  aAuxData 
)
inlineoverridevirtualinherited

Function Replace performs 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
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item text was modified, otherwise false.

Reimplemented from EDA_ITEM.

Definition at line 291 of file sch_text.h.

292  {
293  return EDA_TEXT::Replace( aSearchData );
294  }
bool Replace(wxFindReplaceData &aSearchData)
Helper function used in search and replace dialog.
Definition: eda_text.cpp:178

References EDA_TEXT::Replace().

◆ Replace() [3/3]

bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
wxString &  aText 
)
staticinherited

Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aTextA reference to a wxString object containing the text to be replaced.
Returns
True if aText was modified, otherwise false.

Definition at line 159 of file eda_item.cpp.

160 {
161  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
162 
163  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
164  aSearchData.GetFindString() :
165  aSearchData.GetFindString().Upper() );
166 
167  if( result == wxNOT_FOUND )
168  return false;
169 
170  wxString prefix = aText.Left( result );
171  wxString suffix;
172 
173  if( aSearchData.GetFindString().length() + result < aText.length() )
174  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
175 
176  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
177  aText, prefix, aSearchData.GetReplaceString(), suffix );
178 
179  aText = prefix + aSearchData.GetReplaceString() + suffix;
180 
181  return true;
182 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.

References traceFindReplace.

Referenced by SCH_FIELD::Replace(), EDA_TEXT::Replace(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

◆ ResolveTextVar()

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

Definition at line 1096 of file sch_text.cpp.

1097 {
1098  if( token->IsSameAs( wxT( "INTERSHEET_REFS" ) ) && Schematic() )
1099  {
1100  auto it = Schematic()->GetPageRefsMap().find( GetText() );
1101 
1102  if( it != Schematic()->GetPageRefsMap().end() )
1103  {
1104  SCHEMATIC_SETTINGS& settings = Schematic()->Settings();
1105  std::vector<wxString> pageListCopy;
1106 
1107  pageListCopy.insert( pageListCopy.end(), it->second.begin(), it->second.end() );
1108  std::sort( pageListCopy.begin(), pageListCopy.end() );
1109 
1110  token->Printf( "%s", settings.m_IntersheetRefsPrefix );
1111 
1112  if( ( settings.m_IntersheetRefsFormatShort ) && ( pageListCopy.size() > 2 ) )
1113  {
1114  token->Append( wxString::Format( wxT( "%s..%s" ),
1115  pageListCopy.front(),
1116  pageListCopy.back() ) );
1117  }
1118  else
1119  {
1120  for( const wxString& pageNo : pageListCopy )
1121  token->Append( wxString::Format( wxT( "%s," ), pageNo ) );
1122 
1123  if( token->Last() == ',' )
1124  token->RemoveLast();
1125  }
1126 
1127  token->Append( settings.m_IntersheetRefsSuffix );
1128  }
1129 
1130  return true;
1131  }
1132 
1133  return false;
1134 }
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:125
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
These settings were stored in SCH_BASE_FRAME previously.
std::map< wxString, std::set< wxString > > & GetPageRefsMap()
Definition: schematic.h:168
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133

References Format(), SCHEMATIC::GetPageRefsMap(), EDA_TEXT::GetText(), SCHEMATIC_SETTINGS::m_IntersheetRefsFormatShort, SCHEMATIC_SETTINGS::m_IntersheetRefsPrefix, SCHEMATIC_SETTINGS::m_IntersheetRefsSuffix, SCH_ITEM::Schematic(), and SCHEMATIC::Settings().

Referenced by SCH_FIELD::GetShownText().

◆ Rotate()

void SCH_GLOBALLABEL::Rotate ( wxPoint  aPosition)
overridevirtual

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

Parameters
aPositionA reference to a wxPoint object containing the coordinates to rotate around.

Reimplemented from SCH_TEXT.

Definition at line 960 of file sch_text.cpp.

961 {
962  wxPoint pt = GetTextPos();
963  RotatePoint( &pt, aPosition, 900 );
964  wxPoint offset = pt - GetTextPos();
965 
966  Rotate90( false );
967 
968  SetTextPos( GetTextPos() + offset );
970 }
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
SCH_FIELD m_intersheetRefsField
Definition: sch_text.h:457
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
void Rotate90(bool aClockwise) override
Definition: sch_text.cpp:973

References EDA_TEXT::GetTextPos(), m_intersheetRefsField, Rotate90(), RotatePoint(), and EDA_TEXT::SetTextPos().

◆ Rotate90()

void SCH_GLOBALLABEL::Rotate90 ( bool  aClockwise)
overridevirtual

Reimplemented from SCH_TEXT.

Definition at line 973 of file sch_text.cpp.

974 {
975  SCH_TEXT::Rotate90( aClockwise );
976 
979  {
980  if( !aClockwise )
982 
984  }
987  {
988  if( !aClockwise )
990 
992  }
995  {
996  if( aClockwise )
998 
1000  }
1003  {
1004  if( aClockwise )
1006 
1008  }
1009 
1010  wxPoint pos = m_intersheetRefsField.GetTextPos();
1011  RotatePoint( &pos, GetPosition(), aClockwise ? -900 : 900 );
1013 }
#define TEXT_ANGLE_HORIZ
Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to...
Definition: eda_text.h:50
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
double GetTextAngle() const
Definition: eda_text.h:180
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:205
wxPoint GetPosition() const override
Definition: sch_text.h:312
virtual void Rotate90(bool aClockwise)
Definition: sch_text.cpp:214
SCH_FIELD m_intersheetRefsField
Definition: sch_text.h:457
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:208
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
#define TEXT_ANGLE_VERT
Definition: eda_text.h:51
virtual void SetTextAngle(double aAngle)
Definition: eda_text.h:173

References EDA_TEXT::GetHorizJustify(), SCH_TEXT::GetPosition(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, m_intersheetRefsField, SCH_TEXT::Rotate90(), RotatePoint(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), TEXT_ANGLE_HORIZ, and TEXT_ANGLE_VERT.

Referenced by Rotate().

◆ RunOnChildren()

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

Reimplemented from SCH_ITEM.

Definition at line 888 of file sch_text.cpp.

889 {
890  aFunction( &m_intersheetRefsField );
891 }
SCH_FIELD m_intersheetRefsField
Definition: sch_text.h:457

References m_intersheetRefsField.

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const
inherited

Searches the item hierarchy to find a SCHEMATIC.

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

Every SCH_SCREEN should be parented to the SCHEMATIC. Note that this hierarchy is not the same as the sheet hierarchy!

Returns
the parent schematic this item lives on, or nullptr

Definition at line 97 of file sch_item.cpp.

98 {
99  EDA_ITEM* parent = GetParent();
100 
101  while( parent )
102  {
103  if( parent->Type() == SCHEMATIC_T )
104  return static_cast<SCHEMATIC*>( parent );
105  else
106  parent = parent->GetParent();
107  }
108 
109  return nullptr;
110 }
EDA_ITEM * GetParent() const
Definition: eda_item.h:183
EDA_ITEM is a base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:148
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

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

Referenced by SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_FIELD::DoHypertextMenu(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::getEffectiveShape(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_NO_CONNECT::GetPenWidth(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_COMPONENT::GetPins(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetTextOffset(), inheritNetclass(), SCH_SHEET::IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), SCH_HIERLABEL::Print(), SCH_COMPONENT::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), ResolveTextVar(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and SCH_MARKER::ViewGetLayers().

◆ Set() [1/3]

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

Definition at line 40 of file inspectable.h.

41  {
43  TYPE_ID thisType = TYPE_HASH( *this );
44  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
45 
46  if( object )
47  aProperty->setter( object, aValue );
48 
49  return object != nullptr;
50  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
virtual void setter(void *aObject, wxAny &aValue)=0
Provides class metadata.
Definition: property_mgr.h:61
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

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

◆ Set() [2/3]

template<typename T >
bool INSPECTABLE::Set ( PROPERTY_BASE aProperty,
aValue 
)
inlineinherited

Definition at line 53 of file inspectable.h.

54  {
56  TYPE_ID thisType = TYPE_HASH( *this );
57  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
58 
59  if( object )
60  aProperty->set<T>( object, aValue );
61 
62  return object != nullptr;
63  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
Provides class metadata.
Definition: property_mgr.h:61
void set(void *aObject, T aValue)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

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

◆ Set() [3/3]

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

Definition at line 66 of file inspectable.h.

67  {
69  TYPE_ID thisType = TYPE_HASH( *this );
70  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
71  void* object = nullptr;
72 
73  if( prop )
74  {
75  object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
76 
77  if( object )
78  prop->set<T>( object, aValue );
79  }
80 
81  return object != nullptr;
82  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Returns a property for a specific type.
Provides class metadata.
Definition: property_mgr.h:61
void set(void *aObject, T aValue)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

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

◆ SetBold()

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

◆ SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool  aDirty = true)
inlineinherited

Definition at line 446 of file sch_item.h.

446 { m_connectivity_dirty = aDirty; }
bool m_connectivity_dirty
Definition: sch_item.h:211

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetEffects()

void EDA_TEXT::SetEffects ( const EDA_TEXT aSrc)
inherited

Set the text effects from another instance.

TEXT_EFFECTS is not exposed in the public API, but includes everything except the actual text string itself.

Definition at line 137 of file eda_text.cpp.

138 {
139  m_e = aSrc.m_e;
140 }
TEXT_EFFECTS m_e
Definition: eda_text.h:381

References EDA_TEXT::m_e.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::ImportValues(), LIB_FIELD::operator=(), DIALOG_CHANGE_SYMBOLS::processSymbol(), CLIPBOARD_IO::SaveSelection(), and FP_TEXT::SetEffects().

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 220 of file eda_item.h.

220 { m_flags |= aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:164

References EDA_ITEM::m_flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), SCH_MOVE_TOOL::AlignElements(), PCBNEW_CONTROL::AppendBoard(), FOOTPRINT::BuildPolyCourtyards(), SCH_EDIT_TOOL::ChangeTextType(), TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupSegments(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), LIB_PIN_TOOL::CreatePin(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), KIGFX::SCH_PAINTER::draw(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), SCH_MOVE_TOOL::getConnectedDragItems(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), TRACKS_CLEANER::mergeCollinearSegments(), LIB_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), EE_SELECTION_TOOL::narrowSelection(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseJunction(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParseNoERC(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_ALTIUM_PLUGIN::ParseWire(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), DRC_TEST_PROVIDER_HOLE_CLEARANCE::Run(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

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

Parameters
aEnableTrue 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 272 of file eda_item.h.

272 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: eda_item.h:163

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetHorizJustify()

void EDA_TEXT::SetHorizJustify ( EDA_TEXT_HJUSTIFY_T  aType)
inlineinherited

Definition at line 208 of file eda_text.h.

208 { m_e.hjustify = aType; };
TEXT_EFFECTS m_e
Definition: eda_text.h:381
signed char hjustify
horizontal justification
Definition: eda_text.h:101

References TEXT_EFFECTS::hjustify, and EDA_TEXT::m_e.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), AutoplaceFields(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXT::Flip(), ALTIUM_PCB::HelperParseDimensions6Leader(), AUTOPLACER::justify_field(), 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_CACHE::loadText(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseFileName(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_ALTIUM_PLUGIN::ParseSheetName(), ALTIUM_PCB::ParseTexts6Data(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), LIB_TEXT::Rotate(), Rotate90(), SetEdaTextJustification(), SCH_TEXT::SetLabelSpinStyle(), SetLabelSpinStyle(), SCH_HIERLABEL::SetLabelSpinStyle(), PCAD2KICAD::SetTextJustify(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and DIALOG_EDIT_ONE_FIELD::updateText().

◆ SetIntersheetRefs()

void SCH_GLOBALLABEL::SetIntersheetRefs ( const SCH_FIELD aField)
inline

Definition at line 438 of file sch_text.h.

438 { m_intersheetRefsField = aField; }
SCH_FIELD m_intersheetRefsField
Definition: sch_text.h:457

References m_intersheetRefsField.

Referenced by SCH_SEXPR_PARSER::parseSchText().

◆ SetIsDangling()

void SCH_TEXT::SetIsDangling ( bool  aIsDangling)
inlineinherited

Definition at line 304 of file sch_text.h.

304 { m_isDangling = aIsDangling; }
bool m_isDangling
True if not connected to another object if the object derive from SCH_TEXT supports connections.
Definition: sch_text.h:172

References SCH_TEXT::m_isDangling.

Referenced by SCH_EDIT_TOOL::ChangeTextType().

◆ SetItalic()

◆ SetLabelSpinStyle()

void SCH_GLOBALLABEL::SetLabelSpinStyle ( LABEL_SPIN_STYLE  aSpinStyle)
overridevirtual

Set a spin or rotation angle, along with specific horizontal and vertical justification styles with each angle.

Parameters
aSpinStyleSpin style as per LABEL_SPIN_STYLE storage class, may be the enum values or int value

Reimplemented from SCH_TEXT.

Definition at line 926 of file sch_text.cpp.

927 {
928  m_spin_style = aSpinStyle;
929 
930  switch( aSpinStyle )
931  {
932  default:
933  wxASSERT_MSG( 1, "Bad spin style" );
936 
937  case LABEL_SPIN_STYLE::RIGHT: // Horiz Normal Orientation
940  break;
941 
942  case LABEL_SPIN_STYLE::UP: // Vert Orientation UP
945  break;
946 
947  case LABEL_SPIN_STYLE::LEFT: // Horiz Orientation
950  break;
951 
952  case LABEL_SPIN_STYLE::BOTTOM: // Vert Orientation BOTTOM
955  break;
956  }
957 }
#define TEXT_ANGLE_HORIZ
Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to...
Definition: eda_text.h:50
LABEL_SPIN_STYLE m_spin_style
The orientation of text and any associated drawing elements of derived objects.
Definition: sch_text.h:185
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition: macros.h:83
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:208
#define TEXT_ANGLE_VERT
Definition: eda_text.h:51
virtual void SetTextAngle(double aAngle)
Definition: eda_text.h:173

References LABEL_SPIN_STYLE::BOTTOM, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, KI_FALLTHROUGH, LABEL_SPIN_STYLE::LEFT, SCH_TEXT::m_spin_style, LABEL_SPIN_STYLE::RIGHT, EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetTextAngle(), TEXT_ANGLE_HORIZ, TEXT_ANGLE_VERT, and LABEL_SPIN_STYLE::UP.

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances().

◆ SetLayer()

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

Set the 'lock' status to aLocked for of this item.

Definition at line 273 of file sch_item.h.

273 {}

◆ SetMirrored()

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

Definition at line 79 of file eda_item.cpp.

80 {
82 
83  // If this a child object, then the parent modification state also needs to be set.
84  if( m_parent )
86 }
void SetModified()
Definition: eda_item.cpp:79
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:162
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: eda_item.h:102
void SetFlags(STATUS_FLAGS aMask)
Definition: eda_item.h:220

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

Referenced by LIB_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_COMPONENT::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_ALTIUM_PLUGIN::Parse(), ALTIUM_PCB::Parse(), LIB_PART::RemoveDrawItem(), SCH_COMPONENT::SetConvert(), SCH_COMPONENT::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_COMPONENT::SetTransform(), and SCH_COMPONENT::SetUnit().

◆ SetMultilineAllowed()

void EDA_TEXT::SetMultilineAllowed ( bool  aAllow)
inlineinherited
Parameters
aAllowtrue 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 202 of file eda_text.h.

202 { m_e.Bit( TE_MULTILINE, aAllow ); }
TEXT_EFFECTS m_e
Definition: eda_text.h:381
void Bit(int aBit, bool aValue)
Definition: eda_text.h:108

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_MULTILINE.

Referenced by PCB_TEXT::PCB_TEXT(), SCH_HIERLABEL::SCH_HIERLABEL(), SCH_LABEL::SCH_LABEL(), SCH_TEXT::SCH_TEXT(), and WS_DATA_ITEM_TEXT::SyncDrawItems().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Reimplemented in DIMENSION_BASE.

Definition at line 184 of file eda_item.h.

184 { m_parent = aParent; }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:162

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), SCH_SHEET::AddPin(), LIB_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_PART::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), LIB_PART::LIB_PART(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), SYMBOL_EDIT_FRAME::LoadOneSymbol(), FOOTPRINT::operator=(), LIB_PART::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), LIB_EDIT_TOOL::Paste(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), SCH_DRAWING_TOOLS::PlaceComponent(), PCB_EDITOR_CONTROL::PlaceModule(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

◆ SetPosition()

◆ SetSelected()

◆ SetShape()

◆ SetState()

void EDA_ITEM::SetState ( int  type,
int  state 
)
inlineinherited

Definition at line 209 of file eda_item.h.

210  {
211  if( state )
212  m_status |= type; // state = ON or OFF
213  else
214  m_status &= ~type;
215  }
STATUS_FLAGS m_status
Definition: eda_item.h:161

References EDA_ITEM::m_status.

Referenced by LEGACY_PLUGIN::loadTrackList(), TRACKS_CLEANER::mergeCollinearSegments(), SELECTION_TOOL::selectConnectedTracks(), and TRACK::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 218 of file eda_item.h.

218 { m_status = aStatus; }
STATUS_FLAGS m_status
Definition: eda_item.h:161

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( wxPoint  aPos)
inlineinherited

Definition at line 250 of file sch_item.h.

250 { m_storedPos = aPos; }
wxPoint m_storedPos
Definition: sch_item.h:202

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::Main(), and SCH_MOVE_TOOL::moveItem().

◆ SetStroke()

virtual void SCH_ITEM::SetStroke ( const STROKE_PARAMS aStroke)
inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 488 of file sch_item.h.

488 { wxCHECK( false, /* void */ ); }

◆ SetText()

void EDA_TEXT::SetText ( const wxString &  aText)
virtualinherited

Definition at line 121 of file eda_text.cpp.

122 {
123  m_text = aText;
124  m_shown_text = UnescapeString( aText );
125  m_shown_text_has_text_var_refs = m_shown_text.Contains( wxT( "${" ) );
126 }
wxString m_shown_text
Definition: eda_text.h:378
bool m_shown_text_has_text_var_refs
Definition: eda_text.h:379
wxString m_text
Definition: eda_text.h:377
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:152

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), LIB_TEXT::Clone(), createBoard(), PCB_BASE_FRAME::CreateNewFootprint(), SYMBOL_EDIT_FRAME::CreateNewPart(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), dummy(), KIGFX::dummy(), SCH_EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), ALTIUM_PCB::HelperParseDimensions6Leader(), LIB_FIELD::HitTest(), SCH_EDIT_FRAME::importFile(), SCH_TEXT::IncrementLabel(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), SCH_LEGACY_PLUGIN_CACHE::loadField(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), SCH_EAGLE_PLUGIN::loadLibrary(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_LEGACY_PLUGIN_CACHE::LoadPart(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EAGLE_PLUGIN::loadSheet(), SCH_LEGACY_PLUGIN::loadSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), SCH_LEGACY_PLUGIN_CACHE::loadText(), TUNER_SLIDER::onSave(), DIALOG_SHEET_PROPERTIES::OnUpdateUI(), LIB_FIELD::operator=(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_ALTIUM_PLUGIN::ParseFileName(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_ALTIUM_PLUGIN::ParseSheetEntry(), SCH_ALTIUM_PLUGIN::ParseSheetName(), ALTIUM_PCB::ParseTexts6Data(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), LIB_PART::PlotLibFields(), DIALOG_CHANGE_SYMBOLS::processSymbol(), processTextItem(), SCH_SEXPR_PLUGIN_CACHE::saveDcmInfoAsFields(), CLIPBOARD_IO::SaveSelection(), LIB_PART::SetName(), SCH_COMPONENT::SetRef(), TEXT_MOD_GRID_TABLE::SetValue(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_SPICE_MODEL::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_LIB_EDIT_ONE_FIELD::UpdateField(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), SCH_COMPONENT::UpdateFields(), SCH_SHEET_LIST::UpdateSymbolInstances(), and DIMENSION_BASE::updateText().

◆ SetTextAngle()

virtual void EDA_TEXT::SetTextAngle ( double  aAngle)
inlinevirtualinherited

Reimplemented in WS_DRAW_ITEM_TEXT, FP_TEXT, and PCB_TEXT.

Definition at line 173 of file eda_text.h.

174  {
175  // Higher level classes may be more restrictive than this by overloading
176  // SetTextAngle() or merely calling EDA_TEXT::SetTextAngle() after clamping
177  // aAngle before calling this lowest inline accessor.
178  m_e.angle = aAngle;
179  }
TEXT_EFFECTS m_e
Definition: eda_text.h:381
double angle
now: 0.1 degrees; future: degrees
Definition: eda_text.h:105