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:

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
int	GetAngleFrom (const wxPoint &aPoint) const
int	GetReverseAngleFrom (const wxPoint &aPoint) const
bool	IsNull () const
wxPoint	GetStartPoint () const
void	SetStartPoint (const wxPoint &aPosition)
wxPoint	GetEndPoint () const
void	SetEndPoint (const wxPoint &aPosition)
void	SetLastResolvedState (const SCH_ITEM *aItem) override
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 (const wxPoint &aCenter) override
	Rotate the item around aCenter 90 degrees in the clockwise direction. More...
void	RotateStart (const wxPoint &aCenter)
void	RotateEnd (const wxPoint &aCenter)
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. 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...
bool	ConnectionPropagatesTo (const EDA_ITEM *aItem) const override
	Return true if this item should propagate connection info to aItem. 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...
BITMAPS	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 inside or on the boundary of this item. More...
bool	HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
	Test if aRect intersects this item. More...
void	Plot (PLOTTER *aPlotter) const override
	Plot the schematic item to aPlotter. More...
EDA_ITEM *	Clone () 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
	Return if the line is a graphic (non electrical line) More...
bool	IsWire () const
	Return true if the line is a wire. More...
bool	IsBus () const
	Return true if the line is a bus. More...
SCH_ITEM *	Duplicate (bool doClone=false) const
	Routine to create a new copy of given item. More...
virtual bool	IsMovableFromAnchorPoint () const
wxPoint &	GetStoredPos ()
void	SetStoredPos (const wxPoint &aPos)
SCHEMATIC *	Schematic () 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
	Allow 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_CONNECTION *	Connection (const SCH_SHEET_PATH *aSheet=nullptr) const
	Retrieve the connection associated with this object in the given sheet. More...
SCH_ITEM_SET &	ConnectedItems (const SCH_SHEET_PATH &aPath)
	Retrieve the set of items connected to this item on the given sheet. More...
void	AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
	Add a connection link between this item and another. More...
SCH_CONNECTION *	InitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
	Create a new connection object associated with this object. More...
SCH_CONNECTION *	GetOrInitConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
bool	IsConnectivityDirty () const
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	SetFieldsAutoplaced ()
void	ClearFieldsAutoplaced ()
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_ITEM *	GetParent () 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 (EDA_ITEM_FLAGS type) const
void	SetState (EDA_ITEM_FLAGS type, bool state)
EDA_ITEM_FLAGS	GetStatus () const
void	SetStatus (EDA_ITEM_FLAGS aStatus)
void	SetFlags (EDA_ITEM_FLAGS aMask)
void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
EDA_ITEM_FLAGS	GetFlags () const
bool	HasFlag (EDA_ITEM_FLAGS aFlag) const
EDA_ITEM_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 >
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_SET >	m_connected_items
	Store pointers to other items that are connected to this one, per sheet. More...
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * >	m_connection_map
	Store connectivity information, per sheet. More...
bool	m_connectivity_dirty
EDA_ITEM_FLAGS	m_status
EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...
bool	m_forceVisible
EDA_ITEM_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...
PLOT_DASH_TYPE	m_lastResolvedLineStyle
int	m_lastResolvedWidth
COLOR4D	m_lastResolvedColor

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

 :
 SCH_ITEM( nullptr, SCH_LINE_T )
{
 m_start = pos;
 m_end = pos;
 m_stroke.SetWidth( 0 );
 m_stroke.SetPlotStyle( PLOT_DASH_TYPE::DEFAULT );
 m_stroke.SetColor( COLOR4D::UNSPECIFIED );

 switch( layer )
 {
 default: m_layer = LAYER_NOTES; break;
 case LAYER_WIRE: m_layer = LAYER_WIRE; break;
 case LAYER_BUS: m_layer = LAYER_BUS; break;
 }

 if( layer == LAYER_NOTES )
 m_startIsDangling = m_endIsDangling = true;
 else
 m_startIsDangling = m_endIsDangling = false;

 if( layer == LAYER_WIRE )
 m_lastResolvedWidth = Mils2iu( DEFAULT_WIRE_WIDTH_MILS );
 else if( layer == LAYER_BUS )
 m_lastResolvedWidth = Mils2iu( DEFAULT_BUS_WIDTH_MILS );
 else
 m_lastResolvedWidth = Mils2iu( DEFAULT_LINE_WIDTH_MILS );

 m_lastResolvedLineStyle = GetDefaultStyle();
 m_lastResolvedColor = COLOR4D::UNSPECIFIED;
}

References DEFAULT, DEFAULT_BUS_WIDTH_MILS, DEFAULT_LINE_WIDTH_MILS, DEFAULT_WIRE_WIDTH_MILS, GetDefaultStyle(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, m_end, m_endIsDangling, m_lastResolvedColor, m_lastResolvedLineStyle, m_lastResolvedWidth, 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 44 of file sch_line.h.

 :
 SCH_LINE( wxPoint( pos.x, pos.y ), layer )
 {}

SCH_LINE() [3/3]

SCH_LINE::SCH_LINE

(

const SCH_LINE &

aLine

)

Definition at line 73 of file sch_line.cpp.

 :
 SCH_ITEM( aLine )
{
 m_start = aLine.m_start;
 m_end = aLine.m_end;
 m_stroke = aLine.m_stroke;
 m_startIsDangling = aLine.m_startIsDangling;
 m_endIsDangling = aLine.m_endIsDangling;

 m_lastResolvedLineStyle = aLine.m_lastResolvedLineStyle;
 m_lastResolvedWidth = aLine.m_lastResolvedWidth;
 m_lastResolvedColor = aLine.m_lastResolvedColor;
}

References m_end, m_endIsDangling, m_lastResolvedColor, m_lastResolvedLineStyle, m_lastResolvedWidth, m_start, m_startIsDangling, and m_stroke.

~SCH_LINE()

SCH_LINE::~SCH_LINE ( )

inline

Definition at line 50 of file sch_line.h.

{ }

Member Function Documentation

AddConnectionTo()

void SCH_ITEM::AddConnectionTo ( const SCH_SHEET_PATH &  aPath, SCH_ITEM *  aItem  )

inherited

Add a connection link between this item and another.

Definition at line 183 of file sch_item.cpp.

{
 SCH_ITEM_SET& set = m_connected_items[ aSheet ];

 // The vector elements are small, so reserve 1k at a time to prevent re-allocations
 if( set.size() == set.capacity() )
 set.reserve( set.size() + 4096 );

 set.emplace_back( aItem );
}

References SCH_ITEM::m_connected_items.

Referenced by SCH_TEXT::UpdateDanglingState(), and CONNECTION_GRAPH::updateItemConnectivity().

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

aScreen

is the SCH_SCREEN associated with the current instance of the symbol.

Definition at line 436 of file sch_item.h.

 {
 if( GetFieldsAutoplaced() )
 AutoplaceFields( aScreen, GetFieldsAutoplaced() == FIELDS_AUTOPLACED_MANUAL );
 }

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(), SCH_SHEET::SCH_SHEET(), and SCH_EDIT_FRAME::SelectUnit().

AutoplaceFields()

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

inlinevirtualinherited

Reimplemented in SCH_SYMBOL, SCH_GLOBALLABEL, and SCH_SHEET.

Definition at line 442 of file sch_item.h.

{ }

Referenced by SCH_ITEM::AutoAutoplaceFields(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), and SCH_DRAWING_TOOLS::TwoClickPlace().

CanConnect()

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

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 692 of file sch_line.cpp.

{
 if( m_layer == LAYER_WIRE )
 {
 switch( aItem->Type() )
 {
 case SCH_JUNCTION_T:
 case SCH_NO_CONNECT_T:
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 case SCH_BUS_WIRE_ENTRY_T:
 case SCH_SYMBOL_T:
 case SCH_SHEET_T:
 case SCH_SHEET_PIN_T:
 return true;
 default:
 break;
 }
 }
 else if( m_layer == LAYER_BUS )
 {
 switch( aItem->Type() )
 {
 case SCH_JUNCTION_T:
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 case SCH_BUS_WIRE_ENTRY_T:
 case SCH_SHEET_T:
 case SCH_SHEET_PIN_T:
 return true;
 default:
 break;
 }
 }

 return aItem->GetLayer() == m_layer;
}

References SCH_ITEM::GetLayer(), LAYER_BUS, LAYER_WIRE, SCH_ITEM::m_layer, SCH_BUS_WIRE_ENTRY_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, SCH_SYMBOL_T, and EDA_ITEM::Type().

ClassOf()

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

inlinestatic

Definition at line 52 of file sch_line.h.

 {
 return aItem && SCH_LINE_T == aItem->Type();
 }

References SCH_LINE_T, and EDA_ITEM::Type().

ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 132 of file eda_item.h.

{ ClearFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

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

{ m_connections.clear(); }

References SCH_ITEM::m_connections.

ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 171 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

References EDA_ITEM::ClearFlags(), and EDA_ITEM::GetEditFlags().

Referenced by FOOTPRINT::Add(), BOARD::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )

inlineinherited

Definition at line 427 of file sch_item.h.

{ m_fieldsAutoplaced = FIELDS_AUTOPLACED_NO; }

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

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

ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS  aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 153 of file eda_item.h.

{ m_flags &= ~aMask; }

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(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 131 of file eda_item.h.

{ ClearFlags( SELECTED ); }

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL::LIB_SYMBOL(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 165 of file eda_item.h.

 {
 ClearFlags( STARTPOINT | ENDPOINT | CANDIDATE | TEMP_SELECTED | IS_LINKED | SKIP_STRUCT |
 DO_NOT_DRAW );
 }

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 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

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

{
 return new SCH_LINE( *this );
}

References SCH_LINE().

ConnectedItems()

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

inherited

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

Definition at line 177 of file sch_item.cpp.

{
 return m_connected_items[ aSheet ];
}

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), 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 138 of file sch_item.cpp.

{
 if( !IsConnectable() )
 return nullptr;

 wxCHECK_MSG( !IsConnectivityDirty(), nullptr,
 wxT( "Shouldn't be asking for connection if connectivity is dirty!" ) );

 if( !aSheet )
 aSheet = &Schematic()->CurrentSheet();

 auto it = m_connection_map.find( *aSheet );

 if( it == m_connection_map.end() )
 return nullptr;
 else
 return it->second;
}

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

Referenced by CONNECTION_SUBGRAPH::Absorb(), CONNECTION_SUBGRAPH::AddItem(), CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::GetBusesNeedingMigration(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), SCH_ITEM::GetOrInitConnection(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_ITEM::NetClass(), SCH_TEXT::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_EDIT_FRAME::RecalculateConnections(), 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()

bool SCH_LINE::ConnectionPropagatesTo ( const EDA_ITEM *  aItem ) const

overridevirtual

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

Reimplemented from SCH_ITEM.

Definition at line 739 of file sch_line.cpp.

{
 switch( aItem->Type() )
 {
 case SCH_LINE_T:
 return IsBus() == static_cast<const SCH_LINE*>( aItem )->IsBus();

 default:
 return true;
 }
}

References IsBus(), SCH_LINE_T, and EDA_ITEM::Type().

DoHypertextMenu()

virtual void SCH_ITEM::DoHypertextMenu ( EDA_DRAW_FRAME *  aFrame )

inlinevirtualinherited

Reimplemented in SCH_FIELD.

Definition at line 254 of file sch_item.h.

{ }

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

aPosition

is a reference to a wxPoint object containing the test position.

Returns

True if connection to aPosition exists.

Reimplemented from SCH_ITEM.

Definition at line 885 of file sch_line.cpp.

{
 if( m_layer != LAYER_WIRE && m_layer != LAYER_BUS )
 return false;

 return IsEndPoint( aPosition );
}

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

{
 SCH_ITEM* newItem = (SCH_ITEM*) Clone();

 if( !doClone )
 const_cast<KIID&>( newItem->m_Uuid ) = KIID();

 newItem->ClearFlags( SELECTED | BRIGHTENED );

 newItem->RunOnChildren(
 []( SCH_ITEM* aChild )
 {
 aChild->ClearFlags( SELECTED | BRIGHTENED );
 } );

 return newItem;
}

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

Referenced by SCH_EDIT_FRAME::BreakSegment(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_LINE_WIRE_BUS_TOOL::startSegments().

Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 86 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 return object ? aProperty->getter( object ) : wxAny();
 }

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

Referenced by BOOST_AUTO_TEST_CASE(), 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 95 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 return object ? aProperty->get<T>( object ) : T();
 }

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 104 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 boost::optional<T> ret = T();

 if( prop )
 {
 void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );

 if( object )
 ret = prop->get<T>( object );
 }

 return ret;
 }

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

