KiCad PCB EDA Suite
SCH_FIELD Class Reference

SCH_FIELD instances are attached to a component and provide a place for the component's value, reference designator, footprint, and user definable name-value pairs of arbitrary purpose. More...

#include <sch_field.h>

Inheritance diagram for SCH_FIELD:
SCH_ITEM EDA_TEXT EDA_ITEM KIGFX::VIEW_ITEM INSPECTABLE

Public Member Functions

 SCH_FIELD (const wxPoint &aPos, int aFieldId, SCH_ITEM *aParent, const wxString &aName=wxEmptyString)
 
 ~SCH_FIELD ()
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
bool IsType (const KICAD_T aScanTypes[]) const override
 Function IsType Checks whether the item is one of the listed types. More...
 
wxString GetName (bool aUseDefaultName=true) const
 Function GetName returns the field name. More...
 
wxString GetCanonicalName () const
 Get a non-language-specific name for a field which can be used for storage, variable look-up, etc. More...
 
void SetName (const wxString &aName)
 
int GetId () const
 
void SetId (int aId)
 
wxString GetShownText (int aDepth=0) const override
 Return the string actually shown after processing of the base text. More...
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
bool IsHorizJustifyFlipped () const
 Function IsHorizJustifyFlipped Returns whether the field will be rendered with the horizontal justification inverted due to rotation or mirroring of the parent. More...
 
bool IsVoid () const
 Function IsVoid returns true if the field is either empty or holds "~". More...
 
void SwapData (SCH_ITEM *aItem) override
 Swap the internal data structures aItem with the schematic item. More...
 
void ImportValues (const LIB_FIELD &aSource)
 Function ImportValues copy parameters from a LIB_FIELD source. More...
 
int GetPenWidth () const override
 
void Print (RENDER_SETTINGS *aSettings, const wxPoint &aOffset) override
 Print a schematic item. More...
 
void Move (const wxPoint &aMoveVector) override
 Move the item by aMoveVector to a new position. More...
 
void Rotate (wxPoint aPosition) override
 Rotate the item around aPosition 90 degrees in the clockwise direction. More...
 
void MirrorX (int aXaxis_position) override
 Mirror item relative to the X axis about aXaxis_position. More...
 
void MirrorY (int aYaxis_position) override
 Mirror item relative to the Y axis about aYaxis_position. More...
 
bool Matches (wxFindReplaceData &aSearchData, void *aAuxData) override
 Function Matches compares the item against the search criteria in aSearchData. More...
 
bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL) override
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
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...
 
bool IsReplaceable () const override
 Function IsReplaceable. More...
 
wxPoint GetLibPosition () const
 
wxPoint GetPosition () const override
 
void SetPosition (const wxPoint &aPosition) override
 
wxPoint GetParentPosition () const
 
bool HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
 Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
 
void Plot (PLOTTER *aPlotter) override
 Plot the schematic item to aPlotter. More...
 
EDA_ITEMClone () const override
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
bool operator< (const SCH_ITEM &aItem) const override
 
SCH_ITEMDuplicate (bool doClone=false) const
 Routine to create a new copy of given item. More...
 
virtual bool IsMovableFromAnchorPoint ()
 
wxPoint & GetStoredPos ()
 
void SetStoredPos (wxPoint aPos)
 
SCHEMATICSchematic () const
 Searches the item hierarchy to find a SCHEMATIC. More...
 
virtual bool IsLocked () const
 
virtual void SetLocked (bool aLocked)
 Set the 'lock' status to aLocked for of this item. More...
 
SCH_LAYER_ID GetLayer () const
 Return the layer this item is on. More...
 
void SetLayer (SCH_LAYER_ID aLayer)
 Set the layer this item is on. More...
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Return the layers the item is drawn on (which may be more than its "home" layer) More...
 
virtual void GetEndPoints (std::vector< DANGLING_END_ITEM > &aItemList)
 Add the schematic item end points to aItemList if the item has end points. More...
 
virtual bool UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemList, const SCH_SHEET_PATH *aPath=nullptr)
 Test the schematic item to aItemList to check if it's dangling state has changed. More...
 
virtual bool IsDangling () const
 
virtual bool CanConnect (const SCH_ITEM *aItem) const
 
virtual bool IsConnectable () const
 
virtual bool IsPointClickableAnchor (const wxPoint &aPos) const
 
virtual std::vector< wxPoint > GetConnectionPoints () const
 Add all the connection points for this item to aPoints. More...
 
void ClearConnections ()
 Clears all of the connection items from the list. More...
 
bool IsConnected (const wxPoint &aPoint) const
 Test the item to see if it is connected to aPoint. More...
 
SCH_CONNECTIONConnection (const SCH_SHEET_PATH *aSheet=nullptr) const
 Retrieve the connection associated with this object in the given sheet. More...
 
SCH_ITEM_SETConnectedItems (const SCH_SHEET_PATH &aPath)
 Retrieves the set of items connected to this item on the given sheet. More...
 
void AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
 Adds a connection link between this item and another. More...
 
SCH_CONNECTIONInitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
 Creates a new connection object associated with this object. More...
 
virtual bool ConnectionPropagatesTo (const EDA_ITEM *aItem) const
 Returns true if this item should propagate connection info to aItem. More...
 
bool IsConnectivityDirty ()
 
void SetConnectivityDirty (bool aDirty=true)
 
NETCLASSPTR NetClass (const SCH_SHEET_PATH *aSheet=nullptr) const
 
FIELDS_AUTOPLACED GetFieldsAutoplaced () const
 Return whether the fields have been automatically placed. More...
 
void ClearFieldsAutoplaced ()
 Set fields automatically placed flag false. More...
 
void AutoAutoplaceFields (SCH_SCREEN *aScreen)
 Autoplace fields only if correct to do so automatically. More...
 
virtual void AutoplaceFields (SCH_SCREEN *aScreen, bool aManual)
 
virtual bool HasLineStroke () const
 Check if this schematic item has line stoke properties. More...
 
virtual STROKE_PARAMS GetStroke () const
 
virtual void SetStroke (const STROKE_PARAMS &aStroke)
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
KICAD_T Type () const
 Function Type() More...
 
EDA_ITEMGetParent () const
 
virtual void SetParent (EDA_ITEM *aParent)
 
bool IsModified () const
 
bool IsNew () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool HasFlag (STATUS_FLAGS aFlag)
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
bool IsForceVisible () const
 
virtual void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
virtual const wxPoint GetFocusPosition () const
 Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor. 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 double ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
bool Set (PROPERTY_BASE *aProperty, wxAny &aValue)
 
template<typename T >
bool Set (PROPERTY_BASE *aProperty, T aValue)
 
template<typename T >
bool Set (const wxString &aProperty, T aValue)
 
wxAny Get (PROPERTY_BASE *aProperty)
 
template<typename T >
Get (PROPERTY_BASE *aProperty)
 
template<typename T >
boost::optional< T > Get (const wxString &aProperty)
 
virtual const wxString & GetText () const
 Return the string associated with the text object. More...
 
wxString GetShownText (bool *processTextVars) const
 A version of GetShownText() which also indicates whether or not the text needs to be processed for text variables. More...
 
wxString ShortenedShownText () const
 Returns a shortened version (max 15 characters) of the shown text. More...
 
virtual void SetText (const wxString &aText)
 
void SetTextThickness (int aWidth)
 The TextThickness is that set by the user. More...
 
int GetTextThickness () const
 
int GetEffectiveTextPenWidth (int aDefaultWidth=0) const
 The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth. More...
 
virtual void SetTextAngle (double aAngle)
 
double GetTextAngle () const
 
double GetTextAngleDegrees () const
 
double GetTextAngleRadians () const
 
void SetItalic (bool isItalic)
 
bool IsItalic () const
 
void SetBold (bool aBold)
 
bool IsBold () const
 
void SetVisible (bool aVisible)
 
bool IsVisible () const
 
void SetMirrored (bool isMirrored)
 
bool IsMirrored () const
 
void SetMultilineAllowed (bool aAllow)
 
bool IsMultilineAllowed () const
 
EDA_TEXT_HJUSTIFY_T GetHorizJustify () const
 
EDA_TEXT_VJUSTIFY_T GetVertJustify () const
 
void SetHorizJustify (EDA_TEXT_HJUSTIFY_T aType)
 
void SetVertJustify (EDA_TEXT_VJUSTIFY_T aType)
 
void SetEffects (const EDA_TEXT &aSrc)
 Set the text effects from another instance. More...
 
void SwapEffects (EDA_TEXT &aTradingPartner)
 Swap the text effects of the two involved instances. More...
 
void SwapText (EDA_TEXT &aTradingPartner)
 
void CopyText (const EDA_TEXT &aSrc)
 
bool Replace (wxFindReplaceData &aSearchData)
 Helper function used in search and replace dialog. More...
 
bool IsDefaultFormatting () const
 
void SetTextSize (const wxSize &aNewSize)
 
const wxSize & GetTextSize () const
 
void SetTextWidth (int aWidth)
 
int GetTextWidth () const
 
void SetTextHeight (int aHeight)
 
int GetTextHeight () const
 
void SetTextPos (const wxPoint &aPoint)
 
const wxPoint & GetTextPos () const
 
void SetTextX (int aX)
 
void SetTextY (int aY)
 
void Offset (const wxPoint &aOffset)
 
void Empty ()
 
void Print (RENDER_SETTINGS *aSettings, const wxPoint &aOffset, COLOR4D aColor, OUTLINE_MODE aDisplay_mode=FILLED)
 Print this text object to the device context aDC. More...
 
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...
 
std::shared_ptr< SHAPE_COMPOUNDGetEffectiveTextShape () const
 
virtual bool TextHitTest (const wxPoint &aPoint, int aAccuracy=0) const
 Test if aPoint is within the bounds of this object. More...
 
virtual bool TextHitTest (const EDA_RECT &aRect, bool aContains, int aAccuracy=0) const
 Test if object bounding box is contained within or intersects aRect. More...
 
int LenSize (const wxString &aLine, int aThickness) const
 
EDA_RECT GetTextBox (int aLine=-1, bool aInvertY=false) const
 Useful in multiline texts to calculate the full text or a line area (for zones filling, locate functions....) More...
 
int GetInterline () const
 Return the distance between two lines of text. More...
 
wxString GetTextStyleName () const
 
void GetLinePositions (std::vector< wxPoint > &aPositions, int aLineCount) const
 Populate aPositions with the position of each line of a multiline text, according to the vertical justification and the rotation of the whole text. More...
 
virtual void Format (OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
 Output the object to aFormatter in s-expression form. More...
 
virtual double GetDrawRotation () const
 

Static Public Member Functions

static bool ClassOf (const EDA_ITEM *aItem)
 
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 Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 
static EDA_TEXT_HJUSTIFY_T MapHorizJustify (int aHorizJustify)
 
static EDA_TEXT_VJUSTIFY_T MapVertJustify (int aVertJustify)
 

Public Attributes

const KIID m_Uuid
 

Protected Member Functions

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

Protected Attributes

SCH_LAYER_ID m_Layer
 
EDA_ITEMS m_connections
 
FIELDS_AUTOPLACED m_fieldsAutoplaced
 
wxPoint m_storedPos
 
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SETm_connected_items
 Stores pointers to other items that are connected to this one, per sheet. More...
 
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
 Stores connectivity information, per sheet. More...
 
bool m_connectivity_dirty
 True if connectivity info might be out of date. More...
 
STATUS_FLAGS m_Status
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
STATUS_FLAGS m_Flags
 

Private Attributes

int m_id
 Field index,. More...
 
wxString m_name
 

Detailed Description

SCH_FIELD instances are attached to a component and provide a place for the component's value, reference designator, footprint, and user definable name-value pairs of arbitrary purpose.

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

Definition at line 52 of file sch_field.h.

Constructor & Destructor Documentation

◆ SCH_FIELD()

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

Definition at line 50 of file sch_field.cpp.

51  :
52  SCH_ITEM( aParent, SCH_FIELD_T ),
53  EDA_TEXT( wxEmptyString ),
54  m_id( 0 ),
55  m_name( aName )
56 {
57  SetTextPos( aPos );
58  SetId( aFieldId ); // will also set the layer
59  SetVisible( false );
60 }
EDA_TEXT(const wxString &text=wxEmptyString)
Definition: eda_text.cpp:90
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
void SetVisible(bool aVisible)
Definition: eda_text.h:191
wxString m_name
Definition: sch_field.h:56
void SetId(int aId)
Definition: sch_field.cpp:74
int m_id
Field index,.
Definition: sch_field.h:54
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:47

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

Referenced by Clone().

◆ ~SCH_FIELD()

SCH_FIELD::~SCH_FIELD ( )

Definition at line 63 of file sch_field.cpp.

64 {
65 }

Member Function Documentation

◆ AddConnectionTo()

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

Adds a connection link between this item and another.

Definition at line 186 of file sch_item.cpp.

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

References SCH_ITEM::m_connected_items.

Referenced by SCH_TEXT::UpdateDanglingState().

◆ AutoAutoplaceFields()

void SCH_ITEM::AutoAutoplaceFields ( SCH_SCREEN aScreen)
inlineinherited

Autoplace fields only if correct to do so automatically.

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

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

Definition at line 462 of file sch_item.h.

463  {
464  if( GetFieldsAutoplaced() )
466  }
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition: sch_item.h:447
virtual void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Definition: sch_item.h:468

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

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

◆ AutoplaceFields()

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

Reimplemented in SCH_SHEET, and SCH_COMPONENT.

Definition at line 468 of file sch_item.h.

468 { }

Referenced by SCH_ITEM::AutoAutoplaceFields().

◆ CanConnect()

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

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_HIERLABEL, SCH_GLOBALLABEL, SCH_LABEL, SCH_LINE, SCH_BUS_BUS_ENTRY, SCH_BUS_WIRE_ENTRY, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 372 of file sch_item.h.

372 { return m_Layer == aItem->GetLayer(); }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:199
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:279

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

Referenced by SCH_MOVE_TOOL::getConnectedDragItems().

◆ ClassOf()

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

Definition at line 66 of file sch_field.h.

67  {
68  return aItem && SCH_FIELD_T == aItem->Type();
69  }
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

References SCH_FIELD_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

◆ ClearConnections()

void SCH_ITEM::ClearConnections ( )
inlineinherited

Clears all of the connection items from the list.

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

Definition at line 399 of file sch_item.h.

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

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )
inlineinherited

Set fields automatically placed flag false.

Definition at line 452 of file sch_item.h.

FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

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

◆ ClearFlags()

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

Definition at line 222 of file eda_item.h.

222 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Definition: eda_item.h:165

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), MODULE::BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), LIB_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), 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_FRAME::RecomputeIntersheetsRefs(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::RollbackPartFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 234 of file eda_item.h.

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

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 154 of file view_item.h.

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

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

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

◆ Clone()

EDA_ITEM * SCH_FIELD::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 EDA_ITEM.

Definition at line 68 of file sch_field.cpp.

69 {
70  return new SCH_FIELD( *this );
71 }
SCH_FIELD(const wxPoint &aPos, int aFieldId, SCH_ITEM *aParent, const wxString &aName=wxEmptyString)
Definition: sch_field.cpp:50

References SCH_FIELD().

◆ ConnectedItems()

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

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

Definition at line 180 of file sch_item.cpp.

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

References SCH_ITEM::m_connected_items.

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

◆ Connection()

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

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

Note
The returned value can be nullptr.

Definition at line 147 of file sch_item.cpp.

148 {
149  if( !aSheet )
150  aSheet = &Schematic()->CurrentSheet();
151 
152  auto it = m_connection_map.find( *aSheet );
153 
154  if( it == m_connection_map.end() )
155  return nullptr;
156  else
157  return it->second;
158 }
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:113
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Stores connectivity information, per sheet.
Definition: sch_item.h:209
SCH_SHEET_PATH & CurrentSheet() const
Definition: schematic.h:121

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

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

◆ ConnectionPropagatesTo()

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

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

Reimplemented in SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 436 of file sch_item.h.

436 { return true; }

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT aSrc)
inherited

Definition at line 128 of file eda_text.cpp.

129 {
130  m_text = aSrc.m_text;
131  m_shown_text = aSrc.m_shown_text;
133 }
wxString m_shown_text
Definition: eda_text.h:380
bool m_shown_text_has_text_var_refs
Definition: eda_text.h:381
wxString m_text
Definition: eda_text.h:379

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

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

◆ Duplicate()

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

Routine to create a new copy of given item.

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

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

Definition at line 78 of file sch_item.cpp.

