Holds all the data relating to one schematic. More...

#include <schematic.h>

Inheritance diagram for SCHEMATIC:

Public Member Functions
	SCHEMATIC (PROJECT *aPrj)

virtual	~SCHEMATIC ()

virtual wxString	GetClass () const override
	Return the class name. More...

void	Reset ()
	Initialize this schematic to a blank one, unloading anything existing. More...

PROJECT &	Prj () const override
	Return a reference to the project this schematic is part of. More...

void	SetProject (PROJECT *aPrj)

const std::map< wxString, wxString > *	GetProperties ()

SCH_SHEET_LIST	GetSheets () const override
	Builds and returns an updated schematic hierarchy TODO: can this be cached? More...

SCH_SHEET &	Root () const

void	SetRoot (SCH_SHEET *aRootSheet)
	Initialize the schematic with a new root sheet. More...

bool	IsValid () const
	A simple test if the schematic is loaded, not a complete one. More...

SCH_SCREEN *	RootScreen () const
	Helper to retrieve the screen of the root sheet. More...

void	GetContextualTextVars (wxArrayString *aVars) const

bool	ResolveTextVar (wxString *token, int aDepth) const

wxString	GetFileName () const override
	Helper to retrieve the filename from the root sheet screen. More...

SCH_SHEET_PATH &	CurrentSheet () const override

void	SetCurrentSheet (const SCH_SHEET_PATH &aPath) override

CONNECTION_GRAPH *	ConnectionGraph () const override

SCHEMATIC_SETTINGS &	Settings () const

ERC_SETTINGS &	ErcSettings () const

std::vector< SCH_MARKER * >	ResolveERCExclusions ()

std::shared_ptr< BUS_ALIAS >	GetBusAlias (const wxString &aLabel) const
	Return a pointer to a bus alias object for the given label, or null if one doesn't exist. More...

std::set< wxString >	GetNetClassAssignmentCandidates ()
	Return the set of netname candidates for netclass assignment. More...

bool	ResolveCrossReference (wxString *token, int aDepth) const
	Resolves text vars that refer to other items. More...

std::map< wxString, std::set< int > > &	GetPageRefsMap ()

std::map< int, wxString >	GetVirtualPageToSheetNamesMap () const

std::map< int, wxString >	GetVirtualPageToSheetPagesMap () const

wxString	ConvertRefsToKIIDs (const wxString &aSource) const

wxString	ConvertKIIDsToRefs (const wxString &aSource) const

SCH_SHEET_LIST &	GetFullHierarchy () const
	Return the full schematic flattened hierarchical sheet list. More...

void	SetLegacySymbolInstanceData ()
	Update the symbol value and footprint instance data for legacy designs. More...

wxString	GetUniqueFilenameForCurrentSheet ()

void	SetSheetNumberAndCount ()
	Set the m_ScreenNumber and m_NumberOfScreens members for screens. More...

void	RecomputeIntersheetRefs (const std::function< void(SCH_GLOBALLABEL *)> &aItemCallback)
	Update the schematic's page reference map for all global labels, and refresh the labels so that they are redrawn with up-to-date references. More...

void	ClearOperatingPoints ()
	Clear operating points from a .op simulation. More...

void	SetOperatingPoint (const wxString &aSignal, double aValue)
	Set operating points from a .op simulation. More...

wxString	GetOperatingPoint (const wxString &aNetName, int aPrecision, const wxString &aRange)

void	FixupJunctions ()
	Add junctions to this schematic where required. More...

void	OnItemsAdded (std::vector< SCH_ITEM * > &aNewItems)
	Must be used if Add() is used using a BULK_x ADD_MODE to generate a change event for listeners. More...

void	OnItemsRemoved (std::vector< SCH_ITEM * > &aRemovedItems)
	Must be used if Remove() is used using a BULK_x REMOVE_MODE to generate a change event for listeners. More...

void	AddListener (SCHEMATIC_LISTENER *aListener)
	Add a listener to the schematic to receive calls whenever something on the schematic has been modified. More...

void	RemoveListener (SCHEMATIC_LISTENER *aListener)
	Remove the specified listener. More...

void	RemoveAllListeners ()
	Remove all listeners. More...

void	OnItemsChanged (std::vector< SCH_ITEM * > &aItems)
	Notify the schematic and its listeners that an item on the schematic has been modified in some way. 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	ClearTempFlags ()

void	ClearEditFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

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

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 void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
	Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...

virtual wxString	GetFriendlyName () const

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

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

virtual const BOX2I	GetBoundingBox () const
	Return the orthogonal bounding box of this object for display purposes. More...

virtual VECTOR2I	GetPosition () const

virtual void	SetPosition (const VECTOR2I &aPos)

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

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

virtual EDA_ITEM *	Clone () const
	Create a duplicate of this item with linked list members set to NULL. 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 wxString	GetItemDescription (UNITS_PROVIDER *aUnitsProvider) const
	Return a user-visible description string of this item. More...

virtual BITMAPS	GetMenuImage () const
	Return a pointer to an image to be used in menus. 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...

bool	operator< (const EDA_ITEM &aItem) const
	Test if another item is less than this object. More...

virtual const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers. More...

virtual void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the all the layers within the VIEW the object is painted on. More...

virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Draw the parts of the object belonging to layer aLayer. More...

virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Return the level of detail (LOD) of the item. More...

VIEW_ITEM_DATA *	viewPrivData () const

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

Protected Member Functions
bool	Matches (const wxString &aText, const EDA_SEARCH_DATA &aSearchData) const
	Compare aText against search criteria in aSearchData. More...

Protected Attributes
EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

Private Member Functions
template<typename Func , typename... Args>
void	InvokeListeners (Func &&aFunc, Args &&... args)

Private Attributes
PROJECT *	m_project

SCH_SHEET *	m_rootSheet
	The top-level sheet in this schematic hierarchy (or potentially the only one) More...

SCH_SHEET_PATH *	m_currentSheet
	The sheet path of the sheet currently being edited or displayed. More...

CONNECTION_GRAPH *	m_connectionGraph
	Holds and calculates connectivity information of this schematic. More...

std::map< wxString, std::set< int > >	m_labelToPageRefsMap
	Holds a map of labels to the page sequence (virtual page number) that they appear on. More...

std::map< wxString, wxString >	m_properties
	Properties for text variable substitution (and perhaps other uses in future). More...

std::map< wxString, double >	m_operatingPoints
	Simulation operating points for text variable substitution. More...

std::vector< SCHEMATIC_LISTENER * >	m_listeners
	Currently installed listeners. More...

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

Friends
class	SCH_EDIT_FRAME

Detailed Description

Holds all the data relating to one schematic.