GetAngleFrom()

int SCH_LINE::GetAngleFrom

(

const wxPoint &

aPoint

)

const

Definition at line 472 of file sch_line.cpp.

{
 wxPoint vec;

 if( aPoint == m_start )
 vec = m_end - aPoint;
 else
 vec = m_start - aPoint;

 return KiROUND( ArcTangente( vec.y, vec.x ) );
}

References ArcTangente(), KiROUND(), m_end, and m_start.

Referenced by SCH_SCREEN::doIsJunction().

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

{
 int width = m_stroke.GetWidth() / 2;
 int extra = m_stroke.GetWidth() & 0x1;

 int xmin = std::min( m_start.x, m_end.x ) - width;
 int ymin = std::min( m_start.y, m_end.y ) - width;

 int xmax = std::max( m_start.x, m_end.x ) + width + extra;
 int ymax = std::max( m_start.y, m_end.y ) + width + extra;

 EDA_RECT ret( wxPoint( xmin, ymin ), wxSize( xmax - xmin, ymax - ymin ) );

 return ret;
}

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

Referenced by SCH_SCREEN::MarkConnections(), and SCH_EAGLE_PLUGIN::moveLabels().

GetClass()

wxString SCH_LINE::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 57 of file sch_line.h.

 {
 return wxT( "SCH_LINE" );
 }

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

aPoints

is the list of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 733 of file sch_line.cpp.

{
 return { m_start, m_end };
}

References m_end, and m_start.

GetDefaultStyle()

PLOT_DASH_TYPE SCH_LINE::GetDefaultStyle

(

)

const

Definition at line 254 of file sch_line.cpp.

{
 if( IsGraphicLine() )
 return PLOT_DASH_TYPE::DASH;

 return PLOT_DASH_TYPE::SOLID;
}

References DASH, IsGraphicLine(), and SOLID.

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

GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

 {
 constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
 | IS_WIRE_IMAGE | STRUCT_DELETED );

 return m_flags & mask;
 }

References IS_DRAGGING, IS_MOVING, IS_NEW, IS_PASTED, IS_RESIZING, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SYMBOL::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_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_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 287 of file sch_line.cpp.

{
 if( m_stroke.GetPlotStyle() != PLOT_DASH_TYPE::DEFAULT )
 {
 m_lastResolvedLineStyle = m_stroke.GetPlotStyle();
 }
 else if( IsConnectable() && !IsConnectivityDirty() )
 {
 NETCLASSPTR netclass = NetClass();

 if( netclass )
 m_lastResolvedLineStyle = static_cast<PLOT_DASH_TYPE>( netclass->GetLineStyle() );
 }

 return m_lastResolvedLineStyle;
}

References DEFAULT, STROKE_PARAMS::GetPlotStyle(), IsConnectable(), SCH_ITEM::IsConnectivityDirty(), m_lastResolvedLineStyle, m_stroke, and SCH_ITEM::NetClass().

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

GetEndPoint()

wxPoint SCH_LINE::GetEndPoint ( ) const

inline

Definition at line 93 of file sch_line.h.

{ return m_end; }

References m_end.

Referenced by SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_FRAME::BreakSegments(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_SCREEN::doIsJunction(), KIGFX::SCH_PAINTER::draw(), AUTOPLACER::fitFieldsBetweenWires(), AUTOPLACER::getCollidingSides(), SCH_MOVE_TOOL::getConnectedDragItems(), EE_SELECTION_TOOL::GuessSelectionCandidates(), IsPointClickableAnchor(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_EAGLE_PLUGIN::loadSegments(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), SCH_EAGLE_PLUGIN::moveLabels(), EE_SELECTION_TOOL::narrowSelection(), operator<(), SCH_EDIT_TOOL::Rotate(), SCH_SEXPR_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveLine(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDIT_FRAME::TrimWire(), EE_POINT_EDITOR::updateParentItem(), and EE_POINT_EDITOR::updatePoints().

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

is the list of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 632 of file sch_line.cpp.

{
 if( IsConnectable() )
 {
 aItemList.emplace_back( IsBus() ? BUS_END : WIRE_END, this, m_start );
 aItemList.emplace_back( IsBus() ? BUS_END : WIRE_END, this, m_end );
 }
}

References BUS_END, IsBus(), IsConnectable(), m_end, m_start, and WIRE_END.

GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const

inlineinherited

Return whether the fields have been automatically placed.

Definition at line 424 of file sch_item.h.

{ return m_fieldsAutoplaced; }

References SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_ITEM::AutoAutoplaceFields(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), and EE_POINT_EDITOR::updateParentItem().

GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 154 of file eda_item.h.

{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), calcIsInsideArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), BOARD_INSPECTION_TOOL::InspectConstraints(), LIB_SYMBOL::LIB_SYMBOL(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

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_TRACK, and PCB_SHAPE.

Definition at line 258 of file eda_item.h.

{ return GetPosition(); }

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 259 of file sch_item.h.

{ return m_layer; }

References SCH_ITEM::m_layer.

Referenced by SCH_NO_CONNECT::CanConnect(), SCH_JUNCTION::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), CanConnect(), SCH_LABEL::CanConnect(), SCH_ITEM::CanConnect(), SCH_SHEET::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SYMBOL::CanConnect(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_SCREEN::doIsJunction(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_EDIT_TOOL::Init(), IsBus(), IsGraphicLine(), IsWire(), SCH_SCREEN::MarkConnections(), MergeOverlap(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_TEXT::operator<(), operator<(), SCH_JUNCTION::Plot(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), Plot(), SCH_SCREEN::Plot(), SCH_JUNCTION::Print(), Print(), SCH_SCREEN::Print(), SCH_LEGACY_PLUGIN::saveBusEntry(), SCH_SEXPR_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveText(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::TrimWire(), and CONNECTION_GRAPH::updateItemConnectivity().

GetLength()

double SCH_LINE::GetLength

(

)

const

Returns

The length of the line segment.

Definition at line 207 of file sch_line.cpp.

{
 return GetLineLength( m_start, m_end );
}

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

{
 if( m_stroke.GetColor() != COLOR4D::UNSPECIFIED )
 {
 m_lastResolvedColor = m_stroke.GetColor();
 }
 else if( IsConnectable() && !IsConnectivityDirty() )
 {
 NETCLASSPTR netclass = NetClass();

 if( netclass )
 m_lastResolvedColor = netclass->GetSchematicColor();
 }

 return m_lastResolvedColor;
}

References STROKE_PARAMS::GetColor(), IsConnectable(), SCH_ITEM::IsConnectivityDirty(), m_lastResolvedColor, 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 164 of file sch_line.h.

{ return m_stroke.GetWidth(); }

References STROKE_PARAMS::GetWidth(), and m_stroke.

Referenced by SCH_LEGACY_PLUGIN::saveLine().

GetLineStyle()

PLOT_DASH_TYPE SCH_LINE::GetLineStyle

(

)

const

Definition at line 278 of file sch_line.cpp.

{
 if( m_stroke.GetPlotStyle() != PLOT_DASH_TYPE::DEFAULT )
 return m_stroke.GetPlotStyle();

 return GetDefaultStyle();
}

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

Referenced by 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 115 of file sch_line.cpp.

{
 PLOT_DASH_TYPE id = PLOT_DASH_TYPE::DEFAULT; // Default style id

 //find the name by value
 auto resultIt = std::find_if( lineStyleNames.begin(), lineStyleNames.end(),
 [aStyleName]( const auto& it )
 {
 return it.second == aStyleName;
 } );

 if( resultIt != lineStyleNames.end() )
 id = resultIt->first;

 return id;
}

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

{
 auto resultIt = lineStyleNames.find( aStyle );

 //legacy behavior is to default to dash if there is no name
 return resultIt == lineStyleNames.end() ? lineStyleNames.find( PLOT_DASH_TYPE::DASH )->second :
 resultIt->second;
}

References DASH, and lineStyleNames.

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

GetMenuImage()

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

{
 if( m_layer == LAYER_NOTES )
 return BITMAPS::add_dashed_line;
 else if( m_layer == LAYER_WIRE )
 return BITMAPS::add_line;

 return BITMAPS::add_bus;
}

References add_bus, add_dashed_line, add_line, 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

aList

is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 922 of file sch_line.cpp.

{
 wxString msg;

 switch( GetLayer() )
 {
 case LAYER_WIRE: msg = _( "Wire" ); break;
 case LAYER_BUS: msg = _( "Bus" ); break;
 default: msg = _( "Graphical" ); break;
 }

 aList.emplace_back( _( "Line Type" ), msg );

 if( GetLineStyle() != GetEffectiveLineStyle() )
 msg = _( "from netclass" );
 else
 msg = GetLineStyleName( GetLineStyle() );

 aList.emplace_back( _( "Line Style" ), msg );

 SCH_CONNECTION* conn = nullptr;

 if( !IsConnectivityDirty() && dynamic_cast<SCH_EDIT_FRAME*>( aFrame ) )
 conn = Connection();

 if( conn )
 {
 conn->AppendInfoToMsgPanel( aList );

 if( !conn->IsBus() )
 {
 NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
 wxString netname = conn->Name();
 wxString netclassName = netSettings.m_NetClasses.GetDefaultPtr()->GetName();

 if( netSettings.m_NetClassAssignments.count( netname ) )
 netclassName = netSettings.m_NetClassAssignments[ netname ];

 aList.emplace_back( _( "Assigned Netclass" ), netclassName );
 }
 }
}

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

GetOrInitConnection()

SCH_CONNECTION * SCH_ITEM::GetOrInitConnection ( const SCH_SHEET_PATH &  aPath, CONNECTION_GRAPH *  aGraph  )

inherited

Definition at line 218 of file sch_item.cpp.

{
 if( !IsConnectable() )
 return nullptr;

 SetConnectivityDirty( false );

 SCH_CONNECTION* connection = Connection( &aSheet );

 if( connection )
 return connection;
 else
 return InitializeConnection( aSheet, aGraph );
}

References SCH_ITEM::Connection(), SCH_ITEM::InitializeConnection(), SCH_ITEM::IsConnectable(), and SCH_ITEM::SetConnectivityDirty().

GetParent()

EDA_ITEM* EDA_ITEM::GetParent ( void  ) const

inlineinherited

Definition at line 114 of file eda_item.h.

{ return m_parent; }

References EDA_ITEM::m_parent.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::editFieldText(), CONNECTION_GRAPH::ercCheckNoConnects(), SCH_PIN::GetParentSymbol(), EE_SELECTION_TOOL::highlight(), highlightNet(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), EE_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), BOARD_COMMIT::parentObject(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshSelection(), SCH_EDITOR_CONTROL::ReplaceAll(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN::saveField(), SCH_SCREEN::Schematic(), SCH_ITEM::Schematic(), SCH_SHEET::SearchHierarchy(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), EE_SELECTION_TOOL::unhighlight(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), and SCH_BASE_FRAME::UpdateItem().

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

{
 SCHEMATIC* schematic = Schematic();
 NETCLASSPTR netclass;

 switch ( m_layer )
 {
 default:
 if( m_stroke.GetWidth() > 0 )
 return m_stroke.GetWidth();

 if( schematic )
 return schematic->Settings().m_DefaultLineWidth;

 return Mils2iu( DEFAULT_LINE_WIDTH_MILS );

 case LAYER_WIRE:
 if( m_stroke.GetWidth() > 0 )
 {
 m_lastResolvedWidth = m_stroke.GetWidth();
 }
 else if( !IsConnectivityDirty() )
 {
 netclass = NetClass();

  if( !netclass && schematic )
 netclass = schematic->Prj().GetProjectFile().NetSettings().m_NetClasses.GetDefault();

 if( netclass )
 m_lastResolvedWidth = netclass->GetWireWidth();
 }

 return m_lastResolvedWidth;

 case LAYER_BUS:
 if( m_stroke.GetWidth() > 0 )
 {
 m_lastResolvedWidth = m_stroke.GetWidth();
 }
 else if( !IsConnectivityDirty() )
 {
 netclass = NetClass();

 if( !netclass && schematic )
 netclass = schematic->Prj().GetProjectFile().NetSettings().m_NetClasses.GetDefault();

 if( netclass )
 m_lastResolvedWidth = netclass->GetBusWidth();
 }

 return m_lastResolvedWidth;
 }
}

References DEFAULT_LINE_WIDTH_MILS, NETCLASSES::GetDefault(), PROJECT::GetProjectFile(), STROKE_PARAMS::GetWidth(), SCH_ITEM::IsConnectivityDirty(), LAYER_BUS, LAYER_WIRE, SCHEMATIC_SETTINGS::m_DefaultLineWidth, m_lastResolvedWidth, SCH_ITEM::m_layer, NET_SETTINGS::m_NetClasses, m_stroke, SCH_ITEM::NetClass(), PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), 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.

{ return m_start; }

References m_start.

Referenced by EE_POINT_EDITOR::updateParentItem().

GetReverseAngleFrom()

int SCH_LINE::GetReverseAngleFrom

(

const wxPoint &

aPoint

)

const

Definition at line 485 of file sch_line.cpp.

{
 wxPoint vec;

 if( aPoint == m_end )
 vec = m_start - aPoint;
 else
 vec = m_end - aPoint;

 return KiROUND( ArcTangente( vec.y, vec.x ) );
}

References ArcTangente(), KiROUND(), m_end, and m_start.

GetSelectedPoints()

void SCH_LINE::GetSelectedPoints

(

std::vector< wxPoint > &

aPoints

)

const

Definition at line 752 of file sch_line.cpp.

{
 if( m_flags & STARTPOINT )
 aPoints.push_back( m_start );

 if( m_flags & ENDPOINT )
 aPoints.push_back( m_end );
}

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

{
 wxString txtfmt, orient;

 if( m_start.x == m_end.x )
 {
 switch( m_layer )
 {
 case LAYER_WIRE: txtfmt = _( "Vertical Wire, length %s" ); break;
 case LAYER_BUS: txtfmt = _( "Vertical Bus, length %s" ); break;
 default: txtfmt = _( "Vertical Graphic Line, length %s" ); break;
 }
 }
 else if( m_start.y == m_end.y )
 {
 switch( m_layer )
 {
 case LAYER_WIRE: txtfmt = _( "Horizontal Wire, length %s" ); break;
 case LAYER_BUS: txtfmt = _( "Horizontal Bus, length %s" ); break;
 default: txtfmt = _( "Horizontal Graphic Line, length %s" ); break;
 }
 }
 else
 {
 switch( m_layer )
 {
 case LAYER_WIRE: txtfmt = _( "Wire, length %s" ); break;
 case LAYER_BUS: txtfmt = _( "Bus, length %s" ); break;
 default: txtfmt = _( "Graphic Line, length %s" ); break;
 }
 }

 return wxString::Format( txtfmt,
 MessageTextFromValue( aUnits, EuclideanNorm( m_start - m_end ) ) );
}

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

GetStartPoint()

wxPoint SCH_LINE::GetStartPoint ( ) const

inline

Definition at line 90 of file sch_line.h.

{ return m_start; }

References m_start.

Referenced by SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_FRAME::BreakSegments(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_SCREEN::doIsJunction(), KIGFX::SCH_PAINTER::draw(), AUTOPLACER::fitFieldsBetweenWires(), AUTOPLACER::getCollidingSides(), SCH_MOVE_TOOL::getConnectedDragItems(), EE_SELECTION_TOOL::GuessSelectionCandidates(), IsPointClickableAnchor(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_EAGLE_PLUGIN::loadSegments(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), SCH_EAGLE_PLUGIN::moveLabels(), EE_SELECTION_TOOL::narrowSelection(), operator<(), SCH_EDIT_TOOL::Rotate(), SCH_SEXPR_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveLine(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDIT_FRAME::TrimWire(), and EE_POINT_EDITOR::updatePoints().

GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS  type ) const

inlineinherited

Definition at line 136 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 149 of file eda_item.h.

{ return m_status; }

References EDA_ITEM::m_status.

GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 222 of file sch_item.h.

{ return m_storedPos; }

References SCH_ITEM::m_storedPos.

GetStroke()

virtual STROKE_PARAMS SCH_LINE::GetStroke ( ) const

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 136 of file sch_line.h.

{ return m_stroke; }

References m_stroke.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), IsStrokeEquivalent(), and SCH_SEXPR_PLUGIN::saveLine().

HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS  aFlag ) const

inlineinherited

Definition at line 155 of file eda_item.h.

{ return ( m_flags & aFlag ) == aFlag; }

References EDA_ITEM::m_flags.

Referenced by TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::moveItem(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList().

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 135 of file sch_line.h.

{ return true; }

HitTest() [1/2]

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

overridevirtual

Test if aPosition is inside or on the boundary of this item.

Parameters

aPosition	A reference to a wxPoint object containing the coordinates to test.
aAccuracy	Increase the item bounding box by this amount.

Returns

True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 833 of file sch_line.cpp.

{
 // Performance enhancement for connection-building
 if( aPosition == m_start || aPosition == m_end )
 return true;

 if( aAccuracy >= 0 )
 aAccuracy += GetPenWidth() / 2;
 else
 aAccuracy = abs( aAccuracy );

 if( TestSegmentHit( aPosition, m_start, m_end, aAccuracy ) )
 return true;

 aAccuracy += Mils2iu( DANGLING_SYMBOL_SIZE );

 return ( EuclideanNorm( aPosition - m_start ) < aAccuracy
 || EuclideanNorm( aPosition - m_end ) < aAccuracy );
}

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

Referenced by SCH_SCREEN::doIsJunction(), and 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 this item.

Parameters

aRect	A reference to a EDA_RECT object containing the rectangle to test.
aContained	Set to true to test for containment instead of an intersection.
aAccuracy	Increase aRect by this amount.

Returns

True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 854 of file sch_line.cpp.

{
 if( m_flags & (STRUCT_DELETED | SKIP_STRUCT ) )
 return false;

 EDA_RECT rect = aRect;

 if ( aAccuracy )
 rect.Inflate( aAccuracy );

 if( aContained )
 return rect.Contains( m_start ) && rect.Contains( m_end );

 return rect.Intersects( m_start, m_end );
}

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

Create a new connection object associated with this object.

Parameters

aPath

is the sheet path to initialize.

Definition at line 195 of file sch_item.cpp.

{
 SetConnectivityDirty( false );

 SCH_CONNECTION* connection = Connection( &aSheet );

 if( connection )
 {
 connection->Reset();
 }
 else
 {
 connection = new SCH_CONNECTION( this );
 m_connection_map.insert( std::make_pair( aSheet, connection ) );
 }

 connection->SetGraph( aGraph );
 connection->SetSheet( aSheet );
 return connection;
}

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

Referenced by SCH_ITEM::GetOrInitConnection().

IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_EDITOR_CONTROL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

IsBus()

bool SCH_LINE::IsBus

(

)

const

Return true if the line is a bus.

Returns

true if this line is on the bus layer.

Definition at line 977 of file sch_line.cpp.

{
 return ( GetLayer() == LAYER_BUS );
}

References SCH_ITEM::GetLayer(), and LAYER_BUS.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), ConnectionPropagatesTo(), GetEndPoints(), and 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 683 of file sch_line.cpp.

{
 if( m_layer == LAYER_WIRE || m_layer == LAYER_BUS )
 return true;

 return false;
}

References LAYER_BUS, LAYER_WIRE, and SCH_ITEM::m_layer.

Referenced by GetEffectiveLineStyle(), GetEndPoints(), GetLineColor(), and UpdateDanglingState().

IsConnected()

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

inherited

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

Parameters

aPoint

is a reference to a wxPoint object containing the coordinates to test.

Returns

True if connection to aPoint exists.

Definition at line 129 of file sch_item.cpp.

{
 if(( m_flags & STRUCT_DELETED ) || ( m_flags & SKIP_STRUCT ) )
 return false;

 return doIsConnected( aPosition );
}

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

Referenced by SCH_SCREEN::doIsJunction(), and SCH_SCREEN::IsTerminalPoint().

IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( ) const

inlineinherited

Definition at line 413 of file sch_item.h.

{ return m_connectivity_dirty; }

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_ITEM::Connection(), KIGFX::SCH_PAINTER::draw(), GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_JUNCTION::GetJunctionColor(), GetLineColor(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), and SCH_BUS_ENTRY_BASE::GetStrokeStyle().

IsDangling()

bool SCH_LINE::IsDangling ( ) const

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 213 of file sch_line.h.

{ return m_startIsDangling || m_endIsDangling; }

References m_endIsDangling, and m_startIsDangling.

IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

{ return m_flags & IS_DRAGGING; }

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

IsEndDangling()

bool SCH_LINE::IsEndDangling ( ) const

inline

Definition at line 212 of file sch_line.h.

{ return m_endIsDangling; }

References m_endIsDangling.

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

IsEndPoint()

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

inline

Definition at line 80 of file sch_line.h.

 {
 return aPoint == m_start || aPoint == m_end;
 }

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

{ return m_flags & ENTERED; }

References ENTERED, and EDA_ITEM::m_flags.

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

IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 205 of file eda_item.h.

{ return m_forceVisible; }

References EDA_ITEM::m_forceVisible.

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

IsGraphicLine()

bool SCH_LINE::IsGraphicLine

(

)

const

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

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

Definition at line 966 of file sch_line.cpp.

{
 return ( GetLayer() == LAYER_NOTES );
}

References SCH_ITEM::GetLayer(), and LAYER_NOTES.

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

IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const

inlinevirtualinherited

Allow items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD.

Definition at line 252 of file sch_item.h.

{ return false; }

IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const

inlinevirtualinherited

Returns

true if the object is locked, else false.

Definition at line 242 of file sch_item.h.

{ return false; }

IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 117 of file eda_item.h.

{ return m_flags & IS_CHANGED; }

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_SYMBOL, SCH_BITMAP, SCH_SHEET_PIN, SCH_SHEET, and SCH_BUS_ENTRY_BASE.

Definition at line 220 of file sch_item.h.

{ return true; }

Referenced by SCH_MOVE_TOOL::Main().

IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), LIB_SHAPE::CalcArcAngles(), LIB_PIN::CalcEdit(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Rotate().

IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::ConvertDeMorgan(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), EDIT_TOOL::DragArcTrack(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

IsNull()

bool SCH_LINE::IsNull ( ) const

inline

Definition at line 88 of file sch_line.h.

{ return m_start == m_end; }

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

{
 wxCHECK_MSG( aLine != nullptr && aLine->Type() == SCH_LINE_T, false,
 wxT( "Cannot test line segment for overlap." ) );

 wxPoint firstSeg = m_end - m_start;
 wxPoint secondSeg = aLine->m_end - aLine->m_start;

 // Use long long here to avoid overflow in calculations
 return !( (long long) firstSeg.x * secondSeg.y - (long long) firstSeg.y * secondSeg.x );
}

References m_end, m_start, 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.

 {
 return ( GetStartPoint() == aPos && IsStartDangling() )
 || ( GetEndPoint() == aPos && IsEndDangling() );
 }

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

Definition at line 402 of file eda_item.h.

{ return false; }

Referenced by EDA_ITEM::Matches().

IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), KIGFX::SCH_PAINTER::getTextThickness(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), RENDER_3D_OPENGL::renderFootprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), GERBVIEW_SELECTION_TOOL::unselect(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

IsStartDangling()

bool SCH_LINE::IsStartDangling ( ) const

inline

Definition at line 211 of file sch_line.h.

{ return m_startIsDangling; }

References m_startIsDangling.

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

IsStrokeEquivalent()

bool SCH_LINE::IsStrokeEquivalent ( const SCH_LINE *  aLine )

inline

Definition at line 139 of file sch_line.h.

 {
 if( m_stroke.GetWidth() != aLine->GetStroke().GetWidth() )
 return false;

 if( m_stroke.GetColor() != aLine->GetStroke().GetColor() )
 return false;

 PLOT_DASH_TYPE style_a = m_stroke.GetPlotStyle();
 PLOT_DASH_TYPE style_b = aLine->GetStroke().GetPlotStyle();

 return style_a == style_b
 || ( style_a == PLOT_DASH_TYPE::DEFAULT && style_b == PLOT_DASH_TYPE::SOLID )
 || ( style_a == PLOT_DASH_TYPE::SOLID && style_b == PLOT_DASH_TYPE::DEFAULT );
 }

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

aScanTypes

List of item types

Returns

true if the item type is contained in the list aScanTypes

Reimplemented from EDA_ITEM.

Definition at line 62 of file sch_line.h.

 {
 if( SCH_ITEM::IsType( aScanTypes ) )
  return true;

 for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
 {
 if( *p == SCH_LINE_LOCATE_WIRE_T && m_layer == LAYER_WIRE )
 return true;
 else if ( *p == SCH_LINE_LOCATE_BUS_T && m_layer == LAYER_BUS )
 return true;
 else if ( *p == SCH_LINE_LOCATE_GRAPHIC_LINE_T && m_layer == LAYER_NOTES )
 return true;
 }

 return false;
 }

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

Return true if the line is a wire.

Returns

true if this line is on the wire layer.

Definition at line 972 of file sch_line.cpp.

{
 return ( GetLayer() == LAYER_WIRE );
}

References SCH_ITEM::GetLayer(), and LAYER_WIRE.

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

IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

{ return m_flags & IS_WIRE_IMAGE; }

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

 {
 for( auto it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
 == SEARCH_RESULT::QUIT )
 return SEARCH_RESULT::QUIT;
 }

 return SEARCH_RESULT::CONTINUE;
 }

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

 {
 for( auto it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
 == SEARCH_RESULT::QUIT )
 return SEARCH_RESULT::QUIT;
 }

 return SEARCH_RESULT::CONTINUE;
 }

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

aSearchData	A reference to a wxFindReplaceData object containing the search criteria.
aAuxData	A 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_SYMBOL, SCH_SHEET, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, ZONE, SCH_PIN, PCB_MARKER, SCH_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 364 of file eda_item.h.

 {
 return false;
 }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), PCB_TEXT::Matches(), FP_TEXT::Matches(), SCH_MARKER::Matches(), PCB_MARKER::Matches(), SCH_PIN::Matches(), ZONE::Matches(), SCH_SHEET_PIN::Matches(), SCH_FIELD::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

aText	A reference to a wxString object containing the string to test.
aSearchData	The criteria to search against.

Returns

True if aText matches the search criteria in aSearchData.

Definition at line 118 of file eda_item.cpp.

{
 wxString text = aText;
 int flags = aSearchData.GetFlags();
 wxString searchText = aSearchData.GetFindString();

 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( ( flags & FR_SEARCH_REPLACE ) && !IsReplaceable() )
 return false;

 if( !( flags & wxFR_MATCHCASE ) )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }

 if( flags & wxFR_WHOLEWORD )
 {
 int ii = 0;

 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );

 if( next == wxNOT_FOUND )
 return false;

 ii = next;
 next += searchText.length();

 bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );

 if( startOK && endOK )
 return true;
 else
 ii++;
 }

 return false;
 }
 else if( flags & FR_MATCH_WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

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

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	is the current screen.
aLine	is the line to compare.
aCheckJunctions	is used to indicate if 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 511 of file sch_line.cpp.

{
 auto less =
 []( const wxPoint& lhs, const wxPoint& rhs ) -> bool
 {
 if( lhs.x == rhs.x )
 return lhs.y < rhs.y;

 return lhs.x < rhs.x;
 };

 wxCHECK_MSG( aLine != nullptr && aLine->Type() == SCH_LINE_T, nullptr,
 wxT( "Cannot test line segment for overlap." ) );

 if( this == aLine || GetLayer() != aLine->GetLayer() )
 return nullptr;

 wxPoint leftmost_start = aLine->m_start;
 wxPoint leftmost_end = aLine->m_end;

 wxPoint rightmost_start = m_start;
 wxPoint rightmost_end = m_end;

 // We place the start to the left and below the end of both lines
 if( leftmost_start != std::min( { leftmost_start, leftmost_end }, less ) )
 std::swap( leftmost_start, leftmost_end );
 if( rightmost_start != std::min( { rightmost_start, rightmost_end }, less ) )
 std::swap( rightmost_start, rightmost_end );

 // - leftmost is the line that starts farthest to the left
 // - other is the line that is _not_ leftmost
 // - rightmost is the line that ends farthest to the right. This may or may not be 'other'
 // as the second line may be completely covered by the first.
 if( less( rightmost_start, leftmost_start ) )
 {
 std::swap( leftmost_start, rightmost_start );
 std::swap( leftmost_end, rightmost_end );
 }

 wxPoint other_start = rightmost_start;
 wxPoint other_end = rightmost_end;

 if( less( rightmost_end, leftmost_end ) )
 {
 rightmost_start = leftmost_start;
 rightmost_end = leftmost_end;
 }

 // If we end one before the beginning of the other, no overlap is possible
 if( less( leftmost_end, other_start ) )
 {
 return nullptr;
 }

 // Search for a common end:
 if( ( leftmost_start == other_start ) && ( leftmost_end == other_end ) ) // Trivial case
 {
 SCH_LINE* ret = new SCH_LINE( *aLine );
 ret->SetStartPoint( leftmost_start );
 ret->SetEndPoint( leftmost_end );
 ret->SetConnectivityDirty( true );

 if( IsSelected() || aLine->IsSelected() )
 ret->SetSelected();

 return ret;
 }

 bool colinear = false;

 /* Test alignment: */
 if( ( leftmost_start.y == leftmost_end.y ) &&
 ( other_start.y == other_end.y ) ) // Horizontal segment
 {
 colinear = ( leftmost_start.y == other_start.y );
 }
 else if( ( leftmost_start.x == leftmost_end.x ) &&
 ( other_start.x == other_end.x ) ) // Vertical segment
 {
 colinear = ( leftmost_start.x == other_start.x );
 }
 else
 {
 // We use long long here to avoid overflow -- it enforces promotion
 // The slope of the left-most line is dy/dx. Then we check that the slope from the
 // left most start to the right most start is the same as well as the slope from the
 // left most start to right most end.
 long long dx = leftmost_end.x - leftmost_start.x;
 long long dy = leftmost_end.y - leftmost_start.y;
 colinear = ( ( ( other_start.y - leftmost_start.y ) * dx ==
 ( other_start.x - leftmost_start.x ) * dy ) &&
 ( ( other_end.y - leftmost_start.y ) * dx ==
 ( other_end.x - leftmost_start.x ) * dy ) );
 }

 if( !colinear )
 return nullptr;

 // We either have a true overlap or colinear touching segments. We always want to merge
 // the former, but the later only get merged if there no junction at the touch point.

 bool touching = leftmost_end == rightmost_start;

 if( touching && aCheckJunctions && aScreen->IsJunction( leftmost_end ) )
 return nullptr;

 // Make a new segment that merges the 2 segments
 leftmost_end = rightmost_end;

 SCH_LINE* ret = new SCH_LINE( *aLine );
 ret->SetStartPoint( leftmost_start );
 ret->SetEndPoint( leftmost_end );
 ret->SetConnectivityDirty( true );

 if( IsSelected() || aLine->IsSelected() )
 ret->SetSelected();

 return ret;
}

References SCH_ITEM::GetLayer(), SCH_SCREEN::IsJunction(), EDA_ITEM::IsSelected(), m_end, m_start, SCH_LINE(), SCH_LINE_T, SCH_ITEM::SetConnectivityDirty(), SetEndPoint(), EDA_ITEM::SetSelected(), SetStartPoint(), 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 438 of file sch_line.cpp.

{
 if( m_flags & STARTPOINT )
 MIRROR( m_start.x, aCenter );

 if( m_flags & ENDPOINT )
 MIRROR( m_end.x, aCenter );
}

References ENDPOINT, m_end, EDA_ITEM::m_flags, m_start, MIRROR(), and STARTPOINT.

MirrorVertically()

void SCH_LINE::MirrorVertically ( int  aCenter )

overridevirtual

Mirror item vertically about aCenter.

Implements SCH_ITEM.

Definition at line 428 of file sch_line.cpp.

{
 if( m_flags & STARTPOINT )
 MIRROR( m_start.y, aCenter );

 if( m_flags & ENDPOINT )
 MIRROR( m_end.y, aCenter );
}

References ENDPOINT, m_end, EDA_ITEM::m_flags, m_start, MIRROR(), and STARTPOINT.

Move()

void SCH_LINE::Move ( const wxPoint &  aMoveVector )

overridevirtual

Move the item by aMoveVector to a new position.

Implements SCH_ITEM.

Definition at line 133 of file sch_line.cpp.

{
 if( aOffset != wxPoint( 0, 0 ) )
 {
 m_start += aOffset;
 m_end += aOffset;
 SetModified();
 }
}

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

MoveEnd()

void SCH_LINE::MoveEnd

(

const wxPoint &

aMoveVector

)

Definition at line 154 of file sch_line.cpp.

{
 if( aOffset != wxPoint( 0, 0 ) )
 {
 m_end += aOffset;
 SetModified();
 }
}

References m_end, and EDA_ITEM::SetModified().

Referenced by SCH_MOVE_TOOL::moveItem().

MoveStart()

void SCH_LINE::MoveStart

(

const wxPoint &

aMoveVector

)

Definition at line 144 of file sch_line.cpp.

{
 if( aOffset != wxPoint( 0, 0 ) )
 {
 m_start += aOffset;
 SetModified();
 }
}

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

{
 if( m_connection_map.size() )
 {
 SCH_CONNECTION* connection = Connection( aSheet );

 if( connection )
 {
 NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
 const wxString& netclassName = netSettings.GetNetclassName( connection->Name() );

 return netSettings.m_NetClasses.Find( netclassName );
 }
 }

 return nullptr;
}

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

{
 if( Type() != aItem.Type() )
 return Type() < aItem.Type();

 const SCH_LINE* line = static_cast<const SCH_LINE*>( &aItem );

 if( GetLayer() != line->GetLayer() )
 return GetLayer() < line->GetLayer();

 if( GetStartPoint().x != line->GetStartPoint().x )
 return GetStartPoint().x < line->GetStartPoint().x;

 if( GetStartPoint().y != line->GetStartPoint().y )
 return GetStartPoint().y < line->GetStartPoint().y;

 if( GetEndPoint().x != line->GetEndPoint().x )
 return GetEndPoint().x < line->GetEndPoint().x;

 return GetEndPoint().y < line->GetEndPoint().y;
}

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 234 of file eda_item.cpp.

{
 wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
 GetClass() ) );

 return false;
}

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

Plot()

void SCH_LINE::Plot ( PLOTTER *  aPlotter ) const

overridevirtual

Plot the schematic item to aPlotter.

Parameters

aPlotter

is the PLOTTER object to plot to.

Reimplemented from SCH_ITEM.

Definition at line 894 of file sch_line.cpp.

{
 auto* settings = static_cast<KIGFX::SCH_RENDER_SETTINGS*>( aPlotter->RenderSettings() );
 int penWidth = std::max( GetPenWidth(), settings->GetMinPenWidth() );
 COLOR4D color = GetLineColor();

 if( color == COLOR4D::UNSPECIFIED )
 color = settings->GetLayerColor( GetLayer() );

 aPlotter->SetColor( color );

 aPlotter->SetCurrentLineWidth( penWidth );
 aPlotter->SetDash( GetEffectiveLineStyle() );

 aPlotter->MoveTo( m_start );
 aPlotter->FinishTo( m_end );

 aPlotter->SetDash( PLOT_DASH_TYPE::SOLID );
}

References color, PLOTTER::FinishTo(), GetEffectiveLineStyle(), SCH_ITEM::GetLayer(), GetLineColor(), GetPenWidth(), m_end, m_start, 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

aOffset

is the drawing offset (usually {0,0} but can be different when moving an object).

