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

Public Member Functions

 SCH_GLOBALLABEL (const wxPoint &pos=wxPoint(0, 0), const wxString &text=wxEmptyString)
 
 ~SCH_GLOBALLABEL ()
 
void Print (wxDC *DC, const wxPoint &offset) override
 Function Print Print a schematic item. More...
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
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 () const override
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
void CreateGraphicShape (std::vector< wxPoint > &aPoints, const wxPoint &aPos) override
 Calculate the graphic shape (a polygon) associated to the text. More...
 
bool IsConnectable () const override
 Function IsConnectable returns true if the schematic item can connect to another schematic item. More...
 
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...
 
EDA_ITEMClone () const override
 Function Clone creates a duplicate of this item with linked list members set to NULL. 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 (wxDC *aDC, const wxPoint &aOffset, COLOR4D aColor, EDA_DRAW_MODE_T aDisplay_mode=FILLED)
 Print this text object to the device context aDC. More...
 
void SwapData (SCH_ITEM *aItem) override
 Function SwapData swap the internal data structures aItem with the schematic item. More...
 
int GetPenSize () const override
 Function GetPenSize virtual pure. More...
 
void Move (const wxPoint &aMoveVector) override
 Function Move moves the item by aMoveVector to a new position. More...
 
void MirrorY (int aYaxis_position) override
 Function MirrorY mirrors item relative to the Y axis about aYaxis_position. More...
 
void MirrorX (int aXaxis_position) override
 Function MirrorX mirrors item relative to the X axis about aXaxis_position. More...
 
void Rotate (wxPoint aPosition) override
 Function Rotate rotates the item around aPosition 90 degrees in the clockwise direction. 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
 Function GetEndPoints adds the schematic item end points to aItemList if the item has end points. More...
 
bool UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemList) override
 Function IsDanglingStateChanged tests the schematic item to aItemList to check if it's dangling state has changed. More...
 
bool IsDangling () const override
 
void SetIsDangling (bool aIsDangling)
 
void GetConnectionPoints (std::vector< wxPoint > &aPoints) const override
 Function GetConnectionPoints add all the connection points for this item to aPoints. More...
 
bool CanIncrementLabel () const override
 
void GetNetListItem (NETLIST_OBJECT_LIST &aNetListItems, SCH_SHEET_PATH *aSheetPath) override
 Function GetNetListItem creates a new NETLIST_OBJECT for the schematic object and adds it to aNetListItems. More...
 
wxPoint GetPosition () const override
 Function GetPosition. More...
 
void SetPosition (const wxPoint &aPosition) override
 Function SetPosition set the schematic item position to aPosition. More...
 
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
 Function Plot plots the schematic item to aPlotter. More...
 
void GetMsgPanelInfo (EDA_UNITS aUnits, 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)
 Routine to create a new copy of given item. More...
 
virtual bool IsMovableFromAnchorPoint ()
 Virtual function IsMovableFromAnchorPoint. More...
 
wxPointGetStoredPos ()
 
void SetStoredPos (wxPoint aPos)
 
virtual bool IsLocked () const
 Function IsLocked. More...
 
virtual void SetLocked (bool aLocked)
 Function SetLocked modifies 'lock' status for of the item. More...
 
SCH_LAYER_ID GetLayer () const
 Function GetLayer returns the layer this item is on. More...
 
void SetLayer (SCH_LAYER_ID aLayer)
 Function SetLayer sets the layer this item is on. More...
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers returns the layers the item is drawn on (which may be more than its "home" layer) More...
 
virtual bool Load (LINE_READER &aLine, wxString &aErrorMsg)
 Function Load reads a schematic item from aLine in a .sch file. More...
 
void ClearConnections ()
 Function ClearConnections clears all of the connection items from the list. More...
 
bool IsConnected (const wxPoint &aPoint) const
 Function IsConnected tests the item to see if it is connected to aPoint. More...
 
SCH_CONNECTIONConnection (const SCH_SHEET_PATH &aPath) const
 Retrieves the connection associated with this object in the given sheet Note: the returned value can be nullptr. More...
 
std::unordered_set< SCH_ITEM * > & ConnectedItems ()
 Retrieves the set of items connected to this item (schematic only) More...
 
void AddConnectionTo (SCH_ITEM *aItem)
 Adds a connection link between this item and another. More...
 
SCH_CONNECTIONInitializeConnection (const SCH_SHEET_PATH &aPath)
 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)
 
virtual bool operator< (const SCH_ITEM &aItem) const
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (timestamp_t aNewTimeStamp)
 
timestamp_t GetTimeStamp () const
 
EDA_ITEMGetParent () const
 
void SetParent (EDA_ITEM *aParent)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
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...
 
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 its member data. 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 unsigned int 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 ()
 
virtual const wxString & GetText () const
 Return the string associated with the text object. More...
 
virtual wxString GetShownText () const
 Return the string actually shown after processing of the base text. More...
 
wxString ShortenedShownText () const
 Returns a shortened version (max 15 characters) of the shown text. More...
 
virtual void SetText (const wxString &aText)
 
void SetThickness (int aNewThickness)
 Set the pen width. More...
 
int GetThickness () const
 Return the pen width. More...
 
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 wxPointGetTextPos () const
 
void SetTextX (int aX)
 
void SetTextY (int aY)
 
void Offset (const wxPoint &aOffset)
 
void Empty ()
 
void TransformTextShapeToSegmentList (std::vector< wxPoint > &aCornerBuffer) 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...
 
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, int aMarkupFlags) const
 
EDA_RECT GetTextBox (int aLine=-1, int aThickness=-1, bool aInvertY=false, int aMarkupFlags=0) 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 ()
 