A schematic may consist of one or more sheets (and one root sheet) Right now, Eeschema can have only one schematic open at a time, but this could change. Please keep this possibility in mind when adding to this object.

Definition at line 71 of file schematic.h.

Constructor & Destructor Documentation

◆ SCHEMATIC()

SCHEMATIC::SCHEMATIC ( PROJECT * aPrj )

Definition at line 37 of file schematic.cpp.

References m_connectionGraph, m_currentSheet, and SetProject().

◆ ~SCHEMATIC()

SCHEMATIC::~SCHEMATIC ( )

virtual

Definition at line 49 of file schematic.cpp.

References m_connectionGraph, and m_currentSheet.

Member Function Documentation

◆ AddListener()

void SCHEMATIC::AddListener ( SCHEMATIC_LISTENER * aListener )

Add a listener to the schematic to receive calls whenever something on the schematic has been modified.

The schematic does not take ownership of the listener object. Make sure to call RemoveListener before deleting the listener object. The order of listener invocations is not guaranteed. If the specified listener object has been added before, it will not be added again.

Definition at line 690 of file schematic.cpp.

References alg::contains(), and m_listeners.

Referenced by SCH_SEARCH_PANE::SCH_SEARCH_PANE().

◆ 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(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), and PCB_SELECTION_TOOL::unhighlightInternal().

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 142 of file eda_item.h.

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

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

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

◆ ClearOperatingPoints()

void SCHEMATIC::ClearOperatingPoints ( )

inline

Clear operating points from a .op simulation.

Definition at line 221 of file schematic.h.

References m_operatingPoints.

Referenced by SIMULATOR_FRAME::onPlotClosed(), and SIMULATOR_FRAME::onSimFinished().

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 137 of file eda_item.h.

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::PutDataInPreviousState().

◆ Clone()

EDA_ITEM * EDA_ITEM::Clone ( ) const

virtualinherited

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 in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, KIGFX::ORIGIN_VIEWITEM, PCB_GROUP, FOOTPRINT, NETINFO_ITEM, PAD, PCB_BITMAP, PCB_DIM_ALIGNED, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIM_LEADER, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_ARC, PCB_VIA, and ZONE.

Definition at line 81 of file eda_item.cpp.

References EDA_ITEM::GetClass().

Referenced by SCH_EDIT_FRAME::AddCopyForRepeatItem(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), LIB_SYMBOL::LIB_SYMBOL(), SCHEMATIC_COMMIT::makeImage(), BOARD_COMMIT::makeImage(), new_clone(), LIB_SYMBOL::operator=(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), LIB_SYMBOL::SetConversion(), LIB_SYMBOL::SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ConnectionGraph()

CONNECTION_GRAPH * SCHEMATIC::ConnectionGraph ( ) const

inlineoverridevirtual

Implements SCHEMATIC_IFACE.

Definition at line 143 of file schematic.h.

References m_connectionGraph.

Referenced by EE_SELECTION_TOOL::autostartEvent(), DIALOG_MIGRATE_BUSES::getProposedLabels(), DIALOG_MIGRATE_BUSES::loadGraphData(), EESCHEMA_HELPERS::LoadSchematic(), SCH_EDIT_FRAME::MakeNetNavigatorNode(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::RecalculateConnections(), DIALOG_ERC::testErc(), ERC_TESTER::TestMultUnitPinConflicts(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and SCH_SCREENS::UpdateSymbolLinks().

◆ ConvertKIIDsToRefs()

wxString SCHEMATIC::ConvertKIIDsToRefs ( const wxString & aSource ) const

Definition at line 453 of file schematic.cpp.

References SCH_SHEET_LIST::GetItem(), SCH_SYMBOL::GetRef(), GetSheets(), SCH_SYMBOL_T, and EDA_ITEM::Type().

Referenced by DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ ConvertRefsToKIIDs()

wxString SCHEMATIC::ConvertRefsToKIIDs ( const wxString & aSource ) const

Definition at line 385 of file schematic.cpp.

References KIID::AsString(), SCH_REFERENCE_LIST::GetCount(), SCH_SYMBOL::GetRef(), GetSheets(), SCH_SHEET_LIST::GetSymbols(), and EDA_ITEM::m_Uuid.

Referenced by DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ CurrentSheet()

SCH_SHEET_PATH & SCHEMATIC::CurrentSheet ( ) const

inlineoverridevirtual

Implements SCHEMATIC_IFACE.

Definition at line 133 of file schematic.h.

References m_currentSheet.

Referenced by SCH_ITEM::Connection(), SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createHPGLFiles(), SCH_PLOTTER::createPDFFile(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), findItemsFromSyncSelection(), SCH_SHEET::findSelf(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), GetContextualTextVars(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_LABEL_BASE::GetIntersheetRefs(), SCH_SYMBOL::GetPins(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), GetUniqueFilenameForCurrentSheet(), SCH_LTSPICE_PLUGIN::Load(), KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), SCH_SYMBOL::Plot(), SCH_PLOTTER::plotOneSheetDXF(), SCH_PLOTTER::plotOneSheetHpgl(), SCH_PLOTTER::plotOneSheetPDF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), RecomputeIntersheetRefs(), SCH_LABEL_BASE::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), ResolveTextVar(), SCH_PLOTTER::restoreEnvironment(), SetSheetNumberAndCount(), SCH_EDITOR_CONTROL::SimTune(), EE_SELECTION_TOOL::SyncSelection(), ERC_TESTER::TestTextVars(), and SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires().

◆ ErcSettings()

ERC_SETTINGS & SCHEMATIC::ErcSettings ( ) const

◆ FixupJunctions()

void SCHEMATIC::FixupJunctions ( )

Add junctions to this schematic where required.

This function is needed for some plugins (e.g. Legacy and Cadstar) in order to retain connectivity after loading.

Definition at line 650 of file schematic.cpp.

References SCH_SCREEN::Append(), SCH_LINE::BreakAt(), SCH_SCREEN::GetBusesAndWires(), SCH_SCREEN::GetNeededJunctions(), GetSheets(), and SCH_SCREEN::Items().

Referenced by CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), and SCH_EDIT_FRAME::OpenProjectFiles().

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

◆ GetBoundingBox()

const BOX2I EDA_ITEM::GetBoundingBox ( ) const

virtualinherited

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 in LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_SYMBOL, LIB_TEXT, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, GBR_LAYOUT, GERBER_DRAW_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, BOARD, FOOTPRINT, NETINFO_ITEM, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TRACK, ZONE, and DS_DRAW_ITEM_BASE.

