KiCad PCB EDA Suite
SCH_LINE Class Reference

Segment description base class to describe items which have 2 end points (track, wire, draw line ...) More...

#include <sch_line.h>

Inheritance diagram for SCH_LINE:
SCH_ITEM EDA_ITEM KIGFX::VIEW_ITEM INSPECTABLE

Public Member Functions

 SCH_LINE (const wxPoint &pos=wxPoint(0, 0), int layer=LAYER_NOTES)
 
 SCH_LINE (const VECTOR2D &pos, int layer=LAYER_NOTES)
 
 SCH_LINE (const SCH_LINE &aLine)
 
 ~SCH_LINE ()
 
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...
 
bool IsEndPoint (const wxPoint &aPoint) const
 
bool IsNull () const
 
wxPoint GetStartPoint () const
 
void SetStartPoint (const wxPoint &aPosition)
 
wxPoint GetEndPoint () const
 
void SetEndPoint (const wxPoint &aPosition)
 
PLOT_DASH_TYPE GetDefaultStyle () const
 
void SetLineStyle (const PLOT_DASH_TYPE aStyle)
 
void SetLineStyle (const int aStyleId)
 
PLOT_DASH_TYPE GetLineStyle () const
 
PLOT_DASH_TYPE GetEffectiveLineStyle () const
 
void SetLineColor (const COLOR4D &aColor)
 
void SetLineColor (const double r, const double g, const double b, const double a)
 
COLOR4D GetLineColor () const
 Returns COLOR4D::UNSPECIFIED if a custom color hasn't been set for this line. More...
 
void SetLineWidth (const int aSize)
 
virtual bool HasLineStroke () const override
 Check if this schematic item has line stoke properties. More...
 
virtual STROKE_PARAMS GetStroke () const override
 
virtual void SetStroke (const STROKE_PARAMS &aStroke) override
 
bool UsesDefaultStroke () const
 Test if the SCH_LINE object uses the default stroke settings. More...
 
int GetLineSize () const
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Return the layers the item is drawn on (which may be more than its "home" layer) More...
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
double GetLength () const
 
void Print (RENDER_SETTINGS *aSettings, const wxPoint &aOffset) override
 Print a schematic item. More...
 
int GetPenWidth () const override
 
void Move (const wxPoint &aMoveVector) override
 Move the item by aMoveVector to a new position. More...
 
void MoveStart (const wxPoint &aMoveVector)
 
void MoveEnd (const wxPoint &aMoveVector)
 
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...
 
void Rotate (wxPoint aPosition) override
 Rotate the item around aPosition 90 degrees in the clockwise direction. More...
 
void RotateStart (wxPoint aPosition)
 
void RotateEnd (wxPoint aPosition)
 
SCH_LINEMergeOverlap (SCH_LINE *aLine)
 Check line against aLine to see if it overlaps and merge if it does. More...
 
bool IsSameQuadrant (SCH_LINE *aLine, const wxPoint &aPosition)
 Check if two lines are in the same quadrant as each other, using a reference point as the origin. More...
 
bool IsParallel (SCH_LINE *aLine)
 
void GetEndPoints (std::vector< DANGLING_END_ITEM > &aItemList) override
 Add the schematic item end points to aItemList if the item has end points. More...
 
bool UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemList, const SCH_SHEET_PATH *aPath=nullptr) override
 Test the schematic item to aItemList to check if it's dangling state has changed. More...
 
bool IsStartDangling () const
 
bool IsEndDangling () const
 
bool IsDangling () const override
 
bool IsConnectable () const override
 
void GetConnectionPoints (std::vector< wxPoint > &aPoints) const override
 Add all the connection points for this item to aPoints. More...
 
void GetSelectedPoints (std::vector< wxPoint > &aPoints) const
 
bool CanConnect (const SCH_ITEM *aItem) const override
 
wxString GetSelectMenuText (EDA_UNITS aUnits) const override
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAP_DEF GetMenuImage () const override
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
void GetNetListItem (NETLIST_OBJECT_LIST &aNetListItems, SCH_SHEET_PATH *aSheetPath) override
 Create a new NETLIST_OBJECT for the schematic object and adds it to aNetListItems. More...
 
bool operator< (const SCH_ITEM &aItem) const override
 
wxPoint GetPosition () const override
 
void SetPosition (const wxPoint &aPosition) override
 Set the schematic item position to aPosition. More...
 
bool HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
 Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
 
void Plot (PLOTTER *aPlotter) override
 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...
 
void SwapData (SCH_ITEM *aItem) override
 Swap the internal data structures aItem with the schematic item. More...
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
bool IsGraphicLine () const
 Returns if the line is a graphic (non electrical line) More...
 
bool IsWire () const
 Returns true if the line is a wire. More...
 
SCH_ITEMDuplicate (bool doClone=false) const
 Routine to create a new copy of given item. More...
 
virtual bool IsMovableFromAnchorPoint ()
 
wxPointGetStoredPos ()
 
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 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 &aPath) const
 Retrieve the connection associated with this object in the given sheet. More...
 
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
 
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)
 
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 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 bool Matches (wxFindReplaceData &aSearchData, void *aAuxData)
 Function Matches compares the item against the search criteria in aSearchData. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Function IsReplaceable. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
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)
 

Static Public Member Functions

static bool ClassOf (const EDA_ITEM *aItem)
 
static const char * GetLineStyleName (PLOT_DASH_TYPE aStyle)
 
static PLOT_DASH_TYPE GetLineStyleByName (const wxString &aStyleName)
 
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...
 

Public Attributes

const KIID m_Uuid
 

Static Public Attributes

static enum wxPenStyle PenStyle []
 

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, 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 Member Functions

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

Private Attributes

bool m_startIsDangling
 True if start point is not connected. More...
 
bool m_endIsDangling
 True if end point is not connected. More...
 
wxPoint m_start
 Line start point. More...
 
wxPoint m_end
 Line end point. More...
 
STROKE_PARAMS m_stroke
 Line stroke properties. More...
 

Detailed Description

Segment description base class to describe items which have 2 end points (track, wire, draw line ...)

Definition at line 37 of file sch_line.h.

Constructor & Destructor Documentation

◆ SCH_LINE() [1/3]

SCH_LINE::SCH_LINE ( const wxPoint pos = wxPoint( 0, 0 ),
int  layer = LAYER_NOTES 
)

Definition at line 37 of file sch_line.cpp.

