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
 Return the class name. More...
 
bool IsType (const KICAD_T aScanTypes[]) const override
 Check 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 IsStrokeEquivalent (const SCH_LINE *aLine)
 
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
 Return the orthogonal bounding box of this object for display purposes. More...
 
double GetLength () const
 
void Print (const 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 MirrorVertically (int aCenter) override
 Mirror item vertically about aCenter. More...
 
void MirrorHorizontally (int aCenter) override
 Mirror item horizontally about aCenter. 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_SCREEN *aScreen, SCH_LINE *aLine, bool aCheckJunctions)
 Check line against aLine to see if it overlaps and merge if it does. More...
 
bool IsSameQuadrant (const SCH_LINE *aLine, const wxPoint &aPosition) const
 Check if two lines are in the same quadrant as each other, using a reference point as the origin. More...
 
bool IsParallel (const SCH_LINE *aLine) const
 
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
 
std::vector< wxPoint > GetConnectionPoints () 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
 Return 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
 Return a pointer to an image to be used in menus. More...
 
bool operator< (const SCH_ITEM &aItem) const override
 
wxPoint GetPosition () const override
 
void SetPosition (const wxPoint &aPosition) override
 
bool IsPointClickableAnchor (const wxPoint &aPos) const override
 
bool HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
 Test 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
 Test 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
 Create 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
 Populate 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...
 
bool IsBus () const
 Returns true if the line is a bus. More...
 
SCH_ITEMDuplicate (bool doClone=false) const
 Routine to create a new copy of given item. More...
 
virtual bool IsMovableFromAnchorPoint () const
 
wxPoint & GetStoredPos ()
 
void SetStoredPos (wxPoint aPos)
 
SCHEMATICSchematic () const
 Searches the item hierarchy to find a SCHEMATIC. More...
 
virtual bool IsLocked () const
 
virtual void SetLocked (bool aLocked)
 Set the 'lock' status to aLocked for of this item. More...
 
virtual bool IsHypertext () const
 Allows items to support hypertext actions when hovered/clicked. More...
 
virtual void DoHypertextMenu (EDA_DRAW_FRAME *aFrame)
 
SCH_LAYER_ID GetLayer () const
 Return the layer this item is on. More...
 
void SetLayer (SCH_LAYER_ID aLayer)
 Set the layer this item is on. More...
 
void ClearConnections ()
 Clears all of the connection items from the list. More...
 
bool IsConnected (const wxPoint &aPoint) const
 Test the item to see if it is connected to aPoint. More...
 
SCH_CONNECTIONConnection (const SCH_SHEET_PATH *aSheet=nullptr) const
 Retrieve the connection associated with this object in the given sheet. More...
 
SCH_ITEM_SETConnectedItems (const SCH_SHEET_PATH &aPath)
 Retrieves the set of items connected to this item on the given sheet. More...
 
void AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
 Adds a connection link between this item and another. More...
 
SCH_CONNECTIONInitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
 Creates a new connection object associated with this object. More...
 
virtual bool ConnectionPropagatesTo (const EDA_ITEM *aItem) const
 Returns true if this item should propagate connection info to aItem. More...
 
bool IsConnectivityDirty ()
 
void SetConnectivityDirty (bool aDirty=true)
 
NETCLASSPTR NetClass (const SCH_SHEET_PATH *aSheet=nullptr) const
 
FIELDS_AUTOPLACED GetFieldsAutoplaced () const
 Return whether the fields have been automatically placed. More...
 
void ClearFieldsAutoplaced ()
 Set fields automatically placed flag false. More...
 
void AutoAutoplaceFields (SCH_SCREEN *aScreen)
 Autoplace fields only if correct to do so automatically. More...
 
virtual void AutoplaceFields (SCH_SCREEN *aScreen, bool aManual)
 
virtual void RunOnChildren (const std::function< void(SCH_ITEM *)> &aFunction)
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
KICAD_T Type () const
 Returns the type of object. 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 IsEntered () 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, bool 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) const
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
void SetForceVisible (bool aEnable)
 Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
bool IsForceVisible () const
 
virtual const wxPoint GetFocusPosition () const
 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[])
 May be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
virtual bool Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const
 Compare the item against the search criteria in aSearchData. More...
 
virtual bool Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
 Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Override this method in any derived object that supports test find and replace. More...
 
virtual const BOX2I ViewBBox () const override
 Return the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Draw the parts of the object belonging to layer aLayer. More...
 
virtual double ViewGetLOD (int aLayer, VIEW *aView) const
 Return the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
bool Set (PROPERTY_BASE *aProperty, wxAny &aValue)
 
template<typename T >
bool Set (PROPERTY_BASE *aProperty, T aValue)
 
template<typename T >
bool Set (const wxString &aProperty, T aValue)
 
wxAny Get (PROPERTY_BASE *aProperty)
 
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[])
 This changes first parameter to avoid the DList and use the main queue instead. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Change first parameter to avoid the DList and use std::vector instead. More...
 
static bool Replace (const wxFindReplaceData &aSearchData, wxString &aText)
 Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Public Attributes

const KIID m_Uuid
 

Static Public Attributes

static enum wxPenStyle PenStyle []
 

Protected Member Functions

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

Protected Attributes

SCH_LAYER_ID m_layer
 
EDA_ITEMS m_connections
 
FIELDS_AUTOPLACED m_fieldsAutoplaced
 
wxPoint m_storedPos
 
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SETm_connected_items
 Stores pointers to other items that are connected to this one, per sheet. More...
 
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
 Stores connectivity information, per sheet. More...
 
bool m_connectivity_dirty
 
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 }
void SetWidth(int aWidth)
Definition: sch_item.h:172
bool m_endIsDangling
True if end point is not connected.
Definition: sch_line.h:40
void SetPlotStyle(PLOT_DASH_TYPE aPlotStyle)
Definition: sch_item.h:175
SCH_LAYER_ID m_layer
Definition: sch_item.h:201
#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:178
wxPoint m_start
Line start point.
Definition: sch_line.h:41
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:47

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::SetPlotStyle(), 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:47

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

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

References SCH_ITEM::m_connected_items.

Referenced by SCH_TEXT::UpdateDanglingState().

◆ AutoAutoplaceFields()

void SCH_ITEM::AutoAutoplaceFields ( SCH_SCREEN aScreen)
inlineinherited

Autoplace fields only if correct to do so automatically.

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

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

Definition at line 460 of file sch_item.h.

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

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

◆ CanConnect()

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

Reimplemented from SCH_ITEM.

Definition at line 648 of file sch_line.cpp.

649 {
650  if( m_layer == LAYER_WIRE )
651  {
652  switch( aItem->Type() )
653  {
654  case SCH_JUNCTION_T:
655  case SCH_NO_CONNECT_T:
656  case SCH_LABEL_T:
657  case SCH_GLOBAL_LABEL_T:
658  case SCH_HIER_LABEL_T:
660  case SCH_COMPONENT_T:
661  case SCH_SHEET_T:
662  case SCH_SHEET_PIN_T:
663  return true;
664  default:
665  break;
666  }
667  }
668  else if( m_layer == LAYER_BUS )
669  {
670  switch( aItem->Type() )
671  {
672  case SCH_JUNCTION_T:
673  case SCH_LABEL_T:
674  case SCH_GLOBAL_LABEL_T:
675  case SCH_HIER_LABEL_T:
677  case SCH_SHEET_T:
678  case SCH_SHEET_PIN_T:
679  return true;
680  default:
681  break;
682  }
683  }
684 
685  return aItem->GetLayer() == m_layer;
686 }
SCH_LAYER_ID m_layer
Definition: sch_item.h:201
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:287
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:162

References SCH_ITEM::GetLayer(), LAYER_BUS, LAYER_WIRE, 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
Returns the type of object.
Definition: eda_item.h:162

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

398 { m_connections.clear(); }
EDA_ITEMS m_connections
Definition: sch_item.h:202

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )
inlineinherited

Set fields automatically placed flag false.

Definition at line 451 of file sch_item.h.

FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:203

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

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

◆ ClearFlags()

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

Definition at line 203 of file eda_item.h.