Definition at line 73 of file eda_item.cpp.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CN_ITEM::BBox(), SCH_EDIT_TOOL::ChangeTextType(), TEST_BOARD_ITEM_FIXTURE::CompareItems(), TEST_EE_ITEM_FIXTURE::CompareItems(), EE_RTREE::contains(), BOARD_COMMIT::dirtyIntersectingZones(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), SCH_DRAWING_TOOLS::DrawSheet(), enclosedByAreaFunc(), PCB_SELECTION_TOOL::FindItem(), SCH_FIND_REPLACE_TOOL::FindNext(), LIB_ITEM::GetBoundingBox(), GetBoundingBoxes(), BOARD_ITEM::GetCenter(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), EE_SELECTION_TOOL::GuessSelectionCandidates(), PNS_KICAD_IFACE::HideItem(), EE_RTREE::insert(), intersectsAreaFunc(), SCH_SCREEN::MarkConnections(), SCH_EDIT_TOOL::Mirror(), DRC_RTREE::QueryColliding(), EE_RTREE::remove(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges(), GERBVIEW_SELECTION::ViewBBox(), and EDA_ITEM::ViewBBox().

◆ GetBusAlias()

std::shared_ptr< BUS_ALIAS > SCHEMATIC::GetBusAlias ( const wxString & aLabel ) const

Return a pointer to a bus alias object for the given label, or null if one doesn't exist.

Definition at line 291 of file schematic.cpp.

References GetSheets().

◆ GetClass()

virtual wxString SCHEMATIC::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 78 of file schematic.h.

◆ GetContextualTextVars()

void SCHEMATIC::GetContextualTextVars ( wxArrayString * aVars ) const

Definition at line 128 of file schematic.cpp.

References alg::contains(), CurrentSheet(), empty(), TITLE_BLOCK::GetContextualTextVars(), SCH_SCREEN::GetTitleBlock(), SCH_SHEET_PATH::LastScreen(), and Prj().

Referenced by SCH_SHEET::GetContextualTextVars().

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

◆ GetFileName()

wxString SCHEMATIC::GetFileName ( ) const

overridevirtual

Helper to retrieve the filename from the root sheet screen.

Implements SCHEMATIC_IFACE.

Definition at line 199 of file schematic.cpp.

References SCH_SCREEN::GetFileName(), SCH_SHEET::GetScreen(), IsValid(), and m_rootSheet.

Referenced by SCH_EDIT_FRAME::GetCurrentFileName(), GetRescueLibraryFileName(), GetUniqueFilenameForCurrentSheet(), EESCHEMA_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), DIALOG_SYMBOL_FIELDS_TABLE::OnOutputFileBrowseClicked(), DIALOG_BOM::OnRunGenerator(), ResolveTextVar(), SCH_EDITOR_CONTROL::Revert(), SCH_SHEET_LIST::TestForRecursion(), SCH_SHEET_PATH::TestForRecursion(), and DIALOG_EXPORT_NETLIST::TransferDataFromWindow().

◆ 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(), SCH_EDIT_FRAME::ConvertPart(), BOARD_COMMIT::dirtyIntersectingZones(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), LIB_PIN::GetMsgPanelInfo(), LIB_SYMBOL::LIB_SYMBOL(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD_TOOL::RecombinePad(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 239 of file eda_item.h.

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 150 of file view_item.h.

References KIGFX::VIEW_ITEM::m_forcedTransparency.

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

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, PCB_TRACK, and ZONE.

Definition at line 310 of file eda_item.cpp.

References EDA_ITEM::GetTypeDesc().

Referenced by PROPERTIES_PANEL::rebuildProperties().

◆ GetFullHierarchy()

SCH_SHEET_LIST & SCHEMATIC::GetFullHierarchy ( ) const

Return the full schematic flattened hierarchical sheet list.

Definition at line 504 of file schematic.cpp.

References SCH_SHEET_LIST::BuildSheetList(), and m_rootSheet.

Referenced by DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ GetItemDescription()

wxString EDA_ITEM::GetItemDescription ( UNITS_PROVIDER * aUnitsProvider ) const

virtualinherited

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 in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, DELETED_SHEET_ITEM, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, GERBER_DRAW_ITEM, DELETED_BOARD_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, BOARD, FOOTPRINT, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 107 of file eda_item.cpp.

References EDA_ITEM::GetClass().

Referenced by CONNECTION_GRAPH::collectAllDriverValues(), DIALOG_GROUP_PROPERTIES::DoAddMember(), SELECTION_TOOL::doSelectionMenu(), DRC_ENGINE::EvalRules(), BOARD_INSPECTION_TOOL::getItemDescription(), PCB_MARKER::GetMsgPanelInfo(), ERC_TREE_MODEL::GetValue(), RC_TREE_MODEL::GetValue(), RC_ITEM::ShowReport(), DIALOG_POSITION_RELATIVE::updateAnchorInfo(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetMenuImage()

BITMAPS EDA_ITEM::GetMenuImage ( ) const

virtualinherited

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 in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, PAD, PCB_BITMAP, PCB_DIM_ALIGNED, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIM_LEADER, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 269 of file eda_item.cpp.

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ GetMsgPanelInfo()

virtual void EDA_ITEM::GetMsgPanelInfo	(	EDA_DRAW_FRAME *	aFrame,
		std::vector< MSG_PANEL_ITEM > &	aList
	)

inlinevirtualinherited

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 in LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, GERBER_DRAW_ITEM, DS_DRAW_ITEM_BASE, PCB_GROUP, BOARD, FOOTPRINT, NETINFO_ITEM, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_DIM_ALIGNED, PCB_DIM_LEADER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 192 of file eda_item.h.

Referenced by SCH_SHAPE::GetMsgPanelInfo(), EDA_DRAW_FRAME::SetMsgPanel(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), and FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel().

◆ GetNetClassAssignmentCandidates()

std::set< wxString > SCHEMATIC::GetNetClassAssignmentCandidates ( )

Return the set of netname candidates for netclass assignment.

The list will include both composite names (buses) and atomic net names. Names are fetched from available labels, power pins, etc.

Definition at line 306 of file schematic.cpp.

References CONNECTION_SUBGRAPH::GetDriverConnection(), CONNECTION_SUBGRAPH::GetDriverPriority(), CONNECTION_GRAPH::GetNetMap(), SCH_CONNECTION::IsBus(), m_connectionGraph, and CONNECTION_SUBGRAPH::PIN.

Referenced by DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP().

◆ GetOperatingPoint()

wxString SCHEMATIC::GetOperatingPoint	(	const wxString &	aNetName,
		int	aPrecision,
		const wxString &	aRange
	)

Definition at line 630 of file schematic.cpp.

References NETLIST_EXPORTER_SPICE::ConvertToSpiceMarkup(), m_operatingPoints, and SPICE_VALUE::ToString().

Referenced by SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), SCH_LABEL_BASE::ResolveTextVar(), and SCH_SYMBOL::ResolveTextVar().

◆ GetPageRefsMap()

std::map< wxString, std::set< int > > & SCHEMATIC::GetPageRefsMap ( )

inline

Definition at line 174 of file schematic.h.

References m_labelToPageRefsMap.

Referenced by SCH_LABEL_BASE::GetIntersheetRefs(), RecomputeIntersheetRefs(), and SCH_GLOBALLABEL::ResolveTextVar().

◆ 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_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::editFieldText(), SCH_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(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), SCHEMATIC_COMMIT::parentObject(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCHEMATIC_COMMIT::pushSchEdit(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCHEMATIC_COMMIT::Revert(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_ITEM::Schematic(), SCH_SCREEN::Schematic(), SCH_SHEET::SearchHierarchy(), PCB_SELECTION_TOOL::select(), SCHEMATIC_COMMIT::Stage(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), EE_SELECTION_TOOL::unhighlight(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), EE_TOOL_BASE< T >::updateItem(), and SCH_BASE_FRAME::UpdateItem().

◆ GetPosition()

virtual VECTOR2I EDA_ITEM::GetPosition ( ) const

inlinevirtualinherited

Reimplemented in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, GERBER_DRAW_ITEM, DELETED_BOARD_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, KIGFX::ORIGIN_VIEWITEM, PCB_GROUP, BOARD, FOOTPRINT, NETINFO_ITEM, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TRACK, PCB_ARC, PCB_VIA, and ZONE.

Definition at line 232 of file eda_item.h.

Referenced by SCH_MOVE_TOOL::AlignElements(), TEARDROP_MANAGER::areItemsInSameZone(), SCH_EDIT_TOOL::ChangeTextType(), TEST_BOARD_ITEM_FIXTURE::CompareItems(), TEST_EE_ITEM_FIXTURE::CompareItems(), PCB_GRID_HELPER::computeAnchors(), EE_GRID_HELPER::computeAnchors(), CONVERT_TOOL::CreatePolys(), SCH_EDIT_FRAME::DeleteJunction(), EDIT_TOOL::doMoveSelection(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNetclassConflicts(), CONNECTION_GRAPH::ercCheckNoConnects(), PCB_SELECTION_TOOL::FindItem(), GERBVIEW_SELECTION::GetCenter(), EDA_ITEM::GetFocusPosition(), BOARD_ITEM::GetFPRelativePosition(), getMinDist(), SCH_FIELD::GetParentPosition(), EDA_ITEM::GetSortPosition(), PCB_SELECTION::GetTopLeftItem(), EE_SELECTION::GetTopLeftItem(), BOARD_ITEM::GetX(), BOARD_ITEM::GetY(), SCH_MOVE_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), DIALOG_MIGRATE_BUSES::onItemSelected(), BOARD::cmp_items::operator()(), SCH_ITEM::operator<(), SCH_EDITOR_CONTROL::Paste(), PL_EDIT_TOOL::Paste(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::PositionRelative(), BACK_ANNOTATE::processNetNameChange(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), RC_ITEM::ShowReport(), SCH_EDIT_TOOL::Swap(), DRC_TEST_PROVIDER_MISC::testTextVars(), TransformItem(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), EDIT_TOOL::updateModificationPoint(), and PL_EDIT_TOOL::updateModificationPoint().

◆ GetProperties()

const std::map< wxString, wxString > * SCHEMATIC::GetProperties ( )

inline

Definition at line 90 of file schematic.h.

References m_properties.

Referenced by KIGFX::SCH_VIEW::DisplaySheet(), SCH_PLOTTER::plotOneSheetDXF(), SCH_PLOTTER::plotOneSheetHpgl(), SCH_PLOTTER::plotOneSheetPDF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), and SCH_PRINTOUT::PrintPage().

◆ GetSheets()

SCH_SHEET_LIST SCHEMATIC::GetSheets ( ) const

inlineoverridevirtual

Builds and returns an updated schematic hierarchy TODO: can this be cached?

Returns: a SCH_SHEET_LIST containing the schematic hierarchy

Implements SCHEMATIC_IFACE.

Definition at line 97 of file schematic.h.

References m_rootSheet.

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

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

Definition at line 248 of file eda_item.h.

References EDA_ITEM::GetPosition().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

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

Definition at line 301 of file eda_item.cpp.

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

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

◆ GetUniqueFilenameForCurrentSheet()

wxString SCHEMATIC::GetUniqueFilenameForCurrentSheet ( )

Returns: a filename that can be used in plot and print functions for the current screen and sheet path. This filename is unique and must be used instead of the screen filename when one must create files for each sheet in the hierarchy. Name is &ltroot sheet filename&gt-&ltsheet path&gt and has no extension. However if filename is too long name is &ltsheet filename&gt-&ltsheet number&gt

Definition at line 523 of file schematic.cpp.

References SCH_SHEET_PATH::at(), CurrentSheet(), GetFileName(), SCH_SHEET::GetName(), and SCH_SHEET_PATH::size().

Referenced by SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createHPGLFiles(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), and SCH_PLOTTER::getOutputFilenameSingle().

◆ GetVirtualPageToSheetNamesMap()

std::map< int, wxString > SCHEMATIC::GetVirtualPageToSheetNamesMap ( ) const

Definition at line 358 of file schematic.cpp.

References _, and GetSheets().

Referenced by SCH_LABEL_BASE::GetIntersheetRefs().

◆ GetVirtualPageToSheetPagesMap()

std::map< int, wxString > SCHEMATIC::GetVirtualPageToSheetPagesMap ( ) const

Definition at line 374 of file schematic.cpp.

References GetSheets().

Referenced by SCH_LABEL_BASE::GetIntersheetRefs(), and SCH_GLOBALLABEL::ResolveTextVar().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

◆ HitTest() [1/2]

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

inlinevirtualinherited

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 in LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, DS_DRAW_ITEM_BASE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, FOOTPRINT, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, PCB_ARC, ZONE, and GERBER_DRAW_ITEM.

Definition at line 218 of file eda_item.h.

◆ HitTest() [2/2]

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

inlinevirtualinherited

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 in RATSNEST_VIEW_ITEM, SCH_SHEET, PCB_DIMENSION_BASE, PCB_TEXT, PCB_TEXTBOX, LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, DS_DRAW_ITEM_BASE, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, FOOTPRINT, PAD, PCB_BITMAP, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TRACK, PCB_ARC, PCB_VIA, ZONE, and GERBER_DRAW_ITEM.

Definition at line 205 of file eda_item.h.

Referenced by PCB_GRID_HELPER::AlignToNearestPad(), PL_SELECTION_TOOL::guessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), LIB_ITEM::HitTest(), DS_DRAW_ITEM_BASE::HitTest(), EE_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_SELECTION_TOOL::selectionContains(), and PCB_SELECTION_TOOL::selectMultiple().

◆ InvokeListeners()

template<typename Func , typename... Args>

void SCHEMATIC::InvokeListeners	(	Func &&	aFunc,
		Args &&...	args
	)

inlineprivate

Definition at line 289 of file schematic.h.

References m_listeners.

Referenced by OnItemsAdded(), OnItemsChanged(), and OnItemsRemoved().

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

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

References EDA_ITEM::m_forceVisible.

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

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

◆ 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_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), LIB_PIN::CalcEdit(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Swap().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

References IS_NEW, and EDA_ITEM::m_flags.

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

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

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsType()

virtual bool EDA_ITEM::IsType ( const std::vector< KICAD_T > & aScanTypes ) const

inlinevirtualinherited

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 in SCH_FIELD, SCH_ITEM, SCH_LABEL_BASE, SCH_LINE, PAD, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, and PCB_VIA.

Definition at line 165 of file eda_item.h.

References EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_FIELD::GetCanonicalName(), KIGFX::SCH_PAINTER::getLineWidth(), SCH_FIELD::GetName(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_FIELD::GetShownText(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_ITEM::IsType(), PAD::IsType(), PCB_SHAPE::IsType(), PCB_TEXT::IsType(), PCB_TEXTBOX::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), CONVERT_TOOL::makePolysFromChainedSegs(), EE_SELECTION_TOOL::RequestSelection(), SCH_FIELD::SetId(), SCHEMATIC_COMMIT::Stage(), SCH_BASE_FRAME::UpdateItem(), and EDA_ITEM::Visit().

◆ IsValid()

bool SCHEMATIC::IsValid ( ) const

inline

A simple test if the schematic is loaded, not a complete one.

Definition at line 118 of file schematic.h.

References m_rootSheet.

Referenced by SCH_EDIT_FRAME::canCloseWindow(), GetFileName(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_SEXPR_PLUGIN::Load(), SCH_LEGACY_PLUGIN::Load(), SCH_LTSPICE_PLUGIN::Load(), and RootScreen().

◆ 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 285 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 305 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 365 of file eda_item.h.

Referenced by SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_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(), 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 116 of file eda_item.cpp.

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

◆ OnItemsAdded()

void SCHEMATIC::OnItemsAdded ( std::vector< SCH_ITEM * > & aNewItems )

Must be used if Add() is used using a BULK_x ADD_MODE to generate a change event for listeners.

Definition at line 678 of file schematic.cpp.

References InvokeListeners(), and SCHEMATIC_LISTENER::OnSchItemsAdded().

Referenced by SCHEMATIC_COMMIT::pushSchEdit(), and SCHEMATIC_COMMIT::Revert().

◆ OnItemsChanged()

void SCHEMATIC::OnItemsChanged ( std::vector< SCH_ITEM * > & aItems )

Notify the schematic and its listeners that an item on the schematic has been modified in some way.

Definition at line 715 of file schematic.cpp.

References InvokeListeners(), and SCHEMATIC_LISTENER::OnSchItemsChanged().

Referenced by SCHEMATIC_COMMIT::pushSchEdit(), and SCHEMATIC_COMMIT::Revert().

◆ OnItemsRemoved()

void SCHEMATIC::OnItemsRemoved ( std::vector< SCH_ITEM * > & aRemovedItems )

Must be used if Remove() is used using a BULK_x REMOVE_MODE to generate a change event for listeners.

Definition at line 684 of file schematic.cpp.

References InvokeListeners(), and SCHEMATIC_LISTENER::OnSchItemsRemoved().

Referenced by SCHEMATIC_COMMIT::pushSchEdit(), and SCHEMATIC_COMMIT::Revert().

◆ operator<()

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

References EDA_ITEM::GetClass().

◆ Prj()

PROJECT & SCHEMATIC::Prj ( ) const

inlineoverridevirtual

Return a reference to the project this schematic is part of.

Implements SCHEMATIC_IFACE.

Definition at line 87 of file schematic.h.

References m_project.

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), SCH_PLOTTER::createPDFFile(), KIGFX::SCH_VIEW::DisplaySheet(), GetContextualTextVars(), SCH_ITEM::GetEffectiveNetClass(), SCH_ALTIUM_PLUGIN::getLibFileName(), SCH_EAGLE_PLUGIN::getLibFileName(), SCH_ALTIUM_PLUGIN::getLibName(), SCH_EAGLE_PLUGIN::getLibName(), TEST_NETLIST_EXPORTER_SPICE_FIXTURE::GetNetlistPath(), TEST_SIM_REGRESSIONS_FIXTURE::GetNetlistPath(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_SEXPR_PLUGIN::Load(), SCH_LEGACY_PLUGIN::Load(), SCH_LTSPICE_PLUGIN::Load(), LTSPICE_SCHEMATIC::Load(), SCH_EAGLE_PLUGIN::loadLibrary(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_ALTIUM_PLUGIN::ParseAltiumSch(), SCH_ALTIUM_PLUGIN::ParseHarnessType(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_PLOTTER::plotOneSheetDXF(), SCH_PLOTTER::plotOneSheetHpgl(), SCH_PLOTTER::plotOneSheetPDF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), SCH_SHEET::ResolveTextVar(), ResolveTextVar(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), ERC_TESTER::TestLibSymbolIssues(), ERC_TESTER::TestSimModelIssues(), ERC_TESTER::TestTextVars(), and SCH_SCREEN::UpdateSymbolLinks().

◆ RecomputeIntersheetRefs()

void SCHEMATIC::RecomputeIntersheetRefs ( const std::function< void(SCH_GLOBALLABEL *)> & aItemCallback )

Update the schematic's page reference map for all global labels, and refresh the labels so that they are redrawn with up-to-date references.

Definition at line 568 of file schematic.cpp.

References CurrentSheet(), SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), GetPageRefsMap(), GetSheets(), EDA_TEXT::GetText(), SCH_SHEET_PATH::LastScreen(), SCHEMATIC_SETTINGS::m_IntersheetRefsShow, Root(), SCH_GLOBAL_LABEL_T, Settings(), and SCH_SCREEN::Update().

Referenced by EESCHEMA_HELPERS::LoadSchematic(), and SCH_EDIT_FRAME::RecomputeIntersheetRefs().

◆ RemoveAllListeners()

void SCHEMATIC::RemoveAllListeners ( )

Remove all listeners.

Definition at line 709 of file schematic.cpp.

References m_listeners.

Referenced by SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ RemoveListener()

void SCHEMATIC::RemoveListener ( SCHEMATIC_LISTENER * aListener )

Remove the specified listener.

If it has not been added before, it will do nothing.

Definition at line 697 of file schematic.cpp.

References m_listeners.

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 147 of file eda_item.h.

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

References EDA_SEARCH_DATA::findString, 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().

◆ Reset()

void SCHEMATIC::Reset ( )

Initialize this schematic to a blank one, unloading anything existing.

Definition at line 56 of file schematic.cpp.

References SCH_SHEET_PATH::clear(), PROJECT::GetProjectFile(), m_connectionGraph, m_currentSheet, m_project, m_rootSheet, project, and CONNECTION_GRAPH::Reset().

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_FRAME::doCloseWindow(), KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::OpenProjectFiles(), KI_TEST::SCHEMATIC_TEST_FIXTURE::~SCHEMATIC_TEST_FIXTURE(), and TEST_NGSPICE_HELPERS::~TEST_NGSPICE_HELPERS().

◆ ResolveCrossReference()

bool SCHEMATIC::ResolveCrossReference	(	wxString *	token,
		int	aDepth
	)		const

Resolves text vars that refer to other items.

Note that the actual resolve is delegated to the symbol/sheet in question. This routine just does the look-up and delegation.

Definition at line 325 of file schematic.cpp.

References SCH_SHEET_LIST::GetItem(), SCH_SYMBOL::GetRef(), GetSheets(), SCH_SHEET::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_SHEET_T, SCH_SYMBOL_T, and EDA_ITEM::Type().

Referenced by SCH_SYMBOL::ResolveTextVar().

◆ ResolveERCExclusions()

std::vector< SCH_MARKER * > SCHEMATIC::ResolveERCExclusions ( )

Definition at line 219 of file schematic.cpp.

References SCH_MARKER::Deserialize(), ErcSettings(), MARKER_BASE::GetRCItem(), GetSheets(), SCH_MARKER::IsLegacyMarker(), ERC_SETTINGS::m_ErcExclusions, SCH_MARKER_T, SCH_MARKER::Serialize(), and MARKER_BASE::SetExcluded().

◆ ResolveTextVar()

bool SCHEMATIC::ResolveTextVar	(	wxString *	token,
		int	aDepth
	)		const

Definition at line 152 of file schematic.cpp.

References CurrentSheet(), empty(), GetFileName(), SCH_SHEET::GetName(), SCH_SHEET_PATH::GetPageNumber(), PROJECT::GetProjectName(), SCH_SHEET_PATH::Last(), m_project, SCH_SHEET_PATH::PathHumanReadable(), Prj(), and Root().

Referenced by DIALOG_PLOT_SCHEMATIC::getOutputPath(), and DIALOG_SYMBOL_FIELDS_TABLE::OnExport().

◆ Root()

SCH_SHEET & SCHEMATIC::Root ( ) const

inline

Definition at line 102 of file schematic.h.

References m_rootSheet.

Referenced by DIALOG_SYMBOL_REMAP::backupProject(), SCH_NAVIGATE_TOOL::CanGoUp(), SCH_SCREENS::ClearAnnotationOfNewSheetPaths(), SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createHPGLFiles(), SCH_PLOTTER::createPDFFile(), SCH_PLOTTER::createPSFiles(), SCH_EDIT_FRAME::CreateScreens(), SCH_PLOTTER::createSVGFiles(), DIALOG_ERC::deleteAllMarkers(), SHEETLIST_ERC_ITEMS_PROVIDER::DeleteItem(), SCH_EDIT_FRAME::doAutoSave(), SCH_SEARCH_HANDLER::FindAll(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_PRINTOUT::GetPageInfo(), HIERARCHY_PANE::getRootString(), getSymbols(), SCH_PRINTOUT::HasPage(), SCH_EDIT_FRAME::importFile(), EE_SELECTION_TOOL::Init(), SCH_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_SHEET::IsRootSheet(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_SEXPR_PLUGIN::Load(), SCH_LEGACY_PLUGIN::Load(), SCH_LTSPICE_PLUGIN::Load(), KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), EESCHEMA_HELPERS::LoadSchematic(), DIALOG_SCH_IMPORT_SETTINGS::OnBrowseClicked(), DIALOG_ERC::OnERCItemRClick(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), RecomputeIntersheetRefs(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_EDITOR_CONTROL::rescueProject(), SCH_EDITOR_CONTROL::RescueSymbols(), ResolveTextVar(), SCH_EDITOR_CONTROL::Revert(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SetSheetNumberAndCount(), ERC_TESTER::TestConflictingBusAliases(), ERC_TESTER::TestDuplicateSheetNames(), DIALOG_ERC::testErc(), ERC_TESTER::TestLibSymbolIssues(), ERC_TESTER::TestOffGridEndpoints(), DIALOG_PRINT_USING_PRINTER::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_BUSES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), PANEL_SETUP_BUSES::TransferDataToWindow(), HIERARCHY_PANE::UpdateHierarchyTree(), LEGACY_RESCUER::WriteRescueLibrary(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

◆ RootScreen()

SCH_SCREEN * SCHEMATIC::RootScreen ( ) const

Helper to retrieve the screen of the root sheet.

Definition at line 122 of file schematic.cpp.

References SCH_SHEET::GetScreen(), IsValid(), and m_rootSheet.

Referenced by SCH_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::CreateArchiveLibraryCacheFile(), SCH_PLOTTER::createHPGLFiles(), SCH_PLOTTER::createPDFFile(), SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_FRAME::doCloseWindow(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), EESCHEMA_HELPERS::LoadSchematic(), SCH_EDIT_FRAME::ResolveERCExclusions(), SCH_EDIT_FRAME::SaveProject(), and SCH_EDIT_FRAME::saveProjectSettings().

◆ 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 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(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), and PCB_SELECTION_TOOL::highlightInternal().

◆ SetCurrentSheet()

void SCHEMATIC::SetCurrentSheet ( const SCH_SHEET_PATH & aPath )

inlineoverridevirtual

Implements SCHEMATIC_IFACE.

Definition at line 138 of file schematic.h.

References m_currentSheet.

Referenced by SCH_NAVIGATE_TOOL::changeSheet(), SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createHPGLFiles(), SCH_PLOTTER::createPDFFile(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), DIALOG_MIGRATE_BUSES::onItemSelected(), SCH_EDIT_FRAME::onNetNavigatorSelection(), SCH_PLOTTER::restoreEnvironment(), SCH_EDIT_FRAME::SetCurrentSheet(), EE_SELECTION_TOOL::SyncSelection(), and ERC_TESTER::TestTextVars().

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

References KIGFX::VIEW_ITEM::m_forcedTransparency.

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

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

◆ SetLegacySymbolInstanceData()

void SCHEMATIC::SetLegacySymbolInstanceData ( )

Update the symbol value and footprint instance data for legacy designs.

Prior to schematic file format version 20200828 and legacy file format version, only symbol reference field and unit were saved in the instance data. The value and footprint fields must be carried forward from the original symbol to prevent data loss.

Definition at line 515 of file schematic.cpp.

References m_rootSheet, and SCH_SCREENS::SetLegacySymbolInstanceData().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

◆ SetOperatingPoint()

void SCHEMATIC::SetOperatingPoint	(	const wxString &	aSignal,
		double	aValue
	)

inline

Set operating points from a .op simulation.

Called after the simulation completes.

Definition at line 229 of file schematic.h.

References m_operatingPoints.

Referenced by SIMULATOR_FRAME::onSimFinished().

◆ 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::AddPrimitiveAnnotationBox(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), 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(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_PLUGIN::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), 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=(), FOOTPRINT::operator=(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCHEMATIC_COMMIT::pushLibEdit(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), 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(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetPosition()

virtual void EDA_ITEM::SetPosition ( const VECTOR2I & aPos )

inlinevirtualinherited

Reimplemented in DELETED_SHEET_ITEM, DELETED_BOARD_ITEM, PCB_GROUP, PCB_VIA, LIB_PIN, SCH_SHAPE, GERBER_DRAW_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, BOARD, FOOTPRINT, NETINFO_ITEM, PAD, PCB_DIMENSION_BASE, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TRACK, PCB_ARC, ZONE, LIB_ITEM, LIB_SHAPE, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, KIGFX::ORIGIN_VIEWITEM, and PCB_BITMAP.

Definition at line 233 of file eda_item.h.

Referenced by EDIT_TOOL::doMoveSelection(), BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), DRAWING_TOOL::DrawVia(), PL_DRAWING_TOOLS::PlaceItem(), BOARD_ITEM::SetFPRelativePosition(), BOARD_ITEM::SetX(), BOARD_ITEM::SetY(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDIT_TOOL::Swap(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetProject()

void SCHEMATIC::SetProject ( PROJECT * aPrj )

Definition at line 81 of file schematic.cpp.

References PROJECT::GetProjectFile(), m_project, and project.

Referenced by SCH_EDIT_FRAME::CreateScreens(), KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::OpenProjectFiles(), SCHEMATIC(), and TEST_NGSPICE_HELPERS::TEST_NGSPICE_HELPERS().

◆ SetRoot()

void SCHEMATIC::SetRoot ( SCH_SHEET * aRootSheet )

Initialize the schematic with a new root sheet.

This is typically done by calling a file loader that returns the new root sheet As a side-effect, takes care of some post-load initialization.

Parameters

aRootSheet is the new root sheet for this schematic.

Definition at line 109 of file schematic.cpp.

References SCH_SHEET_PATH::clear(), m_connectionGraph, m_currentSheet, m_rootSheet, SCH_SHEET_PATH::push_back(), and CONNECTION_GRAPH::Reset().

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_FRAME::importFile(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_LTSPICE_PLUGIN::Load(), KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), EESCHEMA_HELPERS::LoadSchematic(), and SCH_EDIT_FRAME::OpenProjectFiles().

◆ 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(), SCH_LINE::MergeOverlap(), DS_PROXY_UNDO_ITEM::Restore(), EE_TOOL_BASE< T >::saveCopyInUndoList(), and GERBVIEW_SELECTION_TOOL::selectVisually().

◆ SetSheetNumberAndCount()

void SCHEMATIC::SetSheetNumberAndCount ( )

Set the m_ScreenNumber and m_NumberOfScreens members for screens.

Note: This must be called after deleting or adding a sheet and when entering a sheet.

Definition at line 539 of file schematic.cpp.

References SCH_SHEET::CountSheets(), CurrentSheet(), SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), GetSheets(), SCH_SHEET_PATH::LastScreen(), SCH_SHEET_PATH::Path(), Root(), BASE_SCREEN::SetPageCount(), BASE_SCREEN::SetPageNumber(), SCH_SHEET_PATH::SetVirtualPageNumber(), and BASE_SCREEN::SetVirtualPageNumber().

Referenced by SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createHPGLFiles(), SCH_PLOTTER::createPDFFile(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), EESCHEMA_HELPERS::LoadSchematic(), SCH_PLOTTER::restoreEnvironment(), and SCH_EDIT_FRAME::SetSheetNumberAndCount().

◆ Settings()

SCHEMATIC_SETTINGS & SCHEMATIC::Settings ( ) const

Definition at line 205 of file schematic.cpp.

References PROJECT::GetProjectFile(), m_project, and PROJECT_FILE::m_SchematicSettings.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::CommonSettingsChanged(), SCH_DRAWING_TOOLS::createNewText(), SCH_PLOTTER::createPlotFileName(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), SCH_DRAWING_TOOLS::DrawShape(), SCH_JUNCTION::getEffectiveShape(), SCH_LABEL_BASE::GetLabelBoxExpansion(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_SHAPE::GetPenWidth(), SCH_SHEET::GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SCH_TEXT::GetTextOffset(), DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), DIALOG_ANNOTATE::InitValues(), DIALOG_EXPORT_NETLIST::InstallPageSpice(), DIALOG_EXPORT_NETLIST::InstallPageSpiceModel(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PANEL_EESCHEMA_ANNOTATION_OPTIONS::loadEEschemaSettings(), SCH_EDIT_FRAME::LoadProjectSettings(), DIALOG_EXPORT_NETLIST::NetlistUpdateOpt(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceSymbol(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::RecalculateConnections(), RecomputeIntersheetRefs(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataToWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), and DIALOG_ANNOTATE::~DIALOG_ANNOTATE().

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

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

◆ 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 254 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 108 of file view_item.h.

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

◆ ViewGetLayers()

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

overridevirtualinherited

Return the all the layers within the VIEW the object is painted on.

For instance, a PAD spans zero or more copper layers and a few technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called for each of the layers returned by ViewGetLayers(), depending on the rendering order.

Parameters

aLayers[]	is the output layer index array.
aCount	is the number of layer indices in aLayers[].

Implements KIGFX::VIEW_ITEM.

Reimplemented in LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_SYMBOL, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_ITEM, SCH_JUNCTION, SCH_LABEL_BASE, SCH_GLOBALLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, GERBER_DRAW_ITEM, BOARD_ITEM, DS_DRAW_ITEM_BASE, DS_PROXY_VIEW_ITEM, KIGFX::ORIGIN_VIEWITEM, PCB_GROUP, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, EDIT_POINTS, FOOTPRINT, PAD, PCB_BITMAP, PCB_MARKER, PCB_TEXT, PCB_TRACK, PCB_VIA, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, ZONE, and MY_DRAWING.

Definition at line 261 of file eda_item.cpp.

◆ ViewGetLOD()

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

inlinevirtualinherited

Return the level of detail (LOD) of the item.

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

Parameters

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

Returns: the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in SCH_LINE, GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, PAD, PCB_BITMAP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 134 of file view_item.h.

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

◆ viewPrivData()

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

inlineinherited

◆ Visit()

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

virtualinherited

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

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

Parameters

inspector	An INSPECTOR instance to use in the inspection.
testData	Arbitrary data used by the inspector.
aScanTypes	Which KICAD_T types are of interest and the order in which they should be processed.

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

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

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

Friends And Related Function Documentation

◆ SCH_EDIT_FRAME

friend class SCH_EDIT_FRAME

friend

Definition at line 286 of file schematic.h.

Member Data Documentation

◆ m_connectionGraph

CONNECTION_GRAPH* SCHEMATIC::m_connectionGraph

private

Holds and calculates connectivity information of this schematic.

Definition at line 309 of file schematic.h.

Referenced by ConnectionGraph(), GetNetClassAssignmentCandidates(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), Reset(), SCHEMATIC(), SetRoot(), and ~SCHEMATIC().

◆ m_currentSheet

SCH_SHEET_PATH* SCHEMATIC::m_currentSheet

private

The sheet path of the sheet currently being edited or displayed.

Note that this was moved here from SCH_EDIT_FRAME because currently many places in the code want to know the current sheet. Potentially this can be moved back to the UI code once the only places that want to know it are UI-related

Definition at line 306 of file schematic.h.

Referenced by CurrentSheet(), Reset(), SCHEMATIC(), SetCurrentSheet(), SetRoot(), and ~SCHEMATIC().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 480 of file eda_item.h.

Referenced by EDA_ITEM::ClearFlags(), LIB_TEXT::Clone(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), EDA_ITEM::HasFlag(), LIB_ITEM::HitTest(), LIB_SHAPE::HitTest(), LIB_TEXT::HitTest(), SCH_JUNCTION::HitTest(), SCH_LINE::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(), SCH_LINE::MirrorHorizontally(), SCH_LINE::MirrorVertically(), EDA_ITEM::operator=(), SCH_LINE::Rotate(), EDA_ITEM::SetFlags(), PCB_SHAPE::swapData(), PCB_BITMAP::swapData(), and EDA_ITEM::XorFlags().

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 159 of file view_item.h.

Referenced by KIGFX::VIEW_ITEM::GetForcedTransparency(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), and KIGFX::VIEW_ITEM::SetForcedTransparency().

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 479 of file eda_item.h.

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

◆ m_labelToPageRefsMap

std::map<wxString, std::set<int> > SCHEMATIC::m_labelToPageRefsMap

private

Holds a map of labels to the page sequence (virtual page number) that they appear on.

It is used for updating global label intersheet references.

Definition at line 315 of file schematic.h.

Referenced by GetPageRefsMap().

◆ m_listeners

std::vector<SCHEMATIC_LISTENER*> SCHEMATIC::m_listeners

private

Currently installed listeners.

Definition at line 330 of file schematic.h.

Referenced by AddListener(), InvokeListeners(), RemoveAllListeners(), and RemoveListener().

◆ m_operatingPoints

std::map<wxString, double> SCHEMATIC::m_operatingPoints

private

Simulation operating points for text variable substitution.

Definition at line 325 of file schematic.h.

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

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 478 of file eda_item.h.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::DoHypertextAction(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), SCH_FIELD::GetDrawRotation(), SCH_FIELD::GetMenuImage(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_FIELD::GetName(), LIB_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParent(), EDA_ITEM::GetParent(), PAD::GetParent(), PAD::GetParentAsString(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), LIB_FIELD::HitTest(), SCH_FIELD::IsHypertext(), SCH_FIELD::IsReplaceable(), SCH_PIN::IsStacked(), SCH_FIELD::Matches(), EDA_ITEM::operator=(), LIB_FIELD::operator=(), PAD::PAD(), SCH_FIELD::Plot(), SCH_FIELD::Print(), SCH_FIELD::Replace(), SCH_LABEL_BASE::ResolveTextVar(), SCH_SYMBOL::SCH_SYMBOL(), SCH_FIELD::SetId(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), SCH_FIELD::SetPosition(), PCB_SHAPE::swapData(), and PCB_BITMAP::swapData().

◆ m_project

PROJECT* SCHEMATIC::m_project

private

Definition at line 295 of file schematic.h.

Referenced by ErcSettings(), Prj(), Reset(), ResolveTextVar(), SetProject(), and Settings().

◆ m_properties

std::map<wxString, wxString> SCHEMATIC::m_properties

private

Properties for text variable substitution (and perhaps other uses in future).

Definition at line 320 of file schematic.h.

Referenced by GetProperties().

◆ m_rootSheet

SCH_SHEET* SCHEMATIC::m_rootSheet

private

The top-level sheet in this schematic hierarchy (or potentially the only one)

Definition at line 298 of file schematic.h.

Referenced by GetFileName(), GetFullHierarchy(), GetSheets(), IsValid(), Reset(), Root(), RootScreen(), SetLegacySymbolInstanceData(), and SetRoot().

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

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 158 of file view_item.h.

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SCHEMATIC()

◆ ~SCHEMATIC()

Member Function Documentation

◆ AddListener()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearOperatingPoints()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ ConnectionGraph()

◆ ConvertKIIDsToRefs()

◆ ConvertRefsToKIIDs()

◆ CurrentSheet()

◆ ErcSettings()

◆ FixupJunctions()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBoundingBox()

◆ GetBusAlias()

◆ GetClass()

◆ GetContextualTextVars()

◆ GetEditFlags()

◆ GetFileName()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetForcedTransparency()

◆ GetFriendlyName()

◆ GetFullHierarchy()

◆ GetItemDescription()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetNetClassAssignmentCandidates()

◆ GetOperatingPoint()

◆ GetPageRefsMap()

◆ GetParent()

◆ GetPosition()

◆ GetProperties()

◆ GetSheets()

◆ GetSortPosition()

◆ GetTypeDesc()

◆ GetUniqueFilenameForCurrentSheet()

◆ GetVirtualPageToSheetNamesMap()

◆ GetVirtualPageToSheetPagesMap()

◆ HasFlag()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ InvokeListeners()

◆ IsBrightened()

◆ IsEntered()

◆ IsForceVisible()

◆ IsModified()

◆ IsMoving()

◆ IsNew()

◆ IsReplaceable()

◆ IsRollover()

◆ IsSelected()

◆ IsShownAsBitmap()

◆ IsType()

◆ IsValid()

◆ IterateForward() [1/2]

◆ IterateForward() [2/2]

◆ Matches() [1/2]

◆ Matches() [2/2]

◆ OnItemsAdded()

◆ OnItemsChanged()

◆ OnItemsRemoved()

◆ operator<()