void GetPositionsOfLinesOfMultilineText (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...
 

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

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
 List of items connected to this item. More...
 
wxPoint m_storedPos
 a temporary variable used in some move commands

to store a initial pos (of the item or mouse cursor)

More...
 
std::unordered_set< SCH_ITEM * > m_connected_items
 Stores pointers to other items that are connected to this one (schematic only) More...
 
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
 Stores connectivity information, per sheet. More...
 
bool m_connectivity_dirty
 True if connectivity info might be out of date. More...
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
timestamp_t m_TimeStamp
 Time stamp used for logical links. More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Private Member Functions

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

Detailed Description

Definition at line 377 of file sch_text.h.

Constructor & Destructor Documentation

◆ SCH_GLOBALLABEL()

SCH_GLOBALLABEL::SCH_GLOBALLABEL ( const wxPoint pos = wxPoint( 0, 0 ),
const wxString &  text = wxEmptyString 
)

Definition at line 710 of file sch_text.cpp.

711  : SCH_TEXT( pos, text, SCH_GLOBAL_LABEL_T )
712 {
715  m_isDangling = true;
716  SetMultilineAllowed( false );
717 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:141
bool m_isDangling
True if not connected to another object if the object derive from SCH_TEXT supports connections.
Definition: sch_text.h:185
void SetMultilineAllowed(bool aAllow)
Definition: eda_text.h:180
SCH_TEXT(const wxPoint &pos=wxPoint(0, 0), const wxString &text=wxEmptyString, KICAD_T aType=SCH_TEXT_T)
Definition: sch_text.cpp:99
PINSHEETLABEL_SHAPE m_shape
Definition: sch_text.h:181

References LAYER_GLOBLABEL, SCH_TEXT::m_isDangling, SCH_ITEM::m_Layer, SCH_TEXT::m_shape, PS_BIDI, and EDA_TEXT::SetMultilineAllowed().

Referenced by Clone().

◆ ~SCH_GLOBALLABEL()

SCH_GLOBALLABEL::~SCH_GLOBALLABEL ( )
inline

Definition at line 384 of file sch_text.h.

384 { }

Member Function Documentation

◆ AddConnectionTo()

void SCH_ITEM::AddConnectionTo ( SCH_ITEM aItem)
inherited

Adds a connection link between this item and another.

Definition at line 144 of file sch_item.cpp.

145 {
146  m_connected_items.insert( aItem );
147 }
std::unordered_set< SCH_ITEM * > m_connected_items
Stores pointers to other items that are connected to this one (schematic only)
Definition: sch_item.h:147

References SCH_ITEM::m_connected_items.

Referenced by SCH_TEXT::UpdateDanglingState().

◆ CanConnect()

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

Reimplemented from SCH_ITEM.

Definition at line 408 of file sch_text.h.

409  {
410  return aItem->Type() == SCH_LINE_T &&
411  ( aItem->GetLayer() == LAYER_WIRE || aItem->GetLayer() == LAYER_BUS );
412  }
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:212
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

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

◆ CanIncrementLabel()

bool SCH_TEXT::CanIncrementLabel ( ) const
inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 307 of file sch_text.h.

307 { return true; }

Referenced by SCH_EDIT_FRAME::ConvertTextType().

◆ ClassOf()

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

Definition at line 388 of file sch_text.h.

389  {
390  return aItem && SCH_GLOBAL_LABEL_T == aItem->Type();
391  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References SCH_GLOBAL_LABEL_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 235 of file base_struct.h.

235 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:256

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ ClearConnections()

void SCH_ITEM::ClearConnections ( )
inlineinherited

Function ClearConnections 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 336 of file sch_item.h.

336 { m_connections.clear(); }
EDA_ITEMS m_connections
List of items connected to this item.
Definition: sch_item.h:142

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

◆ ClearFlags()

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

Definition at line 256 of file base_struct.h.

256 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_COMPONENT::ClearAllHighlightFlags(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearHighlighted(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), MWAVE::CreateMicrowaveInductor(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), KIGFX::SCH_VIEW::HighlightItem(), MODULE_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceModule(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::RollbackPartFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearHighlighted()

void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 234 of file base_struct.h.

234 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:256

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )
inlineinherited

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 268 of file base_struct.h.

269  {
271  }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:131
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:130
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:126
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:256
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:132
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:125

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 153 of file view_item.h.

154  {
156  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:161
#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 720 of file sch_text.cpp.

721 {
722  return new SCH_GLOBALLABEL( *this );
723 }
SCH_GLOBALLABEL(const wxPoint &pos=wxPoint(0, 0), const wxString &text=wxEmptyString)
Definition: sch_text.cpp:710

References SCH_GLOBALLABEL().

◆ ConnectedItems()

std::unordered_set< SCH_ITEM * > & SCH_ITEM::ConnectedItems ( )
inherited

Retrieves the set of items connected to this item (schematic only)

Definition at line 138 of file sch_item.cpp.

139 {
140  return m_connected_items;
141 }
std::unordered_set< SCH_ITEM * > m_connected_items
Stores pointers to other items that are connected to this one (schematic only)
Definition: sch_item.h:147

References SCH_ITEM::m_connected_items.

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

◆ Connection()

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

Definition at line 373 of file sch_item.h.

373 { return true; }

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT aSrc)
inherited

Definition at line 118 of file eda_text.cpp.

119 {
120  m_text = aSrc.m_text;
121  m_shown_text = aSrc.m_shown_text;
122 }
wxString m_shown_text
Definition: eda_text.h:367
wxString m_text
Definition: eda_text.h:366

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

Referenced by LIB_FIELD::Copy().

◆ CreateGraphicShape()

void SCH_GLOBALLABEL::CreateGraphicShape ( 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 834 of file sch_text.cpp.

835 {
836  int halfSize = GetTextHeight() / 2;
837  int linewidth = GetThickness() == 0 ? GetDefaultLineThickness() : GetThickness();
838 
839  linewidth = Clamp_Text_PenSize( linewidth, GetTextSize(), IsBold() );
840 
841  aPoints.clear();
842 
843  int symb_len = LenSize( GetShownText(), linewidth, GetTextMarkupFlags() ) + ( TXT_MARGIN * 2 );
844 
845  // Create outline shape : 6 points
846  int x = symb_len + linewidth + 3;
847 
848  // Use negation bar Y position to calculate full vertical size
849  // Search for overbar symbol
850  wxString test = GetText();
851  test.Replace( "~~", "" );
852  bool hasOverBar = test.find( "~" ) != wxString::npos;
853 
854  #define V_MARGIN 1.40
855  // Note: this factor is due to the fact the Y size of a few letters like '[' are bigger
856  // than the y size value, and we need a margin for the graphic symbol.
857  int y = KiROUND( halfSize * V_MARGIN );
858 
859  #define OVERBAR_V_MARGIN 1.2
860  // Note: this factor is due to the fact we need a margin for the graphic symbol.
861  if( hasOverBar )
863 
864  // Gives room for line thickess and margin
865  y += linewidth; // for line thickess
866  y += linewidth / 2; // for margin
867 
868  // Starting point(anchor)
869  aPoints.emplace_back( wxPoint( 0, 0 ) );
870  aPoints.emplace_back( wxPoint( 0, -y ) ); // Up
871  aPoints.emplace_back( wxPoint( -x, -y ) ); // left
872  aPoints.emplace_back( wxPoint( -x, 0 ) ); // Up left
873  aPoints.emplace_back( wxPoint( -x, y ) ); // left down
874  aPoints.emplace_back( wxPoint( 0, y ) ); // down
875 
876  int x_offset = 0;
877 
878  switch( m_shape )
879  {
881  x_offset = -halfSize;
882  aPoints[0].x += halfSize;
883  break;
884 
886  aPoints[3].x -= halfSize;
887  break;
888 
891  x_offset = -halfSize;
892  aPoints[0].x += halfSize;
893  aPoints[3].x -= halfSize;
894  break;
895 
897  default:
898  break;
899  }
900 
901  int angle = 0;
902 
903  switch( GetLabelSpinStyle() )
904  {
905  default:
907  break; // Orientation horiz normal
909  angle = -900;
910  break; // Orientation vert UP
912  angle = 1800;
913  break; // Orientation horiz inverse
915  angle = 900;
916  break; // Orientation vert BOTTOM
917  }
918 
919  // Rotate outlines and move corners in real position
920  for( wxPoint& aPoint : aPoints )
921  {
922  aPoint.x += x_offset;
923 
924  if( angle )
925  RotatePoint( &aPoint, angle );
926 
927  aPoint += Pos;
928  }
929 
930  aPoints.push_back( aPoints[0] ); // closing
931 }
bool IsBold() const
Definition: eda_text.h:167
static double GetInterline(double aGlyphHeight)
Compute the distance (interline) between 2 lines of text (for multiline texts).
#define V_MARGIN
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
int GetThickness() const
Return the pen width.
Definition: eda_text.h:148
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
int GetTextHeight() const
Definition: eda_text.h:229
int GetTextMarkupFlags()
Definition: gr_text.cpp:55
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:81
#define OVERBAR_V_MARGIN
const wxSize & GetTextSize() const
Definition: eda_text.h:223
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:238
int LenSize(const wxString &aLine, int aThickness, int aMarkupFlags) const
Definition: eda_text.cpp:150
#define TXT_MARGIN
Definition: sch_text.cpp:57
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)
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:61
PINSHEETLABEL_SHAPE m_shape
Definition: sch_text.h:181
virtual wxString GetShownText() const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:129
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:123

References PNS::angle(), LABEL_SPIN_STYLE::BOTTOM, Clamp_Text_PenSize(), GetDefaultLineThickness(), KIGFX::STROKE_FONT::GetInterline(), SCH_TEXT::GetLabelSpinStyle(), EDA_TEXT::GetShownText(), EDA_TEXT::GetText(), EDA_TEXT::GetTextHeight(), GetTextMarkupFlags(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetThickness(), EDA_TEXT::IsBold(), KiROUND(), LABEL_SPIN_STYLE::LEFT, EDA_TEXT::LenSize(), SCH_TEXT::m_shape, OVERBAR_V_MARGIN, PS_BIDI, PS_INPUT, PS_OUTPUT, PS_TRISTATE, PS_UNSPECIFIED, LABEL_SPIN_STYLE::RIGHT, RotatePoint(), TXT_MARGIN, LABEL_SPIN_STYLE::UP, and V_MARGIN.

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

◆ doIsConnected()

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

Function doIsConnected provides 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 421 of file sch_text.h.

421 { return EDA_TEXT::GetTextPos() == aPosition; }
const wxPoint & GetTextPos() const
Definition: eda_text.h:232

References EDA_TEXT::GetTextPos().

◆ Duplicate()

SCH_ITEM * SCH_ITEM::Duplicate ( bool  doClone = false)
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 75 of file sch_item.cpp.

76 {
77  SCH_ITEM* newItem = (SCH_ITEM*) Clone();
78 
79  if( doClone )
80  newItem->SetTimeStamp( GetTimeStamp() );
81 
82  newItem->ClearFlags( SELECTED | HIGHLIGHTED | BRIGHTENED );
83 
84  if( newItem->Type() == SCH_COMPONENT_T )
85  {
86  SCH_COMPONENT* component = (SCH_COMPONENT*) newItem;
87 
88  for( SCH_PIN& pin : component->GetPins() )
90 
91  std::vector<SCH_FIELD*> fields;
92  component->GetFields( fields, false );
93 
94  for( SCH_FIELD* field : fields )
95  field->ClearFlags( SELECTED | HIGHLIGHTED | BRIGHTENED );
96  }
97 
98  if( newItem->Type() == SCH_SHEET_T )
99  {
100  SCH_SHEET* sheet = (SCH_SHEET*) newItem;
101 
102  for( SCH_SHEET_PIN* pin : sheet->GetPins() )
104  }
105 
106  return newItem;
107 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populates a std::vector with SCH_FIELDs.
#define SELECTED
Definition: base_struct.h:127
timestamp_t GetTimeStamp() const
Definition: base_struct.h:213
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:206
std::vector< SCH_SHEET_PIN * > & GetPins()
Definition: sch_sheet.h:332
void GetPins(std::vector< LIB_PIN * > &aPinsList)
Populate a vector with all the pins from the library object.
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:89
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:256
SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:136
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207
void SetTimeStamp(timestamp_t aNewTimeStamp)
Definition: base_struct.h:212

References BRIGHTENED, EDA_ITEM::ClearFlags(), EDA_ITEM::Clone(), SCH_COMPONENT::GetFields(), SCH_SHEET::GetPins(), SCH_COMPONENT::GetPins(), EDA_ITEM::GetTimeStamp(), HIGHLIGHTED, SCH_COMPONENT_T, SCH_SHEET_T, SELECTED, EDA_ITEM::SetTimeStamp(), and EDA_ITEM::Type().

Referenced by SCH_EDIT_TOOL::Duplicate(), SCH_DRAWING_TOOLS::PlaceComponent(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ Empty()

void EDA_TEXT::Empty ( )
inlineinherited

Definition at line 239 of file eda_text.h.

239 { m_text.Empty(); }
wxString m_text
Definition: eda_text.h:366

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

481 {
482 #ifndef GERBVIEW // Gerbview does not use EDA_TEXT::Format
483  // and does not define FormatInternalUnits, used here
484  // however this function should exist
485 
486  aFormatter->Print( aNestLevel + 1, "(effects" );
487 
488  // Text size
489  aFormatter->Print( 0, " (font" );
490 
491  aFormatter->Print( 0, " (size %s %s)",
492  FormatInternalUnits( GetTextHeight() ).c_str(),
493  FormatInternalUnits( GetTextWidth() ).c_str() );
494 
495  if( GetThickness() )
496  aFormatter->Print( 0, " (thickness %s)", FormatInternalUnits( GetThickness() ).c_str() );
497 
498  if( IsBold() )
499  aFormatter->Print( 0, " bold" );
500 
501  if( IsItalic() )
502  aFormatter->Print( 0, " italic" );
503 
504  aFormatter->Print( 0, ")"); // (font
505 
506  if( IsMirrored() ||
509  {
510  aFormatter->Print( 0, " (justify");
511 
513  aFormatter->Print( 0, (GetHorizJustify() == GR_TEXT_HJUSTIFY_LEFT) ? " left" : " right" );
514 
516  aFormatter->Print( 0, (GetVertJustify() == GR_TEXT_VJUSTIFY_TOP) ? " top" : " bottom" );
517 
518  if( IsMirrored() )
519  aFormatter->Print( 0, " mirror" );
520  aFormatter->Print( 0, ")" ); // (justify
521  }
522 
523  if( !(aControlBits & CTL_OMIT_HIDE) && !IsVisible() )
524  aFormatter->Print( 0, " hide" );
525 
526  aFormatter->Print( 0, ")\n" ); // (justify
527 
528 #endif
529 }
bool IsBold() const
Definition: eda_text.h:167
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:184
bool IsMirrored() const
Definition: eda_text.h:173
bool IsVisible() const
Definition: eda_text.h:170
int GetThickness() const
Return the pen width.
Definition: eda_text.h:148
int GetTextHeight() const
Definition: eda_text.h:229
bool IsItalic() const
Definition: eda_text.h:164
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:183
int GetTextWidth() const
Definition: eda_text.h:226
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
#define CTL_OMIT_HIDE
Definition: eda_text.h:39
std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from internal units to a string appropriate for writing ...
Definition: base_units.cpp:480

References CTL_OMIT_HIDE, FormatInternalUnits(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextWidth(), EDA_TEXT::GetThickness(), 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().

◆ 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 934 of file sch_text.cpp.

935 {
936  int x, y, dx, dy, length, height;
937 
938  x = GetTextPos().x;
939  y = GetTextPos().y;
940  dx = dy = 0;
941 
942  int width = GetThickness() == 0 ? GetDefaultLineThickness() : GetThickness();
943 
944  height = ( (GetTextHeight() * 15) / 10 ) + width + 2 * TXT_MARGIN;
945 
946  // text X size add height for triangular shapes(bidirectional)
947  length = LenSize( GetShownText(), width, GetTextMarkupFlags() ) + height +
948  Mils2iu( DANGLING_SYMBOL_SIZE );
949 
950  switch( GetLabelSpinStyle() ) // respect orientation
951  {
952  default:
954  dx = -length;
955  dy = height;
956  x += Mils2iu( DANGLING_SYMBOL_SIZE );
957  y -= height / 2;
958  break;
959 
961  dx = height;
962  dy = -length;
963  x -= height / 2;
964  y += Mils2iu( DANGLING_SYMBOL_SIZE );
965  break;
966 
968  dx = length;
969  dy = height;
970  x -= Mils2iu( DANGLING_SYMBOL_SIZE );
971  y -= height / 2;
972  break;
973 
975  dx = height;
976  dy = length;
977  x -= height / 2;
978  y -= Mils2iu( DANGLING_SYMBOL_SIZE );
979  break;
980  }
981 
982  EDA_RECT box( wxPoint( x, y ), wxSize( dx, dy ) );
983  box.Normalize();
984  return box;
985 }
#define DANGLING_SYMBOL_SIZE
Definition: general.h:45
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
int GetThickness() const
Return the pen width.
Definition: eda_text.h:148
int GetTextHeight() const
Definition: eda_text.h:229
int GetTextMarkupFlags()
Definition: gr_text.cpp:55
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:238
int LenSize(const wxString &aLine, int aThickness, int aMarkupFlags) const
Definition: eda_text.cpp:150
#define TXT_MARGIN
Definition: sch_text.cpp:57
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
virtual wxString GetShownText() const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:129

References LABEL_SPIN_STYLE::BOTTOM, DANGLING_SYMBOL_SIZE, GetDefaultLineThickness(), SCH_TEXT::GetLabelSpinStyle(), EDA_TEXT::GetShownText(), EDA_TEXT::GetTextHeight(), GetTextMarkupFlags(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetThickness(), LABEL_SPIN_STYLE::LEFT, EDA_TEXT::LenSize(), EDA_RECT::Normalize(), LABEL_SPIN_STYLE::RIGHT, TXT_MARGIN, LABEL_SPIN_STYLE::UP, wxPoint::x, and wxPoint::y.

◆ GetClass()

wxString SCH_GLOBALLABEL::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from SCH_TEXT.

Definition at line 393 of file sch_text.h.

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

◆ GetConnectionPoints()

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

Function GetConnectionPoints 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 392 of file sch_text.cpp.

393 {
394  // Normal text labels do not have connection points. All others do.
395  if( Type() == SCH_TEXT_T )
396  return;
397 
398  aPoints.push_back( GetTextPos() );
399 }
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

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

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 260 of file base_struct.h.

261  {
265  return m_Flags & mask;
266  }
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: base_struct.h:128
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:139
#define BEGIN_ONPAD
Pcbnew: flag set for track segment starting on a pad.
Definition: base_struct.h:138
#define EDA_ITEM_ALL_FLAGS
Definition: base_struct.h:154
#define SELECTED
Definition: base_struct.h:127
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
#define DP_COUPLED
item is coupled with another item making a differential pair
Definition: base_struct.h:145
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
#define IS_DANGLING
indicates a pin is dangling
Definition: base_struct.h:149
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:126
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:125

References BEGIN_ONPAD, BRIGHTENED, DP_COUPLED, EDA_ITEM_ALL_FLAGS, END_ONPAD, ENDPOINT, HIGHLIGHTED, IS_DANGLING, EDA_ITEM::m_Flags, SELECTED, STARTPOINT, and TEMP_SELECTED.

Referenced by SCH_EDIT_TOOL::ChangeShape(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editComponentFieldText(), SCH_EDITOR_CONTROL::EditWithLibEdit(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_EDIT_PIN::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ GetEndPoints()

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

Function GetEndPoints adds 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 302 of file sch_text.cpp.

303 {
304  // Normal text labels cannot be tested for dangling ends.
305  if( Type() == SCH_TEXT_T )
306  return;
307 
308  DANGLING_END_ITEM item( LABEL_END, this, GetTextPos() );
309  aItemList.push_back( item );
310 }
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
DANGLING_END_ITEM is a helper class used to store the state of schematic items that can be connected ...
Definition: sch_item.h:67
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

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

◆ GetFlags()

◆ GetHorizJustify()

EDA_TEXT_HJUSTIFY_T EDA_TEXT::GetHorizJustify ( ) const
inlineinherited

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

179 {
181 }
static double GetInterline(double aGlyphHeight)
Compute the distance (interline) between 2 lines of text (for multiline texts).
int GetTextHeight() const
Definition: eda_text.h:229
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:61

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

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

◆ GetLabelSpinStyle()

◆ GetLayer()

◆ 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 994 of file sch_text.cpp.

995 {
996  return add_glabel_xpm;
997 }
const BITMAP_OPAQUE add_glabel_xpm[1]
Definition: add_glabel.cpp:42

References add_glabel_xpm.

◆ GetMsgPanelInfo()

void SCH_TEXT::GetMsgPanelInfo ( EDA_UNITS  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtualinherited

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

Note
This method replaces DisplayInfo() so that KiCad objects no longer have any knowledge of wxWidgets UI objects.
Parameters
aListis the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 539 of file sch_text.cpp.

540 {
541  wxString msg;
542 
543  switch( Type() )
544  {
545  case SCH_TEXT_T: msg = _( "Graphic Text" ); break;
546  case SCH_LABEL_T: msg = _( "Label" ); break;
547  case SCH_GLOBAL_LABEL_T: msg = _( "Global Label" ); break;
548  case SCH_HIER_LABEL_T: msg = _( "Hierarchical Label" ); break;
549  case SCH_SHEET_PIN_T: msg = _( "Hierarchical Sheet Pin" ); break;
550  default: return;
551  }
552 
553  aList.push_back( MSG_PANEL_ITEM( msg, GetShownText(), DARKCYAN ) );
554 
555  switch( GetLabelSpinStyle() )
556  {
557  case LABEL_SPIN_STYLE::LEFT: msg = _( "Horizontal left" ); break;
558  case LABEL_SPIN_STYLE::UP: msg = _( "Vertical up" ); break;
559  case LABEL_SPIN_STYLE::RIGHT: msg = _( "Horizontal right" ); break;
560  case LABEL_SPIN_STYLE::BOTTOM: msg = _( "Vertical down" ); break;
561  default: msg = wxT( "???" ); break;
562  }
563 
564  aList.push_back( MSG_PANEL_ITEM( _( "Orientation" ), msg, BROWN ) );
565 
566  wxString textStyle[] = { _( "Normal" ), _( "Italic" ), _( "Bold" ), _( "Bold Italic" ) };
567  int style = 0;
568 
569  if( IsItalic() )
570  style = 1;
571 
572  if( IsBold() )
573  style += 2;
574 
575  aList.push_back( MSG_PANEL_ITEM( _( "Style" ), textStyle[style], BROWN ) );
576 
577  // Display electrical type if it is relevant
579  {
580  switch( GetShape() )
581  {
582  case PINSHEETLABEL_SHAPE::PS_INPUT: msg = _( "Input" ); break;
583  case PINSHEETLABEL_SHAPE::PS_OUTPUT: msg = _( "Output" ); break;
584  case PINSHEETLABEL_SHAPE::PS_BIDI: msg = _( "Bidirectional" ); break;
585  case PINSHEETLABEL_SHAPE::PS_TRISTATE: msg = _( "Tri-State" ); break;
586  case PINSHEETLABEL_SHAPE::PS_UNSPECIFIED: msg = _( "Passive" ); break;
587  default: msg = wxT( "???" ); break;
588  }
589 
590  aList.push_back( MSG_PANEL_ITEM( _( "Type" ), msg, BLUE ) );
591  }
592 
593  // Display text size (X or Y value, with are the same value in Eeschema)
594  msg = MessageTextFromValue( aUnits, GetTextWidth(), true );
595  aList.push_back( MSG_PANEL_ITEM( _( "Size" ), msg, RED ) );
596 
597 #if defined(DEBUG)
598  if( auto conn = Connection( *g_CurrentSheet ) )
599  conn->AppendDebugInfoToMsgPanel( aList );
600 
601  msg.Printf( "%p", this );
602  aList.push_back( MSG_PANEL_ITEM( "Object Address", msg, RED ) );
603 
604 #endif
605 }
Definition: colors.h:57
bool IsBold() const
Definition: eda_text.h:167
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aUseMils)
Definition: base_units.cpp:127
bool IsItalic() const
Definition: eda_text.h:164
SCH_SHEET_PATH * g_CurrentSheet
With the new connectivity algorithm, many more places than before want to know what the current sheet...
Definition: colors.h:60
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:238
SCH_CONNECTION * Connection(const SCH_SHEET_PATH &aPath) const
Retrieves the connection associated with this object in the given sheet Note: the returned value can ...
Definition: sch_item.cpp:128
int GetTextWidth() const
Definition: eda_text.h:226
#define _(s)
Definition: 3d_actions.cpp:31
virtual wxString GetShownText() const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:129
EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
PINSHEETLABEL_SHAPE GetShape() const
Definition: sch_text.h:243
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207
Definition: colors.h:62

References _, BLUE, LABEL_SPIN_STYLE::BOTTOM, BROWN, SCH_ITEM::Connection(), DARKCYAN, g_CurrentSheet, SCH_TEXT::GetLabelSpinStyle(), SCH_TEXT::GetShape(), EDA_TEXT::GetShownText(), EDA_TEXT::GetTextWidth(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), LABEL_SPIN_STYLE::LEFT, MessageTextFromValue(), PS_BIDI, PS_INPUT, PS_OUTPUT, PS_TRISTATE, PS_UNSPECIFIED, RED, LABEL_SPIN_STYLE::RIGHT, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_SHEET_PIN_T, SCH_TEXT_T, EDA_ITEM::Type(), and LABEL_SPIN_STYLE::UP.

◆ GetNetListItem()

void SCH_TEXT::GetNetListItem ( NETLIST_OBJECT_LIST aNetListItems,
SCH_SHEET_PATH aSheetPath 
)
overridevirtualinherited

Function GetNetListItem creates a new NETLIST_OBJECT for the schematic object and adds it to aNetListItems.

Not all schematic objects have net list items associated with them. This method only needs to be overridden for those schematic objects that have net list objects associated with them.

Reimplemented from SCH_ITEM.

Definition at line 441 of file sch_text.cpp.

443 {
444  if( GetLayer() == LAYER_NOTES || GetLayer() == LAYER_SHEETLABEL )
445  return;
446 
447  NETLIST_OBJECT* item = new NETLIST_OBJECT();
448  item->m_SheetPath = *aSheetPath;
449  item->m_SheetPathInclude = *aSheetPath;
450  item->m_Comp = (SCH_ITEM*) this;
451  item->m_Type = NETLIST_ITEM::LABEL;
452 
453  if( GetLayer() == LAYER_GLOBLABEL )
455  else if( GetLayer() == LAYER_HIERLABEL )
457 
458  item->m_Label = GetText();
459  item->m_Start = item->m_End = GetTextPos();
460 
461  aNetListItems.push_back( item );
462 
463  // If a bus connects to label
464  if( Connection( *aSheetPath )->IsBusLabel( GetText() ) )
465  item->ConvertBusToNetListItems( aNetListItems );
466 }
SCH_SHEET_PATH m_SheetPathInclude
static bool IsBusLabel(const wxString &aLabel)
Test if aLabel has a bus notation.
SCH_SHEET_PATH m_SheetPath
EDA_ITEM * m_Comp
SCH_CONNECTION * Connection(const SCH_SHEET_PATH &aPath) const
Retrieves the connection associated with this object in the given sheet Note: the returned value can ...
Definition: sch_item.cpp:128
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:212
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
NETLIST_ITEM m_Type
SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:136
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:123
void ConvertBusToNetListItems(NETLIST_OBJECT_LIST &aNetListItems)
Function ConvertBusToNetListItems breaks the text of a bus label type net list object into as many me...

References SCH_ITEM::Connection(), NETLIST_OBJECT::ConvertBusToNetListItems(), SCH_ITEM::GetLayer(), EDA_TEXT::GetText(), EDA_TEXT::GetTextPos(), GLOBLABEL, HIERLABEL, SCH_CONNECTION::IsBusLabel(), LABEL, LAYER_GLOBLABEL, LAYER_HIERLABEL, LAYER_NOTES, LAYER_SHEETLABEL, NETLIST_OBJECT::m_Comp, NETLIST_OBJECT::m_End, NETLIST_OBJECT::m_Label, NETLIST_OBJECT::m_SheetPath, NETLIST_OBJECT::m_SheetPathInclude, NETLIST_OBJECT::m_Start, and NETLIST_OBJECT::m_Type.

◆ GetParent()

◆ GetPenSize()

int SCH_TEXT::GetPenSize ( ) const
overridevirtualinherited

Function GetPenSize virtual pure.

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

Reimplemented from SCH_ITEM.

Definition at line 266 of file sch_text.cpp.

267 {
268  int pensize = GetThickness();
269 
270  if( pensize == 0 ) // Use default values for pen size
271  {
272  if( IsBold() )
273  pensize = GetPenSizeForBold( GetTextWidth() );
274  else
275  pensize = GetDefaultLineThickness();
276  }
277 
278  // Clip pen size for small texts:
279  pensize = Clamp_Text_PenSize( pensize, GetTextSize(), IsBold() );
280  return pensize;
281 }
bool IsBold() const
Definition: eda_text.h:167
int GetPenSizeForBold(int aTextSize)
Function GetPensizeForBold.
Definition: gr_text.cpp:66
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
int GetThickness() const
Return the pen width.
Definition: eda_text.h:148
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:81
const wxSize & GetTextSize() const
Definition: eda_text.h:223
int GetTextWidth() const
Definition: eda_text.h:226

References Clamp_Text_PenSize(), GetDefaultLineThickness(), GetPenSizeForBold(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetTextWidth(), EDA_TEXT::GetThickness(), and EDA_TEXT::IsBold().

Referenced by SCH_TEXT::GetSchematicTextOffset(), and SCH_TEXT::Plot().

◆ GetPosition()

wxPoint SCH_TEXT::GetPosition ( ) const
inlineoverridevirtualinherited

Function GetPosition.

Returns
A wxPoint object containing the schematic item position.

Implements SCH_ITEM.

Definition at line 315 of file sch_text.h.

315 { return EDA_TEXT::GetTextPos(); }
const wxPoint & GetTextPos() const
Definition: eda_text.h:232

References EDA_TEXT::GetTextPos().

Referenced by SCH_EAGLE_PLUGIN::adjustNetLabels(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), SCH_EDIT_FRAME::ConvertTextType(), CONNECTION_GRAPH::ercCheckLabels(), SCH_EAGLE_PLUGIN::SEG_DESC::LabelAttached(), and SCH_LEGACY_PLUGIN::saveText().

◆ GetPositionsOfLinesOfMultilineText()

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

386 {
387  wxPoint pos = GetTextPos(); // Position of first line of the
388  // multiline text according to
389  // the center of the multiline text block
390 
391  wxPoint offset; // Offset to next line.
392 
393  offset.y = GetInterline();
394 
395  if( aLineCount > 1 )
396  {
397  switch( GetVertJustify() )
398  {
400  break;
401 
403  pos.y -= ( aLineCount - 1 ) * offset.y / 2;
404  break;
405 
407  pos.y -= ( aLineCount - 1 ) * offset.y;
408  break;
409  }
410  }
411 
412  // Rotate the position of the first line
413  // around the center of the multiline text block
414  RotatePoint( &pos, GetTextPos(), GetTextAngle() );
415 
416  // Rotate the offset lines to increase happened in the right direction
417  RotatePoint( &offset, GetTextAngle() );
418 
419  for( int ii = 0; ii < aLineCount; ii++ )
420  {
421  aPositions.push_back( pos );
422  pos += offset;
423  }
424 }
int GetInterline() const
Return the distance between two lines of text.
Definition: eda_text.cpp:178
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:184
double GetTextAngle() const
Definition: eda_text.h:158
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
const wxPoint & GetTextPos() const
Definition: eda_text.h:232

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, RotatePoint(), and wxPoint::y.

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer(), export_vrml_pcbtext(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotTextePcb(), EDA_TEXT::Print(), TEXTE_PCB::TransformShapeWithClearanceToPolygonSet(), and EDA_TEXT::TransformTextShapeToSegmentList().

◆ GetSchematicTextOffset()

wxPoint SCH_GLOBALLABEL::GetSchematicTextOffset ( ) 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 726 of file sch_text.cpp.

727 {
728  wxPoint text_offset;
729  int width = GetThickness() == 0 ? GetDefaultLineThickness() : GetThickness();
730 
731  width = Clamp_Text_PenSize( width, GetTextSize(), IsBold() );
732  int halfSize = GetTextWidth() / 2;
733  int offset = width;
734 
735  switch( m_shape )
736  {
740  offset += halfSize;
741  break;
742 
745  offset += TXT_MARGIN;
746  break;
747 
748  default:
749  break;
750  }
751 
752  switch( GetLabelSpinStyle() )
753  {
754  default:
756  text_offset.x -= offset;
757  break; // Orientation horiz normal
759  text_offset.y -= offset;
760  break; // Orientation vert UP
762  text_offset.x += offset;
763  break; // Orientation horiz inverse
765  text_offset.y += offset;
766  break; // Orientation vert BOTTOM
767  }
768 
769  return text_offset;
770 }
bool IsBold() const
Definition: eda_text.h:167
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
int GetThickness() const
Return the pen width.
Definition: eda_text.h:148
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:81
const wxSize & GetTextSize() const
Definition: eda_text.h:223
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:238
int GetTextWidth() const
Definition: eda_text.h:226
#define TXT_MARGIN
Definition: sch_text.cpp:57
PINSHEETLABEL_SHAPE m_shape
Definition: sch_text.h:181

References LABEL_SPIN_STYLE::BOTTOM, Clamp_Text_PenSize(), GetDefaultLineThickness(), SCH_TEXT::GetLabelSpinStyle(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetTextWidth(), EDA_TEXT::GetThickness(), EDA_TEXT::IsBold(), LABEL_SPIN_STYLE::LEFT, SCH_TEXT::m_shape, PS_BIDI, PS_INPUT, PS_OUTPUT, PS_TRISTATE, PS_UNSPECIFIED, LABEL_SPIN_STYLE::RIGHT, TXT_MARGIN, LABEL_SPIN_STYLE::UP, wxPoint::x, and wxPoint::y.

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 988 of file sch_text.cpp.

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

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

◆ GetShape()

◆ GetShownText()

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 239 of file base_struct.h.

240  {
241  return m_Status & type;
242  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by SELECTION_TOOL::expandConnection(), TRACK::GetMsgPanelInfoBase_Common(), TRACK::IsLocked(), TRACK::Print(), and ZONE_CONTAINER::PrintFilledArea().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 252 of file base_struct.h.

252 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 193 of file sch_item.h.

193 { return m_storedPos; }
wxPoint m_storedPos
a temporary variable used in some move commands to store a initial pos (of the item or mouse cursor)
Definition: sch_item.h:143

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::moveItem().

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

123 { return m_text; }
wxString m_text
Definition: eda_text.h:366

References EDA_TEXT::m_text.

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), SCH_EAGLE_PLUGIN::addImplicitConnections(), SIM_PLOT_FRAME::AddTuner(), SCH_EDITOR_CONTROL::BackAnnotateFootprints(), LIB_TEXT::Clone(), LIB_TEXT::compare(), LIB_FIELD::compare(), SCH_REFERENCE::CompareValue(), SCH_SHEET::ComponentCount(), SCH_EDIT_FRAME::ConvertTextType(), CreateComponentsSection(), CreateGraphicShape(), SCH_EDIT_FRAME::CreateNewText(), SCH_EDIT_FRAME::CreateSheetPin(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::SCH_PAINTER::draw(), LIB_PART::Flatten(), PCB_IO::format(), FormatProbeItem(), LIB_FIELD::GetFullText(), SCH_FIELD::GetFullyQualifiedText(), TEXTE_MODULE::GetLength(), getMatchingTextItem(), SCH_TEXT::GetNetListItem(), SCH_COMPONENT::GetRef(), LIB_PART::GetSearchText(), TEXTE_MODULE::GetShownText(), NETLIST_EXPORTER_PSPICE::GetSpiceField(), NETLIST_EXPORTER_PSPICE::GetSpiceFieldDefVal(), DIMENSION::GetText(), TEXT_MOD_GRID_TABLE::GetValue(), hash_eda(), LIB_FIELD::HitTest(), 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(), LIB_FIELD::operator=(), SCH_COMPONENT::operator==(), PCB_PARSER::parseDIMENSION(), DRAWING_TOOL::PlaceText(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), BRDITEMS_PLOTTER::PlotAllTextsModule(), DIALOG_RESCUE_EACH::PopulateInstanceList(), LIB_FIELD::print(), TEXTE_MODULE::Print(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), processTextItem(), SCH_LEGACY_PLUGIN::saveComponent(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_COMPONENT::SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SCREEN::SetComponentFootprint(), LIB_PART::SetParent(), SCH_COMPONENT::SetRef(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_REFERENCE_LIST::sortByReferenceOnly(), TestMultiunitFootprints(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), DIALOG_EDIT_SHEET_PIN::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), EDA_TEXT::TransformTextShapeToSegmentList(), TUNER_SLIDER::TUNER_SLIDER(), DIALOG_UPDATE_FIELDS::updateFields(), SCH_COMPONENT::UpdateFields(), DIALOG_FOOTPRINT_FP_EDITOR::Validate(), DIALOG_FOOTPRINT_BOARD_EDITOR::Validate(), TEXTE_MODULE::ViewGetLOD(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

◆ GetTextAngle()

double EDA_TEXT::GetTextAngle ( ) const
inlineinherited

Definition at line 158 of file eda_text.h.

158 { return m_e.angle; }
TEXT_EFFECTS m_e
Definition: eda_text.h:385
double angle
now: 0.1 degrees; future: degrees
Definition: eda_text.h:95

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

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer(), CreateComponentsSection(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::WS_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), export_vrml_pcbtext(), TEXTE_MODULE::Flip(), PCB_IO::format(), LIB_TEXT::GetBoundingBox(), TEXTE_PCB::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), TEXTE_MODULE::GetDrawRotation(), TEXTE_PCB::GetMsgPanelInfo(), EDA_TEXT::GetPositionsOfLinesOfMultilineText(), EDA_TEXT::GetTextAngleDegrees(), EDA_TEXT::GetTextAngleRadians(), TEXT_MOD_GRID_TABLE::GetValue(), hash_eda(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), TEXTE_MODULE::KeepUpright(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), DIMENSION::Mirror(), EAGLE_PLUGIN::orientModuleText(), PCB_PARSER::parseMODULE_unchecked(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotTextePcb(), PlotWorkSheet(), LIB_TEXT::print(), LIB_FIELD::print(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), SCH_EDIT_TOOL::Rotate(), TEXTE_PCB::Rotate(), LIB_TEXT::Rotate(), TEXTE_MODULE::Rotate(), LIB_FIELD::Rotate(), DIMENSION::Rotate(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SCREEN::SetComponentFootprint(), EDA_TEXT::TextHitTest(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), TEXTE_PCB::TransformShapeWithClearanceToPolygonSet(), EDA_TEXT::TransformTextShapeToSegmentList(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and DIALOG_UPDATE_FIELDS::updateFields().

◆ GetTextAngleDegrees()

double EDA_TEXT::GetTextAngleDegrees ( ) const
inlineinherited

Definition at line 160 of file eda_text.h.

160 { return GetTextAngle() / 10.0; }
double GetTextAngle() const
Definition: eda_text.h:158

References EDA_TEXT::GetTextAngle().

Referenced by TEXTE_MODULE::GetMsgPanelInfo(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GetTextAngleRadians()

double EDA_TEXT::GetTextAngleRadians ( ) const
inlineinherited

Definition at line 161 of file eda_text.h.

161 { return GetTextAngle() * M_PI/1800; }
double GetTextAngle() const
Definition: eda_text.h:158

References EDA_TEXT::GetTextAngle().

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

◆ GetTextBox()

EDA_RECT EDA_TEXT::GetTextBox ( int  aLine = -1,
int  aThickness = -1,
bool  aInvertY = false,
int  aMarkupFlags = 0 
) const
inherited

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

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
Parameters
aLineThe line of text to consider. for single line text, aLine is unused If aLine == -1, the full area (considering all lines) is returned
aThicknessOverrides the current penwidth when greater than 0. This is needed when the current penwidth is 0 and a default penwidth is used.
aInvertYInvert the Y axis when calculating bounding box.
aMarkupFlagsa flagset of MARKUP_FLAG enums indicating which markup tokens should be processed

Definition at line 184 of file eda_text.cpp.

185 {
186  EDA_RECT rect;
187  wxArrayString strings;
188  wxString text = GetShownText();
189  int thickness = ( aThickness < 0 ) ? GetThickness() : aThickness;
190  int linecount = 1;
191  bool hasOverBar = false; // true if the first line of text as an overbar
192 
193  if( IsMultilineAllowed() )
194  {
195  wxStringSplit( text, strings, '\n' );
196 
197  if( strings.GetCount() ) // GetCount() == 0 for void strings
198  {
199  if( aLine >= 0 && (aLine < (int)strings.GetCount()) )
200  text = strings.Item( aLine );
201  else
202  text = strings.Item( 0 );
203 
204  linecount = strings.GetCount();
205  }
206  }
207 
208  // Search for overbar symbol. Only text is scanned,
209  // because only this line can change the bounding box
210  for( unsigned ii = 1; ii < text.size(); ii++ )
211  {
212  if( text[ii-1] == '~' && text[ii] != '~' )
213  {
214  hasOverBar = true;
215  break;
216  }
217  }
218 
219  // calculate the H and V size
220  const auto& font = basic_gal.GetStrokeFont();
221  VECTOR2D size( GetTextSize() );
222  double penWidth( thickness );
223  int dx = KiROUND( font.ComputeStringBoundaryLimits( text, size, penWidth, aMarkupFlags ).x );
224  int dy = GetInterline();
225 
226  // Creates bounding box (rectangle) for an horizontal
227  // and left and top justified text. the bounding box will be moved later
228  // according to the actual text options
229  wxSize textsize = wxSize( dx, dy );
230  wxPoint pos = GetTextPos();
231 
232  if( aInvertY )
233  pos.y = -pos.y;
234 
235  rect.SetOrigin( pos );
236 
237  // The bbox vertical size returned by GetInterline( aThickness )
238  // includes letters like j and y and ] + interval between lines.
239  // The interval below the last line is not usefull, and we can use its half value
240  // as vertical margin above the text
241  // the full interval is roughly GetTextHeight() * 0.4 - aThickness/2
242  rect.Move( wxPoint( 0, thickness/4 - KiROUND( GetTextHeight() * 0.22 ) ) );
243 
244  if( hasOverBar )
245  { // A overbar adds an extra size to the text
246  // Height from the base line text of chars like [ or {
247  double curr_height = GetTextHeight() * 1.15;
248  int extra_height = KiROUND( font.ComputeOverbarVerticalPosition( size.y, penWidth ) - curr_height );
249  extra_height += thickness / 2;
250  textsize.y += extra_height;
251  rect.Move( wxPoint( 0, -extra_height ) );
252  }
253 
254  // for multiline texts and aLine < 0, merge all rectangles
255  // ( if aLine < 0, we want the full text bounding box )
256  if( IsMultilineAllowed() && aLine < 0 )
257  {
258  for( unsigned ii = 1; ii < strings.GetCount(); ii++ )
259  {
260  text = strings.Item( ii );
261  dx = KiROUND( font.ComputeStringBoundaryLimits( text, size, penWidth, aMarkupFlags ).x );
262  textsize.x = std::max( textsize.x, dx );
263  textsize.y += dy;
264  }
265  }
266 
267  rect.SetSize( textsize );
268 
269  /* Now, calculate the rect origin, according to text justification
270  * At this point the rectangle origin is the text origin (m_Pos).
271  * This is true only for left and top text justified texts (using top to bottom Y axis
272  * orientation). and must be recalculated for others justifications
273  * also, note the V justification is relative to the first line
274  */
275  switch( GetHorizJustify() )
276  {
278  if( IsMirrored() )
279  rect.SetX( rect.GetX() - rect.GetWidth() );
280  break;
281 
283  rect.SetX( rect.GetX() - (rect.GetWidth() / 2) );
284  break;
285 
287  if( !IsMirrored() )
288  rect.SetX( rect.GetX() - rect.GetWidth() );
289  break;
290  }
291 
292  dy = GetTextHeight() + thickness;
293 
294  switch( GetVertJustify() )
295  {
297  break;
298 
300  rect.SetY( rect.GetY() - ( dy / 2) );
301  break;
302 
304  rect.SetY( rect.GetY() - dy );
305  break;
306  }
307 
308  if( linecount > 1 )
309  {
310  int yoffset;
311  linecount -= 1;
312 
313  switch( GetVertJustify() )
314  {
316  break;
317 
319  yoffset = linecount * GetInterline() / 2;
320  rect.SetY( rect.GetY() - yoffset );
321  break;
322 
324  yoffset = linecount * GetInterline();
325  rect.SetY( rect.GetY() - yoffset );
326  break;
327  }
328  }
329 
330  rect.Normalize(); // Make h and v sizes always >= 0
331 
332  return rect;
333 }
const STROKE_FONT & GetStrokeFont() const
void wxStringSplit(const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
Split aString to a string list separated at aSplitter.
Definition: common.cpp:186
int GetInterline() const
Return the distance between two lines of text.
Definition: eda_text.cpp:178
void Move(const wxPoint &aMoveVector)
Function Move moves the rectangle by the aMoveVector.
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:184
bool IsMirrored() const
Definition: eda_text.h:173
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 GetThickness() const
Return the pen width.
Definition: eda_text.h:148
int GetTextHeight() const
Definition: eda_text.h:229
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:183
const wxSize & GetTextSize() const
Definition: eda_text.h:223
void SetX(int val)
Definition: eda_rect.h:168
bool IsMultilineAllowed() const
Definition: eda_text.h:181
void SetY(int val)
Definition: eda_rect.h:174
void Normalize()
Function Normalize ensures that the height ant width are positive.
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:61
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
BASIC_GAL basic_gal(basic_displayOptions)
virtual wxString GetShownText() const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:129

References basic_gal, EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetInterline(), EDA_TEXT::GetShownText(), KIGFX::GAL::GetStrokeFont(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetThickness(), 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(), wxPoint::y, and VECTOR2< T >::y.

Referenced by TEXTE_PCB::Flip(), LIB_TEXT::GetBoundingBox(), TEXTE_PCB::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), TEXTE_MODULE::GetBoundingBox(), DIMENSION::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), WS_DRAW_ITEM_TEXT::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), DRC::testCopperTextItem(), TEXTE_MODULE::TextHitTest(), EDA_TEXT::TextHitTest(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), and TEXTE_MODULE::ViewBBox().

◆ GetTextHeight()

◆ GetTextPos()

const wxPoint& EDA_TEXT::GetTextPos ( ) const
inlineinherited

Definition at line 232 of file eda_text.h.

232 { return m_e.pos; }
TEXT_EFFECTS m_e
Definition: eda_text.h:385
wxPoint pos
Definition: eda_text.h:96

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

Referenced by CINFO3D_VISU::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_pcbtext(), export_vrml_text_module(), TEXTE_PCB::Flip(), TEXTE_MODULE::Flip(), PCB_IO::format(), LIB_TEXT::GetBoundingBox(), TEXTE_PCB::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), TEXTE_MODULE::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), SCH_TEXT::GetConnectionPoints(), SCH_SHEET_PIN::GetEndPoints(), SCH_TEXT::GetEndPoints(), SCH_FIELD::GetLibPosition(), SCH_TEXT::GetNetListItem(), TEXTE_PCB::GetPosition(), TEXTE_MODULE::GetPosition(), LIB_TEXT::GetPosition(), DIMENSION::GetPosition(), LIB_FIELD::GetPosition(), SCH_FIELD::GetPosition(), WS_DRAW_ITEM_TEXT::GetPosition(), SCH_TEXT::GetPosition(), EDA_TEXT::GetPositionsOfLinesOfMultilineText(), WS_DRAW_ITEM_TEXT::GetSelectMenuText(), EDA_TEXT::GetTextBox(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), TEXTE_MODULE::Mirror(), DIMENSION::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_FIELD::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), LIB_FIELD::MirrorVertical(), SCH_SHEET_PIN::MirrorX(), SCH_TEXT::MirrorX(), SCH_COMPONENT::MirrorX(), SCH_SHEET_PIN::MirrorY(), SCH_TEXT::MirrorY(), SCH_COMPONENT::MirrorY(), PCB_PARSER::parseDIMENSION(), DRAWING_TOOL::PlaceText(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotTextePcb(), BRDITEMS_PLOTTER::PlotTextModule(), PlotWorkSheet(), LIB_FIELD::print(), TEXTE_MODULE::Print(), EDA_TEXT::Print(), Print(), SCH_HIERLABEL::Print(), TEXTE_PCB::Rotate(), LIB_TEXT::Rotate(), TEXTE_MODULE::Rotate(), SCH_FIELD::Rotate(), SCH_SHEET_PIN::Rotate(), LIB_FIELD::Rotate(), DIMENSION::Rotate(), SCH_TEXT::Rotate(), SCH_COMPONENT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SCREEN::SetComponentFootprint(), TEXTE_MODULE::SetDrawCoord(), TEXTE_MODULE::SetLocalCoord(), SCH_COMPONENT::SetRef(), TEXTE_MODULE::TextHitTest(), EDA_TEXT::TextHitTest(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), TEXTE_PCB::TransformShapeWithClearanceToPolygonSet(), EDA_TEXT::TransformTextShapeToSegmentList(), SCH_TEXT::UpdateDanglingState(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), DIALOG_UPDATE_FIELDS::updateFields(), and TEXTE_MODULE::ViewBBox().

◆ GetTextSize()

◆ GetTextStyleName()

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

Definition at line 445 of file eda_text.cpp.

446 {
447  int style = 0;
448 
449  if( IsItalic() )
450  style = 1;
451 
452  if( IsBold() )
453  style += 2;
454 
455  wxString stylemsg[4] = {
456  _("Normal"),
457  _("Italic"),
458  _("Bold"),
459  _("Bold+Italic")
460  };
461 
462  return stylemsg[style];
463 }
bool IsBold() const
Definition: eda_text.h:167
bool IsItalic() const
Definition: eda_text.h:164
#define _(s)
Definition: 3d_actions.cpp:31

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

Referenced by LIB_FIELD::GetMsgPanelInfo().

◆ GetTextWidth()

◆ GetThickness()

int EDA_TEXT::GetThickness ( ) const
inlineinherited

Return the pen width.

Definition at line 148 of file eda_text.h.

148 { return m_e.penwidth; };
TEXT_EFFECTS m_e
Definition: eda_text.h:385
int penwidth
Definition: eda_text.h:94

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

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer(), DIMENSION::AdjustDimensionDetails(), SCH_EDIT_FRAME::ConvertTextType(), CreateGraphicShape(), KIGFX::WS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), export_vrml_pcbtext(), export_vrml_text_module(), EDA_TEXT::Format(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), LIB_TEXT::GetMsgPanelInfo(), TEXTE_PCB::GetMsgPanelInfo(), TEXTE_MODULE::GetMsgPanelInfo(), LIB_TEXT::GetPenSize(), LIB_FIELD::GetPenSize(), SCH_FIELD::GetPenSize(), SCH_TEXT::GetPenSize(), WS_DRAW_ITEM_TEXT::GetPenWidth(), GetSchematicTextOffset(), SCH_HIERLABEL::GetSchematicTextOffset(), EDA_TEXT::GetTextBox(), KIGFX::SCH_PAINTER::getTextThickness(), TEXT_MOD_GRID_TABLE::GetValue(), LIB_TEXT::GetWidth(), LIB_FIELD::GetWidth(), EDA_TEXT::IsDefaultFormatting(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotTextePcb(), BRDITEMS_PLOTTER::PlotTextModule(), SCH_FIELD::Print(), TEXTE_MODULE::Print(), SCH_TEXT::Print(), Print(), SCH_HIERLABEL::Print(), EDA_TEXT::printOneLineOfText(), SCH_LEGACY_PLUGIN::saveText(), PNS_KICAD_IFACE::syncTextItem(), DRC::testCopperTextItem(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), TEXTE_PCB::TransformShapeWithClearanceToPolygonSet(), and EDA_TEXT::TransformTextShapeToSegmentList().

◆ GetTimeStamp()

◆ GetVertJustify()

◆ HasFlag()

◆ 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 469 of file sch_text.cpp.

470 {
471  EDA_RECT bBox = GetBoundingBox();
472  bBox.Inflate( aAccuracy );
473  return bBox.Contains( aPosition );
474 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_text.cpp:402
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.

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 477 of file sch_text.cpp.

478 {
479  EDA_RECT bBox = GetBoundingBox();
480  bBox.Inflate( aAccuracy );
481 
482  if( aContained )
483  return aRect.Contains( bBox );
484 
485  return aRect.Intersects( bBox );
486 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_text.cpp:402
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.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

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 129 of file sch_text.cpp.

130 {
131  wxString text = GetText();
132  IncrementLabelMember( text, aIncrement );
133  SetText(text );
134 }
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:111
void IncrementLabelMember(wxString &name, int aIncrement)
Definition: edit_label.cpp:281
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:123

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

◆ InitializeConnection()

SCH_CONNECTION * SCH_ITEM::InitializeConnection ( const SCH_SHEET_PATH aPath)
inherited

Creates a new connection object associated with this object.

Parameters
aPathis the sheet path to initialize

Definition at line 150 of file sch_item.cpp.

151 {
152  if( Connection( aSheet ) )
153  {
154  Connection( aSheet )->Reset();
155  Connection( aSheet )->SetSheet( aSheet );
156  return Connection( aSheet );
157  }
158 
159  auto connection = new SCH_CONNECTION( this );
160  connection->SetSheet( aSheet );
161  m_connection_map.insert( std::make_pair( aSheet, connection ) );
162  return connection;
163 }
void SetSheet(SCH_SHEET_PATH aSheet)
void Reset()
Clears connectivity information.
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Stores connectivity information, per sheet.
Definition: sch_item.h:150
SCH_CONNECTION * Connection(const SCH_SHEET_PATH &aPath) const
Retrieves the connection associated with this object in the given sheet Note: the returned value can ...
Definition: sch_item.cpp:128
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(), and SCH_CONNECTION::SetSheet().

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ IsBold()

bool EDA_TEXT::IsBold ( ) const
inlineinherited

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

◆ IsConnectable()

bool SCH_GLOBALLABEL::IsConnectable ( ) const
inlineoverridevirtual

Function IsConnectable returns true if the schematic item can connect to another schematic item.

Reimplemented from SCH_ITEM.

Definition at line 406 of file sch_text.h.

406 { return true; }

◆ IsConnected()

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

Function IsConnected tests 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 119 of file sch_item.cpp.

120 {
121  if( ( m_Flags & STRUCT_DELETED ) || ( m_Flags & SKIP_STRUCT ) )
122  return false;
123 
124  return doIsConnected( aPosition );
125 }
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:131
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:129
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
virtual bool doIsConnected(const wxPoint &aPosition) const
Function doIsConnected provides the object specific test to see if it is connected to aPosition.
Definition: sch_item.h:433

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

375 { return m_connectivity_dirty; }
bool m_connectivity_dirty
True if connectivity info might be out of date.
Definition: sch_item.h:153

References SCH_ITEM::m_connectivity_dirty.

◆ IsDangling()

bool SCH_TEXT::IsDangling ( ) const
inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 302 of file sch_text.h.

302 { 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:185

References SCH_TEXT::m_isDangling.

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

◆ IsDefaultFormatting()

bool EDA_TEXT::IsDefaultFormatting ( ) const
inherited

Definition at line 466 of file eda_text.cpp.

467 {
468  return ( IsVisible()
469  && !IsMirrored()
472  && GetThickness() == 0
473  && !IsItalic()
474  && !IsBold()
475  && !IsMultilineAllowed()
476  );
477 }
bool IsBold() const
Definition: eda_text.h:167
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:184
bool IsMirrored() const
Definition: eda_text.h:173
bool IsVisible() const
Definition: eda_text.h:170
int GetThickness() const
Return the pen width.
Definition: eda_text.h:148
bool IsItalic() const
Definition: eda_text.h:164
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:183
bool IsMultilineAllowed() const
Definition: eda_text.h:181

References EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetThickness(), 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().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 221 of file base_struct.h.

221 { return m_Flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:122
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References IS_DRAGGED, and EDA_ITEM::m_Flags.

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), KIGFX::SCH_PAINTER::setDeviceColors(), and ShowClearance().

◆ IsHighlighted()

bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 225 of file base_struct.h.

225 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References HIGHLIGHTED, and EDA_ITEM::m_Flags.

Referenced by SCH_COMPONENT::ClearAllHighlightFlags(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), and KIGFX::SCH_VIEW::HighlightItem().

◆ IsItalic()

bool EDA_TEXT::IsItalic ( ) const
inlineinherited

◆ IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const
inlinevirtualinherited

Function IsLocked.

Returns
bool - true if the object is locked, else false

Definition at line 200 of file sch_item.h.

200 { return false; }

Referenced by SCH_EDIT_TOOL::DeleteItemCursor().

◆ IsMirrored()

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 219 of file base_struct.h.

219 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:116
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

virtual bool SCH_ITEM::IsMovableFromAnchorPoint ( )
inlinevirtualinherited

Virtual function IsMovableFromAnchorPoint.

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, compoments)

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

Definition at line 191 of file sch_item.h.

191 { return true; }

Referenced by SCH_MOVE_TOOL::Main().

◆ IsMoving()

◆ IsMultilineAllowed()

◆ IsNew()

◆ 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 224 of file base_struct.h.

224 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:121

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 SCH_LABEL, SCH_FIELD, and SCH_LINE.

Definition at line 284 of file base_struct.h.

285  {
286  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
287  return true;
288 
289  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
290  {
291  if( m_StructType == *p )
292  return true;
293  }
294 
295  return false;
296  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:172
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

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(), SCH_LINE::IsType(), SCH_FIELD::IsType(), SCH_LABEL::IsType(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsVisible()

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 222 of file base_struct.h.

222 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:124
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

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 397 of file base_struct.h.

401  {
402  for( auto it : aList )
403  {
404  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
406  return SEARCH_RESULT::QUIT;
407  }
408 
410  }
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...

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

Referenced by GERBER_FILE_IMAGE::Visit(), and BOARD::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 418 of file base_struct.h.

420  {
421  for( auto it : aList )
422  {
423  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
425  return SEARCH_RESULT::QUIT;
426  }
427 
429  }
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...

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

◆ LenSize()

int EDA_TEXT::LenSize ( const wxString &  aLine,
int  aThickness,
int  aMarkupFlags 
) 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
aMarkupFlagsa flag set of MARKUP_FLAG enums indicating which markup tokens should be processed

Definition at line 150 of file eda_text.cpp.

151 {
154  basic_gal.SetLineWidth( (float) aThickness );
156 
157  VECTOR2D tsize = basic_gal.GetTextLineSize( aLine, aMarkupFlags );
158 
159  return KiROUND( tsize.x );
160 }
void SetFontItalic(const bool aItalic)
Set italic property of current font.
bool IsBold() const
Definition: eda_text.h:167
virtual void SetLineWidth(float aLineWidth)
Set the line width.
bool IsItalic() const
Definition: eda_text.h:164
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:223
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:61
void SetGlyphSize(const VECTOR2D aGlyphSize)
Set the font glyph size.
BASIC_GAL basic_gal(basic_displayOptions)
VECTOR2D GetTextLineSize(const UTF8 &aText, int aMarkupFlags=0) const
Compute the X and Y size of a given text.

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

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

◆ Load()

virtual bool SCH_ITEM::Load ( LINE_READER aLine,
wxString &  aErrorMsg 
)
inlinevirtualinherited

Function Load reads a schematic item from aLine in a .sch file.

Parameters
aLine- Essentially this is file to read the object from.
aErrorMsg- Description of the error if an error occurs while loading the object.
Returns
True if the object loaded successfully.

Definition at line 279 of file sch_item.h.

279 { return false; }

◆ MapHorizJustify()

EDA_TEXT_HJUSTIFY_T EDA_TEXT::MapHorizJustify ( int  aHorizJustify)
staticinherited

Definition at line 58 of file eda_text.cpp.

59 {
60  wxASSERT( aHorizJustify >= GR_TEXT_HJUSTIFY_LEFT && aHorizJustify <= GR_TEXT_HJUSTIFY_RIGHT );
61 
62  if( aHorizJustify > GR_TEXT_HJUSTIFY_RIGHT )
64 
65  if( aHorizJustify < GR_TEXT_HJUSTIFY_LEFT )
66  return GR_TEXT_HJUSTIFY_LEFT;
67 
68  return (EDA_TEXT_HJUSTIFY_T) aHorizJustify;
69 }
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:44

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

73 {
74  wxASSERT( aVertJustify >= GR_TEXT_VJUSTIFY_TOP && aVertJustify <= GR_TEXT_VJUSTIFY_BOTTOM );
75 
76  if( aVertJustify > GR_TEXT_VJUSTIFY_BOTTOM )
78 
79  if( aVertJustify < GR_TEXT_VJUSTIFY_TOP )
80  return GR_TEXT_VJUSTIFY_TOP;
81 
82  return (EDA_TEXT_VJUSTIFY_T) aVertJustify;
83 }
EDA_TEXT_VJUSTIFY_T
Definition: eda_text.h:51

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: base_struct.h:471
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:123

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 153 of file base_struct.cpp.

154 {
155  wxString text = aText;
156  wxString searchText = aSearchData.GetFindString();
157 
158  // Don't match if searching for replaceable item and the item doesn't support text replace.
159  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
160  return false;
161 
162  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
163  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
164 
165  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
166  {
167  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
168  return text.Matches( searchText );
169 
170  return text.MakeUpper().Matches( searchText.MakeUpper() );
171  }
172 
173  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
174  return aText.Find( searchText ) != wxNOT_FOUND;
175 
176  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
177 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:515

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

◆ MirrorX()

void SCH_TEXT::MirrorX ( int  aXaxis_position)
overridevirtualinherited

Function MirrorX mirrors item relative to the X axis about aXaxis_position.

Parameters
aXaxis_positionThe X axis position to mirror around.

Implements SCH_ITEM.

Definition at line 170 of file sch_text.cpp.

171 {
172  // Text is NOT really mirrored; it is moved to a suitable vertical position
174 
175  SetTextY( Mirror( GetTextPos().y, aXaxis_position ) );
176 }
void MirrorX(int aXaxis_position) override
Function MirrorX mirrors item relative to the X axis about aXaxis_position.
Definition: sch_text.cpp:170
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:238
T Mirror(T aPoint, T aMirrorRef)
Function MIRROR Mirror aPoint in aMirrorRef.
Definition: macros.h:118
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
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:210
void SetTextY(int aY)
Definition: eda_text.h:235

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

◆ MirrorY()

void SCH_TEXT::MirrorY ( int  aYaxis_position)
overridevirtualinherited

Function MirrorY mirrors item relative to the Y axis about aYaxis_position.

Parameters
aYaxis_positionThe Y axis position to mirror around.

Implements SCH_ITEM.

Definition at line 161 of file sch_text.cpp.

162 {
163  // Text is NOT really mirrored; it is moved to a suitable horizontal position
165 
166  SetTextX( Mirror( GetTextPos().x, aYaxis_position ) );
167 }
void SetTextX(int aX)
Definition: eda_text.h:234
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:238
T Mirror(T aPoint, T aMirrorRef)
Function MIRROR Mirror aPoint in aMirrorRef.
Definition: macros.h:118
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
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:210
void MirrorY(int aYaxis_position) override
Function MirrorY mirrors item relative to the Y axis about aYaxis_position.
Definition: sch_text.cpp:161

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

◆ Move()

void SCH_TEXT::Move ( const wxPoint aMoveVector)
inlineoverridevirtualinherited

Function Move moves the item by aMoveVector to a new position.

Parameters
aMoveVector= the displacement vector

Implements SCH_ITEM.

Definition at line 277 of file sch_text.h.

278  {
279  EDA_TEXT::Offset( aMoveVector );
280  }
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:237

References EDA_TEXT::Offset().

◆ Offset()

◆ operator<() [1/2]

bool SCH_ITEM::operator< ( const SCH_ITEM aItem) const
virtualinherited

Reimplemented in SCH_COMPONENT, and SCH_LINE.

Definition at line 172 of file sch_item.cpp.

173 {
174  wxCHECK_MSG( false, this->Type() < aItem.Type(),
175  wxT( "Less than operator not defined for " ) + GetClass() );
176 }
virtual wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_item.h:162
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References SCH_ITEM::GetClass(), 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 207 of file base_struct.cpp.

208 {
209  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
210  GetChars( GetClass() ) ) );
211 
212  return false;
213 }
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

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

◆ Plot()

void SCH_TEXT::Plot ( PLOTTER aPlotter)
overridevirtualinherited

Function Plot plots the schematic item to aPlotter.

Parameters
aPlotterA pointer to a PLOTTER object.

Reimplemented from SCH_ITEM.

Definition at line 489 of file sch_text.cpp.

490 {
491  static std::vector<wxPoint> Poly;
493  int tmp = GetThickness();
494  int thickness = GetPenSize();
495 
496  // Two thicknesses are set here:
497  // The first is for EDA_TEXT, which controls the interline spacing based on text thickness
498  // The second is for the output that sets the actual stroke size
499  SetThickness( thickness );
500  aPlotter->SetCurrentLineWidth( thickness );
501 
502  if( IsMultilineAllowed() )
503  {
504  std::vector<wxPoint> positions;
505  wxArrayString strings_list;
506  wxStringSplit( GetShownText(), strings_list, '\n' );
507  positions.reserve( strings_list.Count() );
508 
509  GetPositionsOfLinesOfMultilineText(positions, (int) strings_list.Count() );
510 
511  for( unsigned ii = 0; ii < strings_list.Count(); ii++ )
512  {
513  wxPoint textpos = positions[ii] + GetSchematicTextOffset();
514  wxString& txt = strings_list.Item( ii );
515  aPlotter->Text( textpos, color, txt, GetTextAngle(), GetTextSize(), GetHorizJustify(),
516  GetVertJustify(), thickness, IsItalic(), IsBold() );
517  }
518  }
519  else
520  {
521  wxPoint textpos = GetTextPos() + GetSchematicTextOffset();
522 
523  aPlotter->Text( textpos, color, GetShownText(), GetTextAngle(), GetTextSize(),
524  GetHorizJustify(), GetVertJustify(), thickness, IsItalic(), IsBold() );
525  }
526 
527  // Draw graphic symbol for global or hierarchical labels
528  CreateGraphicShape( Poly, GetTextPos() );
529 
530  aPlotter->SetCurrentLineWidth( GetPenSize() );
531 
532  if( Poly.size() )
533  aPlotter->PlotPoly( Poly, NO_FILL );
534 
535  SetThickness( tmp );
536 }
void wxStringSplit(const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
Split aString to a string list separated at aSplitter.
Definition: common.cpp:186
bool IsBold() const
Definition: eda_text.h:167
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:184
int GetPenSize() const override
Function GetPenSize virtual pure.
Definition: sch_text.cpp:266
int color
Definition: DXF_plotter.cpp:61
double GetTextAngle() const
Definition: eda_text.h:158
virtual wxPoint GetSchematicTextOffset() const
Definition: sch_text.cpp:137
int GetThickness() const
Return the pen width.
Definition: eda_text.h:148
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
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:232
bool IsItalic() const
Definition: eda_text.h:164
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:183
const wxSize & GetTextSize() const
Definition: eda_text.h:223
bool IsMultilineAllowed() const
Definition: eda_text.h:181
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:212
virtual void CreateGraphicShape(std::vector< wxPoint > &aPoints, const wxPoint &Pos)
Calculate the graphic shape (a polygon) associated to the text.
Definition: sch_text.h:264
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
void GetPositionsOfLinesOfMultilineText(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:384
virtual wxString GetShownText() const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:129
void SetThickness(int aNewThickness)
Set the pen width.
Definition: eda_text.h:143
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:39

References color, SCH_TEXT::CreateGraphicShape(), EDA_TEXT::GetHorizJustify(), SCH_ITEM::GetLayer(), GetLayerColor(), SCH_TEXT::GetPenSize(), EDA_TEXT::GetPositionsOfLinesOfMultilineText(), SCH_TEXT::GetSchematicTextOffset(), EDA_TEXT::GetShownText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetThickness(), EDA_TEXT::GetVertJustify(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMultilineAllowed(), NO_FILL, PLOTTER::PlotPoly(), PLOTTER::SetCurrentLineWidth(), EDA_TEXT::SetThickness(), PLOTTER::Text(), and wxStringSplit().

◆ Print() [1/2]

void EDA_TEXT::Print ( wxDC *  aDC,
const wxPoint aOffset,
COLOR4D  aColor,
EDA_DRAW_MODE_T  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 361 of file eda_text.cpp.

362 {
363  if( IsMultilineAllowed() )
364  {
365  std::vector<wxPoint> positions;
366  wxArrayString strings;
367  wxStringSplit( GetShownText(), strings, '\n' );
368 
369  positions.reserve( strings.Count() );
370 
371  GetPositionsOfLinesOfMultilineText( positions, strings.Count() );
372 
373  for( unsigned ii = 0; ii < strings.Count(); ii++ )
374  {
375  wxString& txt = strings.Item( ii );
376  printOneLineOfText( aDC, aOffset, aColor, aFillMode, txt, positions[ii] );
377  }
378  }
379  else
380  printOneLineOfText( aDC, aOffset, aColor, aFillMode, GetShownText(), GetTextPos() );
381 }
void wxStringSplit(const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
Split aString to a string list separated at aSplitter.
Definition: common.cpp:186
void printOneLineOfText(wxDC *aDC, const wxPoint &aOffset, COLOR4D aColor, EDA_DRAW_MODE_T aFillMode, const wxString &aText, const wxPoint &aPos)
Print each line of this EDA_TEXT.
Definition: eda_text.cpp:426
bool IsMultilineAllowed() const
Definition: eda_text.h:181
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
void GetPositionsOfLinesOfMultilineText(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:384
virtual wxString GetShownText() const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:129

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

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

◆ Print() [2/2]

void SCH_GLOBALLABEL::Print ( wxDC *  aDC,
const wxPoint aOffset 
)
overridevirtual

Function Print Print a schematic item.

Each schematic item should have its own method

Parameters
aDCDevice Context (can be null)
aOffsetdrawing Offset (usually wxPoint(0,0), but can be different when moving an object)

Reimplemented from SCH_TEXT.

Definition at line 812 of file sch_text.cpp.

813 {
814  static std::vector <wxPoint> Poly;
816  wxPoint text_offset = aOffset + GetSchematicTextOffset();
817 
818  int linewidth = GetThickness() == 0 ? GetDefaultLineThickness() : GetThickness();
819 
820  linewidth = Clamp_Text_PenSize( linewidth, GetTextSize(), IsBold() );
821 
822  int save_width = GetThickness();
823  SetThickness( linewidth );
824 
825  EDA_TEXT::Print( DC, text_offset, color );
826 
827  SetThickness( save_width ); // restore initial value
828 
829  CreateGraphicShape( Poly, GetTextPos() + aOffset );
830  GRPoly( nullptr, DC, Poly.size(), &Poly[0], 0, linewidth, color, color );
831 }
bool IsBold() const
Definition: eda_text.h:167
SCH_LAYER_ID m_Layer
Definition: sch_item.h:141
void GRPoly(EDA_RECT *ClipBox, wxDC *DC, int n, const wxPoint *Points, bool Fill, int width, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:542
int color
Definition: DXF_plotter.cpp:61
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
int GetThickness() const
Return the pen width.
Definition: eda_text.h:148
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
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:81
wxPoint GetSchematicTextOffset() const override
Definition: sch_text.cpp:726
const wxSize & GetTextSize() const
Definition: eda_text.h:223
void CreateGraphicShape(std::vector< wxPoint > &aPoints, const wxPoint &aPos) override
Calculate the graphic shape (a polygon) associated to the text.
Definition: sch_text.cpp:834
void Print(wxDC *aDC, const wxPoint &aOffset, COLOR4D aColor, EDA_DRAW_MODE_T aDisplay_mode=FILLED)
Print this text object to the device context aDC.
Definition: eda_text.cpp:361
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
void SetThickness(int aNewThickness)
Set the pen width.
Definition: eda_text.h:143
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References Clamp_Text_PenSize(), color, CreateGraphicShape(), GetDefaultLineThickness(), GetLayerColor(), GetSchematicTextOffset(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetThickness(), GRPoly(), EDA_TEXT::IsBold(), SCH_ITEM::m_Layer, EDA_TEXT::Print(), and EDA_TEXT::SetThickness().

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

145 {
146  return EDA_ITEM::Replace( aSearchData, m_text );
147 }
static bool Replace(wxFindReplaceData &aSearchData, wxString &aText)
Helper function used in search and replace dialog Function Replace performs a text replace on aText u...
wxString m_text
Definition: eda_text.h:366

References EDA_TEXT::m_text, and EDA_ITEM::Replace().

Referenced by SCH_SHEET_PIN::Replace(), SCH_FIELD::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:144

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 180 of file base_struct.cpp.

181 {
182  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
183 
184  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
185  aSearchData.GetFindString() :
186  aSearchData.GetFindString().Upper() );
187 
188  if( result == wxNOT_FOUND )
189  return false;
190 
191  wxString prefix = aText.Left( result );
192  wxString suffix;
193 
194  if( aSearchData.GetFindString().length() + result < aText.length() )
195  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
196 
197  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
198  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
199  GetChars( suffix ) );
200 
201  aText = prefix + aSearchData.GetReplaceString() + suffix;
202 
203  return true;
204 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101

References GetChars(), and traceFindReplace.

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

◆ Rotate()

void SCH_TEXT::Rotate ( wxPoint  aPosition)
overridevirtualinherited

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

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

Implements SCH_ITEM.

Definition at line 179 of file sch_text.cpp.

180 {
181  int dy = 0;
182 
183  wxPoint pt = GetTextPos();
184  RotatePoint( &pt, aPosition, 900 );
185  SetTextPos( pt );
186 
187  SetLabelSpinStyle( GetLabelSpinStyle().RotateCW() );
188 
189  if( this->Type() == SCH_TEXT_T )
190  {
191  switch( GetLabelSpinStyle() )
192  {
195  dy = GetTextHeight();
196  break;
199  default:
200  dy = 0;
201  dy = 0;
202  break;
203  }
204 
205  SetTextY( GetTextPos().y + dy );
206  }
207 }
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:231
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
int GetTextHeight() const
Definition: eda_text.h:229
LABEL_SPIN_STYLE GetLabelSpinStyle() const
Definition: sch_text.h:238
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
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:210
void SetTextY(int aY)
Definition: eda_text.h:235
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References LABEL_SPIN_STYLE::BOTTOM, SCH_TEXT::GetLabelSpinStyle(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextPos(), LABEL_SPIN_STYLE::LEFT, LABEL_SPIN_STYLE::RIGHT, RotatePoint(), SCH_TEXT_T, SCH_TEXT::SetLabelSpinStyle(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextY(), EDA_ITEM::Type(), and LABEL_SPIN_STYLE::UP.

◆ SetBold()

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 231 of file base_struct.h.

231 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:255
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ SetConnectivityDirty()

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

Definition at line 377 of file sch_item.h.

377 { m_connectivity_dirty = aDirty; }
bool m_connectivity_dirty
True if connectivity info might be out of date.
Definition: sch_item.h:153

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

126 {
127  m_e = aSrc.m_e;
128 }
TEXT_EFFECTS m_e
Definition: eda_text.h:385

References EDA_TEXT::m_e.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::ImportValues(), LIB_FIELD::operator=(), and TEXTE_MODULE::SetEffects().

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 255 of file base_struct.h.

255 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), PCBNEW_CONTROL::AppendBoard(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::CreateNewText(), LIB_PIN_TOOL::CreatePin(), SCH_EDIT_FRAME::CreateSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), LIB_DRAWING_TOOLS::DrawShape(), SCH_EDIT_TOOL::Duplicate(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_VIEW::HighlightItem(), EDIT_POINTS_FACTORY::Make(), TRACKS_CLEANER::mergeCollinearSegments(), SCH_MOVE_TOOL::moveItem(), LIB_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), EDA_ITEM::SetHighlighted(), 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_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::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 306 of file base_struct.h.

306 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:181

References EDA_ITEM::m_forceVisible.

◆ SetHighlighted()

void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 230 of file base_struct.h.

230 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:255
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

◆ SetHorizJustify()

◆ SetIsDangling()

void SCH_TEXT::SetIsDangling ( bool  aIsDangling)
inlineinherited

Definition at line 303 of file sch_text.h.

303 { 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:185

References SCH_TEXT::m_isDangling.

Referenced by SCH_EDIT_FRAME::ConvertTextType().

◆ 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 773 of file sch_text.cpp.

774 {
775  m_spin_style = aSpinStyle;
776 
777  switch( aSpinStyle )
778  {
779  default:
780  wxASSERT_MSG( 1, "Bad spin style" );
781  break;
782 
783  case LABEL_SPIN_STYLE::RIGHT: // Horiz Normal Orientation
784  //
785  m_spin_style = LABEL_SPIN_STYLE::RIGHT; // Handle the error spin style by resetting
789  break;
790 
791  case LABEL_SPIN_STYLE::UP: // Vert Orientation UP
795  break;
796 
797  case LABEL_SPIN_STYLE::LEFT: // Horiz Orientation
801  break;
802 
803  case LABEL_SPIN_STYLE::BOTTOM: // Vert Orientation BOTTOM
807  break;
808  }
809 }
void SetTextAngle(double aAngle)
Definition: eda_text.h:150
#define TEXT_ANGLE_HORIZ
#define TEXT_ANGLE_VERT
LABEL_SPIN_STYLE m_spin_style
The orientation of text and any associated drawing elements of derived objects.
Definition: sch_text.h:198
void SetVertJustify(EDA_TEXT_VJUSTIFY_T aType)
Definition: eda_text.h:187
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:186

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

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID  aLayer)
inlineinherited

Function SetLayer sets the layer this item is on.

Parameters
aLayerThe layer number.

Definition at line 219 of file sch_item.h.

219 { m_Layer = aLayer; }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:141

References SCH_ITEM::m_Layer.

Referenced by SCH_COMPONENT::Init(), SCH_FIELD::SCH_FIELD(), and SCH_NO_CONNECT::SCH_NO_CONNECT().

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

Function SetLocked modifies 'lock' status for of the item.

Definition at line 206 of file sch_item.h.

206 {}

◆ SetMirrored()

◆ SetModified()

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

180 { m_e.Bit( TE_MULTILINE, aAllow ); }
TEXT_EFFECTS m_e
Definition: eda_text.h:385
void Bit(int aBit, bool aValue)
Definition: eda_text.h:98

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

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

◆ SetParent()

◆ SetPosition()

void SCH_TEXT::SetPosition ( const wxPoint aPosition)
inlineoverridevirtualinherited

Function SetPosition set the schematic item position to aPosition.

Parameters
aPositionA reference to a wxPoint object containing the new position.

Implements SCH_ITEM.

Definition at line 316 of file sch_text.h.

316 { EDA_TEXT::SetTextPos( aPosition ); }
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:231

References EDA_TEXT::SetTextPos().

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_EAGLE_PLUGIN::adjustNetLabels(), and SCH_LINE_WIRE_BUS_TOOL::doDrawSegments().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )
inlineinherited

◆ SetShape()

void SCH_TEXT::SetShape ( PINSHEETLABEL_SHAPE  aShape)
inlineinherited

◆ SetState()

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

Definition at line 244 of file base_struct.h.

245  {
246  if( state )
247  m_Status |= type; // state = ON or OFF
248  else
249  m_Status &= ~type;
250  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

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 253 of file base_struct.h.

253 { m_Status = aStatus; }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( wxPoint  aPos)
inlineinherited

Definition at line 194 of file sch_item.h.

194 { m_storedPos = aPos; }
wxPoint m_storedPos
a temporary variable used in some move commands to store a initial pos (of the item or mouse cursor)
Definition: sch_item.h:143

References SCH_ITEM::m_storedPos.

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

◆ SetText()

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

Definition at line 111 of file eda_text.cpp.

112 {
113  m_text = aText;
114  m_shown_text = UnescapeString( aText );
115 }
wxString m_shown_text
Definition: eda_text.h:367
wxString m_text
Definition: eda_text.h:366
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:131

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

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_EDITOR_CONTROL::BackAnnotateFootprints(), LIB_TEXT::Clone(), LIB_EDIT_FRAME::CreateNewPart(), dummy(), KIGFX::dummy(), SCH_FIELD::GetBoundingBox(), LIB_FIELD::HitTest(), SCH_TEXT::IncrementLabel(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadLibrary(), LEGACY_PLUGIN::loadMODULE_TEXT(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), SCH_LEGACY_PLUGIN_CACHE::LoadPart(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN_CACHE::loadText(), TUNER_SLIDER::onSave(), LIB_FIELD::operator=(), EAGLE_PLUGIN::orientModuleText(), EAGLE_PLUGIN::packageText(), LIB_EDIT_TOOL::Paste(), LIB_PART::PlotLibFields(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), processTextItem(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SCREEN::SetComponentFootprint(), LIB_EDIT_FRAME::SetCurPart(), LIB_PART::SetName(), LIB_PART::SetParent(), SCH_COMPONENT::SetRef(), DIMENSION::SetText(), TEXT_MOD_GRID_TABLE::SetValue(), DIALOG_EDIT_SHEET_PIN::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_SPICE_MODEL::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), DIALOG_LIB_EDIT_ONE_FIELD::UpdateField(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), DIALOG_UPDATE_FIELDS::updateFields(), and SCH_COMPONENT::UpdateFields().

◆ SetTextAngle()

◆ SetTextHeight()

void EDA_TEXT::SetTextHeight ( int  aHeight)
inlineinherited

Definition at line 228 of file eda_text.h.

228 { m_e.size.y = aHeight; }
TEXT_EFFECTS m_e
Definition: eda_text.h:385
wxSize size
Definition: eda_text.h:93

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

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), LIB_FIELD::Init(), and TEXT_MOD_GRID_TABLE::SetValue().

◆ SetTextPos()

void EDA_TEXT::SetTextPos ( const wxPoint aPoint)
inlineinherited

Definition at line 231 of file eda_text.h.

231 { m_e.pos = aPoint; }
TEXT_EFFECTS m_e
Definition: eda_text.h:385
wxPoint pos
Definition: eda_text.h:96

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

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_TEXT::AddToBoard(), DIMENSION::AdjustDimensionDetails(), LIB_TEXT::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_TEXT::CalcEdit(), LIB_FIELD::CalcEdit(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), DIMENSION::Mirror(), SCH_COMPONENT::MirrorX(), SCH_COMPONENT::MirrorY(), LIB_TEXT::MoveTo(), LIB_FIELD::MoveTo(), EAGLE_PLUGIN::orientModuleText(), EAGLE_PLUGIN::packageText(), DRAWING_TOOL::PlaceText(), TEXTE_PCB::Rotate(), LIB_TEXT::Rotate(), TEXTE_MODULE::Rotate(), SCH_FIELD::Rotate(), LIB_FIELD::Rotate(), DIMENSION::Rotate(), SCH_TEXT::Rotate(), SCH_COMPONENT::Rotate(), SCH_FIELD::SCH_FIELD(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), SCH_SCREEN::SetComponentFootprint(), TEXTE_MODULE::SetDrawCoord(), TEXTE_PCB::SetPosition(), TEXTE_MODULE::SetPosition(), DIMENSION::SetPosition(), SCH_FIELD::SetPosition(), WS_DRAW_ITEM_TEXT::SetPosition(), SCH_TEXT::SetPosition(), SCH_COMPONENT::SetRef(), TEXTE_MODULE::TEXTE_MODULE(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_UPDATE_FIELDS::updateFields(), SCH_COMPONENT::UpdateFields(), DIALOG_EDIT_ONE_FIELD::updateText(), and WS_DRAW_ITEM_TEXT::WS_DRAW_ITEM_TEXT().

◆ SetTextSize()

void EDA_TEXT::SetTextSize ( const wxSize &  aNewSize)
inlineinherited

Definition at line 222 of file eda_text.h.

222 { m_e.size = aNewSize; };
TEXT_EFFECTS m_e
Definition: eda_text.h:385
wxSize size
Definition: eda_text.h:93

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

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_EDIT_FRAME::ConvertTextType(), PCB_EDIT_FRAME::CreateMuWaveBaseFootprint(), PCB_BASE_FRAME::CreateNewModule(), SCH_EDIT_FRAME::CreateNewText(), SCH_EDIT_FRAME::CreateSheetPin(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), dummy(), KIGFX::dummy(), EDA_TEXT::EDA_TEXT(), LIB_TEXT::LIB_TEXT(), 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_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAddField(), EAGLE_PLUGIN::orientModuleText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), DRAWING_TOOL::PlaceText(), SCH_SCREEN::SetComponentFootprint(), DIMENSION::SetTextSize(), PCAD2KICAD::SetTextSizeFromStrokeFontHeight(), PCAD2KICAD::SetTextSizeFromTrueTypeFontHeight(), DIALOG_EDIT_SHEET_PIN::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), DIALOG_UPDATE_FIELDS::updateFields(), DIALOG_EDIT_ONE_FIELD::updateText(), and WS_DRAW_ITEM_TEXT::WS_DRAW_ITEM_TEXT().

◆ SetTextWidth()

void EDA_TEXT::SetTextWidth ( int  aWidth)
inlineinherited

Definition at line 225 of file eda_text.h.

225 { m_e.size.x = aWidth; }
TEXT_EFFECTS m_e
Definition: eda_text.h:385
wxSize size
Definition: eda_text.h:93

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

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), LIB_FIELD::Init(), and TEXT_MOD_GRID_TABLE::SetValue().

◆ SetTextX()

◆ SetTextY()

◆ SetThickness()

◆ SetTimeStamp()

void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 212 of file base_struct.h.

212 { m_TimeStamp = aNewTimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:178

References EDA_ITEM::m_TimeStamp.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_FRAME::AddModuleToBoard(), BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), Diagnose(), SCH_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::EditFpInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), EDA_ITEM::initVars(), BOARD::InsertArea(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadPolygon(), SCH_EDIT_FRAME::LoadSheetFromFile(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), EDA_ITEM::operator=(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseDIMENSION(), SCH_EDITOR_CONTROL::Paste(), PCB_EDITOR_CONTROL::PlaceModule(), SCH_EDIT_TOOL::RepeatDrawItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), SwapItemData(), TestDuplicateSheetNames(), DIALOG_ERC::TestErc(), and TestMultiunitFootprints().

◆ SetVertJustify()

◆ SetVisible()

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 228 of file base_struct.h.

228 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:255
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:124

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ ShortenedShownText()

wxString EDA_TEXT::ShortenedShownText ( ) const
inherited

Returns a shortened version (max 15 characters) of the shown text.

Definition at line 163 of file eda_text.cpp.

164 {
165  wxString tmp = GetShownText();
166 
167  tmp.Replace( wxT( "\n" ), wxT( " " ) );
168  tmp.Replace( wxT( "\r" ), wxT( " " ) );
169  tmp.Replace( wxT( "\t" ), wxT( " " ) );
170 
171  if( tmp.Length() > 15 )
172  tmp = tmp.Left( 12 ) + wxT( "..." );
173 
174  return tmp;
175 }
virtual wxString GetShownText() const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:129

References EDA_TEXT::GetShownText().

Referenced by CONNECTION_GRAPH::ercCheckLabels(), LIB_TEXT::GetSelectMenuText(), TEXTE_PCB::GetSelectMenuText(), LIB_FIELD::GetSelectMenuText(), SCH_SHEET_PIN::GetSelectMenuText(), TEXTE_MODULE::GetSelectMenuText(), SCH_TEXT::GetSelectMenuText(), SCH_LABEL::GetSelectMenuText(), GetSelectMenuText(), and SCH_HIERLABEL::GetSelectMenuText().

◆ Sort()

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

Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters
aLeftThe left hand item to compare.
aRightThe right hand item to compare.
Returns
True if aLeft is less than aRight.

Definition at line 534 of file base_struct.h.

534 { return *aLeft < *aRight; }

◆ SwapData()

void SCH_TEXT::SwapData ( SCH_ITEM aItem)
overridevirtualinherited

Function SwapData swap the internal data structures aItem with the schematic item.

Obviously, aItem must have the same type than me

Parameters
aItemThe item to swap the data structures with.

Reimplemented from SCH_ITEM.

Definition at line 251 of file sch_text.cpp.

252 {
253  SCH_TEXT* item = (SCH_TEXT*) aItem;
254 
255  std::swap( m_Layer, item->m_Layer );
256 
257  std::swap( m_shape, item->m_shape );
258  std::swap( m_isDangling, item->m_isDangling );
259  std::swap( m_spin_style, item->m_spin_style );
260 
261  SwapText( *item );
262  SwapEffects( *item );
263 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:141
void SwapEffects(EDA_TEXT &aTradingPartner)
Swap the text effects of the two involved instances.
Definition: eda_text.cpp:138
LABEL_SPIN_STYLE m_spin_style
The orientation of text and any associated drawing elements of derived objects.
Definition: sch_text.h:198
bool m_isDangling
True if not connected to another object if the object derive from SCH_TEXT supports connections.
Definition: sch_text.h:185
void SwapText(EDA_TEXT &aTradingPartner)
Definition: eda_text.cpp:131
PINSHEETLABEL_SHAPE m_shape
Definition: sch_text.h:181

References SCH_TEXT::m_isDangling, SCH_ITEM::m_Layer, SCH_TEXT::m_shape, SCH_TEXT::m_spin_style, EDA_TEXT::SwapEffects(), and EDA_TEXT::SwapText().

Referenced by SCH_SHEET_PIN::SwapData().

◆ SwapEffects()

void EDA_TEXT::SwapEffects ( EDA_TEXT aTradingPartner)
inherited

Swap the text effects of the two involved instances.

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

Definition at line 138 of file eda_text.cpp.

139 {
140  std::swap( m_e, aTradingPartner.m_e );
141 }
TEXT_EFFECTS m_e
Definition: eda_text.h:385

References EDA_TEXT::m_e.

Referenced by SCH_FIELD::SwapData(), SCH_TEXT::SwapData(), and TEXTE_MODULE::SwapEffects().

◆ SwapText()

void EDA_TEXT::SwapText ( EDA_TEXT aTradingPartner)
inherited

Definition at line 131 of file eda_text.cpp.

132 {
133  std::swap( m_text, aTradingPartner.m_text );
134  std::swap( m_shown_text, aTradingPartner.m_shown_text );
135 }
wxString m_shown_text
Definition: eda_text.h:367
wxString m_text
Definition: eda_text.h:366

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

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

◆ TextHitTest() [1/2]

bool EDA_TEXT::TextHitTest ( const wxPoint aPoint,
int  aAccuracy = 0 
) const
virtualinherited

Test if aPoint is within the bounds of this object.

Parameters
aPoint-A wxPoint to test
aAccuracy- Amount to inflate the bounding box.
Returns
bool - true if a hit, else false

Reimplemented in TEXTE_MODULE.

Definition at line 336 of file eda_text.cpp.

337 {
338  EDA_RECT rect = GetTextBox( -1 ); // Get the full text area.
339  wxPoint location = aPoint;
340 
341  rect.Inflate( aAccuracy );
342  RotatePoint( &location, GetTextPos(), -GetTextAngle() );
343 
344  return rect.Contains( location );
345 }
double GetTextAngle() const
Definition: eda_text.h:158
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
bool Contains(const wxPoint &aPoint) const
Function Contains.
EDA_RECT GetTextBox(int aLine=-1, int aThickness=-1, bool aInvertY=false, int aMarkupFlags=0) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
Definition: eda_text.cpp:184
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References EDA_RECT::Contains(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextPos(), EDA_RECT::Inflate(), and RotatePoint().

Referenced by LIB_TEXT::HitTest(), TEXTE_PCB::HitTest(), LIB_FIELD::HitTest(), DIMENSION::HitTest(), and WS_DRAW_ITEM_TEXT::HitTest().

◆ TextHitTest() [2/2]

bool EDA_TEXT::TextHitTest ( const EDA_RECT aRect,
bool  aContains,
int  aAccuracy = 0 
) const
virtualinherited

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

Parameters
aRect- Rect to test against.
aContains- Test for containment instead of intersection if true.
aAccuracy- Amount to inflate the bounding box.
Returns
bool - true if a hit, else false

Reimplemented in TEXTE_MODULE.

Definition at line 348 of file eda_text.cpp.

349 {
350  EDA_RECT rect = aRect;
351 
352  rect.Inflate( aAccuracy );
353 
354  if( aContains )
355  return rect.Contains( GetTextBox( -1 ) );
356 
357  return rect.Intersects( GetTextBox( -1 ), GetTextAngle() );
358 }
double GetTextAngle() const
Definition: eda_text.h:158
bool Contains(const wxPoint &aPoint) const
Function Contains.
EDA_RECT GetTextBox(int aLine=-1, int aThickness=-1, bool aInvertY=false, int aMarkupFlags=0) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
Definition: eda_text.cpp:184
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.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References EDA_RECT::Contains(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextBox(), EDA_RECT::Inflate(), and EDA_RECT::Intersects().

◆ TransformBoundingBoxWithClearanceToPolygon()

void EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon ( SHAPE_POLY_SET aCornerBuffer,
int  aClearanceValue 
) const
inherited

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

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

Parameters
aCornerBuffer= a buffer to store the polygon
aClearanceValue= the clearance around the text bounding box to the real clearance value (usually near from 1.0)

Definition at line 337 of file board_items_to_polygon_shape_transform.cpp.

339 {
340  if( GetText().Length() == 0 )
341  return;
342 
343  wxPoint corners[4]; // Buffer of polygon corners
344 
345  EDA_RECT rect = GetTextBox( -1 );
346  rect.Inflate( aClearanceValue );
347  corners[0].x = rect.GetOrigin().x;
348  corners[0].y = rect.GetOrigin().y;
349  corners[1].y = corners[0].y;
350  corners[1].x = rect.GetRight();
351  corners[2].x = corners[1].x;
352  corners[2].y = rect.GetBottom();
353  corners[3].y = corners[2].y;
354  corners[3].x = corners[0].x;
355 
356  aCornerBuffer->NewOutline();
357 
358  for( wxPoint& corner : corners )
359  {
360  // Rotate polygon
361  RotatePoint( &corner.x, &corner.y, GetTextPos().x, GetTextPos().y, GetTextAngle() );
362  aCornerBuffer->Append( corner.x, corner.y );
363  }
364 }
double GetTextAngle() const
Definition: eda_text.h:158
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
int GetBottom() const
Definition: eda_rect.h:124
const wxPoint GetOrigin() const
Definition: eda_rect.h:114
EDA_RECT GetTextBox(int aLine=-1, int aThickness=-1, bool aInvertY=false, int aMarkupFlags=0) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
Definition: eda_text.cpp:184
int GetRight() const
Definition: eda_rect.h:121
int NewOutline()
Creates a new empty polygon in the set and returns its index
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:123
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline)

References SHAPE_POLY_SET::Append(), EDA_RECT::GetBottom(), EDA_RECT::GetOrigin(), EDA_RECT::GetRight(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextPos(), EDA_RECT::Inflate(), SHAPE_POLY_SET::NewOutline(), RotatePoint(), wxPoint::x, and wxPoint::y.

Referenced by ZONE_FILLER::addKnockout().

◆ TransformTextShapeToSegmentList()

void EDA_TEXT::TransformTextShapeToSegmentList ( std::vector< wxPoint > &  aCornerBuffer) const
inherited

Convert the text shape to a list of segment.

Each segment is stored as 2 wxPoints: the starting point and the ending point there are therefore 2*n points.

Parameters
aCornerBuffer= a buffer to store the polygon

Definition at line 544 of file eda_text.cpp.

545 {
546  wxSize size = GetTextSize();
547 
548  if( IsMirrored() )
549  size.x = -size.x;
550 
551  COLOR4D color = COLOR4D::BLACK; // not actually used, but needed by GRText
552 
553  if( IsMultilineAllowed() )
554  {
555  wxArrayString strings_list;
556  wxStringSplit( GetShownText(), strings_list, wxChar('\n') );
557  std::vector<wxPoint> positions;
558  positions.reserve( strings_list.Count() );
559  GetPositionsOfLinesOfMultilineText( positions,strings_list.Count() );
560 
561  for( unsigned ii = 0; ii < strings_list.Count(); ii++ )
562  {
563  wxString txt = strings_list.Item( ii );
564  GRText( NULL, positions[ii], color, txt, GetTextAngle(), size, GetHorizJustify(),
566  &aCornerBuffer );
567  }
568  }
569  else
570  {
573  &aCornerBuffer );
574  }
575 }
void wxStringSplit(const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
Split aString to a string list separated at aSplitter.
Definition: common.cpp:186
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:184
bool IsMirrored() const
Definition: eda_text.h:173
int color
Definition: DXF_plotter.cpp:61
static void addTextSegmToBuffer(int x0, int y0, int xf, int yf, void *aData)
Definition: eda_text.cpp:536
double GetTextAngle() const
Definition: eda_text.h:158
int GetThickness() const
Return the pen width.
Definition: eda_text.h:148
bool IsItalic() const
Definition: eda_text.h:164
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:183
#define NULL
const wxSize & GetTextSize() const
Definition: eda_text.h:223
bool IsMultilineAllowed() const
Definition: eda_text.h:181
void GRText(wxDC *aDC, const wxPoint &aPos, 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, void(*aCallback)(int x0, int y0, int xf, int yf, void *aData), void *aCallbackData, PLOTTER *aPlotter)
Function GRText Draw a graphic text (like module texts)
Definition: gr_text.cpp:143
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
void GetPositionsOfLinesOfMultilineText(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:384
virtual wxString GetShownText() const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:129
Definition: colors.h:45
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:123
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References addTextSegmToBuffer(), BLACK, color, EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetPositionsOfLinesOfMultilineText(), EDA_TEXT::GetShownText(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetThickness(), EDA_TEXT::GetVertJustify(), GRText(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsMultilineAllowed(), NULL, and wxStringSplit().

Referenced by PNS_KICAD_IFACE::syncTextItem(), and DRC::testCopperTextItem().

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

returns the type of object. This attribute should never be changed after a constructor sets it, so there is no public "setter" method.

Returns
KICAD_T - the type of object.

Definition at line 207 of file base_struct.h.

208  {
209  return m_StructType;
210  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:172

References EDA_ITEM::m_StructType.

Referenced by MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), CONNECTION_GRAPH::buildConnectionGraph(), SCH_SCREENS::buildScreenList(), calcArea(), calcMaxArea(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), TEXTE_PCB::ClassOf(), SCH_NO_CONNECT::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), SCH_PIN::ClassOf(), EDGE_MODULE::ClassOf(), PCB_TARGET::ClassOf(), SCH_LINE::ClassOf(), SCH_FIELD::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), MARKER_PCB::ClassOf(), ZONE_CONTAINER::ClassOf(), TRACK::ClassOf(), SCH_BITMAP::ClassOf(), DIMENSION::ClassOf(), NETINFO_ITEM::ClassOf(), SCH_SHEET_PIN::ClassOf(), MODULE::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_SCREEN::ClassOf(), D_PAD::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), BOARD::ClassOf(), SCH_TEXT::ClassOf(), SCH_SHEET::ClassOf(), VIA::ClassOf(), SCH_LABEL::ClassOf(), ClassOf(), SCH_HIERLABEL::ClassOf(), TRACKS_CLEANER::cleanupSegments(), LIB_RECTANGLE::compare(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), SCH_EDIT_FRAME::ConvertTextType(), MODULE::CoverageRatio(), CINFO3D_VISU::createLayers(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), NETLIST_EXPORTER::CreatePinList(), D_PAD::D_PAD(), SCH_SCREEN::DeleteItem(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDIT_TOOL::DoDelete(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), DRC::doTrackDrc(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), CN_ITEM::Dump(), SCH_ITEM::Duplicate(), BOARD::Duplicate(), MODULE::Duplicate(), SCH_EDIT_TOOL::EditField(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckLabels(), NETLIST_EXPORTER::findNextComponent(), EDIT_TOOL::FootprintFilter(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), PCBNEW_SELECTION::GetTopLeftItem(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_eda(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), KIGFX::SCH_VIEW::HighlightItem(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_MOVE_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_CONNECTION::Name(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), POINT_EDITOR::OnSelectionChange(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshItem(), SCH_BASE_FRAME::RefreshSelection(), EE_RTREE::remove(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), CONNECTION_SUBGRAPH::ResolveDrivers(), WS_PROXY_UNDO_ITEM::Restore(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), SELECTION_TOOL::select(), SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectConnectedTracks(), ITEM_PICKER::SetItem(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), ShowClearance(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), SCH_FIELD::SwapData(), TRACK::SwapData(), DIMENSION::SwapData(), VIA::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), D_PAD::SwapData(), SwapItemData(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), SCH_TEXT::UpdateDanglingState(), EE_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_SHEET::Visit(), SCH_COMPONENT::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ UpdateDanglingState()

bool SCH_TEXT::UpdateDanglingState ( std::vector< DANGLING_END_ITEM > &  aItemList)
overridevirtualinherited

Function IsDanglingStateChanged tests the schematic item to aItemList to check if it's dangling state has changed.

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

Parameters
aItemList- List of items to test item against.
Returns
True if the dangling state has changed from it's current setting.

Reimplemented from SCH_ITEM.

Definition at line 313 of file sch_text.cpp.

314 {
315  // Normal text labels cannot be tested for dangling ends.
316  if( Type() == SCH_TEXT_T )
317  return false;
318 
319  bool previousState = m_isDangling;
320  m_isDangling = true;
322 
323  for( unsigned ii = 0; ii < aItemList.size(); ii++ )
324  {
325  DANGLING_END_ITEM& item = aItemList[ii];
326 
327  if( item.GetItem() == this )
328  continue;
329 
330  switch( item.GetType() )
331  {
332  case PIN_END:
333  case LABEL_END:
334  case SHEET_LABEL_END:
335  case NO_CONNECT_END:
336  if( GetTextPos() == item.GetPosition() )
337  {
338  m_isDangling = false;
339 
340  if( item.GetType() != PIN_END )
341  m_connected_items.insert( static_cast< SCH_ITEM* >( item.GetItem() ) );
342  }
343 
344  break;
345 
346 
347  case BUS_START_END:
349  // fall through
350 
351  case WIRE_START_END:
352  {
353  // These schematic items have created 2 DANGLING_END_ITEM one per end. But being
354  // a paranoid programmer, I'll check just in case.
355  ii++;
356 
357  wxCHECK_MSG( ii < aItemList.size(), previousState != m_isDangling,
358  wxT( "Dangling end type list overflow. Bad programmer!" ) );
359 
360  DANGLING_END_ITEM & nextItem = aItemList[ii];
361  m_isDangling = !IsPointOnSegment( item.GetPosition(), nextItem.GetPosition(), GetTextPos() );
362 
363  if( !m_isDangling )
364  {
367 
368  // Add the line to the connected items, since it won't be picked
369  // up by a search of intersecting connection points
370  auto sch_item = static_cast< SCH_ITEM* >( item.GetItem() );
371  AddConnectionTo( sch_item );
372  sch_item->AddConnectionTo( this );
373  }
374  }
375  break;
376 
377  default:
378  break;
379  }
380 
381  if( !m_isDangling )
382  break;
383  }
384 
385  if( m_isDangling )
387 
388  return previousState != m_isDangling;
389 }
wxPoint GetPosition() const
Definition: sch_item.h:122
void AddConnectionTo(SCH_ITEM *aItem)
Adds a connection link between this item and another.
Definition: sch_item.cpp:144
bool m_isDangling
True if not connected to another object if the object derive from SCH_TEXT supports connections.
Definition: sch_text.h:185
bool IsPointOnSegment(const wxPoint &aSegStart, const wxPoint &aSegEnd, const wxPoint &aTestPoint)
Function IsPointOnSegment.
Definition: trigo.cpp:42
CONNECTION_TYPE m_connectionType
Definition: sch_text.h:187
std::unordered_set< SCH_ITEM * > m_connected_items
Stores pointers to other items that are connected to this one (schematic only)
Definition: sch_item.h:147
No connection to this item.
EDA_ITEM * GetItem() const
Definition: sch_item.h:123
This item represents a net.
DANGLING_END_T GetType() const
Definition: sch_item.h:125
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
DANGLING_END_ITEM is a helper class used to store the state of schematic items that can be connected ...
Definition: sch_item.h:67
This item represents a bus vector.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References SCH_ITEM::AddConnectionTo(), BUS, BUS_START_END,