Implements SCH_ITEM.

Definition at line 366 of file sch_line.cpp.

{
 wxDC* DC = aSettings->GetPrintDC();
 COLOR4D color = GetLineColor();

 if( color == COLOR4D::UNSPECIFIED )
 color = aSettings->GetLayerColor( GetLayer() );

 wxPoint start = m_start;
 wxPoint end = m_end;
 PLOT_DASH_TYPE lineStyle = GetEffectiveLineStyle();
 int penWidth = std::max( GetPenWidth(), aSettings->GetDefaultPenWidth() );

 if( lineStyle <= PLOT_DASH_TYPE::FIRST_TYPE )
 {
 GRLine( nullptr, DC, start.x, start.y, end.x, end.y, penWidth, color );
 }
 else
 {
 EDA_RECT clip( (wxPoint) start, wxSize( end.x - start.x, end.y - start.y ) );
 clip.Normalize();

 double theta = atan2( end.y - start.y, end.x - start.x );
 double strokes[] = { 1.0, dash_gap_len( penWidth ), 1.0, dash_gap_len( penWidth ) };

 switch( lineStyle )
 {
 default:
 case PLOT_DASH_TYPE::DASH:
 strokes[0] = strokes[2] = dash_mark_len( penWidth );
 break;
 case PLOT_DASH_TYPE::DOT:
 strokes[0] = strokes[2] = dot_mark_len( penWidth );
 break;
 case PLOT_DASH_TYPE::DASHDOT:
 strokes[0] = dash_mark_len( penWidth );
 strokes[2] = dot_mark_len( penWidth );
 break;
 }

 for( size_t i = 0; i < 10000; ++i )
 {
 // Calculations MUST be done in doubles to keep from accumulating rounding
 // errors as we go.
 wxPoint next( start.x + strokes[ i % 4 ] * cos( theta ),
 start.y + strokes[ i % 4 ] * sin( theta ) );

 // Drawing each segment can be done rounded to ints.
 wxPoint segStart( KiROUND( start.x ), KiROUND( start.y ) );
 wxPoint segEnd( KiROUND( next.x ), KiROUND( next.y ) );

 if( ClipLine( &clip, segStart.x, segStart.y, segEnd.x, segEnd.y ) )
 break;
 else if( i % 2 == 0 )
 GRLine( nullptr, DC, segStart.x, segStart.y, segEnd.x, segEnd.y, penWidth, color );

 start = next;
 }
 }
}

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

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aText	A reference to a wxString object containing the text to be replaced.

Returns

True if aText was modified, otherwise false.

Definition at line 170 of file eda_item.cpp.

{
 wxString text = aText;
 int flags = aSearchData.GetFlags();
 wxString searchText = aSearchData.GetFindString();
 wxString result;
 bool replaced = false;

 if( flags & wxFR_MATCHCASE )
 {
 text = text.Upper();
 searchText = searchText.Upper();
 }

 int ii = 0;

 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );

 if( next == wxNOT_FOUND )
 {
 result += aText.Mid( ii, wxString::npos );
 break;
 }

 if( next > ii )
 result += aText.Mid( ii, next - ii );

 ii = next;
 next += searchText.length();

 bool startOK;
 bool endOK;

 if( flags & wxFR_WHOLEWORD )
 {
 startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 }
 else
 {
 startOK = true;
 endOK = true;
 }

 if( startOK && endOK )
 {
 result += aSearchData.GetReplaceString();
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }

 aText = result;
 return replaced;
}

References next(), and text.

Referenced by SCH_FIELD::Replace(), EDA_TEXT::Replace(), SCH_EDITOR_CONTROL::ReplaceAll(), 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

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxData	A 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_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 391 of file eda_item.h.

 {
 return false;
 }

Rotate()

void SCH_LINE::Rotate ( const wxPoint &  aCenter )

overridevirtual

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

Implements SCH_ITEM.

Definition at line 448 of file sch_line.cpp.

{
 // When we allow off grid items, the
 // else if should become a plain if to allow
 // rotation around the center of the line
 if( m_flags & STARTPOINT )
 RotatePoint( &m_start, aCenter, 900 );
 else if( m_flags & ENDPOINT )
 RotatePoint( &m_end, aCenter, 900 );
}

References ENDPOINT, m_end, EDA_ITEM::m_flags, m_start, RotatePoint(), and STARTPOINT.

RotateEnd()

void SCH_LINE::RotateEnd

(

const wxPoint &

aCenter

)

Definition at line 466 of file sch_line.cpp.

{
 RotatePoint( &m_end, aCenter, 900 );
}

References m_end, and RotatePoint().

Referenced by SCH_EDIT_TOOL::Rotate().

RotateStart()

void SCH_LINE::RotateStart

(

const wxPoint &

aCenter

)

Definition at line 460 of file sch_line.cpp.

{
 RotatePoint( &m_start, aCenter, 900 );
}

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_SYMBOL, SCH_SHEET, and SCH_GLOBALLABEL.

Definition at line 444 of file sch_item.h.

{ }

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

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

This hierarchy is not the same as the sheet hierarchy!

Returns

the parent schematic this item lives on, or nullptr.

Definition at line 104 of file sch_item.cpp.

{
 EDA_ITEM* parent = GetParent();

 while( parent )
 {
 if( parent->Type() == SCHEMATIC_T )
 return static_cast<SCHEMATIC*>( parent );
 else
 parent = parent->GetParent();
 }

 return nullptr;
}

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

Referenced by SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_FIELD::DoHypertextMenu(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::getEffectiveShape(), SCH_TEXT::GetLabelBoxExpansion(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_NO_CONNECT::GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), GetPenWidth(), SCH_SHEET::GetPenWidth(), SCH_SYMBOL::GetPins(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_PIN::HitTest(), SCH_GLOBALLABEL::HitTest(), inheritNetclass(), SCH_SHEET::IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), SCH_GLOBALLABEL::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_SHEET::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), and SCH_MARKER::ViewGetLayers().

Set() [1/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );

 if( object )
 aProperty->setter( object, aValue );

 return object != nullptr;
 }

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, T  aValue  )

inlineinherited

Definition at line 55 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );

 if( object )
 aProperty->set<T>( object, aValue );

 return object != nullptr;
 }

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, T  aValue  )

inlineinherited

Definition at line 68 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 void* object = nullptr;

 if( prop )
 {
 object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );

 if( object )
 prop->set<T>( object, aValue );
 }

 return object != nullptr;
 }

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

Definition at line 129 of file eda_item.h.

{ SetFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool  aDirty = true )

inlineinherited

Definition at line 415 of file sch_item.h.

{ m_connectivity_dirty = aDirty; }

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::BreakSegment(), SCH_ITEM::GetOrInitConnection(), SCH_ITEM::InitializeConnection(), MergeOverlap(), SCH_EDITOR_CONTROL::Paste(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

SetEndPoint()

void SCH_LINE::SetEndPoint ( const wxPoint &  aPosition )

inline

Definition at line 94 of file sch_line.h.

{ m_end = aPosition; }

References m_end.

Referenced by SCH_EDIT_FRAME::BreakSegment(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), SCH_EAGLE_PLUGIN::loadFrame(), CADSTAR_SCH_ARCHIVE_LOADER::loadGraphicStaightSegment(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), MergeOverlap(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_ALTIUM_PLUGIN::ParseWire(), SCH_SEXPR_PLUGIN::saveBusEntry(), and EE_POINT_EDITOR::updateParentItem().

SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )

inlineinherited

Definition at line 426 of file sch_item.h.

{ m_fieldsAutoplaced = FIELDS_AUTOPLACED_AUTO; }

References FIELDS_AUTOPLACED_AUTO, and SCH_ITEM::m_fieldsAutoplaced.

SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS  aMask )

inlineinherited

Definition at line 152 of file eda_item.h.

{ m_flags |= aMask; }

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(), GRAPHICS_CLEANER::cleanupShapes(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), 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(), PCB_SELECTION_TOOL::EnterGroup(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), 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(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceText(), SCH_SYMBOL::Plot(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), 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_BITMAP::SyncDrawItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_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

aEnable

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

{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

SetLastResolvedState()

void SCH_LINE::SetLastResolvedState ( const SCH_ITEM *  aItem )

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 96 of file sch_line.h.

 {
 const SCH_LINE* aLine = dynamic_cast<const SCH_LINE*>( aItem );

 if( aLine )
 {
 m_lastResolvedLineStyle = aLine->m_lastResolvedLineStyle;
 m_lastResolvedWidth = aLine->m_lastResolvedWidth;
 m_lastResolvedColor = aLine->m_lastResolvedColor;
 }
 }

References m_lastResolvedColor, m_lastResolvedLineStyle, and m_lastResolvedWidth.

SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID  aLayer )

inlineinherited

Set the layer this item is on.

Parameters

aLayer

The layer number.

Definition at line 266 of file sch_item.h.

{ m_layer = aLayer; }

References SCH_ITEM::m_layer.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadGraphicStaightSegment(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_NO_CONNECT::SCH_NO_CONNECT(), SCH_FIELD::SetId(), and CONNECTION_GRAPH::updateItemConnectivity().

SetLineColor() [1/2]

void SCH_LINE::SetLineColor

(

const COLOR4D &

aColor

)

Definition at line 213 of file sch_line.cpp.

{
 m_stroke.SetColor( aColor );
}

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

{
 COLOR4D newColor(r, g, b, a);

 if( newColor == COLOR4D::UNSPECIFIED )
 {
 m_stroke.SetColor( COLOR4D::UNSPECIFIED );
 }
 else
 {
 // Eeschema does not allow alpha channel in colors
 newColor.a = 1.0;
 m_stroke.SetColor( newColor );
 }
}

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

SetLineStyle() [1/2]

void SCH_LINE::SetLineStyle

(

const PLOT_DASH_TYPE

aStyle

)

Definition at line 269 of file sch_line.cpp.

{
 if( aStyle == GetDefaultStyle() )
 m_stroke.SetPlotStyle( PLOT_DASH_TYPE::DEFAULT );
 else
 m_stroke.SetPlotStyle( aStyle );
}

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

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_EAGLE_PLUGIN::loadFrame(), CADSTAR_SCH_ARCHIVE_LOADER::loadGraphicStaightSegment(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), and SetLineStyle().

SetLineStyle() [2/2]

void SCH_LINE::SetLineStyle

(

const int

aStyleId

)

Definition at line 263 of file sch_line.cpp.

{
 SetLineStyle( static_cast<PLOT_DASH_TYPE>( aStyleId ) );
}

References SetLineStyle().

SetLineWidth()

void SCH_LINE::SetLineWidth

(

const int

aSize

)

Definition at line 305 of file sch_line.cpp.

{
 m_stroke.SetWidth( aSize );
}

References m_stroke, and STROKE_PARAMS::SetWidth().

Referenced by KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadGraphicStaightSegment(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_ALTIUM_PLUGIN::ParseWire(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked )

inlinevirtualinherited

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

Definition at line 247 of file sch_item.h.

{}

SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 65 of file eda_item.cpp.

{
 SetFlags( IS_CHANGED );

 // If this a child object, then the parent modification state also needs to be set.
 if( m_parent )
 m_parent->SetModified();
}

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_SYMBOL::Move(), MoveEnd(), MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), LIB_SYMBOL::RemoveDrawItem(), SCH_SYMBOL::SetConvert(), SCH_SYMBOL::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_SYMBOL::SetTransform(), and SCH_SYMBOL::SetUnit().

SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM *  aParent )

inlinevirtualinherited

Reimplemented in PCB_DIMENSION_BASE.

Definition at line 115 of file eda_item.h.

{ m_parent = aParent; }

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), 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::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_PLUGIN::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), FOOTPRINT::operator=(), LIB_SYMBOL::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(), 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_SYMBOL::SetFields(), PCB_DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_SHEET::SwapData(), SCH_GLOBALLABEL::SwapData(), SCH_SYMBOL::SwapData(), and SwapItemData().

SetPosition()

void SCH_LINE::SetPosition ( const wxPoint &  aPosition )

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 915 of file sch_line.cpp.

{
 m_end = m_end - ( m_start - aPosition );
 m_start = aPosition;
}

References m_end, and m_start.

SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 128 of file eda_item.h.

{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), MergeOverlap(), DS_PROXY_UNDO_ITEM::Restore(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), and GERBVIEW_SELECTION_TOOL::selectVisually().

SetStartPoint()

void SCH_LINE::SetStartPoint ( const wxPoint &  aPosition )

inline

Definition at line 91 of file sch_line.h.

{ m_start = aPosition; }

References m_start.

Referenced by SCH_EDIT_FRAME::BreakSegment(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), SCH_EAGLE_PLUGIN::loadFrame(), CADSTAR_SCH_ARCHIVE_LOADER::loadGraphicStaightSegment(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), MergeOverlap(), and EE_POINT_EDITOR::updateParentItem().

SetState()

void EDA_ITEM::SetState ( EDA_ITEM_FLAGS  type, bool  state  )

inlineinherited

Definition at line 141 of file eda_item.h.

 {
 if( state )
 m_status |= type; // state = ON or OFF
 else
 m_status &= ~type;
 }

References EDA_ITEM::m_status.

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

SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS  aStatus )

inlineinherited

Definition at line 150 of file eda_item.h.

{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

SetStoredPos()

void SCH_ITEM::SetStoredPos ( const wxPoint &  aPos )

inlineinherited

Definition at line 223 of file sch_item.h.

{ m_storedPos = aPos; }

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::Main().

SetStroke()

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

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 137 of file sch_line.h.

{ m_stroke = aStroke; }

References m_stroke.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), and KIGFX::SCH_PAINTER::draw().

SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 127 of file eda_item.h.

{ SetFlags( IS_WIRE_IMAGE ); }

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

aLeft	The left hand item to compare.
aRight	The right hand item to compare.

Returns

True if aLeft is less than aRight.

Definition at line 420 of file eda_item.h.

{ 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

aItem

The item to swap the data structures with.

Reimplemented from SCH_ITEM.

Definition at line 871 of file sch_line.cpp.

{
 SCH_LINE* item = (SCH_LINE*) aItem;

 std::swap( m_layer, item->m_layer );

 std::swap( m_start, item->m_start );
 std::swap( m_end, item->m_end );
 std::swap( m_startIsDangling, item->m_startIsDangling );
 std::swap( m_endIsDangling, item->m_endIsDangling );
 std::swap( m_stroke, item->m_stroke );
}

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

{ return m_structType; }

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(), DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), 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(), SCH_MOVE_TOOL::AlignElements(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), SCH_SCREEN::Append(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), PNS::TOPOLOGY::AssembleTuningPath(), CONNECTION_GRAPH::buildConnectionGraph(), DIALOG_NET_INSPECTOR::buildNewItem(), SCH_SCREENS::buildScreenList(), calcIsInsideArea(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), PCB_POINT_EDITOR::canAddCorner(), SCH_NO_CONNECT::CanConnect(), SCH_JUNCTION::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), CanConnect(), SCH_LABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SYMBOL::CanConnect(), CN_VISITOR::checkZoneItemConnection(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), PCB_TEXT::ClassOf(), SCH_NO_CONNECT::ClassOf(), SCH_PIN::ClassOf(), PCB_MARKER::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), FP_SHAPE::ClassOf(), PCB_SHAPE::ClassOf(), PCB_TARGET::ClassOf(), ClassOf(), PCB_GROUP::ClassOf(), SCH_FIELD::ClassOf(), FP_TEXT::ClassOf(), SCH_SHEET::ClassOf(), NETINFO_ITEM::ClassOf(), ZONE::ClassOf(), SCH_SHEET_PIN::ClassOf(), SCH_BITMAP::ClassOf(), PCB_TRACK::ClassOf(), PAD::ClassOf(), SCH_SYMBOL::ClassOf(), FOOTPRINT::ClassOf(), SCH_SCREEN::ClassOf(), SCH_TEXT::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), BOARD::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), PCB_ARC::ClassOf(), SCH_LABEL::ClassOf(), PCB_VIA::ClassOf(), SCH_GLOBALLABEL::ClassOf(), PCB_DIM_ALIGNED::ClassOf(), PCB_DIM_ORTHOGONAL::ClassOf(), SCH_HIERLABEL::ClassOf(), PCB_DIM_LEADER::ClassOf(), PCB_DIM_CENTER::ClassOf(), TRACKS_CLEANER::cleanup(), CONNECTION_GRAPH::collectAllDriverValues(), LIB_TEXT::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_ITEM::compare(), LIB_SYMBOL::Compare(), EE_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createLayers(), CONVERT_TOOL::CreateLines(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), BOARD_ADAPTER::createTrack(), DRC_TOOL::CrossProbe(), SCH_SCREEN::DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), 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::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::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), NETLIST_EXPORTER_BASE::findNextSymbol(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), PCB_BASE_FRAME::FocusOnItems(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_PLUGIN::Format(), PCB_PLUGIN::format(), FormatProbeItem(), FP_TEXT::FP_TEXT(), PCB_POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), PCB_TRACK::GetBoundingBox(), SCH_FIELD::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(), SCH_FIELD::GetDrawRotation(), getDrilledHoleShape(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), getMinDist(), PCB_TRACK::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTIVITY_DATA::GetNetItems(), LIB_SYMBOL::GetNextDrawItem(), PCB_SHAPE::GetParentFootprint(), BOARD_ITEM::GetParentFootprint(), LIB_SYMBOL::GetPin(), SCH_SYMBOL::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_TRACK::GetSelectMenuText(), DRC_ENGINE::GetShape(), PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), CONVERT_TOOL::getStartEndPoints(), getTopLevelGroup(), PCB_EXPR_TYPE_REF::GetValue(), GROUP_TOOL::Group(), PCB_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(), insideBackCourtyard(), insideCourtyard(), insideFrontCourtyard(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), ARRAY_CREATOR::Invoke(), CONNECTIVITY_DATA::IsConnectedOnLayer(), 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(), PCB_TRACK::IsNull(), isNullAperture(), IsParallel(), isPlated(), SCH_FIELD::IsReplaceable(), PNS::ROUTER::isStartingPointRoutable(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), PCB_SELECTION_TOOL::itemPassesFilter(), CLIPBOARD_IO::Load(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), 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(), CONVERT_TOOL::makePolysFromSegs(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_FIELD::Matches(), memberOf(), MergeOverlap(), SCH_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(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_SHAPE::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_TEXT::operator<(), SCH_FIELD::operator<(), LIB_ITEM::operator<(), operator<(), SCH_SHEET::operator<(), SCH_ITEM::operator<(), SCH_SYMBOL::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_SYMBOL::operator=(), LIB_ITEM::operator==(), PAD::PAD(), EDIT_TOOL::PadFilter(), BOARD_EDITOR_CONTROL::PageSettings(), BOARD_COMMIT::parentObject(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), POSITION_RELATIVE_TOOL::PositionRelative(), SCH_FIELD::Print(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), CONNECTION_GRAPH::processSubGraphs(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), BOARD_REANNOTATE_TOOL::ReannotateDuplicates(), 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_SYMBOL::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), SCH_EDITOR_CONTROL::ReplaceAll(), PCB_SELECTION_TOOL::RequestSelection(), SCHEMATIC::ResolveCrossReference(), PCB_PARSER::resolveGroups(), DS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), 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(), 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(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_POINT_EDITOR::setAltConstraint(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_TEXT_AND_LABEL_PROPERTIES::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_SHEET_PIN::SwapData(), SCH_FIELD::SwapData(), PCB_GROUP::SwapData(), PCB_TEXT::SwapData(), PCB_TRACK::SwapData(), SCH_SHEET::SwapData(), PCB_ARC::SwapData(), PCB_DIM_ALIGNED::SwapData(), PCB_DIM_ORTHOGONAL::SwapData(), SCH_SYMBOL::SwapData(), PCB_VIA::SwapData(), PCB_DIM_LEADER::SwapData(), PCB_DIM_CENTER::SwapData(), PAD::SwapData(), FOOTPRINT::SwapData(), ZONE::SwapData(), SwapItemData(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), ERC_TESTER::TestMultUnitPinConflicts(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataToWindow(), PCB_TRACK::TransformShapeWithClearanceToPolygon(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), 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_FIELD_PROPERTIES::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::updatePastedSheet(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), PCB_GROUP::Visit(), PCB_TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_GLOBALLABEL::Visit(), SCH_SHEET::Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), 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 overridden method can optionally use it to update sheet-local connectivity information

Parameters

aItemList	is the list of items to test item against.
aSheet	is the 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 642 of file sch_line.cpp.

{
 if( IsConnectable() )
 {
 bool previousStartState = m_startIsDangling;
 bool previousEndState = m_endIsDangling;

 m_startIsDangling = m_endIsDangling = true;

 for( DANGLING_END_ITEM item : aItemList )
 {
 if( item.GetItem() == this )
 continue;

 if( ( IsWire() && item.GetType() != BUS_END && item.GetType() != BUS_ENTRY_END )
 || ( IsBus() && item.GetType() != WIRE_END && item.GetType() != PIN_END ) )
 {
 if( m_start == item.GetPosition() )
 m_startIsDangling = false;

 if( m_end == item.GetPosition() )
  m_endIsDangling = false;

 if( !m_startIsDangling && !m_endIsDangling )
 break;
 }
 }

 // We only use the bus dangling state for automatic line starting, so we don't care if it
 // has changed or not (and returning true will result in extra work)
 if( IsBus() )
 return false;

 return previousStartState != m_startIsDangling || previousEndState != m_endIsDangling;
 }

 return false;
}

References BUS_END, BUS_ENTRY_END, IsBus(), IsConnectable(), IsWire(), m_end, m_endIsDangling, m_start, m_startIsDangling, PIN_END, and WIRE_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 983 of file sch_line.cpp.

{
 return m_stroke.GetWidth() == 0 && m_stroke.GetColor() == COLOR4D::UNSPECIFIED
 && ( m_stroke.GetPlotStyle() == GetDefaultStyle()
 || m_stroke.GetPlotStyle() == PLOT_DASH_TYPE::DEFAULT );
}

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, PCB_DIM_CENTER, EDIT_POINTS, PCB_DIMENSION_BASE, GERBER_DRAW_ITEM, FP_TEXT, PCB_TRACK, PCB_SHAPE, DS_PROXY_VIEW_ITEM, PCB_MARKER, ROUTER_PREVIEW_ITEM, MY_DRAWING, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::RULER_ITEM, RATSNEST_VIEW_ITEM, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 257 of file eda_item.cpp.

{
 // Basic fallback
 EDA_RECT bbox = GetBoundingBox();

 return BOX2I( bbox.GetOrigin(), bbox.GetSize() );
}

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

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), PCB_SHAPE::ViewBBox(), and PCB_DIMENSION_BASE::ViewBBox().

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

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

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

Definition at line 106 of file view_item.h.

 {}

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

{
 aCount = 3;
 aLayers[0] = LAYER_DANGLING;
 aLayers[1] = m_layer;
 aLayers[2] = LAYER_SELECTION_SHADOWS;
}

References LAYER_DANGLING, 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

aLayer	is the current drawing layer.
aView	is 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, PCB_VIA, GERBER_DRAW_ITEM, FP_TEXT, PCB_TRACK, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 132 of file view_item.h.

 {
 // By default always show the item
 return 0.0;
 }

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

viewPrivData()

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::viewPrivData ( ) const

inlineinherited

Definition at line 138 of file view_item.h.

 {
 return m_viewPrivData;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::DRAW_ITEM_VISITOR::deferredDraw(), KIGFX::VIEW::draw(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsVisible(), KIGFX::VIEW::OnDestroy(), KIGFX::QUERY_VISITOR< CONTAINER >::operator()(), KIGFX::VIEW::UPDATE_COLOR_VISITOR::operator()(), KIGFX::VIEW::UPDATE_DEPTH_VISITOR::operator()(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), KIGFX::VIEW::RECACHE_ITEM_VISITOR::operator()(), KIGFX::VIEW::CLEAR_LAYER_CACHE_VISITOR::operator()(), KIGFX::VIEW::Remove(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

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

inspector	An INSPECTOR instance to use in the inspection.
testData	Arbitrary data used by the inspector.
scanTypes	Which# 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_SYMBOL, FOOTPRINT, LIB_SYMBOL, SCH_SHEET, SCH_GLOBALLABEL, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, PCB_TRACK, PCB_GROUP, and GBR_LAYOUT.

Definition at line 93 of file eda_item.cpp.

{
#if 0 && defined(DEBUG)
 std::cout << GetClass().mb_str() << ' ';
#endif

 if( IsType( scanTypes ) )
 {
 if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
 return SEARCH_RESULT::QUIT;
 }

 return SEARCH_RESULT::CONTINUE;
}

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

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

Definition at line 494 of file sch_item.h.

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

m_connection_map

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

protectedinherited

Store connectivity information, per sheet.

Definition at line 497 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 488 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

Definition at line 499 of file sch_item.h.

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

m_end

wxPoint SCH_LINE::m_end

private

Line end point.

Definition at line 282 of file sch_line.h.

Referenced by GetAngleFrom(), GetBoundingBox(), GetConnectionPoints(), GetEndPoint(), GetEndPoints(), GetLength(), GetReverseAngleFrom(), GetSelectedPoints(), GetSelectMenuText(), HitTest(), IsEndPoint(), IsNull(), IsParallel(), MergeOverlap(), MirrorHorizontally(), MirrorVertically(), Move(), MoveEnd(), Plot(), Print(), Rotate(), RotateEnd(), SCH_LINE(), SetEndPoint(), SetPosition(), SwapData(), and UpdateDanglingState().

m_endIsDangling

bool SCH_LINE::m_endIsDangling

private

True if end point is not connected.

Definition at line 280 of file sch_line.h.

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

m_fieldsAutoplaced

FIELDS_AUTOPLACED SCH_ITEM::m_fieldsAutoplaced

protectedinherited

Definition at line 489 of file sch_item.h.

Referenced by SCH_SHEET::AutoplaceFields(), SCH_GLOBALLABEL::AutoplaceFields(), SCH_SYMBOL::AutoplaceFields(), SCH_ITEM::ClearFieldsAutoplaced(), SCH_ITEM::GetFieldsAutoplaced(), SCH_ITEM::operator=(), SCH_SHEET::Resize(), SCH_SHEET::Rotate(), SCH_ITEM::SCH_ITEM(), SCH_SHEET::SCH_SHEET(), SCH_SYMBOL::SCH_SYMBOL(), SCH_ITEM::SetFieldsAutoplaced(), SCH_SHEET::SwapData(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 480 of file eda_item.h.

Referenced by EDA_ITEM::ClearFlags(), LIB_TEXT::Clone(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), GetSelectedPoints(), EDA_ITEM::HasFlag(), LIB_SHAPE::HitTest(), LIB_TEXT::HitTest(), SCH_JUNCTION::HitTest(), LIB_PIN::HitTest(), LIB_ITEM::HitTest(), HitTest(), SCH_SYMBOL::HitTest(), ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsBrightened(), SCH_ITEM::IsConnected(), EDA_ITEM::IsDragging(), EDA_ITEM::IsEntered(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsResized(), EDA_ITEM::IsSelected(), EDA_ITEM::IsWireImage(), MirrorHorizontally(), MirrorVertically(), EDA_ITEM::operator=(), Rotate(), EDA_ITEM::SetFlags(), and PCB_SHAPE::SwapData().

m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 479 of file eda_item.h.

Referenced by ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsForceVisible(), EDA_ITEM::operator=(), EDA_ITEM::SetForceVisible(), and PCB_SHAPE::SwapData().

m_lastResolvedColor

COLOR4D SCH_LINE::m_lastResolvedColor

mutableprivate

Definition at line 290 of file sch_line.h.

Referenced by GetLineColor(), SCH_LINE(), and SetLastResolvedState().

m_lastResolvedLineStyle

PLOT_DASH_TYPE SCH_LINE::m_lastResolvedLineStyle

mutableprivate

Definition at line 288 of file sch_line.h.

Referenced by GetEffectiveLineStyle(), SCH_LINE(), and SetLastResolvedState().

m_lastResolvedWidth

int SCH_LINE::m_lastResolvedWidth

mutableprivate

Definition at line 289 of file sch_line.h.

Referenced by GetPenWidth(), SCH_LINE(), and SetLastResolvedState().

m_layer

SCH_LAYER_ID SCH_ITEM::m_layer

protectedinherited

Definition at line 487 of file sch_item.h.

Referenced by CanConnect(), SCH_ITEM::CanConnect(), doIsConnected(), SCH_ITEM::GetLayer(), GetMenuImage(), GetPenWidth(), GetSelectMenuText(), IsConnectable(), IsType(), SCH_ITEM::operator=(), SCH_BUS_ENTRY_BASE::Plot(), SCH_TEXT::Plot(), SCH_BUS_ENTRY_BASE::Print(), SCH_FIELD::Print(), SCH_TEXT::Print(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_BITMAP::SCH_BITMAP(), SCH_BUS_BUS_ENTRY::SCH_BUS_BUS_ENTRY(), SCH_BUS_WIRE_ENTRY::SCH_BUS_WIRE_ENTRY(), SCH_HIERLABEL::SCH_HIERLABEL(), SCH_ITEM::SCH_ITEM(), SCH_JUNCTION::SCH_JUNCTION(), SCH_LABEL::SCH_LABEL(), SCH_LINE(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), SCH_ITEM::SetLayer(), SCH_FIELD::SwapData(), SCH_TEXT::SwapData(), SwapData(), SCH_JUNCTION::ViewGetLayers(), ViewGetLayers(), and SCH_TEXT::ViewGetLayers().

m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 478 of file eda_item.h.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::DoHypertextMenu(), FP_TEXT::FP_TEXT(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), SCH_TEXT::GetContextualTextVars(), SCH_FIELD::GetDrawRotation(), FP_TEXT::GetDrawRotation(), SCH_FIELD::GetMenuImage(), FP_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), SCH_FIELD::GetName(), PAD::GetParent(), EDA_ITEM::GetParent(), BOARD_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), LIB_ITEM::GetParent(), FP_TEXT::GetParentAsString(), PAD::GetParentAsString(), FP_SHAPE::GetParentAsString(), PCB_SHAPE::GetParentFootprint(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), LIB_FIELD::HitTest(), SCH_FIELD::IsHypertext(), SCH_FIELD::IsReplaceable(), SCH_FIELD::Matches(), LIB_FIELD::operator=(), EDA_ITEM::operator=(), PAD::PAD(), SCH_FIELD::Plot(), SCH_FIELD::Print(), SCH_FIELD::Replace(), SCH_SYMBOL::SCH_SYMBOL(), FP_SHAPE::SetDrawCoord(), FP_TEXT::SetDrawCoord(), PAD::SetDrawCoord(), SCH_FIELD::SetId(), FP_SHAPE::SetLocalCoord(), FP_TEXT::SetLocalCoord(), PAD::SetLocalCoord(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), SCH_FIELD::SetPosition(), PCB_SHAPE::SwapData(), and FP_TEXT::TransformShapeWithClearanceToPolygon().

m_start

wxPoint SCH_LINE::m_start

private

Line start point.

Definition at line 281 of file sch_line.h.

Referenced by GetAngleFrom(), GetBoundingBox(), GetConnectionPoints(), GetEndPoints(), GetLength(), GetPosition(), GetReverseAngleFrom(), GetSelectedPoints(), GetSelectMenuText(), GetStartPoint(), HitTest(), IsEndPoint(), IsNull(), IsParallel(), MergeOverlap(), MirrorHorizontally(), MirrorVertically(), Move(), MoveStart(), Plot(), Print(), Rotate(), RotateStart(), SCH_LINE(), SetPosition(), SetStartPoint(), SwapData(), and UpdateDanglingState().

m_startIsDangling

bool SCH_LINE::m_startIsDangling

private

True if start point is not connected.

Definition at line 279 of file sch_line.h.

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

m_status

EDA_ITEM_FLAGS EDA_ITEM::m_status

protectedinherited

Definition at line 477 of file eda_item.h.

Referenced by EDA_ITEM::GetState(), EDA_ITEM::GetStatus(), EDA_ITEM::operator=(), EDA_ITEM::SetState(), EDA_ITEM::SetStatus(), and PCB_SHAPE::SwapData().

m_storedPos

wxPoint SCH_ITEM::m_storedPos

protectedinherited

Definition at line 490 of file sch_item.h.

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

m_stroke

STROKE_PARAMS SCH_LINE::m_stroke

private

Line stroke properties.

Definition at line 283 of file sch_line.h.

Referenced by GetBoundingBox(), GetEffectiveLineStyle(), GetLineColor(), GetLineSize(), GetLineStyle(), GetPenWidth(), GetStroke(), IsStrokeEquivalent(), SCH_LINE(), SetLineColor(), SetLineStyle(), SetLineWidth(), SetStroke(), SwapData(), and UsesDefaultStroke().

m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 474 of file eda_item.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_SYMBOL::AddHierarchicalReference(), RC_ITEM::AddItem(), SCH_EDIT_FRAME::AnnotateSymbols(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), BOOST_FIXTURE_TEST_CASE(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), MICROWAVE_TOOL::createMicrowaveInductor(), DRAWING_TOOL::DrawVia(), LIB_SYMBOL::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), FOOTPRINT::Duplicate(), FOOTPRINT::DuplicateItem(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportNetlist(), BOARD::FillItemMap(), SCH_SHEET_LIST::FillItemMap(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_EDIT_FRAME::FocusOnItem(), SCH_SEXPR_PLUGIN::Format(), PCB_PLUGIN::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), BOARD::GetItem(), SCH_SHEET_LIST::GetItem(), PAD::GetMsgPanelInfo(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), FP_TEXT::GetParentAsString(), PAD::GetParentAsString(), FP_SHAPE::GetParentAsString(), SCH_REFERENCE::GetPath(), SCH_SCREEN::GetSheets(), SCH_MARKER::GetUUID(), PCB_MARKER::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), SCH_SHEET_PATH::IsContainedWithin(), LEGACY_PLUGIN::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PCB_EDIT_FRAME::LoadFootprints(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_LEGACY_PLUGIN::loadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), LEGACY_PLUGIN::loadTrackList(), PNS::LOGGER::Log(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_EDITOR_CONTROL::nextMatch(), PCB_SHAPE::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), SCH_ITEM::operator<(), SCH_SYMBOL::operator<(), PAD::PAD(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), BOARD_REANNOTATE_TOOL::ReannotateDuplicates(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SYMBOL::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBusEntry(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN::saveJunction(), 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_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), SCH_SYMBOL::SCH_SYMBOL(), RC_ITEM::SetItems(), SwapItemData(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), testGroupEqual(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::updatePastedSheet(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

PenStyle

enum wxPenStyle SCH_LINE::PenStyle[]

static

Definition at line 40 of file sch_line.h.

---

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

• sch_line.h
• sch_line.cpp