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

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)

int	GetLineWidth () const

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)

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

double	ViewGetLOD (int aLayer, KIGFX::VIEW *aView) const override
	Return the level of detail (LOD) of the item. 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...

SCH_LINE *	BreakAt (const VECTOR2I &aPoint)
	Break this segment into two at the specified point. 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	GetItemDescription (UNITS_PROVIDER *aUnitsProvider) const override
	Return a user-visible description string of this item. 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...

const wxString &	GetOperatingPoint () const

void	SetOperatingPoint (const wxString &aText)

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

void	SwapFlags (SCH_ITEM *aItem)
	Swap the non-temp and non-edit flags. More...

SCH_ITEM *	Duplicate (bool doClone=false) const
	Routine to create a new copy of given item. More...

virtual void	SetExcludedFromSim (bool aExclude)

virtual bool	GetExcludedFromSim () const

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

const KIFONT::METRICS &	GetFontMetrics () 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)

void	SetConnectionGraph (CONNECTION_GRAPH *aGraph)
	Updates the connection graph for all connections in this item. More...

virtual bool	HasCachedDriverName () const

virtual const wxString &	GetCachedDriverName () const

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	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	XorFlags (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	ClearEditFlags ()

EDA_ITEM_FLAGS	GetTempFlags () const

void	ClearTempFlags ()

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

VIEW_ITEM_DATA *	viewPrivData () const

void	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

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

wxString	m_operatingPoint

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

double	m_forcedTransparency
	Additional transparency for diff'ing items. More...

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`
	)

◆ 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() [3/3]

SCH_LINE::SCH_LINE ( const SCH_LINE & aLine )

Definition at line 76 of file sch_line.cpp.

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

◆ ~SCH_LINE()

SCH_LINE::~SCH_LINE ( )

inline

Definition at line 52 of file sch_line.h.

Member Function Documentation

◆ AddConnectionTo()

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

inherited

Add a connection link between this item and another.

Definition at line 203 of file sch_item.cpp.

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

References m_end, and m_start.

Referenced by SCH_MOVE_TOOL::getConnectedDragItems(), SCH_SCREEN::GetLabelOrientationForPoint(), 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 455 of file sch_item.h.

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

Referenced by 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 461 of file sch_item.h.

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

◆ BreakAt()

SCH_LINE * SCH_LINE::BreakAt ( const VECTOR2I & aPoint )

Break this segment into two at the specified point.

Note: No checks are made to verify if aPoint is contained within the segment. That is the responsibility of the caller.; It is the responsibility of the caller to add the newly created segment to the screen.

Parameters

aPoint Point at which to break the segment

Returns: The newly created segment.

Definition at line 591 of file sch_line.cpp.

References SCH_ITEM::Duplicate(), SCH_ITEM::SetConnectivityDirty(), SetEndPoint(), and SetStartPoint().

Referenced by SCH_EDIT_FRAME::BreakSegment(), and SCHEMATIC::FixupJunctions().

◆ CanConnect()

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

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 663 of file sch_line.cpp.

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.

References SCH_LINE_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by FOOTPRINT_DIFF_WIDGET::DisplayDiff(), SYMBOL_EDIT_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), and PCB_SELECTION_TOOL::unhighlightInternal().

◆ ClearCaches()

void SCH_ITEM::ClearCaches ( )

virtualinherited

Reimplemented in SCH_FIELD.

Definition at line 288 of file sch_item.cpp.

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

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 137 of file eda_item.h.

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

Referenced by BOARD::Add(), FOOTPRINT::Add(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::PutDataInPreviousState(), BOARD_COMMIT::Revert(), SCH_ITEM::SwapFlags(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )

inlineinherited

Definition at line 446 of file sch_item.h.

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

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConnectBoardShapes(), 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(), SCH_COMMIT::pushSchEdit(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), EDA_ITEM::SetIsShownAsBitmap(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_DIFF_WIDGET::DisplayDiff(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL::LIB_SYMBOL(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_COMMIT::Stage(), 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 149 of file eda_item.h.

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState(), and SCH_ITEM::SwapFlags().

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

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

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), 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 147 of file sch_item.cpp.

References SCHEMATIC::CurrentSheet(), SCH_ITEM::IsConnectable(), 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_JUNCTION::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(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_LABEL_BASE::ResolveTextVar(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDITOR_CONTROL::SimProbe(), 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 712 of file sch_line.cpp.

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

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

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

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

Referenced by SCH_EDIT_FRAME::AddCopyForRepeatItem(), BreakAt(), 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 112 of file sch_line.cpp.

References SCH_ITEM::ConnectedItems(), FindWireSegmentNetNameRecursive(), 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.

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.

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(), PROPERTIES_PANEL::getItemValue(), and PCBEXPR_VAR_REF::GetValue().

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

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

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

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

◆ GetCachedDriverName()

const wxString & SCH_ITEM::GetCachedDriverName ( ) const

virtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 254 of file sch_item.cpp.

Referenced by CONNECTION_SUBGRAPH::GetNameForDriver().

◆ GetClass()

wxString SCH_LINE::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 59 of file sch_line.h.

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

References m_end, and m_start.

Referenced by SCH_MOVE_TOOL::doMoveSelection().

◆ GetDefaultFont()

const wxString & SCH_ITEM::GetDefaultFont ( ) const

inherited

Definition at line 323 of file sch_item.cpp.

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

References IS_BROKEN, IS_CHANGED, IS_MOVING, IS_NEW, IS_PASTED, 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 302 of file sch_line.cpp.

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

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

◆ GetEndPoint()

VECTOR2I SCH_LINE::GetEndPoint ( ) const

inline

Definition at line 145 of file sch_line.h.

References m_end.

Referenced by SCH_MOVE_TOOL::AlignElements(), EE_GRID_HELPER::computeAnchors(), 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(), SCH_SCREEN::GetBusesAndWires(), AUTOPLACER::getCollidingSides(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), SCH_SCREEN::GetNeededJunctions(), GetNetNavigatorItemText(), EE_SELECTION_TOOL::GuessSelectionCandidates(), IsPointClickableAnchor(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), EE_SELECTION_TOOL::Main(), 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 603 of file sch_line.cpp.

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

◆ GetExcludedFromSim()

virtual bool SCH_ITEM::GetExcludedFromSim ( ) const

inlinevirtualinherited

Reimplemented in SCH_SYMBOL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 210 of file sch_item.h.

Referenced by DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const

inlineinherited

Return whether the fields have been automatically placed.

Definition at line 443 of file sch_item.h.

References SCH_ITEM::m_fieldsAutoplaced.

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

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 126 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), collidesWithArea(), ConvertOutlineToPolygon(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), LIB_PIN::GetMsgPanelInfo(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), LIB_SYMBOL::LIB_SYMBOL(), EE_SELECTION_TOOL::Main(), 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(), 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 246 of file eda_item.h.

References EDA_ITEM::GetPosition().

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

◆ GetFontMetrics()

const KIFONT::METRICS & SCH_ITEM::GetFontMetrics ( ) const

inherited

Definition at line 331 of file sch_item.cpp.

References KIFONT::METRICS::Default(), and SCH_ITEM::Schematic().

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_FIELD::getFontMetrics(), SCH_TEXT::getFontMetrics(), SCH_TEXTBOX::getFontMetrics(), SCH_FIELD::GetRenderCache(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), and SCH_FIELD::Print().

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 155 of file view_item.h.

Referenced by EDA_ITEM::EDA_ITEM(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), and EDA_ITEM::operator=().

◆ GetFriendlyName()

wxString SCH_LINE::GetFriendlyName ( ) const

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 93 of file sch_line.cpp.

References _, SCH_ITEM::GetLayer(), LAYER_BUS, and LAYER_WIRE.

◆ GetItemDescription()

wxString SCH_LINE::GetItemDescription ( UNITS_PROVIDER * aUnitsProvider ) const

overridevirtual

Return a user-visible description string of this item.

This description is used in disambiguation menus, the message panel, ERC/DRC reports, etc.

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

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

◆ GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 257 of file sch_item.h.

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(), GetFriendlyName(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), GetMsgPanelInfo(), GetNetNavigatorItemText(), 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(), CONNECTION_GRAPH::updateItemConnectivity(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetLength()

double SCH_LINE::GetLength ( ) const

Returns: The length of the line segment.

Definition at line 237 of file sch_line.cpp.

References GetLineLength(), m_end, and m_start.

Referenced by SCH_MOVE_TOOL::orthoLineDrag(), and SCH_EDIT_FRAME::RefreshOperatingPointDisplay().

◆ GetLineColor()

COLOR4D SCH_LINE::GetLineColor ( ) const

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

Definition at line 267 of file sch_line.cpp.

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

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

◆ GetLineStyle()

PLOT_DASH_TYPE SCH_LINE::GetLineStyle ( ) const

Definition at line 293 of file sch_line.cpp.

References STROKE_PARAMS::GetPlotStyle(), and m_stroke.

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

◆ GetLineWidth()

int SCH_LINE::GetLineWidth ( ) const

inline

Definition at line 177 of file sch_line.h.

References STROKE_PARAMS::GetWidth(), and m_stroke.

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

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

References LAYER_NOTES, LAYER_WIRE, and SCH_ITEM::m_layer.

◆ GetMidPoint()

VECTOR2I SCH_LINE::GetMidPoint ( ) const

inline

Definition at line 143 of file sch_line.h.

References m_end, and m_start.

Referenced by KIGFX::SCH_PAINTER::draw(), and 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

aFrame	is the EDA_DRAW_FRAME that displays the message panel
aList	is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 925 of file sch_line.cpp.

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

References FindWireSegmentNetNameRecursive().

◆ GetOperatingPoint()

const wxString & SCH_LINE::GetOperatingPoint ( ) const

inline

Definition at line 301 of file sch_line.h.

References m_operatingPoint.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_EDIT_FRAME::RefreshOperatingPointDisplay().

◆ GetOrInitConnection()

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

inherited

Definition at line 239 of file sch_item.cpp.

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

◆ GetParent()

EDA_ITEM * EDA_ITEM::GetParent ( ) const

inlineinherited

Definition at line 99 of file eda_item.h.

References EDA_ITEM::m_parent.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::editFieldText(), SCH_PIN::GetDefaultNetName(), SCH_FIELD::GetFieldColor(), getInferredSymbols(), SCH_PIN::GetParentSymbol(), EE_SELECTION_TOOL::highlight(), highlightNet(), SCH_FIELD::HitTest(), SCH_PIN::IsStacked(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), EE_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDIT_FRAME::onNetNavigatorSelection(), SCH_FIELD::OnScintillaCharAdded(), SCH_COMMIT::parentObject(), SCH_FIELD::Print(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_COMMIT::Revert(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_ITEM::Schematic(), SCH_SCREEN::Schematic(), SCH_SHEET::SearchHierarchy(), PCB_SELECTION_TOOL::select(), SCH_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 322 of file sch_line.cpp.

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

References m_start.

◆ GetReverseAngleFrom()

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

Definition at line 444 of file sch_line.cpp.

References KiROUND(), m_end, and m_start.

◆ GetSelectedPoints()

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

Definition at line 725 of file sch_line.cpp.

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

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

References GetMidPoint().

◆ GetStartPoint()

VECTOR2I SCH_LINE::GetStartPoint ( ) const

inline

Definition at line 140 of file sch_line.h.

References m_start.

Referenced by SCH_MOVE_TOOL::AlignElements(), EE_GRID_HELPER::computeAnchors(), 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(), SCH_SCREEN::GetBusesAndWires(), AUTOPLACER::getCollidingSides(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), SCH_SCREEN::GetNeededJunctions(), GetNetNavigatorItemText(), EE_SELECTION_TOOL::GuessSelectionCandidates(), IsPointClickableAnchor(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), 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().

◆ GetStoredAngle()

EDA_ANGLE SCH_LINE::GetStoredAngle ( ) const

inline

Returns the angle stored by StoreAngle()

Returns: Stored angle in radians.

Definition at line 129 of file sch_line.h.

References m_storedAngle.

◆ GetStoredPos()

VECTOR2I & SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 220 of file sch_item.h.

References SCH_ITEM::m_storedPos.

◆ GetStroke()

virtual STROKE_PARAMS SCH_LINE::GetStroke ( ) const

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 180 of file sch_line.h.

References m_stroke.

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

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

References CANDIDATE, IS_LINKED, EDA_ITEM::m_flags, SELECTED_BY_DRAG, and SKIP_STRUCT.

Referenced by EDA_ITEM::ClearTempFlags(), and SCH_ITEM::SwapFlags().

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

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

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

◆ HasCachedDriverName()

virtual bool SCH_ITEM::HasCachedDriverName ( ) const

inlinevirtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 433 of file sch_item.h.

Referenced by CONNECTION_SUBGRAPH::GetNameForDriver().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

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

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

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

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

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

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

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

Referenced by SCH_ITEM::GetOrInitConnection().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), SCH_FIND_REPLACE_TOOL::FindNext(), SYMBOL_EDIT_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::setDeviceColors(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

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

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

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

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

◆ IsDangling()

bool SCH_LINE::IsDangling ( ) const

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 262 of file sch_line.h.

References m_endIsDangling, and m_startIsDangling.

◆ IsEndDangling()

bool SCH_LINE::IsEndDangling ( ) const

inline

Definition at line 261 of file sch_line.h.

References m_endIsDangling.

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

◆ IsEndPoint()

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

inline

Definition at line 94 of file sch_line.h.

References m_end, and m_start.

Referenced by SCH_EDIT_TOOL::BreakWire(), SCH_EDIT_FRAME::DeleteJunction(), doIsConnected(), and SCH_SCREEN::GetBusesAndWires().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 191 of file eda_item.h.

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

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

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

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

Referenced by SCH_MOVE_TOOL::doMoveSelection().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), LIB_PIN::CalcEdit(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), 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.

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_MOVE_TOOL::getConnectedDragItems(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), SCH_SCREEN::IsTerminalPoint(), EE_POINT_EDITOR::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ IsNull()

bool SCH_LINE::IsNull ( ) const

inline

Definition at line 138 of file sch_line.h.

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

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

◆ IsParallel()

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

Definition at line 457 of file sch_line.cpp.

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

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

Referenced by EDA_ITEM::Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

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

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), RENDER_3D_OPENGL::get3dModelsFromFootprint(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_SCREEN::MarkConnections(), MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), KIGFX::SCH_PAINTER::nonCached(), SCH_MOVE_TOOL::orthoLineDrag(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), EE_SELECTION_TOOL::RebuildSelection(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), SCH_COMMIT::Stage(), GERBVIEW_SELECTION_TOOL::unselect(), SCH_FIND_REPLACE_TOOL::UpdateFind(), HIERARCHY_PANE::UpdateHierarchySelection(), PCB_FIELD::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 164 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsStartDangling()

bool SCH_LINE::IsStartDangling ( ) const

inline

Definition at line 260 of file sch_line.h.

References m_startIsDangling.

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

◆ IsStrokeEquivalent()

bool SCH_LINE::IsStrokeEquivalent ( const SCH_LINE * aLine )

inline

Definition at line 183 of file sch_line.h.

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

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

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

References SCH_ITEM::GetLayer(), and LAYER_WIRE.

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

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

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

References 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, NETINFO_ITEM, PCB_MARKER, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 372 of file eda_item.h.

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), SCH_FIND_REPLACE_TOOL::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(), NETINFO_ITEM::Matches(), PCB_MARKER::Matches(), PCB_TEXT::Matches(), PCB_TEXTBOX::Matches(), ZONE::Matches(), TEXT_SEARCH_HANDLER::Search(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_FIND_REPLACE_TOOL::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 123 of file eda_item.cpp.

References CTX_SEARCH, EDA_COMBINED_MATCHER::Find(), EDA_SEARCH_DATA::findString, EDA_ITEM::IsReplaceable(), isWordChar(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::searchAndReplace, and text.

◆ MergeOverlap()

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

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

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

Parameters

aScreen	is the current screen.
aLine	is the line to compare.
aCheckJunctions	is used to indicate if we need to check for a junction if the two segments are colinear and touch.

Returns: New line that combines the two or NULL on non-overlapping segments.

Definition at line 470 of file sch_line.cpp.

References SCH_ITEM::GetLayer(), SCH_SCREEN::IsJunction(), EDA_ITEM::IsSelected(), m_end, m_start, 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 396 of file sch_line.cpp.

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

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

References m_end, and m_start.

Referenced by LTSPICE_SCH_PARSER::CreateLine().

◆ MoveEnd()

void SCH_LINE::MoveEnd ( const VECTOR2I & aMoveVector )

Definition at line 163 of file sch_line.cpp.

References m_end.

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

◆ MoveStart()

void SCH_LINE::MoveStart ( const VECTOR2I & aMoveVector )

Definition at line 157 of file sch_line.cpp.

References m_start.

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

References EDA_ITEM::GetClass().

◆ operator<() [2/2]

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

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 783 of file sch_line.cpp.

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

References _, color, SCH_ITEM::Connection(), PLOTTER::FinishTo(), 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(), and PLOTTER::SetDash().

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

References color, 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 299 of file sch_item.h.

◆ RenderAsBitmap()

bool SCH_ITEM::RenderAsBitmap ( double aWorldScale ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 340 of file sch_item.cpp.

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

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

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

Referenced by EDA_TEXT::Replace(), SCH_FIELD::Replace(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), and SCH_FIND_REPLACE_TOOL::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 406 of file sch_line.cpp.

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

References ANGLE_90, m_end, and RotatePoint().

Referenced by SCH_EDIT_TOOL::Rotate().

◆ RotateStart()

void SCH_LINE::RotateStart ( const VECTOR2I & aCenter )

Definition at line 419 of file sch_line.cpp.

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

Referenced by SCH_ITEM::ClearCaches(), SCH_ITEM::Duplicate(), SCH_SHEET_PATH::GetItem(), CONNECTION_SUBGRAPH::GetNetclassForDriver(), SCH_EDIT_FRAME::RecalculateConnections(), 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 113 of file sch_item.cpp.

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

Referenced by EE_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::ChangeTextType(), SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createNewSheetPin(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_SHEET::findSelf(), SCH_MARKER::GetColorLayer(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), SCH_SHEET::GetContextualTextVars(), SCH_ITEM::GetEffectiveNetClass(), SCH_JUNCTION::getEffectiveShape(), SCH_ITEM::GetFontMetrics(), 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_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_PIN::HitTest(), SCH_SHEET::IsRootSheet(), SCH_LABEL_BASE::IsType(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), SCH_FIELD::OnScintillaCharAdded(), SCH_SYMBOL::Plot(), SCH_COMMIT::pushSchEdit(), SCH_LABEL_BASE::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_COMMIT::Revert(), SCH_SYMBOL::SetRef(), SCH_EDITOR_CONTROL::SimTune(), 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.

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.

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.

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

Referenced by SCH_PROPERTIES_PANEL::valueChanged(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 116 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetConnectionGraph()

void SCH_ITEM::SetConnectionGraph ( CONNECTION_GRAPH * aGraph )

inherited

Updates the connection graph for all connections in this item.

Definition at line 164 of file sch_item.cpp.

References SCH_ITEM::m_connection_map, and path.

Referenced by CONNECTION_GRAPH::Merge().

◆ SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool aDirty = true )

inlineinherited

Definition at line 428 of file sch_item.h.

References SCH_ITEM::m_connectivity_dirty.

Referenced by BreakAt(), SCH_MOVE_TOOL::getConnectedDragItems(), MergeOverlap(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_COMMIT::Revert(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetEndPoint()

void SCH_LINE::SetEndPoint ( const VECTOR2I & aPosition )

inline

Definition at line 146 of file sch_line.h.

References m_end.

Referenced by BreakAt(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), LTSPICE_SCH_PARSER::CreateLine(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), LTSPICE_SCH_PARSER::CreateWire(), LTSPICE_SCH_PARSER::CreateWires(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), EE_SELECTION_TOOL::Main(), MergeOverlap(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_ALTIUM_PLUGIN::ParseWire(), SCH_SEXPR_PLUGIN::saveBusEntry(), and EE_POINT_EDITOR::updateParentItem().

◆ SetExcludedFromSim()

virtual void SCH_ITEM::SetExcludedFromSim ( bool aExclude )

inlinevirtualinherited

Reimplemented in SCH_SYMBOL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 209 of file sch_item.h.

Referenced by DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )

inlineinherited

Definition at line 445 of file sch_item.h.

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

References EDA_ITEM::m_flags.

◆ SetForcedTransparency()

void KIGFX::VIEW_ITEM::SetForcedTransparency ( double aForcedTransparency )

inlineinherited

Definition at line 150 of file view_item.h.

Referenced by EDA_ITEM::EDA_ITEM(), SYMBOL_DIFF_WIDGET::onSlider(), FOOTPRINT_DIFF_WIDGET::onSlider(), and EDA_ITEM::operator=().

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

References EDA_ITEM::m_forceVisible.

Referenced by SCH_FIND_REPLACE_TOOL::FindNext(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 156 of file eda_item.h.

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

References GetStroke(), m_lastResolvedColor, m_lastResolvedLineStyle, m_lastResolvedWidth, and m_stroke.

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

References SCH_ITEM::m_layer.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), LTSPICE_SCH_PARSER::CreateWire(), SCH_MOVE_TOOL::getConnectedDragItems(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), 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 243 of file sch_line.cpp.

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

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_LINE_DESC::SCH_LINE_DESC(), 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 250 of file sch_line.cpp.

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

◆ SetLineStyle() [1/2]

void SCH_LINE::SetLineStyle ( const int aStyleId )

Definition at line 280 of file sch_line.cpp.

References SetLineStyle().

◆ SetLineStyle() [2/2]

void SCH_LINE::SetLineStyle ( const PLOT_DASH_TYPE aStyle )

Definition at line 286 of file sch_line.cpp.

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

Referenced by LTSPICE_SCH_PARSER::CreateWire(), LTSPICE_SCH_PARSER::CreateWires(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), SCH_LINE_DESC::SCH_LINE_DESC(), and SetLineStyle().

◆ SetLineWidth()

void SCH_LINE::SetLineWidth ( const int aSize )

Definition at line 315 of file sch_line.cpp.

References GetPenWidth(), m_lastResolvedWidth, m_stroke, and STROKE_PARAMS::SetWidth().

Referenced by LTSPICE_SCH_PARSER::CreateWire(), LTSPICE_SCH_PARSER::CreateWires(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseWire(), and SCH_LINE_DESC::SCH_LINE_DESC().

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

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

Definition at line 245 of file sch_item.h.

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 64 of file eda_item.cpp.

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), and EDA_ITEM::SetModified().

◆ SetOperatingPoint()

void SCH_LINE::SetOperatingPoint ( const wxString & aText )

inline

Definition at line 302 of file sch_line.h.

References m_operatingPoint.

Referenced by SCH_EDIT_FRAME::RefreshOperatingPointDisplay().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 100 of file eda_item.h.

References EDA_ITEM::m_parent.

Referenced by BOARD::Add(), FOOTPRINT::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitivePoly(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), CADSTAR_SCH_ARCHIVE_LOADER::copySymbolItems(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), LIB_SYMBOL::Flatten(), FOOTPRINT::FootprintNeedsUpdate(), PCB_PLUGIN::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), LTSPICE_SCHEMATIC::Load(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), KI_TEST::LoadHierarchy(), LIB_SYMBOL::operator=(), SCH_SEXPR_PARSER::parseLibSymbol(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), PAD_TOOL::RecombinePad(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), CLIPBOARD_IO::SaveSelection(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_LABEL_BASE::SwapData(), SCH_SHEET::SwapData(), SCH_SYMBOL::SwapData(), BOARD_ITEM::SwapItemData(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetPosition()

void SCH_LINE::SetPosition ( const VECTOR2I & aPosition )

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 918 of file sch_line.cpp.

References m_end, and m_start.

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 115 of file eda_item.h.

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(), GERBVIEW_SELECTION_TOOL::selectVisually(), and SCH_COMMIT::Stage().

◆ SetStartPoint()

void SCH_LINE::SetStartPoint ( const VECTOR2I & aPosition )

inline

Definition at line 141 of file sch_line.h.

References m_start.

Referenced by BreakAt(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), LTSPICE_SCH_PARSER::CreateWire(), LTSPICE_SCH_PARSER::CreateWires(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), MergeOverlap(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), and EE_POINT_EDITOR::updateParentItem().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( const VECTOR2I & aPos )

inlineinherited

Definition at line 221 of file sch_item.h.

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::doMoveSelection().

◆ SetStroke()

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

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 181 of file sch_line.h.

References m_stroke.

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

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

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

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

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

◆ StoreAngle() [2/2]

void SCH_LINE::StoreAngle ( const EDA_ANGLE & aAngle )

inline

Definition at line 122 of file sch_line.h.

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

References m_end, m_endIsDangling, SCH_ITEM::m_layer, m_start, m_startIsDangling, m_stroke, and SCH_ITEM::SwapFlags().

◆ SwapFlags()

void SCH_ITEM::SwapFlags ( SCH_ITEM * aItem )

inherited

Swap the non-temp and non-edit flags.

Definition at line 267 of file sch_item.cpp.

References EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearTempFlags(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetTempFlags(), EDA_ITEM::m_flags, and EDA_ITEM::SetFlags().

Referenced by SCH_BITMAP::SwapData(), SCH_BUS_ENTRY_BASE::SwapData(), SCH_FIELD::SwapData(), SCH_JUNCTION::SwapData(), SwapData(), SCH_NO_CONNECT::SwapData(), SCH_SHAPE::SwapData(), SCH_SHEET::SwapData(), SCH_SYMBOL::SwapData(), and SCH_TEXT::SwapData().

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

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

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, PAD, PCB_DIMENSION_BASE, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TEXT, PCB_TRACK, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, and MY_DRAWING.

Definition at line 273 of file eda_item.cpp.

References EDA_ITEM::GetBoundingBox().

Referenced by EDIT_TOOL::doMoveSelection(), GERBVIEW_FRAME::GetDocumentExtents(), EDIT_TOOL::Rotate(), 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 113 of file view_item.h.

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

◆ ViewGetLayers()

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

overridevirtual

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

Reimplemented from SCH_ITEM.

Definition at line 186 of file sch_line.cpp.

References LAYER_DANGLING, LAYER_OP_VOLTAGES, LAYER_SELECTION_SHADOWS, and SCH_ITEM::m_layer.

◆ ViewGetLOD()

double SCH_LINE::ViewGetLOD	(	int	aLayer,
		KIGFX::VIEW *	aView
	)		const

overridevirtual

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 from KIGFX::VIEW_ITEM.

Definition at line 196 of file sch_line.cpp.

References std::abs(), LAYER_OP_VOLTAGES, m_end, m_start, EDA_IU_SCALE::mmToIU(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ viewPrivData()

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

inlineinherited

Definition at line 145 of file view_item.h.

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

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

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

Referenced by PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), EDA_ITEM::IterateForward(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), and BOARD::UpdateUserUnits().

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 124 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by EE_SELECTION_TOOL::selectMultiple().

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

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

◆ m_connections

EDA_ITEMS SCH_ITEM::m_connections

protectedinherited

Definition at line 511 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 522 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 346 of file sch_line.h.

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

◆ m_endIsDangling

bool SCH_LINE::m_endIsDangling

private

True if end point is not connected.

Definition at line 344 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 512 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 487 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::GetTempFlags(), 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::IsEntered(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsRollover(), EDA_ITEM::IsSelected(), EDA_ITEM::IsShownAsBitmap(), MirrorHorizontally(), MirrorVertically(), EDA_ITEM::operator=(), Rotate(), EDA_ITEM::SetFlags(), PCB_SHAPE::swapData(), PCB_BITMAP::swapData(), SCH_ITEM::SwapFlags(), and EDA_ITEM::XorFlags().

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 164 of file view_item.h.

Referenced by KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()().

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 486 of file eda_item.h.

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

◆ m_lastResolvedColor

COLOR4D SCH_LINE::m_lastResolvedColor

mutableprivate

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

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

◆ m_lastResolvedWidth

int SCH_LINE::m_lastResolvedWidth

mutableprivate

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

Referenced by SCH_ITEM::CanConnect(), CanConnect(), doIsConnected(), GetItemDescription(), SCH_ITEM::GetLayer(), GetMenuImage(), GetPenWidth(), 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_operatingPoint

wxString SCH_LINE::m_operatingPoint

private

Definition at line 357 of file sch_line.h.

Referenced by GetOperatingPoint(), SCH_LINE(), and SetOperatingPoint().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 485 of file eda_item.h.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::DoHypertextAction(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), PCB_FIELD::GetCanonicalName(), SCH_FIELD::GetDrawRotation(), SCH_FIELD::GetMenuImage(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_FIELD::GetName(), PCB_FIELD::GetName(), LIB_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParent(), EDA_ITEM::GetParent(), BOARD_ITEM::GetParentAsString(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), LIB_FIELD::HitTest(), 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(), SCH_FIELD::SetId(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), SCH_FIELD::SetPosition(), PCB_SHAPE::swapData(), and PCB_BITMAP::swapData().

◆ m_start

VECTOR2I SCH_LINE::m_start

private

Line start point.

Definition at line 345 of file sch_line.h.

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

◆ m_startIsDangling

bool SCH_LINE::m_startIsDangling

private

True if start point is not connected.

Definition at line 343 of file sch_line.h.

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

◆ m_storedAngle

EDA_ANGLE SCH_LINE::m_storedAngle

private

Stored angle.

Definition at line 347 of file sch_line.h.

Referenced by GetStoredAngle(), and StoreAngle().

◆ m_storedPos

VECTOR2I SCH_ITEM::m_storedPos

protectedinherited

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

Referenced by GetEffectiveLineStyle(), GetLineColor(), GetLineStyle(), GetLineWidth(), GetMsgPanelInfo(), GetPenWidth(), GetStroke(), IsStrokeEquivalent(), SCH_LINE(), SetLastResolvedState(), 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 494 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 482 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 163 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::OnDestroy(), KIGFX::VIEW::Remove(), 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()

◆ BreakAt()

◆ CanConnect()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearCaches()

◆ ClearConnections()

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ ConnectedItems()

◆ Connection()

◆ ConnectionPropagatesTo()

◆ DoHypertextAction()

◆ doIsConnected()

◆ Duplicate()

◆ FindWireSegmentNetNameRecursive()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAngleFrom()

◆ GetBoundingBox()

◆ GetCachedDriverName()

◆ GetClass()

◆ GetConnectionPoints()

◆ GetDefaultFont()

◆ GetEditFlags()

◆ GetEffectiveLineStyle()

◆ GetEffectiveNetClass()

◆ GetEndPoint()

◆ GetEndPoints()

◆ GetExcludedFromSim()

◆ GetFieldsAutoplaced()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFontMetrics()

◆ GetForcedTransparency()

◆ GetFriendlyName()

◆ GetItemDescription()

◆ GetLayer()

◆ GetLength()

◆ GetLineColor()

◆ GetLineStyle()

◆ GetLineWidth()

◆ GetMenuImage()

◆ GetMidPoint()

◆ GetMsgPanelInfo()

◆ GetNetname()

◆ GetOperatingPoint()

◆ GetOrInitConnection()

◆ GetParent()

◆ GetPenWidth()

◆ GetPosition()

◆ GetReverseAngleFrom()

◆ GetSelectedPoints()

◆ GetSortPosition()

◆ GetStartPoint()

◆ GetStoredAngle()

◆ GetStoredPos()