37  :
39 {
40  m_start = pos;
41  m_end = pos;
43  m_stroke.SetWidth( 0 );
45  m_stroke.SetColor( COLOR4D::UNSPECIFIED );
46 
47  switch( layer )
48  {
49  default: m_Layer = LAYER_NOTES; break;
50  case LAYER_WIRE: m_Layer = LAYER_WIRE; break;
51  case LAYER_BUS: m_Layer = LAYER_BUS; break;
52  }
53 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:192
void SetWidth(int aWidth)
Definition: sch_item.h:170
bool m_endIsDangling
True if end point is not connected.
Definition: sch_line.h:40
void SetType(PLOT_DASH_TYPE aType)
Definition: sch_item.h:173
#define NULL
bool m_startIsDangling
True if start point is not connected.
Definition: sch_line.h:39
wxPoint m_end
Line end point.
Definition: sch_line.h:42
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
void SetColor(const COLOR4D &aColor)
Definition: sch_item.h:176
wxPoint m_start
Line start point.
Definition: sch_line.h:41
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:50

References DEFAULT, LAYER_BUS, LAYER_NOTES, LAYER_WIRE, m_end, m_endIsDangling, SCH_ITEM::m_Layer, m_start, m_startIsDangling, m_stroke, STROKE_PARAMS::SetColor(), STROKE_PARAMS::SetType(), and STROKE_PARAMS::SetWidth().

Referenced by Clone(), and MergeOverlap().

◆ SCH_LINE() [2/3]

SCH_LINE::SCH_LINE ( const VECTOR2D pos,
int  layer = LAYER_NOTES 
)
inline

Definition at line 51 of file sch_line.h.

51  :
52  SCH_LINE( wxPoint( pos.x, pos.y ), layer )
53  {}
SCH_LINE(const wxPoint &pos=wxPoint(0, 0), int layer=LAYER_NOTES)
Definition: sch_line.cpp:37

◆ SCH_LINE() [3/3]

SCH_LINE::SCH_LINE ( const SCH_LINE aLine)

Definition at line 56 of file sch_line.cpp.

56  :
57  SCH_ITEM( aLine )
58 {
59  m_start = aLine.m_start;
60  m_end = aLine.m_end;
61  m_stroke = aLine.m_stroke;
64 }
bool m_endIsDangling
True if end point is not connected.
Definition: sch_line.h:40
bool m_startIsDangling
True if start point is not connected.
Definition: sch_line.h:39
wxPoint m_end
Line end point.
Definition: sch_line.h:42
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
wxPoint m_start
Line start point.
Definition: sch_line.h:41
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:50

References m_end, m_endIsDangling, m_start, m_startIsDangling, and m_stroke.

◆ ~SCH_LINE()

SCH_LINE::~SCH_LINE ( )
inline

Definition at line 57 of file sch_line.h.

57 { }

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 182 of file sch_item.cpp.

183 {
184  m_connected_items[ aSheet ].insert( aItem );
185 }
std::unordered_map< SCH_SHEET_PATH, ITEM_SET > m_connected_items
Stores pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:199

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

451  {
452  if( GetFieldsAutoplaced() )
454  }
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition: sch_item.h:435
virtual void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Definition: sch_item.h:456

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

456 { }

Referenced by SCH_ITEM::AutoAutoplaceFields().

◆ CanConnect()

bool SCH_LINE::CanConnect ( const SCH_ITEM aItem) const
overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 550 of file sch_line.cpp.

551 {
552  switch( aItem->Type() )
553  {
554  case SCH_JUNCTION_T:
555  case SCH_NO_CONNECT_T:
556  case SCH_LABEL_T:
557  case SCH_GLOBAL_LABEL_T:
558  case SCH_HIER_LABEL_T:
560  case SCH_COMPONENT_T:
561  case SCH_SHEET_T:
562  case SCH_SHEET_PIN_T:
563  return true;
564 
565  default:
566  return aItem->GetLayer() == m_Layer;
567  }
568 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:192
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References SCH_ITEM::GetLayer(), SCH_ITEM::m_Layer, SCH_BUS_WIRE_ENTRY_T, SCH_COMPONENT_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_NO_CONNECT_T, SCH_SHEET_PIN_T, SCH_SHEET_T, and EDA_ITEM::Type().

◆ ClassOf()

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

Definition at line 59 of file sch_line.h.

60  {
61  return aItem && SCH_LINE_T == aItem->Type();
62  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References SCH_LINE_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 387 of file sch_item.h.

387 { m_connections.clear(); }
EDA_ITEMS m_connections
Definition: sch_item.h:193

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )
inlineinherited

Set fields automatically placed flag false.

Definition at line 440 of file sch_item.h.

FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:194

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

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

◆ ClearFlags()

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

Definition at line 233 of file base_struct.h.

233 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), LIB_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_EDIT_FRAME::DeleteAnnotation(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceModule(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::RollbackPartFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 245 of file base_struct.h.

246  {
248  DO_NOT_DRAW );
249  }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:114
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: base_struct.h:125
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:128
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:127
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:123
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:233
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:129
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:122

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_LINE::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 67 of file sch_line.cpp.

68 {
69  return new SCH_LINE( *this );
70 }
SCH_LINE(const wxPoint &pos=wxPoint(0, 0), int layer=LAYER_NOTES)
Definition: sch_line.cpp:37

References SCH_LINE().

◆ ConnectedItems()

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 176 of file sch_item.cpp.

177 {
178  return m_connected_items[ aSheet ];
179 }
std::unordered_map< SCH_SHEET_PATH, ITEM_SET > m_connected_items
Stores pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:199

References SCH_ITEM::m_connected_items.

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

◆ Connection()

◆ ConnectionPropagatesTo()

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

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

Reimplemented in SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 424 of file sch_item.h.

424 { return true; }

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

◆ doIsConnected()

bool SCH_LINE::doIsConnected ( const wxPoint aPosition) const
overrideprivatevirtual

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

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

Reimplemented from SCH_ITEM.

Definition at line 720 of file sch_line.cpp.

721 {
722  if( m_Layer != LAYER_WIRE && m_Layer != LAYER_BUS )
723  return false;
724 
725  return IsEndPoint( aPosition );
726 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:192
bool IsEndPoint(const wxPoint &aPoint) const
Definition: sch_line.h:87

References IsEndPoint(), LAYER_BUS, LAYER_WIRE, and SCH_ITEM::m_Layer.

◆ 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 81 of file sch_item.cpp.

82 {
83  SCH_ITEM* newItem = (SCH_ITEM*) Clone();
84 
85  if( !doClone )
86  const_cast<KIID&>( newItem->m_Uuid ) = KIID();
87 
88  newItem->ClearFlags( SELECTED | BRIGHTENED );
89 
90  if( newItem->Type() == SCH_COMPONENT_T )
91  {
92  SCH_COMPONENT* component = (SCH_COMPONENT*) newItem;
93 
94  for( SCH_PIN* pin : component->GetSchPins() )
95  pin->ClearFlags( SELECTED | BRIGHTENED );
96 
97  for( SCH_FIELD& field : component->GetFields() )
98  field.ClearFlags( SELECTED | BRIGHTENED );
99  }
100 
101  if( newItem->Type() == SCH_SHEET_T )
102  {
103  SCH_SHEET* sheet = (SCH_SHEET*) newItem;
104 
105  for( SCH_FIELD& field : sheet->GetFields() )
106  field.ClearFlags( SELECTED | BRIGHTENED );
107 
108  for( SCH_SHEET_PIN* pin : sheet->GetPins() )
109  pin->ClearFlags( SELECTED | BRIGHTENED );
110  }
111 
112  return newItem;
113 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populates a std::vector with SCH_FIELDs.
std::vector< SCH_FIELD > & GetFields()
Definition: sch_sheet.h:268
#define SELECTED
Definition: base_struct.h:124
Definition: common.h:68
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:139
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:216
const KIID m_Uuid
Definition: base_struct.h:162
std::vector< SCH_SHEET_PIN * > & GetPins()
Definition: sch_sheet.h:362
Schematic symbol object.
Definition: sch_component.h:88
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:233
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:187
SCH_PIN_PTRS GetSchPins(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieves a list of the SCH_PINs for the given sheet path.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

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

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

◆ 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:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
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:58
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:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
T
enum T contains all this lexer's tokens.
Provides class metadata.
Definition: property_mgr.h:58
T get(void *aObject)
Definition: property.h:273
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:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
T
enum T contains all this lexer's tokens.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Returns a property for a specific type.
Provides class metadata.
Definition: property_mgr.h:58
T get(void *aObject)
Definition: property.h:273
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_LINE::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 165 of file sch_line.cpp.

166 {
167  int width = m_stroke.GetWidth() / 2;
168  int extra = m_stroke.GetWidth() & 0x1;
169 
170  int xmin = std::min( m_start.x, m_end.x ) - width;
171  int ymin = std::min( m_start.y, m_end.y ) - width;
172 
173  int xmax = std::max( m_start.x, m_end.x ) + width + extra;
174  int ymax = std::max( m_start.y, m_end.y ) + width + extra;
175 
176  EDA_RECT ret( wxPoint( xmin, ymin ), wxSize( xmax - xmin, ymax - ymin ) );
177 
178  return ret;
179 }
int GetWidth() const
Definition: sch_item.h:169
wxPoint m_end
Line end point.
Definition: sch_line.h:42
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References STROKE_PARAMS::GetWidth(), m_end, m_start, m_stroke, wxPoint::x, and wxPoint::y.

◆ GetClass()

wxString SCH_LINE::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from SCH_ITEM.

Definition at line 64 of file sch_line.h.

65  {
66  return wxT( "SCH_LINE" );
67  }

◆ GetConnectionPoints()

void SCH_LINE::GetConnectionPoints ( std::vector< wxPoint > &  aPoints) const
overridevirtual

Add all the connection points for this item to aPoints.

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

Parameters
aPointsList of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 571 of file sch_line.cpp.

572 {
573  aPoints.push_back( m_start );
574  aPoints.push_back( m_end );
575 }
wxPoint m_end
Line end point.
Definition: sch_line.h:42
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_end, and m_start.

◆ GetDefaultStyle()

PLOT_DASH_TYPE SCH_LINE::GetDefaultStyle ( ) const

Definition at line 220 of file sch_line.cpp.

221 {
222  if( IsGraphicLine() )
223  return PLOT_DASH_TYPE::DASH;
224 
225  return PLOT_DASH_TYPE::SOLID;
226 }
bool IsGraphicLine() const
Returns if the line is a graphic (non electrical line)
Definition: sch_line.cpp:810

References DASH, IsGraphicLine(), and SOLID.

Referenced by GetLineStyle(), SCH_LEGACY_PLUGIN::saveLine(), SetLineStyle(), and UsesDefaultStroke().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 237 of file base_struct.h.

238  {
239  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
241 
242  return m_Flags & mask;
243  }
#define IS_NEW
New item, just created.
Definition: base_struct.h:117
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:119
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:121
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:118
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
Definition: base_struct.h:130
#define IS_MOVED
Item being moved.
Definition: base_struct.h:116

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(), 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_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ GetEffectiveLineStyle()

PLOT_DASH_TYPE SCH_LINE::GetEffectiveLineStyle ( ) const
Returns
the style that the line should be drawn in this might be set on the line or inherited from the line's netclass

Definition at line 253 of file sch_line.cpp.

254 {
255  NETCLASSPTR netclass = NetClass();
256 
257  if( netclass )
258  return (PLOT_DASH_TYPE) netclass->GetLineStyle();
259 
260  return GetLineStyle();
261 }
PLOT_DASH_TYPE GetLineStyle() const
Definition: sch_line.cpp:244
NETCLASSPTR NetClass() const
Definition: sch_item.cpp:160
PLOT_DASH_TYPE
Enum for choosing dashed line type.
Definition: plotter.h:87

References GetLineStyle(), and SCH_ITEM::NetClass().

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

◆ GetEndPoint()

◆ GetEndPoints()

void SCH_LINE::GetEndPoints ( std::vector< DANGLING_END_ITEM > &  aItemList)
overridevirtual

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

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

Parameters
aItemList- List of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 483 of file sch_line.cpp.

484 {
485  if( IsGraphicLine() )
486  return;
487 
488  if( ( GetLayer() == LAYER_BUS ) || ( GetLayer() == LAYER_WIRE ) )
489  {
491  m_start );
492  aItemList.push_back( item );
493 
495  m_end );
496  aItemList.push_back( item1 );
497  }
498 }
bool IsGraphicLine() const
Returns if the line is a graphic (non electrical line)
Definition: sch_line.cpp:810
wxPoint m_end
Line end point.
Definition: sch_line.h:42
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272
Helper class used to store the state of schematic items that can be connected to other schematic item...
Definition: sch_item.h:85
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References BUS_END_END, BUS_START_END, SCH_ITEM::GetLayer(), IsGraphicLine(), LAYER_BUS, LAYER_WIRE, m_end, m_start, WIRE_END_END, and WIRE_START_END.

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const
inlineinherited

Return whether the fields have been automatically placed.

Definition at line 435 of file sch_item.h.

435 { return m_fieldsAutoplaced; }
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:194

References SCH_ITEM::m_fieldsAutoplaced.

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

◆ 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 DRAWSEGMENT, and TRACK.

Definition at line 344 of file base_struct.h.

344 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: base_struct.h:337

References EDA_ITEM::GetPosition().

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

◆ GetLayer()

◆ GetLength()

double SCH_LINE::GetLength ( ) const
Returns
The length of the line segment.

Definition at line 182 of file sch_line.cpp.

183 {
184  return GetLineLength( m_start, m_end );
185 }
double GetLineLength(const wxPoint &aPointA, const wxPoint &aPointB)
Return the length of a line segment defined by aPointA and aPointB.
Definition: trigo.h:206
wxPoint m_end
Line end point.
Definition: sch_line.h:42
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References GetLineLength(), m_end, and m_start.

◆ GetLineColor()

COLOR4D SCH_LINE::GetLineColor ( ) const

Returns COLOR4D::UNSPECIFIED if a custom color hasn't been set for this line.

Definition at line 209 of file sch_line.cpp.

210 {
211  NETCLASSPTR netclass = NetClass();
212 
213  if( netclass && netclass->GetSchematicColor() != COLOR4D::UNSPECIFIED )
214  return netclass->GetSchematicColor();
215 
216  return m_stroke.GetColor();
217 }
NETCLASSPTR NetClass() const
Definition: sch_item.cpp:160
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
COLOR4D GetColor() const
Definition: sch_item.h:175

References STROKE_PARAMS::GetColor(), m_stroke, and SCH_ITEM::NetClass().

Referenced by Plot(), Print(), SCH_LEGACY_PLUGIN::saveLine(), and SCH_EDIT_FRAME::SchematicCleanUp().

◆ GetLineSize()

int SCH_LINE::GetLineSize ( ) const
inline

Definition at line 140 of file sch_line.h.

140 { return m_stroke.GetWidth(); }
int GetWidth() const
Definition: sch_item.h:169
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43

References STROKE_PARAMS::GetWidth(), and m_stroke.

Referenced by SCH_LEGACY_PLUGIN::saveLine(), and SCH_EDIT_FRAME::SchematicCleanUp().

◆ GetLineStyle()

PLOT_DASH_TYPE SCH_LINE::GetLineStyle ( ) const

Definition at line 244 of file sch_line.cpp.

245 {
247  return m_stroke.GetType();
248 
249  return GetDefaultStyle();
250 }
PLOT_DASH_TYPE GetDefaultStyle() const
Definition: sch_line.cpp:220
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
PLOT_DASH_TYPE GetType() const
Definition: sch_item.h:172

References DEFAULT, GetDefaultStyle(), STROKE_PARAMS::GetType(), and m_stroke.

Referenced by GetEffectiveLineStyle(), GetMsgPanelInfo(), SCH_LEGACY_PLUGIN::saveLine(), and SCH_EDIT_FRAME::SchematicCleanUp().

◆ GetLineStyleByName()

PLOT_DASH_TYPE SCH_LINE::GetLineStyleByName ( const wxString &  aStyleName)
static
Returns
the style id from the style name (mainly to read style from .sch file)

Definition at line 94 of file sch_line.cpp.

95 {
96  PLOT_DASH_TYPE id = PLOT_DASH_TYPE::DEFAULT; // Default style id
97 
98  //find the name by value
99  auto resultIt = std::find_if( lineStyleNames.begin(), lineStyleNames.end(),
100  [aStyleName]( const auto& it ) { return it.second == aStyleName; } );
101 
102  if( resultIt != lineStyleNames.end() )
103  id = resultIt->first;
104 
105  return id;
106 }
const std::map< PLOT_DASH_TYPE, const char * > lineStyleNames
Definition: sch_line.cpp:76
PLOT_DASH_TYPE
Enum for choosing dashed line type.
Definition: plotter.h:87

References DEFAULT, and lineStyleNames.

Referenced by SCH_LEGACY_PLUGIN::loadWire().

◆ GetLineStyleName()

const char * SCH_LINE::GetLineStyleName ( PLOT_DASH_TYPE  aStyle)
static
Returns
the style name from the style id (mainly to write it in .sch file)

Definition at line 84 of file sch_line.cpp.

85 {
86  auto resultIt = lineStyleNames.find( aStyle );
87 
88  //legacy behavior is to default to dash if there is no name
89  return resultIt == lineStyleNames.end() ? lineStyleNames.find( PLOT_DASH_TYPE::DASH )->second :
90  resultIt->second;
91 }
const std::map< PLOT_DASH_TYPE, const char * > lineStyleNames
Definition: sch_line.cpp:76

References DASH, and lineStyleNames.

Referenced by GetMsgPanelInfo(), and SCH_LEGACY_PLUGIN::saveLine().

◆ GetMenuImage()

BITMAP_DEF SCH_LINE::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 614 of file sch_line.cpp.

615 {
616  if( m_Layer == LAYER_NOTES )
617  return add_dashed_line_xpm;
618  else if( m_Layer == LAYER_WIRE )
619  return add_line_xpm;
620 
621  return add_bus_xpm;
622 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:192
const BITMAP_OPAQUE add_dashed_line_xpm[1]
const BITMAP_OPAQUE add_line_xpm[1]
Definition: add_line.cpp:30
const BITMAP_OPAQUE add_bus_xpm[1]
Definition: add_bus.cpp:30

References add_bus_xpm, add_dashed_line_xpm, add_line_xpm, LAYER_NOTES, LAYER_WIRE, and SCH_ITEM::m_Layer.

◆ GetMsgPanelInfo()

void SCH_LINE::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

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

Parameters
aListis the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 769 of file sch_line.cpp.

770 {
771  wxString msg;
772 
773  switch( GetLayer() )
774  {
775  case LAYER_WIRE: msg = _( "Wire" ); break;
776  case LAYER_BUS: msg = _( "Bus" ); break;
777  default: msg = _( "Graphical" ); break;
778  }
779 
780  aList.push_back( MSG_PANEL_ITEM( _( "Line Type" ), msg, DARKCYAN ) );
781 
783  msg = _( "from netclass" );
784  else
785  msg = GetLineStyleName( GetLineStyle() );
786 
787  aList.push_back( MSG_PANEL_ITEM( _( "Line Style" ), msg, DARKCYAN ) );
788 
789  SCH_EDIT_FRAME* frame = dynamic_cast<SCH_EDIT_FRAME*>( aFrame );
790 
791  if( frame )
792  {
793  if( SCH_CONNECTION* conn = Connection( frame->GetCurrentSheet() ) )
794  {
795  conn->AppendInfoToMsgPanel( aList );
796 
797  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
798  const wxString& netname = conn->Name( true );
799 
800  if( netSettings.m_NetClassAssignments.count( netname ) )
801  {
802  const wxString& netclassName = netSettings.m_NetClassAssignments[ netname ];
803  aList.push_back( MSG_PANEL_ITEM( _( "Assigned Netclass" ), netclassName, DARKRED ) );
804  }
805  }
806  }
807 }
static const char * GetLineStyleName(PLOT_DASH_TYPE aStyle)
Definition: sch_line.cpp:84
std::map< wxString, wxString > m_NetClassAssignments
Definition: net_settings.h:43
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:116
NET_SETTINGS & NetSettings()
Definition: project_file.h:92
Schematic editor (Eeschema) main window.
PLOT_DASH_TYPE GetLineStyle() const
Definition: sch_line.cpp:244
VTBL_ENTRY PROJECT_FILE & GetProjectFile() const
Definition: project.h:129
NET_SETTINGS stores various net-related settings in a project context.
Definition: net_settings.h:31
SCH_CONNECTION * Connection(const SCH_SHEET_PATH &aPath) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:150
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272
PLOT_DASH_TYPE GetEffectiveLineStyle() const
Definition: sch_line.cpp:253
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
#define _(s)
Definition: 3d_actions.cpp:33
PROJECT & Prj() const
Return a reference to the project this schematic is part of.
Definition: schematic.h:77
SCH_SHEET_PATH & GetCurrentSheet() const
EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53

References _, SCH_ITEM::Connection(), DARKCYAN, DARKRED, SCH_EDIT_FRAME::GetCurrentSheet(), GetEffectiveLineStyle(), SCH_ITEM::GetLayer(), GetLineStyle(), GetLineStyleName(), PROJECT::GetProjectFile(), LAYER_BUS, LAYER_WIRE, NET_SETTINGS::m_NetClassAssignments, PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

◆ GetNetListItem()

void SCH_LINE::GetNetListItem ( NETLIST_OBJECT_LIST aNetListItems,
SCH_SHEET_PATH aSheetPath 
)
overridevirtual

Create a new NETLIST_OBJECT for the schematic object and adds it to aNetListItems.

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

Reimplemented from SCH_ITEM.

Definition at line 625 of file sch_line.cpp.

627 {
628  // Net list item not required for graphic lines.
629  if( IsGraphicLine() )
630  return;
631 
632  NETLIST_OBJECT* item = new NETLIST_OBJECT();
633  item->m_SheetPath = *aSheetPath;
634  item->m_SheetPathInclude = *aSheetPath;
635  item->m_Comp = (SCH_ITEM*) this;
636  item->m_Start = m_start;
637  item->m_End = m_end;
638 
639  if( GetLayer() == LAYER_BUS )
640  {
641  item->m_Type = NETLIST_ITEM::BUS;
642  }
643  else /* WIRE */
644  {
646  }
647 
648  aNetListItems.push_back( item );
649 }
bool IsGraphicLine() const
Returns if the line is a graphic (non electrical line)
Definition: sch_line.cpp:810
SCH_SHEET_PATH m_SheetPathInclude
SCH_SHEET_PATH m_SheetPath
EDA_ITEM * m_Comp
wxPoint m_end
Line end point.
Definition: sch_line.h:42
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272
NETLIST_ITEM m_Type
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:187
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References BUS, SCH_ITEM::GetLayer(), IsGraphicLine(), LAYER_BUS, NETLIST_OBJECT::m_Comp, m_end, NETLIST_OBJECT::m_End, NETLIST_OBJECT::m_SheetPath, NETLIST_OBJECT::m_SheetPathInclude, m_start, NETLIST_OBJECT::m_Start, NETLIST_OBJECT::m_Type, and SEGMENT.

◆ GetParent()

◆ GetPenWidth()

int SCH_LINE::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 270 of file sch_line.cpp.

271 {
272  NETCLASSPTR netclass = NetClass();
273 
274  if( netclass )
275  return ( m_Layer == LAYER_BUS ) ? netclass->GetBusWidth() : netclass->GetWireWidth();
276 
277  if( m_stroke.GetWidth() == 0 && Schematic() )
278  return std::max( Schematic()->Settings().m_DefaultLineWidth, 1 );
279 
280  return std::max( m_stroke.GetWidth(), 1 );
281 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:192
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:138
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:116
NETCLASSPTR NetClass() const
Definition: sch_item.cpp:160
int GetWidth() const
Definition: sch_item.h:169
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43

References STROKE_PARAMS::GetWidth(), LAYER_BUS, SCHEMATIC_SETTINGS::m_DefaultLineWidth, SCH_ITEM::m_Layer, m_stroke, SCH_ITEM::NetClass(), SCH_ITEM::Schematic(), and SCHEMATIC::Settings().

Referenced by HitTest(), Plot(), and Print().

◆ GetPosition()

wxPoint SCH_LINE::GetPosition ( ) const
inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 214 of file sch_line.h.

214 { return m_start; }
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_start.

Referenced by EE_POINT_EDITOR::updateItem().

◆ GetSelectedPoints()

void SCH_LINE::GetSelectedPoints ( std::vector< wxPoint > &  aPoints) const

Definition at line 578 of file sch_line.cpp.

579 {
580  if( m_Flags & STARTPOINT )
581  aPoints.push_back( m_start );
582 
583  if( m_Flags & ENDPOINT )
584  aPoints.push_back( m_end );
585 }
wxPoint m_end
Line end point.
Definition: sch_line.h:42
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:123
wxPoint m_start
Line start point.
Definition: sch_line.h:41
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:122

References ENDPOINT, m_end, EDA_ITEM::m_Flags, m_start, and STARTPOINT.

◆ GetSelectMenuText()

wxString SCH_LINE::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 588 of file sch_line.cpp.

589 {
590  wxString txtfmt, orient;
591 
592  if( m_start.x == m_end.x )
593  orient = _( "Vertical" );
594  else if( m_start.y == m_end.y )
595  orient = _( "Horizontal" );
596 
597  switch( m_Layer )
598  {
599  case LAYER_NOTES: txtfmt = _( "%s Graphic Line from (%s, %s) to (%s, %s)" ); break;
600  case LAYER_WIRE: txtfmt = _( "%s Wire from (%s, %s) to (%s, %s)" ); break;
601  case LAYER_BUS: txtfmt = _( "%s Bus from (%s, %s) to (%s, %s)" ); break;
602  default: txtfmt = _( "%s Line on Unknown Layer from (%s, %s) to (%s, %s)" ); break;
603  }
604 
605  return wxString::Format( txtfmt,
606  orient,
607  MessageTextFromValue( aUnits, m_start.x ),
608  MessageTextFromValue( aUnits, m_start.y ),
609  MessageTextFromValue( aUnits, m_end.x ),
610  MessageTextFromValue( aUnits, m_end.y ) );
611 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:192
wxPoint m_end
Line end point.
Definition: sch_line.h:42
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aUseMils, EDA_DATA_TYPE aType)
Definition: base_units.cpp:124
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
#define _(s)
Definition: 3d_actions.cpp:33
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References _, Format(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, m_end, SCH_ITEM::m_Layer, m_start, MessageTextFromValue(), wxPoint::x, and wxPoint::y.

◆ GetStartPoint()

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 216 of file base_struct.h.

217  {
218  return m_Status & type;
219  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

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

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 229 of file base_struct.h.

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

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 243 of file sch_item.h.

243 { return m_storedPos; }
wxPoint m_storedPos
Definition: sch_item.h:195

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::moveItem().

◆ GetStroke()

virtual STROKE_PARAMS SCH_LINE::GetStroke ( ) const
inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 128 of file sch_line.h.

128 { return m_stroke; }
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43

References m_stroke.

Referenced by SCH_SEXPR_PLUGIN::saveLine().

◆ HasFlag()

◆ HasLineStroke()

virtual bool SCH_LINE::HasLineStroke ( ) const
inlineoverridevirtual

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

Definition at line 127 of file sch_line.h.

127 { return true; }

◆ HitTest() [1/2]

bool SCH_LINE::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 675 of file sch_line.cpp.

676 {
677  // Performance enhancement for connection-building
678  if( aPosition == m_start || aPosition == m_end )
679  return true;
680 
681  // Insure minimum accuracy
682  if( aAccuracy == 0 )
683  aAccuracy = ( GetPenWidth() / 2 ) + 4;
684 
685  return TestSegmentHit( aPosition, m_start, m_end, aAccuracy );
686 }
bool TestSegmentHit(const wxPoint &aRefPoint, wxPoint aStart, wxPoint aEnd, int aDist)
Test if aRefPoint is with aDistance on the line defined by aStart and aEnd.
Definition: trigo.cpp:129
int GetPenWidth() const override
Definition: sch_line.cpp:270
wxPoint m_end
Line end point.
Definition: sch_line.h:42
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References GetPenWidth(), m_end, m_start, and TestSegmentHit().

Referenced by SCH_MOVE_TOOL::getConnectedDragItems().

◆ HitTest() [2/2]

bool SCH_LINE::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 689 of file sch_line.cpp.

690 {
691  if( m_Flags & ( STRUCT_DELETED | SKIP_STRUCT ) )
692  return false;
693 
694  EDA_RECT rect = aRect;
695 
696  if ( aAccuracy )
697  rect.Inflate( aAccuracy );
698 
699  if( aContained )
700  return rect.Contains( m_start ) && rect.Contains( m_end );
701 
702  return rect.Intersects( m_start, m_end );
703 }
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:128
bool Contains(const wxPoint &aPoint) const
Function Contains.
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
wxPoint m_end
Line end point.
Definition: sch_line.h:42
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
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.
wxPoint m_start
Line start point.
Definition: sch_line.h:41
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References EDA_RECT::Contains(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), m_end, EDA_ITEM::m_Flags, m_start, SKIP_STRUCT, and STRUCT_DELETED.

◆ 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 188 of file sch_item.cpp.

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

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

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

◆ IsConnectable()

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

Reimplemented from SCH_ITEM.

Definition at line 541 of file sch_line.cpp.

542 {
543  if( m_Layer == LAYER_WIRE || m_Layer == LAYER_BUS )
544  return true;
545 
546  return false;
547 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:192

References LAYER_BUS, LAYER_WIRE, and SCH_ITEM::m_Layer.

◆ 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 141 of file sch_item.cpp.

142 {
143  if( ( m_Flags & STRUCT_DELETED ) || ( m_Flags & SKIP_STRUCT ) )
144  return false;
145 
146  return doIsConnected( aPosition );
147 }
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:128
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
virtual bool doIsConnected(const wxPoint &aPosition) const
Provide the object specific test to see if it is connected to aPosition.
Definition: sch_item.h:513

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

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

References SCH_ITEM::m_connectivity_dirty.

◆ IsDangling()

bool SCH_LINE::IsDangling ( ) const
inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 196 of file sch_line.h.

196 { return m_startIsDangling || m_endIsDangling; }
bool m_endIsDangling
True if end point is not connected.
Definition: sch_line.h:40
bool m_startIsDangling
True if start point is not connected.
Definition: sch_line.h:39

References m_endIsDangling, and m_startIsDangling.

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 201 of file base_struct.h.

201 { return m_Flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:119
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References IS_DRAGGED, and EDA_ITEM::m_Flags.

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

◆ IsEndDangling()

bool SCH_LINE::IsEndDangling ( ) const
inline

Definition at line 195 of file sch_line.h.

195 { return m_endIsDangling; }
bool m_endIsDangling
True if end point is not connected.
Definition: sch_line.h:40

References m_endIsDangling.

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

◆ IsEndPoint()

bool SCH_LINE::IsEndPoint ( const wxPoint aPoint) const
inline

Definition at line 87 of file sch_line.h.

88  {
89  return aPoint == m_start || aPoint == m_end;
90  }
wxPoint m_end
Line end point.
Definition: sch_line.h:42
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_end, and m_start.

Referenced by SCH_EDIT_FRAME::BreakSegment(), SCH_EDIT_FRAME::DeleteJunction(), doIsConnected(), and SCH_EDIT_FRAME::SchematicCleanUp().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 286 of file base_struct.h.

286 { return m_forceVisible; }
bool m_forceVisible
Definition: base_struct.h:175

References EDA_ITEM::m_forceVisible.

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

◆ IsGraphicLine()

bool SCH_LINE::IsGraphicLine ( ) const

Returns if the line is a graphic (non electrical line)

Currently, anything on the internal NOTES layer is a graphic line

Definition at line 810 of file sch_line.cpp.

811 {
812  return ( GetLayer() == LAYER_NOTES );
813 }
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272

References SCH_ITEM::GetLayer(), and LAYER_NOTES.

Referenced by GetDefaultStyle(), GetEndPoints(), GetNetListItem(), SCH_LEGACY_PLUGIN::saveLine(), and UpdateDanglingState().

◆ IsLocked()

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

Definition at line 262 of file sch_item.h.

262 { return false; }

Referenced by SCH_EDIT_TOOL::DeleteItemCursor().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 198 of file base_struct.h.

198 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:113
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

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

241 { return true; }

Referenced by SCH_MOVE_TOOL::Main().

◆ IsMoving()

◆ IsNew()

◆ IsNull()

bool SCH_LINE::IsNull ( ) const
inline

Definition at line 92 of file sch_line.h.

92 { return m_start == m_end; }
wxPoint m_end
Line end point.
Definition: sch_line.h:42
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_end, and m_start.

Referenced by SCH_EDIT_FRAME::SchematicCleanUp(), and SCH_LINE_WIRE_BUS_TOOL::simplifyWireList().

◆ IsParallel()

bool SCH_LINE::IsParallel ( SCH_LINE aLine)

Definition at line 357 of file sch_line.cpp.

358 {
359  wxCHECK_MSG( aLine != NULL && aLine->Type() == SCH_LINE_T, false,
360  wxT( "Cannot test line segment for overlap." ) );
361 
362  wxPoint firstSeg = m_end - m_start;
363  wxPoint secondSeg = aLine->m_end - aLine->m_start;
364 
365  // Use long long here to avoid overflow in calculations
366  return !( (long long) firstSeg.x * secondSeg.y - (long long) firstSeg.y * secondSeg.x );
367 }
#define NULL
wxPoint m_end
Line end point.
Definition: sch_line.h:42
wxPoint m_start
Line start point.
Definition: sch_line.h:41
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References m_end, m_start, NULL, SCH_LINE_T, EDA_ITEM::Type(), wxPoint::x, and wxPoint::y.

Referenced by SCH_EDIT_FRAME::SchematicCleanUp(), and SCH_LINE_WIRE_BUS_TOOL::simplifyWireList().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

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

Definition at line 501 of file base_struct.h.

501 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 204 of file base_struct.h.

204 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:118

References IS_RESIZED, and EDA_ITEM::m_Flags.

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

◆ IsSameQuadrant()

bool SCH_LINE::IsSameQuadrant ( SCH_LINE aLine,
const wxPoint aPosition 
)

Check if two lines are in the same quadrant as each other, using a reference point as the origin.

Parameters
aLine- Line to compare
aPosition- Point to reference against lines
Returns
true if lines are mostly in different quadrants of aPosition, false otherwise

Definition at line 334 of file sch_line.cpp.

335 {
336  wxPoint first;
337  wxPoint second;
338 
339  if( m_start == aPosition )
340  first = m_end - aPosition;
341  else if( m_end == aPosition )
342  first = m_start - aPosition;
343  else
344  return false;
345 
346  if( aLine->m_start == aPosition )
347  second = aLine->m_end - aPosition;
348  else if( aLine->m_end == aPosition )
349  second = aLine->m_start - aPosition;
350  else
351  return false;
352 
353  return ( sign( first.x ) == sign( second.x ) && sign( first.y ) == sign( second.y ) );
354 }
int sign(T val)
Definition: util.h:101
wxPoint m_end
Line end point.
Definition: sch_line.h:42
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_end, m_start, sign(), wxPoint::x, and wxPoint::y.

◆ IsSelected()

◆ IsStartDangling()

bool SCH_LINE::IsStartDangling ( ) const
inline

Definition at line 194 of file sch_line.h.

194 { return m_startIsDangling; }
bool m_startIsDangling
True if start point is not connected.
Definition: sch_line.h:39

References m_startIsDangling.

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

◆ IsType()

bool SCH_LINE::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 69 of file sch_line.h.

70  {
71  if( SCH_ITEM::IsType( aScanTypes ) )
72  return true;
73 
74  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
75  {
76  if( *p == SCH_LINE_LOCATE_WIRE_T && m_Layer == LAYER_WIRE )
77  return true;
78  else if ( *p == SCH_LINE_LOCATE_BUS_T && m_Layer == LAYER_BUS )
79  return true;
80  else if ( *p == SCH_LINE_LOCATE_GRAPHIC_LINE_T && m_Layer == LAYER_NOTES )
81  return true;
82  }
83 
84  return false;
85  }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:192
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: base_struct.h:262

References EOT, EDA_ITEM::IsType(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, SCH_ITEM::m_Layer, SCH_LINE_LOCATE_BUS_T, SCH_LINE_LOCATE_GRAPHIC_LINE_T, and SCH_LINE_LOCATE_WIRE_T.

Referenced by SCH_EDIT_FRAME::DeleteJunction().

◆ IsWire()

bool SCH_LINE::IsWire ( ) const

Returns true if the line is a wire.

Returns
true if this line is on the wire layer.

Definition at line 816 of file sch_line.cpp.

817 {
818  return ( GetLayer() == LAYER_WIRE );
819 }
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272

References SCH_ITEM::GetLayer(), and LAYER_WIRE.

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 202 of file base_struct.h.

202 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:121
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

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

387  {
388  for( auto it : aList )
389  {
390  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
392  return SEARCH_RESULT::QUIT;
393  }
394 
396  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...

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

Referenced by GERBER_FILE_IMAGE::Visit(), and BOARD::Visit().

◆ IterateForward() [2/2]

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

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

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

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

Definition at line 404 of file base_struct.h.

406  {
407  for( auto it : aList )
408  {
409  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
411  return SEARCH_RESULT::QUIT;
412  }
413 
415  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...

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

◆ Matches() [1/2]

virtual bool EDA_ITEM::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData 
)
inlinevirtualinherited

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 in SCH_COMPONENT, SCH_SHEET, SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, SCH_PIN, TEXTE_MODULE, SCH_MARKER, MARKER_PCB, MARKER_PCB, and TEXTE_PCB.

Definition at line 457 of file base_struct.h.

458  {
459  return false;
460  }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), TEXTE_PCB::Matches(), MARKER_PCB::Matches(), SCH_MARKER::Matches(), TEXTE_MODULE::Matches(), SCH_PIN::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

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

146 {
147  wxString text = aText;
148  wxString searchText = aSearchData.GetFindString();
149 
150  // Don't match if searching for replaceable item and the item doesn't support text replace.
151  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
152  return false;
153 
154  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
155  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
156 
157  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
158  {
159  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
160  return text.Matches( searchText );
161 
162  return text.MakeUpper().Matches( searchText.MakeUpper() );
163  }
164 
165  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
166  return aText.Find( searchText ) != wxNOT_FOUND;
167 
168  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
169 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:501

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

◆ MergeOverlap()

SCH_LINE * SCH_LINE::MergeOverlap ( SCH_LINE aLine)

Check line against aLine to see if it overlaps and merge if it does.

This method will return an equivalent of the union of line and aLine if the two lines overlap. This method is used to merge multiple line segments into a single line.

Parameters
aLine- Line to compare.
Returns
New line that combines the two or NULL on non-overlapping segments.

Definition at line 370 of file sch_line.cpp.

371 {
372  auto less = []( const wxPoint& lhs, const wxPoint& rhs ) -> bool
373  {
374  if( lhs.x == rhs.x )
375  return lhs.y < rhs.y;
376  return lhs.x < rhs.x;
377  };
378 
379  wxCHECK_MSG( aLine != NULL && aLine->Type() == SCH_LINE_T, NULL,
380  wxT( "Cannot test line segment for overlap." ) );
381 
382  if( this == aLine || GetLayer() != aLine->GetLayer() )
383  return nullptr;
384 
385  auto leftmost_start = aLine->m_start;
386  auto leftmost_end = aLine->m_end;
387 
388  auto rightmost_start = m_start;
389  auto rightmost_end = m_end;
390 
391  // We place the start to the left and below the end of both lines
392  if( leftmost_start != std::min( { leftmost_start, leftmost_end }, less ) )
393  std::swap( leftmost_start, leftmost_end );
394  if( rightmost_start != std::min( { rightmost_start, rightmost_end }, less ) )
395  std::swap( rightmost_start, rightmost_end );
396 
397  // -leftmost is the line that starts farthest to the left
398  // -other is the line that is _not_ leftmost
399  // -rightmost is the line that ends farthest to the right. This may or
400  // may not be 'other' as the second line may be completely covered by
401  // the first.
402  if( less( rightmost_start, leftmost_start ) )
403  {
404  std::swap( leftmost_start, rightmost_start );
405  std::swap( leftmost_end, rightmost_end );
406  }
407 
408  auto other_start = rightmost_start;
409  auto other_end = rightmost_end;
410 
411  if( less( rightmost_end, leftmost_end ) )
412  {
413  rightmost_start = leftmost_start;
414  rightmost_end = leftmost_end;
415  }
416 
417  // If we end one before the beginning of the other, no overlap is possible
418  if( less( leftmost_end, other_start ) )
419  {
420  return nullptr;
421  }
422 
423  // Search for a common end:
424  if( ( leftmost_start == other_start ) && ( leftmost_end == other_end ) ) // Trivial case
425  {
426  auto ret = new SCH_LINE( *aLine );
427  ret->SetStartPoint( leftmost_start );
428  ret->SetEndPoint( leftmost_end );
429 
430  if( IsSelected() || aLine->IsSelected() )
431  ret->SetSelected();
432 
433  return ret;
434  }
435 
436  bool colinear = false;
437 
438  /* Test alignment: */
439  if( ( leftmost_start.y == leftmost_end.y ) &&
440  ( other_start.y == other_end.y ) ) // Horizontal segment
441  {
442  colinear = ( leftmost_start.y == other_start.y );
443  }
444  else if( ( leftmost_start.x == leftmost_end.x ) &&
445  ( other_start.x == other_end.x ) ) // Vertical segment
446  {
447  colinear = ( leftmost_start.x == other_start.x );
448  }
449  else
450  {
451  // We use long long here to avoid overflow -- it enforces promotion
452  // Don't use double as we need to make a direct comparison
453  // The slope of the left-most line is dy/dx. Then we check that the slope
454  // from the left most start to the right most start is the same as well as
455  // the slope from the left most start to right most end.
456  long long dx = leftmost_end.x - leftmost_start.x;
457  long long dy = leftmost_end.y - leftmost_start.y;
458  colinear = ( ( ( other_start.y - leftmost_start.y ) * dx ==
459  ( other_start.x - leftmost_start.x ) * dy ) &&
460  ( ( other_end.y - leftmost_start.y ) * dx ==
461  ( other_end.x - leftmost_start.x ) * dy ) );
462  }
463 
464  // Make a new segment that merges the 2 segments
465  if( colinear )
466  {
467  leftmost_end = rightmost_end;
468 
469  auto ret = new SCH_LINE( *aLine );
470  ret->SetStartPoint( leftmost_start );
471  ret->SetEndPoint( leftmost_end );
472 
473  if( IsSelected() || aLine->IsSelected() )
474  ret->SetSelected();
475 
476  return ret;
477  }
478 
479  return nullptr;
480 }
bool IsSelected() const
Definition: base_struct.h:203
#define NULL
wxPoint m_end
Line end point.
Definition: sch_line.h:42
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272
wxPoint m_start
Line start point.
Definition: sch_line.h:41
SCH_LINE(const wxPoint &pos=wxPoint(0, 0), int layer=LAYER_NOTES)
Definition: sch_line.cpp:37
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References SCH_ITEM::GetLayer(), EDA_ITEM::IsSelected(), m_end, m_start, NULL, SCH_LINE(), SCH_LINE_T, EDA_ITEM::Type(), wxPoint::x, and wxPoint::y.

Referenced by SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_FRAME::SchematicCleanUp(), and SCH_LINE_WIRE_BUS_TOOL::simplifyWireList().

◆ MirrorX()

void SCH_LINE::MirrorX ( int  aXaxis_position)
overridevirtual

Mirror item relative to the X axis about aXaxis_position.

Parameters
aXaxis_positionThe X axis position to mirror around.

Implements SCH_ITEM.

Definition at line 301 of file sch_line.cpp.

302 {
303  MIRROR( m_start.y, aXaxis_position );
304  MIRROR( m_end.y, aXaxis_position );
305 }
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:175
wxPoint m_end
Line end point.
Definition: sch_line.h:42
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_end, m_start, MIRROR(), and wxPoint::y.

◆ MirrorY()

void SCH_LINE::MirrorY ( int  aYaxis_position)
overridevirtual

Mirror item relative to the Y axis about aYaxis_position.

Parameters
aYaxis_positionThe Y axis position to mirror around.

Implements SCH_ITEM.

Definition at line 308 of file sch_line.cpp.

309 {
310  MIRROR( m_start.x, aYaxis_position );
311  MIRROR( m_end.x, aYaxis_position );
312 }
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:175
wxPoint m_end
Line end point.
Definition: sch_line.h:42
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_end, m_start, MIRROR(), and wxPoint::x.

◆ Move()

void SCH_LINE::Move ( const wxPoint aMoveVector)
overridevirtual

Move the item by aMoveVector to a new position.

Parameters
aMoveVector= the displacement vector

Implements SCH_ITEM.

Definition at line 109 of file sch_line.cpp.

110 {
111  if( aOffset != wxPoint( 0, 0 ) )
112  {
113  m_start += aOffset;
114  m_end += aOffset;
115  SetModified();
116  }
117 }
void SetModified()
Definition: base_struct.cpp:87
wxPoint m_end
Line end point.
Definition: sch_line.h:42
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_end, m_start, and EDA_ITEM::SetModified().

◆ MoveEnd()

void SCH_LINE::MoveEnd ( const wxPoint aMoveVector)

Definition at line 130 of file sch_line.cpp.

131 {
132  if( aOffset != wxPoint( 0, 0 ) )
133  {
134  m_end += aOffset;
135  SetModified();
136  }
137 }
void SetModified()
Definition: base_struct.cpp:87
wxPoint m_end
Line end point.
Definition: sch_line.h:42

References m_end, and EDA_ITEM::SetModified().

Referenced by SCH_MOVE_TOOL::moveItem().

◆ MoveStart()

void SCH_LINE::MoveStart ( const wxPoint aMoveVector)

Definition at line 120 of file sch_line.cpp.

121 {
122  if( aOffset != wxPoint( 0, 0 ) )
123  {
124  m_start += aOffset;
125  SetModified();
126  }
127 }
void SetModified()
Definition: base_struct.cpp:87
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_start, and EDA_ITEM::SetModified().

Referenced by SCH_MOVE_TOOL::moveItem().

◆ NetClass()

NETCLASSPTR SCH_ITEM::NetClass ( ) const
inherited

Definition at line 160 of file sch_item.cpp.

161 {
162  if( m_connection_map.size() )
163  {
164  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
165  const wxString& netname = m_connection_map.begin()->second->Name( true );
166  const wxString& netclassName = netSettings.m_NetClassAssignments[ netname ];
167 
168  if( !netclassName.IsEmpty() )
169  return netSettings.m_NetClasses.Find( netclassName );
170  }
171 
172  return nullptr;
173 }
std::map< wxString, wxString > m_NetClassAssignments
Definition: net_settings.h:43
NETCLASSPTR Find(const wxString &aName) const
Function Find searches this container for a NETCLASS given by aName.
Definition: netclass.cpp:132
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:116
NET_SETTINGS & NetSettings()
Definition: project_file.h:92
NETCLASSES m_NetClasses
Definition: net_settings.h:39
VTBL_ENTRY PROJECT_FILE & GetProjectFile() const
Definition: project.h:129
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:202
PROJECT & Prj() const
Return a reference to the project this schematic is part of.
Definition: schematic.h:77

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

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

◆ operator<() [1/2]

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

Reimplemented from SCH_ITEM.

Definition at line 652 of file sch_line.cpp.

653 {
654  if( Type() != aItem.Type() )
655  return Type() < aItem.Type();
656 
657  auto line = static_cast<const SCH_LINE*>( &aItem );
658 
659  if( GetLayer() != line->GetLayer() )
660  return GetLayer() < line->GetLayer();
661 
662  if( GetStartPoint().x != line->GetStartPoint().x )
663  return GetStartPoint().x < line->GetStartPoint().x;
664 
665  if( GetStartPoint().y != line->GetStartPoint().y )
666  return GetStartPoint().y < line->GetStartPoint().y;
667 
668  if( GetEndPoint().x != line->GetEndPoint().x )
669  return GetEndPoint().x < line->GetEndPoint().x;
670 
671  return GetEndPoint().y < line->GetEndPoint().y;
672 }
wxPoint GetStartPoint() const
Definition: sch_line.h:94
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193
wxPoint GetEndPoint() const
Definition: sch_line.h:97

References GetEndPoint(), SCH_ITEM::GetLayer(), GetStartPoint(), EDA_ITEM::Type(), wxPoint::x, and wxPoint::y.

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

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

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

◆ Plot()

void SCH_LINE::Plot ( PLOTTER aPlotter)
overridevirtual

Plot the schematic item to aPlotter.

Parameters
aPlotterA pointer to a PLOTTER object.

Reimplemented from SCH_ITEM.

Definition at line 729 of file sch_line.cpp.

730 {
731  auto* settings = static_cast<KIGFX::SCH_RENDER_SETTINGS*>( aPlotter->RenderSettings() );
732  int penWidth;
734 
735  if( color == COLOR4D::UNSPECIFIED )
736  color = settings->GetLayerColor( GetLayer() );
737 
738  aPlotter->SetColor( color );
739 
740  switch( m_Layer )
741  {
742  case LAYER_WIRE: penWidth = settings->m_DefaultWireThickness; break;
743  case LAYER_BUS: penWidth = settings->m_DefaultBusThickness; break;
744  default: penWidth = GetPenWidth(); break;
745  }
746 
747  penWidth = std::max( penWidth, aPlotter->RenderSettings()->GetDefaultPenWidth() );
748 
749  if( m_stroke.GetWidth() != 0 )
750  penWidth = m_stroke.GetWidth();
751 
752  aPlotter->SetCurrentLineWidth( penWidth );
753  aPlotter->SetDash( GetEffectiveLineStyle() );
754 
755  aPlotter->MoveTo( m_start );
756  aPlotter->FinishTo( m_end );
757 
758  aPlotter->SetDash( PLOT_DASH_TYPE::SOLID );
759 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:267
SCH_LAYER_ID m_Layer
Definition: sch_item.h:192
COLOR4D GetLineColor() const
Returns COLOR4D::UNSPECIFIED if a custom color hasn't been set for this line.
Definition: sch_line.cpp:209
virtual void SetColor(COLOR4D color)=0
int color
Definition: DXF_plotter.cpp:61
int GetPenWidth() const override
Definition: sch_line.cpp:270
int GetWidth() const
Definition: sch_item.h:169
wxPoint m_end
Line end point.
Definition: sch_line.h:42
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272
void MoveTo(const wxPoint &pos)
Definition: plotter.h:257
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:147
PLOT_DASH_TYPE GetEffectiveLineStyle() const
Definition: sch_line.cpp:253
int GetDefaultPenWidth() const
wxPoint m_start
Line start point.
Definition: sch_line.h:41
virtual void SetDash(PLOT_DASH_TYPE dashed)=0
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

References color, PLOTTER::FinishTo(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), GetEffectiveLineStyle(), SCH_ITEM::GetLayer(), GetLineColor(), GetPenWidth(), STROKE_PARAMS::GetWidth(), LAYER_BUS, LAYER_WIRE, m_end, SCH_ITEM::m_Layer, m_start, m_stroke, PLOTTER::MoveTo(), PLOTTER::RenderSettings(), PLOTTER::SetColor(), PLOTTER::SetCurrentLineWidth(), PLOTTER::SetDash(), and SOLID.

◆ Print()

void SCH_LINE::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 284 of file sch_line.cpp.

285 {
286  wxDC* DC = aSettings->GetPrintDC();
288 
289  if( color == COLOR4D::UNSPECIFIED )
290  color = aSettings->GetLayerColor( GetLayer() );
291 
292  wxPoint start = m_start;
293  wxPoint end = m_end;
294  int penWidth = std::max( GetPenWidth(), aSettings->GetDefaultPenWidth() );
295 
296  GRLine( nullptr, DC, start.x, start.y, end.x, end.y, penWidth, color,
298 }
COLOR4D GetLineColor() const
Returns COLOR4D::UNSPECIFIED if a custom color hasn't been set for this line.
Definition: sch_line.cpp:209
int color
Definition: DXF_plotter.cpp:61
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
int GetPenWidth() const override
Definition: sch_line.cpp:270
void GRLine(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color, wxPenStyle aStyle)
Definition: gr_basic.cpp:232
wxPoint m_end
Line end point.
Definition: sch_line.h:42
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272
PLOT_DASH_TYPE GetEffectiveLineStyle() const
Definition: sch_line.cpp:253
int GetDefaultPenWidth() const
wxPoint m_start
Line start point.
Definition: sch_line.h:41
wxPenStyle GetwxPenStyle(PLOT_DASH_TYPE aType)
Convert KiCad line plot styles to wxWidgets device context styles.
Definition: plotter.cpp:599
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

References color, KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), GetEffectiveLineStyle(), SCH_ITEM::GetLayer(), KIGFX::RENDER_SETTINGS::GetLayerColor(), GetLineColor(), GetPenWidth(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GetwxPenStyle(), GRLine(), m_end, m_start, wxPoint::x, and wxPoint::y.

◆ Replace() [1/2]

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

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

References GetChars(), and traceFindReplace.

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

◆ Replace() [2/2]

virtual bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
void *  aAuxData = NULL 
)
inlinevirtualinherited

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 in SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, and SCH_PIN.

Definition at line 489 of file base_struct.h.

489 { return false; }

◆ Rotate()

void SCH_LINE::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 315 of file sch_line.cpp.

316 {
317  RotatePoint( &m_start, aPosition, 900 );
318  RotatePoint( &m_end, aPosition, 900 );
319 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
wxPoint m_end
Line end point.
Definition: sch_line.h:42
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_end, m_start, and RotatePoint().

◆ RotateEnd()

void SCH_LINE::RotateEnd ( wxPoint  aPosition)

Definition at line 328 of file sch_line.cpp.

329 {
330  RotatePoint( &m_end, aPosition, 900 );
331 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
wxPoint m_end
Line end point.
Definition: sch_line.h:42

References m_end, and RotatePoint().

Referenced by SCH_EDIT_TOOL::Rotate().

◆ RotateStart()

void SCH_LINE::RotateStart ( wxPoint  aPosition)

Definition at line 322 of file sch_line.cpp.

323 {
324  RotatePoint( &m_start, aPosition, 900 );
325 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_start, and RotatePoint().

Referenced by SCH_EDIT_TOOL::Rotate().

◆ 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 116 of file sch_item.cpp.

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

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

Referenced by SCH_EDIT_FRAME::CreateSheetPin(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_JUNCTION::GetBoundingBox(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::GetDiameter(), GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_COMPONENT::GetSchPins(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_SHEET::IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnAddField(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), SCH_JUNCTION::Plot(), SCH_JUNCTION::Print(), SCH_HIERLABEL::Print(), 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:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
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:58
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:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
T
enum T contains all this lexer's tokens.
Provides class metadata.
Definition: property_mgr.h:58
void set(void *aObject, T aValue)
Definition: property.h:266
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:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
T
enum T contains all this lexer's tokens.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Returns a property for a specific type.
Provides class metadata.
Definition: property_mgr.h:58
void set(void *aObject, T aValue)
Definition: property.h:266
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().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

◆ SetConnectivityDirty()

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

Definition at line 428 of file sch_item.h.

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

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetEndPoint()

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 232 of file base_struct.h.

232 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), PCBNEW_CONTROL::AppendBoard(), SCH_EDIT_TOOL::ChangeTextType(), GRAPHICS_CLEANER::cleanupSegments(), TRACKS_CLEANER::cleanupSegments(), 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::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(), EDIT_POINTS_FACTORY::Make(), TRACKS_CLEANER::mergeCollinearSegments(), LIB_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectPoint(), 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_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TEXT_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 284 of file base_struct.h.

284 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: base_struct.h:175

References EDA_ITEM::m_forceVisible.

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID  aLayer)
inlineinherited

Set the layer this item is on.

Parameters
aLayerThe layer number.

Definition at line 279 of file sch_item.h.

279 { m_Layer = aLayer; }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:192

References SCH_ITEM::m_Layer.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), SCH_NO_CONNECT::SCH_NO_CONNECT(), SCH_FIELD::SetId(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ SetLineColor() [1/2]

void SCH_LINE::SetLineColor ( const COLOR4D aColor)

Definition at line 188 of file sch_line.cpp.

189 {
190  m_stroke.SetColor( aColor );
191 }
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
void SetColor(const COLOR4D &aColor)
Definition: sch_item.h:176

References m_stroke, and STROKE_PARAMS::SetColor().

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

◆ SetLineColor() [2/2]

void SCH_LINE::SetLineColor ( const double  r,
const double  g,
const double  b,
const double  a 
)

Definition at line 194 of file sch_line.cpp.

195 {
196  COLOR4D newColor(r, g, b, a);
197 
198  if( newColor == COLOR4D::UNSPECIFIED )
199  m_stroke.SetColor( COLOR4D::UNSPECIFIED );
200  else
201  {
202  // Eeschema does not allow alpha channel in colors
203  newColor.a = 1.0;
204  m_stroke.SetColor( newColor );
205  }
206 }
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
void SetColor(const COLOR4D &aColor)
Definition: sch_item.h:176
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

References KIGFX::COLOR4D::a, m_stroke, and STROKE_PARAMS::SetColor().

◆ SetLineStyle() [1/2]

void SCH_LINE::SetLineStyle ( const PLOT_DASH_TYPE  aStyle)

Definition at line 235 of file sch_line.cpp.

236 {
237  if( aStyle == GetDefaultStyle() )
239  else
240  m_stroke.SetType( aStyle );
241 }
void SetType(PLOT_DASH_TYPE aType)
Definition: sch_item.h:173
PLOT_DASH_TYPE GetDefaultStyle() const
Definition: sch_line.cpp:220
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43

References DEFAULT, GetDefaultStyle(), m_stroke, and STROKE_PARAMS::SetType().

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

◆ SetLineStyle() [2/2]

void SCH_LINE::SetLineStyle ( const int  aStyleId)

Definition at line 229 of file sch_line.cpp.

230 {
231  SetLineStyle( static_cast<PLOT_DASH_TYPE>( aStyleId ) );
232 }
void SetLineStyle(const PLOT_DASH_TYPE aStyle)
Definition: sch_line.cpp:235

References SetLineStyle().

◆ SetLineWidth()

void SCH_LINE::SetLineWidth ( const int  aSize)

Definition at line 264 of file sch_line.cpp.

265 {
266  m_stroke.SetWidth( aSize );
267 }
void SetWidth(int aWidth)
Definition: sch_item.h:170
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43

References m_stroke, and STROKE_PARAMS::SetWidth().

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

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

Definition at line 267 of file sch_item.h.

267 {}

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

Definition at line 87 of file base_struct.cpp.

88 {
90 
91  // If this a child object, then the parent modification state also needs to be set.
92  if( m_Parent )
94 }
void SetModified()
Definition: base_struct.cpp:87
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:113
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:232

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

Referenced by SCH_COMPONENT::ClearAnnotation(), LIB_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), Move(), SCH_COMPONENT::Move(), MoveEnd(), MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), 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().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Definition at line 196 of file base_struct.h.

196 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174

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(), LIB_FIELD::Copy(), LIB_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), 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(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), SwapItemData(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary().

◆ SetPosition()

void SCH_LINE::SetPosition ( const wxPoint aPosition)
overridevirtual

Set the schematic item position to aPosition.

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

Implements SCH_ITEM.

Definition at line 762 of file sch_line.cpp.

763 {
764  m_end = m_end - ( m_start - aPosition );
765  m_start = aPosition;
766 }
wxPoint m_end
Line end point.
Definition: sch_line.h:42
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_end, and m_start.

◆ SetSelected()

◆ SetStartPoint()

void SCH_LINE::SetStartPoint ( const wxPoint aPosition)
inline

◆ SetState()

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

Definition at line 221 of file base_struct.h.

222  {
223  if( state )
224  m_Status |= type; // state = ON or OFF
225  else
226  m_Status &= ~type;
227  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 230 of file base_struct.h.

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

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( wxPoint  aPos)
inlineinherited

Definition at line 244 of file sch_item.h.

244 { m_storedPos = aPos; }
wxPoint m_storedPos
Definition: sch_item.h:195

References SCH_ITEM::m_storedPos.

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

◆ SetStroke()

virtual void SCH_LINE::SetStroke ( const STROKE_PARAMS aStroke)
inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 129 of file sch_line.h.

129 { m_stroke = aStroke; }
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43

References m_stroke.

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

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 207 of file base_struct.h.

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

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ Sort()

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

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

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

Definition at line 520 of file base_struct.h.

520 { return *aLeft < *aRight; }

◆ SwapData()

void SCH_LINE::SwapData ( SCH_ITEM aItem)
overridevirtual

Swap the internal data structures aItem with the schematic item.

Obviously, aItem must have the same type than me

Parameters
aItemThe item to swap the data structures with.

Reimplemented from SCH_ITEM.

Definition at line 706 of file sch_line.cpp.

707 {
708  SCH_LINE* item = (SCH_LINE*) aItem;
709 
710  std::swap( m_Layer, item->m_Layer );
711 
712  std::swap( m_start, item->m_start );
713  std::swap( m_end, item->m_end );
714  std::swap( m_startIsDangling, item->m_startIsDangling );
715  std::swap( m_endIsDangling, item->m_endIsDangling );
716  std::swap( m_stroke, item->m_stroke );
717 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:192
bool m_endIsDangling
True if end point is not connected.
Definition: sch_line.h:40
bool m_startIsDangling
True if start point is not connected.
Definition: sch_line.h:39
wxPoint m_end
Line end point.
Definition: sch_line.h:42
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_end, m_endIsDangling, SCH_ITEM::m_Layer, m_start, m_startIsDangling, and m_stroke.

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

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

Returns
KICAD_T - the type of object.

Definition at line 193 of file base_struct.h.

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

References EDA_ITEM::m_StructType.

Referenced by MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), SCH_SCREEN::Append(), CONNECTION_GRAPH::buildConnectionGraph(), DIALOG_SELECT_NET_FROM_LIST::buildNetsList(), SCH_SCREENS::buildScreenList(), calcArea(), calcMaxArea(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_EDIT_TOOL::ChangeTextType(), CN_VISITOR::checkZoneItemConnection(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), SCH_NO_CONNECT::ClassOf(), TEXTE_PCB::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), SCH_PIN::ClassOf(), MARKER_PCB::ClassOf(), EDGE_MODULE::ClassOf(), ClassOf(), PCB_TARGET::ClassOf(), SCH_FIELD::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), ZONE_CONTAINER::ClassOf(), SCH_BITMAP::ClassOf(), D_PAD::ClassOf(), DIMENSION::ClassOf(), TRACK::ClassOf(), NETINFO_ITEM::ClassOf(), SCH_SHEET_PIN::ClassOf(), MODULE::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_SCREEN::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), SCH_TEXT::ClassOf(), SCH_SHEET::ClassOf(), BOARD::ClassOf(), ARC::ClassOf(), SCH_LABEL::ClassOf(), VIA::ClassOf(), SCH_GLOBALLABEL::ClassOf(), SCH_HIERLABEL::ClassOf(), TRACKS_CLEANER::cleanupSegments(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_ITEM::compare(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), DIALOG_TEXT_PROPERTIES::convertKIIDsToReferences(), SCHEMATIC::ConvertKIIDsToRefs(), MODULE::CoverageRatio(), BOARD_ADAPTER::createLayers(), PCB_BASE_FRAME::CreateNewModule(), SCH_DRAWING_TOOLS::createNewText(), BOARD_ADAPTER::createNewTrack(), D_PAD::D_PAD(), SCH_SCREEN::DeleteItem(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDIT_TOOL::DoDelete(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), test::DRC_TEST_PROVIDER_COPPER_CLEARANCE::doTrackDrc(), DRC::doTrackDrc(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), MODULE::DuplicateItem(), EDA_ITEM_DESC::EDA_ITEM_DESC(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckLabels(), NETLIST_EXPORTER::findNextComponent(), PCB_BASE_FRAME::FocusOnItem(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), TRACK::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetContextualTextVars(), CONNECTION_GRAPH::getDefaultConnection(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), TEXTE_PCB::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_eda(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), highlightNet(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), CN_ANCHOR::IsDangling(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), TRACK::IsNull(), IsParallel(), SCH_FIELD::IsReplaceable(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), SELECTION_TOOL::itemPassesFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_FIELD::Matches(), MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), DRAWSEGMENT::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), MODULE::cmp_drawings::operator()(), SCH_JUNCTION::operator<(), SCH_BUS_ENTRY_BASE::operator<(), SCH_FIELD::operator<(), operator<(), LIB_ITEM::operator<(), SCH_TEXT::operator<(), SCH_ITEM::operator<(), SCH_SHEET::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), SCH_FIELD::Print(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), SCH_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshItem(), SCH_BASE_FRAME::RefreshSelection(), EE_RTREE::remove(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), SCH_SCREEN::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), SCHEMATIC::ResolveCrossReference(), WS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), DRC_TEXTVAR_TESTER::RunDRC(), SCH_SEXPR_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_SEXPR_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_SEXPR_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_SEXPR_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), CLIPBOARD_IO::SaveSelection(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SCREEN::Schematic(), SCH_ITEM::Schematic(), SELECTION_TOOL::select(), SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectConnectedTracks(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_SHEET_PIN::SwapData(), SCH_FIELD::SwapData(), TEXTE_PCB::SwapData(), TRACK::SwapData(), DIMENSION::SwapData(), ARC::SwapData(), SCH_SHEET::SwapData(), VIA::SwapData(), SCH_COMPONENT::SwapData(), D_PAD::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), SwapItemData(), TEXTE_MODULE::TEXTE_MODULE(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), KIGFX::PCB_VIEW::Update(), SCH_TEXT::UpdateDanglingState(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), EE_POINT_EDITOR::updateItem(), PL_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), CONNECTION_GRAPH::updateItemConnectivity(), DIALOG_SELECT_NET_FROM_LIST::updateNet(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_SHEET::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ UpdateDanglingState()

bool SCH_LINE::UpdateDanglingState ( std::vector< DANGLING_END_ITEM > &  aItemList,
const SCH_SHEET_PATH aPath = nullptr 
)
overridevirtual

Test the schematic item to aItemList to check if it's dangling state has changed.

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

If aSheet is passed a non-null pointer to a SCH_SHEET_PATH, the overrided method can optionally use it to update sheet-local connectivity information

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

Reimplemented from SCH_ITEM.

Definition at line 501 of file sch_line.cpp.

503 {
504  bool previousStartState = m_startIsDangling;
505  bool previousEndState = m_endIsDangling;
506 
508 
509  if( GetLayer() == LAYER_WIRE )
510  {
511  for( DANGLING_END_ITEM item : aItemList )
512  {
513  if( item.GetItem() == this )
514  continue;
515 
516  if( item.GetType() == BUS_START_END ||
517  item.GetType() == BUS_END_END ||
518  item.GetType() == BUS_ENTRY_END )
519  continue;
520 
521  if( m_start == item.GetPosition() )
522  m_startIsDangling = false;
523 
524  if( m_end == item.GetPosition() )
525  m_endIsDangling = false;
526 
528  break;
529  }
530  }
531  else if( GetLayer() == LAYER_BUS || IsGraphicLine() )
532  {
533  // Lines on the notes layer and the bus layer cannot be tested for dangling ends.
534  previousStartState = previousEndState = m_startIsDangling = m_endIsDangling = false;
535  }
536 
537  return ( previousStartState != m_startIsDangling ) || ( previousEndState != m_endIsDangling );
538 }
bool IsGraphicLine() const
Returns if the line is a graphic (non electrical line)
Definition: sch_line.cpp:810
bool m_endIsDangling
True if end point is not connected.
Definition: sch_line.h:40
bool m_startIsDangling
True if start point is not connected.
Definition: sch_line.h:39
wxPoint m_end
Line end point.
Definition: sch_line.h:42
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272
Helper class used to store the state of schematic items that can be connected to other schematic item...
Definition: sch_item.h:85
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References BUS_END_END, BUS_ENTRY_END, BUS_START_END, SCH_ITEM::GetLayer(), IsGraphicLine(), LAYER_BUS, LAYER_WIRE, m_end, m_endIsDangling, m_start, and m_startIsDangling.

◆ UsesDefaultStroke()

bool SCH_LINE::UsesDefaultStroke ( ) const

Test if the SCH_LINE object uses the default stroke settings.

The stroke settings include the line width, style, and color.

Returns
True if the SCH_LINE object uses the default stroke settings.

Definition at line 822 of file sch_line.cpp.

823 {
824  return m_stroke.GetWidth() == 0 && m_stroke.GetColor() == COLOR4D::UNSPECIFIED
825  && ( m_stroke.GetType() == GetDefaultStyle()
827 }
PLOT_DASH_TYPE GetDefaultStyle() const
Definition: sch_line.cpp:220
int GetWidth() const
Definition: sch_item.h:169
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
COLOR4D GetColor() const
Definition: sch_item.h:175
PLOT_DASH_TYPE GetType() const
Definition: sch_item.h:172

References DEFAULT, STROKE_PARAMS::GetColor(), GetDefaultStyle(), STROKE_PARAMS::GetType(), STROKE_PARAMS::GetWidth(), and m_stroke.

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

Function ViewBBox() returns the bounding box of the item covering all its layers.

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

Reimplemented in MODULE, D_PAD, EDIT_POINTS, DRAWSEGMENT, GERBER_DRAW_ITEM, DIMENSION, TRACK, TEXTE_MODULE, ROUTER_PREVIEW_ITEM, MARKER_PCB, MARKER_PCB, KIGFX::WS_PROXY_VIEW_ITEM, MY_DRAWING, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, and BRIGHT_BOX.

Definition at line 220 of file base_struct.cpp.

221 {
222  // Basic fallback
223  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
224  VECTOR2I( GetBoundingBox().GetSize() ) );
225 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:522
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: base_struct.cpp:97

References EDA_ITEM::GetBoundingBox().

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), and BRIGHT_BOX::ViewDraw().

◆ ViewDraw()

virtual void KIGFX::VIEW_ITEM::ViewDraw ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Function ViewDraw() Draws the parts of the object belonging to layer aLayer.

viewDraw() is an alternative way for drawing objects if if there is no PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on

Reimplemented in EDIT_POINTS, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::WS_PROXY_VIEW_ITEM, KIGFX::PREVIEW::SELECTION_AREA, MY_DRAWING, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::VIEW_OVERLAY, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, BRIGHT_BOX, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, and PCB_BRIGHT_BOX.

Definition at line 117 of file view_item.h.

118  {}

Referenced by KIGFX::VIEW::draw(), and KIGFX::VIEW::updateItemGeometry().

◆ ViewGetLayers()

void SCH_LINE::ViewGetLayers ( int  aLayers[],
int &  aCount 
) const
overridevirtual

Return the layers the item is drawn on (which may be more than its "home" layer)

Reimplemented from SCH_ITEM.

Definition at line 157 of file sch_line.cpp.

158 {
159  aCount = 2;
160  aLayers[0] = m_Layer;
161  aLayers[1] = LAYER_SELECTION_SHADOWS;
162 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:192

References LAYER_SELECTION_SHADOWS, and SCH_ITEM::m_Layer.

◆ ViewGetLOD()

virtual unsigned int KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Function ViewGetLOD() Returns the level of detail (LOD) of the item.

A level of detail is the minimal VIEW scale that is sufficient for an item to be shown on a given layer.

Parameters
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on
Returns
the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in MODULE_ZONE_CONTAINER, MODULE, D_PAD, VIA, GERBER_DRAW_ITEM, TEXTE_MODULE, TRACK, and EDGE_MODULE.

Definition at line 141 of file view_item.h.

142  {
143  // By default always show the item
144  return 0;
145  }

Referenced by KIGFX::VIEW::drawItem::operator()(), GRID_HELPER::queryVisible(), and SELECTION_TOOL::Selectable().

◆ viewPrivData()

◆ Visit()

SEARCH_RESULT EDA_ITEM::Visit ( INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
virtualinherited

Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in scanTypes[], and may use IterateForward() to do so on lists of such data.

Parameters
inspectorAn INSPECTOR instance to use in the inspection.
testDataArbitrary data used by the inspector.
scanTypesWhich KICAD_T types are of interest and the order is significant too, terminated by EOT.
Returns
SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else SCAN_CONTINUE, and determined by the inspector.

Reimplemented in BOARD, SCH_COMPONENT, MODULE, SCH_SHEET, LIB_PART, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 120 of file base_struct.cpp.

121 {
122 #if 0 && defined(DEBUG)
123  std::cout << GetClass().mb_str() << ' ';
124 #endif
125 
126  if( IsType( scanTypes ) )
127  {
128  if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
129  return SEARCH_RESULT::QUIT;
130  }
131 
133 }
virtual bool IsType(const KICAD_T aScanTypes[]) const
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:262
virtual wxString GetClass() const =0
Function GetClass returns the class name.

References CONTINUE, EDA_ITEM::GetClass(), EDA_ITEM::IsType(), and QUIT.

Referenced by GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), and EDA_ITEM::IterateForward().

Member Data Documentation

◆ m_connected_items

std::unordered_map<SCH_SHEET_PATH, ITEM_SET> SCH_ITEM::m_connected_items
protectedinherited

Stores pointers to other items that are connected to this one, per sheet.

Definition at line 199 of file sch_item.h.

Referenced by SCH_ITEM::AddConnectionTo(), SCH_ITEM::ConnectedItems(), SCH_LABEL::IsType(), and SCH_TEXT::UpdateDanglingState().

◆ m_connection_map

std::unordered_map<SCH_SHEET_PATH, SCH_CONNECTION*> SCH_ITEM::m_connection_map
protectedinherited

Stores connectivity information, per sheet.

Definition at line 202 of file sch_item.h.

Referenced by SCH_ITEM::Connection(), SCH_ITEM::InitializeConnection(), SCH_ITEM::NetClass(), and SCH_ITEM::~SCH_ITEM().

◆ m_connections

EDA_ITEMS SCH_ITEM::m_connections
protectedinherited

Definition at line 193 of file sch_item.h.

Referenced by SCH_ITEM::ClearConnections(), and SCH_ITEM::~SCH_ITEM().

◆ m_connectivity_dirty

bool SCH_ITEM::m_connectivity_dirty
protectedinherited

True if connectivity info might be out of date.

Definition at line 205 of file sch_item.h.

Referenced by SCH_ITEM::IsConnectivityDirty(), SCH_ITEM::SCH_ITEM(), and SCH_ITEM::SetConnectivityDirty().

◆ m_end

◆ m_endIsDangling

bool SCH_LINE::m_endIsDangling
private

True if end point is not connected.

Definition at line 40 of file sch_line.h.

Referenced by IsDangling(), IsEndDangling(), SCH_LINE(), SwapData(), and UpdateDanglingState().

◆ m_fieldsAutoplaced

◆ m_Flags

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

◆ m_Layer

◆ m_Parent

◆ m_start

◆ m_startIsDangling

bool SCH_LINE::m_startIsDangling
private

True if start point is not connected.

Definition at line 39 of file sch_line.h.

Referenced by IsDangling(), IsStartDangling(), SCH_LINE(), SwapData(), and UpdateDanglingState().

◆ m_Status

◆ m_storedPos

wxPoint SCH_ITEM::m_storedPos
protectedinherited

Definition at line 195 of file sch_item.h.

Referenced by SCH_ITEM::GetStoredPos(), and SCH_ITEM::SetStoredPos().

◆ m_stroke

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid
inherited

Definition at line 162 of file base_struct.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddHierarchicalReference(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), PAD_TOOL::EditPad(), PCB_EDIT_FRAME::Exchange_Module(), PAD_TOOL::explodePad(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), BOARD::GetItem(), SCH_SHEET::GetMsgPanelInfo(), SCH_REFERENCE::GetPath(), SCH_COMPONENT::GetRef(), SCH_MARKER::GetUUID(), MARKER_PCB::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadComponent(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), LEGACY_PLUGIN::loadTrackList(), NETLIST_EXPORTER_GENERIC::makeComponents(), SCH_EDIT_FRAME::mapExistingAnnotation(), TRACK::cmp_tracks::operator()(), DRAWSEGMENT::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), MODULE::cmp_drawings::operator()(), MODULE::cmp_pads::operator()(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), PCB_PARSER::parseDIMENSION(), PCB_PARSER::parseMODULE_unchecked(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_COMPONENT::ReplaceInstanceSheetPath(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_COMPONENT::SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), RC_ITEM::SetItems(), SwapItemData(), DIALOG_SCH_SHEET_PROPS::TransferDataToWindow(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ PenStyle

enum wxPenStyle SCH_LINE::PenStyle[]
static

Definition at line 47 of file sch_line.h.


The documentation for this class was generated from the following files: