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 VECTOR2I &pos=VECTOR2I(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...

wxString	GetNetname (const SCH_SHEET_PATH &aSheet)
	This function travel though all the connected wire segments to look for connected labels. More...

bool	IsType (const std::vector< KICAD_T > &aScanTypes) const override
	Check whether the item is one of the listed types. More...

bool	IsEndPoint (const VECTOR2I &aPoint) const

int	GetAngleFrom (const VECTOR2I &aPoint) const

int	GetReverseAngleFrom (const VECTOR2I &aPoint) const

EDA_ANGLE	Angle () const
	Gets the angle between the start and end lines. More...

void	StoreAngle ()
	Saves the current line angle. More...

void	StoreAngle (const EDA_ANGLE &aAngle)

EDA_ANGLE	GetStoredAngle () const
	Returns the angle stored by StoreAngle() More...

bool	IsOrthogonal () const
	Checks if line is orthogonal (to the grid). More...

bool	IsNull () const

VECTOR2I	GetStartPoint () const

void	SetStartPoint (const VECTOR2I &aPosition)

VECTOR2I	GetMidPoint () const

VECTOR2I	GetEndPoint () const

void	SetEndPoint (const VECTOR2I &aPosition)

void	SetLastResolvedState (const SCH_ITEM *aItem) override

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)

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 BOX2I	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 VECTOR2I &aOffset) override
	Print a schematic item. More...

int	GetPenWidth () const override

void	Move (const VECTOR2I &aMoveVector) override
	Move the item by aMoveVector to a new position. More...

void	MoveStart (const VECTOR2I &aMoveVector)

void	MoveEnd (const VECTOR2I &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 VECTOR2I &aCenter) override
	Rotate the item around aCenter 90 degrees in the clockwise direction. More...

void	RotateStart (const VECTOR2I &aCenter)

void	RotateEnd (const VECTOR2I &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< VECTOR2I >	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< VECTOR2I > &aPoints) const

bool	CanConnect (const SCH_ITEM *aItem) const override

wxString	GetSelectMenuText (UNITS_PROVIDER *aUnitsProvider) 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

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &aPosition) override

VECTOR2I	GetSortPosition () const override
	Return the coordinates that should be used for sorting this element visually compared to other elements. More...

bool	IsPointClickableAnchor (const VECTOR2I &aPos) const override

bool	HitTest (const VECTOR2I &aPosition, int aAccuracy=0) const override
	Test if aPosition is inside or on the boundary of this item. More...

bool	HitTest (const BOX2I &aRect, bool aContained, int aAccuracy=0) const override
	Test if aRect intersects this item. More...

void	Plot (PLOTTER *aPlotter, bool aBackground) 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

VECTOR2I &	GetStoredPos ()

void	SetStoredPos (const VECTOR2I &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	DoHypertextAction (EDA_DRAW_FRAME *aFrame) const

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

const wxString &	GetDefaultFont () const

bool	RenderAsBitmap (double aWorldScale) const override

virtual void	PrintBackground (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset)
	Print the (optional) backaground elements if they exist. More...

void	ClearConnections ()
	Clears all of the connection items from the list. More...

bool	IsConnected (const VECTOR2I &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)

std::shared_ptr< NETCLASS >	GetEffectiveNetClass (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)

virtual void	ClearCaches ()

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

bool	IsRollover () 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	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

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 wxString	GetFriendlyName () const

virtual const VECTOR2I	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...

virtual INSPECT_RESULT	Visit (INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes)
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...

wxString	GetTypeDesc () const
	Return a translated description of the type for this EDA_ITEM for display in user facing messages. More...

virtual bool	Matches (const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData. More...

virtual bool	Replace (const EDA_SEARCH_DATA &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) const

template<typename T >
T	Get (PROPERTY_BASE *aProperty) const

template<typename T >
std::optional< T >	Get (const wxString &aProperty) const

Static Public Member Functions
static bool	ClassOf (const EDA_ITEM *aItem)

template<class T >
static INSPECT_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
	This changes first parameter to avoid the DList and use the main queue instead. More...

template<class T >
static INSPECT_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
	Change first parameter to avoid the DList and use std::vector instead. More...

static bool	Replace (const EDA_SEARCH_DATA &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 EDA_SEARCH_DATA &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

VECTOR2I	m_storedPos

std::map< SCH_SHEET_PATH, SCH_ITEM_SET, SHEET_PATH_CMP >	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
wxString	FindWireSegmentNetNameRecursive (SCH_LINE line, std::list< const SCH_LINE > &checkedLines, const SCH_SHEET_PATH &aSheet) const
	Recursively called function to travel through the connected wires and find a connected net name label. More...

bool	doIsConnected (const VECTOR2I &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...

VECTOR2I	m_start
	Line start point. More...

VECTOR2I	m_end
	Line end point. More...

EDA_ANGLE	m_storedAngle
	Stored angle. More...

STROKE_PARAMS	m_stroke
	Line stroke properties. More...

PLOT_DASH_TYPE	m_lastResolvedLineStyle

int	m_lastResolvedWidth

COLOR4D	m_lastResolvedColor

KICAD_T	m_structType
	Run time identification, keep private so it can never be changed after a ctor sets it. More...

VIEW_ITEM_DATA *	m_viewPrivData

Detailed Description

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

Definition at line 39 of file sch_line.h.

Constructor & Destructor Documentation

◆ SCH_LINE() [1/3]

SCH_LINE::SCH_LINE	(	const VECTOR2I &	pos = `VECTOR2I( 0, 0 )`,
		int	layer = `LAYER_NOTES`
	)

Definition at line 43 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 = schIUScale.MilsToIU( DEFAULT_WIRE_WIDTH_MILS );
 else if( layer == LAYER_BUS )
 m_lastResolvedWidth = schIUScale.MilsToIU( DEFAULT_BUS_WIDTH_MILS );
  else
 m_lastResolvedWidth = schIUScale.MilsToIU( DEFAULT_LINE_WIDTH_MILS );
 
 m_lastResolvedLineStyle = PLOT_DASH_TYPE::SOLID;
 m_lastResolvedColor = COLOR4D::UNSPECIFIED;
}

References DEFAULT, DEFAULT_BUS_WIDTH_MILS, DEFAULT_LINE_WIDTH_MILS, DEFAULT_WIRE_WIDTH_MILS, 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, EDA_IU_SCALE::MilsToIU(), schIUScale, STROKE_PARAMS::SetColor(), STROKE_PARAMS::SetPlotStyle(), STROKE_PARAMS::SetWidth(), and SOLID.

Referenced by Clone(), and MergeOverlap().

◆ SCH_LINE() [2/3]

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

inline

Definition at line 46 of file sch_line.h.

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

◆ SCH_LINE() [3/3]

SCH_LINE::SCH_LINE ( const SCH_LINE & aLine )

Definition at line 76 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 52 of file sch_line.h.

52{ }

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 193 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_LABEL_BASE::UpdateDanglingState(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ Angle()

EDA_ANGLE SCH_LINE::Angle ( ) const

inline

Gets the angle between the start and end lines.

Returns: Line angle in radians.

Definition at line 105 of file sch_line.h.

 {
 return ( EDA_ANGLE( (VECTOR2I) m_end - (VECTOR2I) m_start ) );
 }

References m_end, and m_start.

Referenced by SCH_MOVE_TOOL::getConnectedDragItems(), IsOrthogonal(), SCH_MOVE_TOOL::orthoLineDrag(), and StoreAngle().

◆ 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 DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), SCH_SHEET::SCH_SHEET(), SCH_EDIT_FRAME::SelectUnit(), and DIALOG_LABEL_PROPERTIES::TransferDataFromWindow().

◆ AutoplaceFields()

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

inlinevirtualinherited

Reimplemented in SCH_LABEL_BASE, SCH_DIRECTIVE_LABEL, SCH_SHEET, and SCH_SYMBOL.

Definition at line 442 of file sch_item.h.

442{ }

Referenced by SCH_ITEM::AutoAutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), 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 621 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_DIRECTIVE_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_DIRECTIVE_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_DIRECTIVE_LABEL_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 54 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 122 of file eda_item.h.

122{ ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:143

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:66

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearCaches()

void SCH_ITEM::ClearCaches ( )

virtualinherited

Reimplemented in SCH_FIELD.

Definition at line 251 of file sch_item.cpp.

{
 auto clearTextCaches =
 []( SCH_ITEM* aItem )
 {
 EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( aItem );
 
 if( text )
 {
 text->ClearBoundingBoxCache();
 text->ClearRenderCache();
 }
 };
 
 clearTextCaches( this );
 
 RunOnChildren( clearTextCaches );
}

References SCH_ITEM::RunOnChildren(), and text.

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

372{ m_connections.clear(); }

SCH_ITEM::m_connections

EDA_ITEMS m_connections

Definition: sch_item.h:492

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 160 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

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

Referenced by BOARD::Add(), FOOTPRINT::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_DRAWING_TOOLS::DrawShape(), 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.

427{ m_fieldsAutoplaced = FIELDS_AUTOPLACED_NO; }

SCH_ITEM::m_fieldsAutoplaced

FIELDS_AUTOPLACED m_fieldsAutoplaced

Definition: sch_item.h:493

FIELDS_AUTOPLACED_NO

@ FIELDS_AUTOPLACED_NO

Definition: sch_item.h:56

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_LABEL_BASE::SCH_LABEL_BASE(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), 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 143 of file eda_item.h.

143{ m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:500

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), 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(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Init(), EE_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetIsShownAsBitmap(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 121 of file eda_item.h.

121{ ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Item was manually selected by the user.

Definition: eda_item_flags.h:48

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< T >::saveCopyInUndoList(), SCH_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 155 of file eda_item.h.

 {
 ClearFlags( CANDIDATE | SELECTED_BY_DRAG | IS_LINKED | SKIP_STRUCT | DO_NOT_DRAW );
 }

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), and 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 128 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 187 of file sch_item.cpp.

{
 return m_connected_items[ aSheet ];
}

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), FindWireSegmentNetNameRecursive(), 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 146 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_ITEM::GetEffectiveNetClass(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), SCH_ITEM::GetOrInitConnection(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_LABEL_BASE::Plot(), Plot(), SCH_TEXT::Plot(), SCH_LABEL_BASE::Print(), NETLIST_EXPORTER_SPICE_MODEL::readPorts(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_LABEL_BASE::ResolveTextVar(), 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 670 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().

◆ DoHypertextAction()

virtual void SCH_ITEM::DoHypertextAction ( EDA_DRAW_FRAME * aFrame ) const

inlinevirtualinherited

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 241 of file sch_item.h.

241{ }

◆ doIsConnected()

bool SCH_LINE::doIsConnected ( const VECTOR2I & 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 VECTOR2I object containing the test position.

Returns: True if connection to aPosition exists.

Reimplemented from SCH_ITEM.

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

◆ FindWireSegmentNetNameRecursive()

wxString SCH_LINE::FindWireSegmentNetNameRecursive	(	SCH_LINE *	line,
		std::list< const SCH_LINE * > &	checkedLines,
		const SCH_SHEET_PATH &	aSheet
	)		const

private

Recursively called function to travel through the connected wires and find a connected net name label.

Parameters

line	- the wire segment to start the recursive lookup
checkedLines	- a lsit containing the already checked wire segments, to prevent the infinite recursion in the case if someone draws a rectangle for e.g.
aSheet	- the sheet where the lookup is performed

Returns: With the net name if a connected label found, otherwise with an empty string

Definition at line 97 of file sch_line.cpp.

{
 for ( auto connected : line->ConnectedItems( aSheet ) )
 {
 if( connected->Type() == SCH_LINE_T )
 {
 if( std::find(checkedLines.begin(), checkedLines.end(), connected ) == checkedLines.end() )
 {
 SCH_LINE* connectedLine = static_cast<SCH_LINE*>( connected );
 checkedLines.push_back( connectedLine );
 
 wxString netName = FindWireSegmentNetNameRecursive( connectedLine, checkedLines,
 aSheet );
 
 if( !netName.IsEmpty() )
 return netName;
 }
 }
 else if( connected->Type() == SCH_LABEL_T
 || connected->Type() == SCH_GLOBAL_LABEL_T
 || connected->Type() == SCH_DIRECTIVE_LABEL_T)
 {
 return static_cast<SCH_TEXT*>( connected )->GetText();
 }
 
 }
 return "";
}

References SCH_ITEM::ConnectedItems(), FindWireSegmentNetNameRecursive(), EDA_UNIT_UTILS::GetText(), SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_LABEL_T, and SCH_LINE_T.

Referenced by FindWireSegmentNetNameRecursive(), and GetNetname().

◆ Get() [1/3]

template<typename T >

std::optional< T > INSPECTABLE::Get ( const wxString & aProperty ) const

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 );
 std::optional<T> ret;
 
 if( prop )
 {
 const 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().

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), 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(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( !object )
 throw std::runtime_error( "Could not cast INSPECTABLE to the requested type" );
 
 return aProperty->get<T>( object );
 }

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

◆ GetAngleFrom()

int SCH_LINE::GetAngleFrom ( const VECTOR2I & aPoint ) const

Definition at line 401 of file sch_line.cpp.

{
 VECTOR2I vec;
 
 if( aPoint == m_start )
 vec = m_end - aPoint;
 else
 vec = m_start - aPoint;
 
 return KiROUND( EDA_ANGLE( vec ).AsDegrees() );
}

References KiROUND(), m_end, and m_start.

Referenced by SCH_SCREEN::doIsJunction().

◆ GetBoundingBox()

const BOX2I 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 191 of file sch_line.cpp.

{
 int width = GetPenWidth() / 2;
 
 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 + 1;
 int ymax = std::max( m_start.y, m_end.y ) + width + 1;
 
 BOX2I ret( VECTOR2I( xmin, ymin ), VECTOR2I( xmax - xmin, ymax - ymin ) );
 
 return ret;
}

References GetPenWidth(), m_end, m_start, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_MOVE_TOOL::getConnectedDragItems(), SCH_EAGLE_PLUGIN::moveLabels(), and Plot().

◆ GetClass()

wxString SCH_LINE::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 59 of file sch_line.h.

 {
 return wxT( "SCH_LINE" );
 }

◆ GetConnectionPoints()

std::vector< VECTOR2I > 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 664 of file sch_line.cpp.

{
 return { m_start, m_end };
}

References m_end, and m_start.

Referenced by SCH_MOVE_TOOL::Main().

◆ GetDefaultFont()

const wxString & SCH_ITEM::GetDefaultFont ( ) const

inherited

Definition at line 286 of file sch_item.cpp.

{
 EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
 
 return cfg->m_Appearance.default_font;
}

References EESCHEMA_SETTINGS::APPEARANCE::default_font, EESCHEMA_SETTINGS::m_Appearance, and Pgm().

Referenced by SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), SCH_FIELD::GetRenderCache(), and SCH_TEXTBOX::GetShownText().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 147 of file eda_item.h.

 {
 constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
 | IS_CHANGED | IS_WIRE_IMAGE | STRUCT_DELETED );
 
 return m_flags & mask;
 }

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

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

{
 if( m_stroke.GetPlotStyle() != PLOT_DASH_TYPE::DEFAULT )
 m_lastResolvedLineStyle = m_stroke.GetPlotStyle();
 else if( !IsConnectable() )
 m_lastResolvedLineStyle = PLOT_DASH_TYPE::SOLID;
 else if( !IsConnectivityDirty() )
 m_lastResolvedLineStyle = (PLOT_DASH_TYPE) GetEffectiveNetClass()->GetLineStyle();
 
 return m_lastResolvedLineStyle;
}

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

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

◆ GetEffectiveNetClass()

std::shared_ptr< NETCLASS > SCH_ITEM::GetEffectiveNetClass ( const SCH_SHEET_PATH * aSheet = nullptr ) const

inherited

Definition at line 166 of file sch_item.cpp.

{
 static std::shared_ptr<NETCLASS> nullNetclass = std::make_shared<NETCLASS>( wxEmptyString );
 
 SCHEMATIC* schematic = Schematic();
 
 if( schematic )
 {
 std::shared_ptr<NET_SETTINGS>& netSettings = schematic->Prj().GetProjectFile().m_NetSettings;
 SCH_CONNECTION* connection = Connection( aSheet );
 
 if( connection )
 return netSettings->GetEffectiveNetClass( connection->Name() );
 else
 return netSettings->m_DefaultNetClass;
 }
 
 return nullNetclass;
}

References SCH_ITEM::Connection(), PROJECT::GetProjectFile(), PROJECT_FILE::m_NetSettings, SCH_CONNECTION::Name(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

Referenced by SCH_BUS_ENTRY_BASE::GetBusEntryColor(), GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_FIELD::GetFieldColor(), SCH_JUNCTION::GetJunctionColor(), SCH_LABEL_BASE::GetLabelColor(), GetLineColor(), SCH_BUS_ENTRY_BASE::GetLineStyle(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), GetPenWidth(), SCH_LABEL_BASE::Plot(), Plot(), and SCH_LABEL_BASE::ResolveTextVar().

◆ GetEndPoint()

VECTOR2I SCH_LINE::GetEndPoint ( ) const

inline

Definition at line 143 of file sch_line.h.

143{ 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_EDIT_FRAME::DeleteJunction(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_SCREEN::doIsJunction(), KIGFX::SCH_PAINTER::draw(), AUTOPLACER::fitFieldsBetweenWires(), AUTOPLACER::getCollidingSides(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), 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(), operator<(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_EDIT_TOOL::Rotate(), SCH_LEGACY_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveLine(), EE_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), ERC_TESTER::TestOffGridEndpoints(), 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 561 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.

424{ 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 144 of file eda_item.h.

144{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), collidesWithArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), LIB_SYMBOL::LIB_SYMBOL(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD_TOOL::RecombinePad(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), 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 VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 258 of file eda_item.h.

258{ return GetPosition(); }

EDA_ITEM::GetPosition

virtual VECTOR2I GetPosition() const

Definition: eda_item.h:251

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, and ZONE.

Definition at line 310 of file eda_item.cpp.

{
 return GetTypeDesc();
}

References EDA_ITEM::GetTypeDesc().

Referenced by PROPERTIES_PANEL::update().

◆ GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 246 of file sch_item.h.

246{ return m_layer; }

References SCH_ITEM::m_layer.

Referenced by SCH_ITEM::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL_BASE::CanConnect(), CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_SHEET::CanConnect(), SCH_SYMBOL::CanConnect(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), DIALOG_IMAGE_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), 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<(), operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_JUNCTION::Plot(), Plot(), SCH_JUNCTION::Print(), Print(), SCH_LEGACY_PLUGIN::saveBusEntry(), SCH_LEGACY_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveText(), 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.

Referenced by SCH_MOVE_TOOL::orthoLineDrag().

◆ GetLineColor()

COLOR4D SCH_LINE::GetLineColor ( ) const

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

Definition at line 237 of file sch_line.cpp.

{
 if( m_stroke.GetColor() != COLOR4D::UNSPECIFIED )
 m_lastResolvedColor = m_stroke.GetColor();
 else if( !IsConnectable() )
 m_lastResolvedColor = COLOR4D::UNSPECIFIED;
 else if( !IsConnectivityDirty() )
 m_lastResolvedColor = GetEffectiveNetClass()->GetSchematicColor();
 
 return m_lastResolvedColor;
}

References STROKE_PARAMS::GetColor(), SCH_ITEM::GetEffectiveNetClass(), IsConnectable(), SCH_ITEM::IsConnectivityDirty(), m_lastResolvedColor, and m_stroke.

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

◆ GetLineSize()

int SCH_LINE::GetLineSize ( ) const

inline

Definition at line 195 of file sch_line.h.

195{ return m_stroke.GetWidth(); }

STROKE_PARAMS::GetWidth

int GetWidth() const

Definition: stroke_params.h:98

References STROKE_PARAMS::GetWidth(), and m_stroke.

Referenced by SCH_LEGACY_PLUGIN::saveLine().

◆ GetLineStyle()

PLOT_DASH_TYPE SCH_LINE::GetLineStyle ( ) const

Definition at line 263 of file sch_line.cpp.

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

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

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

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

◆ GetMidPoint()

VECTOR2I SCH_LINE::GetMidPoint ( ) const

inline

Definition at line 141 of file sch_line.h.

141{ return ( m_start + m_end ) / 2; }

References m_end, and m_start.

Referenced by GetSortPosition().

◆ 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 881 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 );
 
 PLOT_DASH_TYPE lineStyle = GetLineStyle();
 
 if( GetEffectiveLineStyle() != lineStyle )
 aList.emplace_back( _( "Line Style" ), _( "from netclass" ) );
 else
 m_stroke.GetMsgPanelInfo( aFrame, aList, true, false );
 
 SCH_CONNECTION* conn = nullptr;
 
 if( !IsConnectivityDirty() && dynamic_cast<SCH_EDIT_FRAME*>( aFrame ) )
 conn = Connection();
 
 if( conn )
 {
 conn->AppendInfoToMsgPanel( aList );
 
 if( !conn->IsBus() )
 {
 aList.emplace_back( _( "Resolved Netclass" ),
 UnescapeString( GetEffectiveNetClass()->GetName() ) );
 }
 }
}

References _, SCH_CONNECTION::AppendInfoToMsgPanel(), SCH_ITEM::Connection(), GetEffectiveLineStyle(), SCH_ITEM::GetEffectiveNetClass(), SCH_ITEM::GetLayer(), GetLineStyle(), STROKE_PARAMS::GetMsgPanelInfo(), SCH_CONNECTION::IsBus(), SCH_ITEM::IsConnectivityDirty(), LAYER_BUS, LAYER_WIRE, m_stroke, and UnescapeString().

◆ GetNetname()

wxString SCH_LINE::GetNetname ( const SCH_SHEET_PATH & aSheet )

This function travel though all the connected wire segments to look for connected labels.

Parameters

aSheet - the sheet where the current wire segment is located

Returns: returns the name of the wire if connected labels found, otherwise empty string

Definition at line 90 of file sch_line.cpp.

{
 std::list<const SCH_LINE *> checkedLines;
 checkedLines.push_back(this);
 return FindWireSegmentNetNameRecursive( this, checkedLines, aSheet );
}

References FindWireSegmentNetNameRecursive().

Referenced by SCH_DRAWING_TOOLS::TwoClickPlace().

◆ GetOrInitConnection()

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

inherited

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

99{ return m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:498

References EDA_ITEM::m_parent.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::editFieldText(), SCH_FIELD::GetFieldColor(), getInferredSymbols(), SCH_PIN::GetParentSymbol(), EE_SELECTION_TOOL::highlight(), highlightNet(), SCH_FIELD::HitTest(), SCH_PIN::IsStacked(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), 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(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_EDITOR_CONTROL::ReplaceAll(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_ITEM::Schematic(), SCH_SCREEN::Schematic(), SCH_SHEET::SearchHierarchy(), PCB_SELECTION_TOOL::select(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), EE_SELECTION_TOOL::unhighlight(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), EE_TOOL_BASE< T >::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 292 of file sch_line.cpp.

{
 SCHEMATIC* schematic = Schematic();
 
 switch ( m_layer )
 {
 default:
 if( m_stroke.GetWidth() > 0 )
 return m_stroke.GetWidth();
 
 if( schematic )
 return schematic->Settings().m_DefaultLineWidth;
 
 return schIUScale.MilsToIU( DEFAULT_LINE_WIDTH_MILS );
 
 case LAYER_WIRE:
 if( m_stroke.GetWidth() > 0 )
 m_lastResolvedWidth = m_stroke.GetWidth();
 else if( !IsConnectivityDirty() )
 m_lastResolvedWidth = GetEffectiveNetClass()->GetWireWidth();
 
 return m_lastResolvedWidth;
 
 case LAYER_BUS:
 if( m_stroke.GetWidth() > 0 )
 m_lastResolvedWidth = m_stroke.GetWidth();
 else if( !IsConnectivityDirty() )
 m_lastResolvedWidth = GetEffectiveNetClass()->GetBusWidth();
 
 return m_lastResolvedWidth;
 }
}

References DEFAULT_LINE_WIDTH_MILS, SCH_ITEM::GetEffectiveNetClass(), STROKE_PARAMS::GetWidth(), SCH_ITEM::IsConnectivityDirty(), LAYER_BUS, LAYER_WIRE, SCHEMATIC_SETTINGS::m_DefaultLineWidth, m_lastResolvedWidth, SCH_ITEM::m_layer, m_stroke, EDA_IU_SCALE::MilsToIU(), SCH_ITEM::Schematic(), schIUScale, and SCHEMATIC::Settings().

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

◆ GetPosition()

VECTOR2I SCH_LINE::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 262 of file sch_line.h.

262{ return m_start; }

References m_start.

◆ GetReverseAngleFrom()

int SCH_LINE::GetReverseAngleFrom ( const VECTOR2I & aPoint ) const

Definition at line 414 of file sch_line.cpp.

{
 VECTOR2I vec;
 
 if( aPoint == m_end )
 vec = m_start - aPoint;
 else
 vec = m_end - aPoint;
 
 return KiROUND( EDA_ANGLE( vec ).AsDegrees() );
}

References KiROUND(), m_end, and m_start.

◆ GetSelectedPoints()

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

Definition at line 683 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.

Referenced by SCH_MOVE_TOOL::Main().

◆ GetSelectMenuText()

wxString SCH_LINE::GetSelectMenuText ( UNITS_PROVIDER * aUnitsProvider ) 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 693 of file sch_line.cpp.

{
 wxString txtfmt;
 
 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,
 aUnitsProvider->MessageTextFromValue( EuclideanNorm( m_start - m_end ) ) );
}

References _, EuclideanNorm(), Format(), LAYER_BUS, LAYER_WIRE, m_end, SCH_ITEM::m_layer, m_start, UNITS_PROVIDER::MessageTextFromValue(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetSortPosition()

VECTOR2I SCH_LINE::GetSortPosition ( ) const

inlineoverridevirtual

Return the coordinates that should be used for sorting this element visually compared to other elements.

For instance, for lines the midpoint might be a better sorting point than either end.

Returns: X,Y coordinate of the sort point

Reimplemented from EDA_ITEM.

Definition at line 264 of file sch_line.h.

264{ return GetMidPoint(); }

SCH_LINE::GetMidPoint

VECTOR2I GetMidPoint() const

Definition: sch_line.h:141

References GetMidPoint().

◆ GetStartPoint()

VECTOR2I SCH_LINE::GetStartPoint ( ) const

inline

Definition at line 138 of file sch_line.h.

138{ 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_EDIT_FRAME::DeleteJunction(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_SCREEN::doIsJunction(), KIGFX::SCH_PAINTER::draw(), AUTOPLACER::fitFieldsBetweenWires(), AUTOPLACER::getCollidingSides(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), 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(), operator<(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_EDIT_TOOL::Rotate(), SCH_LEGACY_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveLine(), EE_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), ERC_TESTER::TestOffGridEndpoints(), SCH_EDIT_FRAME::TrimWire(), EE_POINT_EDITOR::updateParentItem(), and EE_POINT_EDITOR::updatePoints().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 126 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 139 of file eda_item.h.

139{ return m_status; }

References EDA_ITEM::m_status.

◆ GetStoredAngle()

EDA_ANGLE SCH_LINE::GetStoredAngle ( ) const

inline

Returns the angle stored by StoreAngle()

Returns: Stored angle in radians.

Definition at line 127 of file sch_line.h.

127{ return m_storedAngle; }

SCH_LINE::m_storedAngle

EDA_ANGLE m_storedAngle

Stored angle.

Definition: sch_line.h:326

References m_storedAngle.

◆ GetStoredPos()

VECTOR2I & SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 209 of file sch_item.h.

209{ return m_storedPos; }

SCH_ITEM::m_storedPos

VECTOR2I m_storedPos

Definition: sch_item.h:494

References SCH_ITEM::m_storedPos.

◆ GetStroke()

virtual STROKE_PARAMS SCH_LINE::GetStroke ( ) const

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 176 of file sch_line.h.

176{ return m_stroke; }

References m_stroke.

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

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

Return a translated description of the type for this EDA_ITEM for display in user facing messages.

Definition at line 301 of file eda_item.cpp.

{
 //@see EDA_ITEM_DESC for definition of ENUM_MAP<KICAD_T>
 wxString typeDescr = ENUM_MAP<KICAD_T>::Instance().ToString( Type() );
 
 return wxGetTranslation( typeDescr );
}

References ENUM_MAP< T >::Instance(), and EDA_ITEM::Type().

Referenced by PCB_GROUP::AddItem(), EDIT_TOOL::doMoveSelection(), and EDA_ITEM::GetFriendlyName().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 145 of file eda_item.h.

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

References EDA_ITEM::m_flags.

Referenced by GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), ZONE::IsConflicting(), SCH_MOVE_TOOL::Main(), SCH_SCREEN::MarkConnections(), SCH_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::orthoLineDrag(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< T >::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 175 of file sch_line.h.

175{ return true; }

◆ HitTest() [1/2]

bool SCH_LINE::HitTest	(	const BOX2I &	aRect,
		bool	aContained,
		int	aAccuracy = `0`
	)		const

overridevirtual

Test if aRect intersects this item.

Parameters

aRect	A reference to a BOX2I 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 779 of file sch_line.cpp.

{
 if( m_flags & (STRUCT_DELETED | SKIP_STRUCT ) )
 return false;
 
 BOX2I 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 BOX2< Vec >::Contains(), BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), m_end, EDA_ITEM::m_flags, m_start, SKIP_STRUCT, and STRUCT_DELETED.

◆ HitTest() [2/2]

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

overridevirtual

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

Parameters

aPosition	A reference to a VECTOR2I 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 764 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 );
 
 return TestSegmentHit( aPosition, m_start, m_end, aAccuracy );
}

References std::abs(), GetPenWidth(), m_end, m_start, and TestSegmentHit().

Referenced by SCH_SCREEN::doIsJunction(), SCH_MOVE_TOOL::getConnectedDragItems(), and SCH_MOVE_TOOL::getConnectedItems().

◆ 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 205 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 110 of file eda_item.h.

110{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), SCH_EDIT_FRAME::FocusOnItem(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::setDeviceColors(), 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 931 of file sch_line.cpp.

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

References SCH_ITEM::GetLayer(), and LAYER_BUS.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), EE_SELECTION_TOOL::autostartEvent(), 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 612 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 VECTOR2I & aPoint ) const

inherited

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

Parameters

aPoint is a reference to a VECTOR2I object containing the coordinates to test.

Returns: True if connection to aPoint exists.

Definition at line 137 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(), SCH_MOVE_TOOL::getConnectedItems(), SCH_SCREEN::IsTerminalPoint(), and SCH_SCREEN::MarkConnections().

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( ) const

inlineinherited

Definition at line 413 of file sch_item.h.

413{ return m_connectivity_dirty; }

SCH_ITEM::m_connectivity_dirty

bool m_connectivity_dirty

Definition: sch_item.h:503

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_ITEM::Connection(), KIGFX::SCH_PAINTER::draw(), SCH_BUS_ENTRY_BASE::GetBusEntryColor(), GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_FIELD::GetFieldColor(), SCH_JUNCTION::GetJunctionColor(), SCH_LABEL_BASE::GetLabelColor(), GetLineColor(), SCH_BUS_ENTRY_BASE::GetLineStyle(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), GetPenWidth(), and highlightNet().

◆ IsDangling()

bool SCH_LINE::IsDangling ( ) const

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 244 of file sch_line.h.

244{ return m_startIsDangling || m_endIsDangling; }

References m_endIsDangling, and m_startIsDangling.

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 105 of file eda_item.h.

105{ 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 243 of file sch_line.h.

243{ return m_endIsDangling; }

References m_endIsDangling.

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

◆ IsEndPoint()

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

inline

Definition at line 92 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(), and doIsConnected().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

108{ return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:73

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 203 of file eda_item.h.

203{ return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:499

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

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

References SCH_ITEM::GetLayer(), and LAYER_NOTES.

Referenced by EE_SELECTION_TOOL::autostartEvent(), 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, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 239 of file sch_item.h.

239{ return false; }

Referenced by SCH_ITEM::RenderAsBitmap().

◆ IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const

inlinevirtualinherited

Returns: true if the object is locked, else false.

Definition at line 229 of file sch_item.h.

229{ return false; }

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

102{ 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_BITMAP, SCH_BUS_ENTRY_BASE, SCH_SHEET, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 207 of file sch_item.h.

207{ return true; }

Referenced by SCH_MOVE_TOOL::Main().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

104{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

103{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_MOVE_TOOL::getConnectedDragItems(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

◆ IsNull()

bool SCH_LINE::IsNull ( ) const

inline

Definition at line 136 of file sch_line.h.

136{ return m_start == m_end; }

References m_end, and m_start.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::simplifyWireList(), and StoreAngle().

◆ IsOrthogonal()

bool SCH_LINE::IsOrthogonal ( ) const

inline

Checks if line is orthogonal (to the grid).

Returns: True if orthogonal, false if not or the line is zero length.

Definition at line 134 of file sch_line.h.

134{ return Angle().IsCardinal(); }

EDA_ANGLE::IsCardinal

bool IsCardinal() const

Definition: eda_angle.cpp:49

SCH_LINE::Angle

EDA_ANGLE Angle() const

Gets the angle between the start and end lines.

Definition: sch_line.h:105

References Angle(), and EDA_ANGLE::IsCardinal().

◆ IsParallel()

bool SCH_LINE::IsParallel ( const SCH_LINE * aLine ) const

Definition at line 427 of file sch_line.cpp.

{
 wxCHECK_MSG( aLine != nullptr && aLine->Type() == SCH_LINE_T, false,
 wxT( "Cannot test line segment for overlap." ) );
 
 VECTOR2I firstSeg = m_end - m_start;
 VECTOR2I 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, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ IsPointClickableAnchor()

bool SCH_LINE::IsPointClickableAnchor ( const VECTOR2I & 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 266 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 LIB_TEXTBOX, SCH_FIELD, SCH_LABEL, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 422 of file eda_item.h.

422{ return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 109 of file eda_item.h.

109{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 112 of file eda_item.h.

 {
 return ( m_flags & ( IS_ROLLOVER | IS_MOVING ) ) == IS_ROLLOVER;
 }

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

107{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 175 of file eda_item.h.

175{ return m_flags & IS_SHOWN_AS_BITMAP; }

IS_SHOWN_AS_BITMAP

#define IS_SHOWN_AS_BITMAP

Definition: eda_item_flags.h:55

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsStartDangling()

bool SCH_LINE::IsStartDangling ( ) const

inline

Definition at line 242 of file sch_line.h.

242{ 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 179 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.

◆ IsType()

bool SCH_LINE::IsType ( const std::vector< 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 SCH_ITEM.

Definition at line 72 of file sch_line.h.

 {
 if( SCH_ITEM::IsType( aScanTypes ) )
 return true;
 
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == SCH_ITEM_LOCATE_WIRE_T && m_layer == LAYER_WIRE )
 return true;
 
 if ( scanType == SCH_ITEM_LOCATE_BUS_T && m_layer == LAYER_BUS )
 return true;
 
 if ( scanType == SCH_ITEM_LOCATE_GRAPHIC_LINE_T && m_layer == LAYER_NOTES )
 return true;
 }
 
 return false;
 }

References SCH_ITEM::IsType(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, SCH_ITEM::m_layer, SCH_ITEM_LOCATE_BUS_T, SCH_ITEM_LOCATE_GRAPHIC_LINE_T, and SCH_ITEM_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 925 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(), SCH_DRAWING_TOOLS::TwoClickPlace(), and UpdateDanglingState().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

106{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >

static INSPECT_RESULT EDA_ITEM::IterateForward	(	std::deque< T > &	aList,
		INSPECTOR	inspector,
		void *	testData,
		const std::vector< KICAD_T > &	scanTypes
	)

inlinestaticinherited

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

Definition at line 304 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

static INSPECT_RESULT EDA_ITEM::IterateForward	(	std::vector< T > &	aList,
		INSPECTOR	inspector,
		void *	testData,
		const std::vector< KICAD_T > &	scanTypes
	)

inlinestaticinherited

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

Definition at line 324 of file eda_item.h.

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

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

◆ Matches() [1/2]

virtual bool EDA_ITEM::Matches	(	const EDA_SEARCH_DATA &	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_MARKER, LIB_TEXTBOX, SCH_FIELD, SCH_LABEL_BASE, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, FP_TEXT, FP_TEXTBOX, NETINFO_ITEM, PCB_MARKER, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 384 of file eda_item.h.

 {
 return false;
 }

Referenced by SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_EDITOR_CONTROL::HasMatch(), SCH_MARKER::Matches(), LIB_TEXTBOX::Matches(), SCH_FIELD::Matches(), SCH_LABEL_BASE::Matches(), SCH_PIN::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_TEXTBOX::Matches(), FP_TEXT::Matches(), FP_TEXTBOX::Matches(), NETINFO_ITEM::Matches(), PCB_MARKER::Matches(), PCB_TEXT::Matches(), PCB_TEXTBOX::Matches(), ZONE::Matches(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_EDITOR_CONTROL::UpdateFind().

◆ Matches() [2/2]

bool EDA_ITEM::Matches	(	const wxString &	aText,
		const EDA_SEARCH_DATA &	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 117 of file eda_item.cpp.

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 
 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( aSearchData.searchAndReplace && !IsReplaceable() )
 return false;
 
 if( !aSearchData.matchCase )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::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( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

References EDA_SEARCH_DATA::findString, EDA_ITEM::IsReplaceable(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::searchAndReplace, text, WHOLEWORD, and WILDCARD.

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

{
 auto less =
 []( const VECTOR2I& lhs, const VECTOR2I& 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;
 
 VECTOR2I leftmost_start = aLine->m_start;
 VECTOR2I leftmost_end = aLine->m_end;
 
 VECTOR2I rightmost_start = m_start;
 VECTOR2I 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 );
 }
 
 VECTOR2I other_start = rightmost_start;
 VECTOR2I 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(), EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_EDIT_FRAME::DeleteJunction(), 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 366 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(), STARTPOINT, and VECTOR2< T >::x.

◆ MirrorVertically()

void SCH_LINE::MirrorVertically ( int aCenter )

overridevirtual

Mirror item vertically about aCenter.

Implements SCH_ITEM.

Definition at line 356 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(), STARTPOINT, and VECTOR2< T >::y.

◆ Move()

void SCH_LINE::Move ( const VECTOR2I & aMoveVector )

overridevirtual

Move the item by aMoveVector to a new position.

Implements SCH_ITEM.

Definition at line 134 of file sch_line.cpp.

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

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

◆ MoveEnd()

void SCH_LINE::MoveEnd ( const VECTOR2I & aMoveVector )

Definition at line 155 of file sch_line.cpp.

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

References m_end, and EDA_ITEM::SetModified().

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

◆ MoveStart()

void SCH_LINE::MoveStart ( const VECTOR2I & aMoveVector )

Definition at line 145 of file sch_line.cpp.

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

References m_start, and EDA_ITEM::SetModified().

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

◆ operator<() [1/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 231 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().

◆ operator<() [2/2]

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

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 741 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(), EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ Plot()

void SCH_LINE::Plot	(	PLOTTER *	aPlotter,
		bool	aBackground
	)		const

overridevirtual

Plot the schematic item to aPlotter.

Parameters

aPlotter	is the PLOTTER object to plot to.
aBackground	a poor-man's Z-order. The routine will get called twice, first with aBackground true and then with aBackground false.

Reimplemented from SCH_ITEM.

Definition at line 819 of file sch_line.cpp.

{
 if( aBackground )
 return;
 
 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( penWidth, GetEffectiveLineStyle() );
 
 aPlotter->MoveTo( m_start );
 aPlotter->FinishTo( m_end );
 
 aPlotter->SetDash( penWidth, PLOT_DASH_TYPE::SOLID );
 
 // Plot attributes to a hypertext menu
 std::vector<wxString> properties;
 BOX2I bbox = GetBoundingBox();
 bbox.Inflate( GetPenWidth() * 3 );
 
 if( GetLayer() == LAYER_WIRE )
 {
 if( SCH_CONNECTION* connection = Connection() )
 {
 properties.emplace_back( wxString::Format( wxT( "!%s = %s" ),
 _( "Net" ),
 connection->Name() ) );
 
 properties.emplace_back( wxString::Format( wxT( "!%s = %s" ),
 _( "Resolved netclass" ),
 GetEffectiveNetClass()->GetName() ) );
 }
 }
 else if( GetLayer() == LAYER_BUS )
 {
 if( SCH_CONNECTION* connection = Connection() )
 {
 for( std::shared_ptr<SCH_CONNECTION>& member : connection->Members() )
 properties.emplace_back( wxT( "!" ) + member->Name() );
 }
 
 }
 
 if( !properties.empty() )
 aPlotter->HyperlinkMenu( bbox, properties );
}

References _, color, SCH_ITEM::Connection(), PLOTTER::FinishTo(), Format(), GetBoundingBox(), GetEffectiveLineStyle(), SCH_ITEM::GetEffectiveNetClass(), SCH_ITEM::GetLayer(), GetLineColor(), GetPenWidth(), PLOTTER::HyperlinkMenu(), BOX2< Vec >::Inflate(), LAYER_BUS, LAYER_WIRE, 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 VECTOR2I &	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 326 of file sch_line.cpp.

{
 wxDC* DC = aSettings->GetPrintDC();
 COLOR4D color = GetLineColor();
 
 if( color == COLOR4D::UNSPECIFIED )
 color = aSettings->GetLayerColor( GetLayer() );
 
 VECTOR2I start = m_start;
 VECTOR2I end = m_end;
 PLOT_DASH_TYPE lineStyle = GetEffectiveLineStyle();
 int penWidth = std::max( GetPenWidth(), aSettings->GetDefaultPenWidth() );
 
 if( lineStyle <= PLOT_DASH_TYPE::FIRST_TYPE )
 {
 GRLine( DC, start.x, start.y, end.x, end.y, penWidth, color );
 }
 else
 {
 SHAPE_SEGMENT segment( start, end );
 
 STROKE_PARAMS::Stroke( &segment, lineStyle, penWidth, aSettings,
  [&]( const VECTOR2I& a, const VECTOR2I& b )
 {
 GRLine( DC, a.x, a.y, b.x, b.y, penWidth, color );
 } );
 }
}

References color, FIRST_TYPE, KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), GetEffectiveLineStyle(), SCH_ITEM::GetLayer(), KIGFX::RENDER_SETTINGS::GetLayerColor(), GetLineColor(), GetPenWidth(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GRLine(), m_end, m_start, STROKE_PARAMS::Stroke(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ PrintBackground()

virtual void SCH_ITEM::PrintBackground	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset
	)

inlinevirtualinherited

Print the (optional) backaground elements if they exist.

Parameters

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

Reimplemented in SCH_SHAPE, and SCH_SYMBOL.

Definition at line 286 of file sch_item.h.

286{};

◆ RenderAsBitmap()

bool SCH_ITEM::RenderAsBitmap ( double aWorldScale ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 294 of file sch_item.cpp.

{
 if( IsHypertext() )
 return false;
 
 if( const EDA_TEXT* text = dynamic_cast<const EDA_TEXT*>( this ) )
 return text->GetTextHeight() * aWorldScale < BITMAP_FONT_SIZE_THRESHOLD;
 
 return false;
}

References BITMAP_FONT_SIZE_THRESHOLD, SCH_ITEM::IsHypertext(), and text.

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

◆ Replace() [1/2]

virtual bool EDA_ITEM::Replace	(	const EDA_SEARCH_DATA &	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 LIB_TEXTBOX, SCH_LABEL_BASE, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 411 of file eda_item.h.

 {
 return false;
 }

◆ Replace() [2/2]

bool EDA_ITEM::Replace	(	const EDA_SEARCH_DATA &	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 168 of file eda_item.cpp.

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 wxString result;
 bool replaced = false;
 
 if( !aSearchData.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( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::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.replaceString;
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }
 
 aText = result;
 return replaced;
}

References EDA_SEARCH_DATA::findString, EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::replaceString, text, and WHOLEWORD.

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

◆ Rotate()

void SCH_LINE::Rotate ( const VECTOR2I & aCenter )

overridevirtual

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

Implements SCH_ITEM.

Definition at line 376 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, ANGLE_90 );
 
 else if( m_flags & ENDPOINT )
 RotatePoint( m_end, aCenter, ANGLE_90 );
}

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

◆ RotateEnd()

void SCH_LINE::RotateEnd ( const VECTOR2I & aCenter )

Definition at line 395 of file sch_line.cpp.

{
 RotatePoint( m_end, aCenter, ANGLE_90 );
}

References ANGLE_90, m_end, and RotatePoint().

Referenced by SCH_EDIT_TOOL::Rotate().

◆ RotateStart()

void SCH_LINE::RotateStart ( const VECTOR2I & aCenter )

Definition at line 389 of file sch_line.cpp.

{
 RotatePoint( m_start, aCenter, ANGLE_90 );
}

References ANGLE_90, 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_LABEL_BASE, SCH_SHEET, and SCH_SYMBOL.

Definition at line 444 of file sch_item.h.

444{ }

Referenced by SCH_ITEM::ClearCaches(), SCH_ITEM::Duplicate(), SCH_SHEET_LIST::GetItem(), CONNECTION_SUBGRAPH::GetNetclassForDriver(), 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 112 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_EDIT_TOOL::ChangeTextType(), SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_SHEET::findSelf(), SCH_MARKER::GetColorLayer(), SCH_ITEM::GetEffectiveNetClass(), SCH_JUNCTION::getEffectiveShape(), SCH_LABEL_BASE::GetIntersheetRefs(), SCH_LABEL_BASE::GetLabelBoxExpansion(), SCH_DIRECTIVE_LABEL::GetPenWidth(), GetPenWidth(), SCH_NO_CONNECT::GetPenWidth(), SCH_SHAPE::GetPenWidth(), SCH_SHEET::GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), SCH_SYMBOL::GetPins(), SCH_MARKER::GetSeverity(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_PIN::HitTest(), SCH_SHEET::IsRootSheet(), SCH_LABEL_BASE::IsType(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), DIALOG_TEXT_PROPERTIES::onScintillaCharAdded(), SCH_LABEL_BASE::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_SYMBOL::SetRef(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), and SCH_MARKER::ViewGetLayers().

◆ Set() [1/3]

template<typename T >

bool INSPECTABLE::Set	(	const wxString &	aProperty,
		T	aValue
	)

inlineinherited

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

◆ Set() [2/3]

template<typename T >

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		T	aValue
	)

inlineinherited

Definition at line 54 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), 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]

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

inlineinherited

Definition at line 42 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), 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().

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

119{ SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:142

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), EE_SELECTION_TOOL::highlight(), PL_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.

415{ m_connectivity_dirty = aDirty; }

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::BreakSegment(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_ITEM::GetOrInitConnection(), SCH_ITEM::InitializeConnection(), MergeOverlap(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ SetEndPoint()

void SCH_LINE::SetEndPoint ( const VECTOR2I & aPosition )

inline

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )

inlineinherited

Definition at line 426 of file sch_item.h.

426{ m_fieldsAutoplaced = FIELDS_AUTOPLACED_AUTO; }

FIELDS_AUTOPLACED_AUTO

@ FIELDS_AUTOPLACED_AUTO

Definition: sch_item.h:57

References FIELDS_AUTOPLACED_AUTO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_SEXPR_PARSER::parseSchText().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 142 of file eda_item.h.

142{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

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

201{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 167 of file eda_item.h.

 {
 if( aBitmap )
 SetFlags( IS_SHOWN_AS_BITMAP );
 else
 ClearFlags( IS_SHOWN_AS_BITMAP );
 }

References EDA_ITEM::ClearFlags(), IS_SHOWN_AS_BITMAP, and EDA_ITEM::SetFlags().

◆ SetLastResolvedState()

void SCH_LINE::SetLastResolvedState ( const SCH_ITEM * aItem )

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 146 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.

Referenced by SCH_MOVE_TOOL::getConnectedDragItems(), and SCH_MOVE_TOOL::orthoLineDrag().

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

253{ 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_SHAPE::SCH_SHAPE(), and SCH_FIELD::SetId().

◆ SetLineColor() [1/2]

void SCH_LINE::SetLineColor ( const COLOR4D & aColor )

Definition at line 213 of file sch_line.cpp.

{
 m_stroke.SetColor( aColor );
 m_lastResolvedColor = GetLineColor();
}

References GetLineColor(), m_lastResolvedColor, m_stroke, and STROKE_PARAMS::SetColor().

Referenced by KIGFX::SCH_PAINTER::draw(), and DIALOG_WIRE_BUS_PROPERTIES::TransferDataFromWindow().

◆ SetLineColor() [2/2]

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

Definition at line 220 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 int aStyleId )

Definition at line 250 of file sch_line.cpp.

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

References SetLineStyle().

◆ SetLineStyle() [2/2]

void SCH_LINE::SetLineStyle ( const PLOT_DASH_TYPE aStyle )

Definition at line 256 of file sch_line.cpp.

{
 m_stroke.SetPlotStyle( aStyle );
 m_lastResolvedLineStyle = GetLineStyle();
}

References GetLineStyle(), m_lastResolvedLineStyle, m_stroke, and STROKE_PARAMS::SetPlotStyle().

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_EAGLE_PLUGIN::loadFrame(), CADSTAR_SCH_ARCHIVE_LOADER::loadGraphicStaightSegment(), and SetLineStyle().

◆ SetLineWidth()

void SCH_LINE::SetLineWidth ( const int aSize )

Definition at line 285 of file sch_line.cpp.

{
 m_stroke.SetWidth( aSize );
 m_lastResolvedWidth = GetPenWidth();
}

References GetPenWidth(), m_lastResolvedWidth, 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::ParseBus(), SCH_ALTIUM_PLUGIN::ParsePort(), and SCH_ALTIUM_PLUGIN::ParseWire().

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

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

Definition at line 234 of file sch_item.h.

234{}

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 64 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(), PCB_PARSER::parseZONE(), 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 LIB_SYMBOL, and PCB_DIMENSION_BASE.

Definition at line 100 of file eda_item.h.

100{ m_parent = aParent; }

References EDA_ITEM::m_parent.

◆ SetPosition()

void SCH_LINE::SetPosition ( const VECTOR2I & aPosition )

overridevirtual

Reimplemented from EDA_ITEM.

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

118{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetStartPoint()

void SCH_LINE::SetStartPoint ( const VECTOR2I & aPosition )

inline

Definition at line 139 of file sch_line.h.

139{ 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(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), and EE_POINT_EDITOR::updateParentItem().

◆ SetState()

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

inlineinherited

Definition at line 131 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(), and TRACKS_CLEANER::mergeCollinearSegments().

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 140 of file eda_item.h.

140{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( const VECTOR2I & aPos )

inlineinherited

Definition at line 210 of file sch_item.h.

210{ 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 177 of file sch_line.h.

177{ m_stroke = aStroke; }

References m_stroke.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseLine(), and SCH_SEXPR_PARSER::ParseSchematic().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 117 of file eda_item.h.

117{ 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 440 of file eda_item.h.

440{ return *aLeft < *aRight; }

◆ StoreAngle() [1/2]

void SCH_LINE::StoreAngle ( )

inline

Saves the current line angle.

Useful when dragging a line and its important to be able to restart the line from length 0 in the correct direction.

Definition at line 114 of file sch_line.h.

 {
 if( !IsNull() )
 m_storedAngle = Angle();
 }

References Angle(), IsNull(), and m_storedAngle.

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

◆ StoreAngle() [2/2]

void SCH_LINE::StoreAngle ( const EDA_ANGLE & aAngle )

inline

Definition at line 120 of file sch_line.h.

120{ m_storedAngle = aAngle; }

References m_storedAngle.

◆ 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 796 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 97 of file eda_item.h.

97{ return m_structType; }

EDA_ITEM::m_structType

KICAD_T m_structType

Run time identification, keep private so it can never be changed after a ctor sets it.

Definition: eda_item.h:507

References EDA_ITEM::m_structType.

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

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

Definition at line 254 of file eda_item.cpp.

{
 // Basic fallback
 return GetBoundingBox();
}

References EDA_ITEM::GetBoundingBox().

Referenced by EDIT_TOOL::doMoveSelection(), GERBVIEW_FRAME::GetDocumentExtents(), EDIT_TOOL::Rotate(), PCB_DIMENSION_BASE::ViewBBox(), and PCB_SHAPE::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 DS_PROXY_VIEW_ITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, EDIT_POINTS, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, MY_DRAWING, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::ORIGIN_VIEWITEM, KIGFX::VIEW_GROUP, and KIGFX::VIEW_OVERLAY.

Definition at line 106 of file view_item.h.

107 {}

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 182 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 GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, ZONE, and FP_ZONE.

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(), and PCB_GRID_HELPER::queryVisible().

◆ viewPrivData()

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

inlineinherited

◆ Visit()

INSPECT_RESULT EDA_ITEM::Visit	(	INSPECTOR	inspector,
		void *	testData,
		const std::vector< KICAD_T > &	aScanTypes
	)

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 aScanTypes, 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.
aScanTypes	Which KICAD_T types are of interest and the order in which they should be processed.

Returns: #SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else #SCAN_CONTINUE, and determined by the inspector.

Reimplemented in PCB_GROUP, LIB_SYMBOL, SCH_SHEET, SCH_SYMBOL, GBR_LAYOUT, GERBER_DRAW_ITEM, GERBER_FILE_IMAGE, FOOTPRINT, PCB_TRACK, SCH_LABEL_BASE, and BOARD.

Definition at line 91 of file eda_item.cpp.

{
#if 0 && defined(DEBUG)
 std::cout << GetClass().mb_str() << ' ';
#endif
 
 if( IsType( aScanTypes ) )
 {
 if( INSPECT_RESULT::QUIT == inspector( this, testData ) )
 return INSPECT_RESULT::QUIT;
 }
 
 return INSPECT_RESULT::CONTINUE;
}

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

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

Member Data Documentation

◆ m_connected_items

std::map<SCH_SHEET_PATH, SCH_ITEM_SET, SHEET_PATH_CMP> SCH_ITEM::m_connected_items

protectedinherited

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

Definition at line 498 of file sch_item.h.

Referenced by SCH_ITEM::AddConnectionTo(), SCH_ITEM::ConnectedItems(), and SCH_LABEL_BASE::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 501 of file sch_item.h.

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

◆ m_connections

EDA_ITEMS SCH_ITEM::m_connections

protectedinherited

Definition at line 492 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 503 of file sch_item.h.

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

◆ m_end

VECTOR2I SCH_LINE::m_end

private

Line end point.

Definition at line 325 of file sch_line.h.

Referenced by Angle(), GetAngleFrom(), GetBoundingBox(), GetConnectionPoints(), GetEndPoint(), GetEndPoints(), GetLength(), GetMidPoint(), 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 323 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 493 of file sch_item.h.

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

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 500 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_ITEM::HitTest(), LIB_SHAPE::HitTest(), LIB_TEXT::HitTest(), SCH_JUNCTION::HitTest(), HitTest(), SCH_SYMBOL::HitTest(), LIB_PIN::HitTest(), SCH_PIN::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::IsRollover(), EDA_ITEM::IsSelected(), EDA_ITEM::IsShownAsBitmap(), 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 499 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 334 of file sch_line.h.

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

◆ m_lastResolvedLineStyle

PLOT_DASH_TYPE SCH_LINE::m_lastResolvedLineStyle

mutableprivate

Definition at line 332 of file sch_line.h.

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

◆ m_lastResolvedWidth

int SCH_LINE::m_lastResolvedWidth

mutableprivate

Definition at line 333 of file sch_line.h.

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

◆ m_layer

SCH_LAYER_ID SCH_ITEM::m_layer

protectedinherited

Definition at line 491 of file sch_item.h.

Referenced by SCH_ITEM::CanConnect(), CanConnect(), doIsConnected(), SCH_ITEM::GetLayer(), GetMenuImage(), GetPenWidth(), GetSelectMenuText(), SCH_SYMBOL::Init(), IsConnectable(), SCH_ITEM::IsType(), IsType(), SCH_ITEM::operator=(), SCH_BUS_ENTRY_BASE::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_BUS_ENTRY_BASE::Print(), SCH_FIELD::Print(), SCH_LABEL_BASE::Print(), SCH_TEXT::Print(), SCH_TEXTBOX::Print(), SCH_BITMAP::SCH_BITMAP(), SCH_BUS_BUS_ENTRY::SCH_BUS_BUS_ENTRY(), SCH_BUS_WIRE_ENTRY::SCH_BUS_WIRE_ENTRY(), SCH_DIRECTIVE_LABEL::SCH_DIRECTIVE_LABEL(), SCH_GLOBALLABEL::SCH_GLOBALLABEL(), SCH_HIERLABEL::SCH_HIERLABEL(), SCH_ITEM::SCH_ITEM(), SCH_JUNCTION::SCH_JUNCTION(), SCH_LABEL::SCH_LABEL(), SCH_LINE(), SCH_PIN::SCH_PIN(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), SCH_TEXTBOX::SCH_TEXTBOX(), SCH_ITEM::SetLayer(), SCH_FIELD::SwapData(), SwapData(), SCH_SHAPE::SwapData(), SCH_TEXT::SwapData(), SCH_TEXTBOX::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 498 of file eda_item.h.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::DoHypertextAction(), FP_TEXT::FP_TEXT(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), SCH_FIELD::GetDrawRotation(), FP_TEXT::GetDrawRotation(), FP_TEXTBOX::GetDrawRotation(), SCH_FIELD::GetMenuImage(), FP_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_FIELD::GetName(), LIB_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParent(), EDA_ITEM::GetParent(), PAD::GetParent(), FP_SHAPE::GetParentAsString(), FP_TEXT::GetParentAsString(), FP_TEXTBOX::GetParentAsString(), PAD::GetParentAsString(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), LIB_FIELD::HitTest(), SCH_FIELD::IsHypertext(), SCH_FIELD::IsReplaceable(), SCH_PIN::IsStacked(), SCH_FIELD::Matches(), EDA_ITEM::operator=(), LIB_FIELD::operator=(), PAD::PAD(), SCH_FIELD::Plot(), SCH_FIELD::Print(), SCH_FIELD::Replace(), SCH_LABEL_BASE::ResolveTextVar(), 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(), and PCB_SHAPE::swapData().

◆ m_start

VECTOR2I SCH_LINE::m_start

private

Line start point.

Definition at line 324 of file sch_line.h.

Referenced by Angle(), GetAngleFrom(), GetBoundingBox(), GetConnectionPoints(), GetEndPoints(), GetLength(), GetMidPoint(), 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 322 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 497 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_storedAngle

EDA_ANGLE SCH_LINE::m_storedAngle

private

Stored angle.

Definition at line 326 of file sch_line.h.

Referenced by GetStoredAngle(), and StoreAngle().

◆ m_storedPos

VECTOR2I SCH_ITEM::m_storedPos

protectedinherited

Definition at line 494 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 327 of file sch_line.h.

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

◆ m_structType

KICAD_T EDA_ITEM::m_structType

privateinherited

Run time identification, keep private so it can never be changed after a ctor sets it.

See comment near SetType() regarding virtual functions.

Definition at line 507 of file eda_item.h.

Referenced by EDA_ITEM::IsType(), EDA_ITEM::operator=(), and EDA_ITEM::Type().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 494 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 151 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW_ITEM::ClearViewPrivData(), KIGFX::VIEW_ITEM::viewPrivData(), and KIGFX::VIEW_ITEM::~VIEW_ITEM().

◆ PenStyle

enum wxPenStyle SCH_LINE::PenStyle[]

static

Definition at line 42 of file sch_line.h.

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCH_LINE() [1/3]

◆ SCH_LINE() [2/3]

◆ SCH_LINE() [3/3]

◆ ~SCH_LINE()

Member Function Documentation

◆ AddConnectionTo()

◆ Angle()

◆ AutoAutoplaceFields()

◆ AutoplaceFields()

◆ CanConnect()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearCaches()

◆ ClearConnections()

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ ConnectedItems()

◆ Connection()

◆ ConnectionPropagatesTo()

◆ DoHypertextAction()

◆ doIsConnected()

◆ Duplicate()

◆ FindWireSegmentNetNameRecursive()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAngleFrom()

◆ GetBoundingBox()

◆ GetClass()

◆ GetConnectionPoints()

◆ GetDefaultFont()

◆ GetEditFlags()

◆ GetEffectiveLineStyle()

◆ GetEffectiveNetClass()

◆ GetEndPoint()

◆ GetEndPoints()

◆ GetFieldsAutoplaced()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFriendlyName()

◆ GetLayer()

◆ GetLength()

◆ GetLineColor()

◆ GetLineSize()

◆ GetLineStyle()

◆ GetMenuImage()

◆ GetMidPoint()

◆ GetMsgPanelInfo()

◆ GetNetname()

◆ GetOrInitConnection()

◆ GetParent()

◆ GetPenWidth()

◆ GetPosition()

◆ GetReverseAngleFrom()

◆ GetSelectedPoints()

◆ GetSelectMenuText()

◆ GetSortPosition()

◆ GetStartPoint()

◆ GetState()

◆ GetStatus()

◆ GetStoredAngle()

◆ GetStoredPos()

◆ GetStroke()

◆ GetTypeDesc()

◆ HasFlag()