79 {
80  SCH_ITEM* newItem = (SCH_ITEM*) Clone();
81 
82  if( !doClone )
83  const_cast<KIID&>( newItem->m_Uuid ) = KIID();
84 
85  newItem->ClearFlags( SELECTED | BRIGHTENED );
86 
87  if( newItem->Type() == SCH_COMPONENT_T )
88  {
89  SCH_COMPONENT* component = (SCH_COMPONENT*) newItem;
90 
91  for( SCH_PIN* pin : component->GetPins() )
92  pin->ClearFlags( SELECTED | BRIGHTENED );
93 
94  for( SCH_FIELD& field : component->GetFields() )
95  field.ClearFlags( SELECTED | BRIGHTENED );
96  }
97 
98  if( newItem->Type() == SCH_SHEET_T )
99  {
100  SCH_SHEET* sheet = (SCH_SHEET*) newItem;
101 
102  for( SCH_FIELD& field : sheet->GetFields() )
103  field.ClearFlags( SELECTED | BRIGHTENED );
104 
105  for( SCH_SHEET_PIN* pin : sheet->GetPins() )
106  pin->ClearFlags( SELECTED | BRIGHTENED );
107  }
108 
109  return newItem;
110 }
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.
Definition: eda_item.cpp:97
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populates a std::vector with SCH_FIELDs.
std::vector< SCH_FIELD > & GetFields()
Definition: sch_sheet.h:270
Definition: kiid.h:44
#define BRIGHTENED
item is drawn with a bright contour
Definition: eda_item.h:128
#define SELECTED
Definition: eda_item.h:113
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85
std::vector< SCH_PIN * > GetPins(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieves a list of the SCH_PINs for the given sheet path.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:219
const KIID m_Uuid
Definition: eda_item.h:151
std::vector< SCH_SHEET_PIN * > & GetPins()
Definition: sch_sheet.h:364
Schematic symbol object.
Definition: sch_component.h:79
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:222
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

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

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

◆ Empty()

void EDA_TEXT::Empty ( )
inlineinherited

Definition at line 261 of file eda_text.h.

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

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

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

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

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

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 84 of file inspectable.h.

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

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

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

◆ Get() [2/3]

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

Definition at line 93 of file inspectable.h.

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

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

◆ Get() [3/3]

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

Definition at line 102 of file inspectable.h.

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

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

◆ GetBoundingBox()

const EDA_RECT SCH_FIELD::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 EDA_ITEM.

Definition at line 250 of file sch_field.cpp.

251 {
252  // Calculate the text bounding box:
253  EDA_RECT rect = GetTextBox();
254 
255  // Calculate the bounding box position relative to the parent:
256  wxPoint origin = GetParentPosition();
257  wxPoint pos = GetTextPos() - origin;
258  wxPoint begin = rect.GetOrigin() - origin;
259  wxPoint end = rect.GetEnd() - origin;
260  RotatePoint( &begin, pos, GetTextAngle() );
261  RotatePoint( &end, pos, GetTextAngle() );
262 
263  // Now, apply the component transform (mirror/rot)
264  TRANSFORM transform;
265 
266  if( m_Parent && m_Parent->Type() == SCH_COMPONENT_T )
267  {
268  SCH_COMPONENT* parentComponent = static_cast<SCH_COMPONENT*>( m_Parent );
269 
270  // Due to the Y axis direction, we must mirror the bounding box,
271  // relative to the text position:
272  MIRROR( begin.y, pos.y );
273  MIRROR( end.y, pos.y );
274 
275  transform = parentComponent->GetTransform();
276  }
277  else
278  {
279  transform = TRANSFORM( 1, 0, 0, 1 ); // identity transform
280  }
281 
282  rect.SetOrigin( transform.TransformCoordinate( begin ) );
283  rect.SetEnd( transform.TransformCoordinate( end ) );
284 
285  rect.Move( origin );
286  rect.Normalize();
287 
288  return rect;
289 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
void Move(const wxPoint &aMoveVector)
Function Move moves the rectangle by the aMoveVector.
Definition: eda_rect.cpp:51
EDA_RECT GetTextBox(int aLine=-1, bool aInvertY=false) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
Definition: eda_text.cpp:222
double GetTextAngle() const
Definition: eda_text.h:180
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:131
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:136
const wxPoint GetEnd() const
Definition: eda_rect.h:116
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
const wxPoint GetOrigin() const
Definition: eda_rect.h:114
TRANSFORM & GetTransform() const
void SetEnd(int x, int y)
Definition: eda_rect.h:192
void Normalize()
Function Normalize ensures that the height ant width are positive.
Definition: eda_rect.cpp:35
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
Schematic symbol object.
Definition: sch_component.h:79
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
wxPoint GetParentPosition() const
Definition: sch_field.cpp:617
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

References EDA_RECT::GetEnd(), EDA_RECT::GetOrigin(), GetParentPosition(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextPos(), SCH_COMPONENT::GetTransform(), EDA_ITEM::m_Parent, MIRROR(), EDA_RECT::Move(), EDA_RECT::Normalize(), RotatePoint(), SCH_COMPONENT_T, EDA_RECT::SetEnd(), EDA_RECT::SetOrigin(), TRANSFORM::TransformCoordinate(), and EDA_ITEM::Type().

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

◆ GetCanonicalName()

wxString SCH_FIELD::GetCanonicalName ( ) const

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

Definition at line 456 of file sch_field.cpp.

457 {
458  if( m_Parent && m_Parent->Type() == SCH_COMPONENT_T )
459  {
460  switch( m_id )
461  {
462  case REFERENCE: return wxT( "Reference" );
463  case VALUE: return wxT( "Value" );
464  case FOOTPRINT: return wxT( "Footprint" );
465  case DATASHEET: return wxT( "Datasheet" );
466  }
467  }
468  else if( m_Parent && m_Parent->Type() == SCH_SHEET_T )
469  {
470  switch( m_id )
471  {
472  case SHEETNAME: return wxT( "Sheetname" );
473  case SHEETFILENAME: return wxT( "Sheetfile" );
474  }
475  }
476 
477  return m_name;
478 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
name of datasheet
wxString m_name
Definition: sch_field.h:56
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
Field Value of part, i.e. "3.3K".
int m_id
Field index,.
Definition: sch_field.h:54
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

References DATASHEET, FOOTPRINT, m_id, m_name, EDA_ITEM::m_Parent, REFERENCE, SCH_COMPONENT_T, SCH_SHEET_T, SHEETFILENAME, SHEETNAME, EDA_ITEM::Type(), and VALUE.

Referenced by SCH_COMPONENT::UpdateFields().

◆ GetClass()

wxString SCH_FIELD::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from SCH_ITEM.

Definition at line 71 of file sch_field.h.

72  {
73  return wxT( "SCH_FIELD" );
74  }

Referenced by SCH_EDIT_TOOL::Properties().

◆ GetConnectionPoints()

virtual std::vector<wxPoint> SCH_ITEM::GetConnectionPoints ( ) const
inlinevirtualinherited

Add all the connection points for this item to aPoints.

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

Parameters
aPointsList of connection points to add to.

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_TEXT, SCH_LINE, SCH_BUS_ENTRY_BASE, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 391 of file sch_item.h.

391 { return {}; }

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), EE_GRID_HELPER::computeAnchors(), SCH_EDIT_TOOL::DoDelete(), and SCH_MOVE_TOOL::Main().

◆ GetDrawRotation()

double EDA_TEXT::GetDrawRotation ( ) const
virtualinherited

Reimplemented in FP_TEXT.

Definition at line 634 of file eda_text.cpp.

635 {
636  return GetTextAngle();
637 }
double GetTextAngle() const
Definition: eda_text.h:180

References EDA_TEXT::GetTextAngle().

Referenced by EDA_TEXT::TransformTextShapeToSegmentList().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 226 of file eda_item.h.

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

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

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

◆ GetEffectiveTextPenWidth()

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

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

Definition at line 156 of file eda_text.cpp.

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

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

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

◆ GetEffectiveTextShape()

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

Definition at line 620 of file eda_text.cpp.

621 {
622  std::shared_ptr<SHAPE_COMPOUND> shape ( new SHAPE_COMPOUND );
623  int penWidth = GetEffectiveTextPenWidth();
624  std::vector<wxPoint> pts;
626 
627  for( unsigned jj = 0; jj < pts.size(); jj += 2 )
628  shape->AddShape( new SHAPE_SEGMENT( pts[jj], pts[jj+1], penWidth ) );
629 
630  return shape;
631 }
int GetEffectiveTextPenWidth(int aDefaultWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth.
Definition: eda_text.cpp:156
void TransformTextShapeToSegmentList(std::vector< wxPoint > &aCornerBuffer) const
Convert the text shape to a list of segment.
Definition: eda_text.cpp:583

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

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

◆ GetEndPoints()

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

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

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

Parameters
aItemList- List of DANGLING_END_ITEMS to add to.

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_TEXT, SCH_LINE, SCH_BUS_BUS_ENTRY, SCH_SHEET_PIN, SCH_BUS_WIRE_ENTRY, SCH_JUNCTION, and SCH_NO_CONNECT.

Definition at line 346 of file sch_item.h.

346 {}

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const
inlineinherited

Return whether the fields have been automatically placed.

Definition at line 447 of file sch_item.h.

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

References SCH_ITEM::m_fieldsAutoplaced.

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

◆ GetFlags()

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and TRACK.

Definition at line 334 of file eda_item.h.

334 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: eda_item.h:326

References EDA_ITEM::GetPosition().

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

◆ GetHorizJustify()

EDA_TEXT_HJUSTIFY_T EDA_TEXT::GetHorizJustify ( ) const
inlineinherited

Definition at line 205 of file eda_text.h.

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

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

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), export_vrml_pcbtext(), export_vrml_text_module(), AUTOPLACER::field_horiz_placement(), PCB_TEXT::Flip(), FP_TEXT::Flip(), EDA_TEXT::Format(), EDA_TEXT::GetTextBox(), hash_eda(), EDA_TEXT::IsDefaultFormatting(), IsHorizJustifyFlipped(), FP_TEXT::KeepUpright(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), positioningChanged(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), LIB_TEXT::Rotate(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), KIGFX::GAL::SetTextAttributes(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_TEXT::TransformShapeWithClearanceToPolygonSet(), EDA_TEXT::TransformTextShapeToSegmentList(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

◆ GetId()

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

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

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

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

◆ GetLayer()

◆ GetLibPosition()

wxPoint SCH_FIELD::GetLibPosition ( ) const
inline

Definition at line 188 of file sch_field.h.

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

References EDA_TEXT::GetTextPos().

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

◆ GetLinePositions()

void EDA_TEXT::GetLinePositions ( std::vector< wxPoint > &  aPositions,
int  aLineCount 
) const
inherited

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

Parameters
aPositionsis the list to populate by the wxPoint positions
aLineCountis the number of lines (not recalculated here for efficiency reasons

Definition at line 423 of file eda_text.cpp.

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

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

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

◆ GetMenuImage()

BITMAP_DEF SCH_FIELD::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 EDA_ITEM.

Definition at line 481 of file sch_field.cpp.

482 {
483  if( m_Parent && m_Parent->Type() == SCH_COMPONENT_T )
484  {
485  switch( m_id )
486  {
487  case REFERENCE: return edit_comp_ref_xpm;
488  case VALUE: return edit_comp_value_xpm;
489  case FOOTPRINT: return edit_comp_footprint_xpm;
490  default: return edit_text_xpm;
491  }
492  }
493 
494  return edit_text_xpm;
495 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
const BITMAP_OPAQUE edit_comp_value_xpm[1]
const BITMAP_OPAQUE edit_comp_ref_xpm[1]
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
Field Value of part, i.e. "3.3K".
const BITMAP_OPAQUE edit_comp_footprint_xpm[1]
int m_id
Field index,.
Definition: sch_field.h:54
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182
const BITMAP_OPAQUE edit_text_xpm[1]
Definition: edit_text.cpp:59

References edit_comp_footprint_xpm, edit_comp_ref_xpm, edit_comp_value_xpm, edit_text_xpm, FOOTPRINT, m_id, EDA_ITEM::m_Parent, REFERENCE, SCH_COMPONENT_T, EDA_ITEM::Type(), and VALUE.

◆ GetMsgPanelInfo()

virtual void EDA_ITEM::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
inlinevirtualinherited

◆ GetName()

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

Function GetName returns the field name.

Parameters
aUseDefaultNameWhen true return the default field name if the field name is empty. Otherwise the default field name is returned.
Returns
A wxString object containing the name of the field.

Definition at line 440 of file sch_field.cpp.

441 {
442  if( !m_name.IsEmpty() )
443  return m_name;
444  else if( aUseDefaultName )
445  {
446  if( m_Parent && m_Parent->Type() == SCH_COMPONENT_T )
448  else if( m_Parent && m_Parent->Type() == SCH_SHEET_T )
450  }
451 
452  return wxEmptyString;
453 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
wxString m_name
Definition: sch_field.h:56
static const wxString GetDefaultFieldName(int aFieldNdx)
Definition: sch_sheet.cpp:43
static const wxString GetDefaultFieldName(int aFieldNdx, bool aTranslate=true)
Function GetDefaultFieldName returns a default symbol field name for field aFieldNdx for all componen...
int m_id
Field index,.
Definition: sch_field.h:54
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

References TEMPLATE_FIELDNAME::GetDefaultFieldName(), SCH_SHEET::GetDefaultFieldName(), m_id, m_name, EDA_ITEM::m_Parent, SCH_COMPONENT_T, SCH_SHEET_T, and EDA_ITEM::Type().

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_EDIT_TOOL::editFieldText(), GetSelectMenuText(), DIALOG_FIELDS_EDITOR_GLOBAL::LoadFieldNames(), operator<(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_SEXPR_PLUGIN::saveField(), SCH_LEGACY_PLUGIN::saveField(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::Validate(), DIALOG_SYMBOL_PROPERTIES::Validate(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetParent()

◆ GetParentPosition()

wxPoint SCH_FIELD::GetParentPosition ( ) const

Definition at line 617 of file sch_field.cpp.

618 {
619  return m_Parent ? m_Parent->GetPosition() : wxPoint( 0, 0 );
620 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
virtual wxPoint GetPosition() const
Definition: eda_item.h:326

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

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

◆ GetPenWidth()

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

Reimplemented from SCH_ITEM.

Definition at line 179 of file sch_field.cpp.

180 {
181  return GetEffectiveTextPenWidth();
182 }
int GetEffectiveTextPenWidth(int aDefaultWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth.
Definition: eda_text.cpp:156

References EDA_TEXT::GetEffectiveTextPenWidth().

◆ GetPosition()

wxPoint SCH_FIELD::GetPosition ( ) const
overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 601 of file sch_field.cpp.

602 {
603  if( m_Parent && m_Parent->Type() == SCH_COMPONENT_T )
604  {
605  SCH_COMPONENT* parentComponent = static_cast<SCH_COMPONENT*>( m_Parent );
606  wxPoint relativePos = GetTextPos() - parentComponent->GetPosition();
607 
608  relativePos = parentComponent->GetTransform().TransformCoordinate( relativePos );
609 
610  return relativePos + parentComponent->GetPosition();
611  }
612 
613  return GetTextPos();
614 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
TRANSFORM & GetTransform() const
Schematic symbol object.
Definition: sch_component.h:79
wxPoint GetPosition() const override
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

References SCH_COMPONENT::GetPosition(), EDA_TEXT::GetTextPos(), SCH_COMPONENT::GetTransform(), EDA_ITEM::m_Parent, SCH_COMPONENT_T, TRANSFORM::TransformCoordinate(), and EDA_ITEM::Type().

Referenced by IsHorizJustifyFlipped(), positioningChanged(), and SCH_SEXPR_PLUGIN::saveField().

◆ GetSelectMenuText()

wxString SCH_FIELD::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 EDA_ITEM.

Definition at line 432 of file sch_field.cpp.

433 {
434  return wxString::Format( "%s '%s'",
435  GetName(),
436  ShortenedShownText() );
437 }
wxString ShortenedShownText() const
Returns a shortened version (max 15 characters) of the shown text.
Definition: eda_text.cpp:201
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:201
wxString GetName(bool aUseDefaultName=true) const
Function GetName returns the field name.
Definition: sch_field.cpp:440

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

Referenced by Matches().

◆ GetShownText() [1/2]

wxString SCH_FIELD::GetShownText ( int  aDepth = 0) const
overridevirtual

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

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

Reimplemented from EDA_TEXT.

Definition at line 100 of file sch_field.cpp.

101 {
102  std::function<bool( wxString* )> symbolResolver =
103  [&]( wxString* token ) -> bool
104  {
105  if( token->Contains( ':' ) )
106  {
107  if( Schematic()->ResolveCrossReference( token, aDepth ) )
108  return true;
109  }
110  else
111  {
112  SCH_COMPONENT* component = static_cast<SCH_COMPONENT*>( m_Parent );
113 
114  if( component->ResolveTextVar( token, aDepth + 1 ) )
115  return true;
116 
117  SCHEMATIC* schematic = component->Schematic();
118  SCH_SHEET* sheet = schematic ? schematic->CurrentSheet().Last() : nullptr;
119 
120  if( sheet && sheet->ResolveTextVar( token, aDepth + 1 ) )
121  return true;
122  }
123 
124  return false;
125  };
126 
127  std::function<bool( wxString* )> sheetResolver =
128  [&]( wxString* token ) -> bool
129  {
130  SCH_SHEET* sheet = static_cast<SCH_SHEET*>( m_Parent );
131  return sheet->ResolveTextVar( token, aDepth + 1 );
132  };
133 
134  PROJECT* project = nullptr;
135  bool processTextVars = false;
136  wxString text = EDA_TEXT::GetShownText( &processTextVars );
137 
138  if( processTextVars )
139  {
140  if( Schematic() )
141  project = &Schematic()->Prj();
142 
143  if( aDepth < 10 )
144  {
145  if( m_Parent && m_Parent->Type() == SCH_COMPONENT_T )
146  text = ExpandTextVars( text, &symbolResolver, project );
147  else if( m_Parent && m_Parent->Type() == SCH_SHEET_T )
148  text = ExpandTextVars( text, &sheetResolver, project );
149  else
150  text = ExpandTextVars( text, nullptr, project );
151  }
152  }
153 
154  // WARNING: the IDs of FIELDS and SHEETS overlap, so one must check *both* the
155  // id and the parent's type.
156 
157  if( m_Parent && m_Parent->Type() == SCH_COMPONENT_T )
158  {
159  SCH_COMPONENT* component = static_cast<SCH_COMPONENT*>( m_Parent );
160 
161  if( m_id == REFERENCE )
162  {
163  // For more than one part per package, we must add the part selection
164  // A, B, ... or 1, 2, .. to the reference.
165  if( component->GetUnitCount() > 1 )
166  text << LIB_PART::SubReference( component->GetUnit() );
167  }
168  }
169  else if( m_Parent && m_Parent->Type() == SCH_SHEET_T )
170  {
171  if( m_id == SHEETFILENAME )
172  text = _( "File:" ) + wxS( " " )+ text;
173  }
174 
175  return text;
176 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
PROJECT holds project specific data.
Definition: project.h:63
bool ResolveTextVar(wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the component.
Holds all the data relating to one schematic A schematic may consist of one or more sheets (and one r...
Definition: schematic.h:44
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:113
int GetUnitCount() const
Return the number of units per package of the symbol.
Field Reference of part, i.e. "IC21".
int GetUnit() const
bool ResolveCrossReference(wxString *token, int aDepth) const
Resolves text vars that refer to other items.
Definition: schematic.cpp:170
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:219
wxString ExpandTextVars(const wxString &aSource, const std::function< bool(wxString *)> *aLocalResolver, const PROJECT *aProject, const std::function< bool(wxString *)> *aFallbackResolver)
Expand '${var-name}' templates in text.
Definition: common.cpp:58
#define _(s)
Definition: 3d_actions.cpp:33
static wxString SubReference(int aUnit, bool aAddSeparator=true)
Schematic symbol object.
Definition: sch_component.h:79
PROJECT & Prj() const
Return a reference to the project this schematic is part of.
Definition: schematic.h:79
bool ResolveTextVar(wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the sheet.
Definition: sch_sheet.cpp:203
int m_id
Field index,.
Definition: sch_field.h:54
virtual wxString GetShownText(int aDepth=0) const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:140
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182
SCH_SHEET_PATH & CurrentSheet() const
Definition: schematic.h:121

References _, SCHEMATIC::CurrentSheet(), ExpandTextVars(), EDA_TEXT::GetShownText(), SCH_COMPONENT::GetUnit(), SCH_COMPONENT::GetUnitCount(), SCH_SHEET_PATH::Last(), m_id, EDA_ITEM::m_Parent, SCHEMATIC::Prj(), REFERENCE, SCHEMATIC::ResolveCrossReference(), SCH_COMPONENT::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), SCH_COMPONENT_T, SCH_SHEET_T, SCH_ITEM::Schematic(), SHEETFILENAME, LIB_PART::SubReference(), and EDA_ITEM::Type().

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), KIGFX::SCH_PAINTER::draw(), SCH_COMPONENT::GetFootprint(), NETLIST_EXPORTER_PSPICE::GetSpiceField(), NETLIST_EXPORTER_PSPICE::GetSpiceFieldDefVal(), SCH_COMPONENT::GetValue(), Matches(), Plot(), Print(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

◆ GetShownText() [2/2]

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

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

Parameters
processTextVars[out]

Definition at line 147 of file eda_text.h.

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

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

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 205 of file eda_item.h.

206  {
207  return m_Status & type;
208  }
STATUS_FLAGS m_Status
Definition: eda_item.h:162

References EDA_ITEM::m_Status.

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

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 218 of file eda_item.h.

218 { return m_Status; }
STATUS_FLAGS m_Status
Definition: eda_item.h:162

References EDA_ITEM::m_Status.

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 250 of file sch_item.h.

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

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::moveItem().

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const
inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 479 of file sch_item.h.

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

◆ GetText()

virtual const wxString& EDA_TEXT::GetText ( ) const
inlinevirtualinherited

Return the string associated with the text object.

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

Definition at line 133 of file eda_text.h.

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

References EDA_TEXT::m_text.

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

◆ GetTextAngle()

double EDA_TEXT::GetTextAngle ( ) const
inlineinherited

Definition at line 180 of file eda_text.h.

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

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

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

◆ GetTextAngleDegrees()

double EDA_TEXT::GetTextAngleDegrees ( ) const
inlineinherited

◆ GetTextAngleRadians()

double EDA_TEXT::GetTextAngleRadians ( ) const
inlineinherited

◆ GetTextBox()

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

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

Parameters
aLineThe line of text to consider. Pass -1 for all lines.
aInvertYInvert the Y axis when calculating bounding box.
Returns
the rect containing the line of text (i.e. the position and the size of one line) this rectangle is calculated for 0 orient text. If orientation is not 0 the rect must be rotated to match the physical area

Definition at line 222 of file eda_text.cpp.

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

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

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

◆ GetTextHeight()

◆ GetTextPos()

const wxPoint& EDA_TEXT::GetTextPos ( ) const
inlineinherited

Definition at line 254 of file eda_text.h.

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

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

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

◆ GetTextSize()

◆ GetTextStyleName()

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

Definition at line 484 of file eda_text.cpp.

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

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

Referenced by LIB_FIELD::GetMsgPanelInfo().

◆ GetTextThickness()

◆ GetTextWidth()

◆ GetVertJustify()

◆ HasFlag()

◆ HasLineStroke()

virtual bool SCH_ITEM::HasLineStroke ( ) const
inlinevirtualinherited

Check if this schematic item has line stoke properties.

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

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 477 of file sch_item.h.

477 { return false; }

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

◆ HitTest() [1/2]

bool SCH_FIELD::HitTest ( const wxPoint &  aPosition,
int  aAccuracy = 0 
) const
overridevirtual

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

499 {
500  // Do not hit test hidden or empty fields.
501  if( !IsVisible() || IsVoid() )
502  return false;
503 
504  EDA_RECT rect = GetBoundingBox();
505 
506  rect.Inflate( aAccuracy );
507 
508  return rect.Contains( aPosition );
509 }
bool IsVisible() const
Definition: eda_text.h:192
bool Contains(const wxPoint &aPoint) const
Function Contains.
Definition: eda_rect.cpp:57
bool IsVoid() const
Function IsVoid returns true if the field is either empty or holds "~".
Definition: sch_field.cpp:309
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_field.cpp:250
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

References EDA_RECT::Contains(), GetBoundingBox(), EDA_RECT::Inflate(), EDA_TEXT::IsVisible(), and IsVoid().

◆ HitTest() [2/2]

bool SCH_FIELD::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
overridevirtual

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

513 {
514  // Do not hit test hidden fields.
515  if( !IsVisible() || IsVoid() )
516  return false;
517 
518  EDA_RECT rect = aRect;
519 
520  rect.Inflate( aAccuracy );
521 
522  if( aContained )
523  return rect.Contains( GetBoundingBox() );
524 
525  return rect.Intersects( GetBoundingBox() );
526 }
bool IsVisible() const
Definition: eda_text.h:192
bool Contains(const wxPoint &aPoint) const
Function Contains.
Definition: eda_rect.cpp:57
bool IsVoid() const
Function IsVoid returns true if the field is either empty or holds "~".
Definition: sch_field.cpp:309
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_field.cpp:250
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
Definition: eda_rect.cpp:150
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

References EDA_RECT::Contains(), GetBoundingBox(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), EDA_TEXT::IsVisible(), and IsVoid().

◆ ImportValues()

void SCH_FIELD::ImportValues ( const LIB_FIELD aSource)

Function ImportValues copy parameters from a LIB_FIELD source.

Pointers and specific values (position) are not copied

Parameters
aSource= the LIB_FIELD to read

Definition at line 231 of file sch_field.cpp.

232 {
233  SetEffects( aSource );
234 }
void SetEffects(const EDA_TEXT &aSrc)
Set the text effects from another instance.
Definition: eda_text.cpp:136

References EDA_TEXT::SetEffects().

Referenced by SCH_COMPONENT::UpdateFields().

◆ InitializeConnection()

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

Creates a new connection object associated with this object.

Parameters
aPathis the sheet path to initialize

Definition at line 192 of file sch_item.cpp.

194 {
195  SCH_CONNECTION* connection = Connection( &aSheet );
196 
197  if( connection )
198  {
199  connection->Reset();
200  }
201  else
202  {
203  connection = new SCH_CONNECTION( this );
204  m_connection_map.insert( std::make_pair( aSheet, connection ) );
205  connection->SetGraph( aGraph );
206  }
207 
208  connection->SetSheet( aSheet );
209  return connection;
210 }
void SetSheet(SCH_SHEET_PATH aSheet)
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:147
void Reset()
Clears connectivity information.
void SetGraph(CONNECTION_GRAPH *aGraph)
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Stores connectivity information, per sheet.
Definition: sch_item.h:209
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).

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

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ IsBold()

◆ IsBrightened()

◆ IsConnectable()

virtual bool SCH_ITEM::IsConnectable ( ) const
inlinevirtualinherited

◆ IsConnected()

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

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

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

Definition at line 138 of file sch_item.cpp.

139 {
140  if( ( m_Flags & STRUCT_DELETED ) || ( m_Flags & SKIP_STRUCT ) )
141  return false;
142 
143  return doIsConnected( aPosition );
144 }
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:115
STATUS_FLAGS m_Flags
Definition: eda_item.h:165
virtual bool doIsConnected(const wxPoint &aPosition) const
Provide the object specific test to see if it is connected to aPosition.
Definition: sch_item.h:506
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: eda_item.h:117

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

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

References SCH_ITEM::m_connectivity_dirty.

◆ IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const
inlinevirtualinherited

Reimplemented in SCH_TEXT, SCH_LINE, SCH_BUS_ENTRY_BASE, SCH_PIN, and SCH_IREF.

Definition at line 370 of file sch_item.h.

370 { return false; }

◆ IsDefaultFormatting()

bool EDA_TEXT::IsDefaultFormatting ( ) const
inherited

Definition at line 505 of file eda_text.cpp.

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

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

Referenced by SCH_SEXPR_PLUGIN::saveField().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 190 of file eda_item.h.

190 { return m_Flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:108
STATUS_FLAGS m_Flags
Definition: eda_item.h:165

References IS_DRAGGED, and EDA_ITEM::m_Flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 275 of file eda_item.h.

275 { return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:164

References EDA_ITEM::m_forceVisible.

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

◆ IsHorizJustifyFlipped()

bool SCH_FIELD::IsHorizJustifyFlipped ( ) const

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

Definition at line 292 of file sch_field.cpp.

293 {
294  wxPoint render_center = GetBoundingBox().Centre();
295  wxPoint pos = GetPosition();
296 
297  switch( GetHorizJustify() )
298  {
300  return render_center.x < pos.x;
302  return render_center.x > pos.x;
303  default:
304  return false;
305  }
306 }
wxPoint GetPosition() const override
Definition: sch_field.cpp:601
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:205
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_field.cpp:250
wxPoint Centre() const
Definition: eda_rect.h:62

References EDA_RECT::Centre(), GetBoundingBox(), EDA_TEXT::GetHorizJustify(), GetPosition(), GR_TEXT_HJUSTIFY_LEFT, and GR_TEXT_HJUSTIFY_RIGHT.

Referenced by AUTOPLACER::field_horiz_placement(), and AUTOPLACER::justify_field().

◆ IsItalic()

bool EDA_TEXT::IsItalic ( ) const
inlineinherited

Definition at line 186 of file eda_text.h.

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

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

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

◆ IsLocked()

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

Definition at line 269 of file sch_item.h.

269 { return false; }

Referenced by SCH_EDIT_TOOL::DeleteItemCursor().

◆ IsMirrored()

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 187 of file eda_item.h.

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

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

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

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

Definition at line 248 of file sch_item.h.

248 { return true; }

Referenced by SCH_MOVE_TOOL::Main().

◆ IsMoving()

◆ IsMultilineAllowed()

◆ IsNew()

◆ IsPointClickableAnchor()

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

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

Definition at line 382 of file sch_item.h.

382 { return false; }

Referenced by EE_SELECTION_TOOL::GuessSelectionCandidates().

◆ IsReplaceable()

bool SCH_FIELD::IsReplaceable ( ) const
overridevirtual

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.

Definition at line 355 of file sch_field.cpp.

356 {
357  if( m_Parent && m_Parent->Type() == SCH_COMPONENT_T )
358  {
359  SCH_COMPONENT* parentComponent = static_cast<SCH_COMPONENT*>( m_Parent );
360 
361  if( m_id == VALUE )
362  {
363  LIB_PART* part = parentComponent->GetPartRef().get();
364 
365  if( part && part->IsPower() )
366  return false;
367  }
368  }
369  else if( m_Parent && m_Parent->Type() == SCH_SHEET_T )
370  {
371  // See comments in SCH_FIELD::Replace(), below.
372  if( m_id == SHEETFILENAME )
373  return false;
374  }
375 
376  return true;
377 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
Define a library symbol object.
std::unique_ptr< LIB_PART > & GetPartRef()
Field Value of part, i.e. "3.3K".
bool IsPower() const
Schematic symbol object.
Definition: sch_component.h:79
int m_id
Field index,.
Definition: sch_field.h:54
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

References SCH_COMPONENT::GetPartRef(), LIB_PART::IsPower(), m_id, EDA_ITEM::m_Parent, SCH_COMPONENT_T, SCH_SHEET_T, SHEETFILENAME, EDA_ITEM::Type(), and VALUE.

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 193 of file eda_item.h.

193 { return m_Flags & IS_RESIZED; }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:107
STATUS_FLAGS m_Flags
Definition: eda_item.h:165

References IS_RESIZED, and EDA_ITEM::m_Flags.

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

◆ IsSelected()

◆ IsType()

bool SCH_FIELD::IsType ( const KICAD_T  aScanTypes[]) const
inlineoverridevirtual

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

Definition at line 76 of file sch_field.h.

77  {
78  if( SCH_ITEM::IsType( aScanTypes ) )
79  return true;
80 
81  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
82  {
84  return true;
85  else if ( *p == SCH_FIELD_LOCATE_VALUE_T && m_id == VALUE )
86  return true;
87  else if ( *p == SCH_FIELD_LOCATE_FOOTPRINT_T && m_id == FOOTPRINT )
88  return true;
89  else if ( *p == SCH_FIELD_LOCATE_DATASHEET_T && m_id == DATASHEET )
90  return true;
91  }
92 
93  return false;
94  }
name of datasheet
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
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
virtual bool IsType(const KICAD_T aScanTypes[]) const
Function IsType Checks whether the item is one of the listed types.
Definition: eda_item.h:251
Field Value of part, i.e. "3.3K".
int m_id
Field index,.
Definition: sch_field.h:54

References DATASHEET, EOT, FOOTPRINT, EDA_ITEM::IsType(), m_id, REFERENCE, SCH_FIELD_LOCATE_DATASHEET_T, SCH_FIELD_LOCATE_FOOTPRINT_T, SCH_FIELD_LOCATE_REFERENCE_T, SCH_FIELD_LOCATE_VALUE_T, and VALUE.

◆ IsVisible()

◆ IsVoid()

bool SCH_FIELD::IsVoid ( ) const

Function IsVoid returns true if the field is either empty or holds "~".

Definition at line 309 of file sch_field.cpp.

310 {
311  return GetText().Len() == 0;
312 }
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133

References EDA_TEXT::GetText().

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), KIGFX::SCH_PAINTER::draw(), HitTest(), Plot(), Print(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 191 of file eda_item.h.

191 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:110
STATUS_FLAGS m_Flags
Definition: eda_item.h:165

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 373 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

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

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

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

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

Definition at line 394 of file eda_item.h.

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

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

◆ LenSize()

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

Definition at line 187 of file eda_text.cpp.

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

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

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

◆ MapHorizJustify()

EDA_TEXT_HJUSTIFY_T EDA_TEXT::MapHorizJustify ( int  aHorizJustify)
staticinherited

Definition at line 62 of file eda_text.cpp.

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

References GR_TEXT_HJUSTIFY_LEFT, and GR_TEXT_HJUSTIFY_RIGHT.

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

◆ MapVertJustify()

EDA_TEXT_VJUSTIFY_T EDA_TEXT::MapVertJustify ( int  aVertJustify)
staticinherited

Definition at line 76 of file eda_text.cpp.

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

References GR_TEXT_VJUSTIFY_BOTTOM, and GR_TEXT_VJUSTIFY_TOP.

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

◆ Matches() [1/2]

bool SCH_FIELD::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData 
)
overridevirtual

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

316 {
317  wxString text = GetShownText();
318  int flags = aSearchData.GetFlags();
319  bool searchHiddenFields = flags & FR_SEARCH_ALL_FIELDS;
320  bool searchAndReplace = flags & FR_SEARCH_REPLACE;
321  bool replaceReferences = flags & FR_REPLACE_REFERENCES;
322 
323  wxLogTrace( traceFindItem, wxT( " child item " )
325 
326  if( !IsVisible() && !searchHiddenFields )
327  return false;
328 
329  if( m_Parent && m_Parent->Type() == SCH_COMPONENT_T && m_id == REFERENCE )
330  {
331  if( searchAndReplace && !replaceReferences )
332  return false;
333 
334  SCH_COMPONENT* parentComponent = static_cast<SCH_COMPONENT*>( m_Parent );
335  wxASSERT( aAuxData );
336 
337  // Take sheet path into account which effects the reference field and the unit for
338  // components with multiple parts.
339  if( aAuxData )
340  {
341  text = parentComponent->GetRef( (SCH_SHEET_PATH*) aAuxData );
342 
343  if( SCH_ITEM::Matches( text, aSearchData ) )
344  return true;
345 
346  if( parentComponent->GetUnitCount() > 1 )
347  text << LIB_PART::SubReference( parentComponent->GetUnit() );
348  }
349  }
350 
351  return SCH_ITEM::Matches( text, aSearchData );
352 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
bool IsVisible() const
Definition: eda_text.h:192
int GetUnitCount() const
Return the number of units per package of the symbol.
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: sch_field.cpp:432
Field Reference of part, i.e. "IC21".
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_field.cpp:100
int GetUnit() const
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
const wxChar *const traceFindItem
Flag to enable find debug tracing.
static wxString SubReference(int aUnit, bool aAddSeparator=true)
Schematic symbol object.
Definition: sch_component.h:79
int m_id
Field index,.
Definition: sch_field.h:54
virtual bool Matches(wxFindReplaceData &aSearchData, void *aAuxData)
Function Matches compares the item against the search criteria in aSearchData.
Definition: eda_item.h:447
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.

References FR_REPLACE_REFERENCES, FR_SEARCH_ALL_FIELDS, FR_SEARCH_REPLACE, SCH_COMPONENT::GetRef(), GetSelectMenuText(), GetShownText(), SCH_COMPONENT::GetUnit(), SCH_COMPONENT::GetUnitCount(), EDA_TEXT::IsVisible(), m_id, EDA_ITEM::m_Parent, EDA_ITEM::Matches(), MILLIMETRES, REFERENCE, SCH_COMPONENT_T, LIB_PART::SubReference(), traceFindItem, and EDA_ITEM::Type().

◆ Matches() [2/2]

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

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

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

Definition at line 132 of file eda_item.cpp.

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

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

◆ MirrorX()

void SCH_FIELD::MirrorX ( int  aXaxis_position)
inlineoverridevirtual

Mirror item relative to the X axis about aXaxis_position.

Parameters
aXaxis_positionThe X axis position to mirror around.

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

Implements SCH_ITEM.

Definition at line 163 of file sch_field.h.

164  {
165  }

◆ MirrorY()

void SCH_FIELD::MirrorY ( int  aYaxis_position)
inlineoverridevirtual

Mirror item relative to the Y axis about aYaxis_position.

Parameters
aYaxis_positionThe Y axis position to mirror around.

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

Implements SCH_ITEM.

Definition at line 174 of file sch_field.h.

175  {
176  }

◆ Move()

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

Move the item by aMoveVector to a new position.

Parameters
aMoveVector= the displacement vector

Implements SCH_ITEM.

Definition at line 149 of file sch_field.h.

150  {
151  Offset( aMoveVector );
152  }
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:259

References EDA_TEXT::Offset().

◆ NetClass()

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

Definition at line 161 of file sch_item.cpp.

162 {
163  if( m_connection_map.size() )
164  {
165  SCH_CONNECTION* connection = Connection( aSheet );
166 
167  if( connection )
168  {
169  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
170  const wxString& netclassName = netSettings.GetNetclassName( connection->Name() );
171 
172  return netSettings.m_NetClasses.Find( netclassName );
173  }
174  }
175 
176  return nullptr;
177 }
NETCLASSPTR Find(const wxString &aName) const
Function Find searches this container for a NETCLASS given by aName.
Definition: netclass.cpp:132
const wxString & GetNetclassName(const wxString &aNetName) const
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:113
NET_SETTINGS & NetSettings()
Definition: project_file.h:92
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:147
NETCLASSES m_NetClasses
Definition: net_settings.h:39
wxString Name(bool aIgnoreSheet=false) const
VTBL_ENTRY PROJECT_FILE & GetProjectFile() const
Definition: project.h:143
NET_SETTINGS stores various net-related settings in a project context.
Definition: net_settings.h:31
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Stores connectivity information, per sheet.
Definition: sch_item.h:209
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
PROJECT & Prj() const
Return a reference to the project this schematic is part of.
Definition: schematic.h:79

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

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

◆ Offset()

◆ operator<() [1/2]

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

Reimplemented from SCH_ITEM.

Definition at line 623 of file sch_field.cpp.

624 {
625  if( Type() != aItem.Type() )
626  return Type() < aItem.Type();
627 
628  auto field = static_cast<const SCH_FIELD*>( &aItem );
629 
630  if( GetId() != field->GetId() )
631  return GetId() < field->GetId();
632 
633  if( GetText() != field->GetText() )
634  return GetText() < field->GetText();
635 
636  if( GetLibPosition().x != field->GetLibPosition().x )
637  return GetLibPosition().x < field->GetLibPosition().x;
638 
639  if( GetLibPosition().y != field->GetLibPosition().y )
640  return GetLibPosition().y < field->GetLibPosition().y;
641 
642  return GetName() < field->GetName();
643 }
int GetId() const
Definition: sch_field.h:114
wxPoint GetLibPosition() const
Definition: sch_field.h:188
wxString GetName(bool aUseDefaultName=true) const
Function GetName returns the field name.
Definition: sch_field.cpp:440
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

References GetId(), GetLibPosition(), GetName(), EDA_TEXT::GetText(), and EDA_ITEM::Type().

◆ operator<() [2/2]

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

Test if another item is less than this object.

Parameters
aItem- Item to compare against.
Returns
- True if aItem is less than the item.

Definition at line 185 of file eda_item.cpp.

186 {
187  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
188  GetClass() ) );
189 
190  return false;
191 }
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:201

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

◆ Plot()

void SCH_FIELD::Plot ( PLOTTER aPlotter)
overridevirtual

Plot the schematic item to aPlotter.

Parameters
aPlotterA pointer to a PLOTTER object.

Reimplemented from SCH_ITEM.

Definition at line 529 of file sch_field.cpp.

530 {
531  RENDER_SETTINGS* settings = aPlotter->RenderSettings();
532  COLOR4D color = settings->GetLayerColor( GetLayer() );
533  int penWidth = GetEffectiveTextPenWidth( settings->GetDefaultPenWidth() );
534 
535  penWidth = std::max( penWidth, settings->GetMinPenWidth() );
536 
537  if( !IsVisible() )
538  return;
539 
540  if( IsVoid() )
541  return;
542 
543  // Calculate the text orientation, according to the component orientation/mirror
544  int orient = GetTextAngle();
545 
546  if( m_Parent && m_Parent->Type() == SCH_COMPONENT_T )
547  {
548  SCH_COMPONENT* parentComponent = static_cast<SCH_COMPONENT*>( m_Parent );
549 
550  if( parentComponent->GetTransform().y1 ) // Rotate component 90 deg.
551  {
552  if( orient == TEXT_ANGLE_HORIZ )
553  orient = TEXT_ANGLE_VERT;
554  else
555  orient = TEXT_ANGLE_HORIZ;
556  }
557  }
558 
559  /*
560  * Calculate the text justification, according to the component orientation/mirror
561  * this is a bit complicated due to cumulative calculations:
562  * - numerous cases (mirrored or not, rotation)
563  * - the DrawGraphicText function also recalculates H and H justifications according to the
564  * text orientation.
565  * - When a component is mirrored, the text is not mirrored and justifications are
566  * complicated to calculate
567  * so the easier way is to use no justifications (centered text) and use GetBoundaryBox to
568  * know the text coordinate considered as centered
569  */
570  EDA_RECT BoundaryBox = GetBoundingBox();
573  wxPoint textpos = BoundaryBox.Centre();
574 
575  aPlotter->Text( textpos, color, GetShownText(), orient, GetTextSize(), hjustify, vjustify,
576  penWidth, IsItalic(), IsBold() );
577 }
#define TEXT_ANGLE_HORIZ
Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to...
Definition: eda_text.h:50
bool IsBold() const
Definition: eda_text.h:189
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:61
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
bool IsVisible() const
Definition: eda_text.h:192
int color
Definition: DXF_plotter.cpp:60
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
double GetTextAngle() const
Definition: eda_text.h:180
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_field.cpp:100
bool IsVoid() const
Function IsVoid returns true if the field is either empty or holds "~".
Definition: sch_field.cpp:309
int GetEffectiveTextPenWidth(int aDefaultWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth.
Definition: eda_text.cpp:156
virtual void Text(const wxPoint &aPos, const COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, bool aMultilineAllowed=false, void *aData=NULL)
Draws text with the plotter.
Definition: gr_text.cpp:219
bool IsItalic() const
Definition: eda_text.h:186
int y1
Definition: transform.h:49
TRANSFORM & GetTransform() const
const wxSize & GetTextSize() const
Definition: eda_text.h:245
EDA_TEXT_VJUSTIFY_T
Definition: eda_text.h:68
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:279
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:165
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_field.cpp:250
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
Schematic symbol object.
Definition: sch_component.h:79
wxPoint Centre() const
Definition: eda_rect.h:62
int GetDefaultPenWidth() const
#define TEXT_ANGLE_VERT
Definition: eda_text.h:51
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100

References EDA_RECT::Centre(), color, GetBoundingBox(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), EDA_TEXT::GetEffectiveTextPenWidth(), SCH_ITEM::GetLayer(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), GetShownText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextSize(), SCH_COMPONENT::GetTransform(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_CENTER, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsVisible(), IsVoid(), EDA_ITEM::m_Parent, PLOTTER::RenderSettings(), SCH_COMPONENT_T, PLOTTER::Text(), TEXT_ANGLE_HORIZ, TEXT_ANGLE_VERT, EDA_ITEM::Type(), and TRANSFORM::y1.

◆ Print() [1/2]

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

Print a schematic item.

Each schematic item should have its own method

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

Implements SCH_ITEM.

Definition at line 185 of file sch_field.cpp.

186 {
187  wxDC* DC = aSettings->GetPrintDC();
189  int orient;
190  wxPoint textpos;
191  int penWidth = GetEffectiveTextPenWidth( aSettings->GetDefaultPenWidth() );
192 
193  if( ( !IsVisible() && !IsForceVisible() ) || IsVoid() )
194  return;
195 
196  // Calculate the text orientation according to the component orientation.
197  orient = GetTextAngle();
198 
199  if( m_Parent && m_Parent->Type() == SCH_COMPONENT_T )
200  {
201  SCH_COMPONENT* parentComponent = static_cast<SCH_COMPONENT*>( m_Parent );
202 
203  if( parentComponent && parentComponent->GetTransform().y1 ) // Rotate component 90 degrees.
204  {
205  if( orient == TEXT_ANGLE_HORIZ )
206  orient = TEXT_ANGLE_VERT;
207  else
208  orient = TEXT_ANGLE_HORIZ;
209  }
210  }
211 
212  /* Calculate the text justification, according to the component
213  * orientation/mirror this is a bit complicated due to cumulative
214  * calculations:
215  * - numerous cases (mirrored or not, rotation)
216  * - the DrawGraphicText function recalculate also H and H justifications
217  * according to the text orientation.
218  * - When a component is mirrored, the text is not mirrored and
219  * justifications are complicated to calculate
220  * so the more easily way is to use no justifications ( Centered text )
221  * and use GetBoundaryBox to know the text coordinate considered as centered
222  */
223  EDA_RECT boundaryBox = GetBoundingBox();
224  textpos = boundaryBox.Centre() + aOffset;
225 
226  GRText( DC, textpos, color, GetShownText(), orient, GetTextSize(), GR_TEXT_HJUSTIFY_CENTER,
227  GR_TEXT_VJUSTIFY_CENTER, penWidth, IsItalic(), IsBold() );
228 }
#define TEXT_ANGLE_HORIZ
Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to...
Definition: eda_text.h:50
bool IsBold() const
Definition: eda_text.h:189
SCH_LAYER_ID m_Layer
Definition: sch_item.h:199
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
bool IsVisible() const
Definition: eda_text.h:192
int color
Definition: DXF_plotter.cpp:60
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
double GetTextAngle() const
Definition: eda_text.h:180
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_field.cpp:100
bool IsVoid() const
Function IsVoid returns true if the field is either empty or holds "~".
Definition: sch_field.cpp:309
int GetEffectiveTextPenWidth(int aDefaultWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth.
Definition: eda_text.cpp:156
bool IsItalic() const
Definition: eda_text.h:186
int y1
Definition: transform.h:49
TRANSFORM & GetTransform() const
const wxSize & GetTextSize() const
Definition: eda_text.h:245
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:131
bool IsForceVisible() const
Definition: eda_item.h:275
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_field.cpp:250
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
Schematic symbol object.
Definition: sch_component.h:79
wxPoint Centre() const
Definition: eda_rect.h:62
int GetDefaultPenWidth() const
#define TEXT_ANGLE_VERT
Definition: eda_text.h:51
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100

References EDA_RECT::Centre(), color, GetBoundingBox(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), EDA_TEXT::GetEffectiveTextPenWidth(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GetShownText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextSize(), SCH_COMPONENT::GetTransform(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_CENTER, GRText(), EDA_TEXT::IsBold(), EDA_ITEM::IsForceVisible(), EDA_TEXT::IsItalic(), EDA_TEXT::IsVisible(), IsVoid(), LAYER_HIDDEN, SCH_ITEM::m_Layer, EDA_ITEM::m_Parent, SCH_COMPONENT_T, TEXT_ANGLE_HORIZ, TEXT_ANGLE_VERT, EDA_ITEM::Type(), and TRANSFORM::y1.

◆ Print() [2/2]

void EDA_TEXT::Print ( RENDER_SETTINGS aSettings,
const wxPoint &  aOffset,
COLOR4D  aColor,
OUTLINE_MODE  aDisplay_mode = FILLED 
)
inherited

Print this text object to the device context aDC.

Parameters
aDC= the current Device Context
aOffset= draw offset (usually (0,0))
aColor= text color
aDisplay_mode= FILLED or SKETCH

Definition at line 400 of file eda_text.cpp.

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

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

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

◆ Replace() [1/3]

bool SCH_FIELD::Replace ( wxFindReplaceData &  aSearchData,
void *  aAuxData = NULL 
)
overridevirtual

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

381 {
382  bool isReplaced = false;
383 
384  if( m_Parent && m_Parent->Type() == SCH_COMPONENT_T )
385  {
386  SCH_COMPONENT* parentComponent = static_cast<SCH_COMPONENT*>( m_Parent );
387 
388  if( m_id == REFERENCE )
389  {
390  wxCHECK_MSG( aAuxData != NULL, false,
391  wxT( "Cannot replace reference designator without valid sheet path." ) );
392 
393  if( !( aSearchData.GetFlags() & FR_REPLACE_REFERENCES ) )
394  return false;
395 
396  wxString text = parentComponent->GetRef( (SCH_SHEET_PATH*) aAuxData );
397 
398  isReplaced = EDA_ITEM::Replace( aSearchData, text );
399 
400  if( isReplaced )
401  parentComponent->SetRef( (SCH_SHEET_PATH*) aAuxData, text );
402  }
403  else
404  {
405  isReplaced = EDA_TEXT::Replace( aSearchData );
406  }
407  }
408  else if( m_Parent && m_Parent->Type() == SCH_SHEET_T )
409  {
410  isReplaced = EDA_TEXT::Replace( aSearchData );
411 
412  if( m_id == SHEETFILENAME && isReplaced )
413  {
414  // If we allowed this we'd have a bunch of work to do here, including warning
415  // about it not being undoable, checking for recursive hierarchies, reloading
416  // sheets, etc. See DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().
417  }
418  }
419 
420  return isReplaced;
421 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
static bool Replace(wxFindReplaceData &aSearchData, wxString &aText)
Helper function used in search and replace dialog Function Replace performs a text replace on aText u...
Definition: eda_item.cpp:159
Field Reference of part, i.e. "IC21".
#define NULL
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
bool Replace(wxFindReplaceData &aSearchData)
Helper function used in search and replace dialog.
Definition: eda_text.cpp:177
Schematic symbol object.
Definition: sch_component.h:79
int m_id
Field index,.
Definition: sch_field.h:54
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.

References FR_REPLACE_REFERENCES, SCH_COMPONENT::GetRef(), m_id, EDA_ITEM::m_Parent, NULL, REFERENCE, EDA_TEXT::Replace(), EDA_ITEM::Replace(), SCH_COMPONENT_T, SCH_SHEET_T, SCH_COMPONENT::SetRef(), SHEETFILENAME, and EDA_ITEM::Type().

Referenced by SCH_EAGLE_PLUGIN::loadSheet().

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

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

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

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

◆ Replace() [3/3]

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

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

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

Definition at line 159 of file eda_item.cpp.

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

References traceFindReplace.

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

◆ Rotate()

void SCH_FIELD::Rotate ( wxPoint  aPosition)
overridevirtual

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

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

Implements SCH_ITEM.

Definition at line 424 of file sch_field.cpp.

425 {
426  wxPoint pt = GetTextPos();
427  RotatePoint( &pt, aPosition, 900 );
428  SetTextPos( pt );
429 }
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
const wxPoint & GetTextPos() const
Definition: eda_text.h:254

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

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const
inherited

Searches the item hierarchy to find a SCHEMATIC.

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

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

Returns
the parent schematic this item lives on, or nullptr

Definition at line 113 of file sch_item.cpp.

114 {
115  EDA_ITEM* parent = GetParent();
116 
117  while( parent )
118  {
119  if( parent->Type() == SCHEMATIC_T )
120  return static_cast<SCHEMATIC*>( parent );
121  else
122  parent = parent->GetParent();
123  }
124 
125  return nullptr;
126 }
EDA_ITEM * GetParent() const
Definition: eda_item.h:184
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: eda_item.h:148
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

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

Referenced by SCH_IREF::BuildHypertextMenu(), SCH_ITEM::Connection(), SCH_EDIT_FRAME::CreateSheetPin(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_JUNCTION::GetBoundingBox(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::GetDiameter(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_NO_CONNECT::GetPenWidth(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_COMPONENT::GetPins(), GetShownText(), SCH_TEXT::GetShownText(), inheritNetclass(), SCH_SHEET::IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), SCH_JUNCTION::Plot(), SCH_JUNCTION::Print(), SCH_HIERLABEL::Print(), SCH_COMPONENT::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and SCH_MARKER::ViewGetLayers().

◆ Set() [1/3]

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

Definition at line 40 of file inspectable.h.

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

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

◆ Set() [2/3]

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

Definition at line 53 of file inspectable.h.

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

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

◆ Set() [3/3]

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

Definition at line 66 of file inspectable.h.

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

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

◆ SetBold()

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

◆ SetConnectivityDirty()

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

Definition at line 440 of file sch_item.h.

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

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

137 {
138  m_e = aSrc.m_e;
139 }
TEXT_EFFECTS m_e
Definition: eda_text.h:383

References EDA_TEXT::m_e.

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

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 221 of file eda_item.h.

221 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Definition: eda_item.h:165

References EDA_ITEM::m_Flags.

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

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

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

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

Definition at line 273 of file eda_item.h.

273 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: eda_item.h:164

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetHorizJustify()

void EDA_TEXT::SetHorizJustify ( EDA_TEXT_HJUSTIFY_T  aType)
inlineinherited

Definition at line 208 of file eda_text.h.

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

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXT::Flip(), ALTIUM_PCB::HelperParseDimensions6Leader(), AUTOPLACER::justify_field(), FP_TEXT::KeepUpright(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN_CACHE::loadText(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), EAGLE_PLUGIN::orientModuleText(), EAGLE_PLUGIN::packageText(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseFileName(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_ALTIUM_PLUGIN::ParseSheetName(), ALTIUM_PCB::ParseTexts6Data(), LIB_TEXT::Rotate(), SetEdaTextJustification(), SCH_IREF::SetIrefOrientation(), SCH_TEXT::SetLabelSpinStyle(), SCH_GLOBALLABEL::SetLabelSpinStyle(), SCH_HIERLABEL::SetLabelSpinStyle(), PCAD2KICAD::SetTextJustify(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and DIALOG_EDIT_ONE_FIELD::updateText().

◆ SetId()

void SCH_FIELD::SetId ( int  aId)

Definition at line 74 of file sch_field.cpp.

75 {
76  m_id = aId;
77 
78  if( m_Parent && m_Parent->Type() == SCH_SHEET_T )
79  {
80  switch( m_id )
81  {
82  case SHEETNAME: SetLayer( LAYER_SHEETNAME ); break;
84  default: SetLayer( LAYER_SHEETFIELDS ); break;
85  }
86  }
87  else
88  {
89  switch( m_id )
90  {
91  case REFERENCE: SetLayer( LAYER_REFERENCEPART ); break;
92  case VALUE: SetLayer( LAYER_VALUEPART ); break;
93  default: SetLayer( LAYER_FIELDS ); break;
94  }
95  }
96 
97 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
Field Reference of part, i.e. "IC21".
void SetLayer(SCH_LAYER_ID aLayer)
Set the layer this item is on.
Definition: sch_item.h:286
Field Value of part, i.e. "3.3K".
int m_id
Field index,.
Definition: sch_field.h:54
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

References LAYER_FIELDS, LAYER_REFERENCEPART, LAYER_SHEETFIELDS, LAYER_SHEETFILENAME, LAYER_SHEETNAME, LAYER_VALUEPART, m_id, EDA_ITEM::m_Parent, REFERENCE, SCH_SHEET_T, SCH_ITEM::SetLayer(), SHEETFILENAME, SHEETNAME, EDA_ITEM::Type(), and VALUE.

Referenced by SCH_SEXPR_PARSER::parseSchematicSymbol(), SCH_SEXPR_PARSER::parseSheet(), SCH_LEGACY_PLUGIN::saveComponent(), SCH_SEXPR_PLUGIN::saveField(), and SCH_FIELD().

◆ SetItalic()

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID  aLayer)
inlineinherited

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

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

Definition at line 274 of file sch_item.h.

274 {}

◆ SetMirrored()

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

Definition at line 79 of file eda_item.cpp.

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

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

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

◆ SetMultilineAllowed()

void EDA_TEXT::SetMultilineAllowed ( bool  aAllow)
inlineinherited
Parameters
aAllowtrue if ok to use multiline option, false if ok to use only single line text. (Single line is faster in calculations than multiline.)

Definition at line 202 of file eda_text.h.

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

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

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

◆ SetName()

void SCH_FIELD::SetName ( const wxString &  aName)
inline

Definition at line 112 of file sch_field.h.

112 { m_name = aName; }
wxString m_name
Definition: sch_field.h:56

References m_name.

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Reimplemented in DIMENSION.

Definition at line 185 of file eda_item.h.

185 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163

References EDA_ITEM::m_Parent.

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

◆ SetPosition()

void SCH_FIELD::SetPosition ( const wxPoint &  aPosition)
overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 580 of file sch_field.cpp.

581 {
582  // Actual positions are calculated by the rotation/mirror transform of the
583  // parent component of the field. The inverse transform is used to calculate
584  // the position relative to the parent component.
585  if( m_Parent && m_Parent->Type() == SCH_COMPONENT_T )
586  {
587  SCH_COMPONENT* parentComponent = static_cast<SCH_COMPONENT*>( m_Parent );
588  wxPoint relativePos = aPosition - parentComponent->GetPosition();
589 
590  relativePos = parentComponent->GetTransform().
591  InverseTransform().TransformCoordinate( relativePos );
592 
593  SetTextPos( relativePos + parentComponent->GetPosition() );
594  return;
595  }
596 
597  SetTextPos( aPosition );
598 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
TRANSFORM & GetTransform() const
Schematic symbol object.
Definition: sch_component.h:79
wxPoint GetPosition() const override
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

References SCH_COMPONENT::GetPosition(), SCH_COMPONENT::GetTransform(), EDA_ITEM::m_Parent, SCH_COMPONENT_T, EDA_TEXT::SetTextPos(), TRANSFORM::TransformCoordinate(), and EDA_ITEM::Type().

Referenced by AUTOPLACER::DoAutoplace(), SCH_EAGLE_PLUGIN::loadInstance(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_ALTIUM_PLUGIN::ParseFileName(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), and SCH_ALTIUM_PLUGIN::ParseSheetName().

◆ SetSelected()

◆ SetState()

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

Definition at line 210 of file eda_item.h.

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

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 219 of file eda_item.h.

219 { m_Status = aStatus; }
STATUS_FLAGS m_Status
Definition: eda_item.h:162

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( wxPoint  aPos)
inlineinherited

Definition at line 251 of file sch_item.h.

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

References SCH_ITEM::m_storedPos.

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

◆ SetStroke()

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

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 481 of file sch_item.h.

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

◆ SetText()

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

Definition at line 120 of file eda_text.cpp.

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

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

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

◆ SetTextAngle()

virtual void EDA_TEXT::SetTextAngle ( double  aAngle)
inlinevirtualinherited

Reimplemented in WS_DRAW_ITEM_TEXT, FP_TEXT, and PCB_TEXT.

Definition at line 173 of file eda_text.h.

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

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

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), eagleToKicadAlignment(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), LIB_FIELD::Init(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibraryFieldAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute(), SCH_LEGACY_PLUGIN_CACHE::loadText(), DIALOG_SHEET_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), ALTIUM_PCB::ParseTexts6Data(), SCH_EDIT_TOOL::Rotate(), LIB_TEXT::Rotate(), LIB_FIELD::Rotate(), SetFieldOrientation(), SCH_IREF::SetIrefOrientation(), SCH_TEXT::SetLabelSpinStyle(), SCH_GLOBALLABEL::SetLabelSpinStyle(), SCH_HIERLABEL::SetLabelSpinStyle(), PCB_TEXT::SetTextAngle(), FP_TEXT::SetTextAngle(), WS_DRAW_ITEM_TEXT::SetTextAngle(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and DIALOG_EDIT_ONE_FIELD::updateText().

◆ SetTextHeight()

◆ SetTextPos()

void EDA_TEXT::SetTextPos ( const wxPoint &  aPoint)
inlineinherited

Definition at line 253 of file eda_text.h.

253 { m_e.pos = aPoint; }
TEXT_EFFECTS m_e
Definition: eda_text.h:383
wxPoint pos
Definition: eda_text.h:106

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), LIB_TEXT::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_TEXT::CalcEdit(), LIB_FIELD::CalcEdit(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), FP_TEXT::FP_TEXT(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibraryFieldAttribute(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), DIMENSION::Mirror(), LIB_TEXT::MoveTo(), LIB_FIELD::MoveTo(), LIB_TEXT::NormalizeJustification(), EAGLE_PLUGIN::orientModuleText(), EAGLE_PLUGIN::packageText(), SCH_IREF::PlaceAtDefaultPosition(), DRAWING_TOOL::PlaceText(), DIALOG_CHANGE_SYMBOLS::processSymbol(), LIB_TEXT::Rotate(), PCB_TEXT::Rotate(), FP_TEXT::Rotate(), Rotate(), LIB_FIELD::Rotate(), SCH_TEXT::Rotate(), SCH_FIELD(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), FP_TEXT::SetDrawCoord(), PCB_TEXT::SetPosition(), FP_TEXT::SetPosition(), DIMENSION::SetPosition(), SetPosition(), WS_DRAW_ITEM_TEXT::SetPosition(), SCH_TEXT::SetPosition(), SCH_COMPONENT::SetRef(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), SCH_COMPONENT::UpdateFields(), DIALOG_EDIT_ONE_FIELD::updateText(), ALIGNED_DIMENSION::updateText(), ORTHOGONAL_DIMENSION::updateText(), and WS_DRAW_ITEM_TEXT::WS_DRAW_ITEM_TEXT().

◆ SetTextSize()

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

Definition at line 244 of file eda_text.h.

244 { m_e.size = aNewSize; }
TEXT_EFFECTS m_e
Definition: eda_text.h:383
wxSize size
Definition: eda_text.h:103

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_EDIT_TOOL::ChangeTextType(), SCH_IREF::CopyParentStyle(), MICROWAVE_TOOL::createBaseFootprint(), PCB_BASE_FRAME::CreateNewModule(), SCH_DRAWING_TOOLS::createNewText(), SCH_EDIT_FRAME::CreateSheetPin(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), dummy(), KIGFX::dummy(), EDA_TEXT::EDA_TEXT(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParseDimensions6Linear(), LIB_TEXT::LIB_TEXT(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_LEGACY_PLUGIN::loadSheet(), SCH_LEGACY_PLUGIN_CACHE::loadText(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientModuleText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseLabel(), ALTIUM_PCB::ParseTexts6Data(), DRAWING_TOOL::PlaceText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BACK_ANNOTATE::processNetNameChange(), DIMENSION::SetTextSize(), PCAD2KICAD::SetTextSizeFromStrokeFontHeight(), PCAD2KICAD::SetTextSizeFromTrueTypeFontHeight(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), DIALOG_EDIT_ONE_FIELD::updateText(), and WS_DRAW_ITEM_TEXT::WS_DRAW_ITEM_TEXT().

◆ SetTextThickness()

void EDA_TEXT::SetTextThickness ( int  aWidth)
inlineinherited

The TextThickness is that set by the user.

The EffectiveTextPenWidth also factors in bold text and thickness clamping.

Definition at line 164 of file eda_text.h.

164 { m_e.penwidth = aWidth; };
TEXT_EFFECTS m_e
Definition: eda_text.h:383
int penwidth
Definition: eda_text.h:104

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_MODULE::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), SCH_IREF::CopyParentStyle(), MICROWAVE_TOOL::createBaseFootprint(), PCB_BASE_FRAME::CreateNewModule(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXT::FP_TEXT(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParseDimensions6Linear(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientModuleText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), ALTIUM_PCB::ParseTexts6Data(), DRAWING_TOOL::PlaceText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), TEXT_MOD_GRID_TABLE::SetValue(), LIB_TEXT::SetWidth(), LIB_FIELD::SetWidth(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and WS_DRAW_ITEM_TEXT::WS_DRAW_ITEM_TEXT().

◆ SetTextWidth()

◆ SetTextX()

void EDA_TEXT::SetTextX ( int  aX)
inlineinherited

◆ SetTextY()

◆ SetVertJustify()

void EDA_TEXT::SetVertJustify ( EDA_TEXT_VJUSTIFY_T  aType)
inlineinherited

◆ SetVisible()

void EDA_TEXT::SetVisible ( bool  aVisible)
inlineinherited

Definition at line 191 of file eda_text.h.

191 { m_e.Bit( TE_VISIBLE, aVisible ); }
TEXT_EFFECTS m_e
Definition: eda_text.h:383
void Bit(int aBit, bool aValue)
Definition: eda_text.h:108

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCB_MODULE::AddToBoard(), SCH_EDITOR_CONTROL::AssignFootprints(), PCB_BASE_FRAME::CreateNewModule(), EDA_TEXT_DESC::EDA_TEXT_DESC(), LIB_FIELD::Init(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), EAGLE_PLUGIN::loadElements(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_EAGLE_PLUGIN::loadLibrary(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibraryFieldAttribute(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_LEGACY_PLUGIN_CACHE::LoadPart(), EAGLE_PLUGIN::loadPlain(), SCH_EAGLE_PLUGIN::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute(), SCH_LEGACY_PLUGIN_CACHE::loadText(), ALTIUM_PCB::ParseComponents6Data(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseFileName(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_ALTIUM_PLUGIN::ParseSheetName(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_CHANGE_SYMBOLS::processSymbol(), processTextItem(), SCH_SEXPR_PLUGIN_CACHE::saveDcmInfoAsFields(), SCH_FIELD(), TEXT_MOD_GRID_TABLE::SetValueAsBool(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_EDIT_ONE_FIELD::updateText().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 196 of file eda_item.h.

196 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: eda_item.h:221
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:110

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ ShortenedShownText()

wxString EDA_TEXT::ShortenedShownText ( ) const