203 { m_flags &= ~aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:530

References EDA_ITEM::m_flags.

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

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 215 of file eda_item.h.

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

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 148 of file view_item.h.

149  {
150  m_viewPrivData = nullptr;
151  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:156

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * SCH_LINE::Clone ( ) const
overridevirtual

Create a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns
A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 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()

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

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

Definition at line 164 of file sch_item.cpp.

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

References SCH_ITEM::m_connected_items.

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

◆ Connection()

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

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

Note
The returned value can be nullptr.

Definition at line 131 of file sch_item.cpp.

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

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

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

◆ ConnectionPropagatesTo()

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

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

Reimplemented in SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 435 of file sch_item.h.

435 { return true; }

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

◆ DoHypertextMenu()

virtual void SCH_ITEM::DoHypertextMenu ( EDA_DRAW_FRAME aFrame)
inlinevirtualinherited

Reimplemented in SCH_FIELD.

Definition at line 282 of file sch_item.h.

282 { }

◆ 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 819 of file sch_line.cpp.

820 {
821  if( m_layer != LAYER_WIRE && m_layer != LAYER_BUS )
822  return false;
823 
824  return IsEndPoint( aPosition );
825 }
SCH_LAYER_ID m_layer
Definition: sch_item.h:201
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 78 of file sch_item.cpp.

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

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

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

◆ 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:66
#define TYPE_HASH(x)
Definition: property.h:57
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:43
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
virtual wxAny getter(void *aObject) const =0
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:63
virtual size_t OwnerHash() const =0
Return 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:66
#define TYPE_HASH(x)
Definition: property.h:57
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:43
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:63
T get(void *aObject)
Definition: property.h:266
virtual size_t OwnerHash() const =0
Return 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:66
#define TYPE_HASH(x)
Definition: property.h:57
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:43
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:63
T get(void *aObject)
Definition: property.h:266
virtual size_t OwnerHash() const =0
Return 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

Return the orthogonal bounding box of this object for display purposes.

This box should be an enclosing perimeter for visible components of this object, and the units should be in the pcb or schematic coordinate system. It is OK to overestimate the size by a few counts.

Reimplemented from EDA_ITEM.

Definition at line 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:171
wxPoint m_end
Line end point.
Definition: sch_line.h:42
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
Handle the component boundary box.
Definition: eda_rect.h:42
wxPoint m_start
Line start point.
Definition: sch_line.h:41

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

Referenced by SCH_SCREEN::MarkConnections().

◆ GetClass()

wxString SCH_LINE::GetClass ( ) const
inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 64 of file sch_line.h.

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

◆ GetConnectionPoints()

std::vector< wxPoint > SCH_LINE::GetConnectionPoints ( ) 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 689 of file sch_line.cpp.

690 {
691  return { m_start, m_end };
692 }
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 223 of file sch_line.cpp.

224 {
225  if( IsGraphicLine() )
226  return PLOT_DASH_TYPE::DASH;
227 
228  return PLOT_DASH_TYPE::SOLID;
229 }
bool IsGraphicLine() const
Returns if the line is a graphic (non electrical line)
Definition: sch_line.cpp:909

References DASH, IsGraphicLine(), and SOLID.

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

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 207 of file eda_item.h.

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

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

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_COMPONENT::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ 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 256 of file sch_line.cpp.

257 {
259  return m_stroke.GetPlotStyle();
260 
261  NETCLASSPTR netclass = NetClass();
262 
263  if( netclass )
264  return (PLOT_DASH_TYPE) netclass->GetLineStyle();
265 
266  return GetLineStyle();
267 }
NETCLASSPTR NetClass(const SCH_SHEET_PATH *aSheet=nullptr) const
Definition: sch_item.cpp:145
PLOT_DASH_TYPE GetLineStyle() const
Definition: sch_line.cpp:247
PLOT_DASH_TYPE GetPlotStyle() const
Definition: sch_item.h:174
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
PLOT_DASH_TYPE
Dashed line types.
Definition: plotter.h:104

References DEFAULT, GetLineStyle(), STROKE_PARAMS::GetPlotStyle(), m_stroke, 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 567 of file sch_line.cpp.

568 {
569  DANGLING_END_T startType, endType;
570 
571  switch( GetLayer() )
572  {
573  case LAYER_WIRE:
574  startType = WIRE_START_END;
575  endType = WIRE_END_END;
576  break;
577  case LAYER_BUS:
578  startType = BUS_START_END;
579  endType = BUS_END_END;
580  break;
581  default:
582  startType = GRAPHIC_START_END;
583  endType = GRAPHIC_END_END;
584  break;
585  }
586 
587  DANGLING_END_ITEM item( startType, this, m_start );
588  aItemList.push_back( item );
589 
590  DANGLING_END_ITEM item1( endType, this, m_end );
591  aItemList.push_back( item1 );
592 }
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:287
Helper class used to store the state of schematic items that can be connected to other schematic item...
Definition: sch_item.h:87
DANGLING_END_T
Definition: sch_item.h:64
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References BUS_END_END, BUS_START_END, SCH_ITEM::GetLayer(), GRAPHIC_END_END, GRAPHIC_START_END, 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 446 of file sch_item.h.

446 { return m_fieldsAutoplaced; }
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:203

References SCH_ITEM::m_fieldsAutoplaced.

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

◆ GetFlags()

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

Similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and TRACK.

Definition at line 308 of file eda_item.h.

308 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: eda_item.h:301

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:223
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  if( m_stroke.GetColor() != COLOR4D::UNSPECIFIED )
212  return m_stroke.GetColor();
213 
214  NETCLASSPTR netclass = NetClass();
215 
216  if( netclass )
217  return netclass->GetSchematicColor();
218 
219  return m_stroke.GetColor();
220 }
NETCLASSPTR NetClass(const SCH_SHEET_PATH *aSheet=nullptr) const
Definition: sch_item.cpp:145
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
COLOR4D GetColor() const
Definition: sch_item.h:177

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

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

◆ GetLineSize()

int SCH_LINE::GetLineSize ( ) const
inline

Definition at line 156 of file sch_line.h.

156 { return m_stroke.GetWidth(); }
int GetWidth() const
Definition: sch_item.h:171
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().

◆ GetLineStyle()

PLOT_DASH_TYPE SCH_LINE::GetLineStyle ( ) const

Definition at line 247 of file sch_line.cpp.

248 {
250  return m_stroke.GetPlotStyle();
251 
252  return GetDefaultStyle();
253 }
PLOT_DASH_TYPE GetDefaultStyle() const
Definition: sch_line.cpp:223
PLOT_DASH_TYPE GetPlotStyle() const
Definition: sch_item.h:174
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43

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

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

◆ 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
Dashed line types.
Definition: plotter.h:104

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

Return a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns
The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 742 of file sch_line.cpp.

743 {
744  if( m_layer == LAYER_NOTES )
745  return add_dashed_line_xpm;
746  else if( m_layer == LAYER_WIRE )
747  return add_line_xpm;
748 
749  return add_bus_xpm;
750 }
const BITMAP_OPAQUE add_dashed_line_xpm[1]
SCH_LAYER_ID m_layer
Definition: sch_item.h:201
const BITMAP_OPAQUE add_line_xpm[1]
Definition: add_line.cpp:19
const BITMAP_OPAQUE add_bus_xpm[1]
Definition: add_bus.cpp:22

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

Populate 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 868 of file sch_line.cpp.

869 {
870  wxString msg;
871 
872  switch( GetLayer() )
873  {
874  case LAYER_WIRE: msg = _( "Wire" ); break;
875  case LAYER_BUS: msg = _( "Bus" ); break;
876  default: msg = _( "Graphical" ); break;
877  }
878 
879  aList.push_back( MSG_PANEL_ITEM( _( "Line Type" ), msg ) );
880 
882  msg = _( "from netclass" );
883  else
884  msg = GetLineStyleName( GetLineStyle() );
885 
886  aList.push_back( MSG_PANEL_ITEM( _( "Line Style" ), msg ) );
887 
888  SCH_EDIT_FRAME* frame = dynamic_cast<SCH_EDIT_FRAME*>( aFrame );
889 
890  if( frame )
891  {
892  if( SCH_CONNECTION* conn = Connection() )
893  {
894  conn->AppendInfoToMsgPanel( aList );
895 
896  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
897  wxString netname = conn->Name();
898  wxString netclassName = netSettings.m_NetClasses.GetDefaultPtr()->GetName();
899 
900  if( netSettings.m_NetClassAssignments.count( netname ) )
901  netclassName = netSettings.m_NetClassAssignments[ netname ];
902 
903  aList.push_back( MSG_PANEL_ITEM( _( "Assigned Netclass" ), netclassName ) );
904  }
905  }
906 }
static const char * GetLineStyleName(PLOT_DASH_TYPE aStyle)
Definition: sch_line.cpp:84
std::map< wxString, wxString > m_NetClassAssignments
Definition: net_settings.h:43
const wxString & GetName() const
Definition: netclass.h:65
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:145
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
NET_SETTINGS & NetSettings()
Definition: project_file.h:92
Schematic editor (Eeschema) main window.
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:131
NETCLASSES m_NetClasses
Definition: net_settings.h:39
PLOT_DASH_TYPE GetLineStyle() const
Definition: sch_line.cpp:247
NET_SETTINGS stores various net-related settings in a project context.
Definition: net_settings.h:31
NETCLASS * GetDefaultPtr() const
Definition: netclass.h:258
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
Definition: schematic.h:99
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:287
PLOT_DASH_TYPE GetEffectiveLineStyle() const
Definition: sch_line.cpp:256
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
#define _(s)
Definition: 3d_actions.cpp:33
EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:54

References _, SCH_ITEM::Connection(), NETCLASSES::GetDefaultPtr(), GetEffectiveLineStyle(), SCH_ITEM::GetLayer(), GetLineStyle(), GetLineStyleName(), NETCLASS::GetName(), PROJECT::GetProjectFile(), LAYER_BUS, LAYER_WIRE, NET_SETTINGS::m_NetClassAssignments, NET_SETTINGS::m_NetClasses, PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

◆ 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 276 of file sch_line.cpp.

277 {
278  NETCLASSPTR netclass = NetClass();
279 
280  switch ( m_layer )
281  {
282  default:
283  if( m_stroke.GetWidth() > 0 )
284  return m_stroke.GetWidth();
285 
286  if( Schematic() )
288 
289  return DEFAULT_LINE_THICKNESS;
290 
291  case LAYER_WIRE:
292  if( m_stroke.GetWidth() > 0 )
293  return m_stroke.GetWidth();
294 
295  if( netclass )
296  return netclass->GetWireWidth();
297 
298  if( Schematic() )
300 
301  return DEFAULT_WIRE_THICKNESS;
302 
303  case LAYER_BUS:
304  if( m_stroke.GetWidth() > 0 )
305  return m_stroke.GetWidth();
306 
307  if( netclass )
308  return netclass->GetBusWidth();
309 
310  if( Schematic() )
312 
313  return DEFAULT_BUS_THICKNESS;
314  }
315 }
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:125
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
NETCLASSPTR NetClass(const SCH_SHEET_PATH *aSheet=nullptr) const
Definition: sch_item.cpp:145
SCH_LAYER_ID m_layer
Definition: sch_item.h:201
int GetWidth() const
Definition: sch_item.h:171
#define DEFAULT_LINE_THICKNESS
The default wire width in mils. (can be changed in preference menu)
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
#define DEFAULT_BUS_THICKNESS
The default noconnect size in mils.
#define DEFAULT_WIRE_THICKNESS
The default bus width in mils. (can be changed in preference menu)

References DEFAULT_BUS_THICKNESS, DEFAULT_LINE_THICKNESS, DEFAULT_WIRE_THICKNESS, STROKE_PARAMS::GetWidth(), LAYER_BUS, LAYER_WIRE, SCHEMATIC_SETTINGS::m_DefaultBusThickness, SCHEMATIC_SETTINGS::m_DefaultLineWidth, SCHEMATIC_SETTINGS::m_DefaultWireThickness, 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 231 of file sch_line.h.

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

References m_start.

Referenced by EE_POINT_EDITOR::updateParentItem().

◆ GetSelectedPoints()

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

Definition at line 695 of file sch_line.cpp.

696 {
697  if( m_flags & STARTPOINT )
698  aPoints.push_back( m_start );
699 
700  if( m_flags & ENDPOINT )
701  aPoints.push_back( m_end );
702 }
wxPoint m_end
Line end point.
Definition: sch_line.h:42
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: eda_item.h:111
#define ENDPOINT
ends. (Used to support dragging.)
Definition: eda_item.h:112
STATUS_FLAGS m_flags
Definition: eda_item.h:530
wxPoint m_start
Line start point.
Definition: sch_line.h:41

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

◆ GetSelectMenuText()

wxString SCH_LINE::GetSelectMenuText ( EDA_UNITS  aUnits) const
overridevirtual

Return 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 705 of file sch_line.cpp.

706 {
707  wxString txtfmt, orient;
708 
709  if( m_start.x == m_end.x )
710  {
711  switch( m_layer )
712  {
713  case LAYER_WIRE: txtfmt = _( "Vertical Wire, length %s" ); break;
714  case LAYER_BUS: txtfmt = _( "Vertical Bus, length %s" ); break;
715  default: txtfmt = _( "Vertical Graphic Line, length %s" ); break;
716  }
717  }
718  else if( m_start.y == m_end.y )
719  {
720  switch( m_layer )
721  {
722  case LAYER_WIRE: txtfmt = _( "Horizontal Wire, length %s" ); break;
723  case LAYER_BUS: txtfmt = _( "Horizontal Bus, length %s" ); break;
724  default: txtfmt = _( "Horizontal Graphic Line, length %s" ); break;
725  }
726  }
727  else
728  {
729  switch( m_layer )
730  {
731  case LAYER_WIRE: txtfmt = _( "Wire, length %s" ); break;
732  case LAYER_BUS: txtfmt = _( "Bus, length %s" ); break;
733  default: txtfmt = _( "Graphic Line, length %s" ); break;
734  }
735  }
736 
737  return wxString::Format( txtfmt,
739 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:148
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:125
SCH_LAYER_ID m_layer
Definition: sch_item.h:201
wxPoint m_end
Line end point.
Definition: sch_line.h:42
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References _, EuclideanNorm(), Format(), LAYER_BUS, LAYER_WIRE, m_end, SCH_ITEM::m_layer, m_start, and MessageTextFromValue().

◆ GetStartPoint()

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 186 of file eda_item.h.

187  {
188  return m_status & type;
189  }
STATUS_FLAGS m_status
Definition: eda_item.h:527

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 199 of file eda_item.h.

199 { return m_status; }
STATUS_FLAGS m_status
Definition: eda_item.h:527

References EDA_ITEM::m_status.

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 251 of file sch_item.h.

251 { return m_storedPos; }
wxPoint m_storedPos
Definition: sch_item.h:204

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 IsStrokeEquivalent(), and 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

Test 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 776 of file sch_line.cpp.

777 {
778  // Performance enhancement for connection-building
779  if( aPosition == m_start || aPosition == m_end )
780  return true;
781 
782  aAccuracy += GetPenWidth() / 2;
783 
784  return TestSegmentHit( aPosition, m_start, m_end, aAccuracy );
785 }
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:276
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

Test 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 788 of file sch_line.cpp.

789 {
790  if( m_flags & (STRUCT_DELETED | SKIP_STRUCT ) )
791  return false;
792 
793  EDA_RECT rect = aRect;
794 
795  if ( aAccuracy )
796  rect.Inflate( aAccuracy );
797 
798  if( aContained )
799  return rect.Contains( m_start ) && rect.Contains( m_end );
800 
801  return rect.Intersects( m_start, m_end );
802 }
bool Contains(const wxPoint &aPoint) const
Definition: eda_rect.cpp:57
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:115
wxPoint m_end
Line end point.
Definition: sch_line.h:42
Handle the component boundary box.
Definition: eda_rect.h:42
bool Intersects(const EDA_RECT &aRect) const
Test for a common area between rectangles.
Definition: eda_rect.cpp:150
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: eda_item.h:117
STATUS_FLAGS m_flags
Definition: eda_item.h:530
wxPoint m_start
Line start point.
Definition: sch_line.h:41
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Inflate the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

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

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

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

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ IsBrightened()

◆ IsBus()

bool SCH_LINE::IsBus ( ) const

Returns true if the line is a bus.

Returns
true if this line is on the bus layer.

Definition at line 920 of file sch_line.cpp.

921 {
922  return ( GetLayer() == LAYER_BUS );
923 }
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:287

References SCH_ITEM::GetLayer(), and LAYER_BUS.

Referenced by UpdateDanglingState().

◆ 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 639 of file sch_line.cpp.

640 {
641  if( m_layer == LAYER_WIRE || m_layer == LAYER_BUS )
642  return true;
643 
644  return false;
645 }
SCH_LAYER_ID m_layer
Definition: sch_item.h:201

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

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

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

437 { return m_connectivity_dirty; }
bool m_connectivity_dirty
Definition: sch_item.h:213

References SCH_ITEM::m_connectivity_dirty.

◆ IsDangling()

bool SCH_LINE::IsDangling ( ) const
inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 215 of file sch_line.h.

215 { 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 170 of file eda_item.h.

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

References IS_DRAGGED, and EDA_ITEM::m_flags.

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

◆ IsEndDangling()

bool SCH_LINE::IsEndDangling ( ) const
inline

Definition at line 214 of file sch_line.h.

214 { 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(), and IsPointClickableAnchor().

◆ 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::BreakSegments(), SCH_EDIT_FRAME::DeleteJunction(), doIsConnected(), SCH_SCREEN::MarkConnections(), and SCH_EDIT_FRAME::SchematicCleanUp().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const
inlineinherited

Definition at line 173 of file eda_item.h.

173 { return m_flags & ENTERED; }
#define ENTERED
indicates a group has been entered
Definition: eda_item.h:137
STATUS_FLAGS m_flags
Definition: eda_item.h:530

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 255 of file eda_item.h.

255 { return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:529

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 909 of file sch_line.cpp.

910 {
911  return ( GetLayer() == LAYER_NOTES );
912 }
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:287

References SCH_ITEM::GetLayer(), and LAYER_NOTES.

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

◆ IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const
inlinevirtualinherited

Allows items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD.

Definition at line 280 of file sch_item.h.

280 { return false; }

◆ IsLocked()

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

Definition at line 270 of file sch_item.h.

270 { return false; }

Referenced by SCH_EDIT_TOOL::DeleteItemCursor().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 167 of file eda_item.h.

167 { return m_flags & IS_CHANGED; }
#define IS_CHANGED
Item was edited, and modified.
Definition: eda_item.h:102
STATUS_FLAGS m_flags
Definition: eda_item.h:530

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

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

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

Definition at line 249 of file sch_item.h.

249 { 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_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_EDIT_FRAME::SchematicCleanUp(), and SCH_LINE_WIRE_BUS_TOOL::simplifyWireList().

◆ IsParallel()

bool SCH_LINE::IsParallel ( const SCH_LINE aLine) const

Definition at line 436 of file sch_line.cpp.

437 {
438  wxCHECK_MSG( aLine != NULL && aLine->Type() == SCH_LINE_T, false,
439  wxT( "Cannot test line segment for overlap." ) );
440 
441  wxPoint firstSeg = m_end - m_start;
442  wxPoint secondSeg = aLine->m_end - aLine->m_start;
443 
444  // Use long long here to avoid overflow in calculations
445  return !( (long long) firstSeg.x * secondSeg.y - (long long) firstSeg.y * secondSeg.x );
446 }
#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
Returns the type of object.
Definition: eda_item.h:162

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

Referenced by SCH_EDIT_FRAME::SchematicCleanUp().

◆ IsPointClickableAnchor()

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

Reimplemented from SCH_ITEM.

Definition at line 234 of file sch_line.h.

235  {
236  return ( GetStartPoint() == aPos && IsStartDangling() )
237  || ( GetEndPoint() == aPos && IsEndDangling() );
238  }
wxPoint GetStartPoint() const
Definition: sch_line.h:94
bool IsEndDangling() const
Definition: sch_line.h:214
bool IsStartDangling() const
Definition: sch_line.h:213
wxPoint GetEndPoint() const
Definition: sch_line.h:97

References GetEndPoint(), GetStartPoint(), IsEndDangling(), and IsStartDangling().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

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

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

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_LABEL, SCH_TEXT, SCH_SHEET_PIN, and SCH_FIELD.

Definition at line 452 of file eda_item.h.

452 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 174 of file eda_item.h.

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

References IS_RESIZED, and EDA_ITEM::m_flags.

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

◆ IsSameQuadrant()

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

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 413 of file sch_line.cpp.

414 {
415  wxPoint first;
416  wxPoint second;
417 
418  if( m_start == aPosition )
419  first = m_end - aPosition;
420  else if( m_end == aPosition )
421  first = m_start - aPosition;
422  else
423  return false;
424 
425  if( aLine->m_start == aPosition )
426  second = aLine->m_end - aPosition;
427  else if( aLine->m_end == aPosition )
428  second = aLine->m_start - aPosition;
429  else
430  return false;
431 
432  return ( sign( first.x ) == sign( second.x ) && sign( first.y ) == sign( second.y ) );
433 }
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, and sign().

◆ IsSelected()

◆ IsStartDangling()

bool SCH_LINE::IsStartDangling ( ) const
inline

Definition at line 213 of file sch_line.h.

213 { 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(), and IsPointClickableAnchor().

◆ IsStrokeEquivalent()

bool SCH_LINE::IsStrokeEquivalent ( const SCH_LINE aLine)
inline

Definition at line 131 of file sch_line.h.

132  {
133  if( m_stroke.GetWidth() != aLine->GetStroke().GetWidth() )
134  return false;
135 
136  if( m_stroke.GetColor() != aLine->GetStroke().GetColor() )
137  return false;
138 
140  PLOT_DASH_TYPE style_b = aLine->GetStroke().GetPlotStyle();
141 
142  return style_a == style_b
143  || ( style_a == PLOT_DASH_TYPE::DEFAULT && style_b == PLOT_DASH_TYPE::SOLID )
144  || ( style_a == PLOT_DASH_TYPE::SOLID && style_b == PLOT_DASH_TYPE::DEFAULT );
145  }
PLOT_DASH_TYPE GetPlotStyle() const
Definition: sch_item.h:174
int GetWidth() const
Definition: sch_item.h:171
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
PLOT_DASH_TYPE
Dashed line types.
Definition: plotter.h:104
COLOR4D GetColor() const
Definition: sch_item.h:177
virtual STROKE_PARAMS GetStroke() const override
Definition: sch_line.h:128

References DEFAULT, STROKE_PARAMS::GetColor(), STROKE_PARAMS::GetPlotStyle(), GetStroke(), STROKE_PARAMS::GetWidth(), m_stroke, and SOLID.

Referenced by SCH_EDIT_FRAME::SchematicCleanUp().

◆ IsType()

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

Check 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  }
search types array terminator (End Of Types)
Definition: typeinfo.h:81
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
SCH_LAYER_ID m_layer
Definition: sch_item.h:201
virtual bool IsType(const KICAD_T aScanTypes[]) const
Check whether the item is one of the listed types.
Definition: eda_item.h:232

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 915 of file sch_line.cpp.

916 {
917  return ( GetLayer() == LAYER_WIRE );
918 }
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:287

References SCH_ITEM::GetLayer(), and LAYER_WIRE.

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 171 of file eda_item.h.

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

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

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

Definition at line 344 of file eda_item.h.

348  {
349  for( auto it : aList )
350  {
351  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
353  return SEARCH_RESULT::QUIT;
354  }
355 
357  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:107

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

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

Change first parameter to avoid the DList and use std::vector instead.

Definition at line 363 of file eda_item.h.

365  {
366  for( auto it : aList )
367  {
368  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
370  return SEARCH_RESULT::QUIT;
371  }
372 
374  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:107

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

◆ Matches() [1/2]

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

Compare the item against the search criteria in aSearchData.

The base class returns false since many of the objects derived from EDA_ITEM do not have any text to search.

Parameters
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, ZONE, SCH_PIN, SCH_MARKER, PCB_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 414 of file eda_item.h.

415  {
416  return false;
417  }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), PCB_TEXT::Matches(), FP_TEXT::Matches(), PCB_MARKER::Matches(), SCH_MARKER::Matches(), SCH_PIN::Matches(), ZONE::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), and SCH_EDITOR_CONTROL::UpdateFind().

◆ Matches() [2/2]

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

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

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

Definition at line 132 of file eda_item.cpp.

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

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

◆ MergeOverlap()

SCH_LINE * SCH_LINE::MergeOverlap ( SCH_SCREEN aScreen,
SCH_LINE aLine,
bool  aCheckJunctions 
)

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
aScreen- the current screen
aLine- Line to compare.
aCheckJunctions- indicates we need to check for a junction if the two segments are colinear and touch
Returns
New line that combines the two or NULL on non-overlapping segments.

Definition at line 449 of file sch_line.cpp.

450 {
451  auto less = []( const wxPoint& lhs, const wxPoint& rhs ) -> bool
452  {
453  if( lhs.x == rhs.x )
454  return lhs.y < rhs.y;
455 
456  return lhs.x < rhs.x;
457  };
458 
459  wxCHECK_MSG( aLine != NULL && aLine->Type() == SCH_LINE_T, NULL,
460  wxT( "Cannot test line segment for overlap." ) );
461 
462  if( this == aLine || GetLayer() != aLine->GetLayer() )
463  return nullptr;
464 
465  auto leftmost_start = aLine->m_start;
466  auto leftmost_end = aLine->m_end;
467 
468  auto rightmost_start = m_start;
469  auto rightmost_end = m_end;
470 
471  // We place the start to the left and below the end of both lines
472  if( leftmost_start != std::min( { leftmost_start, leftmost_end }, less ) )
473  std::swap( leftmost_start, leftmost_end );
474  if( rightmost_start != std::min( { rightmost_start, rightmost_end }, less ) )
475  std::swap( rightmost_start, rightmost_end );
476 
477  // - leftmost is the line that starts farthest to the left
478  // - other is the line that is _not_ leftmost
479  // - rightmost is the line that ends farthest to the right. This may or may not be 'other'
480  // as the second line may be completely covered by the first.
481  if( less( rightmost_start, leftmost_start ) )
482  {
483  std::swap( leftmost_start, rightmost_start );
484  std::swap( leftmost_end, rightmost_end );
485  }
486 
487  wxPoint other_start = rightmost_start;
488  wxPoint other_end = rightmost_end;
489 
490  if( less( rightmost_end, leftmost_end ) )
491  {
492  rightmost_start = leftmost_start;
493  rightmost_end = leftmost_end;
494  }
495 
496  // If we end one before the beginning of the other, no overlap is possible
497  if( less( leftmost_end, other_start ) )
498  {
499  return nullptr;
500  }
501 
502  // Search for a common end:
503  if( ( leftmost_start == other_start ) && ( leftmost_end == other_end ) ) // Trivial case
504  {
505  auto ret = new SCH_LINE( *aLine );
506  ret->SetStartPoint( leftmost_start );
507  ret->SetEndPoint( leftmost_end );
508 
509  if( IsSelected() || aLine->IsSelected() )
510  ret->SetSelected();
511 
512  return ret;
513  }
514 
515  bool colinear = false;
516 
517  /* Test alignment: */
518  if( ( leftmost_start.y == leftmost_end.y ) &&
519  ( other_start.y == other_end.y ) ) // Horizontal segment
520  {
521  colinear = ( leftmost_start.y == other_start.y );
522  }
523  else if( ( leftmost_start.x == leftmost_end.x ) &&
524  ( other_start.x == other_end.x ) ) // Vertical segment
525  {
526  colinear = ( leftmost_start.x == other_start.x );
527  }
528  else
529  {
530  // We use long long here to avoid overflow -- it enforces promotion
531  // The slope of the left-most line is dy/dx. Then we check that the slope from the
532  // left most start to the right most start is the same as well as the slope from the
533  // left most start to right most end.
534  long long dx = leftmost_end.x - leftmost_start.x;
535  long long dy = leftmost_end.y - leftmost_start.y;
536  colinear = ( ( ( other_start.y - leftmost_start.y ) * dx ==
537  ( other_start.x - leftmost_start.x ) * dy ) &&
538  ( ( other_end.y - leftmost_start.y ) * dx ==
539  ( other_end.x - leftmost_start.x ) * dy ) );
540  }
541 
542  if( !colinear )
543  return nullptr;
544 
545  // We either have a true overlap or colinear touching segments. We always want to merge
546  // the former, but the later only get merged if there no junction at the touch point.
547 
548  bool touching = leftmost_end == rightmost_start;
549 
550  if( touching && aCheckJunctions && aScreen->IsJunctionNeeded( leftmost_end ) )
551  return nullptr;
552 
553  // Make a new segment that merges the 2 segments
554  leftmost_end = rightmost_end;
555 
556  auto ret = new SCH_LINE( *aLine );
557  ret->SetStartPoint( leftmost_start );
558  ret->SetEndPoint( leftmost_end );
559 
560  if( IsSelected() || aLine->IsSelected() )
561  ret->SetSelected();
562 
563  return ret;
564 }
bool IsSelected() const
Definition: eda_item.h:172
bool IsJunctionNeeded(const wxPoint &aPosition, bool aNew=false)
Test if a junction is required for the items at aPosition on the screen.
Definition: sch_screen.cpp:369
#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:287
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
Returns the type of object.
Definition: eda_item.h:162

References SCH_ITEM::GetLayer(), SCH_SCREEN::IsJunctionNeeded(), EDA_ITEM::IsSelected(), m_end, m_start, NULL, SCH_LINE(), SCH_LINE_T, and EDA_ITEM::Type().

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

◆ MirrorHorizontally()

void SCH_LINE::MirrorHorizontally ( int  aCenter)
overridevirtual

Mirror item horizontally about aCenter.

Implements SCH_ITEM.

Definition at line 387 of file sch_line.cpp.

388 {
389  MIRROR( m_start.x, aCenter );
390  MIRROR( m_end.x, aCenter );
391 }
void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:40
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 MIRROR().

◆ MirrorVertically()

void SCH_LINE::MirrorVertically ( int  aCenter)
overridevirtual

Mirror item vertically about aCenter.

Implements SCH_ITEM.

Definition at line 380 of file sch_line.cpp.

381 {
382  MIRROR( m_start.y, aCenter );
383  MIRROR( m_end.y, aCenter );
384 }
void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:40
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 MIRROR().

◆ Move()

void SCH_LINE::Move ( const wxPoint &  aMoveVector)
overridevirtual

Move the item by aMoveVector to a new position.

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: eda_item.cpp:79
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: eda_item.cpp:79
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: eda_item.cpp:79
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 SCH_SHEET_PATH aSheet = nullptr) const
inherited

Definition at line 145 of file sch_item.cpp.

146 {
147  if( m_connection_map.size() )
148  {
149  SCH_CONNECTION* connection = Connection( aSheet );
150 
151  if( connection )
152  {
153  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
154  const wxString& netclassName = netSettings.GetNetclassName( connection->Name() );
155 
156  return netSettings.m_NetClasses.Find( netclassName );
157  }
158  }
159 
160  return nullptr;
161 }
NETCLASSPTR Find(const wxString &aName) const
Search this container for a NETCLASS given by aName.
Definition: netclass.cpp:132
const wxString & GetNetclassName(const wxString &aNetName) const
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:145
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
NET_SETTINGS & NetSettings()
Definition: project_file.h:92
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:131
NETCLASSES m_NetClasses
Definition: net_settings.h:39
wxString Name(bool aIgnoreSheet=false) const
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:211
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
Definition: schematic.h:99
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).

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

Referenced by GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_JUNCTION::GetJunctionColor(), 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 753 of file sch_line.cpp.

754 {
755  if( Type() != aItem.Type() )
756  return Type() < aItem.Type();
757 
758  auto line = static_cast<const SCH_LINE*>( &aItem );
759 
760  if( GetLayer() != line->GetLayer() )
761  return GetLayer() < line->GetLayer();
762 
763  if( GetStartPoint().x != line->GetStartPoint().x )
764  return GetStartPoint().x < line->GetStartPoint().x;
765 
766  if( GetStartPoint().y != line->GetStartPoint().y )
767  return GetStartPoint().y < line->GetStartPoint().y;
768 
769  if( GetEndPoint().x != line->GetEndPoint().x )
770  return GetEndPoint().x < line->GetEndPoint().x;
771 
772  return GetEndPoint().y < line->GetEndPoint().y;
773 }
wxPoint GetStartPoint() const
Definition: sch_line.h:94
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:287
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:162
wxPoint GetEndPoint() const
Definition: sch_line.h:97

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

◆ operator<() [2/2]

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

Test if another item is less than this object.

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

Definition at line 185 of file eda_item.cpp.

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

References Format(), 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 828 of file sch_line.cpp.

829 {
830  auto* settings = static_cast<KIGFX::SCH_RENDER_SETTINGS*>( aPlotter->RenderSettings() );
831  int penWidth;
833 
834  if( color == COLOR4D::UNSPECIFIED )
835  color = settings->GetLayerColor( GetLayer() );
836 
837  aPlotter->SetColor( color );
838 
839  switch( m_layer )
840  {
841  case LAYER_WIRE: penWidth = settings->m_DefaultWireThickness; break;
842  case LAYER_BUS: penWidth = settings->m_DefaultBusThickness; break;
843  default: penWidth = GetPenWidth(); break;
844  }
845 
846  if( m_stroke.GetWidth() != 0 )
847  penWidth = m_stroke.GetWidth();
848 
849  penWidth = std::max( penWidth, settings->GetMinPenWidth() );
850 
851  aPlotter->SetCurrentLineWidth( penWidth );
852  aPlotter->SetDash( GetEffectiveLineStyle() );
853 
854  aPlotter->MoveTo( m_start );
855  aPlotter->FinishTo( m_end );
856 
857  aPlotter->SetDash( PLOT_DASH_TYPE::SOLID );
858 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:267
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:60
SCH_LAYER_ID m_layer
Definition: sch_item.h:201
int GetPenWidth() const override
Definition: sch_line.cpp:276
int GetWidth() const
Definition: sch_item.h:171
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:287
void MoveTo(const wxPoint &pos)
Definition: plotter.h:257
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:155
PLOT_DASH_TYPE GetEffectiveLineStyle() const
Definition: sch_line.cpp:256
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.
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

References color, PLOTTER::FinishTo(), 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 ( const 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 318 of file sch_line.cpp.

319 {
320  wxDC* DC = aSettings->GetPrintDC();
322 
323  if( color == COLOR4D::UNSPECIFIED )
324  color = aSettings->GetLayerColor( GetLayer() );
325 
326  wxPoint start = m_start;
327  wxPoint end = m_end;
329  int penWidth = std::max( GetPenWidth(), aSettings->GetDefaultPenWidth() );
330 
331  if( lineStyle <= PLOT_DASH_TYPE::FIRST_TYPE )
332  {
333  GRLine( nullptr, DC, start.x, start.y, end.x, end.y, penWidth, color );
334  }
335  else
336  {
337  EDA_RECT clip( (wxPoint) start, wxSize( end.x - start.x, end.y - start.y ) );
338  clip.Normalize();
339 
340  double theta = atan2( end.y - start.y, end.x - start.x );
341  double strokes[] = { 1.0, DASH_GAP_LEN( penWidth ), 1.0, DASH_GAP_LEN( penWidth ) };
342 
343  switch( lineStyle )
344  {
345  default:
347  strokes[0] = strokes[2] = DASH_MARK_LEN( penWidth );
348  break;
349  case PLOT_DASH_TYPE::DOT:
350  strokes[0] = strokes[2] = DOT_MARK_LEN( penWidth );
351  break;
353  strokes[0] = DASH_MARK_LEN( penWidth );
354  strokes[2] = DOT_MARK_LEN( penWidth );
355  break;
356  }
357 
358  for( size_t i = 0; i < 10000; ++i )
359  {
360  // Calculations MUST be done in doubles to keep from accumulating rounding
361  // errors as we go.
362  wxPoint next( start.x + strokes[ i % 4 ] * cos( theta ),
363  start.y + strokes[ i % 4 ] * sin( theta ) );
364 
365  // Drawing each segment can be done rounded to ints.
366  wxPoint segStart( KiROUND( start.x ), KiROUND( start.y ) );
367  wxPoint segEnd( KiROUND( next.x ), KiROUND( next.y ) );
368 
369  if( ClipLine( &clip, segStart.x, segStart.y, segEnd.x, segEnd.y ) )
370  break;
371  else if( i % 2 == 0 )
372  GRLine( nullptr, DC, segStart.x, segStart.y, segEnd.x, segEnd.y, penWidth, color );
373 
374  start = next;
375  }
376  }
377 }
CITER next(CITER it)
Definition: ptree.cpp:126
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:60
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
#define DASH_MARK_LEN(aLineWidth)
bool ClipLine(const EDA_RECT *aClipBox, int &x1, int &y1, int &x2, int &y2)
Test if any part of a line falls within the bounds of a rectangle.
#define DOT_MARK_LEN(aLineWidth)
int GetPenWidth() const override
Definition: sch_line.cpp:276
wxDC * GetPrintDC() const
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:228
wxPoint m_end
Line end point.
Definition: sch_line.h:42
PLOT_DASH_TYPE
Dashed line types.
Definition: plotter.h:104
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:287
PLOT_DASH_TYPE GetEffectiveLineStyle() const
Definition: sch_line.cpp:256
Handle the component boundary box.
Definition: eda_rect.h:42
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
#define DASH_GAP_LEN(aLineWidth)
int GetDefaultPenWidth() const
wxPoint m_start
Line start point.
Definition: sch_line.h:41
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

References ClipLine(), color, DASH, DASH_GAP_LEN, DASH_MARK_LEN, DASHDOT, DOT, DOT_MARK_LEN, FIRST_TYPE, KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), GetEffectiveLineStyle(), SCH_ITEM::GetLayer(), KIGFX::RENDER_SETTINGS::GetLayerColor(), GetLineColor(), GetPenWidth(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GRLine(), KiROUND(), m_end, m_start, next(), and EDA_RECT::Normalize().

◆ Replace() [1/2]

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

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

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

Definition at line 159 of file eda_item.cpp.

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

References traceFindReplace.

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

◆ Replace() [2/2]

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

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

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

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

442  {
443  return false;
444  }

◆ Rotate()

void SCH_LINE::Rotate ( wxPoint  aPosition)
overridevirtual

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

Implements SCH_ITEM.

Definition at line 394 of file sch_line.cpp.

395 {
396  RotatePoint( &m_start, aPosition, 900 );
397  RotatePoint( &m_end, aPosition, 900 );
398 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
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 407 of file sch_line.cpp.

408 {
409  RotatePoint( &m_end, aPosition, 900 );
410 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
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 401 of file sch_line.cpp.

402 {
403  RotatePoint( &m_start, aPosition, 900 );
404 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
wxPoint m_start
Line start point.
Definition: sch_line.h:41

References m_start, and RotatePoint().

Referenced by SCH_EDIT_TOOL::Rotate().

◆ RunOnChildren()

virtual void SCH_ITEM::RunOnChildren ( const std::function< void(SCH_ITEM *)> &  aFunction)
inlinevirtualinherited

Reimplemented in SCH_SHEET, SCH_COMPONENT, and SCH_GLOBALLABEL.

Definition at line 468 of file sch_item.h.

468 { }

Referenced by SCH_ITEM::Duplicate(), and SCH_SHEET_LIST::GetItem().

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const
inherited

Searches the item hierarchy to find a SCHEMATIC.

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

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

Returns
the parent schematic this item lives on, or nullptr

Definition at line 97 of file sch_item.cpp.

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

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

Referenced by SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_FIELD::DoHypertextMenu(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::getEffectiveShape(), GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_NO_CONNECT::GetPenWidth(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_COMPONENT::GetPins(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetTextOffset(), inheritNetclass(), SCH_SHEET::IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), SCH_GLOBALLABEL::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_COMPONENT::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), SCH_GLOBALLABEL::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:66
#define TYPE_HASH(x)
Definition: property.h:57
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:43
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
virtual void setter(void *aObject, wxAny &aValue)=0
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:63
virtual size_t OwnerHash() const =0
Return 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:66
#define TYPE_HASH(x)
Definition: property.h:57
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:43
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:63
void set(void *aObject, T aValue)
Definition: property.h:259
virtual size_t OwnerHash() const =0
Return 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:66
#define TYPE_HASH(x)
Definition: property.h:57
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:43
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:63
void set(void *aObject, T aValue)
Definition: property.h:259
virtual size_t OwnerHash() const =0
Return 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 439 of file sch_item.h.

439 { m_connectivity_dirty = aDirty; }
bool m_connectivity_dirty
Definition: sch_item.h:213

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

202 { m_flags |= aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:530

References EDA_ITEM::m_flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SCH_MOVE_TOOL::AlignElements(), PCB_CONTROL::AppendBoard(), FOOTPRINT::BuildPolyCourtyards(), SCH_EDIT_TOOL::ChangeTextType(), TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupSegments(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_PIN_TOOL::CreatePin(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::EnterGroup(), SCH_MOVE_TOOL::getConnectedDragItems(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EE_SELECTION_TOOL::Main(), TRACKS_CLEANER::mergeCollinearSegments(), SYMBOL_EDITOR_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), EE_SELECTION_TOOL::narrowSelection(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseJunction(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParseNoERC(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_ALTIUM_PLUGIN::ParseWire(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_TEXT::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

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

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

253 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: eda_item.h:529

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetLayer()

◆ 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:178

References m_stroke, and STROKE_PARAMS::SetColor().

Referenced by KIGFX::SCH_PAINTER::draw(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ 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:178
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

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

◆ SetLineStyle() [1/2]

◆ SetLineStyle() [2/2]

void SCH_LINE::SetLineStyle ( const int  aStyleId)

Definition at line 232 of file sch_line.cpp.

233 {
234  SetLineStyle( static_cast<PLOT_DASH_TYPE>( aStyleId ) );
235 }
void SetLineStyle(const PLOT_DASH_TYPE aStyle)
Definition: sch_line.cpp:238

References SetLineStyle().

◆ SetLineWidth()

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

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

Definition at line 275 of file sch_item.h.

275 {}

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

Definition at line 79 of file eda_item.cpp.

80 {
82 
83  // If this a child object, then the parent modification state also needs to be set.
84  if( m_parent )
86 }
void SetModified()
Definition: eda_item.cpp:79
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:528
#define IS_CHANGED
Item was edited, and modified.
Definition: eda_item.h:102
void SetFlags(STATUS_FLAGS aMask)
Definition: eda_item.h:202

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

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

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Reimplemented in DIMENSION_BASE.

Definition at line 165 of file eda_item.h.

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

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_PART::Flatten(), FOOTPRINT::FOOTPRINT(), GPCB_PLUGIN::FootprintLoad(), LEGACY_PLUGIN::FootprintLoad(), EAGLE_PLUGIN::FootprintLoad(), PCB_IO::FootprintLoad(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), LIB_PART::LIB_PART(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), FOOTPRINT::operator=(), LIB_PART::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), SCH_DRAWING_TOOLS::PlaceComponent(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_GLOBALLABEL::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

◆ SetPosition()

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

Reimplemented from EDA_ITEM.

Definition at line 861 of file sch_line.cpp.

862 {
863  m_end = m_end - ( m_start - aPosition );
864  m_start = aPosition;
865 }
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()

◆ SetState()

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

Definition at line 191 of file eda_item.h.

192  {
193  if( state )
194  m_status |= type; // state = ON or OFF
195  else
196  m_status &= ~type;
197  }
STATUS_FLAGS m_status
Definition: eda_item.h:527

References EDA_ITEM::m_status.

Referenced by LEGACY_PLUGIN::loadTrackList(), TRACKS_CLEANER::mergeCollinearSegments(), PCB_SELECTION_TOOL::selectConnectedTracks(), and BOARD_ITEM::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 200 of file eda_item.h.

200 { m_status = aStatus; }
STATUS_FLAGS m_status
Definition: eda_item.h:527

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( wxPoint  aPos)
inlineinherited

Definition at line 252 of file sch_item.h.

252 { m_storedPos = aPos; }
wxPoint m_storedPos
Definition: sch_item.h:204

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

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

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ Sort()

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

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

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

Definition at line 470 of file eda_item.h.

470 { 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 805 of file sch_line.cpp.

806 {
807  SCH_LINE* item = (SCH_LINE*) aItem;
808 
809  std::swap( m_layer, item->m_layer );
810 
811  std::swap( m_start, item->m_start );
812  std::swap( m_end, item->m_end );
813  std::swap( m_startIsDangling, item->m_startIsDangling );
814  std::swap( m_endIsDangling, item->m_endIsDangling );
815  std::swap( m_stroke, item->m_stroke );
816 }
bool m_endIsDangling
True if end point is not connected.
Definition: sch_line.h:40
SCH_LAYER_ID m_layer
Definition: sch_item.h:201
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

Returns the type of object.

This attribute should never be changed after a ctor sets it, so there is no public "setter" method.

Returns
the type of object.

Definition at line 162 of file eda_item.h.

162 { return m_structType; }
KICAD_T m_structType
Run time identification, keep private so it can never be changed after a ctor sets it.
Definition: eda_item.h:537

References EDA_ITEM::m_structType.

Referenced by KIGFX::PCB_VIEW::Add(), FOOTPRINT::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), PCB_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_NET_INSPECTOR::buildNewItem(), SCH_SCREENS::buildScreenList(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), PCB_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(), SCH_EDIT_TOOL::ChangeTextType(), CN_VISITOR::checkZoneItemConnection(), SCH_MARKER::ClassOf(), PCB_TEXT::ClassOf(), PCB_MARKER::ClassOf(), FP_SHAPE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), SCH_JUNCTION::ClassOf(), SCH_NO_CONNECT::ClassOf(), PCB_GROUP::ClassOf(), PCB_TARGET::ClassOf(), SCH_PIN::ClassOf(), ClassOf(), FP_TEXT::ClassOf(), SCH_FIELD::ClassOf(), NETINFO_ITEM::ClassOf(), PCB_SHAPE::ClassOf(), ZONE::ClassOf(), SCH_BITMAP::ClassOf(), PAD::ClassOf(), TRACK::ClassOf(), SCH_SHEET_PIN::ClassOf(), FOOTPRINT::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_SCREEN::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), SCH_TEXT::ClassOf(), SCH_SHEET::ClassOf(), BOARD::ClassOf(), ARC::ClassOf(), SCH_LABEL::ClassOf(), VIA::ClassOf(), ALIGNED_DIMENSION::ClassOf(), SCH_GLOBALLABEL::ClassOf(), ORTHOGONAL_DIMENSION::ClassOf(), SCH_HIERLABEL::ClassOf(), LEADER::ClassOf(), CENTER_DIMENSION::ClassOf(), TRACKS_CLEANER::cleanup(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_ITEM::compare(), EE_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), EDIT_TOOL::CreateArray(), BOARD_ADAPTER::createLayers(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), ZONE_CREATE_HELPER::createNewZone(), BOARD_ADAPTER::createTrack(), SCH_SCREEN::DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), 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::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), 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(), APPEARANCE_CONTROLS::doesBoardItemNeedRebuild(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawVia(), CONNECTION_SUBGRAPH::driverName(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_ITEM_DESC::EDA_ITEM_DESC(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), DRC_ENGINE::EvalRules(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectorForGroups(), NETLIST_EXPORTER_BASE::findNextSymbol(), EDIT_TOOL::Flip(), PCB_BASE_FRAME::FocusOnItem(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), FP_TEXT::FP_TEXT(), PCB_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(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetContextualTextVars(), FOOTPRINT::GetCoverageArea(), CONNECTION_GRAPH::getDefaultConnection(), getDrilledHoleShape(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), PCB_SHAPE::GetParentFootprint(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), DRC_ENGINE::GetShape(), PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), CONVERT_TOOL::getStartEndPoints(), GROUP_TOOL::Group(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::highlightNet(), highlightNet(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), DRC_RTREE::Insert(), insideArea(), insideCourtyard(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), ARRAY_CREATOR::Invoke(), isCopper(), CN_ANCHOR::IsDangling(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), PNS_KICAD_IFACE::IsFlashedOnLayer(), CADSTAR_PCB_ARCHIVE_LOADER::isFootprint(), SCH_FIELD::IsHypertext(), isKeepoutZone(), DRC_ENGINE::IsNetTie(), TRACK::IsNull(), IsParallel(), isPlated(), SCH_FIELD::IsReplaceable(), PNS::ROUTER::isStartingPointRoutable(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), PCB_SELECTION_TOOL::itemPassesFilter(), CONVERT_TOOL::LinesToPoly(), CLIPBOARD_IO::Load(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), EE_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), NETLIST_EXPORTER_XML::makeListOfNets(), PCB_POINT_EDITOR::makePoints(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_FIELD::Matches(), memberOf(), MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), LIB_ITEM::operator<(), SCH_FIELD::operator<(), operator<(), SCH_TEXT::operator<(), SCH_ITEM::operator<(), SCH_SHEET::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), PAD::PAD(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), CONVERT_TOOL::PolyToLines(), POSITION_RELATIVE_TOOL::PositionRelative(), SCH_FIELD::Print(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), SCH_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshSelection(), KIGFX::PCB_VIEW::Remove(), EE_RTREE::remove(), FOOTPRINT::Remove(), CN_CONNECTIVITY_ALGO::Remove(), SCH_SCREEN::Remove(), BOARD::Remove(), PCB_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), PCB_SELECTION_TOOL::RequestSelection(), SCHEMATIC::ResolveCrossReference(), PCB_PARSER::resolveGroups(), DS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), 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(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), PCB_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(), PCB_GROUP::SwapData(), SCH_FIELD::SwapData(), PCB_TEXT::SwapData(), TRACK::SwapData(), ARC::SwapData(), ALIGNED_DIMENSION::SwapData(), ORTHOGONAL_DIMENSION::SwapData(), SCH_SHEET::SwapData(), LEADER::SwapData(), VIA::SwapData(), SCH_COMPONENT::SwapData(), CENTER_DIMENSION::SwapData(), PAD::SwapData(), FOOTPRINT::SwapData(), ZONE::SwapData(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), ERC_TESTER::TestMultUnitPinConflicts(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), PCB_GROUP::TopLevelGroup(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), SCH_TEXT::UpdateDanglingState(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), SCH_BASE_FRAME::UpdateItem(), CONNECTION_GRAPH::updateItemConnectivity(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updateParentItem(), SCH_EDITOR_CONTROL::updatePastedInstances(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), PCB_GROUP::Visit(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_GLOBALLABEL::Visit(), SCH_SHEET::Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), PCB_GROUP::WithinScope(), and NETLIST_EXPORTER_CADSTAR::writeListOfNets().

◆ 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 595 of file sch_line.cpp.

597 {
598  bool previousStartState = m_startIsDangling;
599  bool previousEndState = m_endIsDangling;
600 
602 
603  for( DANGLING_END_ITEM item : aItemList )
604  {
605  if( item.GetItem() == this )
606  continue;
607 
608  if( ( IsWire()
609  && ( item.GetType() == BUS_START_END || item.GetType() == BUS_END_END
610  || item.GetType() == BUS_ENTRY_END ) )
611  || ( IsBus()
612  && ( item.GetType() == WIRE_START_END || item.GetType() == WIRE_END_END
613  || item.GetType() == PIN_END ) )
614  || ( IsGraphicLine()
615  && ( item.GetType() != GRAPHIC_START_END && item.GetType() != GRAPHIC_END_END ) ) )
616  continue;
617 
618  if( m_start == item.GetPosition() )
619  m_startIsDangling = false;
620 
621  if( m_end == item.GetPosition() )
622  m_endIsDangling = false;
623 
625  break;
626  }
627 
628  if( IsBus() || IsGraphicLine() )
629  {
630  // Force unchanged return state for graphic lines and busses
631  previousStartState = m_startIsDangling;
632  previousEndState = m_endIsDangling;
633  }
634 
635  return ( previousStartState != m_startIsDangling ) || ( previousEndState != m_endIsDangling );
636 }
bool IsGraphicLine() const
Returns if the line is a graphic (non electrical line)
Definition: sch_line.cpp:909
bool IsWire() const
Returns true if the line is a wire.
Definition: sch_line.cpp:915
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
Helper class used to store the state of schematic items that can be connected to other schematic item...
Definition: sch_item.h:87
wxPoint m_start
Line start point.
Definition: sch_line.h:41
bool IsBus() const
Returns true if the line is a bus.
Definition: sch_line.cpp:920

References BUS_END_END, BUS_ENTRY_END, BUS_START_END, GRAPHIC_END_END, GRAPHIC_START_END, IsBus(), IsGraphicLine(), IsWire(), m_end, m_endIsDangling, m_start, m_startIsDangling, PIN_END, WIRE_END_END, and WIRE_START_END.

◆ 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 926 of file sch_line.cpp.

927 {
928  return m_stroke.GetWidth() == 0 && m_stroke.GetColor() == COLOR4D::UNSPECIFIED
931 }
PLOT_DASH_TYPE GetDefaultStyle() const
Definition: sch_line.cpp:223
PLOT_DASH_TYPE GetPlotStyle() const
Definition: sch_item.h:174
int GetWidth() const
Definition: sch_item.h:171
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:43
COLOR4D GetColor() const
Definition: sch_item.h:177

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

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

Return the bounding box of the item covering all its layers.

Returns
the current bounding box.

Implements KIGFX::VIEW_ITEM.

Reimplemented in PAD, FOOTPRINT, CENTER_DIMENSION, EDIT_POINTS, PCB_SHAPE, DIMENSION_BASE, GERBER_DRAW_ITEM, FP_TEXT, TRACK, DS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, PCB_MARKER, MY_DRAWING, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::POLYGON_ITEM, RATSNEST_VIEW_ITEM, KIGFX::PREVIEW::RULER_ITEM, BRIGHT_BOX, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 206 of file eda_item.cpp.

207 {
208  // Basic fallback
209  EDA_RECT bbox = GetBoundingBox();
210 
211  return BOX2I( bbox.GetOrigin(), bbox.GetSize() );
212 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:522
const wxPoint GetOrigin() const
Definition: eda_rect.h:106
Handle the component boundary box.
Definition: eda_rect.h:42
virtual const EDA_RECT GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition: eda_item.cpp:89
const wxSize GetSize() const
Definition: eda_rect.h:96

References EDA_ITEM::GetBoundingBox(), EDA_RECT::GetOrigin(), and EDA_RECT::GetSize().

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), BRIGHT_BOX::ViewBBox(), DIMENSION_BASE::ViewBBox(), PCB_SHAPE::ViewBBox(), and BRIGHT_BOX::ViewDraw().

◆ ViewDraw()

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

Draw the parts of the object belonging to layer aLayer.

An alternative way for drawing objects 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
aLayeris the current drawing layer.
aViewis a pointer to the VIEW device we are drawing on.

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

Definition at line 111 of file view_item.h.

112  {}

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:201

References LAYER_SELECTION_SHADOWS, and SCH_ITEM::m_layer.

◆ ViewGetLOD()

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

Return 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
aLayeris the current drawing layer.
aViewis a pointer 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 FP_ZONE, PAD, FOOTPRINT, VIA, GERBER_DRAW_ITEM, FP_TEXT, TRACK, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 137 of file view_item.h.

138  {
139  // By default always show the item
140  return 0.0;
141  }

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::drawItem::operator()(), EE_GRID_HELPER::queryVisible(), PCB_GRID_HELPER::queryVisible(), and PCB_SELECTION_TOOL::Selectable().

◆ viewPrivData()

◆ Visit()

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

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, SCH_SHEET, FOOTPRINT, LIB_PART, SCH_GLOBALLABEL, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, PCB_GROUP, and GBR_LAYOUT.

Definition at line 107 of file eda_item.cpp.

108 {
109 #if 0 && defined(DEBUG)
110  std::cout << GetClass().mb_str() << ' ';
111 #endif
112 
113  if( IsType( scanTypes ) )
114  {
115  if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
116  return SEARCH_RESULT::QUIT;
117  }
118 
120 }
virtual bool IsType(const KICAD_T aScanTypes[]) const
Check whether the item is one of the listed types.
Definition: eda_item.h:232
virtual wxString GetClass() const =0
Return 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, SCH_ITEM_SET> SCH_ITEM::m_connected_items
protectedinherited

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

Definition at line 208 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 211 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 202 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

◆ 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

STATUS_FLAGS EDA_ITEM::m_status
protectedinherited

◆ m_storedPos

wxPoint SCH_ITEM::m_storedPos
protectedinherited

Definition at line 204 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 524 of file eda_item.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddHierarchicalReference(), RC_ITEM::AddItem(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), MICROWAVE_TOOL::createMicrowaveInductor(), DRAWING_TOOL::DrawVia(), LIB_PART::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), FOOTPRINT::Duplicate(), FOOTPRINT::DuplicateItem(), PAD_TOOL::EditPad(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), SCH_SHEET_LIST::FillItemMap(), BOARD::FillItemMap(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), SCH_SHEET_LIST::GetItem(), BOARD::GetItem(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), FP_TEXT::GetParentAsString(), PAD::GetParentAsString(), FP_SHAPE::GetParentAsString(), SCH_REFERENCE::GetPath(), SCH_MARKER::GetUUID(), PCB_MARKER::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), SCH_LEGACY_PLUGIN::loadComponent(), LEGACY_PLUGIN::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PCB_EDIT_FRAME::LoadFootprints(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), LEGACY_PLUGIN::loadTrackList(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), TRACK::cmp_tracks::operator()(), BOARD_ITEM::ptr_cmp::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), PAD::PAD(), PCB_PARSER::parseDIMENSION(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::parseSchSheetInstances(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_COMPONENT::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBusEntry(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveNoConnect(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_COMPONENT::SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), RC_ITEM::SetItems(), SwapItemData(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), testGroupEqual(), SCH_EDITOR_CONTROL::updatePastedInstances(), 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: